@xsai/shared-chat 0.3.5 → 0.4.0-beta.10

package/dist/index.d.ts

@@ -1,75 +1,88 @@
-import { CommonRequestOptions } from '@xsai/shared';
+import { WithUnknown, CommonRequestOptions } from '@xsai/shared';
 
 type FinishReason = 'content_filter' | 'error' | 'length' | 'other' | 'stop' | 'tool-calls' | (string & {});
 
-interface AudioBase64 {
-    /**
-     * Base64 encoded audio data.
-     */
-    data: string;
-    format: 'mp3' | 'wav';
-}
-interface AudioPart extends CommonPart<'input_audio'> {
-    input_audio: AudioBase64;
-}
-interface CommonPart<T extends string> {
-    type: T;
+interface AudioContentPart {
+    input_audio: {
+        data: string;
+        format: 'mp3' | 'wav';
+    };
+    type: 'input_audio';
 }
-interface ImagePart extends CommonPart<'image_url'> {
-    image_url: ImageURLorBase64;
+/** @internal */
+type CommonContentPart = AudioContentPart | FileContentPart | ImageContentPart | TextContentPart;
+interface FileContentPart {
+    file: {
+        file_data?: string;
+        file_id?: string;
+        filename?: string;
+    };
+    type: 'file';
 }
-interface ImageURLorBase64 {
-    /**
-     * Specifies the detail level of the image.
-     */
-    detail?: 'auto' | 'high' | 'low';
-    /**
-     * Either a URL of the image or the base64 encoded image data.
-     */
-    url: string;
+interface ImageContentPart {
+    image_url: {
+        detail?: 'auto' | 'high' | 'low';
+        url: string;
+    };
+    type: 'image_url';
 }
-type Part = AudioPart | ImagePart | RefusalPart | TextPart;
-interface RefusalPart extends CommonPart<'refusal'> {
+interface RefusalContentPart {
     refusal: string;
+    type: 'refusal';
 }
-interface TextPart extends CommonPart<'text'> {
+interface TextContentPart {
     text: string;
+    type: 'text';
 }
 
-interface AssistantMessage extends Optional<CommonMessage<'assistant', AssistantMessagePart>, 'content'> {
-    refusal?: null | string;
-    tool_calls?: ToolCall[];
+interface ToolCall {
+    function: ToolCallFunction | ToolCallFunctionWithoutArguments | ToolCallFunctionWithoutName;
+    id: string;
+    type: 'function';
 }
-type AssistantMessagePart = RefusalPart | TextPart;
-interface AssistantMessageResponse extends Omit<AssistantMessage, 'content'> {
-    content?: string;
+interface ToolCallFunction {
+    arguments: string;
+    name: string;
 }
-interface CommonMessage<T extends string, P extends Part> {
-    content: Array<P> | string;
+interface ToolCallFunctionWithoutArguments {
+    arguments?: never;
+    name: string;
+}
+interface ToolCallFunctionWithoutName {
+    arguments: string;
+    name?: never;
+}
+
+interface AssistantMessage {
+    content?: (RefusalContentPart | TextContentPart)[] | string;
     name?: string;
-    role: T;
+    refusal?: string;
+    role: 'assistant';
+    tool_calls?: ToolCall[];
 }
-type Message = AssistantMessage | SystemMessage | ToolMessage | UserMessage;
-interface SystemMessage extends CommonMessage<'system', SystemMessagePart> {
+interface DeveloperMessage {
+    content: string | TextContentPart[];
+    name?: string;
+    /** @remarks Before using, confirm that your model supports this. */
+    role: 'developer';
 }
-type SystemMessagePart = TextPart;
-interface ToolCall {
-    function: {
-        arguments: string;
-        name: string;
-    };
-    id: string;
-    index: number;
-    type: 'function';
+type Message = AssistantMessage | DeveloperMessage | SystemMessage | ToolMessage | UserMessage;
+interface SystemMessage {
+    content: string | TextContentPart[];
+    name?: string;
+    role: 'system';
 }
-interface ToolMessage extends Omit<CommonMessage<'tool', ToolMessagePart>, 'name'> {
+interface ToolMessage {
+    /** @remarks considering the support of ecosystems (such as MCP), we have relaxed this type. */
+    content: CommonContentPart[] | string;
+    role: 'tool';
     tool_call_id: string;
 }
-type ToolMessagePart = AudioPart | ImagePart | TextPart;
-interface UserMessage extends CommonMessage<'user', UserMessagePart> {
+interface UserMessage {
+    content: CommonContentPart[] | string;
+    name?: string;
+    role: 'user';
 }
-type UserMessagePart = AudioPart | ImagePart | TextPart;
-type Optional<T, K extends keyof T> = Omit<T, K> & Pick<Partial<T>, K>;
 
 interface CompletionToolCall {
     args: string;
@@ -79,7 +92,7 @@ interface CompletionToolCall {
 }
 interface CompletionToolResult {
     args: Record<string, unknown>;
-    result: string | ToolMessagePart[];
+    result: ToolMessage['content'];
     toolCallId: string;
     toolName: string;
 }
@@ -119,16 +132,22 @@ type CompletionStep<T extends boolean = false> = (T extends true ? {
 };
 type CompletionStepType = 'continue' | 'done' | 'initial' | 'tool-result';
 
-type ToolChoice = 'auto' | 'none' | 'required' | {
+type ToolChoice = AllowedTools | ToolChoiceMode | ToolChoiceTool;
+interface AllowedTools {
+    mode: 'auto' | 'required';
+    tools: ToolChoiceTool[];
+    type: 'allowed_tools';
+}
+type ToolChoiceMode = 'auto' | 'none' | 'required';
+interface ToolChoiceTool {
     function: {
         name: string;
     };
     type: 'function';
-};
+}
 
 /** @see {@link https://platform.openai.com/docs/api-reference/chat/create} */
 interface ChatOptions extends CommonRequestOptions {
-    [key: string]: unknown;
     /**
      * number between -2.0 and 2.0.
      * @default 0
@@ -153,7 +172,7 @@ interface ChatOptions extends CommonRequestOptions {
     /** @default 1 */
     topP?: number;
 }
-declare const chat: <T extends ChatOptions>(options: T) => Promise<Response>;
+declare const chat: <T extends WithUnknown<ChatOptions>>(options: T) => Promise<Response>;
 
 interface DetermineStepTypeOptions {
     finishReason: FinishReason;
@@ -177,4 +196,5 @@ interface ExecuteToolResult {
 }
 declare const executeTool: ({ abortSignal, messages, toolCall, tools }: ExecuteToolOptions) => Promise<ExecuteToolResult>;
 
-export { type AssistantMessage, type AssistantMessagePart, type AssistantMessageResponse, type AudioBase64, type AudioPart, type ChatOptions, type CommonMessage, type CommonPart, type CompletionStep, type CompletionStepType, type CompletionToolCall, type CompletionToolResult, type DetermineStepTypeOptions, type ExecuteToolOptions, type ExecuteToolResult, type FinishReason, type ImagePart, type ImageURLorBase64, type Message, type Part, type RefusalPart, type SystemMessage, type SystemMessagePart, type TextPart, type Tool, type ToolCall, type ToolChoice, type ToolExecuteOptions, type ToolExecuteResult, type ToolMessage, type ToolMessagePart, type Usage, type UserMessage, type UserMessagePart, chat, determineStepType, executeTool };
+export { chat, determineStepType, executeTool };
+export type { AssistantMessage, AudioContentPart, ChatOptions, CommonContentPart, CompletionStep, CompletionStepType, CompletionToolCall, CompletionToolResult, DetermineStepTypeOptions, DeveloperMessage, ExecuteToolOptions, ExecuteToolResult, FileContentPart, FinishReason, ImageContentPart, Message, RefusalContentPart, SystemMessage, TextContentPart, Tool, ToolCall, ToolChoice, ToolExecuteOptions, ToolExecuteResult, ToolMessage, Usage, UserMessage };

package/dist/index.js

@@ -35,7 +35,7 @@ const wrapToolResult = (result) => {
   if (typeof result === "string")
     return result;
   if (Array.isArray(result)) {
-    if (result.every((item) => !!(typeof item === "object" && "type" in item && ["audio", "image", "text"].includes(item.type)))) {
+    if (result.every((item) => !!(typeof item === "object" && "type" in item && ["file", "image_url", "input_audio", "text"].includes(item.type)))) {
       return result;
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xsai/shared-chat",
   "type": "module",
-  "version": "0.3.5",
+  "version": "0.4.0-beta.10",
   "description": "extra-small AI SDK.",
   "author": "Moeru AI",
   "license": "MIT",
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@xsai/shared": "~0.3.5"
+    "@xsai/shared": "~0.4.0-beta.10"
   },
   "scripts": {
     "build": "pkgroll"