Struct chromadb::v1::client::ChromaClient

pub struct ChromaClient { /* private fields */ }

Implementations

impl ChromaClient

pub fn new(_: ChromaClientOptions) -> ChromaClient

Create a new Chroma client with the given options.

• Defaults to url: http://localhost:8000

pub fn create_collection( &self, name: &str, metadata: Option<Map<String, Value>>, get_or_create: bool ) -> Result<ChromaCollection>

Create a new collection with the given name and metadata.

Arguments

• name - The name of the collection to create
• metadata - Optional metadata to associate with the collection. Must be a JSON object with keys and values that are either numbers, strings or floats.
• get_or_create - If true, return the existing collection if it exists

Errors

• If the collection already exists and get_or_create is false
• If the collection name is invalid

pub fn get_or_create_collection( &self, name: &str, metadata: Option<Map<String, Value>> ) -> Result<ChromaCollection>

Get or create a collection with the given name and metadata.

Arguments

• name - The name of the collection to get or create
• metadata - Optional metadata to associate with the collection. Must be a JSON object with keys and values that are either numbers, strings or floats.

Errors

• If the collection name is invalid

pub fn list_collections(&self) -> Result<Vec<ChromaCollection>>

List all collections

pub fn get_collection(&self, name: &str) -> Result<ChromaCollection>

Get a collection with the given name.

Arguments

• name - The name of the collection to get

Errors

• If the collection name is invalid
• If the collection does not exist

pub fn delete_collection(&self, name: &str) -> Result<()>

Delete a collection with the given name.

Arguments

• name - The name of the collection to delete

Errors

• If the collection name is invalid
• If the collection does not exist

pub fn reset(&self) -> Result<bool>

Resets the database. This will delete all collections and entries.

pub fn version(&self) -> Result<String>

The version of Chroma

pub fn heartbeat(&self) -> Result<u64>

Get the current time in nanoseconds since epoch. Used to check if the server is alive.