v2

type APIClientV2 struct {
	BaseAPIClient
	// contains filtered or unexported fields
}

type AbsRank struct {
	// contains filtered or unexported fields
}

type AddOption interface {
	ApplyToAdd(*CollectionAddOp) error
}

type AddOptionFunc func(*CollectionAddOp) error

type Aggregate interface {
	MarshalJSON() ([]byte, error)
	Validate() error
}

type BaseAPIClient struct {
	// contains filtered or unexported fields
}

type BasicAuthCredentialsProvider struct {
	Username string
	Password string
}

type BoolInvertedIndexConfig struct{}

type BoolInvertedIndexType struct {
	Enabled bool                     `json:"enabled"`
	Config  *BoolInvertedIndexConfig `json:"config,omitempty"`
}

type BoolValueType struct {
	BoolInvertedIndex *BoolInvertedIndexType `json:"bool_inverted_index,omitempty"`
}

type Client interface {
	PreFlight(ctx context.Context) error
	// Heartbeat checks if the chroma instance is alive.
	Heartbeat(ctx context.Context) error
	// GetVersion returns the version of the chroma instance.
	GetVersion(ctx context.Context) (string, error)
	// GetIdentity returns the identity of the chroma instance. This is noop for v1 API.
	GetIdentity(ctx context.Context) (Identity, error)
	// GetTenant gets a tenant with the given name.
	GetTenant(ctx context.Context, tenant Tenant) (Tenant, error)
	// UseTenant sets the current tenant to the given name and resets the active
	// database to [DefaultDatabase] for that tenant.
	UseTenant(ctx context.Context, tenant Tenant) error
	// UseDatabase sets a database to use for all collection operations.
	UseDatabase(ctx context.Context, database Database) error
	// CreateTenant creates a new tenant with the given name.
	CreateTenant(ctx context.Context, tenant Tenant) (Tenant, error)
	// ListDatabases returns a list of databases in the given tenant.
	ListDatabases(ctx context.Context, tenant Tenant) ([]Database, error)
	// GetDatabase gets a database with the given name from the given tenant.
	GetDatabase(ctx context.Context, db Database) (Database, error)
	// CreateDatabase creates a new database with the given name in the given tenant.
	CreateDatabase(ctx context.Context, db Database) (Database, error)
	// DeleteDatabase deletes a database with the given name from the given tenant.
	DeleteDatabase(ctx context.Context, db Database) error
	// CurrentTenant returns the current tenant.
	CurrentTenant() Tenant
	// CurrentDatabase returns the current database.
	CurrentDatabase() Database
	// Reset resets the chroma instance by all data. Use with caution.
	// Returns an error if ALLOW_RESET is not set to true.
	Reset(ctx context.Context) error
	// CreateCollection creates a new collection with the given name and options.
	CreateCollection(ctx context.Context, name string, options ...CreateCollectionOption) (Collection, error)
	// GetOrCreateCollection gets a collection with the given name. If the collection does not exist, it creates a new collection with the given options.
	// If the collection exists but the metadata does not match the options, it returns an error. Use Collection.ModifyMetadata to update the metadata.
	GetOrCreateCollection(ctx context.Context, name string, options ...CreateCollectionOption) (Collection, error)
	// DeleteCollection deletes the collection with the given name.
	DeleteCollection(ctx context.Context, name string, options ...DeleteCollectionOption) error
	// GetCollection gets a collection with the given name.
	GetCollection(ctx context.Context, name string, opts ...GetCollectionOption) (Collection, error)
	// CountCollections returns the number of collections in the current tenant and database.
	CountCollections(ctx context.Context, opts ...CountCollectionsOption) (int, error)
	// ListCollections returns a list of collections in the current tenant and database.
	ListCollections(ctx context.Context, opts ...ListCollectionsOption) ([]Collection, error)
	// Close closes the client and releases any resources.
	Close() error
}

type ClientOption func(client *BaseAPIClient) error

type CloudAPIClient struct {
	*APIClientV2
}

type CloudClientOption func(client *CloudAPIClient) error

type Cmek struct {
	Provider CmekProvider
	Resource string
}

type CmekProvider string

type Collection interface {
	// Name returns the name of the collection.
	Name() string

	// ID returns the unique identifier of the collection.
	ID() string

	// Tenant returns the tenant that owns this collection.
	Tenant() Tenant

	// Database returns the database containing this collection.
	Database() Database

	// Metadata returns the collection's metadata.
	Metadata() CollectionMetadata

	// Dimension returns the dimensionality of embeddings in this collection.
	// Returns 0 if not yet determined (no documents added).
	Dimension() int

	// Configuration returns the collection's configuration settings.
	Configuration() CollectionConfiguration

	// Schema returns the collection's schema definition, if any.
	Schema() *Schema

	// Add inserts new documents into the collection.
	//
	// Documents can be provided as text (automatically embedded) or with
	// pre-computed embeddings. IDs must be unique within the collection.
	//
	// Options: [WithIDs], [WithTexts], [WithEmbeddings], [WithMetadatas], [WithIDGenerator]
	//
	//	err := collection.Add(ctx,
	//	    WithIDs("doc1", "doc2"),
	//	    WithTexts("First document", "Second document"),
	//	)
	Add(ctx context.Context, opts ...CollectionAddOption) error

	// Upsert inserts new documents or updates existing ones.
	//
	// If a document with the given ID exists, it is updated. Otherwise, a new
	// document is created. Uses the same options as [Collection.Add].
	//
	//	err := collection.Upsert(ctx,
	//	    WithIDs("doc1"),
	//	    WithTexts("New or updated content"),
	//	)
	Upsert(ctx context.Context, opts ...CollectionAddOption) error

	// Update modifies existing documents in the collection.
	//
	// Only the provided fields are updated. Documents must exist.
	//
	// Options: [WithIDs], [WithTexts], [WithEmbeddings], [WithMetadatas]
	//
	//	err := collection.Update(ctx,
	//	    WithIDs("doc1"),
	//	    WithTexts("Updated content"),
	//	)
	Update(ctx context.Context, opts ...CollectionUpdateOption) error

	// Delete removes documents from the collection.
	//
	// At least one filter must be provided: IDs, Where, or WhereDocument.
	//
	// Options: [WithIDs], [WithWhere], [WithWhereDocument]
	//
	//	// Delete by ID
	//	err := collection.Delete(ctx, WithIDs("doc1", "doc2"))
	//
	//	// Delete by metadata filter
	//	err := collection.Delete(ctx, WithWhere(EqString("status", "archived")))
	Delete(ctx context.Context, opts ...CollectionDeleteOption) error

	// Count returns the total number of documents in the collection.
	Count(ctx context.Context) (int, error)

	// ModifyName changes the collection's name.
	ModifyName(ctx context.Context, newName string) error

	// ModifyMetadata updates the collection's metadata.
	ModifyMetadata(ctx context.Context, newMetadata CollectionMetadata) error

	// ModifyConfiguration updates the collection's configuration.
	// Note: Not all configuration changes may be supported.
	ModifyConfiguration(ctx context.Context, newConfig *UpdateCollectionConfiguration) error

	// Get retrieves documents from the collection by ID or filter.
	//
	// Returns documents matching the specified criteria. If no filters are
	// provided, returns all documents (subject to limit/offset).
	//
	// Options: [WithIDs], [WithWhere], [WithWhereDocument], [WithInclude], [WithLimit], [WithOffset]
	//
	//	// Get by IDs
	//	results, _ := collection.Get(ctx, WithIDs("doc1", "doc2"))
	//
	//	// Get with pagination
	//	results, _ := collection.Get(ctx, WithLimit(100), WithOffset(200))
	//
	//	// Get with filter
	//	results, _ := collection.Get(ctx,
	//	    WithWhere(EqString("status", "published")),
	//	    WithInclude(IncludeDocuments, IncludeMetadatas),
	//	)
	Get(ctx context.Context, opts ...CollectionGetOption) (GetResult, error)

	// Query performs semantic search using text or embeddings.
	//
	// Finds documents most similar to the query. Use [WithQueryTexts] for text
	// queries (automatically embedded) or [WithQueryEmbeddings] for pre-computed
	// embeddings.
	//
	// Options: [WithQueryTexts], [WithQueryEmbeddings], [WithNResults], [WithWhere],
	// [WithWhereDocument], [WithInclude], [WithIDs]
	//
	//	results, _ := collection.Query(ctx,
	//	    WithQueryTexts("machine learning"),
	//	    WithNResults(10),
	//	    WithWhere(EqString("category", "tech")),
	//	)
	Query(ctx context.Context, opts ...CollectionQueryOption) (QueryResult, error)

	// Search performs advanced search with ranking and filtering.
	//
	// Provides more control than Query, including custom ranking expressions,
	// pagination, field selection, and grouping.
	//
	// Use [NewSearchRequest] to create search requests with options like
	// [WithKnnRank], [WithFilter], [WithPage], [WithSelect], and [WithGroupBy].
	//
	//	results, _ := collection.Search(ctx,
	//	    NewSearchRequest(
	//	        WithKnnRank(KnnQueryText("machine learning")),
	//	        WithFilter(EqString(K("status"), "published")),
	//	        WithPage(PageLimit(10)),
	//	        WithSelect(KDocument, KScore),
	//	    ),
	//	)
	Search(ctx context.Context, opts ...SearchCollectionOption) (SearchResult, error)

	// Fork creates a copy of this collection with a new name.
	// The new collection contains all documents from the original.
	Fork(ctx context.Context, newName string) (Collection, error)

	// IndexingStatus returns the current indexing progress for this collection.
	// Requires Chroma server version >= 1.4.1.
	//
	// Use this to monitor background indexing after adding large amounts of data.
	IndexingStatus(ctx context.Context) (*IndexingStatus, error)

	// Close releases any resources held by the collection.
	// The collection should not be used after calling Close.
	Close() error
}

type CollectionAddOp struct {
	// Ids are the unique identifiers for each document.
	Ids []DocumentID `json:"ids"`

	// Documents contain the text content to be stored and embedded.
	Documents []Document `json:"documents,omitempty"`

	// Metadatas contain key-value metadata for each document.
	Metadatas []DocumentMetadata `json:"metadatas,omitempty"`

	// Embeddings are the vector representations of the documents.
	// If not provided, they are computed from Documents using the embedding function.
	Embeddings []any `json:"embeddings"`

	// Records is an alternative to separate Ids/Documents/Metadatas/Embeddings.
	Records []Record `json:"-"`

	// IDGenerator automatically generates IDs if Ids is empty.
	IDGenerator IDGenerator `json:"-"`
}

type CollectionAddOption = AddOption

type CollectionConfiguration interface {
	// GetRaw returns a configuration value by key.
	// Returns the value and true if found, or nil and false if not found.
	GetRaw(key string) (any, bool)
}

type CollectionConfigurationImpl struct {
	// contains filtered or unexported fields
}

type CollectionDeleteOp struct {
	FilterOp   // Where and WhereDocument filters
	FilterIDOp // ID filter
}

type CollectionDeleteOption = DeleteOption

type CollectionGetOp struct {
	FilterOp          // Where and WhereDocument filters
	FilterIDOp        // ID filter
	ProjectOp         // Field projection (Include)
	LimitAndOffsetOp  // Pagination
	SortOp            // Ordering (not yet supported)
	ResourceOperation `json:"-"`
}

type CollectionGetOption = GetOption

type CollectionImpl struct {
	// contains filtered or unexported fields
}

type CollectionLifecycleOp interface {
	PrepareAndValidateCollectionRequest() error
}

type CollectionMetadata interface {
	Keys() []string
	GetRaw(key string) (interface{}, bool)
	GetString(key string) (string, bool)
	GetInt(key string) (int64, bool)
	GetFloat(key string) (float64, bool)
	GetBool(key string) (bool, bool)
	GetStringArray(key string) ([]string, bool)
	GetIntArray(key string) ([]int64, bool)
	GetFloatArray(key string) ([]float64, bool)
	GetBoolArray(key string) ([]bool, bool)
	SetRaw(key string, value interface{})
	SetString(key, value string)
	SetInt(key string, value int64)
	SetFloat(key string, value float64)
	SetBool(key string, value bool)
	SetStringArray(key string, value []string)
	SetIntArray(key string, value []int64)
	SetFloatArray(key string, value []float64)
	SetBoolArray(key string, value []bool)
	MarshalJSON() ([]byte, error)
	UnmarshalJSON(b []byte) error
}

type CollectionMetadataImpl struct {
	// contains filtered or unexported fields
}

type CollectionModel struct {
	ID                string                 `json:"id"`
	Name              string                 `json:"name"`
	ConfigurationJSON map[string]interface{} `json:"configuration_json,omitempty"`
	Metadata          CollectionMetadata     `json:"metadata,omitempty"`
	Dimension         int                    `json:"dimension,omitempty"`
	Tenant            string                 `json:"tenant,omitempty"`
	Database          string                 `json:"database,omitempty"`
	Version           int                    `json:"version,omitempty"`
	LogPosition       int                    `json:"log_position,omitempty"`
	Schema            *Schema                `json:"schema,omitempty"`
}

type CollectionOp interface {
	// PrepareAndValidate validates the operation before sending.
	PrepareAndValidate() error

	// EmbedData embeds text data using the provided embedding function.
	EmbedData(ctx context.Context, ef embeddings.EmbeddingFunction) error

	// MarshalJSON serializes the operation to JSON.
	MarshalJSON() ([]byte, error)

	// UnmarshalJSON deserializes the operation from JSON.
	UnmarshalJSON(b []byte) error
}

type CollectionQueryOp struct {
	FilterOp           // Where and WhereDocument filters
	FilterEmbeddingsOp // Pre-computed query embeddings
	FilterTextsOp      // Query texts to be embedded
	LimitResultOp      // Number of results per query
	ProjectOp          // Field projection (Include)
	FilterIDOp         // Limit search to specific IDs
}

type CollectionQueryOption = QueryOption

type CollectionUpdateOp struct {
	// Ids identifies the documents to update (required).
	Ids []DocumentID `json:"ids"`

	// Documents contain updated text content.
	Documents []Document `json:"documents,omitempty"`

	// Metadatas contain updated metadata values.
	Metadatas []DocumentMetadata `json:"metadatas,omitempty"`

	// Embeddings contain updated vector representations.
	Embeddings []any `json:"embeddings"`

	// Records is an alternative to separate fields.
	Records []Record `json:"-"`
}

type CollectionUpdateOption = UpdateOption

type CountCollectionsOp struct {
	Database Database `json:"-"`
}

type CountCollectionsOption func(*CountCollectionsOp) error

type CreateCollectionOp struct {
	Name              string `json:"name"`
	CreateIfNotExists bool   `json:"get_or_create,omitempty"`

	Metadata      CollectionMetadata           `json:"metadata,omitempty"`
	Configuration *CollectionConfigurationImpl `json:"configuration,omitempty"`
	Schema        *Schema                      `json:"schema,omitempty"`
	Database      Database                     `json:"-"`
	// contains filtered or unexported fields
}

type CreateCollectionOption func(*CreateCollectionOp) error

type CredentialsProvider interface {
	Authenticate() (map[string]string, error)
}

type Database interface {
	ID() string
	Name() string
	Tenant() Tenant
	String() string
	Validate() error
}

type DatabaseBase struct {
	DBName     string `json:"name" mapstructure:"name"`
	DBID       string `json:"id,omitempty" mapstructure:"id"`
	TenantName string `json:"tenant,omitempty" mapstructure:"tenant"`
	// contains filtered or unexported fields
}

type DeleteCollectionOp struct {
	Database Database `json:"-"`
}

type DeleteCollectionOption func(*DeleteCollectionOp) error

type DeleteOption interface {
	ApplyToDelete(*CollectionDeleteOp) error
}

type DeleteOptionFunc func(*CollectionDeleteOp) error

type DivRank struct {
	// contains filtered or unexported fields
}

type Document interface {
	ContentRaw() []byte
	ContentString() string
}

type DocumentID string

type DocumentIDs []DocumentID

type DocumentMetadata interface {
	GetRaw(key string) (interface{}, bool)
	GetString(key string) (string, bool)
	GetInt(key string) (int64, bool)
	GetFloat(key string) (float64, bool)
	GetBool(key string) (bool, bool)
	GetStringArray(key string) ([]string, bool)
	GetIntArray(key string) ([]int64, bool)
	GetFloatArray(key string) ([]float64, bool)
	GetBoolArray(key string) ([]bool, bool)
	SetRaw(key string, value interface{})
	SetString(key, value string)
	SetInt(key string, value int64)
	SetFloat(key string, value float64)
	SetBool(key string, value bool)
	SetStringArray(key string, value []string)
	SetIntArray(key string, value []int64)
	SetFloatArray(key string, value []float64)
	SetBoolArray(key string, value []bool)
}

type DocumentMetadataImpl struct {
	// contains filtered or unexported fields
}

type DocumentMetadatas []DocumentMetadata

type Documents []Document

type EmbeddingFunctionInfo struct {
	Type   string                 `json:"type"`
	Name   string                 `json:"name"`
	Config map[string]interface{} `json:"config"`
}

type ExpRank struct {
	// contains filtered or unexported fields
}

type FilterEmbeddingsOp struct {
	QueryEmbeddings []embeddings.Embedding `json:"query_embeddings"`
}

type FilterIDOp struct {
	// Ids contains the document IDs to filter by.
	Ids []DocumentID `json:"ids,omitempty"`
}

type FilterOp struct {
	// Where filters by metadata field values.
	Where WhereFilter `json:"where,omitempty"`

	// WhereDocument filters by document text content.
	WhereDocument WhereDocumentFilter `json:"where_document,omitempty"`
}

type FilterTextsOp struct {
	QueryTexts []string `json:"-"`
}

type FloatInvertedIndexConfig struct{}

type FloatInvertedIndexType struct {
	Enabled bool                      `json:"enabled"`
	Config  *FloatInvertedIndexConfig `json:"config,omitempty"`
}

type FloatListValueType struct {
	VectorIndex *VectorIndexType `json:"vector_index,omitempty"`
}

type FloatOperand float64

type FloatValueType struct {
	FloatInvertedIndex *FloatInvertedIndexType `json:"float_inverted_index,omitempty"`
}

type FtsIndexConfig struct{}

type FtsIndexType struct {
	Enabled bool            `json:"enabled"`
	Config  *FtsIndexConfig `json:"config,omitempty"`
}

type GenerateOptions struct {
	Document string
}

type GetCollectionOp struct {
	Database Database `json:"-"`
	// contains filtered or unexported fields
}

type GetCollectionOption func(*GetCollectionOp) error

type GetOption interface {
	ApplyToGet(*CollectionGetOp) error
}

type GetOptionFunc func(*CollectionGetOp) error