from . import common_pb2 as _common_pb2
from google.protobuf import descriptor_pb2 as _descriptor_pb2
from google.protobuf.internal import containers as _containers
from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
from google.protobuf import descriptor as _descriptor
from google.protobuf import message as _message
from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
DESCRIPTOR: _descriptor.FileDescriptor
class DataType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
None: _ClassVar[DataType]
Bool: _ClassVar[DataType]
Int8: _ClassVar[DataType]
Int16: _ClassVar[DataType]
Int32: _ClassVar[DataType]
Int64: _ClassVar[DataType]
Float: _ClassVar[DataType]
Double: _ClassVar[DataType]
String: _ClassVar[DataType]
VarChar: _ClassVar[DataType]
Array: _ClassVar[DataType]
JSON: _ClassVar[DataType]
Geometry: _ClassVar[DataType]
BinaryVector: _ClassVar[DataType]
FloatVector: _ClassVar[DataType]
Float16Vector: _ClassVar[DataType]
BFloat16Vector: _ClassVar[DataType]
SparseFloatVector: _ClassVar[DataType]
class FunctionType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
Unknown: _ClassVar[FunctionType]
BM25: _ClassVar[FunctionType]
TextEmbedding: _ClassVar[FunctionType]
class FieldState(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
FieldCreated: _ClassVar[FieldState]
FieldCreating: _ClassVar[FieldState]
FieldDropping: _ClassVar[FieldState]
FieldDropped: _ClassVar[FieldState]
None: DataType
Bool: DataType
Int8: DataType
Int16: DataType
Int32: DataType
Int64: DataType
Float: DataType
Double: DataType
String: DataType
VarChar: DataType
Array: DataType
JSON: DataType
Geometry: DataType
BinaryVector: DataType
FloatVector: DataType
Float16Vector: DataType
BFloat16Vector: DataType
SparseFloatVector: DataType
Unknown: FunctionType
BM25: FunctionType
TextEmbedding: FunctionType
FieldCreated: FieldState
FieldCreating: FieldState
FieldDropping: FieldState
FieldDropped: FieldState
class FieldSchema(_message.Message):
__slots__ = ("fieldID", "name", "is_primary_key", "description", "data_type", "type_params", "index_params", "autoID", "state", "element_type", "default_value", "is_dynamic", "is_partition_key", "is_clustering_key", "nullable", "is_function_output")
FIELDID_FIELD_NUMBER: _ClassVar[int]
NAME_FIELD_NUMBER: _ClassVar[int]
IS_PRIMARY_KEY_FIELD_NUMBER: _ClassVar[int]
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
DATA_TYPE_FIELD_NUMBER: _ClassVar[int]
TYPE_PARAMS_FIELD_NUMBER: _ClassVar[int]
INDEX_PARAMS_FIELD_NUMBER: _ClassVar[int]
AUTOID_FIELD_NUMBER: _ClassVar[int]
STATE_FIELD_NUMBER: _ClassVar[int]
ELEMENT_TYPE_FIELD_NUMBER: _ClassVar[int]
DEFAULT_VALUE_FIELD_NUMBER: _ClassVar[int]
IS_DYNAMIC_FIELD_NUMBER: _ClassVar[int]
IS_PARTITION_KEY_FIELD_NUMBER: _ClassVar[int]
IS_CLUSTERING_KEY_FIELD_NUMBER: _ClassVar[int]
NULLABLE_FIELD_NUMBER: _ClassVar[int]
IS_FUNCTION_OUTPUT_FIELD_NUMBER: _ClassVar[int]
fieldID: int
name: str
is_primary_key: bool
description: str
data_type: DataType
type_params: _containers.RepeatedCompositeFieldContainer[_common_pb2.KeyValuePair]
index_params: _containers.RepeatedCompositeFieldContainer[_common_pb2.KeyValuePair]
autoID: bool
state: FieldState
element_type: DataType
default_value: ValueField
is_dynamic: bool
is_partition_key: bool
is_clustering_key: bool
nullable: bool
is_function_output: bool
def __init__(self, fieldID: _Optional[int] = ..., name: _Optional[str] = ..., is_primary_key: bool = ..., description: _Optional[str] = ..., data_type: _Optional[_Union[DataType, str]] = ..., type_params: _Optional[_Iterable[_Union[_common_pb2.KeyValuePair, _Mapping]]] = ..., index_params: _Optional[_Iterable[_Union[_common_pb2.KeyValuePair, _Mapping]]] = ..., autoID: bool = ..., state: _Optional[_Union[FieldState, str]] = ..., element_type: _Optional[_Union[DataType, str]] = ..., default_value: _Optional[_Union[ValueField, _Mapping]] = ..., is_dynamic: bool = ..., is_partition_key: bool = ..., is_clustering_key: bool = ..., nullable: bool = ..., is_function_output: bool = ...) -> None: ...
class FunctionSchema(_message.Message):
__slots__ = ("name", "id", "description", "type", "input_field_names", "input_field_ids", "output_field_names", "output_field_ids", "params")
NAME_FIELD_NUMBER: _ClassVar[int]
ID_FIELD_NUMBER: _ClassVar[int]
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
TYPE_FIELD_NUMBER: _ClassVar[int]
INPUT_FIELD_NAMES_FIELD_NUMBER: _ClassVar[int]
INPUT_FIELD_IDS_FIELD_NUMBER: _ClassVar[int]
OUTPUT_FIELD_NAMES_FIELD_NUMBER: _ClassVar[int]
OUTPUT_FIELD_IDS_FIELD_NUMBER: _ClassVar[int]
PARAMS_FIELD_NUMBER: _ClassVar[int]
name: str
id: int
description: str
type: FunctionType
input_field_names: _containers.RepeatedScalarFieldContainer[str]
input_field_ids: _containers.RepeatedScalarFieldContainer[int]
output_field_names: _containers.RepeatedScalarFieldContainer[str]
output_field_ids: _containers.RepeatedScalarFieldContainer[int]
params: _containers.RepeatedCompositeFieldContainer[_common_pb2.KeyValuePair]
def __init__(self, name: _Optional[str] = ..., id: _Optional[int] = ..., description: _Optional[str] = ..., type: _Optional[_Union[FunctionType, str]] = ..., input_field_names: _Optional[_Iterable[str]] = ..., input_field_ids: _Optional[_Iterable[int]] = ..., output_field_names: _Optional[_Iterable[str]] = ..., output_field_ids: _Optional[_Iterable[int]] = ..., params: _Optional[_Iterable[_Union[_common_pb2.KeyValuePair, _Mapping]]] = ...) -> None: ...
class CollectionSchema(_message.Message):
__slots__ = ("name", "description", "autoID", "fields", "enable_dynamic_field", "properties", "functions")
NAME_FIELD_NUMBER: _ClassVar[int]
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
AUTOID_FIELD_NUMBER: _ClassVar[int]
FIELDS_FIELD_NUMBER: _ClassVar[int]
ENABLE_DYNAMIC_FIELD_FIELD_NUMBER: _ClassVar[int]
PROPERTIES_FIELD_NUMBER: _ClassVar[int]
FUNCTIONS_FIELD_NUMBER: _ClassVar[int]
name: str
description: str
autoID: bool
fields: _containers.RepeatedCompositeFieldContainer[FieldSchema]
enable_dynamic_field: bool
properties: _containers.RepeatedCompositeFieldContainer[_common_pb2.KeyValuePair]
functions: _containers.RepeatedCompositeFieldContainer[FunctionSchema]
def __init__(self, name: _Optional[str] = ..., description: _Optional[str] = ..., autoID: bool = ..., fields: _Optional[_Iterable[_Union[FieldSchema, _Mapping]]] = ..., enable_dynamic_field: bool = ..., properties: _Optional[_Iterable[_Union[_common_pb2.KeyValuePair, _Mapping]]] = ..., functions: _Optional[_Iterable[_Union[FunctionSchema, _Mapping]]] = ...) -> None: ...
class BoolArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[bool]
def __init__(self, data: _Optional[_Iterable[bool]] = ...) -> None: ...
class IntArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[int]
def __init__(self, data: _Optional[_Iterable[int]] = ...) -> None: ...
class LongArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[int]
def __init__(self, data: _Optional[_Iterable[int]] = ...) -> None: ...
class FloatArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[float]
def __init__(self, data: _Optional[_Iterable[float]] = ...) -> None: ...
class DoubleArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[float]
def __init__(self, data: _Optional[_Iterable[float]] = ...) -> None: ...
class BytesArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[bytes]
def __init__(self, data: _Optional[_Iterable[bytes]] = ...) -> None: ...
class StringArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[str]
def __init__(self, data: _Optional[_Iterable[str]] = ...) -> None: ...
class ArrayArray(_message.Message):
__slots__ = ("data", "element_type")
DATA_FIELD_NUMBER: _ClassVar[int]
ELEMENT_TYPE_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedCompositeFieldContainer[ScalarField]
element_type: DataType
def __init__(self, data: _Optional[_Iterable[_Union[ScalarField, _Mapping]]] = ..., element_type: _Optional[_Union[DataType, str]] = ...) -> None: ...
class JSONArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[bytes]
def __init__(self, data: _Optional[_Iterable[bytes]] = ...) -> None: ...
class GeometryArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedScalarFieldContainer[bytes]
def __init__(self, data: _Optional[_Iterable[bytes]] = ...) -> None: ...
class ValueField(_message.Message):
__slots__ = ("bool_data", "int_data", "long_data", "float_data", "double_data", "string_data", "bytes_data")
BOOL_DATA_FIELD_NUMBER: _ClassVar[int]
INT_DATA_FIELD_NUMBER: _ClassVar[int]
LONG_DATA_FIELD_NUMBER: _ClassVar[int]
FLOAT_DATA_FIELD_NUMBER: _ClassVar[int]
DOUBLE_DATA_FIELD_NUMBER: _ClassVar[int]
STRING_DATA_FIELD_NUMBER: _ClassVar[int]
BYTES_DATA_FIELD_NUMBER: _ClassVar[int]
bool_data: bool
int_data: int
long_data: int
float_data: float
double_data: float
string_data: str
bytes_data: bytes
def __init__(self, bool_data: bool = ..., int_data: _Optional[int] = ..., long_data: _Optional[int] = ..., float_data: _Optional[float] = ..., double_data: _Optional[float] = ..., string_data: _Optional[str] = ..., bytes_data: _Optional[bytes] = ...) -> None: ...
class ScalarField(_message.Message):
__slots__ = ("bool_data", "int_data", "long_data", "float_data", "double_data", "string_data", "bytes_data", "array_data", "json_data", "geometry_data")
BOOL_DATA_FIELD_NUMBER: _ClassVar[int]
INT_DATA_FIELD_NUMBER: _ClassVar[int]
LONG_DATA_FIELD_NUMBER: _ClassVar[int]
FLOAT_DATA_FIELD_NUMBER: _ClassVar[int]
DOUBLE_DATA_FIELD_NUMBER: _ClassVar[int]
STRING_DATA_FIELD_NUMBER: _ClassVar[int]
BYTES_DATA_FIELD_NUMBER: _ClassVar[int]
ARRAY_DATA_FIELD_NUMBER: _ClassVar[int]
JSON_DATA_FIELD_NUMBER: _ClassVar[int]
GEOMETRY_DATA_FIELD_NUMBER: _ClassVar[int]
bool_data: BoolArray
int_data: IntArray
long_data: LongArray
float_data: FloatArray
double_data: DoubleArray
string_data: StringArray
bytes_data: BytesArray
array_data: ArrayArray
json_data: JSONArray
geometry_data: GeometryArray
def __init__(self, bool_data: _Optional[_Union[BoolArray, _Mapping]] = ..., int_data: _Optional[_Union[IntArray, _Mapping]] = ..., long_data: _Optional[_Union[LongArray, _Mapping]] = ..., float_data: _Optional[_Union[FloatArray, _Mapping]] = ..., double_data: _Optional[_Union[DoubleArray, _Mapping]] = ..., string_data: _Optional[_Union[StringArray, _Mapping]] = ..., bytes_data: _Optional[_Union[BytesArray, _Mapping]] = ..., array_data: _Optional[_Union[ArrayArray, _Mapping]] = ..., json_data: _Optional[_Union[JSONArray, _Mapping]] = ..., geometry_data: _Optional[_Union[GeometryArray, _Mapping]] = ...) -> None: ...
class SparseFloatArray(_message.Message):
__slots__ = ("contents", "dim")
CONTENTS_FIELD_NUMBER: _ClassVar[int]
DIM_FIELD_NUMBER: _ClassVar[int]
contents: _containers.RepeatedScalarFieldContainer[bytes]
dim: int
def __init__(self, contents: _Optional[_Iterable[bytes]] = ..., dim: _Optional[int] = ...) -> None: ...
class VectorField(_message.Message):
__slots__ = ("dim", "float_vector", "binary_vector", "float16_vector", "bfloat16_vector", "sparse_float_vector")
DIM_FIELD_NUMBER: _ClassVar[int]
FLOAT_VECTOR_FIELD_NUMBER: _ClassVar[int]
BINARY_VECTOR_FIELD_NUMBER: _ClassVar[int]
FLOAT16_VECTOR_FIELD_NUMBER: _ClassVar[int]
BFLOAT16_VECTOR_FIELD_NUMBER: _ClassVar[int]
SPARSE_FLOAT_VECTOR_FIELD_NUMBER: _ClassVar[int]
dim: int
float_vector: FloatArray
binary_vector: bytes
float16_vector: bytes
bfloat16_vector: bytes
sparse_float_vector: SparseFloatArray
def __init__(self, dim: _Optional[int] = ..., float_vector: _Optional[_Union[FloatArray, _Mapping]] = ..., binary_vector: _Optional[bytes] = ..., float16_vector: _Optional[bytes] = ..., bfloat16_vector: _Optional[bytes] = ..., sparse_float_vector: _Optional[_Union[SparseFloatArray, _Mapping]] = ...) -> None: ...
class FieldData(_message.Message):
__slots__ = ("type", "field_name", "scalars", "vectors", "field_id", "is_dynamic", "valid_data")
TYPE_FIELD_NUMBER: _ClassVar[int]
FIELD_NAME_FIELD_NUMBER: _ClassVar[int]
SCALARS_FIELD_NUMBER: _ClassVar[int]
VECTORS_FIELD_NUMBER: _ClassVar[int]
FIELD_ID_FIELD_NUMBER: _ClassVar[int]
IS_DYNAMIC_FIELD_NUMBER: _ClassVar[int]
VALID_DATA_FIELD_NUMBER: _ClassVar[int]
type: DataType
field_name: str
scalars: ScalarField
vectors: VectorField
field_id: int
is_dynamic: bool
valid_data: _containers.RepeatedScalarFieldContainer[bool]
def __init__(self, type: _Optional[_Union[DataType, str]] = ..., field_name: _Optional[str] = ..., scalars: _Optional[_Union[ScalarField, _Mapping]] = ..., vectors: _Optional[_Union[VectorField, _Mapping]] = ..., field_id: _Optional[int] = ..., is_dynamic: bool = ..., valid_data: _Optional[_Iterable[bool]] = ...) -> None: ...
class IDs(_message.Message):
__slots__ = ("int_id", "str_id")
INT_ID_FIELD_NUMBER: _ClassVar[int]
STR_ID_FIELD_NUMBER: _ClassVar[int]
int_id: LongArray
str_id: StringArray
def __init__(self, int_id: _Optional[_Union[LongArray, _Mapping]] = ..., str_id: _Optional[_Union[StringArray, _Mapping]] = ...) -> None: ...
class SearchIteratorV2Results(_message.Message):
__slots__ = ("token", "last_bound")
TOKEN_FIELD_NUMBER: _ClassVar[int]
LAST_BOUND_FIELD_NUMBER: _ClassVar[int]
token: str
last_bound: float
def __init__(self, token: _Optional[str] = ..., last_bound: _Optional[float] = ...) -> None: ...
class SearchResultData(_message.Message):
__slots__ = ("num_queries", "top_k", "fields_data", "scores", "ids", "topks", "output_fields", "group_by_field_value", "all_search_count", "distances", "search_iterator_v2_results")
NUM_QUERIES_FIELD_NUMBER: _ClassVar[int]
TOP_K_FIELD_NUMBER: _ClassVar[int]
FIELDS_DATA_FIELD_NUMBER: _ClassVar[int]
SCORES_FIELD_NUMBER: _ClassVar[int]
IDS_FIELD_NUMBER: _ClassVar[int]
TOPKS_FIELD_NUMBER: _ClassVar[int]
OUTPUT_FIELDS_FIELD_NUMBER: _ClassVar[int]
GROUP_BY_FIELD_VALUE_FIELD_NUMBER: _ClassVar[int]
ALL_SEARCH_COUNT_FIELD_NUMBER: _ClassVar[int]
DISTANCES_FIELD_NUMBER: _ClassVar[int]
SEARCH_ITERATOR_V2_RESULTS_FIELD_NUMBER: _ClassVar[int]
num_queries: int
top_k: int
fields_data: _containers.RepeatedCompositeFieldContainer[FieldData]
scores: _containers.RepeatedScalarFieldContainer[float]
ids: IDs
topks: _containers.RepeatedScalarFieldContainer[int]
output_fields: _containers.RepeatedScalarFieldContainer[str]
group_by_field_value: FieldData
all_search_count: int
distances: _containers.RepeatedScalarFieldContainer[float]
search_iterator_v2_results: SearchIteratorV2Results
def __init__(self, num_queries: _Optional[int] = ..., top_k: _Optional[int] = ..., fields_data: _Optional[_Iterable[_Union[FieldData, _Mapping]]] = ..., scores: _Optional[_Iterable[float]] = ..., ids: _Optional[_Union[IDs, _Mapping]] = ..., topks: _Optional[_Iterable[int]] = ..., output_fields: _Optional[_Iterable[str]] = ..., group_by_field_value: _Optional[_Union[FieldData, _Mapping]] = ..., all_search_count: _Optional[int] = ..., distances: _Optional[_Iterable[float]] = ..., search_iterator_v2_results: _Optional[_Union[SearchIteratorV2Results, _Mapping]] = ...) -> None: ...
class VectorClusteringInfo(_message.Message):
__slots__ = ("field", "centroid")
FIELD_FIELD_NUMBER: _ClassVar[int]
CENTROID_FIELD_NUMBER: _ClassVar[int]
field: str
centroid: VectorField
def __init__(self, field: _Optional[str] = ..., centroid: _Optional[_Union[VectorField, _Mapping]] = ...) -> None: ...
class ScalarClusteringInfo(_message.Message):
__slots__ = ("field",)
FIELD_FIELD_NUMBER: _ClassVar[int]
field: str
def __init__(self, field: _Optional[str] = ...) -> None: ...
class ClusteringInfo(_message.Message):
__slots__ = ("vector_clustering_infos", "scalar_clustering_infos")
VECTOR_CLUSTERING_INFOS_FIELD_NUMBER: _ClassVar[int]
SCALAR_CLUSTERING_INFOS_FIELD_NUMBER: _ClassVar[int]
vector_clustering_infos: _containers.RepeatedCompositeFieldContainer[VectorClusteringInfo]
scalar_clustering_infos: _containers.RepeatedCompositeFieldContainer[ScalarClusteringInfo]
def __init__(self, vector_clustering_infos: _Optional[_Iterable[_Union[VectorClusteringInfo, _Mapping]]] = ..., scalar_clustering_infos: _Optional[_Iterable[_Union[ScalarClusteringInfo, _Mapping]]] = ...) -> None: ...
class TemplateValue(_message.Message):
__slots__ = ("bool_val", "int64_val", "float_val", "string_val", "array_val")
BOOL_VAL_FIELD_NUMBER: _ClassVar[int]
INT64_VAL_FIELD_NUMBER: _ClassVar[int]
FLOAT_VAL_FIELD_NUMBER: _ClassVar[int]
STRING_VAL_FIELD_NUMBER: _ClassVar[int]
ARRAY_VAL_FIELD_NUMBER: _ClassVar[int]
bool_val: bool
int64_val: int
float_val: float
string_val: str
array_val: TemplateArrayValue
def __init__(self, bool_val: bool = ..., int64_val: _Optional[int] = ..., float_val: _Optional[float] = ..., string_val: _Optional[str] = ..., array_val: _Optional[_Union[TemplateArrayValue, _Mapping]] = ...) -> None: ...
class TemplateArrayValue(_message.Message):
__slots__ = ("bool_data", "long_data", "double_data", "string_data", "array_data", "json_data")
BOOL_DATA_FIELD_NUMBER: _ClassVar[int]
LONG_DATA_FIELD_NUMBER: _ClassVar[int]
DOUBLE_DATA_FIELD_NUMBER: _ClassVar[int]
STRING_DATA_FIELD_NUMBER: _ClassVar[int]
ARRAY_DATA_FIELD_NUMBER: _ClassVar[int]
JSON_DATA_FIELD_NUMBER: _ClassVar[int]
bool_data: BoolArray
long_data: LongArray
double_data: DoubleArray
string_data: StringArray
array_data: TemplateArrayValueArray
json_data: JSONArray
def __init__(self, bool_data: _Optional[_Union[BoolArray, _Mapping]] = ..., long_data: _Optional[_Union[LongArray, _Mapping]] = ..., double_data: _Optional[_Union[DoubleArray, _Mapping]] = ..., string_data: _Optional[_Union[StringArray, _Mapping]] = ..., array_data: _Optional[_Union[TemplateArrayValueArray, _Mapping]] = ..., json_data: _Optional[_Union[JSONArray, _Mapping]] = ...) -> None: ...
class TemplateArrayValueArray(_message.Message):
__slots__ = ("data",)
DATA_FIELD_NUMBER: _ClassVar[int]
data: _containers.RepeatedCompositeFieldContainer[TemplateArrayValue]
def __init__(self, data: _Optional[_Iterable[_Union[TemplateArrayValue, _Mapping]]] = ...) -> None: ...