openai_struct/models/
realtime_response_create_params.rs

1/*
2 * OpenAI API
3 *
4 * The OpenAI REST API. Please see pub https://platform.openai.com/docs/api-reference for more details.
5 *
6 * OpenAPI spec pub version: 2.3.0
7 *
8 * Generated pub by: https://github.com/swagger-api/swagger-codegen.git
9 */
10
11/// pub RealtimeResponseCreateParams : Create a new Realtime response with these parameters
12
13#[allow(unused_imports)]
14use serde_json::Value;
15
16#[derive(Debug, Serialize, Deserialize)]
17pub struct RealtimeResponseCreateParams {
18    /// Controls which conversation the response is added to. Currently supports `auto` and `none`, with `auto` as the default value. The `auto` value means that the contents of the response will be added to the default conversation. Set this to `none` to create an out-of-band response which  will not add items to default conversation.
19    #[serde(rename = "conversation")]
20    pub conversation: Option<Value>,
21    /// Input items to include in the prompt for the model. Using this field creates a new context for this Response instead of using the default conversation. An empty array `[]` will clear the context for this Response. Note that this can include references to items from the default conversation.
22    #[serde(rename = "input")]
23    pub input: Option<Vec<crate::models::RealtimeConversationItemWithReference>>,
24    /// The default system instructions (i.e. system message) prepended to model  calls. This field allows the client to guide the model on desired  responses. The model can be instructed on response content and format,  (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good  responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion  into your voice\", \"laugh frequently\"). The instructions are not guaranteed  to be followed by the model, but they provide guidance to the model on the  desired behavior.  Note that the server sets default instructions which will be used if this  field is not set and are visible in the `session.created` event at the  start of the session.
25    #[serde(rename = "instructions")]
26    pub instructions: Option<String>,
27    /// Maximum number of output tokens for a single assistant response, inclusive of tool calls. Provide an integer between 1 and 4096 to limit output tokens, or `inf` for the maximum available tokens for a given model. Defaults to `inf`.
28    #[serde(rename = "max_response_output_tokens")]
29    pub max_response_output_tokens: Option<Value>,
30    #[serde(rename = "metadata")]
31    pub metadata: Option<crate::models::Metadata>,
32    /// The set of modalities the model can respond with. To disable audio, set this to [\"text\"].
33    #[serde(rename = "modalities")]
34    pub modalities: Option<Vec<String>>,
35    /// The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
36    #[serde(rename = "output_audio_format")]
37    pub output_audio_format: Option<String>,
38    /// Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.
39    #[serde(rename = "temperature")]
40    pub temperature: Option<f32>,
41    /// How the model chooses tools. Options are `auto`, `none`, `required`, or  specify a function, like `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}`.
42    #[serde(rename = "tool_choice")]
43    pub tool_choice: Option<String>,
44    /// Tools (functions) available to the model.
45    #[serde(rename = "tools")]
46    pub tools: Option<Vec<crate::models::RealtimeResponseCreateParamsTools>>,
47    /// The voice the model uses to respond. Voice cannot be changed during the  session once the model has responded with audio at least once. Current  voice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, and `verse`.
48    #[serde(rename = "voice")]
49    pub voice: Option<crate::models::VoiceIdsShared>,
50}
openai_struct/models/realtime_response_create_params.rs

openai_struct/models/
realtime_response_create_params.rs
