Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.topk.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Classes

​
FieldIndex

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

​
FieldSpec

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

​
required()

required(self) -> FieldSpec
Mark a field as required. All fields are optional by default. Example: 
from topk_sdk.schema import text

client.collections().create("books", schema={
    "title": text().required()
})
Returns FieldSpec

​
optional()

optional(self) -> FieldSpec
Returns FieldSpec

​
index()

index(self, index: FieldIndex) -> FieldSpec
Create an index on a field. Example: 
from topk_sdk.schema import text, keyword_index

client.collections().create("books", schema={
    "title": text().index(keyword_index())
})
Parameters
ParameterType
indexFieldIndex
Returns FieldSpec

​
Functions

​
text()

text() -> FieldSpec
Create a FieldSpec type for text values. Example: 
from topk_sdk.schema import text

client.collections().create("books", schema={
    "title": text()
})
Returns FieldSpec

​
int()

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

​
float()

float() -> FieldSpec
Create a FieldSpec type for float values. Example: 
from topk_sdk.schema import float

client.collections().create("books", schema={
    "price": float()
})
Returns FieldSpec

​
bool()

bool() -> FieldSpec
Create a FieldSpec type for bool values. Example: 
from topk_sdk.schema import bool

client.collections().create("books", schema={
    "is_published": bool()
})
Returns FieldSpec

​
f8_vector()

f8_vector(dimension: int) -> FieldSpec
Create a FieldSpec type for f8_vector values. Example: 
from topk_sdk.schema import f8_vector

client.collections().create("books", schema={
    "title_embedding": f8_vector(dimension=1536)
})
Parameters
ParameterType
dimensionint
Returns FieldSpec

​
f16_vector()

f16_vector(dimension: int) -> FieldSpec
Create a FieldSpec type for f16_vector values. Example: 
from topk_sdk.schema import f16_vector

client.collections().create("books", schema={
    "title_embedding": f16_vector(dimension=1536)
})
Parameters
ParameterType
dimensionint
Returns FieldSpec

​
f32_vector()

f32_vector(dimension: int) -> FieldSpec
Create a FieldSpec type for f32_vector values. Example: 
from topk_sdk.schema import f32_vector

client.collections().create("books", schema={
    "title_embedding": f32_vector(dimension=1536)
})
Parameters
ParameterType
dimensionint
Returns FieldSpec

​
u8_vector()

u8_vector(dimension: int) -> FieldSpec
Create a FieldSpec type for u8_vector values. Example: 
from topk_sdk.schema import u8_vector

client.collections().create("books", schema={
    "title_embedding": u8_vector(dimension=1536)
})
Parameters
ParameterType
dimensionint
Returns FieldSpec

​
i8_vector()

i8_vector(dimension: int) -> FieldSpec
Create a FieldSpec type for i8_vector values. Example: 
from topk_sdk.schema import i8_vector

client.collections().create("books", schema={
    "title_embedding": i8_vector(dimension=1536)
})
Parameters
ParameterType
dimensionint
Returns FieldSpec

​
binary_vector()

binary_vector(dimension: int) -> FieldSpec
Create a FieldSpec type for binary_vector values. Example: 
from topk_sdk.schema import binary_vector

client.collections().create("books", schema={
    "title_embedding": binary_vector(dimension=128)
})
Parameters
ParameterType
dimensionint
Returns FieldSpec

​
f32_sparse_vector()

f32_sparse_vector() -> FieldSpec
Create a FieldSpec type for f32_sparse_vector values. Note: Sparse vectors use u32 dimension indices to support dictionaries of up to 2^32 - 1 terms. Example: 
from topk_sdk.schema import f32_sparse_vector

client.collections().create("books", schema={
    "sparse_field": f32_sparse_vector()
})
Returns FieldSpec

​
u8_sparse_vector()

u8_sparse_vector() -> FieldSpec
Create a FieldSpec type for u8_sparse_vector values. Note: Sparse vectors use u32 dimension indices to support dictionaries of up to 2^32 - 1 terms. Example: 
from topk_sdk.schema import u8_sparse_vector

client.collections().create("books", schema={
    "sparse_field": u8_sparse_vector()
})
Returns FieldSpec

​
bytes()

bytes() -> FieldSpec
Create a FieldSpec type for bytes values. Example: 
from topk_sdk.schema import bytes

client.collections().create("books", schema={
    "image": bytes()
})
Returns FieldSpec

​
list()

list(value_type: Literal['text', 'integer', 'float']) -> FieldSpec
Create a FieldSpec type for list values. Example: 
from topk_sdk.schema import list

client.collections().create("books", schema={
    "tags": list(value_type="text")
})
Parameters
ParameterType
value_typeLiteral[‘text’, ‘integer’, ‘float’]
Returns FieldSpec

​
matrix()

matrix(dimension: int, value_type: Literal['f32', 'f16', 'f8', 'u8', 'i8']) -> FieldSpec
Create a FieldSpec type for matrix values. Supported value_types:
  • f32
  • f16
  • f8
  • u8
  • i8
Example: 
from topk_sdk.schema import matrix

client.collections().create("books", schema={
    "title_embedding": matrix(dimension=1536, value_type="f32")
})
Parameters
ParameterType
dimensionint
value_typeLiteral[‘f32’, ‘f16’, ‘f8’, ‘u8’, ‘i8’]
Returns FieldSpec

​
vector_index()

vector_index(metric: Literal['cosine', 'euclidean', 'dot_product', 'hamming']) -> FieldIndex
Create a FieldIndex type for vector_index values. Supported metrics:
  • euclidean (only dense vectors)
  • cosine (only dense vectors)
  • dot_product (dense and sparse vectors)
  • hamming (only binary vectors)
Example: 
from topk_sdk.schema import f32_vector, vector_index

client.collections().create("books", schema={
    "title_embedding": f32_vector(dimension=1536).index(vector_index(metric="cosine"))
})
Parameters
ParameterType
metricLiteral[‘cosine’, ‘euclidean’, ‘dot_product’, ‘hamming’]
Returns FieldIndex

​
keyword_index()

keyword_index() -> FieldIndex
Create a FieldIndex type for keyword_index values. Example: 
from topk_sdk.schema import text, keyword_index

client.collections().create("books", schema={
    "title": text().index(keyword_index())
})
Returns FieldIndex

​
semantic_index()

semantic_index() -> FieldIndex
Create a FieldIndex type for semantic_index values. Example: 
from topk_sdk.schema import text, semantic_index

client.collections().create("books", schema={
    "title": text().index(semantic_index())
})
Returns FieldIndex

​
multi_vector_index()

multi_vector_index(
   metric: Literal['maxsim'],
   quantization: Optional[Literal['1bit', '2bit', 'scalar']] = None,
   width: Optional[int] = None,
   top_k: Optional[int] = None
)
Create a FieldIndex type for multi_vector_index values. Supported metrics:
  • maxsim
Example: 
from topk_sdk.schema import matrix, multi_vector_index

client.collections().create("books", schema={
    "title_embedding": matrix(dimension=1536, value_type="f32").index(multi_vector_index(metric="maxsim"))
})
Parameters
ParameterType
metricLiteral[‘maxsim’]
quantizationOptional[Literal[‘1bit’, ‘2bit’, ‘scalar’]]
widthOptional[int]
top_kOptional[int]
Returns FieldIndex