SundayT1998/milvus-client/entity

README
U
Client
U
ClientError
U
Code
U
CollectionDescription
U
CollectionLoadState
U
Config
U
ConsistencyLevel
U
CreateCollectionOption
U
CreatePartitionOption
U
DeleteOption
U
DescribeCollectionOption
U
DropCollectionOption
U
DropPartitionOption
U
FlushOption
U
FlushTask
U
GetFlushStateOption
U
GetLoadStateOption
U
HasPartitionOption
U
ListCollectionsOption
U
ListPartitionsOption
U
LoadCollectionOption
U
LoadPartitionsOption
U
LoadState
U
LoadTask
U
MutationResult
U
QueryOption
U
QueryResult
U
ReleaseCollectionOption
U
ReleasePartitionsOption
U
RpcError
U
SearchHit
U
SearchOption
U
SearchResult
U
Unary
U
WriteColumn
U
WriteOption
V
client_config
V
client_error_code
V
default_consistency_level
V
default_port
V
default_timeout_millis
V
is_client_error_deadline_exceeded
V
is_client_error_retryable
V
is_deadline_exceeded
V
is_retryable
V
is_transport_failure
V
new_client
V
with_address
V
with_db_name
V
with_gzip
V
with_timeout_millis
V
with_token

SundayT1998/milvus-client/entity does not have a README file

SchemaError

pub(all) suberror SchemaError {
  SchemaError(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Errors raised when a collection schema is malformed.

The message text is the observable behaviour of this module, so it is phrased after the pymilvus wording where the two check the same thing.

SchemaError::equal

source

#deprecated("`SchemaError::equal` is deprecated, use `Eq::equal` instead.")
fn SchemaError::equal(SchemaError, SchemaError) -> Bool

SchemaError::not_equal

source

#deprecated("`SchemaError::not_equal` is deprecated, use `Eq::not_equal` instead.")
fn SchemaError::not_equal(x : SchemaError, y : SchemaError) -> Bool

SchemaError::to_repr

source

#deprecated("`SchemaError::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn SchemaError::to_repr(SchemaError) -> @moonbitlang/core/debug.Repr
Repr

BFloat16Vector

source

pub(all) struct BFloat16Vector {
  dim : Int
  values : Array[Float]
} derive(@moonbitlang/core/debug.Debug
Debug)

A dense vector of dim bfloat16 values, kept widened to float32 so that arithmetic on them stays exact.

BFloat16Vector::to_repr

source

#deprecated("`BFloat16Vector::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn BFloat16Vector::to_repr(BFloat16Vector) -> @moonbitlang/core/debug.Repr
Repr

BinaryVector

source

pub(all) struct BinaryVector {
  dim : Int
  data : Bytes
} derive(@moonbitlang/core/debug.Debug
Debug)

A dense binary vector of dim bits, packed 8 bits per byte the way VectorField.binary_vector expects. dim is always a multiple of 8, so the byte count is dim / 8.

BinaryVector::to_repr

source

#deprecated("`BinaryVector::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn BinaryVector::to_repr(BinaryVector) -> @moonbitlang/core/debug.Repr
Repr

CollectionSchema

source

pub(all) struct CollectionSchema {
  fields : Array[Field]
  description : String
  enable_dynamic_field : Bool
} derive(@moonbitlang/core/debug.Debug
Debug)

A collection schema: the fields plus the collection-level description and the enable_dynamic_field switch from CollectionSchema in schema.proto.

CollectionSchema::field

source

fn CollectionSchema::field(self : CollectionSchema, name : String) -> Field?

The field with the given name, if any.

CollectionSchema::from_field

source

fn CollectionSchema::from_field(field : Field) -> CollectionSchema

A schema with a single field, for the common one-field case.

CollectionSchema::new

source

fn CollectionSchema::new(fields : Array[Field]) -> CollectionSchema

A schema with the given fields, no dynamic field.

CollectionSchema::primary_key

source

fn CollectionSchema::primary_key(self : CollectionSchema) -> Field?

The primary key field, if the schema declares one.

CollectionSchema::to_repr

source

#deprecated("`CollectionSchema::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn CollectionSchema::to_repr(CollectionSchema) -> @moonbitlang/core/debug.Repr
Repr

CollectionSchema::validate

source

fn CollectionSchema::validate(self : CollectionSchema) -> Unit raise SchemaError

Validates the whole schema: at least one field, exactly one primary key of an auto-ID-capable type, no duplicate names, and every field individually valid.

CollectionSchema::vector_fields

source

fn CollectionSchema::vector_fields(self : CollectionSchema) -> Array[Field]

All vector fields, in declaration order.

CollectionSchema::with_auto_id_primary

source

fn CollectionSchema::with_auto_id_primary(fields : Array[Field]) -> CollectionSchema

A schema with one auto ID Int64 primary key named id, plus the given fields. This is the shape most examples use.

CollectionSchema::with_description

source

fn CollectionSchema::with_description(self : CollectionSchema, description : String) -> CollectionSchema

Sets the collection description.

CollectionSchema::with_dynamic_field

source

fn CollectionSchema::with_dynamic_field(self : CollectionSchema, enabled : Bool) -> CollectionSchema

Enables or disables the $meta dynamic field.

CollectionSchema::with_field

source

fn CollectionSchema::with_field(self : CollectionSchema, field : Field) -> CollectionSchema

Appends a field.

DataType

source

pub(all) enum DataType {
  None
  Bool
  Int8
  Int16
  Int32
  Int64
  Float
  Double
  String
  VarChar
  Array
  Json
  Geometry
  Text
  Timestamptz
  Mol
  Date
  Time
  Decimal
  Uuid
  BinaryVector
  FloatVector
  Float16Vector
  BFloat16Vector
  SparseFloatVector
  Int8Vector
  ArrayOfVector
  ArrayOfStruct
  Struct
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Milvus field data types.

The enum members mirror milvus.proto.schema.DataType one to one, and the numeric values are pinned by DataType::to_int (see entity_wbtest.mbt). They are part of the wire protocol, so neither the spelling nor the value may drift from the upstream .proto.

DataType::equal

source

#deprecated("`DataType::equal` is deprecated, use `Eq::equal` instead.")
fn DataType::equal(DataType, DataType) -> Bool

DataType::from_int

source

fn DataType::from_int(value : Int) -> DataType?

Inverse of DataType::to_int; None for values this client does not know.

DataType::is_dense_vector_type

source

fn DataType::is_dense_vector_type(self : DataType) -> Bool

Whether rows of the type have a fixed byte width derived from dim. Sparse vectors do not: they store only the non-zero entries of each row.

DataType::is_vector_type

source

fn DataType::is_vector_type(self : DataType) -> Bool

Whether the type is any vector kind, dense or sparse.

DataType::name

source

fn DataType::name(self : DataType) -> String

The enum constant name, as spelled in schema.proto.

DataType::not_equal

source

#deprecated("`DataType::not_equal` is deprecated, use `Eq::not_equal` instead.")
fn DataType::not_equal(x : DataType, y : DataType) -> Bool

DataType::to_int

source

fn DataType::to_int(self : DataType) -> Int

The DataType enum value from schema.proto.

DataType::to_repr

source

#deprecated("`DataType::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn DataType::to_repr(DataType) -> @moonbitlang/core/debug.Repr
Repr

DataType::vector_bytes_per_dim

source

fn DataType::vector_bytes_per_dim(self : DataType) -> Int?

Bytes each dimension takes for dense, non-packed vector types. None for binary vectors (packed, 8 dimensions per byte) and for every non-vector type.

Field

source

pub(all) struct Field {
  name : String
  data_type : DataType
  field_id : Int64
  is_primary_key : Bool
  auto_id : Bool
  description : String
  is_dynamic : Bool
  is_partition_key : Bool
  is_clustering_key : Bool
  nullable : Bool
  element_type : DataType?
  dim : Int?
  max_length : Int?
  type_params : Array[(String, String)]
} derive(@moonbitlang/core/debug.Debug
Debug)

One field of a collection schema.

dim and max_length are not FieldSchema fields in schema.proto; the server reads them out of type_params, which is why they are kept here as keys plus an escape hatch (type_params) for the remaining entries such as enable_analyzer.

Field::as_auto_id

source

fn Field::as_auto_id(self : Field) -> Field

Enables server-side ID generation for a primary key field.

Field::as_nullable

source

fn Field::as_nullable(self : Field) -> Field

Allows null values for the field.

Field::as_partition_key

source

fn Field::as_partition_key(self : Field) -> Field

Enables logic partitions on the field.

Field::as_primary_key

source

fn Field::as_primary_key(self : Field) -> Field

Marks the field as the collection's primary key.

Field::is_sparse_vector

source

fn Field::is_sparse_vector(self : Field) -> Bool

Whether the field is a sparse float vector field, which is the one vector kind that has no dimension.

Field::new

source

fn Field::new(name : String, data_type : DataType) -> Field

A field with no optional attribute set: not a primary key, not auto ID, not dynamic, not nullable, no dimension and no max length.

Field::to_repr

source

#deprecated("`Field::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn Field::to_repr(Field) -> @moonbitlang/core/debug.Repr
Repr

Field::type_params_pairs

source

fn Field::type_params_pairs(self : Field) -> Array[(String, String)]

The type_params entries schema.proto expects for this field: the dimension for vectors, the max length for string fields.

Field::validate

source

fn Field::validate(self : Field) -> Unit raise SchemaError

Validates one field: a dimension on every dense vector field and on none of the others, an auto ID only on the primary key, and a partition key only on an Int64 or VarChar field.

Field::with_dim

source

fn Field::with_dim(self : Field, dim : Int) -> Field raise SchemaError

Sets the dimension of a vector field.

Field::with_element_type

source

fn Field::with_element_type(self : Field, element_type : DataType) -> Field

Sets the element type of an Array field.

Field::with_max_length

source

fn Field::with_max_length(self : Field, max_length : Int) -> Field raise SchemaError

Sets the maximum length of a VarChar (or Text) field.

Field::with_type_param

source

fn Field::with_type_param(self : Field, key : String, value : String) -> Field

Adds an arbitrary type_params entry, e.g. enable_analyzer=true.

Float16Vector

source

pub(all) struct Float16Vector {
  dim : Int
  values : Array[Float]
} derive(@moonbitlang/core/debug.Debug
Debug)

A dense vector of dim IEEE-754 half-precision values. The values are kept as floats and narrowed on the wire, where each one takes two bytes.

Float16Vector::to_repr

source

#deprecated("`Float16Vector::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn Float16Vector::to_repr(Float16Vector) -> @moonbitlang/core/debug.Repr
Repr

FloatVector

source

pub(all) struct FloatVector {
  dim : Int
  values : Array[Float]
} derive(@moonbitlang/core/debug.Debug
Debug)

A dense vector of dim float32 values.

FloatVector::to_repr

source

#deprecated("`FloatVector::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn FloatVector::to_repr(FloatVector) -> @moonbitlang/core/debug.Repr
Repr

Int8Vector

source

pub(all) struct Int8Vector {
  dim : Int
  data : Bytes
} derive(@moonbitlang/core/debug.Debug
Debug)

A dense vector of dim signed bytes.

Int8Vector::to_repr

source

#deprecated("`Int8Vector::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn Int8Vector::to_repr(Int8Vector) -> @moonbitlang/core/debug.Repr
Repr

SparseFloatVector

source

pub(all) struct SparseFloatVector {
  indices : Array[UInt]
  values : Array[Float]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A sparse float vector: the value of each stored coordinate, keyed by coordinate. The server sizes a sparse row by its largest index, not by a declared dimension, so there is no dim here.

Indices are UInt because SparseFloatVector coordinates are uint32 on the wire. The .proto bounds the row by uint32 and the per-entry encoding by varint, so an index at or above 2^32 - 1 is rejected the same way upstream rejects it.

SparseFloatVector::equal

source

#deprecated("`SparseFloatVector::equal` is deprecated, use `Eq::equal` instead.")
fn SparseFloatVector::equal(SparseFloatVector, SparseFloatVector) -> Bool

SparseFloatVector::from_bytes

source

fn SparseFloatVector::from_bytes(bytes : Bytes) -> SparseFloatVector raise SchemaError

The sparse row that a payload written by SparseFloatVector::to_bytes stands for: little-endian uint32 index followed by little-endian float32 value, 8 bytes an entry. Named after the upstream entity.DeserializeSliceSparseEmbedding.

A byte count that is not a multiple of 8, or a NaN value, is rejected the same way the write side rejects it, so a payload round-trips or fails loudly at the boundary.

SparseFloatVector::from_entry

source

fn SparseFloatVector::from_entry(index : UInt, value : Float) -> SparseFloatVector

A sparse row with a single entry.

SparseFloatVector::inferred_dim

source

fn SparseFloatVector::inferred_dim(self : SparseFloatVector) -> Int

The dimension the server will infer for this row: the largest index plus one, or 0 for an empty row.

SparseFloatVector::new

source

fn SparseFloatVector::new(indices : Array[UInt], values : Array[Float]) -> SparseFloatVector raise SchemaError

A sparse row from parallel index/value arrays. Both arrays must be the same length; neither may hold a NaN value.

SparseFloatVector::not_equal

source

#deprecated("`SparseFloatVector::not_equal` is deprecated, use `Eq::not_equal` instead.")
fn SparseFloatVector::not_equal(x : SparseFloatVector, y : SparseFloatVector) -> Bool

SparseFloatVector::to_bytes

source

fn SparseFloatVector::to_bytes(self : SparseFloatVector) -> Bytes raise SchemaError

Encodes the row as index/value pairs, each a little-endian uint32 followed by a little-endian float32. Entries are sorted by index, which is the order upstream writes and the order Milvus persists.

SparseFloatVector::to_repr

source

#deprecated("`SparseFloatVector::to_repr` is deprecated, use `@moonbitlang/core/debug.Debug::to_repr` instead.")
fn SparseFloatVector::to_repr(SparseFloatVector) -> @moonbitlang/core/debug.Repr
Repr

SparseFloatVector::validate

source

fn SparseFloatVector::validate(self : SparseFloatVector) -> Unit raise SchemaError

Validates the row against the encoding the server accepts: equal lengths, indices below 2^32 - 1, and no NaN.

bfloat16_from_float

source

fn bfloat16_from_float(value : Float) -> UInt

The BFloat16 bit pattern of each float, in the same order as the input.

BFloat16 is the top 16 bits of an IEEE-754 float32, so the conversion is a truncation plus a round-to-nearest-even step. The rounding constant is 0x7FFF + lsb: adding the low bit of the target makes an exact tie round up only when that bit is already odd, which is round-half-to-even without a branch. Carrying into the exponent is intended — it is how the mantissa overflows into the next binade (0x3F7FFFFF -> 0x3F80, i.e. 1.0), and the same carry turns a float32 infinity into a bfloat16 infinity.

The result is compared against upstream ml_dtypes.bfloat16 over the whole 32-bit space in the report that accompanies this module; see proto/REPORT.md for the tooling it was checked with.

bfloat16_from_floats

source

fn bfloat16_from_floats(values : Array[Float]) -> Array[UInt]

The BFloat16 bit pattern of each float, in input order.

bfloat16_to_float

source

fn bfloat16_to_float(bits : UInt) -> Float

The float that a BFloat16 bit pattern stands for. Exact: every bfloat16 value is a float32 value, so the widening is a shift with no rounding.

bfloat16_vector_bytes

source

fn bfloat16_vector_bytes(values : Array[Float]) -> Bytes

The little-endian, two-bytes-per-value encoding of floats as BFloat16, which is what VectorField.bfloat16_vector carries on the wire.

bfloat16_vector_from_bytes

source

fn bfloat16_vector_from_bytes(bytes : Bytes) -> Array[Float] raise SchemaError

Decodes little-endian BFloat16 bytes back into floats. An odd byte count is a malformed payload and is rejected rather than silently truncated.

dim_key

source

let dim_key : String

Key of the dim entry written into type_params.

float16_from_float

source

fn float16_from_float(value : Float) -> UInt

The float16 (IEEE-754 binary16) bit pattern of a float32, rounded half-to-even.

Split by the value of e = exponent - 127, the unbiased exponent:

e > 15 overflows binary16 and lands on infinity;
e < -14 is subnormal territory, where the implicit leading 1 turns explicit and every step left the value takes costs one bit of the mantissa. Below e = -24 the value rounds to a signed zero;
otherwise it is a normal number and the biased exponent moves from 127 to 15, with the 23-bit mantissa narrowed to 10 by one round-half-even step.

Rounding to nearest even is done on the integer mantissa rather than on the value, so no intermediate is ever held in a wider float: this is what the read side in @column inverts, bit for bit.

float16_vector_bytes

source

fn float16_vector_bytes(values : Array[Float]) -> Bytes

The little-endian, two-bytes-per-value encoding of floats as float16, which is what VectorField.float16_vector carries on the wire.

max_length_key

source

let max_length_key : String

Key of the max_length entry written into type_params.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#SchemaError

#SchemaError::equal

#SchemaError::not_equal

#SchemaError::to_repr

#BFloat16Vector

#BFloat16Vector::to_repr

#BinaryVector

#BinaryVector::to_repr

#CollectionSchema

#CollectionSchema::field

#CollectionSchema::from_field

#CollectionSchema::new

#CollectionSchema::primary_key

#CollectionSchema::to_repr

#CollectionSchema::validate

#CollectionSchema::vector_fields

#CollectionSchema::with_auto_id_primary

#CollectionSchema::with_description

#CollectionSchema::with_dynamic_field

#CollectionSchema::with_field

#DataType

#DataType::equal

#DataType::from_int

#DataType::is_dense_vector_type

#DataType::is_vector_type

#DataType::name

#DataType::not_equal

#DataType::to_int

#DataType::to_repr

#DataType::vector_bytes_per_dim

#Field

#Field::as_auto_id

#Field::as_nullable

#Field::as_partition_key

#Field::as_primary_key

#Field::is_sparse_vector

#Field::new

#Field::to_repr

#Field::type_params_pairs

#Field::validate

#Field::with_dim

#Field::with_element_type

#Field::with_max_length

#Field::with_type_param

#Float16Vector

#Float16Vector::to_repr

#FloatVector

#FloatVector::to_repr

#Int8Vector

#Int8Vector::to_repr

#SparseFloatVector

#SparseFloatVector::equal

#SparseFloatVector::from_bytes

#SparseFloatVector::from_entry

#SparseFloatVector::inferred_dim

#SparseFloatVector::new

#SparseFloatVector::not_equal

#SparseFloatVector::to_bytes

#SparseFloatVector::to_repr

#SparseFloatVector::validate

#bfloat16_from_float

#bfloat16_from_floats

#bfloat16_to_float

#bfloat16_vector_bytes

#bfloat16_vector_from_bytes

#dim_key

#float16_from_float

#float16_vector_bytes

#max_length_key

Source Files

SchemaError

SchemaError::equal

SchemaError::not_equal

SchemaError::to_repr

BFloat16Vector

BFloat16Vector::to_repr

BinaryVector

BinaryVector::to_repr

CollectionSchema

CollectionSchema::field

CollectionSchema::from_field

CollectionSchema::new

CollectionSchema::primary_key

CollectionSchema::to_repr

CollectionSchema::validate

CollectionSchema::vector_fields

CollectionSchema::with_auto_id_primary

CollectionSchema::with_description

CollectionSchema::with_dynamic_field

CollectionSchema::with_field

DataType

DataType::equal

DataType::from_int

DataType::is_dense_vector_type

DataType::is_vector_type

DataType::name

DataType::not_equal

DataType::to_int

DataType::to_repr

DataType::vector_bytes_per_dim

Field

Field::as_auto_id

Field::as_nullable

Field::as_partition_key

Field::as_primary_key

Field::is_sparse_vector

Field::new

Field::to_repr

Field::type_params_pairs

Field::validate

Field::with_dim

Field::with_element_type

Field::with_max_length

Field::with_type_param

Float16Vector

Float16Vector::to_repr

FloatVector

FloatVector::to_repr

Int8Vector

Int8Vector::to_repr

SparseFloatVector

SparseFloatVector::equal

SparseFloatVector::from_bytes

SparseFloatVector::from_entry

SparseFloatVector::inferred_dim

SparseFloatVector::new

SparseFloatVector::not_equal

SparseFloatVector::to_bytes

SparseFloatVector::to_repr

SparseFloatVector::validate

bfloat16_from_float

bfloat16_from_floats

bfloat16_to_float

bfloat16_vector_bytes

bfloat16_vector_from_bytes

dim_key

float16_from_float

float16_vector_bytes

max_length_key