vectorize_client.models.document

  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, Optional, Union
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25class Document(BaseModel):
 26    """
 27    Document
 28    """ # noqa: E501
 29    relevancy: Union[StrictFloat, StrictInt]
 30    id: StrictStr
 31    text: StrictStr
 32    chunk_id: StrictStr
 33    total_chunks: StrictStr
 34    origin: StrictStr
 35    origin_id: StrictStr
 36    similarity: Union[StrictFloat, StrictInt]
 37    source: StrictStr
 38    unique_source: StrictStr
 39    source_display_name: StrictStr
 40    pipeline_id: Optional[StrictStr] = None
 41    org_id: Optional[StrictStr] = None
 42    additional_properties: Dict[str, Any] = {}
 43    __properties: ClassVar[List[str]] = ["relevancy", "id", "text", "chunk_id", "total_chunks", "origin", "origin_id", "similarity", "source", "unique_source", "source_display_name", "pipeline_id", "org_id"]
 44
 45    model_config = ConfigDict(
 46        populate_by_name=True,
 47        validate_assignment=True,
 48        protected_namespaces=(),
 49    )
 50
 51
 52    def to_str(self) -> str:
 53        """Returns the string representation of the model using alias"""
 54        return pprint.pformat(self.model_dump(by_alias=True))
 55
 56    def to_json(self) -> str:
 57        """Returns the JSON representation of the model using alias"""
 58        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 59        return json.dumps(self.to_dict())
 60
 61    @classmethod
 62    def from_json(cls, json_str: str) -> Optional[Self]:
 63        """Create an instance of Document from a JSON string"""
 64        return cls.from_dict(json.loads(json_str))
 65
 66    def to_dict(self) -> Dict[str, Any]:
 67        """Return the dictionary representation of the model using alias.
 68
 69        This has the following differences from calling pydantic's
 70        `self.model_dump(by_alias=True)`:
 71
 72        * `None` is only added to the output dict for nullable fields that
 73          were set at model initialization. Other fields with value `None`
 74          are ignored.
 75        * Fields in `self.additional_properties` are added to the output dict.
 76        """
 77        excluded_fields: Set[str] = set([
 78            "additional_properties",
 79        ])
 80
 81        _dict = self.model_dump(
 82            by_alias=True,
 83            exclude=excluded_fields,
 84            exclude_none=True,
 85        )
 86        # puts key-value pairs in additional_properties in the top level
 87        if self.additional_properties is not None:
 88            for _key, _value in self.additional_properties.items():
 89                _dict[_key] = _value
 90
 91        return _dict
 92
 93    @classmethod
 94    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 95        """Create an instance of Document from a dict"""
 96        if obj is None:
 97            return None
 98
 99        if not isinstance(obj, dict):
100            return cls.model_validate(obj)
101
102        _obj = cls.model_validate({
103            "relevancy": obj.get("relevancy"),
104            "id": obj.get("id"),
105            "text": obj.get("text"),
106            "chunk_id": obj.get("chunk_id"),
107            "total_chunks": obj.get("total_chunks"),
108            "origin": obj.get("origin"),
109            "origin_id": obj.get("origin_id"),
110            "similarity": obj.get("similarity"),
111            "source": obj.get("source"),
112            "unique_source": obj.get("unique_source"),
113            "source_display_name": obj.get("source_display_name"),
114            "pipeline_id": obj.get("pipeline_id"),
115            "org_id": obj.get("org_id")
116        })
117        # store additional fields in additional_properties
118        for _key in obj.keys():
119            if _key not in cls.__properties:
120                _obj.additional_properties[_key] = obj.get(_key)
121
122        return _obj