@ai-sdk/openai 3.0.0-beta.77 → 3.0.0-beta.78

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 3.0.0-beta.78
+
+### Patch Changes
+
+- 2c0a758: chore(openai): add JSDoc to responses options
+
 ## 3.0.0-beta.77
 
 ### Patch Changes

package/dist/index.js

@@ -3272,7 +3272,18 @@ var openaiResponsesModelIds = [
 var openaiResponsesProviderOptionsSchema = (0, import_provider_utils24.lazySchema)(
   () => (0, import_provider_utils24.zodSchema)(
     import_v419.z.object({
+      /**
+       * The ID of the OpenAI Conversation to continue.
+       * You must create a conversation first via the OpenAI API.
+       * Cannot be used in conjunction with `previousResponseId`.
+       * Defaults to `undefined`.
+       * @see https://platform.openai.com/docs/api-reference/conversations/create
+       */
       conversation: import_v419.z.string().nullish(),
+      /**
+       * The set of extra fields to include in the response (advanced, usually not needed).
+       * Example values: 'reasoning.encrypted_content', 'file_search_call.results', 'message.output_text.logprobs'.
+       */
       include: import_v419.z.array(
         import_v419.z.enum([
           "reasoning.encrypted_content",
@@ -3281,9 +3292,16 @@ var openaiResponsesProviderOptionsSchema = (0, import_provider_utils24.lazySchem
           "message.output_text.logprobs"
         ])
       ).nullish(),
+      /**
+       * Instructions for the model.
+       * They can be used to change the system or developer message when continuing a conversation using the `previousResponseId` option.
+       * Defaults to `undefined`.
+       */
       instructions: import_v419.z.string().nullish(),
       /**
-       * Return the log probabilities of the tokens.
+       * Return the log probabilities of the tokens. Including logprobs will increase
+       * the response size and can slow down response times. However, it can
+       * be useful to better understand how the model is behaving.
        *
        * Setting to true will return the log probabilities of the tokens that
        * were generated.
@@ -3301,9 +3319,22 @@ var openaiResponsesProviderOptionsSchema = (0, import_provider_utils24.lazySchem
        * Any further attempts to call a tool by the model will be ignored.
        */
       maxToolCalls: import_v419.z.number().nullish(),
+      /**
+       * Additional metadata to store with the generation.
+       */
       metadata: import_v419.z.any().nullish(),
+      /**
+       * Whether to use parallel tool calls. Defaults to `true`.
+       */
       parallelToolCalls: import_v419.z.boolean().nullish(),
+      /**
+       * The ID of the previous response. You can use it to continue a conversation.
+       * Defaults to `undefined`.
+       */
       previousResponseId: import_v419.z.string().nullish(),
+      /**
+       * Sets a cache key to tie this prompt to cached prefixes for better caching performance.
+       */
       promptCacheKey: import_v419.z.string().nullish(),
       /**
        * The retention policy for the prompt cache.
@@ -3314,14 +3345,60 @@ var openaiResponsesProviderOptionsSchema = (0, import_provider_utils24.lazySchem
        * @default 'in_memory'
        */
       promptCacheRetention: import_v419.z.enum(["in_memory", "24h"]).nullish(),
+      /**
+       * Reasoning effort for reasoning models. Defaults to `medium`. If you use
+       * `providerOptions` to set the `reasoningEffort` option, this model setting will be ignored.
+       * Valid values: 'none' | 'minimal' | 'low' | 'medium' | 'high'
+       *
+       * Note: The 'none' type for `reasoningEffort` is only available for OpenAI's GPT-5.1
+       * models. Setting `reasoningEffort` to 'none' with other models will result in
+       * an error.
+       */
       reasoningEffort: import_v419.z.string().nullish(),
+      /**
+       * Controls reasoning summary output from the model.
+       * Set to "auto" to automatically receive the richest level available,
+       * or "detailed" for comprehensive summaries.
+       */
       reasoningSummary: import_v419.z.string().nullish(),
+      /**
+       * The identifier for safety monitoring and tracking.
+       */
       safetyIdentifier: import_v419.z.string().nullish(),
+      /**
+       * Service tier for the request.
+       * Set to 'flex' for 50% cheaper processing at the cost of increased latency (available for o3, o4-mini, and gpt-5 models).
+       * Set to 'priority' for faster processing with Enterprise access (available for gpt-4, gpt-5, gpt-5-mini, o3, o4-mini; gpt-5-nano is not supported).
+       *
+       * Defaults to 'auto'.
+       */
       serviceTier: import_v419.z.enum(["auto", "flex", "priority", "default"]).nullish(),
+      /**
+       * Whether to store the generation. Defaults to `true`.
+       */
       store: import_v419.z.boolean().nullish(),
+      /**
+       * Whether to use strict JSON schema validation.
+       * Defaults to `true`.
+       */
       strictJsonSchema: import_v419.z.boolean().nullish(),
+      /**
+       * Controls the verbosity of the model's responses. Lower values ('low') will result
+       * in more concise responses, while higher values ('high') will result in more verbose responses.
+       * Valid values: 'low', 'medium', 'high'.
+       */
       textVerbosity: import_v419.z.enum(["low", "medium", "high"]).nullish(),
+      /**
+       * Controls output truncation. 'auto' (default) performs truncation automatically;
+       * 'disabled' turns truncation off.
+       */
       truncation: import_v419.z.enum(["auto", "disabled"]).nullish(),
+      /**
+       * A unique identifier representing your end-user, which can help OpenAI to
+       * monitor and detect abuse.
+       * Defaults to `undefined`.
+       * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
+       */
       user: import_v419.z.string().nullish()
     })
   )
@@ -5180,7 +5257,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.0-beta.77" : "0.0.0-test";
+var VERSION = true ? "3.0.0-beta.78" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {