refactor: adding missing fields from Responses API (#394)

Author: paulhendricks

async-openai/src/types/responses.rs

@@ -155,6 +155,11 @@ pub struct CreateResponse {
     /// performance characteristics, and price points.
     pub model: String,
 
+    /// Whether to run the model response in the background.
+    /// boolean or null.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub background: Option<bool>,
+
     /// Specify additional output data to include in the model response.
     ///
     /// Supported values:
@@ -188,6 +193,11 @@ pub struct CreateResponse {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub max_output_tokens: Option<u32>,
 
+    /// The maximum number of total calls to built-in tools that can be processed in a response.
+    /// This maximum number applies across all built-in tool calls, not per individual tool.
+    /// Any further attempts to call a tool by the model will be ignored.
+    pub max_tool_calls: Option<u32>,
+
     /// Set of 16 key-value pairs that can be attached to an object. This can be
     /// useful for storing additional information about the object in a structured
     /// format, and querying for objects via API or the dashboard.
@@ -206,6 +216,10 @@ pub struct CreateResponse {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub previous_response_id: Option<String>,
 
+    /// Reference to a prompt template and its variables.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub prompt: Option<PromptConfig>,
+
     /// **o-series models only**: Configuration options for reasoning models.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub reasoning: Option<ReasoningConfig>,
@@ -236,6 +250,11 @@ pub struct CreateResponse {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub store: Option<bool>,
 
+    /// If set to true, the model response data will be streamed to the client as it is
+    /// generated using server-sent events.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub stream: Option<bool>,
+
     /// What sampling temperature to use, between 0 and 2. Higher values like 0.8
     /// will make the output more random, while lower values like 0.2 will make it
     /// more focused and deterministic. We generally recommend altering this or
@@ -259,6 +278,11 @@ pub struct CreateResponse {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub tools: Option<Vec<ToolDefinition>>,
 
+    /// An integer between 0 and 20 specifying the number of most likely tokens to return
+    /// at each token position, each with an associated log probability.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub top_logprobs: Option<u32>, // TODO add validation of range
+
     /// An alternative to sampling with temperature, called nucleus sampling,
     /// where the model considers the results of the tokens with top_p probability
     /// mass. So 0.1 means only the tokens comprising the top 10% probability mass
@@ -279,6 +303,23 @@ pub struct CreateResponse {
     pub user: Option<String>,
 }
 
+/// Service tier request options.
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+pub struct PromptConfig {
+    /// The unique identifier of the prompt template to use.
+    pub id: String,
+
+    /// Optional version of the prompt template.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub version: Option<String>,
+
+    /// Optional map of values to substitute in for variables in your prompt. The substitution
+    /// values can either be strings, or other Response input types like images or files.
+    /// For now only supporting Strings.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub variables: Option<HashMap<String, String>>,
+}
+
 /// Service tier request options.
 #[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq)]
 #[serde(rename_all = "lowercase")]
@@ -1323,6 +1364,12 @@ pub struct Response {
     /// The array of content items generated by the model.
     pub output: Vec<OutputContent>,
 
+    /// SDK-only convenience property that contains the aggregated text output from all
+    /// `output_text` items in the `output` array, if any are present.
+    /// Supported in the Python and JavaScript SDKs.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub output_text: Option<String>,
+
     /// Whether parallel tool calls were enabled.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub parallel_tool_calls: Option<bool>,
@@ -1335,6 +1382,10 @@ pub struct Response {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub reasoning: Option<ReasoningConfig>,
 
+    /// Whether to store the generated model response for later retrieval via API.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub store: Option<bool>,
+
     /// The service tier that actually processed this response.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub service_tier: Option<ServiceTier>,