docarray package

Subpackages

• docarray.array package
  • Subpackages
    • docarray.array.mixins package
      • Subpackages
      • Submodules
      • Module contents
    • docarray.array.queryset package
      • Submodules
      • Module contents
    • docarray.array.storage package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • docarray.array.annlite module
      • AnnliteConfig
      • DocumentArrayAnnlite
    • docarray.array.base module
      • BaseDocumentArray
    • docarray.array.chunk module
      • ChunkArray
    • docarray.array.document module
      • DocumentArray
    • docarray.array.elastic module
      • DocumentArrayElastic
      • ElasticConfig
    • docarray.array.match module
      • MatchArray
    • docarray.array.memory module
      • DocumentArrayInMemory
    • docarray.array.milvus module
      • MilvusConfig
      • DocumentArrayMilvus
    • docarray.array.opensearch module
      • DocumentArrayOpenSearch
      • OpenSearchConfig
    • docarray.array.qdrant module
      • DocumentArrayQdrant
      • QdrantConfig
    • docarray.array.redis module
      • DocumentArrayRedis
      • RedisConfig
    • docarray.array.sqlite module
      • SqliteConfig
      • DocumentArraySqlite
    • docarray.array.weaviate module
      • DocumentArrayWeaviate
      • WeaviateConfig
  • Module contents
• docarray.dataclasses package
  • Submodules
    • docarray.dataclasses.enums module
      • DocumentMetadata
      • AttributeType
      • ImageType
    • docarray.dataclasses.getter module
      • image_getter()
      • text_getter()
      • uri_getter()
      • audio_getter()
      • video_getter()
      • mesh_getter()
      • tabular_getter()
      • blob_getter()
      • json_getter()
    • docarray.dataclasses.setter module
      • image_setter()
      • text_setter()
      • uri_setter()
      • audio_setter()
      • video_setter()
      • mesh_setter()
      • blob_setter()
      • json_setter()
      • tabular_setter()
    • docarray.dataclasses.types module
      • field()
      • dataclass()
      • is_multimodal()
  • Module contents
• docarray.document package
  • Subpackages
    • docarray.document.mixins package
      • Submodules
      • Module contents
  • Submodules
    • docarray.document.data module
      • DocumentData
    • docarray.document.generators module
      • from_ndarray()
      • from_files()
      • from_csv()
      • from_huggingface_datasets()
      • from_ndjson()
      • from_lines()
    • docarray.document.pydantic_model module
      • PydanticDocument
    • docarray.document.strawberry_type module
      • StrawberryDocument
      • StrawberryDocumentInput
  • Module contents
    • Document
      • Document.adjacency
      • Document.blob
      • Document.chunks
      • Document.clear()
      • Document.content
      • Document.content_hash
      • Document.content_type
      • Document.convert_blob_to_datauri()
      • Document.convert_blob_to_image_tensor()
      • Document.convert_blob_to_tensor()
      • Document.convert_content_to_datauri()
      • Document.convert_image_tensor_to_blob()
      • Document.convert_image_tensor_to_sliding_windows()
      • Document.convert_image_tensor_to_uri()
      • Document.convert_tensor_to_blob()
      • Document.convert_tensor_to_text()
      • Document.convert_text_to_datauri()
      • Document.convert_text_to_tensor()
      • Document.convert_uri_to_datauri()
      • Document.copy_from()
      • Document.display()
      • Document.display_point_cloud_tensor()
      • Document.display_rgbd_tensor()
      • Document.display_tensor()
      • Document.display_uri()
      • Document.display_vertices_and_faces()
      • Document.embed()
      • Document.embed_feature_hashing()
      • Document.embedding
      • Document.evaluations
      • Document.from_base64()
      • Document.from_bytes()
      • Document.from_dict()
      • Document.from_json()
      • Document.from_protobuf()
      • Document.from_pydantic_model()
      • Document.from_strawberry_type()
      • Document.generator_from_webcam()
      • Document.get_json_schema()
      • Document.get_multi_modal_attribute()
      • Document.get_vocabulary()
      • Document.granularity
      • Document.id
      • Document.is_multimodal
      • Document.load_pil_image_to_datauri()
      • Document.load_uri_to_audio_tensor()
      • Document.load_uri_to_blob()
      • Document.load_uri_to_image_tensor()
      • Document.load_uri_to_point_cloud_tensor()
      • Document.load_uri_to_text()
      • Document.load_uri_to_vertices_and_faces()
      • Document.load_uri_to_video_tensor()
      • Document.load_uris_to_rgbd_tensor()
      • Document.load_vertices_and_faces_to_point_cloud()
      • Document.location
      • Document.match()
      • Document.matches
      • Document.mime_type
      • Document.modality
      • Document.nbytes
      • Document.non_empty_fields
      • Document.offset
      • Document.parent_id
      • Document.plot_matches_sprites()
      • Document.pop()
      • Document.post()
      • Document.save_audio_tensor_to_file()
      • Document.save_blob_to_file()
      • Document.save_image_tensor_to_file()
      • Document.save_uri_to_file()
      • Document.save_video_tensor_to_file()
      • Document.scores
      • Document.set_image_tensor_channel_axis()
      • Document.set_image_tensor_inv_normalization()
      • Document.set_image_tensor_normalization()
      • Document.set_image_tensor_resample()
      • Document.set_image_tensor_shape()
      • Document.set_multi_modal_attribute()
      • Document.summary()
      • Document.tags
      • Document.tensor
      • Document.text
      • Document.to_base64()
      • Document.to_bytes()
      • Document.to_dict()
      • Document.to_json()
      • Document.to_protobuf()
      • Document.to_pydantic_model()
      • Document.to_strawberry_type()
      • Document.uri
      • Document.weight
• docarray.math package
  • Subpackages
    • docarray.math.distance package
      • Submodules
      • Module contents
  • Submodules
    • docarray.math.evaluation module
      • r_precision()
      • precision_at_k()
      • hit_at_k()
      • average_precision()
      • reciprocal_rank()
      • recall_at_k()
      • f1_score_at_k()
      • dcg_at_k()
      • ndcg_at_k()
    • docarray.math.helper module
      • minmax_normalize()
      • top_k()
      • update_rows_x_mat_best()
    • docarray.math.ndarray module
      • unravel()
      • ravel()
      • get_array_type()
      • to_numpy_array()
      • to_list()
      • get_array_rows()
      • check_arraylike_equality()
      • detach_tensor_if_present()
  • Module contents
• docarray.proto package
  • Subpackages
    • docarray.proto.io package
      • Submodules
      • Module contents
    • docarray.proto.pb package
      • Submodules
      • Module contents
    • docarray.proto.pb2 package
      • Submodules
      • Module contents
  • Submodules
    • docarray.proto.docarray_pb2 module
  • Module contents
• docarray.score package
  • Subpackages
    • docarray.score.mixins package
      • Submodules
      • Module contents
  • Submodules
    • docarray.score.data module
      • NamedScoreData
  • Module contents
    • NamedScore
      • NamedScore.clear()
      • NamedScore.copy_from()
      • NamedScore.description
      • NamedScore.nbytes
      • NamedScore.non_empty_fields
      • NamedScore.op_name
      • NamedScore.pop()
      • NamedScore.ref_id
      • NamedScore.to_dict()
      • NamedScore.value
• docarray.typing package
  • Module contents

Submodules

• docarray.base module
  • BaseDCType
    • BaseDCType.copy_from()
    • BaseDCType.clear()
    • BaseDCType.pop()
    • BaseDCType.non_empty_fields
    • BaseDCType.nbytes
• docarray.helper module
  • typename()
  • deprecate_by()
  • dunder_get()
  • random_identity()
  • random_uuid()
  • download_mermaid_url()
  • get_full_version()
  • get_ci_vendor()
  • reset_ports()
  • random_port()
  • cached_property
  • compress_bytes()
  • decompress_bytes()
  • get_compress_ctx()
  • dataclass_from_dict()
  • protocol_and_compress_from_file_path()
  • add_protocol_and_compress_to_file_path()
  • filter_dict()
  • check_root_id()
  • login()
  • logout()

Module contents