Re-exports§
pub use operators::*;
Modules§
- chroma_
proto - error
- operator
- operators
- Well-known operator IDs and names that are pre-populated in the database.
- operators_
generated - optional_
u128 - plan
- regex
Structs§
- AddCollection
Records Payload - AddCollection
Records Request - AddCollection
Records Response - Advance
Attached Function Response - Attach
Function Request - Attach
Function Response - Attached
Function - Attached
Function ApiResponse - API response struct for attached function with function_name instead of function_id
- Attached
Function Info - Attached
Function Update Info - Attached
Function Uuid - AttachedFunctionUuid is a wrapper around Uuid to provide a type for attached function identifiers.
- Bool
Inverted Index Config - Bool
Inverted Index Type - Bool
Value Type - Boolean value type index configurations
- Checklist
Response - Chroma
Resource Name - Chunk
- Collection
- Collection
AndSegments - Collection
Configuration - Collection
Flush Info - Collection
Uuid - CollectionUuid is a wrapper around Uuid to provide a type for the collection id.
- Composite
Expression - Count
Collections Request - Count
Request - Create
Collection Payload - Create
Collection Request - Create
Database Request - Create
Database Response - Create
Tenant Request - Create
Tenant Response - Data
Chunk Iteraror - Data
Record - Database
- Database
Uuid - DatabaseUuid is a wrapper around Uuid to provide a type for the database id.
- Delete
Collection Records Payload - Delete
Collection Records Request - Delete
Collection Records Response - Delete
Collection Request - Delete
Collection Response - Delete
Database Request - Delete
Database Response - Detach
Function Request - Detach
Function Response - Document
Expression - Embedding
Function NewConfiguration - Float
Inverted Index Config - Float
Inverted Index Type - Float
List Value Type - Float list value type index configurations (for vectors)
- Float
Value Type - Float value type index configurations
- Flush
Compaction AndAttached Function Response - Flush
Compaction Response - Fork
Collection Request - Fork
Logs Response - FtsIndex
Config - FtsIndex
Type - GetAttached
Function Response - GetCollection
ByCrn Request - GetCollection
Request - GetDatabase
Request - GetRequest
- GetRequest
Payload - GetResponse
- GetTenant
Request - GetTenant
Response - GetVectors
Result - Health
Check Response - Hnsw
Configuration - Hnsw
Index Config - Configuration for HNSW vector index algorithm parameters
- Include
List - Include
Parsing Error - IntInverted
Index Config - IntInverted
Index Type - IntValue
Type - Integer value type index configurations
- Internal
Collection Configuration - Internal
Hnsw Configuration - Internal
Spann Configuration - Internal
Update Collection Configuration - JobId
- JobId is a wrapper around Uuid to provide a unified type for job identifiers. Jobs can be either collection compaction jobs or task execution jobs.
- List
Collections Request - List
Databases Request - LogRecord
- Metadata
Delta - Metadata
Embedding Record - Metadata
Expression - Operation
Record - Query
Request - Query
Request Payload - Query
Response - RawWhere
Fields - Reset
Response - Schema
- Schema representation for collection index configurations
- Search
Request - Search
Request Payload - Search
Response - Segment
- Segment
Flush Info - Segment
Uuid - SegmentUuid is a wrapper around Uuid to provide a type for the segment id.
- Spann
Configuration - Spann
Index Config - Configuration for SPANN vector index algorithm parameters
- Spann
Posting List - Sparse
Vector - Represents a sparse vector using parallel arrays for indices and values.
- Sparse
Vector Index Config - Sparse
Vector Index Type - Sparse
Vector Length Mismatch - Length mismatch between indices, values, and tokens in a sparse vector.
- Sparse
Vector Value Type - Sparse vector value type index configurations
- String
Inverted Index Config - String
Inverted Index Type - String
Value Type - String value type index configurations
- Tenant
- Update
Collection Configuration - Update
Collection Payload - Update
Collection Records Payload - Update
Collection Records Request - Update
Collection Records Response - Update
Collection Request - Update
Collection Response - Update
Hnsw Configuration - Update
Spann Configuration - Update
Tenant Request - Update
Tenant Response - Upsert
Collection Records Payload - Upsert
Collection Records Request - Upsert
Collection Records Response - Value
Types - Strongly-typed value type configurations Contains optional configurations for each supported value type
- Vector
Embedding Record - Vector
Index Config - Vector
Index Type - Vector
Query Result
Enums§
- AddCollection
Records Error - Advance
Attached Function Error - Attach
Function Error - Attached
Function Conversion Error - Base64
Decode Error - Batch
GetCollection Soft Delete Status Error - Batch
GetCollection Version File Paths Error - Boolean
Operator - Cmek
- Customer-managed encryption key for storage encryption.
- Collection
Configuration ToInternal Configuration Error - Collection
Conversion Error - Collection
Flush Info Conversion Error - Collection
Metadata Update - Collection
ToProto Error - Conversion
Error - Count
Collections Error - Count
Forks Error - Create
Collection Error - Create
Database Error - Create
Tenant Error - Delete
Collection Error - Delete
Collection Records Error - Delete
Database Error - Detach
Function Error - Dirty
Marker - Markers for tracking collection compaction state changes.
- Distributed
Spann Parameters From Segment Error - Document
Operator - Embedding
Function Configuration - Embeddings
Payload - Executor
Error - Filter
Validation Error - Finish
Attached Function Error - Finish
Create Attached Function Error - Finish
Database Deletion Error - Flush
Compaction Response Conversion Error - Fork
Collection Error - GetAttached
Function Error - GetCollection
ByCrn Error - GetCollection
Error - GetCollection
Size Error - GetCollection
With Segments Error - GetCollections
Error - GetDatabase
Error - GetMin
Completion Offset Error - GetSegments
Error - GetTenant
Error - Heartbeat
Error - Hnsw
Parameters From Segment Error - Include
- Index
Config - Union type for all index configurations (used by builder pattern)
- KnnIndex
- List
Attached Functions Error - List
Collection Versions Error - List
Databases Error - Materialized
LogOperation - Metadata
Comparison - Metadata
SetValue - Metadata
Value - Metadata
Value Conversion Error - Metadata
Value Type - Operation
- Operation
Conversion Error - Primitive
Operator - Query
Error - Record
Conversion Error - Reset
Error - Scalar
Encoding - Scalar
Encoding Conversion Error - Schema
Builder Error - Schema
Error - Segment
Conversion Error - Segment
Flush Info Conversion Error - Segment
Scope - Segment
Scope Conversion Error - Segment
Type - SetOperator
- Signed
Roaring Bitmap - This enum helps to delay the evaluation of set minus in metadata filtering:
- Space
- Update
Collection Configuration ToInternal Configuration Error - Update
Collection Configuration ToInternal Update Configuration Error - Update
Collection Error - Update
Collection Records Error - Update
Embeddings Payload - Update
Metadata Value - Update
Metadata Value Conversion Error - Update
Tenant Error - Update
Vector Index Configuration - Upsert
Collection Records Error - Vector
Conversion Error - Vector
Index Configuration - Where
- This
Whereenum serves as an unified representation for thewhereandwhere_documentclauses. 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 bothwhereandwhere_documentclauses will be translated intoWhere, 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 thewhereandwhere_documentclauses are treated seperately. - Where
Conversion Error - Where
Error - Where
Validation Error - Wrapped
Serde Json Error
Constants§
- BOOL_
INVERTED_ INDEX_ NAME - BOOL_
METADATA - BOOL_
VALUE_ NAME - CHROMA_
DOCUMENT_ KEY - CHROMA_
KEY - CHROMA_
URI_ KEY - DOCUMENT_
KEY - EMBEDDING_
KEY - F32_
METADATA - FLOAT_
INVERTED_ INDEX_ NAME - FLOAT_
LIST_ VALUE_ NAME - FLOAT_
VALUE_ NAME - FTS_
INDEX_ NAME - FULL_
TEXT_ PLS - HNSW_
PATH - INT_
INVERTED_ INDEX_ NAME - INT_
VALUE_ NAME - MAX_
HEAD_ ID_ BF_ PATH - MAX_
OFFSET_ ID - OFFSET_
ID_ TO_ DATA - OFFSET_
ID_ TO_ USER_ ID - POSTING_
LIST_ PATH - SPARSE_
MAX - SPARSE_
OFFSET_ VALUE - SPARSE_
VECTOR_ INDEX_ NAME - SPARSE_
VECTOR_ VALUE_ NAME - STRING_
INVERTED_ INDEX_ NAME - STRING_
METADATA - STRING_
VALUE_ NAME - U32_
METADATA - USER_
ID_ TO_ OFFSET_ ID - VECTOR_
INDEX_ NAME - VERSION_
MAP_ PATH
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