​
Classes

​
FieldIndex

Internal Instances of the FieldIndex class represents a field index created by vector_index, keyword_index, or semantic_index functions.

​
FieldSpec

Internal Instances of the FieldSpec class represents a field specification created by text, int, float, bool, f32_vector, u8_vector, binary_vector, f32_sparse_vector, u8_sparse_vector, bytes, or list functions. Methods

​
required()

required(self) -> FieldSpec
Returns FieldSpec

​
optional()

optional(self) -> FieldSpec
Returns FieldSpec

​
index()

index(self, index: FieldIndex) -> FieldSpec
Parameters
ParameterType
indexFieldIndex
Returns FieldSpec

​
Functions

​
text()

text() -> FieldSpec
Create a text field specification. Returns FieldSpec

​
int()

int() -> FieldSpec
Create an integer field specification. Returns FieldSpec

​
float()

float() -> FieldSpec
Create a float field specification. Returns FieldSpec

​
bool()

bool() -> FieldSpec
Create a boolean field specification. Returns FieldSpec

​
f32_vector()

f32_vector(dimension: int) -> FieldSpec
Create a 32-bit float vector field specification. Parameters
ParameterType
dimensionint
Returns FieldSpec

​
u8_vector()

u8_vector(dimension: int) -> FieldSpec
Create an 8-bit unsigned integer vector field specification. Parameters
ParameterType
dimensionint
Returns FieldSpec

​
binary_vector()

binary_vector(dimension: int) -> FieldSpec
Create a binary vector field specification. Parameters
ParameterType
dimensionint
Returns FieldSpec

​
f32_sparse_vector()

f32_sparse_vector() -> FieldSpec
Create a f32 sparse vector field specification. Returns FieldSpec

​
u8_sparse_vector()

u8_sparse_vector() -> FieldSpec
Create a u8 sparse vector field specification. Returns FieldSpec

​
bytes()

bytes() -> FieldSpec
Create a bytes field specification. Returns FieldSpec

​
list()

list(value_type: Literal['text', 'integer', 'float']) -> FieldSpec
Create a list field specification. Parameters
ParameterType
value_typeLiteral[‘text’, ‘integer’, ‘float’]
Returns FieldSpec

​
vector_index()

vector_index(metric: Literal['cosine', 'euclidean', 'dot_product', 'hamming']) -> FieldIndex
Create a vector index on a vector field. Parameters
ParameterType
metricLiteral[‘cosine’, ‘euclidean’, ‘dot_product’, ‘hamming’]
Returns FieldIndex

​
keyword_index()

keyword_index() -> FieldIndex
Create a keyword index on a text field. Returns FieldIndex

​
semantic_index()

semantic_index(model: str) -> FieldIndex
Create a semantic index on a text field. Parameters
ParameterType
modelstr
Returns FieldIndex