docarray.document.mixins.property module#

class docarray.document.mixins.property.PropertyMixin[source]#

Bases: _PropertyMixin

property text: Optional[str]#
Return type:

Optional[str]

property blob: Optional[bytes]#
Return type:

Optional[bytes]

property tensor: Optional[ArrayType]#
Return type:

Optional[ArrayType]

property content: Optional[DocumentContentType]#
Return type:

Optional[DocumentContentType]

property uri: Optional[str]#
Return type:

Optional[str]

property mime_type: Optional[str]#
Return type:

Optional[str]

property chunks: Optional[ChunkArray]#
Return type:

Optional[ChunkArray]

property matches: Optional[MatchArray]#
Return type:

Optional[MatchArray]

property adjacency: Optional[int]#
Return type:

Optional[int]

property content_type: Optional[str]#
Return type:

Optional[str]

property embedding: Optional[ArrayType]#
Return type:

Optional[ArrayType]

property evaluations: Optional[Dict[str, NamedScore]]#
Return type:

Optional[Dict[str, NamedScore]]

property granularity: Optional[int]#
Return type:

Optional[int]

property id: str#
Return type:

str

property location: Optional[List[float]]#
Return type:

Optional[List[float]]

property modality: Optional[str]#
Return type:

Optional[str]

property offset: Optional[float]#
Return type:

Optional[float]

property parent_id: Optional[str]#
Return type:

Optional[str]

property scores: Optional[Dict[str, NamedScore]]#
Return type:

Optional[Dict[str, NamedScore]]

property tags: Optional[Dict[str, StructValueType]]#
Return type:

Optional[Dict[str, StructValueType]]

property weight: Optional[float]#
Return type:

Optional[float]