v2

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

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

type BasicAuthCredentialsProvider struct {
	Username string
	Password string
}

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.
	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 Collection interface {
	// Name returns the name of the collection
	Name() string
	// ID returns the id of the collection
	ID() string
	// Tenant returns the tenant of the collection
	Tenant() Tenant
	// Database returns the database of the collection
	Database() Database
	// Metadata returns the metadata of the collection
	Metadata() CollectionMetadata
	// Dimension returns the dimension of the embeddings in the collection
	Dimension() int
	// Configuration returns the configuration of the collection
	Configuration() CollectionConfiguration
	// Add adds a document to the collection
	Add(ctx context.Context, opts ...CollectionAddOption) error
	// Upsert updates or adds a document to the collection
	Upsert(ctx context.Context, opts ...CollectionAddOption) error
	// Update updates a document in the collection
	Update(ctx context.Context, opts ...CollectionUpdateOption) error
	// Delete deletes documents from the collection
	Delete(ctx context.Context, opts ...CollectionDeleteOption) error
	// Count returns the number of documents in the collection
	Count(ctx context.Context) (int, error)
	// ModifyName modifies the name of the collection
	ModifyName(ctx context.Context, newName string) error
	// ModifyMetadata modifies the metadata of the collection
	ModifyMetadata(ctx context.Context, newMetadata CollectionMetadata) error
	// ModifyConfiguration modifies the configuration of the collection
	ModifyConfiguration(ctx context.Context, newConfig CollectionConfiguration) error // not supported yet
	// Get gets documents from the collection
	Get(ctx context.Context, opts ...CollectionGetOption) (GetResult, error)
	// Query queries the collection
	Query(ctx context.Context, opts ...CollectionQueryOption) (QueryResult, error)

	// Fork creates a fork of the collection
	Fork(ctx context.Context, newName string) (Collection, error)
	// Close closes the collection and releases any resources
	Close() error
}

type CollectionAddOp struct {
	Ids         []DocumentID       `json:"ids"`
	Documents   []Document         `json:"documents,omitempty"`
	Metadatas   []DocumentMetadata `json:"metadatas,omitempty"`
	Embeddings  []any              `json:"embeddings"`
	Records     []Record           `json:"-"`
	IDGenerator IDGenerator        `json:"-"`
}

type CollectionAddOption func(update *CollectionAddOp) error

type CollectionConfiguration interface {
	GetRaw(key string) (interface{}, bool)
}

type CollectionDeleteOp struct {
	FilterOp
	FilterIDOp
}

type CollectionDeleteOption func(update *CollectionDeleteOp) error

type CollectionGetOp struct {
	FilterOp          // ability to filter by where and whereDocument
	FilterIDOp        // ability to filter by id
	ProjectOp         // include metadatas, documents, embeddings, uris, ids
	LimitAndOffsetOp  // limit and offset
	SortOp            // sort
	ResourceOperation `json:"-"`
}

type CollectionGetOption func(get *CollectionGetOp) error

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)
	SetRaw(key string, value interface{})
	SetString(key, value string)
	SetInt(key string, value int64)
	SetFloat(key string, value float64)
	SetBool(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"`
}

type CollectionOp interface {
	// PrepareAndValidate validates the operation. Each operation must implement this method to ensure the operation is valid and can be sent over the wire
	PrepareAndValidate() error
	EmbedData(ctx context.Context, ef embeddings.EmbeddingFunction) error
	// MarshalJSON marshals the operation to JSON
	MarshalJSON() ([]byte, error)
	// UnmarshalJSON unmarshals the operation from JSON
	UnmarshalJSON(b []byte) error
}

type CollectionQueryOp struct {
	FilterOp
	FilterEmbeddingsOp
	FilterTextsOp
	LimitResultOp
	ProjectOp // include metadatas, documents, embeddings, uris
	FilterIDOp
}

type CollectionQueryOption func(query *CollectionQueryOp) error

type CollectionUpdateOp struct {
	Ids        []DocumentID       `json:"ids"`
	Documents  []Document         `json:"documents,omitempty"`
	Metadatas  []DocumentMetadata `json:"metadatas,omitempty"`
	Embeddings []any              `json:"embeddings"`
	Records    []Record           `json:"-"`
}

type CollectionUpdateOption func(update *CollectionUpdateOp) error

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"`
	Database Database           `json:"-"`
	// contains filtered or unexported fields
}

type CreateCollectionOption func(*CreateCollectionOp) error

type CredentialsProvider interface {
	Authenticate(apiClient *BaseAPIClient) 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 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)
	SetRaw(key string, value interface{})
	SetString(key, value string)
	SetInt(key string, value int64)
	SetFloat(key string, value float64)
	SetBool(key string, value bool)
}

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

type DocumentMetadatas []DocumentMetadata

type Documents []Document

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

type FilterIDOp struct {
	Ids []DocumentID `json:"ids,omitempty"`
}

type FilterOp struct {
	Where         WhereFilter         `json:"where,omitempty"`
	WhereDocument WhereDocumentFilter `json:"where_document,omitempty"`
}

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

type GenerateOptions struct {
	Document string
}

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

type GetCollectionOption func(*GetCollectionOp) error

type GetResult interface {
	// GetIDs returns the IDs of the documents in the result.
	GetIDs() DocumentIDs
	// GetDocuments returns the documents in the result.
	GetDocuments() Documents
	// GetMetadatas returns the metadatas of the documents in the result.
	GetMetadatas() DocumentMetadatas
	// GetEmbeddings returns the embeddings of the documents in the result.
	GetEmbeddings() embeddings.Embeddings
	// ToRecords converts the result to a Records object.
	ToRecords() Records
	// Count returns the number of documents in the result.
	Count() int
	// Next when using limint and offset, this will return the next page of results
	Next() (GetResult, error)
}

type GetResultImpl struct {
	Ids        DocumentIDs           `json:"ids,omitempty"`
	Documents  Documents             `json:"documents,omitempty"`
	Metadatas  DocumentMetadatas     `json:"metadatas,omitempty"`
	Embeddings embeddings.Embeddings `json:"embeddings,omitempty"`
	Include    []Include             `json:"include,omitempty"`
}

type IDGenerator interface {
	Generate(opts ...IDGeneratorOption) string
}

type IDGeneratorOption func(opts *GenerateOptions)

type Identity struct {
	UserID    string   `json:"user_id"`
	Tenant    string   `json:"tenant"`
	Databases []string `json:"databases"`
}

type Include string

type LimitAndOffsetOp struct {
	Limit  int `json:"limit,omitempty"`
	Offset int `json:"offset,omitempty"`
}

type LimitResultOp struct {
	NResults int `json:"n_results"`
}

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

type ListCollectionsOption func(*ListCollectionOp) error

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

type MetadataValue struct {
	Bool        *bool    `json:"-"`
	Float64     *float64 `json:"-"`
	Int         *int64   `json:"-"`
	StringValue *string  `json:"-"`
	NilValue    bool     `json:"-"`
}

type OperationType string

type Option func(*CollectionImpl) error

type PreFlightConditioner interface {
	// GetPreFlightConditionsRaw returns the raw preflight response.
	GetPreFlightConditionsRaw() map[string]interface{}
	// Satisfies evaluates the resource type and a given metric to determine if the preflight condition applies.
	Satisfies(resourceOperation ResourceOperation, metric interface{}, metricName string) error
}

type ProjectOp struct {
	Include []Include `json:"include,omitempty"`
}

type QueryResult interface {
	GetIDGroups() []DocumentIDs
	GetDocumentsGroups() []Documents
	GetMetadatasGroups() []DocumentMetadatas
	GetEmbeddingsGroups() []embeddings.Embeddings
	GetDistancesGroups() []embeddings.Distances
	ToRecordsGroups() []Records
	CountGroups() int
}

type QueryResultImpl struct {
	IDLists         []DocumentIDs           `json:"ids"`
	DocumentsLists  []Documents             `json:"documents,omitempty"`
	MetadatasLists  []DocumentMetadatas     `json:"metadatas,omitempty"`
	EmbeddingsLists []embeddings.Embeddings `json:"embeddings,omitempty"`
	DistancesLists  []embeddings.Distances  `json:"distances,omitempty"`
	Include         []Include               `json:"include,omitempty"`
}

type Record interface {
	ID() DocumentID
	Document() Document // should work for both text and URI based documents
	Embedding() embeddings.Embedding
	Metadata() DocumentMetadata
	Validate() error
	Unwrap() (DocumentID, Document, embeddings.Embedding, DocumentMetadata)
}

type RecordOption func(record *SimpleRecord) error

type Records []Record

type Resource string

type ResourceOperation interface {
	Resource() Resource
	Operation() OperationType
}

type SHA256Generator struct{}

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

type SortOp struct {
	Sort string `json:"sort,omitempty"`
}

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

type TenantBase struct {
	TenantName string `json:"name"`
}

type TextDocument struct {
	Content string
}

type TextDocuments []TextDocument

type TokenAuthCredentialsProvider struct {
	Token  string
	Header TokenTransportHeader
}

type TokenTransportHeader string

type ULIDGenerator struct{}

type UUIDGenerator struct{}

type WhereClause interface {
	Operator() WhereFilterOperator
	Key() string
	Operand() interface{}
	String() string
	Validate() error
	MarshalJSON() ([]byte, error)
	UnmarshalJSON(b []byte) error
}

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

type WhereClauseBool struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseBools struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseFloat struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseFloats struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseInt struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseInts struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseString struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseStrings struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereClauseWhereClauses struct {
	WhereClauseBase
	// contains filtered or unexported fields
}

type WhereDocumentClauseAnd struct {
	WhereDocumentFilterBase
	// contains filtered or unexported fields
}

type WhereDocumentClauseContainsOrNotContains struct {
	WhereDocumentFilterBase
	// contains filtered or unexported fields
}

type WhereDocumentClauseOr struct {
	WhereDocumentFilterBase
	// contains filtered or unexported fields
}

type WhereDocumentClauseRegexNotRegex struct {
	WhereDocumentFilterBase
	// contains filtered or unexported fields
}

type WhereDocumentFilter interface {
	Operator() WhereDocumentFilterOperator
	Operand() interface{}
	Validate() error
	String() string
	MarshalJSON() ([]byte, error)
	UnmarshalJSON(b []byte) error
}

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

type WhereDocumentFilterOperator string

type WhereFilter interface {
	String() string
	Validate() error
	MarshalJSON() ([]byte, error)
	UnmarshalJSON(b []byte) error
}

type WhereFilterOperator string