docarray.document.pydantic_model module#

class docarray.document.pydantic_model.PydanticDocument(*, id: Optional[str] = None, parent_id: Optional[str] = None, granularity: Optional[int] = None, adjacency: Optional[int] = None, blob: Optional[str] = None, tensor: Optional[Any] = None, mime_type: Optional[str] = None, text: Optional[str] = None, weight: Optional[float] = None, uri: Optional[str] = None, tags: Optional[Dict[str, Union[bool, float, str, list, dict, None, List[Optional[Union[bool, float, str, list, dict]]], Dict[str, Optional[Union[bool, float, str, list, dict]]]]]] = None, offset: Optional[float] = None, location: Optional[List[float]] = None, embedding: Optional[Any] = None, modality: Optional[str] = None, evaluations: Optional[Dict[str, _NamedScore]] = None, scores: Optional[Dict[str, _NamedScore]] = None, chunks: Optional[List[PydanticDocument]] = None, matches: Optional[List[PydanticDocument]] = None)[source]#

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

id: Optional[str]#

parent_id: Optional[str]#

granularity: Optional[int]#

adjacency: Optional[int]#

blob: Optional[str]#

tensor: Optional[Any]#

mime_type: Optional[str]#

text: Optional[str]#

weight: Optional[float]#

uri: Optional[str]#

tags: Optional[Dict[str, Union[bool, float, str, list, dict, None, List[Optional[Union[bool, float, str, list, dict]]], Dict[str, Optional[Union[bool, float, str, list, dict]]]]]]#

offset: Optional[float]#

location: Optional[List[float]]#

embedding: Optional[Any]#

modality: Optional[str]#

evaluations: Optional[Dict[str, _NamedScore]]#

scores: Optional[Dict[str, _NamedScore]]#

chunks: Optional[List[PydanticDocument]]#

matches: Optional[List[PydanticDocument]]#

class Config[source]#

Bases: object

smart_union = True#

classmethod construct(_fields_set=None, **values)#

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Return type:: Model

copy(*, include=None, exclude=None, update=None, deep=False)#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

include (Union[AbstractSetIntStr, MappingIntStrAny, None]) – fields to include in new model
exclude (Union[AbstractSetIntStr, MappingIntStrAny, None]) – fields to exclude from new model, as with values this takes precedence over include
update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep (bool) – set to True to make a deep copy of the model

Return type:

Model

Returns:

new model instance

dict(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False)#

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Return type:: DictStrAny

classmethod from_orm(obj)#

Return type:: Model

json(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=None, models_as_dict=True, **dumps_kwargs)#

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Return type:: unicode

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)#

Return type:: Model

classmethod parse_obj(obj)#

Return type:: Model

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)#

Return type:: Model

classmethod schema(by_alias=True, ref_template='#/definitions/{model}')#

Return type:: DictStrAny

classmethod schema_json(*, by_alias=True, ref_template='#/definitions/{model}', **dumps_kwargs)#

Return type:: unicode

classmethod update_forward_refs(**localns)#

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Return type:: None

classmethod validate(value)#

Return type:: Model