Struct CompletionRequest 

pub struct CompletionRequest {
    pub input: OneOrMany<InputItem>,
    pub model: String,
    pub instructions: Option<String>,
    pub max_output_tokens: Option<u64>,
    pub stream: Option<bool>,
    pub temperature: Option<f64>,
    pub tools: Vec<ResponsesToolDefinition>,
    pub additional_parameters: AdditionalParameters,
    /* private fields */
}

The completion request type for OpenAI’s Response API: https://platform.openai.com/docs/api-reference/responses/create Intended to be derived from crate::completion::request::CompletionRequest.

Fields

input: OneOrMany<InputItem>

Message inputs

model: String

The model name

instructions: Option<String>

Instructions (also referred to as preamble, although in other APIs this would be the “system prompt”)

max_output_tokens: Option<u64>

The maximum number of output tokens.

stream: Option<bool>

Toggle to true for streaming responses.

temperature: Option<f64>

The temperature. Set higher (up to a max of 1.0) for more creative responses.

tools: Vec<ResponsesToolDefinition>

The tools you want to use. This supports both function tools and hosted tools such as web_search, file_search, and computer_use.

additional_parameters: AdditionalParameters

Additional parameters

Implementations

impl CompletionRequest

pub fn with_structured_outputs<S>(self, schema_name: S, schema: Value) -> Self

where S: Into<String>,

pub fn with_reasoning(self, reasoning: Reasoning) -> Self

pub fn with_tool(self, tool: impl Into<ResponsesToolDefinition>) -> Self

Adds a provider-native hosted tool (e.g. web_search, file_search, computer_use) to the request. These tools are executed by OpenAI’s infrastructure, not by Rig’s agent loop.

pub fn with_tools<I, Tool>(self, tools: I) -> Self

where I: IntoIterator<Item = Tool>, Tool: Into<ResponsesToolDefinition>,

Adds multiple provider-native hosted tools to the request. These tools are executed by OpenAI’s infrastructure, not by Rig’s agent loop.

Trait Implementations

impl Clone for CompletionRequest

fn clone(&self) -> CompletionRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompletionRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CompletionRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(String, CompletionRequest)> for CompletionRequest

Attempt to try and create a NewCompletionRequest from a model name and crate::completion::CompletionRequest

type Error = CompletionError

The type returned in the event of a conversion error.

fn try_from( (model, req): (String, CompletionRequest), ) -> Result<Self, Self::Error>

Performs the conversion.