Python API

This section includes the API documentation from the docarray codebase, as extracted from the docstrings in the code.

For further details, please refer to the full user guide.

docarray - Document and DocumentArray

document.Document	Document is the basic data type in DocArray.
array.document.DocumentArray	DocumentArray is a list-like container of Document objects.
array.chunk.ChunkArray	ChunkArray inherits from DocumentArray.
array.match.MatchArray	MatchArray inherits from DocumentArray.

docarray.dataclasses - Dataclass

types.dataclass	Annotates a class as a DocArray dataclass type.
types.is_multimodal	Returns True if obj is an instance of dataclass().
types.field	Creates new multimodal type for a DocArray dataclass.

docarray.array - Document stores

memory.DocumentArrayInMemory	Default DocumentArray that stores Documents in memory.
sqlite.DocumentArraySqlite	DocumentArray that stores Documents in a SQLite database.
annlite.DocumentArrayAnnlite	DocumentArray that stores Documents in ANNLite.
weaviate.DocumentArrayWeaviate	DocumentArray that stores Documents in a Weaviate vector search engine.
qdrant.DocumentArrayQdrant	DocumentArray that stores Documents in a Qdrant vector search engine.
elastic.DocumentArrayElastic	This is a DocumentArray that uses Elasticsearch as vector search engine and storage.