Crate modelrelay 

Minimal Rust SDK for the ModelRelay API.

Re-exports

pub use tools::assistant_message_with_tool_calls;

pub use tools::create_retry_messages;

pub use tools::execute_with_retry;

pub use tools::format_tool_error_for_model;

pub use tools::function_tool;

pub use tools::get_retryable_errors;

pub use tools::has_retryable_errors;

pub use tools::parse_and_validate_tool_args;

pub use tools::parse_tool_args;

pub use tools::respond_to_tool_call;

pub use tools::respond_to_tool_call_json;

pub use tools::sync_handler;

pub use tools::tool_choice_auto;

pub use tools::tool_choice_none;

pub use tools::tool_choice_required;

pub use tools::tool_result_message;

pub use tools::tool_result_message_json;

pub use tools::web_tool;

pub use tools::BoxFuture;

pub use tools::ParseResult;

pub use tools::ProxyResponseExt;

pub use tools::RetryOptions;

pub use tools::ToolArgsError;

pub use tools::ToolCallAccumulator;

pub use tools::ToolExecutionResult;

pub use tools::ToolHandler;

pub use tools::ToolRegistry;

pub use tools::UnknownToolError;

pub use tools::ValidateArgs;

pub use tools::function_tool_from_type;

pub use tools::ToolSchema;

Modules

tools

Tool helpers for ergonomic tool use with the ModelRelay API.

Macros

tool_handler

Helper macro to create a tool handler from an async closure.

Structs

APIErrorclient or blocking or streaming

Structured error envelope returned by the API.

APIKey

Representation of an API key record.

AttemptRecordclient

Record of a single structured output attempt.

AuthClientclient

ChatRequestBuilderclient or blocking

Builder for LLM proxy chat requests (async + streaming).

ChatStreamAdapterstreaming and (client or blocking)

Thin adapter over streaming events to yield text deltas and final metadata.

CheckoutSessionclient

Checkout session response.

CheckoutSessionRequestclient

Request to create a checkout session.

Clientclient

ClientBuilderclient

Builder for constructing a Client with explicit configuration.

CodeExecConfig

Code execution configuration.

Configclient

Customerclient

A customer in a ModelRelay project.

CustomerChatRequestBuilderclient or blocking

Builder for customer-attributed LLM proxy chat requests.

CustomerClaimRequestclient

Request to claim a customer by email, setting their external_id.

CustomerCreateRequestclient

Request to create a customer.

CustomerProxyRequestBodyclient or blocking

Request body for customer-attributed proxy requests (no model field).

CustomerUpsertRequestclient

Request to upsert a customer by external_id.

CustomersClientclient

Client for customer management operations.

DefaultRetryHandlerclient

Default retry handler that appends a simple error correction message.

FieldErrorclient or blocking or streaming

Field-level validation error returned by the API.

FrontendToken

Short-lived bearer token usable from browser/mobile clients.

FrontendTokenAutoProvisionRequest

Request payload for POST /auth/frontend-token with auto-provisioning.

FrontendTokenRequest

Request payload for POST /auth/frontend-token for an existing customer.

FunctionCall

Function call details in a tool call.

FunctionCallDelta

Incremental function call data.

FunctionTool

Function tool definition.

HeaderEntryclient or blocking

HeaderListclient or blocking

Structured header/metadata list with validation.

HttpRequestMetrics

HTTP request latency and outcome.

LLMClientclient

MetricsCallbacks

User-provided callbacks for emitting metrics without taking on a tracing dependency.

Model

Model identifier (string wrapper).

ProxyMessage

A single chat turn used by the LLM proxy.

ProxyOptionsclient or blocking

Optional headers and metadata for proxy calls.

ProxyRequest

Request payload for /llm/proxy.

ProxyRequestBuilder

Fluent builder for ProxyRequest.

ProxyResponse

Aggregated response returned by /llm/proxy.

RequestContext

Common request metadata shared by all telemetry events.

ResponseFormat

Response format configuration for structured outputs.

ResponseJSONSchema

JSON schema payload for structured outputs.

RetryConfigclient or blocking

Retry/backoff configuration (defaults use 3 attempts + jittered exponential backoff).

RetryMetadataclient or blocking or streaming

Retry metadata surfaced on transport/API errors when retries were attempted.

StreamEvent

Single SSE event emitted by the streaming proxy.

StreamFirstTokenMetrics

Time from request start to the first streaming token/event.

StreamHandleclient and streaming

Streaming handle over SSE chat events.

StructuredChatBuilderclient

Builder for structured output chat requests.

StructuredDecodeErrorclient

Error returned when structured output fails on first attempt (before retries).

StructuredExhaustedErrorclient

Error returned when all retry attempts are exhausted.

StructuredOptionsclient

Options for structured output requests.

StructuredResultclient

Result of a successful structured output request.

SubscriptionStatusclient

Subscription status response.

Tierclient

A pricing tier in a ModelRelay project.

TierCheckoutRequestclient

Request to create a tier checkout session (Stripe-first flow). Stripe collects the customer’s email during checkout.

TierCheckoutSessionclient

Tier checkout session response.

TiersClientclient

Client for tier querying operations.

TokenUsageMetrics

Token usage surfaced once a request/stream finishes.

Tool

A tool available for the model to call.

ToolCall

A tool call made by the model.

ToolCallDelta

Incremental update to a tool call during streaming.

ToolChoice

Controls how the model responds to tool calls.

TransportErrorclient or blocking or streaming

Transport-level error (timeouts, DNS/TLS/connectivity).

Usage

Token usage metadata.

UsageSummary

ValidationErrorclient or blocking or streaming

Structured validation/build error returned by the SDK.

ValidationIssueclient

A single field-level validation issue.

WebToolConfig

Web tool configuration.

XSearchConfig

X/Twitter search configuration.

Enums

Errorclient or blocking or streaming

Unified error type surfaced by the SDK.

MessageRole

Message role in a chat conversation.

PriceIntervalclient

Billing interval for a tier.

ResponseFormatKind

Supported response format types.

StopReason

Stop reason returned by the backend and surfaced by /llm/proxy.

StreamEventKind

High-level streaming event kinds emitted by the API.

StreamFormatclient or blocking

Streaming response framing.

StructuredErrorclient

Unified error type for structured output operations.

StructuredErrorKindclient

Specific kind of structured output error.

TokenType

OAuth2 token type. Always “Bearer” for ModelRelay tokens.

ToolChoiceType

Tool choice type.

ToolType

Tool type identifiers.

TransportErrorKindclient or blocking or streaming

Broad transport error kinds for classification.

Constants

API_KEY_HEADER

CUSTOMER_ID_HEADERclient or blocking

Header name for customer ID attribution.

DEFAULT_BASE_URL

DEFAULT_CLIENT_HEADER

DEFAULT_CONNECT_TIMEOUT

DEFAULT_REQUEST_TIMEOUT

REQUEST_ID_HEADER

Traits

RetryHandlerclient

Handler for customizing retry behavior on validation failures.

Functions

response_format_from_typeclient

Generates a ResponseFormat with automatic JSON schema from a type.

Type Aliases

CustomerMetadataclient

Customer metadata as a key-value map.