@ai-sdk/cohere 4.0.0-beta.3 → 4.0.0-beta.31

package/src/cohere-embedding-model.ts

@@ -1,30 +1,33 @@
 import {
-  EmbeddingModelV3,
   TooManyEmbeddingValuesForCallError,
+  type EmbeddingModelV4,
 } from '@ai-sdk/provider';
 import {
   combineHeaders,
   createJsonResponseHandler,
-  FetchFunction,
   parseProviderOptions,
   postJsonToApi,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE,
+  type FetchFunction,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 import {
-  CohereEmbeddingModelId,
   cohereEmbeddingModelOptions,
+  type CohereEmbeddingModelId,
 } from './cohere-embedding-options';
 import { cohereFailedResponseHandler } from './cohere-error';
 
 type CohereEmbeddingConfig = {
   provider: string;
   baseURL: string;
-  headers: () => Record<string, string | undefined>;
+  headers?: () => Record<string, string | undefined>;
   fetch?: FetchFunction;
 };
 
-export class CohereEmbeddingModel implements EmbeddingModelV3 {
-  readonly specificationVersion = 'v3';
+export class CohereEmbeddingModel implements EmbeddingModelV4 {
+  readonly specificationVersion = 'v4';
   readonly modelId: CohereEmbeddingModelId;
 
   readonly maxEmbeddingsPerCall = 96;
@@ -32,6 +35,20 @@ export class CohereEmbeddingModel implements EmbeddingModelV3 {
 
   private readonly config: CohereEmbeddingConfig;
 
+  static [WORKFLOW_SERIALIZE](model: CohereEmbeddingModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: CohereEmbeddingModelId;
+    config: CohereEmbeddingConfig;
+  }) {
+    return new CohereEmbeddingModel(options.modelId, options.config);
+  }
+
   constructor(modelId: CohereEmbeddingModelId, config: CohereEmbeddingConfig) {
     this.modelId = modelId;
     this.config = config;
@@ -46,8 +63,8 @@ export class CohereEmbeddingModel implements EmbeddingModelV3 {
     headers,
     abortSignal,
     providerOptions,
-  }: Parameters<EmbeddingModelV3['doEmbed']>[0]): Promise<
-    Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>
+  }: Parameters<EmbeddingModelV4['doEmbed']>[0]): Promise<
+    Awaited<ReturnType<EmbeddingModelV4['doEmbed']>>
   > {
     const embeddingOptions = await parseProviderOptions({
       provider: 'cohere',
@@ -70,7 +87,7 @@ export class CohereEmbeddingModel implements EmbeddingModelV3 {
       rawValue,
     } = await postJsonToApi({
       url: `${this.config.baseURL}/embed`,
-      headers: combineHeaders(this.config.headers(), headers),
+      headers: combineHeaders(this.config.headers?.(), headers),
       body: {
         model: this.modelId,
         // The AI SDK only supports 'float' embeddings. Note that the Cohere API

package/src/cohere-prepare-tools.ts

@@ -1,16 +1,16 @@
 import {
-  LanguageModelV3CallOptions,
-  SharedV3Warning,
   UnsupportedFunctionalityError,
+  type LanguageModelV4CallOptions,
+  type SharedV4Warning,
 } from '@ai-sdk/provider';
-import { CohereToolChoice } from './cohere-chat-prompt';
+import type { CohereToolChoice } from './cohere-chat-prompt';
 
 export function prepareTools({
   tools,
   toolChoice,
 }: {
-  tools: LanguageModelV3CallOptions['tools'];
-  toolChoice?: LanguageModelV3CallOptions['toolChoice'];
+  tools: LanguageModelV4CallOptions['tools'];
+  toolChoice?: LanguageModelV4CallOptions['toolChoice'];
 }): {
   tools:
     | Array<{
@@ -23,12 +23,12 @@ export function prepareTools({
       }>
     | undefined;
   toolChoice: CohereToolChoice;
-  toolWarnings: SharedV3Warning[];
+  toolWarnings: SharedV4Warning[];
 } {
   // when the tools array is empty, change it to undefined to prevent errors:
   tools = tools?.length ? tools : undefined;
 
-  const toolWarnings: SharedV3Warning[] = [];
+  const toolWarnings: SharedV4Warning[] = [];
 
   if (tools == null) {
     return { tools: undefined, toolChoice: undefined, toolWarnings };

package/src/cohere-provider.ts

@@ -1,63 +1,62 @@
 import {
-  EmbeddingModelV3,
-  LanguageModelV3,
   NoSuchModelError,
-  RerankingModelV3,
-  ProviderV3,
+  type EmbeddingModelV4,
+  type LanguageModelV4,
+  type RerankingModelV4,
+  type ProviderV4,
 } from '@ai-sdk/provider';
-
 import {
-  FetchFunction,
   generateId,
   loadApiKey,
   withoutTrailingSlash,
   withUserAgentSuffix,
+  type FetchFunction,
 } from '@ai-sdk/provider-utils';
 import { CohereChatLanguageModel } from './cohere-chat-language-model';
-import { CohereChatModelId } from './cohere-chat-options';
+import type { CohereChatModelId } from './cohere-chat-options';
 import { CohereEmbeddingModel } from './cohere-embedding-model';
-import { CohereRerankingModelId } from './reranking/cohere-reranking-options';
+import type { CohereRerankingModelId } from './reranking/cohere-reranking-options';
 import { CohereRerankingModel } from './reranking/cohere-reranking-model';
-import { CohereEmbeddingModelId } from './cohere-embedding-options';
+import type { CohereEmbeddingModelId } from './cohere-embedding-options';
 import { VERSION } from './version';
 
-export interface CohereProvider extends ProviderV3 {
-  (modelId: CohereChatModelId): LanguageModelV3;
+export interface CohereProvider extends ProviderV4 {
+  (modelId: CohereChatModelId): LanguageModelV4;
 
   /**
    * Creates a model for text generation.
    */
-  languageModel(modelId: CohereChatModelId): LanguageModelV3;
+  languageModel(modelId: CohereChatModelId): LanguageModelV4;
 
   /**
    * Creates a model for text embeddings.
    */
-  embedding(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
+  embedding(modelId: CohereEmbeddingModelId): EmbeddingModelV4;
 
   /**
    * Creates a model for text embeddings.
    */
-  embeddingModel(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
+  embeddingModel(modelId: CohereEmbeddingModelId): EmbeddingModelV4;
 
   /**
    * @deprecated Use `embedding` instead.
    */
-  textEmbedding(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
+  textEmbedding(modelId: CohereEmbeddingModelId): EmbeddingModelV4;
 
   /**
    * @deprecated Use `embeddingModel` instead.
    */
-  textEmbeddingModel(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
+  textEmbeddingModel(modelId: CohereEmbeddingModelId): EmbeddingModelV4;
 
   /**
    * Creates a model for reranking.
    */
-  reranking(modelId: CohereRerankingModelId): RerankingModelV3;
+  reranking(modelId: CohereRerankingModelId): RerankingModelV4;
 
   /**
    * Creates a model for reranking.
    */
-  rerankingModel(modelId: CohereRerankingModelId): RerankingModelV3;
+  rerankingModel(modelId: CohereRerankingModelId): RerankingModelV4;
 }
 
 export interface CohereProviderSettings {
@@ -147,7 +146,7 @@ export function createCohere(
     return createChatModel(modelId);
   };
 
-  provider.specificationVersion = 'v3' as const;
+  provider.specificationVersion = 'v4' as const;
   provider.languageModel = createChatModel;
   provider.embedding = createEmbeddingModel;
   provider.embeddingModel = createEmbeddingModel;

package/src/convert-cohere-usage.ts

@@ -1,4 +1,4 @@
-import { LanguageModelV3Usage } from '@ai-sdk/provider';
+import type { LanguageModelV4Usage } from '@ai-sdk/provider';
 
 export type CohereUsageTokens = {
   input_tokens: number;
@@ -7,7 +7,7 @@ export type CohereUsageTokens = {
 
 export function convertCohereUsage(
   tokens: CohereUsageTokens | undefined | null,
-): LanguageModelV3Usage {
+): LanguageModelV4Usage {
   if (tokens == null) {
     return {
       inputTokens: {

package/src/convert-to-cohere-chat-prompt.ts

@@ -1,20 +1,23 @@
 import {
-  SharedV3Warning,
-  LanguageModelV3Prompt,
   UnsupportedFunctionalityError,
+  type SharedV4Warning,
+  type LanguageModelV4Prompt,
 } from '@ai-sdk/provider';
-import { CohereAssistantMessage, CohereChatPrompt } from './cohere-chat-prompt';
+import type {
+  CohereAssistantMessage,
+  CohereChatPrompt,
+} from './cohere-chat-prompt';
 
-export function convertToCohereChatPrompt(prompt: LanguageModelV3Prompt): {
+export function convertToCohereChatPrompt(prompt: LanguageModelV4Prompt): {
   messages: CohereChatPrompt;
   documents: Array<{
     data: { text: string; title?: string };
   }>;
-  warnings: SharedV3Warning[];
+  warnings: SharedV4Warning[];
 } {
   const messages: CohereChatPrompt = [];
   const documents: Array<{ data: { text: string; title?: string } }> = [];
-  const warnings: SharedV3Warning[] = [];
+  const warnings: SharedV4Warning[] = [];
 
   for (const { role, content } of prompt) {
     switch (role) {
@@ -33,32 +36,32 @@ export function convertToCohereChatPrompt(prompt: LanguageModelV3Prompt): {
                   return part.text;
                 }
                 case 'file': {
-                  // Extract documents for RAG
                   let textContent: string;
 
-                  if (typeof part.data === 'string') {
-                    // Base64 or text data
-                    textContent = part.data;
-                  } else if (part.data instanceof Uint8Array) {
-                    // Check if the media type is supported for text extraction
-                    if (
-                      !(
-                        part.mediaType?.startsWith('text/') ||
-                        part.mediaType === 'application/json'
-                      )
-                    ) {
+                  switch (part.data.type) {
+                    case 'reference': {
                       throw new UnsupportedFunctionalityError({
-                        functionality: `document media type: ${part.mediaType}`,
-                        message: `Media type '${part.mediaType}' is not supported. Supported media types are: text/* and application/json.`,
+                        functionality: 'file parts with provider references',
                       });
                     }
-                    textContent = new TextDecoder().decode(part.data);
-                  } else {
-                    throw new UnsupportedFunctionalityError({
-                      functionality: 'File URL data',
-                      message:
-                        'URLs should be downloaded by the AI SDK and not reach this point. This indicates a configuration issue.',
-                    });
+                    case 'url': {
+                      throw new UnsupportedFunctionalityError({
+                        functionality: 'File URL data',
+                        message:
+                          'URLs should be downloaded by the AI SDK and not reach this point. This indicates a configuration issue.',
+                      });
+                    }
+                    case 'text': {
+                      textContent = part.data.text;
+                      break;
+                    }
+                    case 'data': {
+                      textContent =
+                        typeof part.data.data === 'string'
+                          ? part.data.data
+                          : new TextDecoder().decode(part.data.data);
+                      break;
+                    }
                   }
 
                   documents.push({
@@ -68,8 +71,6 @@ export function convertToCohereChatPrompt(prompt: LanguageModelV3Prompt): {
                     },
                   });
 
-                  // Files are handled separately via the documents parameter
-                  // Return empty string to not include file content in message text
                   return '';
                 }
               }
@@ -126,7 +127,7 @@ export function convertToCohereChatPrompt(prompt: LanguageModelV3Prompt): {
                   contentValue = output.value;
                   break;
                 case 'execution-denied':
-                  contentValue = output.reason ?? 'Tool execution denied.';
+                  contentValue = output.reason ?? 'Tool call execution denied.';
                   break;
                 case 'content':
                 case 'json':

package/src/map-cohere-finish-reason.ts

@@ -1,8 +1,8 @@
-import { LanguageModelV3FinishReason } from '@ai-sdk/provider';
+import type { LanguageModelV4FinishReason } from '@ai-sdk/provider';
 
 export function mapCohereFinishReason(
   finishReason: string | null | undefined,
-): LanguageModelV3FinishReason['unified'] {
+): LanguageModelV4FinishReason['unified'] {
   switch (finishReason) {
     case 'COMPLETE':
     case 'STOP_SEQUENCE':

package/src/reranking/cohere-reranking-model.ts

@@ -1,21 +1,20 @@
-import { RerankingModelV3, SharedV3Warning } from '@ai-sdk/provider';
+import type { RerankingModelV4, SharedV4Warning } from '@ai-sdk/provider';
 import {
   combineHeaders,
   createJsonResponseHandler,
-  FetchFunction,
   parseProviderOptions,
   postJsonToApi,
+  type FetchFunction,
 } from '@ai-sdk/provider-utils';
 import { cohereFailedResponseHandler } from '../cohere-error';
 import {
-  CohereRerankingInput,
   cohereRerankingResponseSchema,
+  type CohereRerankingInput,
 } from './cohere-reranking-api';
 import {
-  CohereRerankingModelId,
   cohereRerankingModelOptionsSchema,
+  type CohereRerankingModelId,
 } from './cohere-reranking-options';
-
 type CohereRerankingConfig = {
   provider: string;
   baseURL: string;
@@ -23,8 +22,8 @@ type CohereRerankingConfig = {
   fetch?: FetchFunction;
 };
 
-export class CohereRerankingModel implements RerankingModelV3 {
-  readonly specificationVersion = 'v3';
+export class CohereRerankingModel implements RerankingModelV4 {
+  readonly specificationVersion = 'v4';
   readonly modelId: CohereRerankingModelId;
 
   private readonly config: CohereRerankingConfig;
@@ -46,8 +45,8 @@ export class CohereRerankingModel implements RerankingModelV3 {
     topN,
     abortSignal,
     providerOptions,
-  }: Parameters<RerankingModelV3['doRerank']>[0]): Promise<
-    Awaited<ReturnType<RerankingModelV3['doRerank']>>
+  }: Parameters<RerankingModelV4['doRerank']>[0]): Promise<
+    Awaited<ReturnType<RerankingModelV4['doRerank']>>
   > {
     const rerankingOptions = await parseProviderOptions({
       provider: 'cohere',
@@ -55,7 +54,7 @@ export class CohereRerankingModel implements RerankingModelV3 {
       schema: cohereRerankingModelOptionsSchema,
     });
 
-    const warnings: SharedV3Warning[] = [];
+    const warnings: SharedV4Warning[] = [];
 
     if (documents.type === 'object') {
       warnings.push({

package/src/reranking/cohere-reranking-options.ts

@@ -1,4 +1,8 @@
-import { FlexibleSchema, lazySchema, zodSchema } from '@ai-sdk/provider-utils';
+import {
+  lazySchema,
+  zodSchema,
+  type FlexibleSchema,
+} from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 // https://docs.cohere.com/docs/rerank

package/dist/index.d.mts

@@ -1,117 +0,0 @@
-import { z } from 'zod/v4';
-import { ProviderV3, LanguageModelV3, EmbeddingModelV3, RerankingModelV3 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
-
-type CohereChatModelId = 'command-a-03-2025' | 'command-a-reasoning-08-2025' | 'command-r7b-12-2024' | 'command-r-plus-04-2024' | 'command-r-plus' | 'command-r-08-2024' | 'command-r-03-2024' | 'command-r' | 'command' | 'command-nightly' | 'command-light' | 'command-light-nightly' | (string & {});
-declare const cohereLanguageModelOptions: z.ZodObject<{
-    thinking: z.ZodOptional<z.ZodObject<{
-        type: z.ZodOptional<z.ZodEnum<{
-            enabled: "enabled";
-            disabled: "disabled";
-        }>>;
-        tokenBudget: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-type CohereLanguageModelOptions = z.infer<typeof cohereLanguageModelOptions>;
-
-type CohereRerankingModelId = 'rerank-v3.5' | 'rerank-english-v3.0' | 'rerank-multilingual-v3.0' | (string & {});
-type CohereRerankingModelOptions = {
-    /**
-     * Long documents will be automatically truncated to the specified number of tokens.
-     *
-     * @default 4096
-     */
-    maxTokensPerDoc?: number;
-    /**
-     * The priority of the request.
-     *
-     * @default 0
-     */
-    priority?: number;
-};
-
-type CohereEmbeddingModelId = 'embed-english-v3.0' | 'embed-multilingual-v3.0' | 'embed-english-light-v3.0' | 'embed-multilingual-light-v3.0' | 'embed-english-v2.0' | 'embed-english-light-v2.0' | 'embed-multilingual-v2.0' | (string & {});
-declare const cohereEmbeddingModelOptions: z.ZodObject<{
-    inputType: z.ZodOptional<z.ZodEnum<{
-        search_document: "search_document";
-        search_query: "search_query";
-        classification: "classification";
-        clustering: "clustering";
-    }>>;
-    truncate: z.ZodOptional<z.ZodEnum<{
-        NONE: "NONE";
-        START: "START";
-        END: "END";
-    }>>;
-    outputDimension: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<256>, z.ZodLiteral<512>, z.ZodLiteral<1024>, z.ZodLiteral<1536>]>>;
-}, z.core.$strip>;
-type CohereEmbeddingModelOptions = z.infer<typeof cohereEmbeddingModelOptions>;
-
-interface CohereProvider extends ProviderV3 {
-    (modelId: CohereChatModelId): LanguageModelV3;
-    /**
-     * Creates a model for text generation.
-     */
-    languageModel(modelId: CohereChatModelId): LanguageModelV3;
-    /**
-     * Creates a model for text embeddings.
-     */
-    embedding(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
-    /**
-     * Creates a model for text embeddings.
-     */
-    embeddingModel(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
-    /**
-     * @deprecated Use `embedding` instead.
-     */
-    textEmbedding(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
-    /**
-     * @deprecated Use `embeddingModel` instead.
-     */
-    textEmbeddingModel(modelId: CohereEmbeddingModelId): EmbeddingModelV3;
-    /**
-     * Creates a model for reranking.
-     */
-    reranking(modelId: CohereRerankingModelId): RerankingModelV3;
-    /**
-     * Creates a model for reranking.
-     */
-    rerankingModel(modelId: CohereRerankingModelId): RerankingModelV3;
-}
-interface CohereProviderSettings {
-    /**
-     * Use a different URL prefix for API calls, e.g. to use proxy servers.
-     * The default prefix is `https://api.cohere.com/v2`.
-     */
-    baseURL?: string;
-    /**
-     * API key that is being send using the `Authorization` header.
-     * It defaults to the `COHERE_API_KEY` environment variable.
-     */
-    apiKey?: string;
-    /**
-     * Custom headers to include in the requests.
-     */
-    headers?: Record<string, 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.
-     */
-    fetch?: FetchFunction;
-    /**
-     * Optional function to generate a unique ID for each request.
-     */
-    generateId?: () => string;
-}
-/**
- * Create a Cohere AI provider instance.
- */
-declare function createCohere(options?: CohereProviderSettings): CohereProvider;
-/**
- * Default Cohere provider instance.
- */
-declare const cohere: CohereProvider;
-
-declare const VERSION: string;
-
-export { type CohereLanguageModelOptions as CohereChatModelOptions, type CohereEmbeddingModelOptions, type CohereLanguageModelOptions, type CohereProvider, type CohereProviderSettings, type CohereRerankingModelOptions, type CohereRerankingModelOptions as CohereRerankingOptions, VERSION, cohere, createCohere };