vectorize_client.models.retrieve_documents_response

 1# coding: utf-8
 2
 3"""
 4    Vectorize API (Beta)
 5
 6    API for Vectorize services
 7
 8    The version of the OpenAPI document: 0.0.1
 9    Generated by OpenAPI Generator (https://openapi-generator.tech)
10
11    Do not edit the class manually.
12"""  # noqa: E501
13
14
15from __future__ import annotations
16import pprint
17import re  # noqa: F401
18import json
19
20from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
21from typing import Any, ClassVar, Dict, List, Union
22from vectorize_client.models.document import Document
23from typing import Optional, Set
24from typing_extensions import Self
25
26class RetrieveDocumentsResponse(BaseModel):
27    """
28    RetrieveDocumentsResponse
29    """ # noqa: E501
30    question: StrictStr
31    documents: List[Document]
32    average_relevancy: Union[StrictFloat, StrictInt]
33    ndcg: Union[StrictFloat, StrictInt]
34    __properties: ClassVar[List[str]] = ["question", "documents", "average_relevancy", "ndcg"]
35
36    model_config = ConfigDict(
37        populate_by_name=True,
38        validate_assignment=True,
39        protected_namespaces=(),
40    )
41
42
43    def to_str(self) -> str:
44        """Returns the string representation of the model using alias"""
45        return pprint.pformat(self.model_dump(by_alias=True))
46
47    def to_json(self) -> str:
48        """Returns the JSON representation of the model using alias"""
49        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
50        return json.dumps(self.to_dict())
51
52    @classmethod
53    def from_json(cls, json_str: str) -> Optional[Self]:
54        """Create an instance of RetrieveDocumentsResponse from a JSON string"""
55        return cls.from_dict(json.loads(json_str))
56
57    def to_dict(self) -> Dict[str, Any]:
58        """Return the dictionary representation of the model using alias.
59
60        This has the following differences from calling pydantic's
61        `self.model_dump(by_alias=True)`:
62
63        * `None` is only added to the output dict for nullable fields that
64          were set at model initialization. Other fields with value `None`
65          are ignored.
66        """
67        excluded_fields: Set[str] = set([
68        ])
69
70        _dict = self.model_dump(
71            by_alias=True,
72            exclude=excluded_fields,
73            exclude_none=True,
74        )
75        # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
76        _items = []
77        if self.documents:
78            for _item_documents in self.documents:
79                if _item_documents:
80                    _items.append(_item_documents.to_dict())
81            _dict['documents'] = _items
82        return _dict
83
84    @classmethod
85    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
86        """Create an instance of RetrieveDocumentsResponse from a dict"""
87        if obj is None:
88            return None
89
90        if not isinstance(obj, dict):
91            return cls.model_validate(obj)
92
93        _obj = cls.model_validate({
94            "question": obj.get("question"),
95            "documents": [Document.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
96            "average_relevancy": obj.get("average_relevancy"),
97            "ndcg": obj.get("ndcg")
98        })
99        return _obj