@ai-sdk/cohere 0.0.27 → 0.0.28

package/dist/index.mjs

@@ -1,6 +1,5 @@
 // src/cohere-provider.ts
 import {
-  generateId,
   loadApiKey,
   withoutTrailingSlash
 } from "@ai-sdk/provider-utils";
@@ -11,8 +10,8 @@ import {
 } from "@ai-sdk/provider";
 import {
   combineHeaders,
+  createEventSourceResponseHandler,
   createJsonResponseHandler,
-  createJsonStreamResponseHandler,
   postJsonToApi
 } from "@ai-sdk/provider-utils";
 import { z as z2 } from "zod";
@@ -37,13 +36,13 @@ function convertToCohereChatPrompt(prompt) {
   for (const { role, content } of prompt) {
     switch (role) {
       case "system": {
-        messages.push({ role: "SYSTEM", message: content });
+        messages.push({ role: "system", content });
         break;
       }
       case "user": {
         messages.push({
-          role: "USER",
-          message: content.map((part) => {
+          role: "user",
+          content: content.map((part) => {
             switch (part.type) {
               case "text": {
                 return part.text;
@@ -69,8 +68,12 @@ function convertToCohereChatPrompt(prompt) {
             }
             case "tool-call": {
               toolCalls.push({
-                name: part.toolName,
-                parameters: part.args
+                id: part.toolCallId,
+                type: "function",
+                function: {
+                  name: part.toolName,
+                  arguments: JSON.stringify(part.args)
+                }
               });
               break;
             }
@@ -81,31 +84,23 @@ function convertToCohereChatPrompt(prompt) {
           }
         }
         messages.push({
-          role: "CHATBOT",
-          message: text,
+          role: "assistant",
+          // note: this is a workaround for a Cohere API bug
+          // that requires content to be provided
+          // even if there are tool calls
+          content: text !== "" ? text : "call tool",
           tool_calls: toolCalls.length > 0 ? toolCalls : void 0
         });
         break;
       }
       case "tool": {
-        messages.push({
-          role: "TOOL",
-          tool_results: content.map((toolResult) => ({
-            call: {
-              name: toolResult.toolName,
-              /* 
-                            Note: Currently the tool_results field requires we pass the parameters of the tool results again. It it is blank for two reasons:
-              
-                            1. The parameters are already present in chat_history as a tool message
-                            2. The tool core message of the ai sdk does not include parameters
-                            
-                            It is possible to traverse through the chat history and get the parameters by id but it's currently empty since there wasn't any degradation in the output when left blank.
-                            */
-              parameters: {}
-            },
-            outputs: [toolResult.result]
+        messages.push(
+          ...content.map((toolResult) => ({
+            role: "tool",
+            content: JSON.stringify(toolResult.result),
+            tool_call_id: toolResult.toolCallId
           }))
-        });
+        );
         break;
       }
       default: {
@@ -146,77 +141,38 @@ function prepareTools(mode) {
   const tools = ((_a = mode.tools) == null ? void 0 : _a.length) ? mode.tools : void 0;
   const toolWarnings = [];
   if (tools == null) {
-    return { tools: void 0, force_single_step: void 0, toolWarnings };
+    return { tools: void 0, tool_choice: void 0, toolWarnings };
   }
   const cohereTools = [];
   for (const tool of tools) {
     if (tool.type === "provider-defined") {
       toolWarnings.push({ type: "unsupported-tool", tool });
     } else {
-      const { properties, required } = tool.parameters;
-      const parameterDefinitions = {};
-      if (properties) {
-        for (const [key, value] of Object.entries(properties)) {
-          if (typeof value === "object" && value !== null) {
-            const { type: JSONType, description } = value;
-            let type2;
-            if (typeof JSONType === "string") {
-              switch (JSONType) {
-                case "string":
-                  type2 = "str";
-                  break;
-                case "number":
-                  type2 = "float";
-                  break;
-                case "integer":
-                  type2 = "int";
-                  break;
-                case "boolean":
-                  type2 = "bool";
-                  break;
-                default:
-                  throw new UnsupportedFunctionalityError2({
-                    functionality: `Unsupported tool parameter type: ${JSONType}`
-                  });
-              }
-            } else {
-              throw new UnsupportedFunctionalityError2({
-                functionality: `Unsupported tool parameter type: ${JSONType}`
-              });
-            }
-            parameterDefinitions[key] = {
-              required: required ? required.includes(key) : false,
-              type: type2,
-              description
-            };
-          }
-        }
-      }
       cohereTools.push({
-        name: tool.name,
-        description: tool.description,
-        parameterDefinitions
+        type: "function",
+        function: {
+          name: tool.name,
+          description: tool.description,
+          parameters: tool.parameters
+        }
       });
     }
   }
   const toolChoice = mode.toolChoice;
   if (toolChoice == null) {
-    return { tools: cohereTools, force_single_step: false, toolWarnings };
+    return { tools: cohereTools, tool_choice: void 0, toolWarnings };
   }
   const type = toolChoice.type;
   switch (type) {
     case "auto":
-      return { tools: cohereTools, force_single_step: false, toolWarnings };
-    case "required":
-      return { tools: cohereTools, force_single_step: true, toolWarnings };
+      return { tools: cohereTools, tool_choice: type, toolWarnings };
     case "none":
-      return { tools: void 0, force_single_step: false, toolWarnings };
+      return { tools: void 0, tool_choice: "any", toolWarnings };
+    case "required":
     case "tool":
-      return {
-        tools: cohereTools.filter((tool) => tool.name === toolChoice.toolName),
-        force_single_step: true,
-        toolWarnings
-      };
+      throw new UnsupportedFunctionalityError2({
+        functionality: `Unsupported tool choice type: ${type}`
+      });
     default: {
       const _exhaustiveCheck = type;
       throw new UnsupportedFunctionalityError2({
@@ -253,8 +209,6 @@ var CohereChatLanguageModel = class {
   }) {
     const type = mode.type;
     const chatPrompt = convertToCohereChatPrompt(prompt);
-    const lastMessage = chatPrompt.at(-1);
-    const history = chatPrompt.slice(0, -1);
     const baseArgs = {
       // model id:
       model: this.modelId,
@@ -272,17 +226,14 @@ var CohereChatLanguageModel = class {
       // response format:
       response_format: (responseFormat == null ? void 0 : responseFormat.type) === "json" ? { type: "json_object", schema: responseFormat.schema } : void 0,
       // messages:
-      chat_history: history,
-      ...(lastMessage == null ? void 0 : lastMessage.role) === "TOOL" ? { tool_results: lastMessage.tool_results } : {},
-      message: lastMessage ? lastMessage.role === "USER" ? lastMessage.message : void 0 : void 0
+      messages: chatPrompt
     };
     switch (type) {
       case "regular": {
-        const { tools, force_single_step, toolWarnings } = prepareTools(mode);
+        const { tools, tool_choice, toolWarnings } = prepareTools(mode);
         return {
           ...baseArgs,
           tools,
-          force_single_step,
           warnings: toolWarnings
         };
       }
@@ -298,13 +249,41 @@ var CohereChatLanguageModel = class {
       }
       default: {
         const _exhaustiveCheck = type;
-        throw new Error(`Unsupported type: ${_exhaustiveCheck}`);
+        throw new UnsupportedFunctionalityError3({
+          functionality: `Unsupported mode: ${_exhaustiveCheck}`
+        });
       }
     }
   }
+  concatenateMessageText(messages) {
+    return messages.filter(
+      (message) => "content" in message
+    ).map((message) => message.content).join("");
+  }
+  /*
+  Remove `additionalProperties` and `$schema` from the `parameters` object of each tool.
+  Though these are part of JSON schema, Cohere chokes if we include them in the request.
+  */
+  // TODO(shaper): Look at defining a type to simplify the params here and a couple of other places.
+  removeJsonSchemaExtras(tools) {
+    return tools.map((tool) => {
+      if (tool.type === "function" && tool.function.parameters && typeof tool.function.parameters === "object") {
+        const { additionalProperties, $schema, ...restParameters } = tool.function.parameters;
+        return {
+          ...tool,
+          function: {
+            ...tool.function,
+            parameters: restParameters
+          }
+        };
+      }
+      return tool;
+    });
+  }
   async doGenerate(options) {
-    var _a;
+    var _a, _b, _c, _d;
     const { warnings, ...args } = this.getArgs(options);
+    args.tools = args.tools && this.removeJsonSchemaExtras(args.tools);
     const { responseHeaders, value: response } = await postJsonToApi({
       url: `${this.config.baseURL}/chat`,
       headers: combineHeaders(this.config.headers(), options.headers),
@@ -316,30 +295,28 @@ var CohereChatLanguageModel = class {
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
     });
-    const { chat_history, message, ...rawSettings } = args;
-    const generateId2 = this.config.generateId;
+    const { messages, ...rawSettings } = args;
     return {
-      text: response.text,
-      toolCalls: response.tool_calls ? response.tool_calls.map((toolCall) => ({
-        toolCallId: generateId2(),
-        toolName: toolCall.name,
-        args: JSON.stringify(toolCall.parameters),
+      text: (_c = (_b = (_a = response.message.content) == null ? void 0 : _a[0]) == null ? void 0 : _b.text) != null ? _c : "",
+      toolCalls: response.message.tool_calls ? response.message.tool_calls.map((toolCall) => ({
+        toolCallId: toolCall.id,
+        toolName: toolCall.function.name,
+        args: toolCall.function.arguments,
         toolCallType: "function"
       })) : [],
       finishReason: mapCohereFinishReason(response.finish_reason),
       usage: {
-        promptTokens: response.meta.tokens.input_tokens,
-        completionTokens: response.meta.tokens.output_tokens
+        promptTokens: response.usage.tokens.input_tokens,
+        completionTokens: response.usage.tokens.output_tokens
       },
       rawCall: {
         rawPrompt: {
-          chat_history,
-          message
+          messages
         },
         rawSettings
       },
       response: {
-        id: (_a = response.generation_id) != null ? _a : void 0
+        id: (_d = response.generation_id) != null ? _d : void 0
       },
       rawResponse: { headers: responseHeaders },
       warnings,
@@ -348,26 +325,30 @@ var CohereChatLanguageModel = class {
   }
   async doStream(options) {
     const { warnings, ...args } = this.getArgs(options);
+    args.tools = args.tools && this.removeJsonSchemaExtras(args.tools);
     const body = { ...args, stream: true };
     const { responseHeaders, value: response } = await postJsonToApi({
       url: `${this.config.baseURL}/chat`,
       headers: combineHeaders(this.config.headers(), options.headers),
       body,
       failedResponseHandler: cohereFailedResponseHandler,
-      successfulResponseHandler: createJsonStreamResponseHandler(
+      successfulResponseHandler: createEventSourceResponseHandler(
         cohereChatChunkSchema
       ),
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
     });
-    const { chat_history, message, ...rawSettings } = args;
+    const { messages, ...rawSettings } = args;
     let finishReason = "unknown";
     let usage = {
       promptTokens: Number.NaN,
       completionTokens: Number.NaN
     };
-    const generateId2 = this.config.generateId;
-    const toolCalls = [];
+    let pendingToolCallDelta = {
+      toolCallId: "",
+      toolName: "",
+      argsTextDelta: ""
+    };
     return {
       stream: response.pipeThrough(
         new TransformStream({
@@ -379,69 +360,68 @@ var CohereChatLanguageModel = class {
               return;
             }
             const value = chunk.value;
-            const type = value.event_type;
+            const type = value.type;
             switch (type) {
-              case "text-generation": {
+              case "content-delta": {
                 controller.enqueue({
                   type: "text-delta",
-                  textDelta: value.text
+                  textDelta: value.delta.message.content.text
                 });
                 return;
               }
-              case "tool-calls-chunk": {
-                if (value.tool_call_delta) {
-                  const { index } = value.tool_call_delta;
-                  if (toolCalls[index] === void 0) {
-                    const toolCallId = generateId2();
-                    toolCalls[index] = {
-                      toolCallId,
-                      toolName: ""
-                    };
-                  }
-                  if (value.tool_call_delta.name) {
-                    toolCalls[index].toolName = value.tool_call_delta.name;
-                    controller.enqueue({
-                      type: "tool-call-delta",
-                      toolCallType: "function",
-                      toolCallId: toolCalls[index].toolCallId,
-                      toolName: toolCalls[index].toolName,
-                      argsTextDelta: ""
-                    });
-                  } else if (value.tool_call_delta.parameters) {
-                    controller.enqueue({
-                      type: "tool-call-delta",
-                      toolCallType: "function",
-                      toolCallId: toolCalls[index].toolCallId,
-                      toolName: toolCalls[index].toolName,
-                      argsTextDelta: value.tool_call_delta.parameters
-                    });
-                  }
-                }
+              case "tool-call-start": {
+                pendingToolCallDelta = {
+                  toolCallId: value.delta.message.tool_calls.id,
+                  toolName: value.delta.message.tool_calls.function.name,
+                  argsTextDelta: value.delta.message.tool_calls.function.arguments
+                };
+                controller.enqueue({
+                  type: "tool-call-delta",
+                  toolCallId: pendingToolCallDelta.toolCallId,
+                  toolName: pendingToolCallDelta.toolName,
+                  toolCallType: "function",
+                  argsTextDelta: pendingToolCallDelta.argsTextDelta
+                });
                 return;
               }
-              case "tool-calls-generation": {
-                for (let index = 0; index < value.tool_calls.length; index++) {
-                  const toolCall = value.tool_calls[index];
-                  controller.enqueue({
-                    type: "tool-call",
-                    toolCallId: toolCalls[index].toolCallId,
-                    toolName: toolCalls[index].toolName,
-                    toolCallType: "function",
-                    args: JSON.stringify(toolCall.parameters)
-                  });
-                }
+              case "tool-call-delta": {
+                pendingToolCallDelta.argsTextDelta += value.delta.message.tool_calls.function.arguments;
+                controller.enqueue({
+                  type: "tool-call-delta",
+                  toolCallId: pendingToolCallDelta.toolCallId,
+                  toolName: pendingToolCallDelta.toolName,
+                  toolCallType: "function",
+                  argsTextDelta: value.delta.message.tool_calls.function.arguments
+                });
                 return;
               }
-              case "stream-start": {
+              case "tool-call-end": {
+                controller.enqueue({
+                  type: "tool-call",
+                  toolCallId: pendingToolCallDelta.toolCallId,
+                  toolName: pendingToolCallDelta.toolName,
+                  toolCallType: "function",
+                  args: JSON.stringify(
+                    JSON.parse(pendingToolCallDelta.argsTextDelta)
+                  )
+                });
+                pendingToolCallDelta = {
+                  toolCallId: "",
+                  toolName: "",
+                  argsTextDelta: ""
+                };
+                return;
+              }
+              case "message-start": {
                 controller.enqueue({
                   type: "response-metadata",
-                  id: (_a = value.generation_id) != null ? _a : void 0
+                  id: (_a = value.id) != null ? _a : void 0
                 });
                 return;
               }
-              case "stream-end": {
-                finishReason = mapCohereFinishReason(value.finish_reason);
-                const tokens = value.response.meta.tokens;
+              case "message-end": {
+                finishReason = mapCohereFinishReason(value.delta.finish_reason);
+                const tokens = value.delta.usage.tokens;
                 usage = {
                   promptTokens: tokens.input_tokens,
                   completionTokens: tokens.output_tokens
@@ -463,8 +443,7 @@ var CohereChatLanguageModel = class {
       ),
       rawCall: {
         rawPrompt: {
-          chat_history,
-          message
+          messages
         },
         rawSettings
       },
@@ -476,68 +455,117 @@ var CohereChatLanguageModel = class {
 };
 var cohereChatResponseSchema = z2.object({
   generation_id: z2.string().nullish(),
-  text: z2.string(),
-  tool_calls: z2.array(
-    z2.object({
-      name: z2.string(),
-      parameters: z2.unknown({})
-    })
-  ).nullish(),
+  message: z2.object({
+    role: z2.string(),
+    content: z2.array(
+      z2.object({
+        type: z2.string(),
+        text: z2.string()
+      })
+    ).nullish(),
+    tool_calls: z2.array(
+      z2.object({
+        id: z2.string(),
+        type: z2.literal("function"),
+        function: z2.object({
+          name: z2.string(),
+          arguments: z2.string()
+        })
+      })
+    ).nullish()
+  }),
   finish_reason: z2.string(),
-  meta: z2.object({
+  usage: z2.object({
+    billed_units: z2.object({
+      input_tokens: z2.number(),
+      output_tokens: z2.number()
+    }),
     tokens: z2.object({
       input_tokens: z2.number(),
       output_tokens: z2.number()
     })
   })
 });
-var cohereChatChunkSchema = z2.discriminatedUnion("event_type", [
-  z2.object({
-    event_type: z2.literal("stream-start"),
-    generation_id: z2.string().nullish()
-  }),
+var cohereChatChunkSchema = z2.discriminatedUnion("type", [
   z2.object({
-    event_type: z2.literal("search-queries-generation")
+    type: z2.literal("citation-start")
   }),
   z2.object({
-    event_type: z2.literal("search-results")
+    type: z2.literal("citation-end")
   }),
   z2.object({
-    event_type: z2.literal("text-generation"),
-    text: z2.string()
+    type: z2.literal("content-start")
   }),
   z2.object({
-    event_type: z2.literal("citation-generation")
+    type: z2.literal("content-delta"),
+    delta: z2.object({
+      message: z2.object({
+        content: z2.object({
+          text: z2.string()
+        })
+      })
+    })
   }),
   z2.object({
-    event_type: z2.literal("tool-calls-generation"),
-    tool_calls: z2.array(
-      z2.object({
-        name: z2.string(),
-        parameters: z2.unknown({})
-      })
-    )
+    type: z2.literal("content-end")
   }),
   z2.object({
-    event_type: z2.literal("tool-calls-chunk"),
-    text: z2.string().optional(),
-    tool_call_delta: z2.object({
-      index: z2.number(),
-      name: z2.string().optional(),
-      parameters: z2.string().optional()
-    }).optional()
+    type: z2.literal("message-start"),
+    id: z2.string().nullish()
   }),
   z2.object({
-    event_type: z2.literal("stream-end"),
-    finish_reason: z2.string(),
-    response: z2.object({
-      meta: z2.object({
+    type: z2.literal("message-end"),
+    delta: z2.object({
+      finish_reason: z2.string(),
+      usage: z2.object({
         tokens: z2.object({
           input_tokens: z2.number(),
           output_tokens: z2.number()
         })
       })
     })
+  }),
+  // https://docs.cohere.com/v2/docs/streaming#tool-use-stream-events-for-tool-calling
+  z2.object({
+    type: z2.literal("tool-plan-delta"),
+    delta: z2.object({
+      message: z2.object({
+        tool_plan: z2.string()
+      })
+    })
+  }),
+  z2.object({
+    type: z2.literal("tool-call-start"),
+    delta: z2.object({
+      message: z2.object({
+        tool_calls: z2.object({
+          id: z2.string(),
+          type: z2.literal("function"),
+          function: z2.object({
+            name: z2.string(),
+            arguments: z2.string()
+          })
+        })
+      })
+    })
+  }),
+  // A single tool call's `arguments` stream in chunks and must be accumulated
+  // in a string and so the full tool object info can only be parsed once we see
+  // `tool-call-end`.
+  z2.object({
+    type: z2.literal("tool-call-delta"),
+    delta: z2.object({
+      message: z2.object({
+        tool_calls: z2.object({
+          function: z2.object({
+            arguments: z2.string()
+          })
+        })
+      })
+    })
+  }),
+  z2.object({
+    type: z2.literal("tool-call-end")
   })
 ]);
 
@@ -582,6 +610,11 @@ var CohereEmbeddingModel = class {
       headers: combineHeaders2(this.config.headers(), headers),
       body: {
         model: this.modelId,
+        // TODO(shaper): There are other embedding types. Do we need to support them?
+        // For now we only support 'float' embeddings which are also the only ones
+        // the Cohere API docs state are supported for all models.
+        // https://docs.cohere.com/v2/reference/embed#request.body.embedding_types
+        embedding_types: ["float"],
         texts: values,
         input_type: (_a = this.settings.inputType) != null ? _a : "search_query",
         truncate: this.settings.truncate
@@ -594,14 +627,16 @@ var CohereEmbeddingModel = class {
       fetch: this.config.fetch
     });
     return {
-      embeddings: response.embeddings,
+      embeddings: response.embeddings.float,
       usage: { tokens: response.meta.billed_units.input_tokens },
       rawResponse: { headers: responseHeaders }
     };
   }
 };
 var cohereTextEmbeddingResponseSchema = z3.object({
-  embeddings: z3.array(z3.array(z3.number())),
+  embeddings: z3.object({
+    float: z3.array(z3.array(z3.number()))
+  }),
   meta: z3.object({
     billed_units: z3.object({
       input_tokens: z3.number()
@@ -612,7 +647,7 @@ var cohereTextEmbeddingResponseSchema = z3.object({
 // src/cohere-provider.ts
 function createCohere(options = {}) {
   var _a;
-  const baseURL = (_a = withoutTrailingSlash(options.baseURL)) != null ? _a : "https://api.cohere.com/v1";
+  const baseURL = (_a = withoutTrailingSlash(options.baseURL)) != null ? _a : "https://api.cohere.com/v2";
   const getHeaders = () => ({
     Authorization: `Bearer ${loadApiKey({
       apiKey: options.apiKey,
@@ -621,16 +656,12 @@ function createCohere(options = {}) {
     })}`,
     ...options.headers
   });
-  const createChatModel = (modelId, settings = {}) => {
-    var _a2;
-    return new CohereChatLanguageModel(modelId, settings, {
-      provider: "cohere.chat",
-      baseURL,
-      headers: getHeaders,
-      generateId: (_a2 = options.generateId) != null ? _a2 : generateId,
-      fetch: options.fetch
-    });
-  };
+  const createChatModel = (modelId, settings = {}) => new CohereChatLanguageModel(modelId, settings, {
+    provider: "cohere.chat",
+    baseURL,
+    headers: getHeaders,
+    fetch: options.fetch
+  });
   const createTextEmbeddingModel = (modelId, settings = {}) => new CohereEmbeddingModel(modelId, settings, {
     provider: "cohere.textEmbedding",
     baseURL,