@liveblocks/core 2.25.0-aiprivatebeta1 → 2.25.0-aiprivatebeta11

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { JSONSchema4 } from 'json-schema';
-import { ComponentType } from 'react';
+import { JSONSchema7 } from 'json-schema';
 
 /**
  * Throws an error if multiple copies of a Liveblocks package are being loaded
@@ -3527,7 +3526,6 @@ type ISODateString = Brand<string, "ISODateString">;
 type ChatId = string;
 type MessageId = Brand<`ms_${string}`, "MessageId">;
 type CmdId = Brand<string, "CmdId">;
-type ClientId = Brand<string, "ClientId">;
 type CopilotId = Brand<`co_${string}`, "CopilotId">;
 type ServerAiMsg = ServerCmdResponse | ServerEvent;
 type DefineCmd<CmdName extends string, TRequest, TResponse> = [
@@ -3540,17 +3538,17 @@ type DefineCmd<CmdName extends string, TRequest, TResponse> = [
         cmdId: CmdId;
     } & TResponse>
 ];
-type CommandPair = GetChatsPair | CreateChatPair | DeleteChatPair | GetMessageTreePair | AddUserMessagePair | DeleteMessagePair | ClearChatPair | AskAIPair | AbortAiPair;
+type CommandPair = GetChatsPair | GetOrCreateChatPair | DeleteChatPair | GetMessageTreePair | DeleteMessagePair | ClearChatPair | AskInChatPair | AbortAiPair | SetToolResultPair;
 type ServerCmdResponse<T extends CommandPair = CommandPair> = T[1];
 type GetChatsResponse = ServerCmdResponse<GetChatsPair>;
-type CreateChatResponse = ServerCmdResponse<CreateChatPair>;
+type GetOrCreateChatResponse = ServerCmdResponse<GetOrCreateChatPair>;
 type DeleteChatResponse = ServerCmdResponse<DeleteChatPair>;
 type GetMessageTreeResponse = ServerCmdResponse<GetMessageTreePair>;
-type AddUserMessageResponse = ServerCmdResponse<AddUserMessagePair>;
 type DeleteMessageResponse = ServerCmdResponse<DeleteMessagePair>;
 type ClearChatResponse = ServerCmdResponse<ClearChatPair>;
-type AskAiResponse = ServerCmdResponse<AskAIPair>;
+type AskInChatResponse = ServerCmdResponse<AskInChatPair>;
 type AbortAiResponse = ServerCmdResponse<AbortAiPair>;
+type SetToolResultResponse = ServerCmdResponse<SetToolResultPair>;
 type GetChatsPair = DefineCmd<"get-chats", {
     cursor?: Cursor;
     pageSize?: number;
@@ -3558,12 +3556,15 @@ type GetChatsPair = DefineCmd<"get-chats", {
     chats: AiChat[];
     nextCursor: Cursor | null;
 }>;
-type CreateChatPair = DefineCmd<"create-chat", // XXXX Rename to "upsert-chat"?
-{
+type CreateChatOptions = {
+    /** A human-friendly title for the chat. If not set, it will get auto-generated after the first response. */
+    title?: string;
+    /** Arbitrary metadata to record for this chat. This can be later used to filter the list of chats by metadata. */
+    metadata?: Record<string, string | string[]>;
+};
+type GetOrCreateChatPair = DefineCmd<"get-or-create-chat", {
     id: ChatId;
-    name?: string;
-    ephemeral: boolean;
-    metadata: Record<string, string | string[]>;
+    options?: CreateChatOptions;
 }, {
     chat: AiChat;
 }>;
@@ -3578,14 +3579,6 @@ type GetMessageTreePair = DefineCmd<"get-message-tree", {
     chat: AiChat;
     messages: AiChatMessage[];
 }>;
-type AddUserMessagePair = DefineCmd<"add-user-message", {
-    id: MessageId;
-    chatId: ChatId;
-    parentMessageId: MessageId | null;
-    content: AiUserContentPart[];
-}, {
-    message: AiUserMessage;
-}>;
 type DeleteMessagePair = DefineCmd<"delete-message", {
     chatId: ChatId;
     messageId: MessageId;
@@ -3598,10 +3591,27 @@ type ClearChatPair = DefineCmd<"clear-chat", {
 }, {
     chatId: ChatId;
 }>;
-type AskAIPair = DefineCmd<"ask-ai", {
+type AiGenerationOptions = {
+    /**
+     * The Copilot ID to use for this request. If not provided, a built-in
+     * default Copilot will be used instead of one that you configured via the
+     * dashboard.
+     */
+    copilotId?: CopilotId;
+    stream?: boolean;
+    tools?: AiToolDescription[];
+    knowledge?: AiKnowledgeSource[];
+    timeout?: number;
+};
+type AskInChatPair = DefineCmd<"ask-in-chat", {
     chatId: ChatId;
     /** The chat message to use as the source to create the assistant response. */
-    sourceMessageId: MessageId;
+    sourceMessage: // An existing message ID to reply to
+    MessageId | {
+        id: MessageId;
+        parentMessageId: MessageId | null;
+        content: AiUserContentPart[];
+    };
     /**
      * The new (!) message ID to output the assistant response into. This ID
      * should be a non-existing message ID, optimistically assigned by the
@@ -3609,32 +3619,29 @@ type AskAIPair = DefineCmd<"ask-ai", {
      * message ID.
      */
     targetMessageId: MessageId;
-    /**
-     * The Copilot ID to use for this request. If not provided, a built-in
-     * default Copilot will be used instead of one that you configured via the
-     * dashboard.
-     */
-    copilotId?: CopilotId;
-    /**
-     * A client ID unique to this command. Later delta and settle messages will
-     * reference this client ID, which is important to ensure that tool calls
-     * with side effects will only get executed once, and only by the client
-     * that originally made the request that produced the tool call.
-     */
-    clientId: ClientId;
-    stream: boolean;
-    tools?: AiToolDefinition[];
-    toolChoice?: ToolChoice;
-    context?: AiChatContext[];
-    timeout: number;
+    generationOptions: AiGenerationOptions;
 }, {
-    message: AiChatMessage;
+    sourceMessage?: AiChatMessage;
+    targetMessage: AiChatMessage;
 }>;
 type AbortAiPair = DefineCmd<"abort-ai", {
     messageId: MessageId;
 }, {
     ok: true;
 }>;
+type ToolResultData = Json;
+type SetToolResultPair = DefineCmd<"set-tool-result", {
+    chatId: ChatId;
+    messageId: MessageId;
+    toolCallId: string;
+    result: ToolResultData;
+    generationOptions: AiGenerationOptions;
+}, {
+    ok: true;
+    message: AiChatMessage;
+} | {
+    ok: false;
+}>;
 type ServerEvent = RebootedEvent | CmdFailedEvent | ErrorServerEvent | SyncServerEvent | DeltaServerEvent | SettleServerEvent;
 type RebootedEvent = {
     event: "rebooted";
@@ -3664,8 +3671,6 @@ type SyncServerEvent = {
 type DeltaServerEvent = {
     event: "delta";
     id: MessageId;
-    /** The client ID that originally made the request that led to this event */
-    clientId: ClientId;
     delta: AiAssistantDeltaUpdate;
 };
 /**
@@ -3675,29 +3680,43 @@ type DeltaServerEvent = {
  */
 type SettleServerEvent = {
     event: "settle";
-    /** The client ID that originally made the request that led to this event */
-    clientId: ClientId;
-    message: AiCompletedAssistantMessage | AiFailedAssistantMessage;
+    message: AiAwaitingToolAssistantMessage | AiCompletedAssistantMessage | AiFailedAssistantMessage;
 };
 type AiChat = {
     id: ChatId;
-    name: string;
-    ephemeral: boolean;
+    title: string;
     metadata: Record<string, string | string[]>;
     createdAt: ISODateString;
     lastMessageAt?: ISODateString;
     deletedAt?: ISODateString;
 };
-type AiToolDefinition = {
+type AiToolDescription = {
     name: string;
     description?: string;
-    parameters: JsonObject;
+    parameters: JSONSchema7;
 };
-type AiToolCallPart = {
-    type: "tool-call";
+type AiToolInvocationPart<A extends JsonObject = JsonObject, R extends ToolResultData = ToolResultData> = Relax<AiReceivingToolInvocationPart | AiExecutingToolInvocationPart<A> | AiExecutedToolInvocationPart<A, R>>;
+type AiReceivingToolInvocationPart = {
+    type: "tool-invocation";
+    status: "receiving";
     toolCallId: string;
     toolName: string;
-    args: unknown;
+    partialArgs: Json;
+};
+type AiExecutingToolInvocationPart<A extends JsonObject = JsonObject> = {
+    type: "tool-invocation";
+    status: "executing";
+    toolCallId: string;
+    toolName: string;
+    args: A;
+};
+type AiExecutedToolInvocationPart<A extends JsonObject = JsonObject, R extends ToolResultData = ToolResultData> = {
+    type: "tool-invocation";
+    status: "executed";
+    toolCallId: string;
+    toolName: string;
+    args: A;
+    result: R;
 };
 type AiTextPart = {
     type: "text";
@@ -3717,7 +3736,6 @@ type AiReasoningDelta = Relax<{
 type AiReasoningPart = {
     type: "reasoning";
     text: string;
-    signature?: string;
 };
 type AiUploadedImagePart = {
     type: "image";
@@ -3727,12 +3745,8 @@ type AiUploadedImagePart = {
     mimeType: string;
 };
 type AiUserContentPart = AiTextPart | AiUploadedImagePart;
-type AiAssistantContentPart = AiReasoningPart | AiTextPart | AiToolCallPart;
-type AiAssistantDeltaUpdate = AiAssistantContentPart | AiTextDelta | AiReasoningDelta;
-type ToolChoice = "auto" | "required" | "none" | {
-    type: "tool";
-    toolName: string;
-};
+type AiAssistantContentPart = AiReasoningPart | AiTextPart | AiToolInvocationPart;
+type AiAssistantDeltaUpdate = AiTextDelta | AiReasoningDelta | AiExecutingToolInvocationPart;
 type AiUserMessage = {
     id: MessageId;
     chatId: ChatId;
@@ -3742,63 +3756,178 @@ type AiUserMessage = {
     createdAt: ISODateString;
     deletedAt?: ISODateString;
 };
-type AiAssistantMessage = Relax<AiCompletedAssistantMessage | AiPendingAssistantMessage | AiFailedAssistantMessage>;
-type AiCompletedAssistantMessage = {
+type AiAssistantMessage = Relax<AiGeneratingAssistantMessage | AiAwaitingToolAssistantMessage | AiCompletedAssistantMessage | AiFailedAssistantMessage>;
+type AiGeneratingAssistantMessage = {
     id: MessageId;
     chatId: ChatId;
     parentId: MessageId | null;
     role: "assistant";
-    content: AiAssistantContentPart[];
     createdAt: ISODateString;
     deletedAt?: ISODateString;
-    status: "completed";
+    status: "generating";
+    contentSoFar: AiAssistantContentPart[];
 };
-type AiFailedAssistantMessage = {
+type AiAwaitingToolAssistantMessage = {
     id: MessageId;
     chatId: ChatId;
     parentId: MessageId | null;
     role: "assistant";
     createdAt: ISODateString;
     deletedAt?: ISODateString;
-    status: "failed";
+    status: "awaiting-tool";
     contentSoFar: AiAssistantContentPart[];
-    errorReason: string;
 };
-type AiPendingAssistantMessage = {
+type AiCompletedAssistantMessage = {
+    id: MessageId;
+    chatId: ChatId;
+    parentId: MessageId | null;
+    role: "assistant";
+    content: AiAssistantContentPart[];
+    createdAt: ISODateString;
+    deletedAt?: ISODateString;
+    status: "completed";
+};
+type AiFailedAssistantMessage = {
     id: MessageId;
     chatId: ChatId;
     parentId: MessageId | null;
     role: "assistant";
     createdAt: ISODateString;
     deletedAt?: ISODateString;
-    status: "pending";
+    status: "failed";
     contentSoFar: AiAssistantContentPart[];
+    errorReason: string;
 };
 type AiChatMessage = AiUserMessage | AiAssistantMessage;
-type AiChatContext = {
-    value: string;
+type AiKnowledgeSource = {
     description: string;
+    value: Json;
 };
 
-type ClientToolDefinition = {
+type InferFromSchema<T extends JSONSchema7> = JSONSchema7 extends T ? JsonObject : T extends {
+    type: "object";
+    properties: Record<string, JSONSchema7>;
+    required: readonly string[];
+} ? Resolve<{
+    -readonly [K in keyof T["properties"] as K extends string ? K extends Extract<K, T["required"][number]> ? K : never : never]: InferFromSchema<T["properties"][K]>;
+} & {
+    -readonly [K in keyof T["properties"] as K extends string ? K extends Extract<K, T["required"][number]> ? never : K : never]?: InferFromSchema<T["properties"][K]>;
+}> : T extends {
+    type: "object";
+    properties: Record<string, JSONSchema7>;
+} ? {
+    -readonly [K in keyof T["properties"]]?: InferFromSchema<T["properties"][K]>;
+} : T extends {
+    type: "string" | "number" | "boolean";
+    enum: readonly (infer U)[];
+} ? U : T extends {
+    type: "string";
+} ? string : T extends {
+    type: "number";
+} ? number : T extends {
+    type: "boolean";
+} ? boolean : T extends {
+    type: "null";
+} ? null : T extends {
+    type: "array";
+    items: JSONSchema7;
+} ? InferFromSchema<T["items"]>[] : unknown;
+type AiToolTypePack<A extends JsonObject = JsonObject, R extends ToolResultData = ToolResultData> = {
+    A: A;
+    R: R;
+};
+type AskUserMessageInChatOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
+type SetToolResultOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
+type AiToolInvocationProps<A extends JsonObject, R extends ToolResultData> = Resolve<DistributiveOmit<AiToolInvocationPart<A, R>, "type"> & {
+    respond: (result: R) => void;
+    /**
+     * These are the inferred types for your tool call which you can pass down
+     * to UI components, like so:
+     *
+     *     <AiTool.Confirmation
+     *       types={types}
+     *       confirm={
+     *         // Now fully type-safe!
+     *         (args) => result
+     *       } />
+     *
+     * This will make your AiTool.Confirmation component aware of the types for
+     * `args` and `result`.
+     */
+    types: AiToolTypePack<A, R>;
+    [kInternal]: {
+        execute: AiToolExecuteCallback<A, R> | undefined;
+    };
+}>;
+type AiOpaqueToolInvocationProps = AiToolInvocationProps<JsonObject, ToolResultData>;
+type AiToolExecuteContext = {
+    toolName: string;
+    toolCallId: string;
+};
+type AiToolExecuteCallback<A extends JsonObject, R extends ToolResultData> = (args: A, context: AiToolExecuteContext) => Awaitable<R>;
+type AiToolDefinition<S extends JSONObjectSchema7, A extends JsonObject, R extends ToolResultData> = {
     description?: string;
-    parameters: JSONSchema4;
-    render: ComponentType<{
-        args: any;
-    }>;
-    execute?: never;
+    parameters: S;
+    execute?: AiToolExecuteCallback<A, R>;
+    render?: (props: AiToolInvocationProps<A, R>) => unknown;
 };
+type AiOpaqueToolDefinition = AiToolDefinition<JSONObjectSchema7, JsonObject, ToolResultData>;
+type JSONObjectSchema7 = JSONSchema7 & {
+    type: "object";
+};
+/**
+ * Helper function to help infer the types of `args`, `render`, and `result`.
+ * This function has no runtime implementation and is only needed to make it
+ * possible for TypeScript to infer types.
+ */
+declare function defineAiTool<R extends ToolResultData>(): <const S extends JSONObjectSchema7>(def: AiToolDefinition<S, InferFromSchema<S> extends JsonObject ? InferFromSchema<S> : JsonObject, R>) => AiOpaqueToolDefinition;
 type UiChatMessage = AiChatMessage & {
-    prev: MessageId | null;
-    next: MessageId | null;
+    navigation: {
+        /**
+         * The message ID of the parent message, or null if there is no parent.
+         */
+        parent: MessageId | null;
+        /**
+         * The message ID of the left sibling message, or null if there is no left sibling.
+         */
+        prev: MessageId | null;
+        /**
+         * The message ID of the right sibling message, or null if there is no right sibling.
+         */
+        next: MessageId | null;
+    };
 };
 type UiUserMessage = AiUserMessage & {
-    prev: MessageId | null;
-    next: MessageId | null;
+    navigation: {
+        /**
+         * The message ID of the parent message, or null if there is no parent.
+         */
+        parent: MessageId | null;
+        /**
+         * The message ID of the left sibling message, or null if there is no left sibling.
+         */
+        prev: MessageId | null;
+        /**
+         * The message ID of the right sibling message, or null if there is no right sibling.
+         */
+        next: MessageId | null;
+    };
 };
 type UiAssistantMessage = AiAssistantMessage & {
-    prev: MessageId | null;
-    next: MessageId | null;
+    navigation: {
+        /**
+         * The message ID of the parent message, or null if there is no parent.
+         */
+        parent: MessageId | null;
+        /**
+         * The message ID of the left sibling message, or null if there is no left sibling.
+         */
+        prev: MessageId | null;
+        /**
+         * The message ID of the right sibling message, or null if there is no right sibling.
+         */
+        next: MessageId | null;
+    };
 };
 type AiContext = {
     staticSessionInfoSig: Signal<StaticSessionInfo | null>;
@@ -3810,31 +3939,26 @@ type AiContext = {
     chatsStore: ReturnType<typeof createStore_forUserAiChats>;
     toolsStore: ReturnType<typeof createStore_forTools>;
     messagesStore: ReturnType<typeof createStore_forChatMessages>;
-    contextByChatId: Map<string, Set<AiChatContext>>;
-};
-type CreateChatOptions = {
-    ephemeral?: boolean;
-    metadata?: AiChat["metadata"];
-};
-type AskAiOptions = {
-    copilotId?: CopilotId;
-    stream?: boolean;
-    timeout?: number;
+    knowledge: KnowledgeStack;
 };
+type LayerKey = Brand<string, "LayerKey">;
+declare class KnowledgeStack {
+    #private;
+    constructor();
+    registerLayer(uniqueLayerId: string): LayerKey;
+    deregisterLayer(layerKey: LayerKey): void;
+    get(): AiKnowledgeSource[];
+    invalidate(): void;
+    updateKnowledge(layerKey: LayerKey, key: string, data: AiKnowledgeSource | null): void;
+}
 declare function createStore_forTools(): {
-    getToolCallByNameΣ: (chatId: string, toolName: string) => Signal<ClientToolDefinition | undefined>;
-    getToolsForChat: (chatId: string) => {
-        name: string;
-        definition: ClientToolDefinition;
-    }[];
-    addToolDefinition: (chatId: string, name: string, definition: ClientToolDefinition) => void;
-    removeToolDefinition: (chatId: string, toolName: string) => void;
+    getToolDescriptions: (chatId: string) => AiToolDescription[];
+    getToolΣ: (name: string, chatId?: string) => DerivedSignal<AiOpaqueToolDefinition | undefined>;
+    registerTool: (name: string, tool: AiOpaqueToolDefinition, chatId?: string) => () => void;
 };
-declare function createStore_forChatMessages(): {
+declare function createStore_forChatMessages(toolsStore: ReturnType<typeof createStore_forTools>, setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: SetToolResultOptions) => Promise<SetToolResultResponse>): {
     getMessageById: (messageId: MessageId) => AiChatMessage | undefined;
     getChatMessagesForBranchΣ: (chatId: string, branch?: MessageId) => DerivedSignal<UiChatMessage[]>;
-    getMessagesForChatΣ: (chatId: string) => DerivedSignal<AiChatMessage[]>;
-    getLatestUserMessageAncestor: (chatId: string, messageId: MessageId) => MessageId | null;
     createOptimistically: {
         (chatId: string, role: "user", parentId: MessageId | null, content: AiUserContentPart[]): MessageId;
         (chatId: string, role: "assistant", parentId: MessageId | null): MessageId;
@@ -3845,45 +3969,66 @@ declare function createStore_forChatMessages(): {
     removeByChatId: (chatId: string) => void;
     addDelta: (messageId: MessageId, delta: AiAssistantDeltaUpdate) => void;
     failAllPending: () => void;
+    allowAutoExecuteToolCall(messageId: MessageId): void;
 };
 declare function createStore_forUserAiChats(): {
     chatsΣ: DerivedSignal<AiChat[]>;
+    getChatById: (chatId: string) => AiChat | undefined;
     upsert: (chat: AiChat) => void;
     upsertMany: (chats: AiChat[]) => void;
-    remove: (chatId: string) => void;
+    markDeleted: (chatId: string) => void;
 };
+/** @private This API will change, and is not considered stable. DO NOT RELY on it. */
 type Ai = {
     [kInternal]: {
-        debugContext: () => AiContext;
+        context: AiContext;
     };
     connect: () => void;
     reconnect: () => void;
     disconnect: () => void;
     getStatus: () => Status;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     getChats: (options?: {
         cursor?: Cursor;
     }) => Promise<GetChatsResponse>;
-    createChat: (chatId: string, // A unique identifier
-    name?: string, // A human-friendly "title"
-    options?: CreateChatOptions) => Promise<CreateChatResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    getOrCreateChat: (
+    /** A unique identifier for the chat. */
+    chatId: string, options?: CreateChatOptions) => Promise<GetOrCreateChatResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     deleteChat: (chatId: string) => Promise<DeleteChatResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     getMessageTree: (chatId: string) => Promise<GetMessageTreeResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     deleteMessage: (chatId: string, messageId: MessageId) => Promise<DeleteMessageResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     clearChat: (chatId: string) => Promise<ClearChatResponse>;
-    addUserMessage: (chatId: string, parentMessageId: MessageId | null, message: string) => Promise<AddUserMessageResponse>;
-    ask: (chatId: string, messageId: MessageId, options?: AskAiOptions) => Promise<AskAiResponse>;
-    regenerateMessage: (chatId: string, messageId: MessageId, options?: AskAiOptions) => Promise<AskAiResponse>;
-    addUserMessageAndAsk: (chatId: string, parentMessageId: MessageId | null, message: string, options?: AskAiOptions) => Promise<AskAiResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    askUserMessageInChat: (chatId: string, userMessage: MessageId | {
+        id: MessageId;
+        parentMessageId: MessageId | null;
+        content: AiUserContentPart[];
+    }, targetMessageId: MessageId, options?: AskUserMessageInChatOptions) => Promise<AskInChatResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     abort: (messageId: MessageId) => Promise<AbortAiResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: SetToolResultOptions) => Promise<SetToolResultResponse>;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     signals: {
         chatsΣ: DerivedSignal<AiChat[]>;
         getChatMessagesForBranchΣ(chatId: string, branch?: MessageId): DerivedSignal<UiChatMessage[]>;
-        getMessagesForChatΣ(chatId: string): DerivedSignal<AiChatMessage[]>;
-        getToolDefinitionΣ(chatId: string, toolName: string): Signal<ClientToolDefinition | undefined>;
+        getToolΣ(name: string, chatId?: string): DerivedSignal<AiOpaqueToolDefinition | undefined>;
     };
-    registerChatContext: (chatId: string, data: AiChatContext) => () => void;
-    registerChatTool: (chatId: string, name: string, definition: ClientToolDefinition) => void;
-    unregisterChatTool: (chatId: string, toolName: string) => void;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    getChatById: (chatId: string) => AiChat | undefined;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    registerKnowledgeLayer: (uniqueLayerId: string) => LayerKey;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    deregisterKnowledgeLayer: (layerKey: LayerKey) => void;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    updateKnowledge: (layerKey: LayerKey, data: AiKnowledgeSource, key?: string) => void;
+    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
+    registerTool: (name: string, tool: AiOpaqueToolDefinition, chatId?: string) => () => void;
 };
 
 type CommentBodyParagraphElementArgs = {
@@ -4674,4 +4819,4 @@ declare const CommentsApiError: typeof HttpError;
 /** @deprecated Use HttpError instead. */
 declare const NotificationsApiError: typeof HttpError;
 
-export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiChat, type AiChatContext, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type ClientToolDefinition, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, CommentsApiError, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DE, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type History, type HistoryVersion, HttpError, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, type ManagedPool, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type Resolve, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomNotificationSettings, type RoomStateServerMsg, type RoomSubscriptionSettings, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type URLSafeString, type UiAssistantMessage, type UiChatMessage, type UiUserMessage, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserNotificationSettings, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, getSubscriptionKey, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveUsersInCommentBody, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };
+export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiChat, type AiChatMessage, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, CommentsApiError, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DE, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type History, type HistoryVersion, HttpError, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, type ManagedPool, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type Resolve, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomNotificationSettings, type RoomStateServerMsg, type RoomSubscriptionSettings, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type ToolResultData, type URLSafeString, type UiAssistantMessage, type UiChatMessage, type UiUserMessage, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserNotificationSettings, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, getSubscriptionKey, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveUsersInCommentBody, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };