@ai-sdk/openai 0.0.0-85f9a635-20240518005312

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,198 @@
+# Vercel AI SDK - OpenAI Provider
+
+The [OpenAI](https://platform.openai.com/) provider for the [Vercel AI SDK](https://sdk.vercel.ai/docs) contains language model support for the OpenAI chat and completion APIs.
+It creates language model objects that can be used with the `generateText`, `streamText`, `generateObject`, and `streamObject` AI functions.
+
+## Setup
+
+The OpenAI provider is available in the `@ai-sdk/openai` module. You can install it with
+
+```bash
+npm i @ai-sdk/openai
+```
+
+## Provider Instance
+
+You can import the default provider instance `openai` from `@ai-sdk/openai`:
+
+```ts
+import { openai } from '@ai-sdk/openai';
+```
+
+If you need a customized setup, you can import `createOpenAI` from `@ai-sdk/openai` and create a provider instance with your settings:
+
+```ts
+import { createOpenAI } from '@ai-sdk/openai';
+
+const openai = createOpenAI({
+  // custom settings
+});
+```
+
+You can use the following optional settings to customize the OpenAI provider instance:
+
+- **baseURL** _string_
+
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://api.openai.com/v1`.
+
+- **apiKey** _string_
+
+  API key that is being send using the `Authorization` header.
+  It defaults to the `OPENAI_API_KEY` environment variable.
+
+- **organization** _string_
+
+  OpenAI Organization.
+
+- **project** _string_
+
+  OpenAI project.
+
+- **headers** _Record<string,string>_
+
+  Custom headers to include in the requests.
+
+## Models
+
+The OpenAI provider instance is a function that you can invoke to create a model:
+
+```ts
+const model = openai('gpt-3.5-turbo');
+```
+
+It automatically selects the correct API based on the model id.
+You can also pass additional settings in the second argument:
+
+```ts
+const model = openai('gpt-3.5-turbo', {
+  // additional settings
+});
+```
+
+The available options depend on the API that's automatically chosen for the model (see below).
+If you want to explicitly select a specific model API, you can use `.chat` or `.completion`.
+
+### Chat Models
+
+You can create models that call the [OpenAI chat API](https://platform.openai.com/docs/api-reference/chat) using the `.chat()` factory method.
+The first argument is the model id, e.g. `gpt-4`.
+The OpenAI chat models support tool calls and some have multi-modal capabilities.
+
+```ts
+const model = openai.chat('gpt-3.5-turbo');
+```
+
+OpenAI chat models support also some model specific settings that are not part of the [standard call settings](/docs/ai-core/settings).
+You can pass them as an options argument:
+
+```ts
+const model = openai.chat('gpt-3.5-turbo', {
+  logitBias: {
+    // optional likelihood for specific tokens
+    '50256': -100,
+  },
+  user: 'test-user', // optional unique user identifier
+});
+```
+
+The following optional settings are available for OpenAI chat models:
+
+- **logitBias** _Record<number, number>_
+
+  Modifies 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.
+
+- **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 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.
+
+- **user** _string_
+
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+
+### Completion Models
+
+You can create models that call the [OpenAI completions API](https://platform.openai.com/docs/api-reference/completions) using the `.completion()` factory method.
+The first argument is the model id.
+Currently only `gpt-3.5-turbo-instruct` is supported.
+
+```ts
+const model = openai.completion('gpt-3.5-turbo-instruct');
+```
+
+OpenAI completion models support also some model specific settings that are not part of the [standard call settings](/docs/ai-core/settings).
+You can pass them as an options argument:
+
+```ts
+const model = openai.completion('gpt-3.5-turbo-instruct', {
+  echo: true, // optional, echo the prompt in addition to the completion
+  logitBias: {
+    // optional likelihood for specific tokens
+    '50256': -100,
+  },
+  suffix: 'some text', // optional suffix that comes after a completion of inserted text
+  user: 'test-user', // optional unique user identifier
+});
+```
+
+The following optional settings are available for OpenAI completion models:
+
+- **echo**: _boolean_
+
+  Echo back the prompt in addition to the completion.
+
+- **logitBias** _Record<number, number>_
+
+  Modifies 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.
+
+- **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 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.
+
+- **suffix** _string_
+
+  The suffix that comes after a completion of inserted text.
+
+- **user** _string_
+
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.

package/dist/index.d.mts

@@ -0,0 +1,255 @@
+import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
+
+type OpenAIChatModelId = 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k-0613' | (string & {});
+interface OpenAIChatSettings {
+    /**
+  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?: Record<number, 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 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?: boolean | number;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+  */
+    user?: string;
+}
+
+type OpenAIChatConfig = {
+    provider: string;
+    baseURL: string;
+    compatibility: 'strict' | 'compatible';
+    headers: () => Record<string, string | undefined>;
+};
+declare class OpenAIChatLanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode = "tool";
+    readonly modelId: OpenAIChatModelId;
+    readonly settings: OpenAIChatSettings;
+    private readonly config;
+    constructor(modelId: OpenAIChatModelId, settings: OpenAIChatSettings, config: OpenAIChatConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    doRawStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Omit<Awaited<ReturnType<LanguageModelV1['doStream']>>, 'stream'> & {
+        stream: ReadableStream<Uint8Array>;
+    }>;
+    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
+}
+
+type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
+interface OpenAICompletionSettings {
+    /**
+  Echo back the prompt in addition to the completion.
+     */
+    echo?: boolean;
+    /**
+  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?: Record<number, 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 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?: boolean | number;
+    /**
+  The suffix that comes after a completion of inserted text.
+     */
+    suffix?: string;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+     */
+    user?: string;
+}
+
+type OpenAICompletionConfig = {
+    provider: string;
+    baseURL: string;
+    compatibility: 'strict' | 'compatible';
+    headers: () => Record<string, string | undefined>;
+};
+declare class OpenAICompletionLanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode: undefined;
+    readonly modelId: OpenAICompletionModelId;
+    readonly settings: OpenAICompletionSettings;
+    private readonly config;
+    constructor(modelId: OpenAICompletionModelId, settings: OpenAICompletionSettings, config: OpenAICompletionConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
+}
+
+type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large' | 'text-embedding-ada-002' | (string & {});
+interface OpenAIEmbeddingSettings {
+    /**
+  Override the maximum number of embeddings per call.
+     */
+    maxEmbeddingsPerCall?: number;
+    /**
+  Override the parallelism of embedding calls.
+      */
+    supportsParallelCalls?: boolean;
+    /**
+  The number of dimensions the resulting output embeddings should have.
+  Only supported in text-embedding-3 and later models.
+     */
+    dimensions?: number;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+  */
+    user?: string;
+}
+
+type OpenAIEmbeddingConfig = {
+    provider: string;
+    baseURL: string;
+    headers: () => Record<string, string | undefined>;
+};
+declare class OpenAIEmbeddingModel implements EmbeddingModelV1<string> {
+    readonly specificationVersion = "v1";
+    readonly modelId: OpenAIEmbeddingModelId;
+    private readonly config;
+    private readonly settings;
+    get provider(): string;
+    get maxEmbeddingsPerCall(): number;
+    get supportsParallelCalls(): boolean;
+    constructor(modelId: OpenAIEmbeddingModelId, settings: OpenAIEmbeddingSettings, config: OpenAIEmbeddingConfig);
+    doEmbed({ values, abortSignal, }: Parameters<EmbeddingModelV1<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV1<string>['doEmbed']>>>;
+}
+
+interface OpenAIProvider {
+    (modelId: 'gpt-3.5-turbo-instruct', settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+    (modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    /**
+  Creates an OpenAI chat model for text generation.
+     */
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    /**
+  Creates an OpenAI completion model for text generation.
+     */
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+    /**
+  Creates a model for text embeddings.
+     */
+    embedding(modelId: OpenAIEmbeddingModelId, settings?: OpenAIEmbeddingSettings): OpenAIEmbeddingModel;
+}
+interface OpenAIProviderSettings {
+    /**
+  Base URL for the OpenAI API calls.
+       */
+    baseURL?: string;
+    /**
+  @deprecated Use `baseURL` instead.
+       */
+    baseUrl?: string;
+    /**
+  API key for authenticating requests.
+       */
+    apiKey?: string;
+    /**
+  OpenAI Organization.
+       */
+    organization?: string;
+    /**
+  OpenAI project.
+       */
+    project?: string;
+    /**
+  Custom headers to include in the requests.
+       */
+    headers?: Record<string, string>;
+    /**
+  OpenAI compatibility mode. Should be set to `strict` when using the OpenAI API,
+  and `compatible` when using 3rd party providers. In `compatible` mode, newer
+  information such as streamOptions are not being sent. Defaults to 'compatible'.
+     */
+    compatibility?: 'strict' | 'compatible';
+}
+/**
+Create an OpenAI provider instance.
+ */
+declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
+/**
+Default OpenAI provider instance. It uses 'strict' compatibility mode.
+ */
+declare const openai: OpenAIProvider;
+
+/**
+@deprecated Use `createOpenAI` instead.
+ */
+declare class OpenAI {
+    /**
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://api.openai.com/v1`.
+     */
+    readonly baseURL: string;
+    /**
+  API key that is being send using the `Authorization` header.
+  It defaults to the `OPENAI_API_KEY` environment variable.
+   */
+    readonly apiKey?: string;
+    /**
+  OpenAI Organization.
+     */
+    readonly organization?: string;
+    /**
+  OpenAI project.
+     */
+    readonly project?: string;
+    /**
+  Custom headers to include in the requests.
+     */
+    readonly headers?: Record<string, string>;
+    /**
+     * Creates a new OpenAI provider instance.
+     */
+    constructor(options?: OpenAIProviderSettings);
+    private get baseConfig();
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+}
+
+export { OpenAI, type OpenAIProvider, type OpenAIProviderSettings, createOpenAI, openai };