Crate chroma_types

Crate chroma_types

Re-exports§

pub use operators::*;

Modules§

chroma_proto
error
operator
operators: Well-known operator IDs and names that are pre-populated in the database.
optional_u128
plan
regex

Structs§

AddCollectionRecordsPayload
AddCollectionRecordsRequest
AddCollectionRecordsResponse
BoolInvertedIndexConfig
BoolInvertedIndexType
BoolValueType: Boolean value type index configurations
ChecklistResponse
ChromaResourceName
Chunk
Collection
CollectionAndSegments
CollectionConfiguration
CollectionUuid: CollectionUuid is a wrapper around Uuid to provide a type for the collection id.
CompositeExpression
CountCollectionsRequest
CountRequest
CreateCollectionPayload
CreateCollectionRequest
CreateDatabaseRequest
CreateDatabaseResponse
CreateTaskRequest
CreateTaskResponse
CreateTenantRequest
CreateTenantResponse
DataChunkIteraror
DataRecord
Database
DatabaseUuid: DatabaseUuid is a wrapper around Uuid to provide a type for the database id.
DeleteCollectionRecordsPayload
DeleteCollectionRecordsRequest
DeleteCollectionRecordsResponse
DeleteCollectionRequest
DeleteCollectionResponse
DeleteDatabaseRequest
DeleteDatabaseResponse
DocumentExpression
EmbeddingFunctionNewConfiguration
FloatInvertedIndexConfig
FloatInvertedIndexType
FloatListValueType: Float list value type index configurations (for vectors)
FloatValueType: Float value type index configurations
FlushCompactionResponse
ForkCollectionRequest
ForkLogsResponse
FtsIndexConfig
FtsIndexType
GetCollectionByCrnRequest
GetCollectionRequest
GetDatabaseRequest
GetRequest
GetRequestPayload
GetResponse
GetTenantRequest
GetTenantResponse
GetVectorsResult
HealthCheckResponse
HnswConfiguration
HnswIndexConfig: Configuration for HNSW vector index algorithm parameters
IncludeList
IncludeParsingError
IntInvertedIndexConfig
IntInvertedIndexType
IntValueType: Integer value type index configurations
InternalCollectionConfiguration
InternalHnswConfiguration
InternalSpannConfiguration
InternalUpdateCollectionConfiguration
ListCollectionsRequest
ListDatabasesRequest
LogRecord
MetadataDelta
MetadataEmbeddingRecord
MetadataExpression
OperationRecord
QueryRequest
QueryRequestPayload
QueryResponse
RawWhereFields
RemoveTaskRequest
RemoveTaskResponse
ResetResponse
ScheduleEntry: ScheduleEntry represents a scheduled task run for a collection.
Schema: Schema representation for collection index configurations
SearchRequest
SearchRequestPayload
SearchResponse
Segment
SegmentFlushInfo
SegmentUuid: SegmentUuid is a wrapper around Uuid to provide a type for the segment id.
SpannConfiguration
SpannIndexConfig: Configuration for SPANN vector index algorithm parameters
SpannPostingList
SparseVector: Represents a sparse vector using parallel arrays for indices and values.
SparseVectorIndexConfig
SparseVectorIndexType
SparseVectorValueType: Sparse vector value type index configurations
StringInvertedIndexConfig
StringInvertedIndexType
StringValueType: String value type index configurations
Task: Task represents an asynchronous task that is triggered by collection writes to map records from a source collection to a target collection.
TaskUuid: TaskUuid is a wrapper around Uuid to provide a type for task identifiers.
Tenant
UpdateCollectionConfiguration
UpdateCollectionPayload
UpdateCollectionRecordsPayload
UpdateCollectionRecordsRequest
UpdateCollectionRecordsResponse
UpdateCollectionRequest
UpdateCollectionResponse
UpdateHnswConfiguration
UpdateSpannConfiguration
UpdateTenantRequest
UpdateTenantResponse
UpsertCollectionRecordsPayload
UpsertCollectionRecordsRequest
UpsertCollectionRecordsResponse
ValueTypes: Strongly-typed value type configurations Contains optional configurations for each supported value type
VectorEmbeddingRecord
VectorIndexConfig
VectorIndexType
VectorQueryResult

Enums§

AddCollectionRecordsError
AddTaskError
Base64DecodeError
BatchGetCollectionSoftDeleteStatusError
BatchGetCollectionVersionFilePathsError
BooleanOperator
CollectionConfigurationToInternalConfigurationError
CollectionConversionError
CollectionMetadataUpdate
CollectionToProtoError
ConversionError
CountCollectionsError
CountForksError
CreateCollectionError
CreateDatabaseError
CreateTenantError
DeleteCollectionError
DeleteCollectionRecordsError
DeleteDatabaseError
DirtyMarker: Markers for tracking collection compaction state changes.
DistributedSpannParametersFromSegmentError
DocumentOperator
EmbeddingFunctionConfiguration
EmbeddingsPayload
ExecutorError
FilterValidationError
FinishDatabaseDeletionError
FlushCompactionResponseConversionError
ForkCollectionError
GetCollectionByCrnError
GetCollectionError
GetCollectionSizeError
GetCollectionWithSegmentsError
GetCollectionsError
GetDatabaseError
GetSegmentsError
GetTenantError
HeartbeatError
HnswParametersFromSegmentError
Include
KnnIndex
ListCollectionVersionsError
ListDatabasesError
MaterializedLogOperation
MetadataComparison
MetadataSetValue
MetadataValue
MetadataValueConversionError
MetadataValueType
Operation
OperationConversionError
PrimitiveOperator
QueryError
RecordConversionError
RemoveTaskError
ResetError
ScalarEncoding
ScalarEncodingConversionError
ScheduleEntryConversionError
SchemaError
SegmentConversionError
SegmentFlushInfoConversionError
SegmentScope
SegmentScopeConversionError
SegmentType
SetOperator
SignedRoaringBitmap: This enum helps to delay the evaluation of set minus in metadata filtering:
Space
UpdateCollectionConfigurationToInternalConfigurationError
UpdateCollectionConfigurationToInternalUpdateConfigurationError
UpdateCollectionError
UpdateCollectionRecordsError
UpdateEmbeddingsPayload
UpdateMetadataValue
UpdateMetadataValueConversionError
UpdateTenantError
UpdateVectorIndexConfiguration
UpsertCollectionRecordsError
VectorConversionError
VectorIndexConfiguration
Where: This Where enum serves as an unified representation for the where and where_document clauses. Although this is not unified in the API level due to legacy design choices, in the future we will be unifying them together, and the structure of the unified AST should be identical to the one here. Currently both where and where_document clauses will be translated into Where, and if both are present we simply create a conjunction of both clauses as the actual filter. This is consistent with the semantics we used to have when the where and where_document clauses are treated seperately.
WhereConversionError
WhereError
WhereValidationError
WrappedSerdeJsonError

Constants§

Functions§

are_metadatas_close_to_equal
are_update_metadatas_close_to_equal: Check if two metadata are close to equal. Ignores small differences in float values.
decode_base64_embedding
decode_base64_embeddings
decode_base64_update_embeddings
decode_embeddings
default_batch_size
default_construction_ef
default_construction_ef_spann
default_default_knn_index
default_initial_lambda
default_m
default_m_spann
default_merge_threshold
default_nreplica_count
default_num_centers_to_merge_to
default_num_samples_kmeans
default_num_threads
default_reassign_neighbor_count
default_resize_factor
default_search_ef
default_search_ef_spann
default_search_nprobe
default_search_rng_epsilon
default_search_rng_factor
default_space
default_split_threshold
default_sync_threshold
default_write_nprobe
default_write_rng_epsilon
default_write_rng_factor
dirty_log_path_from_hostname
get_metadata_value_as
is_embedding_function_default
is_hnsw_config_default: Check if HNSW config is default
is_space_default: Check if space is default (None means default, or if present, should be default space)
logical_size_of_metadata
maybe_decode_update_embeddings
parse_where
parse_where_document
test_segment

Type Aliases§

CountCollectionsResponse
CountResponse
CreateCollectionResponse
DeletedMetadata
ForkCollectionResponse
GetCollectionByCrnResponse
GetCollectionResponse
GetDatabaseResponse
ListCollectionsResponse
ListDatabasesResponse
Metadata
UpdateMetadata