API Reference milvex v#0.14.0
Copy MarkdownModules
Represents a single ANN search request for hybrid search.
Exponential backoff calculator with jitter support.
Declarative DSL for defining Milvus collection schemas.
Spark DSL extension for defining Milvus collection schemas.
Struct representing a BM25 function definition in the Milvex Collection DSL.
Struct representing a field definition in the Milvex Collection DSL.
Transformer that generates a struct and @type t from the Collection DSL fields.
Verifies that exactly one primary key field is defined in the collection.
Verifies that all field names in the collection are unique.
Verifies that array fields have valid configuration.
Verifies that auto_id is only used with int64 primary keys.
Verifies that the collection name is valid according to Milvus naming rules.
Verifies that dynamic fields are only used with valid scalar types.
Verifies that varchar fields have valid max_length configuration.
Verifies that vector fields have valid dimensions.
Configuration module for Milvus client connections.
State machine managing gRPC channel lifecycle with automatic reconnection.
Builder for Milvus insert data.
Converts between Elixir values and Milvus FieldData protobuf structures.
Main error aggregator for Milvex using Splode.
Errors related to connection establishment, network issues, or disconnections.
Errors from gRPC operations or Milvus server responses.
Errors for invalid input, validation failures, or constraint violations.
Fallback for unexpected or unclassified errors.
Converts Elixir values to Milvus TemplateValue protobuf structs for filter expression templating.
Builder for Milvus function schemas.
Builder functions for search result highlighting.
Builder for Milvus index configurations.
Layered, halt-free entry point for mix milvex.migrate.
Single unit of work exchanged between Milvex.Migration.Plan,
Milvex.Migration.Runner, and Milvex.Migration.Reporter.
Pure diff between a Milvex.Collection DSL module and the live Milvus state.
Renders migration plans and apply reports as user-facing output.
Applies a list of %Milvex.Migration.Plan{} against a live Milvus cluster.
Final report from one Runner.apply/2 call: per-plan results, a flag
telling whether the run was short-circuited by an :impossible op, and
aggregate counts.
Inputs handed to Runner.apply/2: the connection, the Milvus version,
and the apply-mode flags.
Outcome of attempting one operation: the operation itself plus its terminal
status. :ok means the dispatched RPC succeeded; the various skip atoms
mean the dispatch path was not entered.
Aggregated result for one plan: every operation's OpResult plus the
load-management status describing what the runner did (or chose not to do)
around release/reload.
Helpers for normalising and comparing Milvus version strings.
ConnectionParam defines the params to connect to the Milvus cluster.
CrossClusterTopology is the topology that describes the topology cross multiple cluster milvus.
Don't Modify This. @czs
Deprecated
ImmutableMessage is the message that can not be modified anymore.
MilvusCluster describes the Milvus cluster information, including pchannel mapping details.
Don't Modify This. @czs
NodeInfo is used to describe the node information.
ReplicateCheckpoint is the WAL replicate checkpoint of source cluster. It will be persisted in the target cluster metadata. When a replication started, we will get the replicate checkpoint from target cluster metadata. And use it to continue the replication at source cluster.
ReplicateConfiguration is the configuration that describes the replication topology cross multiple cluster milvus.
User Tag Management
* Alter collection in milvus
Action to perform on the collection schema
Add fields and functions request
Drop field request
The serialized schema.FieldSchema
Alter index
Client Heartbeat
Client Telemetry Service
* Create collection in milvus
Create index for vector datas
Create partition in created collection.
Row Policy Management
Snapshot Management
Delete Client Command
Describe alias response
* Get collection meta datas like: schema, collectionID, shards number ...
* DescribeCollection Response
Get created index information. Current release of Milvus only supports showing latest built index.
Describe index response
* Drop collection in milvus, also will drop data in collection.
Drop partition in created collection.
DumpMessagesRequest is used to dump messages from a WAL range for data salvage.
DumpMessagesResponse streams messages from the WAL. Each response contains either an error status or a message (never both).
Deprecated Flush result for a single flush target
Deprecated
Deprecated, FlushAll semantics changed to flushing the entire cluster. Specific collection to flush with database context This message allows targeting specific collections within a database for flush operations
Get Client Telemetry
* Get collection statistics like row_count.
* Will return collection statistics in stats field like [{key:"row_count",value:"1"}]
Get index building progress
Get partition statistics like row_count.
* Get statistics like row_count. WARNING: This API is experimental and not useful for now.
* Will return statistics in stats field like [{key:"row_count",value:"1"}] WARNING: This API is experimental and not useful for now.
* Check collection exist in milvus or not.
Check if partition exist in collection or not.
Index informations
List aliases response
return all snapshots for the given collection Note: list snapshots is not a privilege check operation
Do load balancing operation from src_nodeID to dst_nodeID.
* Load collection data into query nodes, then you can do vector search on this collection.
Load specific partitions data of one collection into query nodes Then you can get these data as result when you do vector search on this collection.
Push Client Command
* Release collection data from query nodes, then you can't do vector search on this collection.
Release specific partitions data of one collection from query nodes. Then you can not get these data as result when you do vector search on this collection.
ReplicaGroup
restore a snapshot to a new collection
Row Policy Action enum ===== Row Level Security (RLS) Messages =====
List collections
Return basic collection infos.
List all partitions for particular collection
List all partitions for particular collection response. The returned datas are all rows, we can format to columns by therir index.
Deprecated: use GetLoadingProgress rpc instead This is for ShowCollectionsRequest type field.
transfer nodeNum nodes from source_resource_group to target_resource_group
transfer replicaNum replicas in collectionID from source_resource_group to target_resource_group
Truncate collection in milvus
For special fields such as bigdecimal, array...
clustering distribution info of a certain data unit, it can be segment, partition, etc.
* @brief Collection schema
* @brief Field data type
FieldPartialUpdateOp describes how the values carried by the matching FieldData should be applied against the existing row during a partial upsert.
* @brief Field schema
MolArray stores processed molecular data in a serialized binary format.
MolSmilesArray stores user-provided SMILES strings for molecular data.
Scalar field clustering info todo more definitions: min/max, etc
beta, api may change
vector field clustering info
Translates the :order_by option for Milvex.query/4 into the Milvus
order_by_fields query parameter.
Parser for Milvus query results.
Low-level gRPC wrapper with consistent error handling.
Builder functions for hybrid search rerankers.
Decay function reranker for hybrid search.
Reciprocal Rank Fusion (RRF) reranker for hybrid search.
Weighted scoring reranker for hybrid search.
RPC-level retry logic for transient gRPC errors.
Builder for Milvus collection schemas.
Builder for Milvus collection field schemas.
Boot-time schema migration for Milvus collections.
Parser for Milvus search results.
Represents a single search hit.
Telemetry events emitted by Milvex.
Mix Tasks
Diffs Milvex.Collection DSL modules against the live Milvus state and applies the result.