@ai-sdk/openai 0.0.1 → 0.0.3

package/README.md

@@ -13,12 +13,12 @@ npm i @ai-sdk/openai
 
 ## Provider Instance
 
-You can import `OpenAI` from `ai/openai` and initialize a provider instance with various settings:
+You can import `createOpenAI` from `@ai-sdk/openai` and create a provider instance with various settings:
 
 ```ts
-import { OpenAI } from '@ai-sdk/openai'
+import { createOpenAI } from '@ai-sdk/openai'
 
-const openai = new OpenAI({
+const openai = createOpenAI({
   baseURL: '', // optional base URL for proxies etc.
   apiKey: '' // optional API key, default to env property OPENAI_API_KEY
   organization: '' // optional organization
@@ -31,7 +31,19 @@ The AI SDK also provides a shorthand `openai` import with an OpenAI provider ins
 import { openai } from '@ai-sdk/openai';
 ```
 
-## Chat Models
+## 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 provide model-specific parameters or select a model API by using `.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`.
@@ -54,7 +66,7 @@ const model = openai.chat('gpt-3.5-turbo', {
 });
 ```
 
-## Completion Models
+### 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.
@@ -68,7 +80,7 @@ OpenAI completion models support also some model specific settings that are not
 You can pass them as an options argument:
 
 ```ts
-const model = openai.chat('gpt-3.5-turbo', {
+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

package/dist/index.d.mts

@@ -0,0 +1,163 @@
+import { LanguageModelV1 } from '@ai-sdk/provider';
+
+type OpenAIChatModelId = '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>;
+    /**
+     * 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;
+    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']>>>;
+    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>;
+    /**
+     * 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;
+    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']>>>;
+}
+
+/**
+ * @deprecated Use `createOpenAI` instead.
+ */
+declare class OpenAI {
+    /**
+     * Base URL for the OpenAI API calls.
+     */
+    readonly baseURL: string;
+    readonly apiKey?: string;
+    readonly organization?: string;
+    /**
+     * Creates a new OpenAI provider instance.
+     */
+    constructor(options?: {
+        /**
+         * Base URL for the OpenAI API calls.
+         */
+        baseURL?: string;
+        /**
+         * @deprecated Use `baseURL` instead.
+         */
+        baseUrl?: string;
+        /**
+         * API key for authenticating requests.
+         */
+        apiKey?: string;
+        /**
+         * Organization ID.
+         */
+        organization?: string;
+    });
+    private get baseConfig();
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+}
+
+interface OpenAIProvider {
+    (modelId: 'gpt-3.5-turbo-instruct', settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+    (modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+}
+/**
+ * Create an OpenAI provider.
+ */
+declare function createOpenAI(options?: {
+    /**
+     * Base URL for the OpenAI API calls.
+     */
+    baseURL?: string;
+    /**
+     * @deprecated Use `baseURL` instead.
+     */
+    baseUrl?: string;
+    /**
+     * API key for authenticating requests.
+     */
+    apiKey?: string;
+    /**
+     * Organization ID.
+     */
+    organization?: string;
+}): OpenAIProvider;
+/**
+ * Default OpenAI provider instance.
+ */
+declare const openai: OpenAIProvider;
+
+export { OpenAI, type OpenAIProvider, createOpenAI, openai };

package/dist/index.d.ts

@@ -0,0 +1,163 @@
+import { LanguageModelV1 } from '@ai-sdk/provider';
+
+type OpenAIChatModelId = '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>;
+    /**
+     * 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;
+    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']>>>;
+    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>;
+    /**
+     * 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;
+    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']>>>;
+}
+
+/**
+ * @deprecated Use `createOpenAI` instead.
+ */
+declare class OpenAI {
+    /**
+     * Base URL for the OpenAI API calls.
+     */
+    readonly baseURL: string;
+    readonly apiKey?: string;
+    readonly organization?: string;
+    /**
+     * Creates a new OpenAI provider instance.
+     */
+    constructor(options?: {
+        /**
+         * Base URL for the OpenAI API calls.
+         */
+        baseURL?: string;
+        /**
+         * @deprecated Use `baseURL` instead.
+         */
+        baseUrl?: string;
+        /**
+         * API key for authenticating requests.
+         */
+        apiKey?: string;
+        /**
+         * Organization ID.
+         */
+        organization?: string;
+    });
+    private get baseConfig();
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+}
+
+interface OpenAIProvider {
+    (modelId: 'gpt-3.5-turbo-instruct', settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+    (modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+}
+/**
+ * Create an OpenAI provider.
+ */
+declare function createOpenAI(options?: {
+    /**
+     * Base URL for the OpenAI API calls.
+     */
+    baseURL?: string;
+    /**
+     * @deprecated Use `baseURL` instead.
+     */
+    baseUrl?: string;
+    /**
+     * API key for authenticating requests.
+     */
+    apiKey?: string;
+    /**
+     * Organization ID.
+     */
+    organization?: string;
+}): OpenAIProvider;
+/**
+ * Default OpenAI provider instance.
+ */
+declare const openai: OpenAIProvider;
+
+export { OpenAI, type OpenAIProvider, createOpenAI, openai };