Expand description
Type definitions and re-exports for client requests and responses.
Structs§
- AddCollection
Records Payload - Payload for adding records to a collection.
- AddCollection
Records Request - AddCollection
Records Response - Bool
Inverted Index Config - Bool
Inverted Index Type - Bool
Value Type - Boolean value type index configurations
- Chroma
Regex - Chroma custom wrapper for a Regex pattern.
- Collection
- Collection
Configuration - Composite
Expression - Count
Collections Request - Create
Collection Request - Data
Chunk Iteraror - Delete
Collection Records Payload - Payload for deleting records from a collection.
- Delete
Collection Records Request - Delete
Collection Records Response - Delete
Collection Request - Document
Expression - Embedding
Function NewConfiguration - Filter
- Filter the search results.
- 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
- Fork
Collection Request - FtsIndex
Config - FtsIndex
Type - GetRequest
- GetResponse
- All arrays have the same length, with each index representing a single record.
Only fields specified in the request’s
includeparameter are populated. - GetUser
Identity Response - GroupBy
- Groups results by metadata keys and aggregates within each group.
- Heartbeat
Response - Hnsw
Configuration - Hnsw
Index Config - Configuration for HNSW vector index algorithm parameters
- Include
List - Index
Status Response - IntInverted
Index Config - IntInverted
Index Type - IntValue
Type - Integer value type index configurations
- Limit
- Pagination control for search results.
- Metadata
Expression - Query
Request - Query
Response - Rank
- Wrapper for ranking expressions in search queries.
- Schema
- Schema representation for collection index configurations
- Search
Payload - A search payload for the hybrid search API.
- Search
Request - Search
Response - Segment
- Select
- Field selection for search results.
- Spann
Configuration - Spann
Index Config - Configuration for SPANN vector index algorithm parameters
- Sparse
Vector - Represents a sparse vector using parallel arrays for indices and values.
- Sparse
Vector Index Config - Sparse
Vector Index Type - 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
- Update
Collection Configuration - Update
Collection Records Payload - Payload for updating existing records in a collection.
- Update
Collection Records Request - Update
Collection Records Response - Update
Collection Request - Update
Hnsw Configuration - Update
Spann Configuration - Upsert
Collection Records Payload - Payload for upserting records in a collection.
- Upsert
Collection Records Request - Upsert
Collection Records Response - Value
Types - Strongly-typed value type configurations Contains optional configurations for each supported value type
- Vector
Index Config - Vector
Index Type
Enums§
- Aggregate
- Aggregation function applied within each group.
- Base64
Decode Error - Boolean
Operator - Chroma
Hir - Chroma custom internal representation for a Regex pattern.
- Cmek
- Customer-managed encryption key for storage encryption.
- Collection
Conversion Error - Collection
ToProto Error - Contains
Operator - Distributed
Spann Parameters From Segment Error - Document
Operator - Embedding
Function Configuration - Executor
Error - Filter
Validation Error - FtsAlgorithm
- Full-text search index algorithm.
- GetCollection
With Segments Error - Heartbeat
Error - Hnsw
Parameters From Segment Error - Include
- Use this enum to specify which fields should be returned when retrieving records.
- Index
Status Error - Key
- Represents a field key in search queries.
- Metadata
Comparison - Metadata
SetValue - Metadata
Value - Primitive
Operator - Query
Error - Query
Vector - A query vector for KNN search.
- Rank
Expr - A ranking expression for scoring and ordering search results.
- Read
Level - Scalar
Encoding - Schema
Builder Error - Schema
Error - Segment
Scope Conversion Error - SetOperator
- Space
- Sparse
Index Algorithm - Sparse vector index algorithm.
- Update
Embeddings Payload - Update
Metadata Value - Update
Tenant 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
Error
Functions§
- rrf
- Reciprocal Rank Fusion (RRF) - combines multiple ranking strategies.