@ai-sdk/openai 3.0.19 → 3.0.21

package/docs/03-openai.mdx

@@ -186,6 +186,9 @@ The following provider options are available:
   They can be used to change the system or developer message when continuing a conversation using the `previousResponseId` option.
   Defaults to `undefined`.
 
+- **logprobs** _boolean | number_
+  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` returns the log probabilities of the tokens that were generated. Setting to a number (1-20) returns the log probabilities of the top n tokens that were generated.
+
 - **user** _string_
   A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Defaults to `undefined`.
 
@@ -374,6 +377,9 @@ const result = await generateText({
         city: 'San Francisco',
         region: 'California',
       },
+      filters: {
+        allowedDomains: ['sfchronicle.com', 'sfgate.com'],
+      },
     }),
   },
   // Force web search tool (optional):
@@ -393,6 +399,14 @@ for (const toolResult of result.toolResults) {
 }
 ```
 
+The web search tool supports the following configuration options:
+
+- **externalWebAccess** _boolean_ - Whether to use external web access for fetching live content. Defaults to `true`.
+- **searchContextSize** _'low' | 'medium' | 'high'_ - Controls the amount of context used for the search. Higher values provide more comprehensive results but may have higher latency and cost.
+- **userLocation** - Optional location information to provide geographically relevant results. Includes `type` (always `'approximate'`), `country`, `city`, `region`, and `timezone`.
+- **filters** - Optional filter configuration to restrict search results.
+  - **allowedDomains** _string[]_ - Array of allowed domains for the search. Subdomains of the provided domains are automatically included.
+
 For detailed information on configuration options see the [OpenAI Web Search Tool documentation](https://platform.openai.com/docs/guides/tools-web-search?api-mode=responses).
 
 #### File Search Tool
@@ -430,6 +444,49 @@ const result = await generateText({
 });
 ```
 
+The file search tool supports filtering with both comparison and compound filters:
+
+**Comparison filters** - Filter by a single attribute:
+
+- `eq` - Equal to
+- `ne` - Not equal to
+- `gt` - Greater than
+- `gte` - Greater than or equal to
+- `lt` - Less than
+- `lte` - Less than or equal to
+- `in` - Value is in array
+- `nin` - Value is not in array
+
+```ts
+// Single comparison filter
+filters: { key: 'year', type: 'gte', value: 2023 }
+
+// Filter with array values
+filters: { key: 'status', type: 'in', value: ['published', 'reviewed'] }
+```
+
+**Compound filters** - Combine multiple filters with `and` or `or`:
+
+```ts
+// Compound filter with AND
+filters: {
+  type: 'and',
+  filters: [
+    { key: 'author', type: 'eq', value: 'Jane Smith' },
+    { key: 'year', type: 'gte', value: 2023 },
+  ],
+}
+
+// Compound filter with OR
+filters: {
+  type: 'or',
+  filters: [
+    { key: 'department', type: 'eq', value: 'Engineering' },
+    { key: 'department', type: 'eq', value: 'Research' },
+  ],
+}
+```
+
 #### Image Generation Tool
 
 OpenAI's Responses API supports multi-modal image generation as a provider-defined tool.
@@ -1179,6 +1236,14 @@ The following optional provider options are available for OpenAI chat models:
 
   A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user.
 
+- **systemMessageMode** _'system' | 'developer' | 'remove'_
+
+  Override the system message mode for this model. If not specified, the mode is automatically determined based on the model. `system` uses the 'system' role for system messages (default for most models); `developer` uses the 'developer' role (used by reasoning models); `remove` removes system messages entirely.
+
+- **forceReasoning** _boolean_
+
+  Force treating this model as a reasoning model. This is useful for "stealth" reasoning models (e.g. via a custom baseURL) where the model ID is not recognized by the SDK's allowlist. When enabled, the SDK applies reasoning-model parameter compatibility rules and defaults `systemMessageMode` to `developer` unless overridden.
+
 #### Reasoning
 
 OpenAI has introduced the `o1`,`o3`, and `o4` series of [reasoning models](https://platform.openai.com/docs/guides/reasoning).
@@ -2053,12 +2118,6 @@ const result = await generateSpeech({
   Does not work with `tts-1` or `tts-1-hd`.
   Optional.
 
-- **response_format** _string_
-  The format to audio in.
-  Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.
-  Defaults to `mp3`.
-  Optional.
-
 - **speed** _number_
   The speed of the generated audio.
   Select a value from 0.25 to 4.0.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai",
-  "version": "3.0.19",
+  "version": "3.0.21",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@ai-sdk/provider": "3.0.5",
-    "@ai-sdk/provider-utils": "4.0.9"
+    "@ai-sdk/provider-utils": "4.0.10"
   },
   "devDependencies": {
     "@types/node": "20.17.24",

package/src/completion/openai-completion-options.ts

@@ -8,46 +8,46 @@ export const openaiCompletionProviderOptions = lazySchema(() =>
   zodSchema(
     z.object({
       /**
-Echo back the prompt in addition to the completion.
-   */
+       * Echo back the prompt in addition to the completion.
+       */
       echo: z.boolean().optional(),
 
       /**
-Modify the likelihood of specified tokens appearing in the completion.
-
-Accepts a JSON object that maps tokens (specified by their token ID in
-the GPT tokenizer) to an associated bias value from -100 to 100. You
-can use this tokenizer tool to convert text to token IDs. Mathematically,
-the bias is added to the logits generated by the model prior to sampling.
-The exact effect will vary per model, but values between -1 and 1 should
-decrease or increase likelihood of selection; values like -100 or 100
-should result in a ban or exclusive selection of the relevant token.
-
-As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-token from being generated.
- */
+       * Modify the likelihood of specified tokens appearing in the completion.
+       *
+       * Accepts a JSON object that maps tokens (specified by their token ID in
+       * the GPT tokenizer) to an associated bias value from -100 to 100. You
+       * can use this tokenizer tool to convert text to token IDs. Mathematically,
+       * the bias is added to the logits generated by the model prior to sampling.
+       * The exact effect will vary per model, but values between -1 and 1 should
+       * decrease or increase likelihood of selection; values like -100 or 100
+       * should result in a ban or exclusive selection of the relevant token.
+       *
+       * As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
+       * token from being generated.
+       */
       logitBias: z.record(z.string(), z.number()).optional(),
 
       /**
-The suffix that comes after a completion of inserted text.
- */
+       * The suffix that comes after a completion of inserted text.
+       */
       suffix: z.string().optional(),
 
       /**
-A unique identifier representing your end-user, which can help OpenAI to
-monitor and detect abuse. Learn more.
- */
+       * A unique identifier representing your end-user, which can help OpenAI to
+       * monitor and detect abuse. Learn more.
+       */
       user: z.string().optional(),
 
       /**
-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.
-Setting to a number will return the log probabilities of the top n
-tokens that were generated.
-   */
+       * 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.
+       * Setting to a number will return the log probabilities of the top n
+       * tokens that were generated.
+       */
       logprobs: z.union([z.boolean(), z.number()]).optional(),
     }),
   ),

package/src/embedding/openai-embedding-options.ts

@@ -11,15 +11,15 @@ export const openaiEmbeddingProviderOptions = lazySchema(() =>
   zodSchema(
     z.object({
       /**
-The number of dimensions the resulting output embeddings should have.
-Only supported in text-embedding-3 and later models.
-   */
+       * The number of dimensions the resulting output embeddings should have.
+       * Only supported in text-embedding-3 and later models.
+       */
       dimensions: z.number().optional(),
 
       /**
-A unique identifier representing your end-user, which can help OpenAI to
-monitor and detect abuse. Learn more.
-*/
+       * A unique identifier representing your end-user, which can help OpenAI to
+       * monitor and detect abuse. Learn more.
+       */
       user: z.string().optional(),
     }),
   ),

package/src/openai-provider.ts

@@ -34,32 +34,32 @@ export interface OpenAIProvider extends ProviderV3 {
   (modelId: OpenAIResponsesModelId): LanguageModelV3;
 
   /**
-Creates an OpenAI model for text generation.
+   * Creates an OpenAI model for text generation.
    */
   languageModel(modelId: OpenAIResponsesModelId): LanguageModelV3;
 
   /**
-Creates an OpenAI chat model for text generation.
+   * Creates an OpenAI chat model for text generation.
    */
   chat(modelId: OpenAIChatModelId): LanguageModelV3;
 
   /**
-Creates an OpenAI responses API model for text generation.
+   * Creates an OpenAI responses API model for text generation.
    */
   responses(modelId: OpenAIResponsesModelId): LanguageModelV3;
 
   /**
-Creates an OpenAI completion model for text generation.
+   * Creates an OpenAI completion model for text generation.
    */
   completion(modelId: OpenAICompletionModelId): LanguageModelV3;
 
   /**
-Creates a model for text embeddings.
+   * Creates a model for text embeddings.
    */
   embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3;
 
   /**
-Creates a model for text embeddings.
+   * Creates a model for text embeddings.
    */
   embeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3;
 
@@ -74,71 +74,71 @@ Creates a model for text embeddings.
   textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3;
 
   /**
-Creates a model for image generation.
+   * Creates a model for image generation.
    */
   image(modelId: OpenAIImageModelId): ImageModelV3;
 
   /**
-Creates a model for image generation.
+   * Creates a model for image generation.
    */
   imageModel(modelId: OpenAIImageModelId): ImageModelV3;
 
   /**
-Creates a model for transcription.
+   * Creates a model for transcription.
    */
   transcription(modelId: OpenAITranscriptionModelId): TranscriptionModelV3;
 
   /**
-Creates a model for speech generation.
+   * Creates a model for speech generation.
    */
   speech(modelId: OpenAISpeechModelId): SpeechModelV3;
 
   /**
-OpenAI-specific tools.
+   * OpenAI-specific tools.
    */
   tools: typeof openaiTools;
 }
 
 export interface OpenAIProviderSettings {
   /**
-Base URL for the OpenAI API calls.
-     */
+   * Base URL for the OpenAI API calls.
+   */
   baseURL?: string;
 
   /**
-API key for authenticating requests.
-     */
+   * API key for authenticating requests.
+   */
   apiKey?: string;
 
   /**
-OpenAI Organization.
-     */
+   * OpenAI Organization.
+   */
   organization?: string;
 
   /**
-OpenAI project.
-     */
+   * OpenAI project.
+   */
   project?: string;
 
   /**
-Custom headers to include in the requests.
-     */
+   * Custom headers to include in the requests.
+   */
   headers?: Record<string, string>;
 
   /**
-Provider name. Overrides the `openai` default name for 3rd party providers.
+   * Provider name. Overrides the `openai` default name for 3rd party providers.
    */
   name?: string;
 
   /**
-Custom fetch implementation. You can use it as a middleware to intercept requests,
-or to provide a custom fetch implementation for e.g. testing.
-    */
+   * Custom fetch implementation. You can use it as a middleware to intercept requests,
+   * or to provide a custom fetch implementation for e.g. testing.
+   */
   fetch?: FetchFunction;
 }
 
 /**
-Create an OpenAI provider instance.
+ * Create an OpenAI provider instance.
  */
 export function createOpenAI(
   options: OpenAIProviderSettings = {},
@@ -265,6 +265,6 @@ export function createOpenAI(
 }
 
 /**
-Default OpenAI provider instance.
+ * Default OpenAI provider instance.
  */
 export const openai = createOpenAI();