Skip to main content

ResponsesCreateRequest

Struct ResponsesCreateRequest 

Source
pub struct ResponsesCreateRequest {
Show 34 fields pub aspect_ratio: Option<String>, pub attachment: Option<AttachmentInput>, pub attachments: Option<Attachments>, pub duration: Option<f64>, pub image_url: Option<String>, pub include: Vec<String>, pub input: Value, pub instructions: Option<String>, pub language: Option<String>, pub max_output_tokens: Option<i64>, pub metadata: Map<String, Value>, pub modalities: Vec<ResponsesCreateRequestModalitiesItem>, pub model: String, pub n: Option<i64>, pub parallel_tool_calls: Option<bool>, pub previous_response_id: Option<String>, pub prompt_cache_key: Option<String>, pub prompt_cache_retention: Option<String>, pub quality: Option<String>, pub reasoning: Option<ReasoningOptions>, pub reasoning_effort: Option<String>, pub resolution: Option<String>, pub response_format: Option<ResponseFormat>, pub service_tier: Option<String>, pub size: Option<String>, pub speed: Option<f64>, pub store: Option<bool>, pub stream: Option<bool>, pub stream_options: Option<StreamOptions>, pub temperature: Option<f64>, pub text: Map<String, Value>, pub tool_choice: Option<Value>, pub tools: Vec<Map<String, Value>>, pub voice: Option<String>,
}
Expand description

ResponsesCreateRequest

JSON schema
{
 "type": "object",
 "required": [
   "input",
   "model"
 ],
 "properties": {
   "aspect_ratio": {
     "type": "string"
   },
   "attachment": {
     "$ref": "#/components/schemas/AttachmentInput"
   },
   "attachments": {
     "$ref": "#/components/schemas/Attachments"
   },
   "duration": {
     "type": "number"
   },
   "image_url": {
     "type": "string"
   },
   "include": {
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "input": {},
   "instructions": {
     "type": "string"
   },
   "language": {
     "type": "string"
   },
   "max_output_tokens": {
     "type": "integer"
   },
   "metadata": {
     "type": "object",
     "additionalProperties": true
   },
   "modalities": {
     "type": "array",
     "items": {
       "type": "string",
       "enum": [
         "text",
         "image",
         "audio",
         "video",
         "embedding"
       ]
     }
   },
   "model": {
     "type": "string"
   },
   "n": {
     "type": "integer"
   },
   "parallel_tool_calls": {
     "type": "boolean"
   },
   "previous_response_id": {
     "type": "string"
   },
   "prompt_cache_key": {
     "type": "string"
   },
   "prompt_cache_retention": {
     "type": "string"
   },
   "quality": {
     "type": "string"
   },
   "reasoning": {
     "$ref": "#/components/schemas/ReasoningOptions"
   },
   "reasoning_effort": {
     "type": "string"
   },
   "resolution": {
     "type": "string"
   },
   "response_format": {
     "$ref": "#/components/schemas/ResponseFormat"
   },
   "service_tier": {
     "type": "string"
   },
   "size": {
     "type": "string"
   },
   "speed": {
     "type": "number"
   },
   "store": {
     "type": "boolean"
   },
   "stream": {
     "type": "boolean"
   },
   "stream_options": {
     "$ref": "#/components/schemas/StreamOptions"
   },
   "temperature": {
     "type": "number"
   },
   "text": {
     "type": "object",
     "additionalProperties": true
   },
   "tool_choice": {},
   "tools": {
     "type": "array",
     "items": {
       "type": "object",
       "additionalProperties": true
     }
   },
   "voice": {
     "type": "string"
   }
 },
 "additionalProperties": true
}

Fields§

§aspect_ratio: Option<String>§attachment: Option<AttachmentInput>§attachments: Option<Attachments>§duration: Option<f64>§image_url: Option<String>§include: Vec<String>§input: Value§instructions: Option<String>§language: Option<String>§max_output_tokens: Option<i64>§metadata: Map<String, Value>§modalities: Vec<ResponsesCreateRequestModalitiesItem>§model: String§n: Option<i64>§parallel_tool_calls: Option<bool>§previous_response_id: Option<String>§prompt_cache_key: Option<String>§prompt_cache_retention: Option<String>§quality: Option<String>§reasoning: Option<ReasoningOptions>§reasoning_effort: Option<String>§resolution: Option<String>§response_format: Option<ResponseFormat>§service_tier: Option<String>§size: Option<String>§speed: Option<f64>§store: Option<bool>§stream: Option<bool>§stream_options: Option<StreamOptions>§temperature: Option<f64>§text: Map<String, Value>§tool_choice: Option<Value>§tools: Vec<Map<String, Value>>§voice: Option<String>

Implementations§

Trait Implementations§

Source§

impl Clone for ResponsesCreateRequest

Source§

fn clone(&self) -> ResponsesCreateRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResponsesCreateRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ResponsesCreateRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<ResponsesCreateRequest> for ResponsesCreateRequest

Source§

fn from(value: ResponsesCreateRequest) -> Self

Converts to this type from the input type.
Source§

impl Serialize for ResponsesCreateRequest

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<ResponsesCreateRequest> for ResponsesCreateRequest

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

fn try_from(value: ResponsesCreateRequest) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more