Skip to main content

Module commands

Module commands 

Source
Expand description

Typed wrappers around the v1 RPC command catalog.

Each method in this module corresponds to one entry in the wire spec’s command catalog (§ 6). The wrapper:

  1. Builds the positional args array per the spec.
  2. Calls RpcClient::call.
  3. Decodes the VectorizerValue response into a typed Rust value with explicit field handling (no serde_json::from_value detour — the wire is MessagePack, not JSON).

Adding a new typed wrapper for a v1 command landed on the server is mechanical: a new method on RpcClient here, an entry in the README, and (ideally) a test in tests/rpc_integration.rs.

Structs§

AdminStats
Admin stats response from admin.stats.
AdminStatus
Admin status response from admin.status.
AnswerPlanResult
Response from discovery.build_answer_plan.
AnswerPlanSection
One section inside an answer plan.
ApiKeyCreated
Response from auth.api_keys_create / auth.api_keys_create_scoped.
AuthMeResult
Response from auth.me.
BatchDeleteResult
Response from vectors.batch_delete.
BatchInsertResult
Response from vectors.batch_insert / vectors.batch_insert_texts.
BatchItemResult
Per-item result inside batch responses.
BatchSearchResult
One per-query result from vectors.batch_search.
BatchUpdateResult
Response from vectors.batch_update.
BulkUpdateMetadataRpcResult
Response from vectors.bulk_update_metadata.
CleanupEmptyResult
Response from collections.cleanup_empty (admin-gated on server).
CollectionInfo
Collection metadata returned by collections.get_info.
CompressBullet
Response from discovery.compress_evidence.
CopyRpcResult
Response from vectors.copy.
CreateCollectionResult
Response from collections.create.
DeleteByFilterRpcResult
Response from vectors.delete_by_filter.
DiscoverEdgesForNodeResult
Response from graph.discover_edges_for_node.
DiscoverEdgesResult
Response from graph.discover_edges.
DiscoverResult
Summary response from discovery.discover.
DiscoveryChunk
One chunk from discovery.broad_discovery / discovery.semantic_focus.
EmbedResult
Response from vectors.embed.
ExpandQueriesResult
Response from discovery.expand_queries.
GraphDiscoveryStatus
Response from graph discovery stats (graph.discovery_status).
MoveRpcResult
Response from vectors.move.
RebalanceStatus
Response from cluster.rebalance_status — may be idle or active.
RefreshTokenResult
Response from auth.refresh_token.
RenderPromptResult
Response from discovery.render_llm_prompt.
ReplicationConfigureResult
Response from replication.configure.
RotatedApiKey
Response from auth.api_keys_rotate.
ScoredCollection
One scored collection from discovery.score_collections.
SearchExplainResult
Paginated list of vector IDs and data from vectors.list. Items are raw VectorizerValue::Map entries containing id, data, etc. Response from search.explain.
SearchHit
One result from search.basic or search.by_text.
SearchTrace
HNSW traversal trace from search.explain.
SetExpiryResult
Response from vectors.set_expiry.
SlowQueryConfigResult
Slow query config from admin.slow_queries_config.
ValidatePasswordResult
Response from auth.validate_password.
VectorListResult
Response from vectors.list.
VectorWriteResult
Response from vectors.insert / vectors.insert_text / vectors.update.