@ai-sdk/openai 3.0.20 → 3.0.22

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/openai
 
+## 3.0.22
+
+### Patch Changes
+
+- 1524271: chore: add skill information to README files
+
+## 3.0.21
+
+### Patch Changes
+
+- 2c70b90: chore: update provider docs
+
 ## 3.0.20
 
 ### Patch Changes

package/README.md

@@ -11,6 +11,14 @@ The OpenAI provider is available in the `@ai-sdk/openai` module. You can install
 npm i @ai-sdk/openai
 ```
 
+## Skill for Coding Agents
+
+If you use coding agents such as Claude Code or Cursor, we highly recommend adding the AI SDK skill to your repository:
+
+```shell
+npx skills add vercel/ai
+```
+
 ## Provider Instance
 
 You can import the default provider instance `openai` from `@ai-sdk/openai`:

package/dist/index.d.mts

@@ -817,27 +817,27 @@ type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-
 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;
     /**
@@ -849,63 +849,63 @@ interface OpenAIProvider extends ProviderV3 {
      */
     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;
 }
 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.
  */
 declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
 /**
-Default OpenAI provider instance.
+ * Default OpenAI provider instance.
  */
 declare const openai: OpenAIProvider;
 

package/dist/index.d.ts

@@ -817,27 +817,27 @@ type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-
 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;
     /**
@@ -849,63 +849,63 @@ interface OpenAIProvider extends ProviderV3 {
      */
     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;
 }
 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.
  */
 declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
 /**
-Default OpenAI provider instance.
+ * Default OpenAI provider instance.
  */
 declare const openai: OpenAIProvider;
 

package/dist/index.js

@@ -1339,42 +1339,42 @@ var openaiCompletionProviderOptions = (0, import_provider_utils7.lazySchema)(
   () => (0, import_provider_utils7.zodSchema)(
     import_v45.z.object({
       /**
-      Echo back the prompt in addition to the completion.
-         */
+       * Echo back the prompt in addition to the completion.
+       */
       echo: import_v45.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: import_v45.z.record(import_v45.z.string(), import_v45.z.number()).optional(),
       /**
-      The suffix that comes after a completion of inserted text.
+       * The suffix that comes after a completion of inserted text.
        */
       suffix: import_v45.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: import_v45.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: import_v45.z.union([import_v45.z.boolean(), import_v45.z.number()]).optional()
     })
   )
@@ -1620,14 +1620,14 @@ var openaiEmbeddingProviderOptions = (0, import_provider_utils9.lazySchema)(
   () => (0, import_provider_utils9.zodSchema)(
     import_v46.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: import_v46.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: import_v46.z.string().optional()
     })
   )
@@ -5786,7 +5786,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.20" : "0.0.0-test";
+var VERSION = true ? "3.0.22" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {