ai 3.1.29 → 3.1.31

package/svelte/dist/index.d.ts

@@ -1,426 +1,7 @@
+import { Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, AssistantStatus, UseAssistantOptions } from '@ai-sdk/ui-utils';
+export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from '@ai-sdk/ui-utils';
 import { Readable, Writable } from 'svelte/store';
 
-/**
-Typed tool call that is returned by generateText and streamText.
-It contains the tool call ID, the tool name, and the tool arguments.
- */
-interface ToolCall$1<NAME extends string, ARGS> {
-    /**
-  ID of the tool call. This ID is used to match the tool call with the tool result.
-   */
-    toolCallId: string;
-    /**
-  Name of the tool that is being called.
-   */
-    toolName: NAME;
-    /**
-  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
-     */
-    args: ARGS;
-}
-
-/**
-Typed tool result that is returned by generateText and streamText.
-It contains the tool call ID, the tool name, the tool arguments, and the tool result.
- */
-interface ToolResult<NAME extends string, ARGS, RESULT> {
-    /**
-  ID of the tool call. This ID is used to match the tool call with the tool result.
-   */
-    toolCallId: string;
-    /**
-  Name of the tool that was called.
-   */
-    toolName: NAME;
-    /**
-  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
-     */
-    args: ARGS;
-    /**
-  Result of the tool call. This is the result of the tool's execution.
-     */
-    result: RESULT;
-}
-
-type AssistantStatus = 'in_progress' | 'awaiting_message';
-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;
-    /**
-     * 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;
-    /**
-     * An optional callback that will be called when the assistant encounters an error.
-     */
-    onError?: (error: Error) => void;
-};
-
-/**
- * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
- */
-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;
-}
-/**
- * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
- *
- * The tool calls generated by the model, such as function calls.
- */
-interface ToolCall {
-    id: string;
-    type: string;
-    function: {
-        name: string;
-        arguments: string;
-    };
-}
-/**
- * @deprecated use AI SDK 3.1 CoreTool / ToolChoice instead
- *
- * 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;
-    };
-};
-/**
- * @deprecated use AI SDK 3.1 CoreTool instead
- *
- * 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;
-}
-/**
- * @deprecated use AI SDK 3.1 CoreTool instead
- */
-interface Function {
-    /**
-     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
-     * underscores and dashes, with a maximum length of 64.
-     */
-    name: string;
-    /**
-     * The parameters the functions accepts, described as a JSON Schema object. See the
-     * [guide](/docs/guides/gpt/function-calling) for examples, and the
-     * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
-     * documentation about the format.
-     *
-     * To describe a function that accepts no parameters, provide the value
-     * `{"type": "object", "properties": {}}`.
-     */
-    parameters: Record<string, unknown>;
-    /**
-     * A description of what the function does, used by the model to choose when and
-     * how to call the function.
-     */
-    description?: string;
-}
-type IdGenerator = () => string;
-/**
-Tool invocations are either tool calls or tool results. For each assistant tool call,
-there is one tool invocation. While the call is in progress, the invocation is a tool call.
-Once the call is complete, the invocation is a tool result.
- */
-type ToolInvocation = ToolCall$1<string, any> | ToolResult<string, any, any>;
-/**
- * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
- */
-interface Message {
-    id: string;
-    createdAt?: Date;
-    content: string;
-    tool_call_id?: string;
-    /**
-  @deprecated Use AI SDK RSC instead: https://sdk.vercel.ai/docs/ai-sdk-rsc
-   */
-    ui?: string | JSX.Element | JSX.Element[] | null | undefined;
-    /**
-     * `function` and `tool` roles are deprecated.
-     */
-    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.
-     */
-    name?: string;
-    /**
-     * @deprecated Use AI SDK 3.1 `toolInvocations` instead.
-     *
-     * 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. (Deprecated and replaced by tool_calls.)
-     */
-    function_call?: string | FunctionCall;
-    data?: JSONValue;
-    /**
-     * @deprecated Use AI SDK 3.1 `toolInvocations` instead.
-     *
-     * 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[];
-    /**
-     * Additional message-specific information added on the server via StreamData
-     */
-    annotations?: JSONValue[] | undefined;
-    /**
-  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
-  that the assistant made as part of this message.
-     */
-    toolInvocations?: Array<ToolInvocation>;
-}
-type CreateMessage = Omit<Message, 'id'> & {
-    id?: Message['id'];
-};
-type ChatRequest = {
-    messages: Message[];
-    options?: RequestOptions;
-    functions?: Array<Function>;
-    function_call?: FunctionCall;
-    data?: Record<string, string>;
-    tools?: Array<Tool>;
-    tool_choice?: ToolChoice;
-};
-/**
- * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
- */
-type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall) => Promise<ChatRequest | void>;
-/**
- * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
- */
-type ToolCallHandler = (chatMessages: Message[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
-type RequestOptions = {
-    /**
-  An optional object of headers to be passed to the API endpoint.
-   */
-    headers?: Record<string, string> | Headers;
-    /**
-  An optional object to be passed to the API endpoint.
-     */
-    body?: object;
-};
-type ChatRequestOptions = {
-    /**
-  The options to be passed to the fetch call.
-     */
-    options?: RequestOptions;
-    /**
-  @deprecated
-  */
-    functions?: Array<Function>;
-    /**
-  @deprecated
-  */
-    function_call?: FunctionCall;
-    /**
-  @deprecated
-  */
-    tools?: Array<Tool>;
-    /**
-  @deprecated
-  */
-    tool_choice?: ToolChoice;
-    /**
-  Additional data to be sent to the server.
-     */
-    data?: Record<string, string>;
-};
-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;
-    /**
-     * 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.
-     */
-    id?: string;
-    /**
-     * Initial messages of the chat. Useful to load an existing chat history.
-     */
-    initialMessages?: Message[];
-    /**
-     * Initial input of the chat.
-     */
-    initialInput?: string;
-    /**
-     * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
-     *
-     * 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;
-    /**
-     * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
-     *
-     * 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;
-    /**
-  Optional callback function that is invoked when a tool call is received.
-  Intended for automatic client-side tool execution.
-  
-  You can optionally return a result for the tool call,
-  either synchronously or asynchronously.
-     */
-    onToolCall?: ({ toolCall, }: {
-        toolCall: ToolCall$1<string, unknown>;
-    }) => void | Promise<unknown> | unknown;
-    /**
-     * Callback function to be called when the API response is received.
-     */
-    onResponse?: (response: Response) => void | Promise<void>;
-    /**
-     * Callback function to be called when the chat is finished streaming.
-     */
-    onFinish?: (message: Message) => void;
-    /**
-     * Callback function to be called when an error is encountered.
-     */
-    onError?: (error: Error) => void;
-    /**
-     * A way to provide a function that is going to be used for ids for messages.
-     * If not provided nanoid is used by default.
-     */
-    generateId?: IdGenerator;
-    /**
-     * 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.
-     */
-    headers?: Record<string, string> | Headers;
-    /**
-     * Extra body object to be sent with the API request.
-     * @example
-     * Send a `sessionId` to the API along with the messages.
-     * ```js
-     * useChat({
-     *   body: {
-     *     sessionId: '123',
-     *   }
-     * })
-     * ```
-     */
-    body?: object;
-    /**
-     * Whether to send extra message fields such as `message.id` and `message.createdAt` to the API.
-     * Defaults to `false`. When set to `true`, the API endpoint might need to
-     * handle the extra fields before forwarding the request to the AI service.
-     */
-    sendExtraMessageFields?: boolean;
-    /** Stream mode (default to "stream-data") */
-    streamMode?: 'stream-data' | 'text';
-};
-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`.
-     */
-    api?: string;
-    /**
-     * An 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.
-     */
-    id?: string;
-    /**
-     * Initial prompt input of the completion.
-     */
-    initialInput?: string;
-    /**
-     * Initial completion result. Useful to load an existing history.
-     */
-    initialCompletion?: string;
-    /**
-     * Callback function to be called when the API response is received.
-     */
-    onResponse?: (response: Response) => void | Promise<void>;
-    /**
-     * Callback function to be called when the completion is finished streaming.
-     */
-    onFinish?: (prompt: string, completion: string) => void;
-    /**
-     * 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.
-     */
-    headers?: Record<string, string> | Headers;
-    /**
-     * Extra body object to be sent with the API request.
-     * @example
-     * Send a `sessionId` to the API along with the prompt.
-     * ```js
-     * useChat({
-     *   body: {
-     *     sessionId: '123',
-     *   }
-     * })
-     * ```
-     */
-    body?: object;
-    /** Stream mode (default to "stream-data") */
-    streamMode?: 'stream-data' | 'text';
-};
-type JSONValue = null | string | number | boolean | {
-    [x: string]: JSONValue;
-} | Array<JSONValue>;
-
 type UseChatHelpers = {
     /** Current messages in the chat */
     messages: Readable<Message[]>;
@@ -459,6 +40,9 @@ type UseChatHelpers = {
     /** Additional data added on the server via StreamData */
     data: Readable<JSONValue[] | undefined>;
 };
+/**
+ * @deprecated Use `useChat` from `@ai-sdk/svelte` instead.
+ */
 declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: UseChatOptions): UseChatHelpers;
 
 type UseCompletionHelpers = {
@@ -495,6 +79,9 @@ type UseCompletionHelpers = {
     /** Additional data added on the server via StreamData */
     data: Readable<JSONValue[] | undefined>;
 };
+/**
+ * @deprecated Use `useCompletion` from `@ai-sdk/svelte` instead.
+ */
 declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamMode, onResponse, onFinish, onError, }?: UseCompletionOptions): UseCompletionHelpers;
 
 type UseAssistantHelpers = {
@@ -542,6 +129,9 @@ type UseAssistantHelpers = {
      */
     error: Readable<undefined | Error>;
 };
+/**
+ * @deprecated Use `useAssistant` from `@ai-sdk/svelte` instead.
+ */
 declare function useAssistant({ api, threadId: threadIdParam, credentials, headers, body, onError, }: UseAssistantOptions): UseAssistantHelpers;
 
-export { CreateMessage, Message, UseAssistantHelpers, UseChatHelpers, UseChatOptions, UseCompletionHelpers, UseCompletionOptions, useAssistant, useChat, useCompletion };
+export { UseAssistantHelpers, UseChatHelpers, UseCompletionHelpers, useAssistant, useChat, useCompletion };