Skip to main content

Module protocol

Module protocol 

Source
Expand description

Wire-compatible protocol for semantic model daemon.

This protocol is designed to be wire-compatible with xf’s daemon implementation, allowing both tools to share a daemon if both are installed.

Protocol uses MessagePack for efficient binary serialization over Unix Domain Sockets.

Structs§

DecodeError
EmbedResponse
Response containing embeddings.
EmbeddingJobDetail
Detail for a single embedding job.
EmbeddingJobInfo
Status information for embedding jobs.
EncodeError
ErrorResponse
Error response from daemon.
FramedMessage
Framed message wrapper for length-prefixed protocol.
HealthStatus
Health status of the daemon.
ModelInfo
Information about a loaded model.
RerankResponse
Response containing rerank scores.
StatusResponse
Daemon status response.

Enums§

ErrorCode
Error codes for daemon errors.
Request
Request types for the daemon protocol.
Response
Response types from the daemon.

Constants§

PROTOCOL_VERSION
Protocol version for compatibility checks. Both cass and xf must use the same version to share a daemon.

Functions§

decode_message
Decode a message from MessagePack bytes (without length prefix).
default_socket_path
Default socket path (shared between cass and xf).
encode_message
Encode a message to MessagePack bytes with length prefix.