Module prelude 

Prelude module for convenient imports.

Example

use simple_agent_type::prelude::*;

let msg = Message::user("Hello!");
let request = CompletionRequest::builder()
    .model("gpt-4")
    .message(msg)
    .build()
    .unwrap();

Structs

ApiKey

API key (validated, never logged or displayed).

Capabilities

Provider capabilities.

ChoiceDelta

A delta in a streaming choice.

CoercionResult

Result of a coercion operation with transparency.

CompletionChoice

A single completion choice.

CompletionChunk

A chunk of a streaming completion response.

CompletionRequest

A completion request to an LLM provider.

CompletionRequestBuilder

Builder for CompletionRequest.

CompletionResponse

A completion response from an LLM provider.

HealingConfig

Healing configuration for response coercion.

Message

A message in a conversation.

MessageDelta

Incremental message content in a stream.

ProviderConfig

Provider configuration.

ProviderMetrics

Provider metrics for routing decisions.

ProviderRequest

Opaque provider-specific request.

ProviderResponse

Opaque provider-specific response.

RetryConfig

Retry configuration for failed requests.

ToolCall

Tool call emitted by the model.

ToolCallFunction

Tool call function payload in responses.

ToolChoiceFunction

Function selector for tool choice.

ToolChoiceTool

Tool choice specifying a concrete function to call.

ToolDefinition

Tool definition for requests.

ToolFunction

Function tool definition.

Usage

Token usage statistics.

Enums

CoercionFlag

Flag indicating a specific coercion/healing operation.

FinishReason

Reason why a completion finished.

HealingError

Healing and coercion errors.

ProviderError

Provider-specific errors.

ProviderHealth

Provider health status.

Role

Role of a message in a conversation.

RoutingMode

Routing mode enum for common strategies.

SimpleAgentsError

Main error type for SimpleAgents operations.

ToolChoice

Tool choice for requests.

ToolChoiceMode

Tool choice mode for requests.

ToolType

Tool type supported by the API.

ValidationError

Validation errors.

Traits

Cache

Trait for caching LLM responses.

Provider

Trait for LLM providers.

RoutingStrategy

Trait for routing strategies.

Type Aliases

Result

Result type alias using SimpleAgentsError.