@butlerbot/sdk 0.0.6-alpha.2 → 0.0.6-alpha.4

package/dist/types/conversation/v2/aisdk_types.d.ts

@@ -0,0 +1,431 @@
+/**
+ * A message that can be used in the `messages` field of a prompt.
+ * It can be a user message, an assistant message, or a tool message.
+ */
+export type ModelMessage = SystemModelMessage | UserModelMessage | AssistantModelMessage | ToolModelMessage;
+type ProviderOptions = Object;
+type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
+type JSONObject = {
+    [key: string]: JSONValue | undefined;
+};
+type JSONArray = JSONValue[];
+/**
+ * A tool message. It contains the result of one or more tool calls.
+ */
+type ToolModelMessage = {
+    role: 'tool';
+    content: ToolContent;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+};
+/**
+ * Content of a tool message. It is an array of tool result parts.
+ */
+type ToolContent = Array<ToolResultPart | ToolApprovalResponse>;
+/**
+ * Tool approval response prompt part.
+ */
+type ToolApprovalResponse = {
+    type: 'tool-approval-response';
+    /**
+     * ID of the tool approval.
+     */
+    approvalId: string;
+    /**
+     * Flag indicating whether the approval was granted or denied.
+     */
+    approved: boolean;
+    /**
+     * Optional reason for the approval or denial.
+     */
+    reason?: string;
+    /**
+     * Flag indicating whether the tool call is provider-executed.
+     * Only provider-executed tool approval responses should be sent to the model.
+     */
+    providerExecuted?: boolean;
+};
+/**
+ * An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
+ */
+type AssistantModelMessage = {
+    role: 'assistant';
+    content: AssistantContent;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+};
+/**
+ * Content of an assistant message.
+ * It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
+ */
+type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart | ToolApprovalRequest>;
+/**
+ * Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
+ */
+interface ToolCallPart {
+    type: 'tool-call';
+    /**
+     * 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: string;
+    /**
+     * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    input: unknown;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+    /**
+     * Whether the tool call was executed by the provider.
+     */
+    providerExecuted?: boolean;
+}
+/**
+ * Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
+ */
+interface ToolResultPart {
+    type: 'tool-result';
+    /**
+     * ID of the tool call that this result is associated with.
+     */
+    toolCallId: string;
+    /**
+     * Name of the tool that generated this result.
+     */
+    toolName: string;
+    /**
+     * Result of the tool call. This is a JSON-serializable object.
+     */
+    output: ToolResultOutput;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+}
+/**
+ * Output of a tool result.
+ */
+type ToolResultOutput = {
+    /**
+     * Text tool output that should be directly sent to the API.
+     */
+    type: 'text';
+    value: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: ProviderOptions;
+} | {
+    type: 'json';
+    value: JSONValue;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: ProviderOptions;
+} | {
+    /**
+     * Type when the user has denied the execution of the tool call.
+     */
+    type: 'execution-denied';
+    /**
+     * Optional reason for the execution denial.
+     */
+    reason?: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: ProviderOptions;
+} | {
+    type: 'error-text';
+    value: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: ProviderOptions;
+} | {
+    type: 'error-json';
+    value: JSONValue;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: ProviderOptions;
+} | {
+    type: 'content';
+    value: Array<{
+        type: 'text';
+        /**
+         * Text content.
+         */
+        text: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        /**
+         * @deprecated Use image-data or file-data instead.
+         */
+        type: 'media';
+        data: string;
+        mediaType: string;
+    } | {
+        type: 'file-data';
+        /**
+         * Base-64 encoded media data.
+         */
+        data: string;
+        /**
+         * IANA media type.
+         * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+         */
+        mediaType: string;
+        /**
+         * Optional filename of the file.
+         */
+        filename?: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        type: 'file-url';
+        /**
+         * URL of the file.
+         */
+        url: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        type: 'file-id';
+        /**
+         * ID of the file.
+         *
+         * If you use multiple providers, you need to
+         * specify the provider specific ids using
+         * the Record option. The key is the provider
+         * name, e.g. 'openai' or 'anthropic'.
+         */
+        fileId: string | Record<string, string>;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using base64 encoded data.
+         */
+        type: 'image-data';
+        /**
+         * Base-64 encoded image data.
+         */
+        data: string;
+        /**
+         * IANA media type.
+         * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+         */
+        mediaType: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using a URL.
+         */
+        type: 'image-url';
+        /**
+         * URL of the image.
+         */
+        url: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using a provider file id.
+         */
+        type: 'image-file-id';
+        /**
+         * Image that is referenced using a provider file id.
+         *
+         * If you use multiple providers, you need to
+         * specify the provider specific ids using
+         * the Record option. The key is the provider
+         * name, e.g. 'openai' or 'anthropic'.
+         */
+        fileId: string | Record<string, string>;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        /**
+         * Custom content part. This can be used to implement
+         * provider-specific content parts.
+         */
+        type: 'custom';
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    }>;
+};
+/**
+ * Tool approval request prompt part.
+ */
+type ToolApprovalRequest = {
+    type: 'tool-approval-request';
+    /**
+     * ID of the tool approval.
+     */
+    approvalId: string;
+    /**
+     * ID of the tool call that the approval request is for.
+     */
+    toolCallId: string;
+};
+/**
+ * Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
+ */
+type DataContent = string | Uint8Array | ArrayBuffer | Buffer;
+/**
+ * A system message. It can contain system information.
+ *
+ * Note: using the "system" part of the prompt is strongly preferred
+ * to increase the resilience against prompt injection attacks,
+ * and because not all providers support several system messages.
+ */
+type SystemModelMessage = {
+    role: 'system';
+    content: string;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+};
+/**
+ * Text content part of a prompt. It contains a string of text.
+ */
+interface TextPart {
+    type: 'text';
+    /**
+     * The text content.
+     */
+    text: string;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+}
+/**
+ * Image content part of a prompt. It contains an image.
+ */
+interface ImagePart {
+    type: 'image';
+    /**
+     * Image data. Can either be:
+     *
+     * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
+     * - URL: a URL that points to the image
+     */
+    image: DataContent | URL;
+    /**
+     * Optional IANA media type of the image.
+     *
+     * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mediaType?: string;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+}
+/**
+ * File content part of a prompt. It contains a file.
+ */
+interface FilePart {
+    type: 'file';
+    /**
+     * File data. Can either be:
+     *
+     * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
+     * - URL: a URL that points to the image
+     */
+    data: DataContent | URL;
+    /**
+     * Optional filename of the file.
+     */
+    filename?: string;
+    /**
+     * IANA media type of the file.
+     *
+     * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mediaType: string;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+}
+/**
+ * Reasoning content part of a prompt. It contains a reasoning.
+ */
+interface ReasoningPart {
+    type: 'reasoning';
+    /**
+     * The reasoning text.
+     */
+    text: string;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+}
+/**
+ * Content of a user message. It can be a string or an array of text and image parts.
+ */
+type UserContent = string | Array<TextPart | ImagePart | FilePart>;
+/**
+ * A user message. It can contain text or a combination of text and images.
+ */
+type UserModelMessage = {
+    role: 'user';
+    content: UserContent;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+};
+export {};

package/dist/types/conversation/v2/aisdk_types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/conversation/v2/conversation_v2.d.ts

@@ -0,0 +1,74 @@
+import { AI_MODEL } from "../../model";
+import { AIResponseV3 } from "../../type_registry";
+import { ModelMessage } from "./aisdk_types";
+export type AIChatProfileProcessedMessageData = {
+    /** A summarized version of this message */
+    summarized?: any;
+};
+export type RawAIChatProfileMessage = (ModelMessage & {
+    etc?: AIChatProfileProcessedMessageData;
+});
+export type AIChatProfileDisplayEntity = {
+    name?: string;
+    avatarUrl?: string;
+};
+export type BaseUserResponseMetadata = {
+    /** Epoch time for when this happened */
+    timestamp: number;
+};
+export type AIChatDialogueAdditional = {
+    from: "assistant" | "user";
+} & AIChatProfileDisplayEntity;
+export type AIChatDialogueMessage = ((AIResponseV3 & AIChatDialogueAdditional) | ({
+    type: "message";
+    payload: {
+        message: string;
+    };
+    metadata: BaseUserResponseMetadata;
+} & AIChatDialogueAdditional));
+export type AIChatProfile = {
+    settings: {
+        /** The AI model to use */
+        model?: AI_MODEL;
+        /** The profile's system prompt */
+        system?: string;
+        /** The location where this chat is taking place, e.g discord, brain, discord_agent, etc. Used for logging purposes */
+        location?: string;
+        /** The temperature of the AI, 0 to 1 */
+        temperature?: number;
+        /**
+         * The instructions that appears due to the current location, e.g website might have 'use markdown' while discord might have 'use discord formatting'
+         * It's simply appended to the system prompt later, the reason it's seperate is because the location instructions can change for the same chat over time
+        **/
+        locationInstructions?: string;
+        /** The chat's title */
+        title?: string;
+        /** Whether to disable auto title generation */
+        disableAutoTitle?: boolean;
+        /** Enable token-caching */
+        tokenCaching?: boolean;
+    };
+    /** Summary information for this conversation */
+    summary?: {
+        /** Very short summary, like a single sentence */
+        shortSummary?: string;
+        /** Longer summmary, few sentences */
+        longSummary?: string;
+    };
+    /** The raw dialogue messages */
+    messages: RawAIChatProfileMessage[];
+    /** The user's prompt and the responses generated by the AI model and sent to the user */
+    dialogue: AIChatDialogueMessage[];
+    /** Overwrite the default user's name and avatar, useful if the messages was sent on the user's behalf by a different entity */
+    defaultDisplayUser?: AIChatProfileDisplayEntity;
+    /** Overwrite the default AI's name and avatar, useful if the messages was sent on the AI's behalf by a different entity */
+    defaultDisplayAssistant?: AIChatProfileDisplayEntity;
+};
+export interface ConversationV2 {
+    version: "2.0";
+    conversationId: string;
+    ownerUserId: string;
+    /** Whether to disable the ability for the user to view this conversation */
+    disableView?: boolean;
+    profile: AIChatProfile;
+}

package/dist/types/conversation/v2/conversation_v2.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/conversation/v2/index.d.ts

@@ -0,0 +1 @@
+export * from "./conversation_v2";

package/dist/types/conversation/v2/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./conversation_v2"), exports);