ai 2.2.28 → 2.2.30

package/prompts/dist/index.d.ts

@@ -11,15 +11,27 @@ interface FunctionCall {
      */
     name?: string;
 }
+/**
+ * The tool calls generated by the model, such as function calls.
+ */
+interface ToolCall {
+    id: string;
+    type: string;
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
 /**
  * Shared types between the API and UI packages.
  */
 interface Message {
     id: string;
+    tool_call_id?: string;
     createdAt?: Date;
     content: string;
     ui?: string | JSX.Element | JSX.Element[] | null | undefined;
-    role: 'system' | 'user' | 'assistant' | 'function' | 'data';
+    role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.
      * Otherwise, the name field should not be set.
@@ -28,10 +40,15 @@ interface Message {
     /**
      * If the assistant role makes a function call, the `function_call` field
      * contains the function call name and arguments. Otherwise, the field should
-     * not be set.
+     * not be set. (Deprecated and replaced by tool_calls.)
      */
     function_call?: string | FunctionCall;
     data?: JSONValue;
+    /**
+     * If the assistant role makes a tool call, the `tool_calls` field contains
+     * the tool call name and arguments. Otherwise, the field should not be set.
+     */
+    tool_calls?: string | ToolCall[];
 }
 type JSONValue = null | string | number | boolean | {
     [x: string]: JSONValue;
@@ -63,4 +80,159 @@ declare function experimental_buildOpenAssistantPrompt(messages: Pick<Message, '
  */
 declare function experimental_buildLlama2Prompt(messages: Pick<Message, 'content' | 'role'>[]): string;
 
-export { experimental_buildAnthropicPrompt, experimental_buildLlama2Prompt, experimental_buildOpenAssistantPrompt, experimental_buildStarChatBetaPrompt };
+declare function experimental_buildOpenAIMessages(messages: Message[]): ChatCompletionMessageParam[];
+type ChatCompletionMessageParam = ChatCompletionSystemMessageParam | ChatCompletionUserMessageParam | ChatCompletionAssistantMessageParam | ChatCompletionToolMessageParam | ChatCompletionFunctionMessageParam;
+interface ChatCompletionSystemMessageParam {
+    /**
+     * The contents of the system message.
+     */
+    content: string | null;
+    /**
+     * The role of the messages author, in this case `system`.
+     */
+    role: 'system';
+}
+interface ChatCompletionUserMessageParam {
+    /**
+     * The contents of the user message.
+     */
+    content: string | Array<ChatCompletionContentPart> | null;
+    /**
+     * The role of the messages author, in this case `user`.
+     */
+    role: 'user';
+}
+type ChatCompletionContentPart = ChatCompletionContentPartText | ChatCompletionContentPartImage;
+interface ChatCompletionContentPartText {
+    /**
+     * The text content.
+     */
+    text: string;
+    /**
+     * The type of the content part.
+     */
+    type: 'text';
+}
+interface ChatCompletionContentPartImage {
+    image_url: ChatCompletionContentPartImage.ImageURL;
+    /**
+     * The type of the content part.
+     */
+    type: 'image_url';
+}
+declare namespace ChatCompletionContentPartImage {
+    interface ImageURL {
+        /**
+         * Specifies the detail level of the image.
+         */
+        detail?: 'auto' | 'low' | 'high';
+        /**
+         * Either a URL of the image or the base64 encoded image data.
+         */
+        url?: string;
+    }
+}
+interface ChatCompletionAssistantMessageParam {
+    /**
+     * The contents of the assistant message.
+     */
+    content: string | null;
+    /**
+     * The role of the messages author, in this case `assistant`.
+     */
+    role: 'assistant';
+    /**
+     * Deprecated and replaced by `tool_calls`. The name and arguments of a function
+     * that should be called, as generated by the model.
+     */
+    function_call?: ChatCompletionAssistantMessageParam.FunctionCall;
+    /**
+     * The tool calls generated by the model, such as function calls.
+     */
+    tool_calls?: Array<ChatCompletionMessageToolCall>;
+}
+declare namespace ChatCompletionAssistantMessageParam {
+    /**
+     * Deprecated and replaced by `tool_calls`. The name and arguments of a function
+     * that should be called, as generated by the model.
+     */
+    interface FunctionCall {
+        /**
+         * The arguments to call the function with, as generated by the model in JSON
+         * format. Note that the model does not always generate valid JSON, and may
+         * hallucinate parameters not defined by your function schema. Validate the
+         * arguments in your code before calling your function.
+         */
+        arguments: string;
+        /**
+         * The name of the function to call.
+         */
+        name: string;
+    }
+}
+interface ChatCompletionMessageToolCall {
+    /**
+     * The ID of the tool call.
+     */
+    id: string;
+    /**
+     * The function that the model called.
+     */
+    function: ChatCompletionMessageToolCall.Function;
+    /**
+     * The type of the tool. Currently, only `function` is supported.
+     */
+    type: 'function';
+}
+declare namespace ChatCompletionMessageToolCall {
+    /**
+     * The function that the model called.
+     */
+    interface Function {
+        /**
+         * The arguments to call the function with, as generated by the model in JSON
+         * format. Note that the model does not always generate valid JSON, and may
+         * hallucinate parameters not defined by your function schema. Validate the
+         * arguments in your code before calling your function.
+         */
+        arguments: string;
+        /**
+         * The name of the function to call.
+         */
+        name: string;
+    }
+}
+interface ChatCompletionToolMessageParam {
+    /**
+     * The contents of the tool message.
+     */
+    content: string | null;
+    /**
+     * The role of the messages author, in this case `tool`.
+     */
+    role: 'tool';
+    /**
+     * The name of the function that this message is responding to.
+     */
+    name: string;
+    /**
+     * Tool call that this message is responding to.
+     */
+    tool_call_id: string;
+}
+interface ChatCompletionFunctionMessageParam {
+    /**
+     * The return value from the function call, to return to the model.
+     */
+    content: string | null;
+    /**
+     * The name of the function to call.
+     */
+    name: string;
+    /**
+     * The role of the messages author, in this case `function`.
+     */
+    role: 'function';
+}
+
+export { ChatCompletionAssistantMessageParam, ChatCompletionContentPart, ChatCompletionContentPartImage, ChatCompletionContentPartText, ChatCompletionFunctionMessageParam, ChatCompletionMessageParam, ChatCompletionMessageToolCall, ChatCompletionSystemMessageParam, ChatCompletionToolMessageParam, ChatCompletionUserMessageParam, experimental_buildAnthropicPrompt, experimental_buildLlama2Prompt, experimental_buildOpenAIMessages, experimental_buildOpenAssistantPrompt, experimental_buildStarChatBetaPrompt };

package/prompts/dist/index.js

@@ -22,6 +22,7 @@ var prompts_exports = {};
 __export(prompts_exports, {
   experimental_buildAnthropicPrompt: () => experimental_buildAnthropicPrompt,
   experimental_buildLlama2Prompt: () => experimental_buildLlama2Prompt,
+  experimental_buildOpenAIMessages: () => experimental_buildOpenAIMessages,
   experimental_buildOpenAssistantPrompt: () => experimental_buildOpenAssistantPrompt,
   experimental_buildStarChatBetaPrompt: () => experimental_buildStarChatBetaPrompt
 });
@@ -97,10 +98,68 @@ ${content}
   });
   return startPrompt + conversation.join("") + endPrompt;
 }
+
+// prompts/openai.tsx
+function experimental_buildOpenAIMessages(messages) {
+  return messages.map((message) => {
+    switch (message.role) {
+      case "system":
+      case "user":
+        return {
+          role: message.role,
+          content: message.content
+        };
+      case "assistant": {
+        const function_call = message.function_call;
+        if (function_call !== void 0 && (typeof function_call === "string" || function_call.arguments === void 0 || function_call.name === void 0)) {
+          throw new Error(
+            "Invalid function call in message. Expected a function call object"
+          );
+        }
+        return {
+          role: message.role,
+          content: message.content,
+          function_call: function_call === void 0 ? void 0 : {
+            name: function_call.name,
+            arguments: function_call.arguments
+          }
+        };
+      }
+      case "function": {
+        if (message.name === void 0) {
+          throw new Error("Invalid function call in message. Expected a name");
+        }
+        return {
+          role: message.role,
+          content: message.content,
+          name: message.name
+        };
+      }
+      case "data": {
+        throw "unsupported message role 'data'";
+      }
+      case "tool": {
+        if (message.name === void 0) {
+          throw new Error("Invalid tool message. Expected a name");
+        }
+        if (message.tool_call_id === void 0) {
+          throw new Error("Invalid tool message. Expected a tool_call_id");
+        }
+        return {
+          role: message.role,
+          content: message.content,
+          name: message.name,
+          tool_call_id: message.tool_call_id
+        };
+      }
+    }
+  });
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   experimental_buildAnthropicPrompt,
   experimental_buildLlama2Prompt,
+  experimental_buildOpenAIMessages,
   experimental_buildOpenAssistantPrompt,
   experimental_buildStarChatBetaPrompt
 });

package/prompts/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../index.ts","../anthropic.ts","../huggingface.ts"],"sourcesContent":["export * from './anthropic';\nexport * from './huggingface';\n","import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for Anthropic models.\n * Does not support `function` messages.\n * @see https://docs.anthropic.com/claude/reference/getting-started-with-the-api\n */\nexport function experimental_buildAnthropicPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages.map(({ content, role }) => {\n      if (role === 'user') {\n        return `\\n\\nHuman: ${content}`;\n      } else {\n        return `\\n\\nAssistant: ${content}`;\n      }\n    }) + '\\n\\nAssistant:'\n  );\n}\n","import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for the HuggingFace StarChat Beta model.\n * Does not support `function` messages.\n * @see https://huggingface.co/HuggingFaceH4/starchat-beta\n */\nexport function experimental_buildStarChatBetaPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|user|>\\n${content}<|end|>\\n`;\n        } else if (role === 'assistant') {\n          return `<|assistant|>\\n${content}<|end|>\\n`;\n        } else if (role === 'system') {\n          return `<|system|>\\n${content}<|end|>\\n`;\n        } else if (role === 'function') {\n          throw new Error('StarChat Beta does not support function calls.');\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace OpenAssistant models.\n * Does not support `function` or `system` messages.\n * @see https://huggingface.co/OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5\n */\nexport function experimental_buildOpenAssistantPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|prompter|>${content}<|endoftext|>`;\n        } else if (role === 'function') {\n          throw new Error('OpenAssistant does not support function calls.');\n        } else if (role === 'system') {\n          throw new Error('OpenAssistant does not support system messages.');\n        } else {\n          return `<|assistant|>${content}<|endoftext|>`;\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace LLama 2 chat models.\n * Does not support `function` messages.\n * @see https://huggingface.co/meta-llama/Llama-2-70b-chat-hf and https://huggingface.co/blog/llama2#how-to-prompt-llama-2\n */\nexport function experimental_buildLlama2Prompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  const startPrompt = `<s>[INST] `;\n  const endPrompt = ` [/INST]`;\n  const conversation = messages.map(({ content, role }, index) => {\n    if (role === 'user') {\n      return content.trim();\n    } else if (role === 'assistant') {\n      return ` [/INST] ${content}</s><s>[INST] `;\n    } else if (role === 'function') {\n      throw new Error('Llama 2 does not support function calls.');\n    } else if (role === 'system' && index === 0) {\n      return `<<SYS>>\\n${content}\\n<</SYS>>\\n\\n`;\n    } else {\n      throw new Error(`Invalid message role: ${role}`);\n    }\n  });\n\n  return startPrompt + conversation.join('') + endPrompt;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACOO,SAAS,kCACd,UACA;AACA,SACE,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAClC,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA;AAAA,SAAc;AAAA,IACvB,OAAO;AACL,aAAO;AAAA;AAAA,aAAkB;AAAA,IAC3B;AAAA,EACF,CAAC,IAAI;AAET;;;ACZO,SAAS,qCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA,EAAa;AAAA;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO;AAAA,EAAkB;AAAA;AAAA,IAC3B,WAAW,SAAS,UAAU;AAC5B,aAAO;AAAA,EAAe;AAAA;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,sCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO,eAAe;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE,WAAW,SAAS,UAAU;AAC5B,YAAM,IAAI,MAAM,iDAAiD;AAAA,IACnE,OAAO;AACL,aAAO,gBAAgB;AAAA,IACzB;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,+BACd,UACA;AACA,QAAM,cAAc;AACpB,QAAM,YAAY;AAClB,QAAM,eAAe,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,GAAG,UAAU;AAC9D,QAAI,SAAS,QAAQ;AACnB,aAAO,QAAQ,KAAK;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO,YAAY;AAAA,IACrB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D,WAAW,SAAS,YAAY,UAAU,GAAG;AAC3C,aAAO;AAAA,EAAY;AAAA;AAAA;AAAA;AAAA,IACrB,OAAO;AACL,YAAM,IAAI,MAAM,yBAAyB,MAAM;AAAA,IACjD;AAAA,EACF,CAAC;AAED,SAAO,cAAc,aAAa,KAAK,EAAE,IAAI;AAC/C;","names":[]}
+{"version":3,"sources":["../index.ts","../anthropic.ts","../huggingface.ts","../openai.tsx"],"sourcesContent":["export * from './anthropic';\nexport * from './huggingface';\nexport * from './openai';\n","import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for Anthropic models.\n * Does not support `function` messages.\n * @see https://docs.anthropic.com/claude/reference/getting-started-with-the-api\n */\nexport function experimental_buildAnthropicPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages.map(({ content, role }) => {\n      if (role === 'user') {\n        return `\\n\\nHuman: ${content}`;\n      } else {\n        return `\\n\\nAssistant: ${content}`;\n      }\n    }) + '\\n\\nAssistant:'\n  );\n}\n","import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for the HuggingFace StarChat Beta model.\n * Does not support `function` messages.\n * @see https://huggingface.co/HuggingFaceH4/starchat-beta\n */\nexport function experimental_buildStarChatBetaPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|user|>\\n${content}<|end|>\\n`;\n        } else if (role === 'assistant') {\n          return `<|assistant|>\\n${content}<|end|>\\n`;\n        } else if (role === 'system') {\n          return `<|system|>\\n${content}<|end|>\\n`;\n        } else if (role === 'function') {\n          throw new Error('StarChat Beta does not support function calls.');\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace OpenAssistant models.\n * Does not support `function` or `system` messages.\n * @see https://huggingface.co/OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5\n */\nexport function experimental_buildOpenAssistantPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|prompter|>${content}<|endoftext|>`;\n        } else if (role === 'function') {\n          throw new Error('OpenAssistant does not support function calls.');\n        } else if (role === 'system') {\n          throw new Error('OpenAssistant does not support system messages.');\n        } else {\n          return `<|assistant|>${content}<|endoftext|>`;\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace LLama 2 chat models.\n * Does not support `function` messages.\n * @see https://huggingface.co/meta-llama/Llama-2-70b-chat-hf and https://huggingface.co/blog/llama2#how-to-prompt-llama-2\n */\nexport function experimental_buildLlama2Prompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  const startPrompt = `<s>[INST] `;\n  const endPrompt = ` [/INST]`;\n  const conversation = messages.map(({ content, role }, index) => {\n    if (role === 'user') {\n      return content.trim();\n    } else if (role === 'assistant') {\n      return ` [/INST] ${content}</s><s>[INST] `;\n    } else if (role === 'function') {\n      throw new Error('Llama 2 does not support function calls.');\n    } else if (role === 'system' && index === 0) {\n      return `<<SYS>>\\n${content}\\n<</SYS>>\\n\\n`;\n    } else {\n      throw new Error(`Invalid message role: ${role}`);\n    }\n  });\n\n  return startPrompt + conversation.join('') + endPrompt;\n}\n","import { Message } from '../shared/types';\n\nexport function experimental_buildOpenAIMessages(\n  messages: Message[],\n): ChatCompletionMessageParam[] {\n  return messages.map(message => {\n    switch (message.role) {\n      case 'system':\n      case 'user':\n        return {\n          role: message.role,\n          content: message.content,\n        } satisfies ChatCompletionMessageParam;\n\n      case 'assistant': {\n        const function_call = message.function_call;\n\n        if (\n          function_call !== undefined &&\n          (typeof function_call === 'string' ||\n            function_call.arguments === undefined ||\n            function_call.name === undefined)\n        ) {\n          throw new Error(\n            'Invalid function call in message. Expected a function call object',\n          );\n        }\n\n        return {\n          role: message.role,\n          content: message.content,\n          function_call:\n            function_call === undefined\n              ? undefined\n              : {\n                  name: function_call.name!,\n                  arguments: function_call.arguments!,\n                },\n        } satisfies ChatCompletionMessageParam;\n      }\n\n      case 'function': {\n        if (message.name === undefined) {\n          throw new Error('Invalid function call in message. Expected a name');\n        }\n\n        return {\n          role: message.role,\n          content: message.content,\n          name: message.name,\n        } satisfies ChatCompletionMessageParam;\n      }\n\n      case 'data': {\n        throw \"unsupported message role 'data'\";\n      }\n\n      case 'tool': {\n        if (message.name === undefined) {\n          throw new Error('Invalid tool message. Expected a name');\n        }\n\n        if (message.tool_call_id === undefined) {\n          throw new Error('Invalid tool message. Expected a tool_call_id');\n        }\n\n        return {\n          role: message.role,\n          content: message.content,\n          name: message.name,\n          tool_call_id: message.tool_call_id,\n        } satisfies ChatCompletionMessageParam;\n      }\n    }\n  });\n}\n\n// copy of open ai messages (so we don't have a dependency on the openai package)\nexport type ChatCompletionMessageParam =\n  | ChatCompletionSystemMessageParam\n  | ChatCompletionUserMessageParam\n  | ChatCompletionAssistantMessageParam\n  | ChatCompletionToolMessageParam\n  | ChatCompletionFunctionMessageParam;\n\nexport interface ChatCompletionSystemMessageParam {\n  /**\n   * The contents of the system message.\n   */\n  content: string | null;\n\n  /**\n   * The role of the messages author, in this case `system`.\n   */\n  role: 'system';\n}\n\nexport interface ChatCompletionUserMessageParam {\n  /**\n   * The contents of the user message.\n   */\n  content: string | Array<ChatCompletionContentPart> | null;\n\n  /**\n   * The role of the messages author, in this case `user`.\n   */\n  role: 'user';\n}\n\nexport type ChatCompletionContentPart =\n  | ChatCompletionContentPartText\n  | ChatCompletionContentPartImage;\n\nexport interface ChatCompletionContentPartText {\n  /**\n   * The text content.\n   */\n  text: string;\n\n  /**\n   * The type of the content part.\n   */\n  type: 'text';\n}\n\nexport interface ChatCompletionContentPartImage {\n  image_url: ChatCompletionContentPartImage.ImageURL;\n\n  /**\n   * The type of the content part.\n   */\n  type: 'image_url';\n}\n\nexport namespace ChatCompletionContentPartImage {\n  export interface ImageURL {\n    /**\n     * Specifies the detail level of the image.\n     */\n    detail?: 'auto' | 'low' | 'high';\n\n    /**\n     * Either a URL of the image or the base64 encoded image data.\n     */\n    url?: string;\n  }\n}\n\nexport interface ChatCompletionAssistantMessageParam {\n  /**\n   * The contents of the assistant message.\n   */\n  content: string | null;\n\n  /**\n   * The role of the messages author, in this case `assistant`.\n   */\n  role: 'assistant';\n\n  /**\n   * Deprecated and replaced by `tool_calls`. The name and arguments of a function\n   * that should be called, as generated by the model.\n   */\n  function_call?: ChatCompletionAssistantMessageParam.FunctionCall;\n\n  /**\n   * The tool calls generated by the model, such as function calls.\n   */\n  tool_calls?: Array<ChatCompletionMessageToolCall>;\n}\n\nexport namespace ChatCompletionAssistantMessageParam {\n  /**\n   * Deprecated and replaced by `tool_calls`. The name and arguments of a function\n   * that should be called, as generated by the model.\n   */\n  export interface FunctionCall {\n    /**\n     * The arguments to call the function with, as generated by the model in JSON\n     * format. Note that the model does not always generate valid JSON, and may\n     * hallucinate parameters not defined by your function schema. Validate the\n     * arguments in your code before calling your function.\n     */\n    arguments: string;\n\n    /**\n     * The name of the function to call.\n     */\n    name: string;\n  }\n}\n\nexport interface ChatCompletionMessageToolCall {\n  /**\n   * The ID of the tool call.\n   */\n  id: string;\n\n  /**\n   * The function that the model called.\n   */\n  function: ChatCompletionMessageToolCall.Function;\n\n  /**\n   * The type of the tool. Currently, only `function` is supported.\n   */\n  type: 'function';\n}\n\nexport namespace ChatCompletionMessageToolCall {\n  /**\n   * The function that the model called.\n   */\n  export interface Function {\n    /**\n     * The arguments to call the function with, as generated by the model in JSON\n     * format. Note that the model does not always generate valid JSON, and may\n     * hallucinate parameters not defined by your function schema. Validate the\n     * arguments in your code before calling your function.\n     */\n    arguments: string;\n\n    /**\n     * The name of the function to call.\n     */\n    name: string;\n  }\n}\n\nexport interface ChatCompletionToolMessageParam {\n  /**\n   * The contents of the tool message.\n   */\n  content: string | null;\n\n  /**\n   * The role of the messages author, in this case `tool`.\n   */\n  role: 'tool';\n\n  /**\n   * The name of the function that this message is responding to.\n   */\n\n  name: string;\n  /**\n   * Tool call that this message is responding to.\n   */\n  tool_call_id: string;\n}\n\nexport interface ChatCompletionFunctionMessageParam {\n  /**\n   * The return value from the function call, to return to the model.\n   */\n  content: string | null;\n\n  /**\n   * The name of the function to call.\n   */\n  name: string;\n\n  /**\n   * The role of the messages author, in this case `function`.\n   */\n  role: 'function';\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACOO,SAAS,kCACd,UACA;AACA,SACE,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAClC,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA;AAAA,SAAc;AAAA,IACvB,OAAO;AACL,aAAO;AAAA;AAAA,aAAkB;AAAA,IAC3B;AAAA,EACF,CAAC,IAAI;AAET;;;ACZO,SAAS,qCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA,EAAa;AAAA;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO;AAAA,EAAkB;AAAA;AAAA,IAC3B,WAAW,SAAS,UAAU;AAC5B,aAAO;AAAA,EAAe;AAAA;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,sCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO,eAAe;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE,WAAW,SAAS,UAAU;AAC5B,YAAM,IAAI,MAAM,iDAAiD;AAAA,IACnE,OAAO;AACL,aAAO,gBAAgB;AAAA,IACzB;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,+BACd,UACA;AACA,QAAM,cAAc;AACpB,QAAM,YAAY;AAClB,QAAM,eAAe,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,GAAG,UAAU;AAC9D,QAAI,SAAS,QAAQ;AACnB,aAAO,QAAQ,KAAK;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO,YAAY;AAAA,IACrB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D,WAAW,SAAS,YAAY,UAAU,GAAG;AAC3C,aAAO;AAAA,EAAY;AAAA;AAAA;AAAA;AAAA,IACrB,OAAO;AACL,YAAM,IAAI,MAAM,yBAAyB,MAAM;AAAA,IACjD;AAAA,EACF,CAAC;AAED,SAAO,cAAc,aAAa,KAAK,EAAE,IAAI;AAC/C;;;AC3EO,SAAS,iCACd,UAC8B;AAC9B,SAAO,SAAS,IAAI,aAAW;AAC7B,YAAQ,QAAQ,MAAM;AAAA,MACpB,KAAK;AAAA,MACL,KAAK;AACH,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,QACnB;AAAA,MAEF,KAAK,aAAa;AAChB,cAAM,gBAAgB,QAAQ;AAE9B,YACE,kBAAkB,WACjB,OAAO,kBAAkB,YACxB,cAAc,cAAc,UAC5B,cAAc,SAAS,SACzB;AACA,gBAAM,IAAI;AAAA,YACR;AAAA,UACF;AAAA,QACF;AAEA,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,UACjB,eACE,kBAAkB,SACd,SACA;AAAA,YACE,MAAM,cAAc;AAAA,YACpB,WAAW,cAAc;AAAA,UAC3B;AAAA,QACR;AAAA,MACF;AAAA,MAEA,KAAK,YAAY;AACf,YAAI,QAAQ,SAAS,QAAW;AAC9B,gBAAM,IAAI,MAAM,mDAAmD;AAAA,QACrE;AAEA,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,UACjB,MAAM,QAAQ;AAAA,QAChB;AAAA,MACF;AAAA,MAEA,KAAK,QAAQ;AACX,cAAM;AAAA,MACR;AAAA,MAEA,KAAK,QAAQ;AACX,YAAI,QAAQ,SAAS,QAAW;AAC9B,gBAAM,IAAI,MAAM,uCAAuC;AAAA,QACzD;AAEA,YAAI,QAAQ,iBAAiB,QAAW;AACtC,gBAAM,IAAI,MAAM,+CAA+C;AAAA,QACjE;AAEA,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,UACjB,MAAM,QAAQ;AAAA,UACd,cAAc,QAAQ;AAAA,QACxB;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AACH;","names":[]}

package/prompts/dist/index.mjs

@@ -68,9 +68,67 @@ ${content}
   });
   return startPrompt + conversation.join("") + endPrompt;
 }
+
+// prompts/openai.tsx
+function experimental_buildOpenAIMessages(messages) {
+  return messages.map((message) => {
+    switch (message.role) {
+      case "system":
+      case "user":
+        return {
+          role: message.role,
+          content: message.content
+        };
+      case "assistant": {
+        const function_call = message.function_call;
+        if (function_call !== void 0 && (typeof function_call === "string" || function_call.arguments === void 0 || function_call.name === void 0)) {
+          throw new Error(
+            "Invalid function call in message. Expected a function call object"
+          );
+        }
+        return {
+          role: message.role,
+          content: message.content,
+          function_call: function_call === void 0 ? void 0 : {
+            name: function_call.name,
+            arguments: function_call.arguments
+          }
+        };
+      }
+      case "function": {
+        if (message.name === void 0) {
+          throw new Error("Invalid function call in message. Expected a name");
+        }
+        return {
+          role: message.role,
+          content: message.content,
+          name: message.name
+        };
+      }
+      case "data": {
+        throw "unsupported message role 'data'";
+      }
+      case "tool": {
+        if (message.name === void 0) {
+          throw new Error("Invalid tool message. Expected a name");
+        }
+        if (message.tool_call_id === void 0) {
+          throw new Error("Invalid tool message. Expected a tool_call_id");
+        }
+        return {
+          role: message.role,
+          content: message.content,
+          name: message.name,
+          tool_call_id: message.tool_call_id
+        };
+      }
+    }
+  });
+}
 export {
   experimental_buildAnthropicPrompt,
   experimental_buildLlama2Prompt,
+  experimental_buildOpenAIMessages,
   experimental_buildOpenAssistantPrompt,
   experimental_buildStarChatBetaPrompt
 };

package/prompts/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../anthropic.ts","../huggingface.ts"],"sourcesContent":["import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for Anthropic models.\n * Does not support `function` messages.\n * @see https://docs.anthropic.com/claude/reference/getting-started-with-the-api\n */\nexport function experimental_buildAnthropicPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages.map(({ content, role }) => {\n      if (role === 'user') {\n        return `\\n\\nHuman: ${content}`;\n      } else {\n        return `\\n\\nAssistant: ${content}`;\n      }\n    }) + '\\n\\nAssistant:'\n  );\n}\n","import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for the HuggingFace StarChat Beta model.\n * Does not support `function` messages.\n * @see https://huggingface.co/HuggingFaceH4/starchat-beta\n */\nexport function experimental_buildStarChatBetaPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|user|>\\n${content}<|end|>\\n`;\n        } else if (role === 'assistant') {\n          return `<|assistant|>\\n${content}<|end|>\\n`;\n        } else if (role === 'system') {\n          return `<|system|>\\n${content}<|end|>\\n`;\n        } else if (role === 'function') {\n          throw new Error('StarChat Beta does not support function calls.');\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace OpenAssistant models.\n * Does not support `function` or `system` messages.\n * @see https://huggingface.co/OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5\n */\nexport function experimental_buildOpenAssistantPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|prompter|>${content}<|endoftext|>`;\n        } else if (role === 'function') {\n          throw new Error('OpenAssistant does not support function calls.');\n        } else if (role === 'system') {\n          throw new Error('OpenAssistant does not support system messages.');\n        } else {\n          return `<|assistant|>${content}<|endoftext|>`;\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace LLama 2 chat models.\n * Does not support `function` messages.\n * @see https://huggingface.co/meta-llama/Llama-2-70b-chat-hf and https://huggingface.co/blog/llama2#how-to-prompt-llama-2\n */\nexport function experimental_buildLlama2Prompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  const startPrompt = `<s>[INST] `;\n  const endPrompt = ` [/INST]`;\n  const conversation = messages.map(({ content, role }, index) => {\n    if (role === 'user') {\n      return content.trim();\n    } else if (role === 'assistant') {\n      return ` [/INST] ${content}</s><s>[INST] `;\n    } else if (role === 'function') {\n      throw new Error('Llama 2 does not support function calls.');\n    } else if (role === 'system' && index === 0) {\n      return `<<SYS>>\\n${content}\\n<</SYS>>\\n\\n`;\n    } else {\n      throw new Error(`Invalid message role: ${role}`);\n    }\n  });\n\n  return startPrompt + conversation.join('') + endPrompt;\n}\n"],"mappings":";AAOO,SAAS,kCACd,UACA;AACA,SACE,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAClC,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA;AAAA,SAAc;AAAA,IACvB,OAAO;AACL,aAAO;AAAA;AAAA,aAAkB;AAAA,IAC3B;AAAA,EACF,CAAC,IAAI;AAET;;;ACZO,SAAS,qCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA,EAAa;AAAA;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO;AAAA,EAAkB;AAAA;AAAA,IAC3B,WAAW,SAAS,UAAU;AAC5B,aAAO;AAAA,EAAe;AAAA;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,sCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO,eAAe;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE,WAAW,SAAS,UAAU;AAC5B,YAAM,IAAI,MAAM,iDAAiD;AAAA,IACnE,OAAO;AACL,aAAO,gBAAgB;AAAA,IACzB;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,+BACd,UACA;AACA,QAAM,cAAc;AACpB,QAAM,YAAY;AAClB,QAAM,eAAe,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,GAAG,UAAU;AAC9D,QAAI,SAAS,QAAQ;AACnB,aAAO,QAAQ,KAAK;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO,YAAY;AAAA,IACrB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D,WAAW,SAAS,YAAY,UAAU,GAAG;AAC3C,aAAO;AAAA,EAAY;AAAA;AAAA;AAAA;AAAA,IACrB,OAAO;AACL,YAAM,IAAI,MAAM,yBAAyB,MAAM;AAAA,IACjD;AAAA,EACF,CAAC;AAED,SAAO,cAAc,aAAa,KAAK,EAAE,IAAI;AAC/C;","names":[]}
+{"version":3,"sources":["../anthropic.ts","../huggingface.ts","../openai.tsx"],"sourcesContent":["import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for Anthropic models.\n * Does not support `function` messages.\n * @see https://docs.anthropic.com/claude/reference/getting-started-with-the-api\n */\nexport function experimental_buildAnthropicPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages.map(({ content, role }) => {\n      if (role === 'user') {\n        return `\\n\\nHuman: ${content}`;\n      } else {\n        return `\\n\\nAssistant: ${content}`;\n      }\n    }) + '\\n\\nAssistant:'\n  );\n}\n","import { Message } from '../shared/types';\n\n/**\n * A prompt constructor for the HuggingFace StarChat Beta model.\n * Does not support `function` messages.\n * @see https://huggingface.co/HuggingFaceH4/starchat-beta\n */\nexport function experimental_buildStarChatBetaPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|user|>\\n${content}<|end|>\\n`;\n        } else if (role === 'assistant') {\n          return `<|assistant|>\\n${content}<|end|>\\n`;\n        } else if (role === 'system') {\n          return `<|system|>\\n${content}<|end|>\\n`;\n        } else if (role === 'function') {\n          throw new Error('StarChat Beta does not support function calls.');\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace OpenAssistant models.\n * Does not support `function` or `system` messages.\n * @see https://huggingface.co/OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5\n */\nexport function experimental_buildOpenAssistantPrompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  return (\n    messages\n      .map(({ content, role }) => {\n        if (role === 'user') {\n          return `<|prompter|>${content}<|endoftext|>`;\n        } else if (role === 'function') {\n          throw new Error('OpenAssistant does not support function calls.');\n        } else if (role === 'system') {\n          throw new Error('OpenAssistant does not support system messages.');\n        } else {\n          return `<|assistant|>${content}<|endoftext|>`;\n        }\n      })\n      .join('') + '<|assistant|>'\n  );\n}\n\n/**\n * A prompt constructor for HuggingFace LLama 2 chat models.\n * Does not support `function` messages.\n * @see https://huggingface.co/meta-llama/Llama-2-70b-chat-hf and https://huggingface.co/blog/llama2#how-to-prompt-llama-2\n */\nexport function experimental_buildLlama2Prompt(\n  messages: Pick<Message, 'content' | 'role'>[],\n) {\n  const startPrompt = `<s>[INST] `;\n  const endPrompt = ` [/INST]`;\n  const conversation = messages.map(({ content, role }, index) => {\n    if (role === 'user') {\n      return content.trim();\n    } else if (role === 'assistant') {\n      return ` [/INST] ${content}</s><s>[INST] `;\n    } else if (role === 'function') {\n      throw new Error('Llama 2 does not support function calls.');\n    } else if (role === 'system' && index === 0) {\n      return `<<SYS>>\\n${content}\\n<</SYS>>\\n\\n`;\n    } else {\n      throw new Error(`Invalid message role: ${role}`);\n    }\n  });\n\n  return startPrompt + conversation.join('') + endPrompt;\n}\n","import { Message } from '../shared/types';\n\nexport function experimental_buildOpenAIMessages(\n  messages: Message[],\n): ChatCompletionMessageParam[] {\n  return messages.map(message => {\n    switch (message.role) {\n      case 'system':\n      case 'user':\n        return {\n          role: message.role,\n          content: message.content,\n        } satisfies ChatCompletionMessageParam;\n\n      case 'assistant': {\n        const function_call = message.function_call;\n\n        if (\n          function_call !== undefined &&\n          (typeof function_call === 'string' ||\n            function_call.arguments === undefined ||\n            function_call.name === undefined)\n        ) {\n          throw new Error(\n            'Invalid function call in message. Expected a function call object',\n          );\n        }\n\n        return {\n          role: message.role,\n          content: message.content,\n          function_call:\n            function_call === undefined\n              ? undefined\n              : {\n                  name: function_call.name!,\n                  arguments: function_call.arguments!,\n                },\n        } satisfies ChatCompletionMessageParam;\n      }\n\n      case 'function': {\n        if (message.name === undefined) {\n          throw new Error('Invalid function call in message. Expected a name');\n        }\n\n        return {\n          role: message.role,\n          content: message.content,\n          name: message.name,\n        } satisfies ChatCompletionMessageParam;\n      }\n\n      case 'data': {\n        throw \"unsupported message role 'data'\";\n      }\n\n      case 'tool': {\n        if (message.name === undefined) {\n          throw new Error('Invalid tool message. Expected a name');\n        }\n\n        if (message.tool_call_id === undefined) {\n          throw new Error('Invalid tool message. Expected a tool_call_id');\n        }\n\n        return {\n          role: message.role,\n          content: message.content,\n          name: message.name,\n          tool_call_id: message.tool_call_id,\n        } satisfies ChatCompletionMessageParam;\n      }\n    }\n  });\n}\n\n// copy of open ai messages (so we don't have a dependency on the openai package)\nexport type ChatCompletionMessageParam =\n  | ChatCompletionSystemMessageParam\n  | ChatCompletionUserMessageParam\n  | ChatCompletionAssistantMessageParam\n  | ChatCompletionToolMessageParam\n  | ChatCompletionFunctionMessageParam;\n\nexport interface ChatCompletionSystemMessageParam {\n  /**\n   * The contents of the system message.\n   */\n  content: string | null;\n\n  /**\n   * The role of the messages author, in this case `system`.\n   */\n  role: 'system';\n}\n\nexport interface ChatCompletionUserMessageParam {\n  /**\n   * The contents of the user message.\n   */\n  content: string | Array<ChatCompletionContentPart> | null;\n\n  /**\n   * The role of the messages author, in this case `user`.\n   */\n  role: 'user';\n}\n\nexport type ChatCompletionContentPart =\n  | ChatCompletionContentPartText\n  | ChatCompletionContentPartImage;\n\nexport interface ChatCompletionContentPartText {\n  /**\n   * The text content.\n   */\n  text: string;\n\n  /**\n   * The type of the content part.\n   */\n  type: 'text';\n}\n\nexport interface ChatCompletionContentPartImage {\n  image_url: ChatCompletionContentPartImage.ImageURL;\n\n  /**\n   * The type of the content part.\n   */\n  type: 'image_url';\n}\n\nexport namespace ChatCompletionContentPartImage {\n  export interface ImageURL {\n    /**\n     * Specifies the detail level of the image.\n     */\n    detail?: 'auto' | 'low' | 'high';\n\n    /**\n     * Either a URL of the image or the base64 encoded image data.\n     */\n    url?: string;\n  }\n}\n\nexport interface ChatCompletionAssistantMessageParam {\n  /**\n   * The contents of the assistant message.\n   */\n  content: string | null;\n\n  /**\n   * The role of the messages author, in this case `assistant`.\n   */\n  role: 'assistant';\n\n  /**\n   * Deprecated and replaced by `tool_calls`. The name and arguments of a function\n   * that should be called, as generated by the model.\n   */\n  function_call?: ChatCompletionAssistantMessageParam.FunctionCall;\n\n  /**\n   * The tool calls generated by the model, such as function calls.\n   */\n  tool_calls?: Array<ChatCompletionMessageToolCall>;\n}\n\nexport namespace ChatCompletionAssistantMessageParam {\n  /**\n   * Deprecated and replaced by `tool_calls`. The name and arguments of a function\n   * that should be called, as generated by the model.\n   */\n  export interface FunctionCall {\n    /**\n     * The arguments to call the function with, as generated by the model in JSON\n     * format. Note that the model does not always generate valid JSON, and may\n     * hallucinate parameters not defined by your function schema. Validate the\n     * arguments in your code before calling your function.\n     */\n    arguments: string;\n\n    /**\n     * The name of the function to call.\n     */\n    name: string;\n  }\n}\n\nexport interface ChatCompletionMessageToolCall {\n  /**\n   * The ID of the tool call.\n   */\n  id: string;\n\n  /**\n   * The function that the model called.\n   */\n  function: ChatCompletionMessageToolCall.Function;\n\n  /**\n   * The type of the tool. Currently, only `function` is supported.\n   */\n  type: 'function';\n}\n\nexport namespace ChatCompletionMessageToolCall {\n  /**\n   * The function that the model called.\n   */\n  export interface Function {\n    /**\n     * The arguments to call the function with, as generated by the model in JSON\n     * format. Note that the model does not always generate valid JSON, and may\n     * hallucinate parameters not defined by your function schema. Validate the\n     * arguments in your code before calling your function.\n     */\n    arguments: string;\n\n    /**\n     * The name of the function to call.\n     */\n    name: string;\n  }\n}\n\nexport interface ChatCompletionToolMessageParam {\n  /**\n   * The contents of the tool message.\n   */\n  content: string | null;\n\n  /**\n   * The role of the messages author, in this case `tool`.\n   */\n  role: 'tool';\n\n  /**\n   * The name of the function that this message is responding to.\n   */\n\n  name: string;\n  /**\n   * Tool call that this message is responding to.\n   */\n  tool_call_id: string;\n}\n\nexport interface ChatCompletionFunctionMessageParam {\n  /**\n   * The return value from the function call, to return to the model.\n   */\n  content: string | null;\n\n  /**\n   * The name of the function to call.\n   */\n  name: string;\n\n  /**\n   * The role of the messages author, in this case `function`.\n   */\n  role: 'function';\n}\n"],"mappings":";AAOO,SAAS,kCACd,UACA;AACA,SACE,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAClC,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA;AAAA,SAAc;AAAA,IACvB,OAAO;AACL,aAAO;AAAA;AAAA,aAAkB;AAAA,IAC3B;AAAA,EACF,CAAC,IAAI;AAET;;;ACZO,SAAS,qCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO;AAAA,EAAa;AAAA;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO;AAAA,EAAkB;AAAA;AAAA,IAC3B,WAAW,SAAS,UAAU;AAC5B,aAAO;AAAA,EAAe;AAAA;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,sCACd,UACA;AACA,SACE,SACG,IAAI,CAAC,EAAE,SAAS,KAAK,MAAM;AAC1B,QAAI,SAAS,QAAQ;AACnB,aAAO,eAAe;AAAA,IACxB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE,WAAW,SAAS,UAAU;AAC5B,YAAM,IAAI,MAAM,iDAAiD;AAAA,IACnE,OAAO;AACL,aAAO,gBAAgB;AAAA,IACzB;AAAA,EACF,CAAC,EACA,KAAK,EAAE,IAAI;AAElB;AAOO,SAAS,+BACd,UACA;AACA,QAAM,cAAc;AACpB,QAAM,YAAY;AAClB,QAAM,eAAe,SAAS,IAAI,CAAC,EAAE,SAAS,KAAK,GAAG,UAAU;AAC9D,QAAI,SAAS,QAAQ;AACnB,aAAO,QAAQ,KAAK;AAAA,IACtB,WAAW,SAAS,aAAa;AAC/B,aAAO,YAAY;AAAA,IACrB,WAAW,SAAS,YAAY;AAC9B,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D,WAAW,SAAS,YAAY,UAAU,GAAG;AAC3C,aAAO;AAAA,EAAY;AAAA;AAAA;AAAA;AAAA,IACrB,OAAO;AACL,YAAM,IAAI,MAAM,yBAAyB,MAAM;AAAA,IACjD;AAAA,EACF,CAAC;AAED,SAAO,cAAc,aAAa,KAAK,EAAE,IAAI;AAC/C;;;AC3EO,SAAS,iCACd,UAC8B;AAC9B,SAAO,SAAS,IAAI,aAAW;AAC7B,YAAQ,QAAQ,MAAM;AAAA,MACpB,KAAK;AAAA,MACL,KAAK;AACH,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,QACnB;AAAA,MAEF,KAAK,aAAa;AAChB,cAAM,gBAAgB,QAAQ;AAE9B,YACE,kBAAkB,WACjB,OAAO,kBAAkB,YACxB,cAAc,cAAc,UAC5B,cAAc,SAAS,SACzB;AACA,gBAAM,IAAI;AAAA,YACR;AAAA,UACF;AAAA,QACF;AAEA,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,UACjB,eACE,kBAAkB,SACd,SACA;AAAA,YACE,MAAM,cAAc;AAAA,YACpB,WAAW,cAAc;AAAA,UAC3B;AAAA,QACR;AAAA,MACF;AAAA,MAEA,KAAK,YAAY;AACf,YAAI,QAAQ,SAAS,QAAW;AAC9B,gBAAM,IAAI,MAAM,mDAAmD;AAAA,QACrE;AAEA,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,UACjB,MAAM,QAAQ;AAAA,QAChB;AAAA,MACF;AAAA,MAEA,KAAK,QAAQ;AACX,cAAM;AAAA,MACR;AAAA,MAEA,KAAK,QAAQ;AACX,YAAI,QAAQ,SAAS,QAAW;AAC9B,gBAAM,IAAI,MAAM,uCAAuC;AAAA,QACzD;AAEA,YAAI,QAAQ,iBAAiB,QAAW;AACtC,gBAAM,IAAI,MAAM,+CAA+C;AAAA,QACjE;AAEA,eAAO;AAAA,UACL,MAAM,QAAQ;AAAA,UACd,SAAS,QAAQ;AAAA,UACjB,MAAM,QAAQ;AAAA,UACd,cAAc,QAAQ;AAAA,QACxB;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AACH;","names":[]}

package/react/dist/index.d.ts

@@ -11,6 +11,38 @@ interface FunctionCall {
      */
     name?: string;
 }
+/**
+ * The tool calls generated by the model, such as function calls.
+ */
+interface ToolCall {
+    id: string;
+    type: string;
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
+/**
+ * Controls which (if any) function is called by the model.
+ * - none means the model will not call a function and instead generates a message.
+ * - auto means the model can pick between generating a message or calling a function.
+ * - Specifying a particular function via {"type: "function", "function": {"name": "my_function"}} forces the model to call that function.
+ * none is the default when no functions are present. auto is the default if functions are present.
+ */
+type ToolChoice = 'none' | 'auto' | {
+    type: 'function';
+    function: {
+        name: string;
+    };
+};
+/**
+ * A list of tools the model may call. Currently, only functions are supported as a tool.
+ * Use this to provide a list of functions the model may generate JSON inputs for.
+ */
+interface Tool {
+    type: 'function';
+    function: Function;
+}
 interface Function {
     /**
      * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
@@ -39,10 +71,11 @@ type IdGenerator = () => string;
  */
 interface Message {
     id: string;
+    tool_call_id?: string;
     createdAt?: Date;
     content: string;
     ui?: string | JSX.Element | JSX.Element[] | null | undefined;
-    role: 'system' | 'user' | 'assistant' | 'function' | 'data';
+    role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.
      * Otherwise, the name field should not be set.
@@ -51,10 +84,15 @@ interface Message {
     /**
      * If the assistant role makes a function call, the `function_call` field
      * contains the function call name and arguments. Otherwise, the field should
-     * not be set.
+     * not be set. (Deprecated and replaced by tool_calls.)
      */
     function_call?: string | FunctionCall;
     data?: JSONValue;
+    /**
+     * If the assistant role makes a tool call, the `tool_calls` field contains
+     * the tool call name and arguments. Otherwise, the field should not be set.
+     */
+    tool_calls?: string | ToolCall[];
 }
 type CreateMessage = Omit<Message, 'id'> & {
     id?: Message['id'];
@@ -65,8 +103,11 @@ type ChatRequest = {
     functions?: Array<Function>;
     function_call?: FunctionCall;
     data?: Record<string, string>;
+    tools?: Array<Tool>;
+    tool_choice?: ToolChoice;
 };
 type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall) => Promise<ChatRequest | void>;
+type ToolCallHandler = (chatMessages: Message[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
     body?: object;
@@ -75,6 +116,8 @@ type ChatRequestOptions = {
     options?: RequestOptions;
     functions?: Array<Function>;
     function_call?: FunctionCall;
+    tools?: Array<Tool>;
+    tool_choice?: ToolChoice;
     data?: Record<string, string>;
 };
 type UseChatOptions = {
@@ -103,6 +146,12 @@ type UseChatOptions = {
      * automatically to the API and will be used to update the chat.
      */
     experimental_onFunctionCall?: FunctionCallHandler;
+    /**
+     * Callback function to be called when a tool call is received.
+     * If the function returns a `ChatRequest` object, the request will be sent
+     * automatically to the API and will be used to update the chat.
+     */
+    experimental_onToolCall?: ToolCallHandler;
     /**
      * Callback function to be called when the API response is received.
      */
@@ -285,7 +334,7 @@ type UseChatHelpers = {
     setInput: React.Dispatch<React.SetStateAction<string>>;
     /** An input/textarea-ready onChange handler to control the value of the input */
     handleInputChange: (e: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
-    /** Form submission handler to automatically reset input and append a user message  */
+    /** Form submission handler to automatically reset input and append a user message */
     handleSubmit: (e: React.FormEvent<HTMLFormElement>, chatRequestOptions?: ChatRequestOptions) => void;
     metadata?: Object;
     /** Whether the API request is in progress */
@@ -350,28 +399,61 @@ declare function useCompletion({ api, id, initialCompletion, initialInput, crede
 
 type AssistantStatus = 'in_progress' | 'awaiting_message';
 type UseAssistantHelpers = {
-    /** Current messages in the chat */
+    /**
+     * The current array of chat messages.
+     */
     messages: Message[];
-    /** Current thread ID */
+    /**
+     * The current thread ID.
+     */
     threadId: string | undefined;
-    /** The current value of the input */
+    /**
+     * The current value of the input field.
+     */
     input: string;
-    /** An input/textarea-ready onChange handler to control the value of the input */
+    /**
+     * Handler for the `onChange` event of the input field to control the input's value.
+     */
     handleInputChange: (event: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
-    /** Form submission handler to automatically reset input and append a user message  */
+    /**
+     * Form submission handler that automatically resets the input field and appends a user message.
+     */
     submitMessage: (event?: React.FormEvent<HTMLFormElement>, requestOptions?: {
         data?: Record<string, string>;
     }) => Promise<void>;
-    /** Current status of the assistant */
+    /**
+     * The current status of the assistant. This can be used to show a loading indicator.
+     */
     status: AssistantStatus;
-    /** Current error, if any */
+    /**
+     * The error thrown during the assistant message processing, if any.
+     */
     error: undefined | unknown;
 };
 type UseAssistantOptions = {
+    /**
+     * The API endpoint that accepts a `{ threadId: string | null; message: string; }` object and returns an `AssistantResponse` stream.
+     * The threadId refers to an existing thread with messages (or is `null` to create a new thread).
+     * The message is the next message that should be appended to the thread and sent to the assistant.
+     */
     api: string;
+    /**
+     * An optional string that represents the ID of an existing thread.
+     * If not provided, a new thread will be created.
+     */
     threadId?: string | undefined;
+    /**
+     * An optional literal that sets the mode of credentials to be used on the request.
+     * Defaults to "same-origin".
+     */
     credentials?: RequestCredentials;
+    /**
+     * An optional object of headers to be passed to the API endpoint.
+     */
     headers?: Record<string, string> | Headers;
+    /**
+     * An optional, additional body object to be passed to the API endpoint.
+     */
     body?: object;
 };
 declare function experimental_useAssistant({ api, threadId: threadIdParam, credentials, headers, body, }: UseAssistantOptions): UseAssistantHelpers;