ai 3.1.0-canary.2 → 3.1.0-canary.4

package/{provider → openai}/dist/index.d.mts

@@ -48,6 +48,10 @@ type LanguageModelV1CallSettings = {
      * by the model, calls will generate deterministic results.
      */
     seed?: number;
+    /**
+     * Abort signal for cancelling the operation.
+     */
+    abortSignal?: AbortSignal;
 };
 
 /**
@@ -103,9 +107,9 @@ interface LanguageModelV1TextPart {
 interface LanguageModelV1ImagePart {
     type: 'image';
     /**
-     * Image data as a Uint8Array.
+     * Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
      */
-    image: Uint8Array;
+    image: Uint8Array | URL;
     /**
      * Optional mime type of the image.
      */
@@ -231,6 +235,32 @@ type LanguageModelV1 = {
          * model has only generated text.
          */
         toolCalls?: Array<LanguageModelV1FunctionToolCall>;
+        /**
+         * Finish reason.
+         */
+        finishReason: LanguageModelV1FinishReason;
+        /**
+         * Usage information.
+         */
+        usage: {
+            promptTokens: number;
+            completionTokens: number;
+        };
+        /**
+         * Raw prompt and setting information for observability provider integration.
+         */
+        rawCall: {
+            /**
+             * Raw prompt after expansion and conversion to the format that the
+             * provider uses to send the information to their API.
+             */
+            rawPrompt: unknown;
+            /**
+             * Raw settings that are used for the API call. Includes provider-specific
+             * settings.
+             */
+            rawSettings: Record<string, unknown>;
+        };
         warnings?: LanguageModelV1CallWarning[];
     }>;
     /**
@@ -243,6 +273,21 @@ type LanguageModelV1 = {
      */
     doStream(options: LanguageModelV1CallOptions): PromiseLike<{
         stream: ReadableStream<LanguageModelV1StreamPart>;
+        /**
+         * Raw prompt and setting information for observability provider integration.
+         */
+        rawCall: {
+            /**
+             * Raw prompt after expansion and conversion to the format that the
+             * provider uses to send the information to their API.
+             */
+            rawPrompt: unknown;
+            /**
+             * Raw settings that are used for the API call. Includes provider-specific
+             * settings.
+             */
+            rawSettings: Record<string, unknown>;
+        };
         warnings?: LanguageModelV1CallWarning[];
     }>;
 };
@@ -268,83 +313,117 @@ type LanguageModelV1StreamPart = {
     error: unknown;
 };
 
-type Config$1<SETTINGS extends {
-    id: string;
-}> = {
+type OpenAIChatModelId = 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-0125-preview' | 'gpt-4-vision-preview' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k' | '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;
-    apiKey: () => string;
-    mapSettings: (settings: SETTINGS) => Record<string, unknown> & {
-        model: string;
-    };
+    headers: () => Record<string, string | undefined>;
 };
-declare class OpenAIChatLanguageModel<SETTINGS extends {
-    id: string;
-}> implements LanguageModelV1 {
+declare class OpenAIChatLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
     readonly defaultObjectGenerationMode = "tool";
-    readonly settings: SETTINGS;
+    readonly modelId: OpenAIChatModelId;
+    readonly settings: OpenAIChatSettings;
     private readonly config;
-    constructor(settings: SETTINGS, config: Config$1<SETTINGS>);
+    constructor(modelId: OpenAIChatModelId, settings: OpenAIChatSettings, config: OpenAIChatConfig);
     get provider(): string;
-    get modelId(): 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 OpenAIChatModelId = 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-0125-preview' | 'gpt-4-vision-preview' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-16k-0613' | (string & {});
-interface OpenAIChatSettings {
+type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
+interface OpenAICompletionSettings {
     /**
-     * The ID of the model to use.
+     * 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.
      */
-    id: OpenAIChatModelId;
     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 Config<SETTINGS extends {
-    id: string;
-}> = {
+type OpenAICompletionConfig = {
     provider: string;
     baseUrl: string;
-    apiKey: () => string;
-    mapSettings: (settings: SETTINGS) => Record<string, unknown> & {
-        model: string;
-    };
+    headers: () => Record<string, string | undefined>;
 };
-declare class OpenAICompletionLanguageModel<SETTINGS extends {
-    id: string;
-}> implements LanguageModelV1 {
+declare class OpenAICompletionLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
     readonly defaultObjectGenerationMode: undefined;
-    readonly settings: SETTINGS;
+    readonly modelId: OpenAICompletionModelId;
+    readonly settings: OpenAICompletionSettings;
     private readonly config;
-    constructor(settings: SETTINGS, config: Config<SETTINGS>);
+    constructor(modelId: OpenAICompletionModelId, settings: OpenAICompletionSettings, config: OpenAICompletionConfig);
     get provider(): string;
-    get modelId(): 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 {
-    /**
-     * The ID of the model to use.
-     */
-    id: OpenAICompletionModelId;
-    logitBias?: Record<number, number>;
-}
-
+/**
+ * OpenAI provider.
+ */
 declare class OpenAI {
     readonly baseUrl?: string;
     readonly apiKey?: string;
-    constructor({ baseUrl, apiKey }?: {
+    readonly organization?: string;
+    constructor(options?: {
         baseUrl?: string;
         apiKey?: string;
+        organization?: string;
     });
-    chat(settings: OpenAIChatSettings): OpenAIChatLanguageModel<OpenAIChatSettings>;
-    completion(settings: OpenAICompletionSettings): OpenAICompletionLanguageModel<OpenAICompletionSettings>;
+    private get baseConfig();
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
 }
+/**
+ * Default OpenAI provider instance.
+ */
+declare const openai: OpenAI;
 
-export { OpenAI };
+export { OpenAI, openai };

package/{provider → openai}/dist/index.d.ts

@@ -48,6 +48,10 @@ type LanguageModelV1CallSettings = {
      * by the model, calls will generate deterministic results.
      */
     seed?: number;
+    /**
+     * Abort signal for cancelling the operation.
+     */
+    abortSignal?: AbortSignal;
 };
 
 /**
@@ -103,9 +107,9 @@ interface LanguageModelV1TextPart {
 interface LanguageModelV1ImagePart {
     type: 'image';
     /**
-     * Image data as a Uint8Array.
+     * Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
      */
-    image: Uint8Array;
+    image: Uint8Array | URL;
     /**
      * Optional mime type of the image.
      */
@@ -231,6 +235,32 @@ type LanguageModelV1 = {
          * model has only generated text.
          */
         toolCalls?: Array<LanguageModelV1FunctionToolCall>;
+        /**
+         * Finish reason.
+         */
+        finishReason: LanguageModelV1FinishReason;
+        /**
+         * Usage information.
+         */
+        usage: {
+            promptTokens: number;
+            completionTokens: number;
+        };
+        /**
+         * Raw prompt and setting information for observability provider integration.
+         */
+        rawCall: {
+            /**
+             * Raw prompt after expansion and conversion to the format that the
+             * provider uses to send the information to their API.
+             */
+            rawPrompt: unknown;
+            /**
+             * Raw settings that are used for the API call. Includes provider-specific
+             * settings.
+             */
+            rawSettings: Record<string, unknown>;
+        };
         warnings?: LanguageModelV1CallWarning[];
     }>;
     /**
@@ -243,6 +273,21 @@ type LanguageModelV1 = {
      */
     doStream(options: LanguageModelV1CallOptions): PromiseLike<{
         stream: ReadableStream<LanguageModelV1StreamPart>;
+        /**
+         * Raw prompt and setting information for observability provider integration.
+         */
+        rawCall: {
+            /**
+             * Raw prompt after expansion and conversion to the format that the
+             * provider uses to send the information to their API.
+             */
+            rawPrompt: unknown;
+            /**
+             * Raw settings that are used for the API call. Includes provider-specific
+             * settings.
+             */
+            rawSettings: Record<string, unknown>;
+        };
         warnings?: LanguageModelV1CallWarning[];
     }>;
 };
@@ -268,83 +313,117 @@ type LanguageModelV1StreamPart = {
     error: unknown;
 };
 
-type Config$1<SETTINGS extends {
-    id: string;
-}> = {
+type OpenAIChatModelId = 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-0125-preview' | 'gpt-4-vision-preview' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k' | '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;
-    apiKey: () => string;
-    mapSettings: (settings: SETTINGS) => Record<string, unknown> & {
-        model: string;
-    };
+    headers: () => Record<string, string | undefined>;
 };
-declare class OpenAIChatLanguageModel<SETTINGS extends {
-    id: string;
-}> implements LanguageModelV1 {
+declare class OpenAIChatLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
     readonly defaultObjectGenerationMode = "tool";
-    readonly settings: SETTINGS;
+    readonly modelId: OpenAIChatModelId;
+    readonly settings: OpenAIChatSettings;
     private readonly config;
-    constructor(settings: SETTINGS, config: Config$1<SETTINGS>);
+    constructor(modelId: OpenAIChatModelId, settings: OpenAIChatSettings, config: OpenAIChatConfig);
     get provider(): string;
-    get modelId(): 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 OpenAIChatModelId = 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-0125-preview' | 'gpt-4-vision-preview' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-16k-0613' | (string & {});
-interface OpenAIChatSettings {
+type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
+interface OpenAICompletionSettings {
     /**
-     * The ID of the model to use.
+     * 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.
      */
-    id: OpenAIChatModelId;
     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 Config<SETTINGS extends {
-    id: string;
-}> = {
+type OpenAICompletionConfig = {
     provider: string;
     baseUrl: string;
-    apiKey: () => string;
-    mapSettings: (settings: SETTINGS) => Record<string, unknown> & {
-        model: string;
-    };
+    headers: () => Record<string, string | undefined>;
 };
-declare class OpenAICompletionLanguageModel<SETTINGS extends {
-    id: string;
-}> implements LanguageModelV1 {
+declare class OpenAICompletionLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
     readonly defaultObjectGenerationMode: undefined;
-    readonly settings: SETTINGS;
+    readonly modelId: OpenAICompletionModelId;
+    readonly settings: OpenAICompletionSettings;
     private readonly config;
-    constructor(settings: SETTINGS, config: Config<SETTINGS>);
+    constructor(modelId: OpenAICompletionModelId, settings: OpenAICompletionSettings, config: OpenAICompletionConfig);
     get provider(): string;
-    get modelId(): 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 {
-    /**
-     * The ID of the model to use.
-     */
-    id: OpenAICompletionModelId;
-    logitBias?: Record<number, number>;
-}
-
+/**
+ * OpenAI provider.
+ */
 declare class OpenAI {
     readonly baseUrl?: string;
     readonly apiKey?: string;
-    constructor({ baseUrl, apiKey }?: {
+    readonly organization?: string;
+    constructor(options?: {
         baseUrl?: string;
         apiKey?: string;
+        organization?: string;
     });
-    chat(settings: OpenAIChatSettings): OpenAIChatLanguageModel<OpenAIChatSettings>;
-    completion(settings: OpenAICompletionSettings): OpenAICompletionLanguageModel<OpenAICompletionSettings>;
+    private get baseConfig();
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
 }
+/**
+ * Default OpenAI provider instance.
+ */
+declare const openai: OpenAI;
 
-export { OpenAI };
+export { OpenAI, openai };