@lingya-ai/agents-sdk 0.3.0 → 0.5.0

package/dist/bound.js

@@ -33,12 +33,12 @@ var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _ar
     function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LingyaWorkspaceApi = exports.LingyaKnowledgeApi = exports.LingyaFilesApi = exports.LingyaInteractionsApi = exports.LingyaEventsApi = exports.LingyaMessagesApi = exports.LingyaSqlApi = exports.LingyaConversationsApi = exports.LingyaChatApi = exports.LingyaConfigurationApi = exports.LingyaAgentsLowLevelApis = void 0;
+exports.LingyaWorkspaceApi = exports.LingyaKnowledgeApi = exports.LingyaFilesApi = exports.LingyaInteractionsApi = exports.LingyaEventsApi = exports.LingyaMessagesApi = exports.LingyaSqlApi = exports.LingyaConversationsApi = exports.LingyaChatApi = exports.LingyaConfigurationApi = exports.LingyaAgentsLowLevelApis = exports.WorkspaceApi = exports.KnowledgeApi = exports.FilesApi = exports.InteractionsApi = exports.EventsApi = exports.MessagesApi = exports.SqlApi = exports.ConversationsApi = exports.ChatApi = exports.ConfigurationApi = exports.AgentsLowLevelApis = void 0;
 const ChatStreamProbeEvent_1 = require("./models/ChatStreamProbeEvent");
 const events_1 = require("./events");
 const sse_1 = require("./sse");
 /** Generated APIs retained as an explicit compatibility escape hatch until 1.0. */
-class LingyaAgentsLowLevelApis {
+class AgentsLowLevelApis {
     constructor(configuration, chat, conversations, sql, messages, events, interactions, files, knowledge, workspace) {
         this.configuration = configuration;
         this.chat = chat;
@@ -52,9 +52,10 @@ class LingyaAgentsLowLevelApis {
         this.workspace = workspace;
     }
 }
-exports.LingyaAgentsLowLevelApis = LingyaAgentsLowLevelApis;
+exports.AgentsLowLevelApis = AgentsLowLevelApis;
+exports.LingyaAgentsLowLevelApis = AgentsLowLevelApis;
 /** Channel-bound configuration operations for one external user. */
-class LingyaConfigurationApi {
+class ConfigurationApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -77,9 +78,10 @@ class LingyaConfigurationApi {
         return this.delegate.getConversationConfig({ channelId: this.channelId, conversationId });
     }
 }
-exports.LingyaConfigurationApi = LingyaConfigurationApi;
+exports.ConfigurationApi = ConfigurationApi;
+exports.LingyaConfigurationApi = ConfigurationApi;
 /** Channel-bound chat operations for one external user. */
-class LingyaChatApi {
+class ChatApi {
     constructor(channelId, delegate, rawRequest) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -183,9 +185,10 @@ class LingyaChatApi {
         return this.delegate.compactConversation(Object.assign({ channelId: this.channelId, conversationId }, options));
     }
 }
-exports.LingyaChatApi = LingyaChatApi;
+exports.ChatApi = ChatApi;
+exports.LingyaChatApi = ChatApi;
 /** Channel-bound conversations operations for one external user. */
-class LingyaConversationsApi {
+class ConversationsApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -319,9 +322,10 @@ class LingyaConversationsApi {
         return this.delegate.revokeConversationShare({ channelId: this.channelId, conversationId, shareId });
     }
 }
-exports.LingyaConversationsApi = LingyaConversationsApi;
+exports.ConversationsApi = ConversationsApi;
+exports.LingyaConversationsApi = ConversationsApi;
 /** Channel-bound sql operations for one external user. */
-class LingyaSqlApi {
+class SqlApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -362,9 +366,10 @@ class LingyaSqlApi {
         });
     }
 }
-exports.LingyaSqlApi = LingyaSqlApi;
+exports.SqlApi = SqlApi;
+exports.LingyaSqlApi = SqlApi;
 /** Channel-bound messages operations for one external user. */
-class LingyaMessagesApi {
+class MessagesApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -399,6 +404,16 @@ class LingyaMessagesApi {
     listConversationAsyncTasks(conversationId, options = {}) {
         return this.delegate.listConversationAsyncTasks(Object.assign({ channelId: this.channelId, conversationId }, options));
     }
+    /**
+     * 增量同步异步任务 / Sync asynchronous task updates
+     *
+     * @param conversationId - 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
+     * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
+     */
+    syncConversationAsyncTasks(conversationId, options = {}) {
+        return this.delegate.syncConversationAsyncTasks(Object.assign({ channelId: this.channelId, conversationId }, options));
+    }
     /**
      * 读取异步任务 / Get an asynchronous task
      *
@@ -409,6 +424,56 @@ class LingyaMessagesApi {
     getConversationAsyncTask(conversationId, asyncTaskId) {
         return this.delegate.getConversationAsyncTask({ channelId: this.channelId, conversationId, asyncTaskId });
     }
+    /**
+     * 分页查询子 Agent 任务 / List subagent tasks
+     *
+     * @param conversationId - 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
+     * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
+     */
+    listConversationSubagents(conversationId, options = {}) {
+        return this.delegate.listConversationSubagents(Object.assign({ channelId: this.channelId, conversationId }, options));
+    }
+    /**
+     * 增量同步子 Agent 状态 / Sync subagent task updates
+     *
+     * @param conversationId - 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
+     * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
+     */
+    syncConversationSubagents(conversationId, options = {}) {
+        return this.delegate.syncConversationSubagents(Object.assign({ channelId: this.channelId, conversationId }, options));
+    }
+    /**
+     * 读取子 Agent 状态 / Get a subagent task
+     *
+     * @param conversationId - 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     * @param subagentTaskId - 子 Agent 任务 ID。 / Subagent task ID.
+     * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
+     */
+    getConversationSubagent(conversationId, subagentTaskId) {
+        return this.delegate.getConversationSubagent({ channelId: this.channelId, conversationId, subagentTaskId });
+    }
+    /**
+     * 取消子 Agent 任务 / Cancel a subagent task
+     *
+     * @param conversationId - 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     * @param subagentTaskId - 子 Agent 任务 ID。 / Subagent task ID.
+     * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
+     */
+    cancelConversationSubagent(conversationId, subagentTaskId) {
+        return this.delegate.cancelConversationSubagent({ channelId: this.channelId, conversationId, subagentTaskId });
+    }
+    /**
+     * 读取子 Agent 结果 / Get a subagent result
+     *
+     * @param conversationId - 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     * @param subagentTaskId - 子 Agent 任务 ID。 / Subagent task ID.
+     * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
+     */
+    getConversationSubagentResult(conversationId, subagentTaskId) {
+        return this.delegate.getConversationSubagentResult({ channelId: this.channelId, conversationId, subagentTaskId });
+    }
     /**
      * 取消排队消息 / Cancel a queued message
      *
@@ -420,9 +485,10 @@ class LingyaMessagesApi {
         return this.delegate.cancelQueuedMessage({ channelId: this.channelId, conversationId, messageId });
     }
 }
-exports.LingyaMessagesApi = LingyaMessagesApi;
+exports.MessagesApi = MessagesApi;
+exports.LingyaMessagesApi = MessagesApi;
 /** Channel-bound events operations for one external user. */
-class LingyaEventsApi {
+class EventsApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -446,9 +512,10 @@ class LingyaEventsApi {
         return this.delegate.getChatEventsBatch({ channelId: this.channelId, aiChatEventsBatchInput: input });
     }
 }
-exports.LingyaEventsApi = LingyaEventsApi;
+exports.EventsApi = EventsApi;
+exports.LingyaEventsApi = EventsApi;
 /** Channel-bound interactions operations for one external user. */
-class LingyaInteractionsApi {
+class InteractionsApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -491,9 +558,10 @@ class LingyaInteractionsApi {
         return this.delegate.answerUserInput({ channelId: this.channelId, userInputAnswerInput: input });
     }
 }
-exports.LingyaInteractionsApi = LingyaInteractionsApi;
+exports.InteractionsApi = InteractionsApi;
+exports.LingyaInteractionsApi = InteractionsApi;
 /** Channel-bound files operations for one external user. */
-class LingyaFilesApi {
+class FilesApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -556,9 +624,10 @@ class LingyaFilesApi {
         return this.delegate.getPlanIntermediateFilePreview({ channelId: this.channelId, conversationId, messageId, fileId });
     }
 }
-exports.LingyaFilesApi = LingyaFilesApi;
+exports.FilesApi = FilesApi;
+exports.LingyaFilesApi = FilesApi;
 /** Channel-bound knowledge operations for one external user. */
-class LingyaKnowledgeApi {
+class KnowledgeApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -583,9 +652,10 @@ class LingyaKnowledgeApi {
         return this.delegate.getCitationMetadata({ channelId: this.channelId, citationType, referenceId });
     }
 }
-exports.LingyaKnowledgeApi = LingyaKnowledgeApi;
+exports.KnowledgeApi = KnowledgeApi;
+exports.LingyaKnowledgeApi = KnowledgeApi;
 /** Channel-bound workspace operations for one external user. */
-class LingyaWorkspaceApi {
+class WorkspaceApi {
     constructor(channelId, delegate) {
         this.channelId = channelId;
         this.delegate = delegate;
@@ -611,4 +681,5 @@ class LingyaWorkspaceApi {
         return this.delegate.getWorkspaceFilePreview(Object.assign({ channelId: this.channelId, conversationId }, options));
     }
 }
-exports.LingyaWorkspaceApi = LingyaWorkspaceApi;
+exports.WorkspaceApi = WorkspaceApi;
+exports.LingyaWorkspaceApi = WorkspaceApi;

package/dist/client.d.ts

@@ -1,13 +1,13 @@
 import { Configuration } from './runtime';
 import { type OpenApiCredentials } from './hmac';
-import { type LingyaAiChatBriefEvent } from './events';
-import { LingyaAgentsLowLevelApis, LingyaChatApi, LingyaConfigurationApi, LingyaConversationsApi, LingyaEventsApi, LingyaFilesApi, LingyaInteractionsApi, LingyaKnowledgeApi, LingyaMessagesApi, LingyaSqlApi, LingyaWorkspaceApi } from './bound';
+import { type AiChatBriefEvent } from './events';
+import { AgentsLowLevelApis, ChatApi as BoundChatApi, ConfigurationApi as BoundConfigurationApi, ConversationsApi as BoundConversationsApi, EventsApi as BoundEventsApi, FilesApi as BoundFilesApi, InteractionsApi as BoundInteractionsApi, KnowledgeApi as BoundKnowledgeApi, MessagesApi as BoundMessagesApi, SqlApi, WorkspaceApi as BoundWorkspaceApi } from './bound';
 /**
  * Lingya Agents SDK 入口，仅适用于可信服务端。 / Server-side Lingya Agents SDK entry point.
  *
  * 客户端保存 channel 范围的凭证，但只有 [forUser] 创建的用户客户端可以发起请求。
  */
-export declare class LingyaAgentsClient {
+export declare class AgentsClient {
     private readonly baseUrl;
     readonly channelId: string;
     private readonly credentials;
@@ -25,39 +25,39 @@ export declare class LingyaAgentsClient {
      * @param externalUserId - 调用方系统的稳定用户 ID，UTF-8 编码后为 1..256 字节且不能含 NUL。
      * @returns 注入用户身份并可调用全部契约 API 的客户端。
      */
-    forUser(externalUserId: string): LingyaAgentsUserClient;
+    forUser(externalUserId: string): AgentsUserClient;
 }
 /** 已绑定外部用户的强类型 API 集合。 / Strongly typed API collection bound to one external user. */
-export declare class LingyaAgentsUserClient {
+export declare class AgentsUserClient {
     readonly channelId: string;
     private readonly signedFetch;
     private readonly baseUrl;
     /** 发起新聊天和流探针。 / Starts chats and stream probes. */
-    readonly chat: LingyaChatApi;
+    readonly chat: BoundChatApi;
     /** 读取 Agent 与会话配置。 / Reads Agent and conversation configuration. */
-    readonly configuration: LingyaConfigurationApi;
+    readonly configuration: BoundConfigurationApi;
     /** 管理会话、状态、分享和异步任务。 / Manages conversations, status, shares, and async tasks. */
-    readonly conversations: LingyaConversationsApi;
+    readonly conversations: BoundConversationsApi;
     /** 查询已持久化事件。 / Reads persisted events. */
-    readonly events: LingyaEventsApi;
+    readonly events: BoundEventsApi;
     /** 管理附件与预签名 URL。 / Manages attachments and pre-signed URLs. */
-    readonly files: LingyaFilesApi;
+    readonly files: BoundFilesApi;
     /** 回答用户问题并处理计划审批。 / Handles user answers and plan approval. */
-    readonly interactions: LingyaInteractionsApi;
+    readonly interactions: BoundInteractionsApi;
     /** 查询引用元数据。 / Reads citation metadata. */
-    readonly knowledge: LingyaKnowledgeApi;
+    readonly knowledge: BoundKnowledgeApi;
     /** 查询消息并控制排队消息。 / Reads messages and controls queued messages. */
-    readonly messages: LingyaMessagesApi;
+    readonly messages: BoundMessagesApi;
     /** 查询、导出 SQL 结果与图表数据。 / Reads and exports SQL results and chart data. */
-    readonly sql: LingyaSqlApi;
+    readonly sql: SqlApi;
     /** 查询工作区文件及预览。 / Reads workspace files and previews. */
-    readonly workspace: LingyaWorkspaceApi;
+    readonly workspace: BoundWorkspaceApi;
     /**
      * 兼容旧版本的原始生成 API；正常业务调用应使用绑定门面。 / Raw generated APIs retained for migration only.
      *
      * @deprecated 将在 1.0 移除。 / Scheduled for removal in 1.0.
      */
-    readonly lowLevel: LingyaAgentsLowLevelApis;
+    readonly lowLevel: AgentsLowLevelApis;
     constructor(channelId: string, configuration: Configuration, signedFetch: typeof fetch, baseUrl: string);
     /**
      * 调用契约端点并按指定类型返回 JSON；优先使用上方生成的强类型 API。 / Calls a contract endpoint and decodes typed JSON.
@@ -67,7 +67,7 @@ export declare class LingyaAgentsUserClient {
      * @param bodyJson - 最终发送并参与签名的 UTF-8 JSON 字符串；无请求体时省略。
      * @param query - 已按最终顺序组装的查询参数，允许重复键。
      * @returns 调用方指定的响应类型。
-     * @throws [LingyaApiError] 当服务端返回非 2xx 状态。
+     * @throws [ApiError] 当服务端返回非 2xx 状态。
      */
     /** @deprecated 使用对应的业务分组方法。 / Use the matching grouped facade operation. */
     request<T>(method: string, suffix: string, bodyJson?: string, query?: URLSearchParams): Promise<T>;
@@ -100,7 +100,7 @@ export declare class LingyaAgentsUserClient {
      * @returns 支持取消的异步事件序列；未知 type 保留 `rawJson`。
      */
     /** @deprecated 使用 `chat.streamChatEvents(conversationId, { messageId })`。 / Use the channel-bound chat facade. */
-    streamChatEvents(conversationId: string, messageId: string): AsyncGenerator<LingyaAiChatBriefEvent>;
+    streamChatEvents(conversationId: string, messageId: string): AsyncGenerator<AiChatBriefEvent>;
     /**
      * 发送底层受控请求；调用前固定最终 path、query、Content-Type 与 body 字节。 / Sends an exactly signed low-level request.
      *
@@ -112,16 +112,22 @@ export declare class LingyaAgentsUserClient {
      * @param query - 最终查询参数；顺序和重复键均参与签名。
      * @param accept - 精确的 Accept 值，例如 `application/json`、`text/event-stream` 或 `text/csv`。
      * @returns 成功的原始 Fetch Response。
-     * @throws [LingyaApiError] 当服务端返回非 2xx 状态。
+     * @throws [ApiError] 当服务端返回非 2xx 状态。
      */
     /** @deprecated 使用 `lowLevel`，或使用对应的业务分组方法。 / Use `lowLevel` or a grouped facade operation. */
     rawRequest(method: string, suffix: string, bodyJson?: string, query?: URLSearchParams, accept?: string, requestId?: string): Promise<Response>;
 }
 /** 不含凭证的 HTTP 错误。 / HTTP failure that never includes credentials. */
-export declare class LingyaApiError extends Error {
+export declare class ApiError extends Error {
     readonly method: string;
     readonly path: string;
     readonly status: number;
     readonly responseBody: string;
     constructor(method: string, path: string, status: number, responseBody: string);
 }
+/** @deprecated Use [AgentsClient]. */
+export { AgentsClient as LingyaAgentsClient };
+/** @deprecated Use [AgentsUserClient]. */
+export { AgentsUserClient as LingyaAgentsUserClient };
+/** @deprecated Use [ApiError]. */
+export { ApiError as LingyaApiError };

package/dist/client.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LingyaApiError = exports.LingyaAgentsUserClient = exports.LingyaAgentsClient = void 0;
+exports.LingyaApiError = exports.LingyaAgentsUserClient = exports.LingyaAgentsClient = exports.ApiError = exports.AgentsUserClient = exports.AgentsClient = void 0;
 const runtime_1 = require("./runtime");
 const apis_1 = require("./apis");
 const hmac_1 = require("./hmac");
@@ -19,7 +19,7 @@ const bound_1 = require("./bound");
  *
  * 客户端保存 channel 范围的凭证，但只有 [forUser] 创建的用户客户端可以发起请求。
  */
-class LingyaAgentsClient {
+class AgentsClient {
     /**
      * 创建 channel 范围的客户端。 / Creates a channel-scoped client.
      *
@@ -43,12 +43,13 @@ class LingyaAgentsClient {
     forUser(externalUserId) {
         const signedFetch = (0, hmac_1.createSignedFetch)(this.credentials, externalUserId);
         const configuration = new runtime_1.Configuration({ basePath: this.baseUrl.replace(/\/+$/, ''), fetchApi: signedFetch });
-        return new LingyaAgentsUserClient(this.channelId, configuration, signedFetch, this.baseUrl);
+        return new AgentsUserClient(this.channelId, configuration, signedFetch, this.baseUrl);
     }
 }
-exports.LingyaAgentsClient = LingyaAgentsClient;
+exports.AgentsClient = AgentsClient;
+exports.LingyaAgentsClient = AgentsClient;
 /** 已绑定外部用户的强类型 API 集合。 / Strongly typed API collection bound to one external user. */
-class LingyaAgentsUserClient {
+class AgentsUserClient {
     constructor(channelId, configuration, signedFetch, baseUrl) {
         this.channelId = channelId;
         this.signedFetch = signedFetch;
@@ -63,18 +64,18 @@ class LingyaAgentsUserClient {
         const messages = new apis_1.MessagesApi(configuration);
         const sql = new apis_1.SQLApi(configuration);
         const workspace = new apis_1.WorkspaceApi(configuration);
-        this.lowLevel = new bound_1.LingyaAgentsLowLevelApis(configurationApi, chat, conversations, sql, messages, events, interactions, files, knowledge, workspace);
+        this.lowLevel = new bound_1.AgentsLowLevelApis(configurationApi, chat, conversations, sql, messages, events, interactions, files, knowledge, workspace);
         const rawRequest = this.rawRequest.bind(this);
-        this.chat = new bound_1.LingyaChatApi(channelId, chat, rawRequest);
-        this.configuration = new bound_1.LingyaConfigurationApi(channelId, configurationApi);
-        this.conversations = new bound_1.LingyaConversationsApi(channelId, conversations);
-        this.events = new bound_1.LingyaEventsApi(channelId, events);
-        this.files = new bound_1.LingyaFilesApi(channelId, files);
-        this.interactions = new bound_1.LingyaInteractionsApi(channelId, interactions);
-        this.knowledge = new bound_1.LingyaKnowledgeApi(channelId, knowledge);
-        this.messages = new bound_1.LingyaMessagesApi(channelId, messages);
-        this.sql = new bound_1.LingyaSqlApi(channelId, sql);
-        this.workspace = new bound_1.LingyaWorkspaceApi(channelId, workspace);
+        this.chat = new bound_1.ChatApi(channelId, chat, rawRequest);
+        this.configuration = new bound_1.ConfigurationApi(channelId, configurationApi);
+        this.conversations = new bound_1.ConversationsApi(channelId, conversations);
+        this.events = new bound_1.EventsApi(channelId, events);
+        this.files = new bound_1.FilesApi(channelId, files);
+        this.interactions = new bound_1.InteractionsApi(channelId, interactions);
+        this.knowledge = new bound_1.KnowledgeApi(channelId, knowledge);
+        this.messages = new bound_1.MessagesApi(channelId, messages);
+        this.sql = new bound_1.SqlApi(channelId, sql);
+        this.workspace = new bound_1.WorkspaceApi(channelId, workspace);
     }
     /**
      * 调用契约端点并按指定类型返回 JSON；优先使用上方生成的强类型 API。 / Calls a contract endpoint and decodes typed JSON.
@@ -84,7 +85,7 @@ class LingyaAgentsUserClient {
      * @param bodyJson - 最终发送并参与签名的 UTF-8 JSON 字符串；无请求体时省略。
      * @param query - 已按最终顺序组装的查询参数，允许重复键。
      * @returns 调用方指定的响应类型。
-     * @throws [LingyaApiError] 当服务端返回非 2xx 状态。
+     * @throws [ApiError] 当服务端返回非 2xx 状态。
      */
     /** @deprecated 使用对应的业务分组方法。 / Use the matching grouped facade operation. */
     request(method, suffix, bodyJson, query) {
@@ -145,7 +146,7 @@ class LingyaAgentsUserClient {
      * @param query - 最终查询参数；顺序和重复键均参与签名。
      * @param accept - 精确的 Accept 值，例如 `application/json`、`text/event-stream` 或 `text/csv`。
      * @returns 成功的原始 Fetch Response。
-     * @throws [LingyaApiError] 当服务端返回非 2xx 状态。
+     * @throws [ApiError] 当服务端返回非 2xx 状态。
      */
     /** @deprecated 使用 `lowLevel`，或使用对应的业务分组方法。 / Use `lowLevel` or a grouped facade operation. */
     rawRequest(method_1, suffix_1, bodyJson_1, query_1) {
@@ -158,21 +159,23 @@ class LingyaAgentsUserClient {
                 body: bodyJson,
             });
             if (!response.ok)
-                throw new LingyaApiError(method, suffix, response.status, yield response.text());
+                throw new ApiError(method, suffix, response.status, yield response.text());
             return response;
         });
     }
 }
-exports.LingyaAgentsUserClient = LingyaAgentsUserClient;
+exports.AgentsUserClient = AgentsUserClient;
+exports.LingyaAgentsUserClient = AgentsUserClient;
 /** 不含凭证的 HTTP 错误。 / HTTP failure that never includes credentials. */
-class LingyaApiError extends Error {
+class ApiError extends Error {
     constructor(method, path, status, responseBody) {
         super(`${method} ${path} returned HTTP ${status}`);
         this.method = method;
         this.path = path;
         this.status = status;
         this.responseBody = responseBody;
-        this.name = 'LingyaApiError';
+        this.name = 'ApiError';
     }
 }
-exports.LingyaApiError = LingyaApiError;
+exports.ApiError = ApiError;
+exports.LingyaApiError = ApiError;

package/dist/esm/apis/ChatApi.d.ts

@@ -1,8 +1,8 @@
 /**
  * Lingya Agents OpenAPI
- * Public, tenant-scoped Agent channel API authenticated with OPENAPI-HMAC-SHA256-V1. Studio administration endpoints are not part of this contract.
+ * 本契约描述灵涯 Agents 面向可信服务端的公开渠道 API，使用 OPENAPI-HMAC-SHA256-V1 验证请求，不包含 Studio 管理接口。在线文档只展示请求，不会在浏览器中收集或保存 secret。  This contract describes the public Lingya Agents channel API for trusted servers. Requests use OPENAPI-HMAC-SHA256-V1, and Studio administration endpoints are excluded. The online reference only displays requests and never collects or stores a secret in the browser.  ## 快速开始 / Quick start  1. 读取 Configuration，确认模型和附件限制。 / Read Configuration to discover model and attachment limits.  2. 在本地固定最终 method、raw path、raw query、Content-Type 和 body 字节，再生成签名。 / Finalize method, raw path, raw query, Content-Type, and body bytes locally before signing.  3. 按业务分组调用接口；SSE 断开后使用 Events 补取。 / Call the appropriate business group and use Events for recovery after an SSE disconnect.  ## 公共错误 / Common errors  `401` 签名、时间戳或 nonce 无效；`403` 资源不属于当前渠道用户；`413` 请求体过大；`422` 参数校验失败；`429` 请求过于频繁；`500` 服务内部错误；`503` 依赖或执行服务暂不可用。  `401` invalid signature, timestamp, or nonce; `403` resource not owned by the current channel user; `413` request body too large; `422` validation failed; `429` rate limited; `500` internal error; `503` dependency or execution service unavailable.
  *
- * The version of the OpenAPI document: 0.1.2
+ * The version of the OpenAPI document: 0.1.5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,12 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AiChatBriefEvent, AiChatInput, AiChatStreamInput, AiChatSubmission, ChatStreamProbeEvent, ChatStreamProbeInput } from '../models/index';
+import { type AiChatBriefEvent } from '../models/AiChatBriefEvent';
+import { type AiChatInput } from '../models/AiChatInput';
+import { type AiChatStreamInput } from '../models/AiChatStreamInput';
+import { type AiChatSubmission } from '../models/AiChatSubmission';
+import { type ChatStreamProbeEvent } from '../models/ChatStreamProbeEvent';
+import { type ChatStreamProbeInput } from '../models/ChatStreamProbeInput';
 export interface CompactConversationRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -100,12 +105,12 @@ export declare class ChatApi extends runtime.BaseAPI {
      */
     compactConversationRequestOpts(requestParameters: CompactConversationRequest): Promise<runtime.RequestOpts>;
     /**
-     * 压缩会话上下文 / Compact conversation context 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 上下文接近模型上限或用户要求时触发压缩。  ### Use case Trigger context compaction near the model limit or on explicit user request.  ### 前置条件 渠道凭证和外部用户已配置，目标资源属于当前用户。  ### Prerequisites Channel credentials and the external user are configured, and the target resource belongs to that user.  ### 行为与副作用 异步安排上下文压缩。  ### Behavior and side effects Schedules asynchronous context compaction.  ### 后续调用 轮询上下文占用或等待相关事件。  ### Next step Poll context usage or wait for related events.  ### 接口摘要 压缩会话上下文 / Compact conversation context  ### Operation summary 压缩会话上下文 / Compact conversation context
      * 压缩会话上下文 / Compact conversation context
      */
     compactConversationRaw(requestParameters: CompactConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * 压缩会话上下文 / Compact conversation context 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 上下文接近模型上限或用户要求时触发压缩。  ### Use case Trigger context compaction near the model limit or on explicit user request.  ### 前置条件 渠道凭证和外部用户已配置，目标资源属于当前用户。  ### Prerequisites Channel credentials and the external user are configured, and the target resource belongs to that user.  ### 行为与副作用 异步安排上下文压缩。  ### Behavior and side effects Schedules asynchronous context compaction.  ### 后续调用 轮询上下文占用或等待相关事件。  ### Next step Poll context usage or wait for related events.  ### 接口摘要 压缩会话上下文 / Compact conversation context  ### Operation summary 压缩会话上下文 / Compact conversation context
      * 压缩会话上下文 / Compact conversation context
      */
     compactConversation(requestParameters: CompactConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -114,12 +119,12 @@ export declare class ChatApi extends runtime.BaseAPI {
      */
     continueChatRequestOpts(requestParameters: ContinueChatRequest): Promise<runtime.RequestOpts>;
     /**
-     * 向已有会话提交消息 / Submit a message to an existing conversation 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 在已有会话中提交下一轮用户消息。  ### Use case Submit the next user turn to an existing conversation.  ### 前置条件 渠道凭证和外部用户已配置，目标资源属于当前用户。  ### Prerequisites Channel credentials and the external user are configured, and the target resource belongs to that user.  ### 行为与副作用 创建新消息并安排继续执行。  ### Behavior and side effects Creates a new message and schedules continued execution.  ### 后续调用 订阅该 messageId 的 SSE 或稍后补取事件。  ### Next step Subscribe to SSE for the messageId or recover its events later.  ### 接口摘要 向已有会话提交消息 / Submit a message to an existing conversation  ### Operation summary 向已有会话提交消息 / Submit a message to an existing conversation
      * 向已有会话提交消息 / Submit a message to an existing conversation
      */
     continueChatRaw(requestParameters: ContinueChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiChatSubmission>>;
     /**
-     * 向已有会话提交消息 / Submit a message to an existing conversation 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 在已有会话中提交下一轮用户消息。  ### Use case Submit the next user turn to an existing conversation.  ### 前置条件 渠道凭证和外部用户已配置，目标资源属于当前用户。  ### Prerequisites Channel credentials and the external user are configured, and the target resource belongs to that user.  ### 行为与副作用 创建新消息并安排继续执行。  ### Behavior and side effects Creates a new message and schedules continued execution.  ### 后续调用 订阅该 messageId 的 SSE 或稍后补取事件。  ### Next step Subscribe to SSE for the messageId or recover its events later.  ### 接口摘要 向已有会话提交消息 / Submit a message to an existing conversation  ### Operation summary 向已有会话提交消息 / Submit a message to an existing conversation
      * 向已有会话提交消息 / Submit a message to an existing conversation
      */
     continueChat(requestParameters: ContinueChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiChatSubmission>;
@@ -128,12 +133,12 @@ export declare class ChatApi extends runtime.BaseAPI {
      */
     createChatRequestOpts(requestParameters: CreateChatRequest): Promise<runtime.RequestOpts>;
     /**
-     * 创建会话并提交消息 / Create a conversation and submit a message 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 创建新会话并提交第一条用户消息。  ### Use case Create a conversation and submit its first user message.  ### 前置条件 已读取配置；引用的文件已经确认上传。  ### Prerequisites Configuration has been read and referenced files are confirmed uploads.  ### 行为与副作用 创建会话和消息，并安排 Agent 执行。  ### Behavior and side effects Creates a conversation and message and schedules Agent execution.  ### 后续调用 使用返回的 conversationId 和 messageId 订阅 SSE。  ### Next step Use the returned conversationId and messageId to subscribe to SSE.  ### 接口摘要 创建会话并提交消息 / Create a conversation and submit a message  ### Operation summary 创建会话并提交消息 / Create a conversation and submit a message
      * 创建会话并提交消息 / Create a conversation and submit a message
      */
     createChatRaw(requestParameters: CreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiChatSubmission>>;
     /**
-     * 创建会话并提交消息 / Create a conversation and submit a message 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 创建新会话并提交第一条用户消息。  ### Use case Create a conversation and submit its first user message.  ### 前置条件 已读取配置；引用的文件已经确认上传。  ### Prerequisites Configuration has been read and referenced files are confirmed uploads.  ### 行为与副作用 创建会话和消息，并安排 Agent 执行。  ### Behavior and side effects Creates a conversation and message and schedules Agent execution.  ### 后续调用 使用返回的 conversationId 和 messageId 订阅 SSE。  ### Next step Use the returned conversationId and messageId to subscribe to SSE.  ### 接口摘要 创建会话并提交消息 / Create a conversation and submit a message  ### Operation summary 创建会话并提交消息 / Create a conversation and submit a message
      * 创建会话并提交消息 / Create a conversation and submit a message
      */
     createChat(requestParameters: CreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiChatSubmission>;
@@ -142,12 +147,12 @@ export declare class ChatApi extends runtime.BaseAPI {
      */
     interruptConversationRequestOpts(requestParameters: InterruptConversationRequest): Promise<runtime.RequestOpts>;
     /**
-     * 中断会话执行 / Interrupt conversation execution 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 用户主动停止正在执行的会话。  ### Use case Stop an actively executing conversation at the user\'s request.  ### 前置条件 渠道凭证和外部用户已配置，目标资源属于当前用户。  ### Prerequisites Channel credentials and the external user are configured, and the target resource belongs to that user.  ### 行为与副作用 请求终止当前执行；已完成输出不会回滚。  ### Behavior and side effects Requests termination of active execution; completed output is not rolled back.  ### 后续调用 查询活动状态或消息详情确认终态。  ### Next step Query activity or message detail to confirm the terminal state.  ### 接口摘要 中断会话执行 / Interrupt conversation execution  ### Operation summary 中断会话执行 / Interrupt conversation execution
      * 中断会话执行 / Interrupt conversation execution
      */
     interruptConversationRaw(requestParameters: InterruptConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * 中断会话执行 / Interrupt conversation execution 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 用户主动停止正在执行的会话。  ### Use case Stop an actively executing conversation at the user\'s request.  ### 前置条件 渠道凭证和外部用户已配置，目标资源属于当前用户。  ### Prerequisites Channel credentials and the external user are configured, and the target resource belongs to that user.  ### 行为与副作用 请求终止当前执行；已完成输出不会回滚。  ### Behavior and side effects Requests termination of active execution; completed output is not rolled back.  ### 后续调用 查询活动状态或消息详情确认终态。  ### Next step Query activity or message detail to confirm the terminal state.  ### 接口摘要 中断会话执行 / Interrupt conversation execution  ### Operation summary 中断会话执行 / Interrupt conversation execution
      * 中断会话执行 / Interrupt conversation execution
      */
     interruptConversation(requestParameters: InterruptConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -156,12 +161,12 @@ export declare class ChatApi extends runtime.BaseAPI {
      */
     probeEventStreamRequestOpts(requestParameters: ProbeEventStreamRequest): Promise<runtime.RequestOpts>;
     /**
-     * 探测 SSE 连接 / Probe the SSE connection 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 在接入或排障时验证网关、代理和客户端对 SSE 的支持。  ### Use case Verify SSE support across the gateway, proxy, and client during integration or diagnosis.  ### 前置条件 准备符合格式的 probeId。  ### Prerequisites Prepare a valid probeId.  ### 行为与副作用 只产生诊断事件，不创建业务会话。  ### Behavior and side effects Produces diagnostic events without creating a business conversation.  ### 后续调用 确认分片、心跳和 EOF 行为后再接入正式流。  ### Next step Confirm chunking, heartbeat, and EOF behavior before using the production stream.  ### 接口摘要 探测 SSE 连接 / Probe the SSE connection  ### Operation summary 探测 SSE 连接 / Probe the SSE connection
      * 探测 SSE 连接 / Probe the SSE connection
      */
     probeEventStreamRaw(requestParameters: ProbeEventStreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatStreamProbeEvent>>;
     /**
-     * 探测 SSE 连接 / Probe the SSE connection 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 在接入或排障时验证网关、代理和客户端对 SSE 的支持。  ### Use case Verify SSE support across the gateway, proxy, and client during integration or diagnosis.  ### 前置条件 准备符合格式的 probeId。  ### Prerequisites Prepare a valid probeId.  ### 行为与副作用 只产生诊断事件，不创建业务会话。  ### Behavior and side effects Produces diagnostic events without creating a business conversation.  ### 后续调用 确认分片、心跳和 EOF 行为后再接入正式流。  ### Next step Confirm chunking, heartbeat, and EOF behavior before using the production stream.  ### 接口摘要 探测 SSE 连接 / Probe the SSE connection  ### Operation summary 探测 SSE 连接 / Probe the SSE connection
      * 探测 SSE 连接 / Probe the SSE connection
      */
     probeEventStream(requestParameters: ProbeEventStreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatStreamProbeEvent>;
@@ -170,12 +175,12 @@ export declare class ChatApi extends runtime.BaseAPI {
      */
     streamChatEventsRequestOpts(requestParameters: StreamChatEventsRequest): Promise<runtime.RequestOpts>;
     /**
-     * 订阅消息事件流 / Stream message events 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 实时接收指定消息的思考、工具、回答和结束事件。  ### Use case Receive thought, tool, answer, and completion events for a message in real time.  ### 前置条件 消息已经创建且 messageId 与会话匹配。  ### Prerequisites The message exists and its messageId belongs to the conversation.  ### 行为与副作用 保持流式连接；断开不会取消服务端执行。  ### Behavior and side effects Keeps a streaming connection; disconnecting does not cancel server execution.  ### 后续调用 正常 EOF 后读取消息详情；异常断开时使用 Events 补取。  ### Next step After normal EOF read message detail; after an unexpected disconnect recover through Events.  ### 接口摘要 订阅消息事件流 / Stream message events  ### Operation summary 订阅消息事件流 / Stream message events
      * 订阅消息事件流 / Stream message events
      */
     streamChatEventsRaw(requestParameters: StreamChatEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiChatBriefEvent>>;
     /**
-     * 订阅消息事件流 / Stream message events 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 实时接收指定消息的思考、工具、回答和结束事件。  ### Use case Receive thought, tool, answer, and completion events for a message in real time.  ### 前置条件 消息已经创建且 messageId 与会话匹配。  ### Prerequisites The message exists and its messageId belongs to the conversation.  ### 行为与副作用 保持流式连接；断开不会取消服务端执行。  ### Behavior and side effects Keeps a streaming connection; disconnecting does not cancel server execution.  ### 后续调用 正常 EOF 后读取消息详情；异常断开时使用 Events 补取。  ### Next step After normal EOF read message detail; after an unexpected disconnect recover through Events.  ### 接口摘要 订阅消息事件流 / Stream message events  ### Operation summary 订阅消息事件流 / Stream message events
      * 订阅消息事件流 / Stream message events
      */
     streamChatEvents(requestParameters: StreamChatEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiChatBriefEvent>;