Trait CompletionModel 

pub trait CompletionModel:
    Clone
    + WasmCompatSend
    + WasmCompatSync {
    type Response: WasmCompatSend + WasmCompatSync + Serialize + DeserializeOwned;
    type StreamingResponse: Clone + Unpin + WasmCompatSend + WasmCompatSync + Serialize + DeserializeOwned + GetTokenUsage;
    type Client;

    // Required methods
    fn make(client: &Self::Client, model: impl Into<String>) -> Self;
    fn completion(
        &self,
        request: CompletionRequest,
    ) -> impl Future<Output = Result<CompletionResponse<Self::Response>, CompletionError>> + WasmCompatSend;
    fn stream(
        &self,
        request: CompletionRequest,
    ) -> impl Future<Output = Result<StreamingCompletionResponse<Self::StreamingResponse>, CompletionError>> + WasmCompatSend;

    // Provided methods
    fn completion_request(
        &self,
        prompt: impl Into<Message>,
    ) -> CompletionRequestBuilder<Self> { ... }
    fn composes_native_output_with_tools(&self) -> bool { ... }
}

Trait defining a completion model that can be used to generate completion responses. This trait is meant to be implemented by the user to define a custom completion model, either from a third party provider (e.g.: OpenAI) or a local model.

Required Associated Types

type Response: WasmCompatSend + WasmCompatSync + Serialize + DeserializeOwned

The raw response type returned by the underlying completion model.

type StreamingResponse: Clone + Unpin + WasmCompatSend + WasmCompatSync + Serialize + DeserializeOwned + GetTokenUsage

The raw response type returned by the underlying completion model when streaming.

type Client

Provider client type used to construct this model.

Required Methods

fn make(client: &Self::Client, model: impl Into<String>) -> Self

Construct a model handle from a provider client and model identifier.

fn completion( &self, request: CompletionRequest, ) -> impl Future<Output = Result<CompletionResponse<Self::Response>, CompletionError>> + WasmCompatSend

Generates a completion response for the given completion request.

fn stream( &self, request: CompletionRequest, ) -> impl Future<Output = Result<StreamingCompletionResponse<Self::StreamingResponse>, CompletionError>> + WasmCompatSend

Provided Methods

fn completion_request( &self, prompt: impl Into<Message>, ) -> CompletionRequestBuilder<Self>

Generates a completion request builder for the given prompt.

fn composes_native_output_with_tools(&self) -> bool

Whether this provider’s native structured output (output_schema -> format/response_format) composes with tool calls in the same multi-turn request without suppressing them.

Defaults to false (the safe assumption: the native constraint may make the model emit schema JSON instead of calling its tools — see issue #1928). Providers that enforce structured output and tool use together (e.g. OpenAI, Anthropic) override this to true, which lets the agent’s OutputMode::Auto keep using guaranteed native structured output even when the agent has tools.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl CompletionModel for MockCompletionModel

Available on crate feature test-utils only.

type Response = MockResponse

type StreamingResponse = MockResponse

type Client = ()

impl<Ext, H> CompletionModel for GenericCompletionModel<Ext, H>

where Client<Ext, H>: HttpClientExt + Clone + WasmCompatSend + WasmCompatSync + 'static, Ext: Provider + OpenAICompatibleProvider + DebugExt + Clone + WasmCompatSend + WasmCompatSync + 'static, H: Clone + Default + Debug + WasmCompatSend + WasmCompatSync + 'static,

type Response = <Ext as OpenAICompatibleProvider>::Response

type StreamingResponse = StreamingCompletionResponse<<Ext as OpenAICompatibleProvider>::StreamingUsage>

type Client = Client<Ext, H>

impl<H> CompletionModel for rig_core::providers::copilot::CompletionModel<H>

where Client<H>: HttpClientExt + Clone + Debug + 'static, H: Clone + Default + Debug + WasmCompatSend + WasmCompatSync + 'static,

type Response = CopilotCompletionResponse

type StreamingResponse = CopilotStreamingResponse

type Client = Client<CopilotExt, H>

impl<H> CompletionModel for ResponsesCompletionModel<H>

where Client<H>: HttpClientExt + Clone + Debug + 'static, H: Clone + Default + Debug + WasmCompatSend + WasmCompatSync + 'static,

type Response = CompletionResponse

type StreamingResponse = StreamingCompletionResponse

type Client = Client<ChatGPTExt, H>

impl<T> CompletionModel for rig_core::providers::cohere::completion::CompletionModel<T>

where T: HttpClientExt + Clone + 'static,

type Response = CompletionResponse

type StreamingResponse = StreamingCompletionResponse

type Client = Client<CohereExt, T>

impl<T> CompletionModel for rig_core::providers::gemini::completion::CompletionModel<T>

where T: HttpClientExt + Clone + 'static,

type Response = GenerateContentResponse

type StreamingResponse = StreamingCompletionResponse

type Client = Client<GeminiExt, T>

impl<T> CompletionModel for rig_core::providers::ollama::CompletionModel<T>

where T: HttpClientExt + Clone + Default + Debug + Send + 'static,

type Response = CompletionResponse

type StreamingResponse = StreamingCompletionResponse

type Client = Client<OllamaExt, T>

impl<T> CompletionModel for rig_core::providers::xai::completion::CompletionModel<T>

where T: HttpClientExt + Clone + Default + Debug + Send + 'static,

type Response = CompletionResponse

type StreamingResponse = StreamingCompletionResponse

type Client = Client<XAiExt, T>

impl<T> CompletionModel for InteractionsCompletionModel<T>

where T: HttpClientExt + Clone + Debug + Default + 'static,

type Response = Interaction

type StreamingResponse = StreamingCompletionResponse

type Client = Client<GeminiInteractionsExt, T>