docarray.document package

Subpackages

• docarray.document.mixins package
  • Submodules
    • docarray.document.mixins.attribute module
    • docarray.document.mixins.audio module
    • docarray.document.mixins.blob module
    • docarray.document.mixins.content module
    • docarray.document.mixins.convert module
    • docarray.document.mixins.dump module
    • docarray.document.mixins.featurehash module
    • docarray.document.mixins.helper module
    • docarray.document.mixins.image module
    • docarray.document.mixins.mesh module
    • docarray.document.mixins.multimodal module
    • docarray.document.mixins.plot module
    • docarray.document.mixins.porting module
    • docarray.document.mixins.property module
    • docarray.document.mixins.protobuf module
    • docarray.document.mixins.pydantic module
    • docarray.document.mixins.rich_embedding module
    • docarray.document.mixins.strawberry module
    • docarray.document.mixins.sugar module
    • docarray.document.mixins.text module
    • docarray.document.mixins.video module
  • Module contents

Submodules

• docarray.document.data module
• docarray.document.generators module
• docarray.document.pydantic_model module
• docarray.document.strawberry_type module

Module contents

class docarray.document.Document

class docarray.document.Document(_obj: Optional[Document] = None, copy: bool = False)

class docarray.document.Document(_obj: Optional[Any] = None)

class docarray.document.Document(_obj: Optional[Dict], copy: bool = False, field_resolver: Optional[Dict[str, str]] = None, unknown_fields_handler: str = 'catch')

class docarray.document.Document(blob: Optional[bytes] = None, **kwargs)

class docarray.document.Document(tensor: Optional[ArrayType] = None, **kwargs)

class docarray.document.Document(text: Optional[str] = None, **kwargs)

class docarray.document.Document(uri: Optional[str] = None, **kwargs)

class docarray.document.Document(parent_id: Optional[str] = None, granularity: Optional[int] = None, adjacency: Optional[int] = None, blob: Optional[bytes] = None, tensor: Optional[ArrayType] = None, mime_type: Optional[str] = None, text: Optional[str] = None, content: Optional[DocumentContentType] = None, weight: Optional[float] = None, uri: Optional[str] = None, tags: Optional[Dict[str, StructValueType]] = None, offset: Optional[float] = None, location: Optional[List[float]] = None, embedding: Optional[ArrayType] = None, modality: Optional[str] = None, evaluations: Optional[Dict[str, Dict[str, StructValueType]]] = None, scores: Optional[Dict[str, Dict[str, StructValueType]]] = None, chunks: Optional[Sequence[Document]] = None, matches: Optional[Sequence[Document]] = None)

Bases: docarray.document.mixins.AllMixins, docarray.base.BaseDCType