ug(ZLddlmZmZddlmZmZddlmZddlm Z ddl m Z m Z ddl mZddlmZddlmZmZdd lmZmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#dd lm$Z$m%Z%dd l&m'Z'm(Z(m)Z*dd l+m,cm-Z.Gd deZ/Gdde/eZ0GddeZ1Gdde/e1e$Z2y ))ABCabstractmethod)SequenceOptional)UUID)override)CollectionConfigurationCollectionConfigurationInternal) UserIdentity)AsyncCollection)DEFAULT_DATABASEDEFAULT_TENANT)CollectionMetadata Documents EmbeddableEmbeddingFunction DataLoader EmbeddingsIDsIncludeLoadable MetadatasURIsWhere QueryResult GetResult WhereDocument) ComponentSettings)DatabaseTenant CollectionNceZdZedefdZedefdZe d,dedee dee ddfdZ ed e ddfd Z e d-d e d ed edeedeedeedefdZe d.d ed e d eedeedeedeedefdZe d-d ed e d edeedeedeedefdZed edefdZed/d ededefdZeddddddddgdf d ed ee deedee deedeedeedeedeed edefd!Ze d,d ed ee deedeeddf d"Zedddgd#fd ed$ed%edeedeed edefd&Zedefd'Z ede fd(Z!ede"fd)Z#edefd*Z$ede%fd+Z&y)0 AsyncBaseAPIreturnc Kyw)zGet the current time in nanoseconds since epoch. Used to check if the server is alive. Returns: int: The current time in nanoseconds since epoch Nselfs K/var/www/openai/venv/lib/python3.12/site-packages/chromadb/api/async_api.py heartbeatzAsyncBaseAPI.heartbeat$  c Kyw)zCount the number of collections. Returns: int: The number of collections. Examples: ```python await client.count_collections() # 1 ``` Nr'r(s r*count_collectionszAsyncBaseAPI.count_collections3  r-Nidnew_name new_metadatac Kyw)a[Internal] Modify a collection by UUID. Can update the name and/or metadata. Args: id: The internal UUID of the collection to modify. new_name: The new name of the collection. If None, the existing name will remain. Defaults to None. new_metadata: The new metadata to associate with the collection. Defaults to None. Nr')r)r1r2r3s r*_modifyzAsyncBaseAPI._modifyBs r-namec Kyw)a7Delete a collection with the given name. Args: name: The name of the collection to delete. Raises: ValueError: If the collection does not exist. Examples: ```python await client.delete_collection("my_collection") ``` Nr'r)r6s r*delete_collectionzAsyncBaseAPI.delete_collectionT " r-ids collection_id embeddings metadatas documentsurisc Kyw)a[Internal] Add embeddings to a collection specified by UUID. If (some) ids already exist, only the new embeddings will be added. Args: ids: The ids to associate with the embeddings. collection_id: The UUID of the collection to add the embeddings to. embedding: The sequence of embeddings to add. metadata: The metadata to associate with the embeddings. Defaults to None. documents: The documents to associate with the embeddings. Defaults to None. uris: URIs of data sources for each embedding. Defaults to None. Returns: True if the embeddings were added successfully. Nr')r)r;r<r=r>r?r@s r*_addzAsyncBaseAPI._addk 0 r-c Kyw)aw[Internal] Update entries in a collection specified by UUID. Args: collection_id: The UUID of the collection to update the embeddings in. ids: The IDs of the entries to update. embeddings: The sequence of embeddings to update. Defaults to None. metadatas: The metadata to associate with the embeddings. Defaults to None. documents: The documents to associate with the embeddings. Defaults to None. uris: URIs of data sources for each embedding. Defaults to None. Returns: True if the embeddings were updated successfully. Nr'r)r<r;r=r>r?r@s r*_updatezAsyncBaseAPI._update , r-c Kyw)a[Internal] Add or update entries in the a collection specified by UUID. If an entry with the same id already exists, it will be updated, otherwise it will be added. Args: collection_id: The collection to add the embeddings to ids: The ids to associate with the embeddings. Defaults to None. embeddings: The sequence of embeddings to add metadatas: The metadata to associate with the embeddings. Defaults to None. documents: The documents to associate with the embeddings. Defaults to None. uris: URIs of data sources for each embedding. Defaults to None. Nr'rEs r*_upsertzAsyncBaseAPI._upsertrGr-c Kyw)a[Internal] Returns the number of entries in a collection specified by UUID. Args: collection_id: The UUID of the collection to count the embeddings in. Returns: int: The number of embeddings in the collection Nr')r)r<s r*_countzAsyncBaseAPI._count  r- nc Kyw)a4[Internal] Returns the first n entries in a collection specified by UUID. Args: collection_id: The UUID of the collection to peek into. n: The number of entries to peek. Defaults to 10. Returns: GetResult: The first n entries in the collection. Nr')r)r<rNs r*_peekzAsyncBaseAPI._peekr0r-)r=r>r?wheresortlimitoffsetpage page_sizewhere_documentincludec  Kyw)a[Internal] Returns entries from a collection specified by UUID. Args: ids: The IDs of the entries to get. Defaults to None. where: Conditional filtering on metadata. Defaults to {}. sort: The column to sort the entries by. Defaults to None. limit: The maximum number of entries to return. Defaults to None. offset: The number of entries to skip before returning. Defaults to None. page: The page number to return. Defaults to None. page_size: The number of entries to return per page. Defaults to None. where_document: Conditional filtering on documents. Defaults to {}. include: The fields to include in the response. Defaults to ["embeddings", "metadatas", "documents"]. Returns: GetResult: The entries in the collection that match the query. Nr') r)r<r;rQrRrSrTrUrVrWrXs r*_getzAsyncBaseAPI._gets > r-c Kyw)a[Internal] Deletes entries from a collection specified by UUID. Args: collection_id: The UUID of the collection to delete the entries from. ids: The IDs of the entries to delete. Defaults to None. where: Conditional filtering on metadata. Defaults to {}. where_document: Conditional filtering on documents. Defaults to {}. Returns: IDs: The list of IDs of the entries that were deleted. Nr')r)r<r;rQrWs r*_deletezAsyncBaseAPI._deletes & r-)r=r>r? distancesquery_embeddings n_resultsc Kyw)a[Internal] Performs a nearest neighbors query on a collection specified by UUID. Args: collection_id: The UUID of the collection to query. query_embeddings: The embeddings to use as the query. n_results: The number of results to return. Defaults to 10. where: Conditional filtering on metadata. Defaults to {}. where_document: Conditional filtering on documents. Defaults to {}. include: The fields to include in the response. Defaults to ["embeddings", "metadatas", "documents", "distances"]. Returns: QueryResult: The results of the query. Nr')r)r<r^r_rQrWrXs r*_queryzAsyncBaseAPI._queryrCr-c Kyw)zResets the database. This will delete all collections and entries. Returns: bool: True if the database was reset successfully. Nr'r(s r*resetzAsyncBaseAPI.reset!  r-c Kyw)z]Get the version of Chroma. Returns: str: The version of Chroma Nr'r(s r* get_versionzAsyncBaseAPI.get_version*  r-cy)zwGet the settings used to initialize. Returns: Settings: The settings used to initialize. Nr'r(s r* get_settingszAsyncBaseAPI.get_settings4s c Kyw)zUReturn the maximum number of records that can be created or mutated in a single call.Nr'r(s r*get_max_batch_sizezAsyncBaseAPI.get_max_batch_size>s  r-c Kyw)zsResolve the tenant and databases for the client. Returns the default values if can't be resolved. Nr'r(s r*get_user_identityzAsyncBaseAPI.get_user_identityCs r-NN)NNN)NNNN)rM)'__name__ __module__ __qualname__rintr+r/rrstrrr5r9rrrrrboolrBrFrIrKrrPrrrrZr\rrarcrfrrirlr rnr'rjr*r$r$#s\         #'59   3- 12     "     , *.)-#     I&  I&  tn    2 ,0)-)-#   Z(  I&  I&  tn    . *.)-#     I&  I&  tn    .  $  3        #  y    "!%"# $"#'26C  c]   sm  }    sm C= !/     @ "&26   c]   !/     ( !%26P  %     !/      2 T   3   h   #     rjr$ceZdZUeed<eed<e ddeedeedeefdZ edde jddfd ed ee d ee d eeed eeededefdZee jdfd ed eeed eeedefdZedde jdfd ed ee d ee d eeed eeedef dZeefdededdfdZededdfdZeeddZy)AsyncClientAPItenantdatabaseNrSrTr%c Kyw)aList all collections. Args: limit: The maximum number of entries to return. Defaults to None. offset: The number of entries to skip before returning. Defaults to None. Returns: Sequence[str]: A list of collection names. Examples: ```python await client.list_collections() # ["my_collection"] ``` Nr')r)rSrTs r*list_collectionszAsyncClientAPI.list_collectionsPs ( r-Fr6 configurationmetadataembedding_function data_loader get_or_createc Kyw)aYCreate a new collection with the given name and metadata. Args: name: The name of the collection to create. metadata: Optional metadata to associate with the collection. embedding_function: Optional function to use to embed documents. Uses the default embedding function if not provided. get_or_create: If True, return the existing collection if it exists. data_loader: Optional function to use to load records (documents, images, etc.) Returns: Collection: The newly created collection. Raises: ValueError: If the collection already exists and get_or_create is False. ValueError: If the collection name is invalid. Examples: ```python await client.create_collection("my_collection") # collection(name="my_collection", metadata={}) await client.create_collection("my_collection", metadata={"foo": "bar"}) # collection(name="my_collection", metadata={"foo": "bar"}) ``` Nr')r)r6r|r}r~rrs r*create_collectionz AsyncClientAPI.create_collectionfs J r-c Kyw)aGet a collection with the given name. Args: name: The name of the collection to get embedding_function: Optional function to use to embed documents. Uses the default embedding function if not provided. data_loader: Optional function to use to load records (documents, images, etc.) Returns: Collection: The collection Raises: ValueError: If the collection does not exist Examples: ```python await client.get_collection("my_collection") # collection(name="my_collection", metadata={}) ``` Nr')r)r6r~rs r*get_collectionzAsyncClientAPI.get_collections 8 r-c Kyw)a1Get or create a collection with the given name and metadata. Args: name: The name of the collection to get or create metadata: Optional metadata to associate with the collection. If the collection already exists, the metadata provided is ignored. If the collection does not exist, the new collection will be created with the provided metadata. embedding_function: Optional function to use to embed documents data_loader: Optional function to use to load records (documents, images, etc.) Returns: The collection Examples: ```python await client.get_or_create_collection("my_collection") # collection(name="my_collection", metadata={}) ``` Nr')r)r6r|r}r~rs r*get_or_create_collectionz'AsyncClientAPI.get_or_create_collections < r-c Kyw)zSet the tenant and database for the client. Raises an error if the tenant or database does not exist. Args: tenant: The tenant to set. database: The database to set. Nr'r)rxrys r* set_tenantzAsyncClientAPI.set_tenant  r-c Kyw)zSet the database for the client. Raises an error if the database does not exist. Args: database: The database to set. Nr')r)rys r* set_databasezAsyncClientAPI.set_databasergr-cy)zClear the system cache so that new systems can be created for an existing path. This should only be used for testing purposes.Nr'r'rjr*clear_system_cachez!AsyncClientAPI.clear_system_caches rjro)r%N)rprqrrrt__annotations__rrrsrr{efDefaultEmbeddingFunctionr rrrrrrur rrrr rr staticmethodrr'rjr*rwrwLsE KM $ $ }    #   *<@15 (B ' ' )6:#$ $  78$ -. $ % j ) $ j23$ $  $ $ L (B ' ' )6:   % j )  j23     :<@15 (B ' ' )6:   78 -.  % j )  j23    >r?r;rQrRrUrVrWrXc  Kywrr') r)r<r;rQrRrSrTrUrVrWrXrxrys r*rZzAsyncServerAPI._getr:r-r=r@c  Kywrr') r)r;r<r=r>r?r@rxrys r*rBzAsyncServerAPI._addr0r-c  Kywrr' r)r<r;r=r>r?r@rxrys r*rFzAsyncServerAPI._updater0r-c  Kywrr'rs r*rIzAsyncServerAPI._upsertr0r-)r>r?r]r^r_c  Kywrr') r)r<r^r_rQrWrXrxrys r*razAsyncServerAPI._queryr0r-c Kywrr')r)r<r;rQrWrxrys r*r\zAsyncServerAPI._deleterLr-)*rprqrr__doc__rrr rrsrtrCollectionModelr{rr/r rrurrrr9rr5rKrrPrrrrrZrrrrrBrFrIrrar\r'rjr*rr.sQ $ $$(  }       / "    *rs#%'?<"0JJ//f 3f R Z \3Z zB CB Jz \=)z rj