ai 2.1.8 → 2.1.10

package/vue/dist/index.d.ts

@@ -1,32 +1,49 @@
 import { Ref } from 'vue';
+import { ChatCompletionRequestMessageFunctionCall, CreateChatCompletionRequestFunctionCall } from 'openai-edge';
+import { ChatCompletionFunctions } from 'openai-edge/types/api';
 
 /**
  * Shared types between the API and UI packages.
  */
-declare type Message = {
+type Message = {
     id: string;
     createdAt?: Date;
     content: string;
-    role: 'system' | 'user' | 'assistant';
+    role: 'system' | 'user' | 'assistant' | 'function';
+    /**
+     * 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.
+     */
+    name?: string;
+    /**
+     * 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.
+     */
+    function_call?: string | ChatCompletionRequestMessageFunctionCall;
 };
-declare type CreateMessage = {
-    id?: string;
-    createdAt?: Date;
-    content: string;
-    role: 'system' | 'user' | 'assistant';
+type CreateMessage = Omit<Message, 'id'> & {
+    id?: Message['id'];
+};
+type ChatRequest = {
+    messages: Message[];
+    options?: RequestOptions;
+    functions?: Array<ChatCompletionFunctions>;
+    function_call?: CreateChatCompletionRequestFunctionCall;
 };
-declare type RequestOptions = {
+type FunctionCallHandler = (chatMessages: Message[], functionCall: ChatCompletionRequestMessageFunctionCall) => Promise<ChatRequest | void>;
+type RequestOptions = {
     headers?: Record<string, string> | Headers;
     body?: object;
 };
-declare type UseChatOptions = {
+type UseChatOptions = {
     /**
      * The API endpoint that accepts a `{ messages: Message[] }` object and returns
      * a stream of tokens of the AI chat response. Defaults to `/api/chat`.
      */
     api?: string;
     /**
-     * An unique identifier for the chat. If not provided, a random one will be
+     * A unique identifier for the chat. If not provided, a random one will be
      * generated. When provided, the `useChat` hook with the same `id` will
      * have shared states across components.
      */
@@ -39,6 +56,12 @@ declare type UseChatOptions = {
      * Initial input of the chat.
      */
     initialInput?: string;
+    /**
+     * Callback function to be called when a function 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_onFunctionCall?: FunctionCallHandler;
     /**
      * Callback function to be called when the API response is received.
      */
@@ -51,6 +74,12 @@ declare type UseChatOptions = {
      * Callback function to be called when an error is encountered.
      */
     onError?: (error: Error) => void;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
     /**
      * HTTP headers to be sent with the API request.
      */
@@ -75,7 +104,7 @@ declare type UseChatOptions = {
      */
     sendExtraMessageFields?: boolean;
 };
-declare type UseCompletionOptions = {
+type UseCompletionOptions = {
     /**
      * The API endpoint that accepts a `{ prompt: string }` object and returns
      * a stream of tokens of the AI completion response. Defaults to `/api/completion`.
@@ -107,6 +136,12 @@ declare type UseCompletionOptions = {
      * Callback function to be called when an error is encountered.
      */
     onError?: (error: Error) => void;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
     /**
      * HTTP headers to be sent with the API request.
      */
@@ -126,7 +161,7 @@ declare type UseCompletionOptions = {
     body?: object;
 };
 
-declare type UseChatHelpers = {
+type UseChatHelpers = {
     /** Current messages in the chat */
     messages: Ref<Message[]>;
     /** The error object of the API request */
@@ -159,9 +194,9 @@ declare type UseChatHelpers = {
     /** Whether the API request is in progress */
     isLoading: Ref<boolean>;
 };
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onResponse, onFinish, onError, headers, body }?: UseChatOptions): UseChatHelpers;
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onResponse, onFinish, onError, credentials, headers, body }?: UseChatOptions): UseChatHelpers;
 
-declare type UseCompletionHelpers = {
+type UseCompletionHelpers = {
     /** The current completion result */
     completion: Ref<string>;
     /** The error object of the API request */
@@ -193,6 +228,6 @@ declare type UseCompletionHelpers = {
     /** Whether the API request is in progress */
     isLoading: Ref<boolean>;
 };
-declare function useCompletion({ api, id, initialCompletion, initialInput, headers, body, onResponse, onFinish, onError }?: UseCompletionOptions): UseCompletionHelpers;
+declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, onResponse, onFinish, onError }?: UseCompletionOptions): UseCompletionHelpers;
 
 export { CreateMessage, Message, UseChatHelpers, UseChatOptions, UseCompletionHelpers, useChat, useCompletion };

package/vue/dist/index.js

@@ -101,6 +101,7 @@ function useChat({
   onResponse,
   onFinish,
   onError,
+  credentials,
   headers,
   body
 } = {}) {
@@ -135,7 +136,8 @@ function useChat({
             }))
           }, body), options == null ? void 0 : options.body)),
           headers: __spreadValues(__spreadValues({}, headers), options == null ? void 0 : options.headers),
-          signal: abortController.signal
+          signal: abortController.signal,
+          credentials
         }).catch((err) => {
           mutate(previousMessages);
           throw err;
@@ -266,6 +268,7 @@ function useCompletion({
   id,
   initialCompletion = "",
   initialInput = "",
+  credentials,
   headers,
   body,
   onResponse,
@@ -299,7 +302,8 @@ function useCompletion({
             prompt
           }, body), options == null ? void 0 : options.body)),
           headers: __spreadValues(__spreadValues({}, headers), options == null ? void 0 : options.headers),
-          signal: abortController.signal
+          signal: abortController.signal,
+          credentials
         }).catch((err) => {
           throw err;
         });

package/vue/dist/index.mjs

@@ -67,6 +67,7 @@ function useChat({
   onResponse,
   onFinish,
   onError,
+  credentials,
   headers,
   body
 } = {}) {
@@ -101,7 +102,8 @@ function useChat({
             }))
           }, body), options == null ? void 0 : options.body)),
           headers: __spreadValues(__spreadValues({}, headers), options == null ? void 0 : options.headers),
-          signal: abortController.signal
+          signal: abortController.signal,
+          credentials
         }).catch((err) => {
           mutate(previousMessages);
           throw err;
@@ -232,6 +234,7 @@ function useCompletion({
   id,
   initialCompletion = "",
   initialInput = "",
+  credentials,
   headers,
   body,
   onResponse,
@@ -265,7 +268,8 @@ function useCompletion({
             prompt
           }, body), options == null ? void 0 : options.body)),
           headers: __spreadValues(__spreadValues({}, headers), options == null ? void 0 : options.headers),
-          signal: abortController.signal
+          signal: abortController.signal,
+          credentials
         }).catch((err) => {
           throw err;
         });