@ai-sdk/openai-compatible 1.0.0-canary.1 → 1.0.0-canary.11

package/CHANGELOG.md

@@ -1,5 +1,122 @@
 # @ai-sdk/openai-compatible
 
+## 1.0.0-canary.11
+
+### Patch Changes
+
+- db72adc: chore(providers/openai): update completion model to use providerOptions
+- 42e32b0: feat(providers/xai): add reasoningEffort provider option
+- 66962ed: fix(packages): export node10 compatible types
+- 9301f86: refactor (image-model): rename `ImageModelV1` to `ImageModelV2`
+- Updated dependencies [66962ed]
+- Updated dependencies [9301f86]
+- Updated dependencies [a3f768e]
+  - @ai-sdk/provider-utils@3.0.0-canary.11
+  - @ai-sdk/provider@2.0.0-canary.10
+
+## 1.0.0-canary.10
+
+### Patch Changes
+
+- cf8280e: fix(providers/xai): return actual usage when streaming instead of NaN
+- Updated dependencies [e86be6f]
+  - @ai-sdk/provider@2.0.0-canary.9
+  - @ai-sdk/provider-utils@3.0.0-canary.10
+
+## 1.0.0-canary.9
+
+### Patch Changes
+
+- Updated dependencies [95857aa]
+- Updated dependencies [7ea4132]
+  - @ai-sdk/provider@2.0.0-canary.8
+  - @ai-sdk/provider-utils@3.0.0-canary.9
+
+## 1.0.0-canary.8
+
+### Patch Changes
+
+- b9a6121: fix (provider/openai-compatible): change tool_call type schema to nullish
+- Updated dependencies [5d142ab]
+- Updated dependencies [b6b43c7]
+- Updated dependencies [8aa9e20]
+- Updated dependencies [3795467]
+  - @ai-sdk/provider-utils@3.0.0-canary.8
+  - @ai-sdk/provider@2.0.0-canary.7
+
+## 1.0.0-canary.7
+
+### Patch Changes
+
+- fa49207: feat(providers/openai-compatible): convert to providerOptions
+- 26735b5: chore(embedding-model): add v2 interface
+- 443d8ec: feat(embedding-model-v2): add response body field
+- fd65bc6: chore(embedding-model-v2): rename rawResponse to response
+- Updated dependencies [26735b5]
+- Updated dependencies [443d8ec]
+- Updated dependencies [14c9410]
+- Updated dependencies [d9c98f4]
+- Updated dependencies [c4a2fec]
+- Updated dependencies [0054544]
+- Updated dependencies [9e9c809]
+- Updated dependencies [32831c6]
+- Updated dependencies [d0f9495]
+- Updated dependencies [fd65bc6]
+- Updated dependencies [393138b]
+- Updated dependencies [7182d14]
+  - @ai-sdk/provider@2.0.0-canary.6
+  - @ai-sdk/provider-utils@3.0.0-canary.7
+
+## 1.0.0-canary.6
+
+### Patch Changes
+
+- 6db02c9: chore(openai-compatible): remove simulateStreaming
+- Updated dependencies [411e483]
+- Updated dependencies [79457bd]
+- Updated dependencies [ad80501]
+- Updated dependencies [1766ede]
+- Updated dependencies [f10304b]
+  - @ai-sdk/provider@2.0.0-canary.5
+  - @ai-sdk/provider-utils@3.0.0-canary.6
+
+## 1.0.0-canary.5
+
+### Patch Changes
+
+- Updated dependencies [6f6bb89]
+  - @ai-sdk/provider@2.0.0-canary.4
+  - @ai-sdk/provider-utils@3.0.0-canary.5
+
+## 1.0.0-canary.4
+
+### Patch Changes
+
+- Updated dependencies [d1a1aa1]
+  - @ai-sdk/provider@2.0.0-canary.3
+  - @ai-sdk/provider-utils@3.0.0-canary.4
+
+## 1.0.0-canary.3
+
+### Patch Changes
+
+- Updated dependencies [a166433]
+- Updated dependencies [abf9a79]
+- Updated dependencies [9f95b35]
+- Updated dependencies [0a87932]
+- Updated dependencies [6dc848c]
+  - @ai-sdk/provider-utils@3.0.0-canary.3
+  - @ai-sdk/provider@2.0.0-canary.2
+
+## 1.0.0-canary.2
+
+### Patch Changes
+
+- Updated dependencies [c57e248]
+- Updated dependencies [33f4a6a]
+  - @ai-sdk/provider@2.0.0-canary.1
+  - @ai-sdk/provider-utils@3.0.0-canary.2
+
 ## 1.0.0-canary.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,22 +1,26 @@
-import { LanguageModelV2ProviderMetadata, LanguageModelV2, LanguageModelV2ObjectGenerationMode, EmbeddingModelV1, ImageModelV1, ProviderV2 } from '@ai-sdk/provider';
+import { SharedV2ProviderMetadata, LanguageModelV2, EmbeddingModelV2, ImageModelV2, ProviderV2 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z, ZodSchema } from 'zod';
 
 type OpenAICompatibleChatModelId = string;
-interface OpenAICompatibleChatSettings {
+declare const openaiCompatibleProviderOptions: z.ZodObject<{
     /**
-  A unique identifier representing your end-user, which can help the provider to
-  monitor and detect abuse.
-    */
-    user?: string;
+     * A unique identifier representing your end-user, which can help the provider to
+     * monitor and detect abuse.
+     */
+    user: z.ZodOptional<z.ZodString>;
     /**
-  Simulates streaming by using a normal generate call and returning it as a stream.
-  Enable this if the model that you are using does not support streaming.
-  
-  Defaults to `false`.
+     * Reasoning effort for reasoning models. Defaults to `medium`.
      */
-    simulateStreaming?: boolean;
-}
+    reasoningEffort: z.ZodOptional<z.ZodEnum<["low", "medium", "high"]>>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | undefined;
+    reasoningEffort?: "low" | "medium" | "high" | undefined;
+}, {
+    user?: string | undefined;
+    reasoningEffort?: "low" | "medium" | "high" | undefined;
+}>;
+type OpenAICompatibleProviderOptions = z.infer<typeof openaiCompatibleProviderOptions>;
 
 declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
     error: z.ZodObject<{
@@ -73,7 +77,7 @@ type MetadataExtractor = {
      */
     extractMetadata: ({ parsedBody, }: {
         parsedBody: unknown;
-    }) => LanguageModelV2ProviderMetadata | undefined;
+    }) => Promise<SharedV2ProviderMetadata | undefined>;
     /**
      * Creates an extractor for handling streaming responses. The returned object provides
      * methods to process individual chunks and build the final metadata from the accumulated
@@ -96,7 +100,7 @@ type MetadataExtractor = {
          * @returns Provider-specific metadata or undefined if no metadata is available.
          *          The metadata should be under a key indicating the provider id.
          */
-        buildMetadata(): LanguageModelV2ProviderMetadata | undefined;
+        buildMetadata(): SharedV2ProviderMetadata | undefined;
     };
 };
 
@@ -108,70 +112,72 @@ type OpenAICompatibleChatConfig = {
         path: string;
     }) => string;
     fetch?: FetchFunction;
+    includeUsage?: boolean;
     errorStructure?: ProviderErrorStructure<any>;
     metadataExtractor?: MetadataExtractor;
     /**
-  Default object generation mode that should be used with this model when
-  no mode is specified. Should be the mode with the best results for this
-  model. `undefined` can be specified if object generation is not supported.
-    */
-    defaultObjectGenerationMode?: LanguageModelV2ObjectGenerationMode;
-    /**
      * Whether the model supports structured outputs.
      */
     supportsStructuredOutputs?: boolean;
+    /**
+     * The supported URLs for the model.
+     */
+    getSupportedUrls?: () => Promise<Record<string, RegExp[]>>;
 };
 declare class OpenAICompatibleChatLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
     readonly supportsStructuredOutputs: boolean;
     readonly modelId: OpenAICompatibleChatModelId;
-    readonly settings: OpenAICompatibleChatSettings;
     private readonly config;
     private readonly failedResponseHandler;
     private readonly chunkSchema;
-    constructor(modelId: OpenAICompatibleChatModelId, settings: OpenAICompatibleChatSettings, config: OpenAICompatibleChatConfig);
-    get defaultObjectGenerationMode(): 'json' | 'tool' | undefined;
+    constructor(modelId: OpenAICompatibleChatModelId, config: OpenAICompatibleChatConfig);
     get provider(): string;
     private get providerOptionsName();
+    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
     private getArgs;
     doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
     doStream(options: Parameters<LanguageModelV2['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
 }
 
 type OpenAICompatibleCompletionModelId = string;
-interface OpenAICompatibleCompletionSettings {
+declare const openaiCompatibleCompletionProviderOptions: z.ZodObject<{
     /**
-  Echo back the prompt in addition to the completion.
+     * Echo back the prompt in addition to the completion.
      */
-    echo?: boolean;
+    echo: z.ZodOptional<z.ZodBoolean>;
     /**
-  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.
      */
-    logitBias?: Record<number, number>;
+    logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     /**
-  The suffix that comes after a completion of inserted text.
+     * The suffix that comes after a completion of inserted text.
      */
-    suffix?: string;
+    suffix: z.ZodOptional<z.ZodString>;
     /**
-  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 providers to
+     * monitor and detect abuse.
      */
-    user?: string;
-}
+    user: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | undefined;
+    echo?: boolean | undefined;
+    logitBias?: Record<string, number> | undefined;
+    suffix?: string | undefined;
+}, {
+    user?: string | undefined;
+    echo?: boolean | undefined;
+    logitBias?: Record<string, number> | undefined;
+    suffix?: string | undefined;
+}>;
+type OpenAICompatibleCompletionProviderOptions = z.infer<typeof openaiCompatibleCompletionProviderOptions>;
 
 type OpenAICompatibleCompletionConfig = {
     provider: string;
+    includeUsage?: boolean;
     headers: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
@@ -179,36 +185,46 @@ type OpenAICompatibleCompletionConfig = {
     }) => string;
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
+    /**
+     * The supported URLs for the model.
+     */
+    getSupportedUrls?: () => Promise<Record<string, RegExp[]>>;
 };
 declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
-    readonly defaultObjectGenerationMode: undefined;
     readonly modelId: OpenAICompatibleCompletionModelId;
-    readonly settings: OpenAICompatibleCompletionSettings;
     private readonly config;
     private readonly failedResponseHandler;
     private readonly chunkSchema;
-    constructor(modelId: OpenAICompatibleCompletionModelId, settings: OpenAICompatibleCompletionSettings, config: OpenAICompatibleCompletionConfig);
+    constructor(modelId: OpenAICompatibleCompletionModelId, config: OpenAICompatibleCompletionConfig);
     get provider(): string;
     private get providerOptionsName();
+    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
     private getArgs;
     doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
     doStream(options: Parameters<LanguageModelV2['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
 }
 
 type OpenAICompatibleEmbeddingModelId = string;
-interface OpenAICompatibleEmbeddingSettings {
+declare const openaiCompatibleEmbeddingProviderOptions: z.ZodObject<{
     /**
-  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?: number;
+    dimensions: z.ZodOptional<z.ZodNumber>;
     /**
-  A unique identifier representing your end-user, which can help OpenAI to
-  monitor and detect abuse. Learn more.
-  */
-    user?: string;
-}
+     * A unique identifier representing your end-user, which can help providers to
+     * monitor and detect abuse.
+     */
+    user: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | undefined;
+    dimensions?: number | undefined;
+}, {
+    user?: string | undefined;
+    dimensions?: number | undefined;
+}>;
+type OpenAICompatibleEmbeddingProviderOptions = z.infer<typeof openaiCompatibleEmbeddingProviderOptions>;
 
 type OpenAICompatibleEmbeddingConfig = {
     /**
@@ -228,16 +244,16 @@ type OpenAICompatibleEmbeddingConfig = {
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
 };
-declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV1<string> {
-    readonly specificationVersion = "v1";
+declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV2<string> {
+    readonly specificationVersion = "v2";
     readonly modelId: OpenAICompatibleEmbeddingModelId;
     private readonly config;
-    private readonly settings;
     get provider(): string;
     get maxEmbeddingsPerCall(): number;
     get supportsParallelCalls(): boolean;
-    constructor(modelId: OpenAICompatibleEmbeddingModelId, settings: OpenAICompatibleEmbeddingSettings, config: OpenAICompatibleEmbeddingConfig);
-    doEmbed({ values, headers, abortSignal, }: Parameters<EmbeddingModelV1<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV1<string>['doEmbed']>>>;
+    constructor(modelId: OpenAICompatibleEmbeddingModelId, config: OpenAICompatibleEmbeddingConfig);
+    private get providerOptionsName();
+    doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV2<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV2<string>['doEmbed']>>>;
 }
 
 type OpenAICompatibleImageModelId = string;
@@ -266,7 +282,7 @@ type OpenAICompatibleImageModelConfig = {
         currentDate?: () => Date;
     };
 };
-declare class OpenAICompatibleImageModel implements ImageModelV1 {
+declare class OpenAICompatibleImageModel implements ImageModelV2 {
     readonly modelId: OpenAICompatibleImageModelId;
     private readonly settings;
     private readonly config;
@@ -274,16 +290,16 @@ declare class OpenAICompatibleImageModel implements ImageModelV1 {
     get maxImagesPerCall(): number;
     get provider(): string;
     constructor(modelId: OpenAICompatibleImageModelId, settings: OpenAICompatibleImageSettings, config: OpenAICompatibleImageModelConfig);
-    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, }: Parameters<ImageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV1['doGenerate']>>>;
+    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, }: Parameters<ImageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV2['doGenerate']>>>;
 }
 
 interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string, IMAGE_MODEL_IDS extends string = string> extends Omit<ProviderV2, 'imageModel'> {
-    (modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV2;
-    languageModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV2;
-    chatModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV2;
-    completionModel(modelId: COMPLETION_MODEL_IDS, settings?: OpenAICompatibleCompletionSettings): LanguageModelV2;
-    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS, settings?: OpenAICompatibleEmbeddingSettings): EmbeddingModelV1<string>;
-    imageModel(modelId: IMAGE_MODEL_IDS, settings?: OpenAICompatibleImageSettings): ImageModelV1;
+    (modelId: CHAT_MODEL_IDS): LanguageModelV2;
+    languageModel(modelId: CHAT_MODEL_IDS): LanguageModelV2;
+    chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV2;
+    completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV2;
+    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV2<string>;
+    imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV2;
 }
 interface OpenAICompatibleProviderSettings {
     /**
@@ -320,4 +336,4 @@ Create an OpenAICompatible provider instance.
  */
 declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string, IMAGE_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS, IMAGE_MODEL_IDS>;
 
-export { type MetadataExtractor, OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatSettings, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionSettings, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingSettings, type OpenAICompatibleErrorData, OpenAICompatibleImageModel, type OpenAICompatibleImageSettings, type OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };
+export { type MetadataExtractor, OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatModelId, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionModelId, type OpenAICompatibleCompletionProviderOptions, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingModelId, type OpenAICompatibleEmbeddingProviderOptions, type OpenAICompatibleErrorData, OpenAICompatibleImageModel, type OpenAICompatibleImageSettings, type OpenAICompatibleProvider, type OpenAICompatibleProviderOptions, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };