Struct AdditionalParameters

pub struct AdditionalParameters {
    pub background: Option<bool>,
    pub text: Option<TextConfig>,
    pub include: Option<Vec<Include>>,
    pub top_p: Option<f64>,
    pub truncation: Option<TruncationStrategy>,
    pub user: Option<String>,
    pub metadata: Map<String, Value>,
    pub parallel_tool_calls: Option<bool>,
    pub previous_response_id: Option<String>,
    pub reasoning: Option<Reasoning>,
    pub service_tier: Option<OpenAIServiceTier>,
    pub store: Option<bool>,
}

Additional parameters for 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

background: Option<bool>

Whether or not a given model task should run in the background (ie a detached process).

text: Option<TextConfig>

The text response format. This is where you would add structured outputs (if you want them).

include: Option<Vec<Include>>

What types of extra data you would like to include. This is mostly useless at the moment since the types of extra data to add is currently unsupported, but this will be coming soon!

top_p: Option<f64>

top_p. Mutually exclusive with the temperature argument.

truncation: Option<TruncationStrategy>

Whether or not the response should be truncated.

user: Option<String>

The username of the user (that you want to use).

metadata: Map<String, Value>

Any additional metadata you’d like to add. This will additionally be returned by the response.

parallel_tool_calls: Option<bool>

Whether or not you want tool calls to run in parallel.

previous_response_id: Option<String>

Previous response ID. If you are not sending a full conversation, this can help to track the message flow.

reasoning: Option<Reasoning>

Add thinking/reasoning to your response. The response will be emitted as a list member of the output field.

service_tier: Option<OpenAIServiceTier>

The service tier you’re using.

store: Option<bool>

Whether or not to store the response for later retrieval by API.

Trait Implementations

impl Clone for AdditionalParameters

fn clone(&self) -> AdditionalParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdditionalParameters

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

Formats the value using the given formatter.

impl Default for AdditionalParameters

fn default() -> AdditionalParameters

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AdditionalParameters

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AdditionalParameters

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

where __S: Serializer,

Serialize this value into the given Serde serializer.