@lingya-ai/agents-sdk 0.4.0 → 0.7.0

package/dist/apis/InteractionsApi.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.
+ * Public Lingya Agents channel API. HMAC credentials belong on trusted servers; client tokens are single-use.
  *
- * The version of the OpenAPI document: 0.1.2
+ * The version of the OpenAPI document: 0.1.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { OperationResult, PlanApprovalInput, PlanStatus, UserInputAnswerInput, UserInputStatus } from '../models/index';
+import { type OperationResult } from '../models/OperationResult';
+import { type PlanApprovalInput } from '../models/PlanApprovalInput';
+import { type PlanStatus } from '../models/PlanStatus';
+import { type UserInputAnswerInput } from '../models/UserInputAnswerInput';
+import { type UserInputStatus } from '../models/UserInputStatus';
 export interface AnswerUserInputRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -31,6 +35,20 @@ export interface ApprovePlanRequest {
      */
     planApprovalInput: PlanApprovalInput;
 }
+export interface GetMessagePlanStatusRequest {
+    /**
+     * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
+     */
+    channelId: string;
+    /**
+     * 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     */
+    conversationId: string;
+    /**
+     * 用户消息 ID；必须属于指定会话。 / User-message ID owned by the specified conversation.
+     */
+    messageId: string;
+}
 export interface GetPlanStatusRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -68,12 +86,12 @@ export declare class InteractionsApi extends runtime.BaseAPI {
      */
     answerUserInputRequestOpts(requestParameters: AnswerUserInputRequest): Promise<runtime.RequestOpts>;
     /**
-     * 提交用户回答 / Submit a user answer 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 提交用户对 Agent 问题的选项或自定义回答。  ### Use case Submit selected options or custom input for an Agent question.  ### 前置条件 问题仍处于 pending 且标识与消息匹配。  ### Prerequisites The question is pending and identifiers match the message.  ### 行为与副作用 保存回答并可能推动执行继续。  ### Behavior and side effects Stores the answer and may resume execution.  ### 后续调用 继续监听 SSE 或查询消息状态。  ### Next step Continue listening to SSE or query message state.  ### 接口摘要 提交用户回答 / Submit a user answer  ### Operation summary 提交用户回答 / Submit a user answer
      * 提交用户回答 / Submit a user answer
      */
     answerUserInputRaw(requestParameters: AnswerUserInputRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OperationResult>>;
     /**
-     * 提交用户回答 / Submit a user answer 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 提交用户对 Agent 问题的选项或自定义回答。  ### Use case Submit selected options or custom input for an Agent question.  ### 前置条件 问题仍处于 pending 且标识与消息匹配。  ### Prerequisites The question is pending and identifiers match the message.  ### 行为与副作用 保存回答并可能推动执行继续。  ### Behavior and side effects Stores the answer and may resume execution.  ### 后续调用 继续监听 SSE 或查询消息状态。  ### Next step Continue listening to SSE or query message state.  ### 接口摘要 提交用户回答 / Submit a user answer  ### Operation summary 提交用户回答 / Submit a user answer
      * 提交用户回答 / Submit a user answer
      */
     answerUserInput(requestParameters: AnswerUserInputRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OperationResult>;
@@ -82,26 +100,40 @@ export declare class InteractionsApi extends runtime.BaseAPI {
      */
     approvePlanRequestOpts(requestParameters: ApprovePlanRequest): Promise<runtime.RequestOpts>;
     /**
-     * 提交计划审批 / Submit plan approval 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 响应 Agent 发出的计划审批请求。  ### Use case Respond to a plan-approval request emitted by the Agent.  ### 前置条件 从事件取得 planId、conversationId 和 messageId。  ### Prerequisites Obtain planId, conversationId, and messageId from the event.  ### 行为与副作用 提交批准或拒绝，可能推动执行继续。  ### Behavior and side effects Submits approval or rejection and may resume execution.  ### 后续调用 查询计划状态并继续监听事件。  ### Next step Check plan status and continue listening for events.  ### 接口摘要 提交计划审批 / Submit plan approval  ### Operation summary 提交计划审批 / Submit plan approval
      * 提交计划审批 / Submit plan approval
      */
     approvePlanRaw(requestParameters: ApprovePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OperationResult>>;
     /**
-     * 提交计划审批 / Submit plan approval 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 响应 Agent 发出的计划审批请求。  ### Use case Respond to a plan-approval request emitted by the Agent.  ### 前置条件 从事件取得 planId、conversationId 和 messageId。  ### Prerequisites Obtain planId, conversationId, and messageId from the event.  ### 行为与副作用 提交批准或拒绝，可能推动执行继续。  ### Behavior and side effects Submits approval or rejection and may resume execution.  ### 后续调用 查询计划状态并继续监听事件。  ### Next step Check plan status and continue listening for events.  ### 接口摘要 提交计划审批 / Submit plan approval  ### Operation summary 提交计划审批 / Submit plan approval
      * 提交计划审批 / Submit plan approval
      */
     approvePlan(requestParameters: ApprovePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OperationResult>;
+    /**
+     * Creates request options for getMessagePlanStatus without sending the request
+     */
+    getMessagePlanStatusRequestOpts(requestParameters: GetMessagePlanStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### 使用场景 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Use case Check whether plan approval is pending using conversationId and messageId.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Behavior and side effects Check whether plan approval is pending using conversationId and messageId.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 查询消息计划审批状态 / Get message plan status  ### Operation summary 查询消息计划审批状态 / Get message plan status
+     * 查询消息计划审批状态 / Get message plan status
+     */
+    getMessagePlanStatusRaw(requestParameters: GetMessagePlanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanStatus>>;
+    /**
+     * ### 使用场景 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Use case Check whether plan approval is pending using conversationId and messageId.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Behavior and side effects Check whether plan approval is pending using conversationId and messageId.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 查询消息计划审批状态 / Get message plan status  ### Operation summary 查询消息计划审批状态 / Get message plan status
+     * 查询消息计划审批状态 / Get message plan status
+     */
+    getMessagePlanStatus(requestParameters: GetMessagePlanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanStatus>;
     /**
      * Creates request options for getPlanStatus without sending the request
      */
     getPlanStatusRequestOpts(requestParameters: GetPlanStatusRequest): Promise<runtime.RequestOpts>;
     /**
-     * 查询计划审批状态 / Get plan approval status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 确认计划是否仍在等待或已经处理。  ### Use case Check whether a plan is still pending or has been handled.  ### 前置条件 持有事件返回的 planId。  ### Prerequisites A planId returned by an event is available.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 pending 时等待用户操作，否则刷新执行状态。  ### Next step Wait for user action while pending; otherwise refresh execution state.  ### 接口摘要 查询计划审批状态 / Get plan approval status  ### Operation summary 查询计划审批状态 / Get plan approval status
      * 查询计划审批状态 / Get plan approval status
      */
     getPlanStatusRaw(requestParameters: GetPlanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanStatus>>;
     /**
-     * 查询计划审批状态 / Get plan approval status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 确认计划是否仍在等待或已经处理。  ### Use case Check whether a plan is still pending or has been handled.  ### 前置条件 持有事件返回的 planId。  ### Prerequisites A planId returned by an event is available.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 pending 时等待用户操作，否则刷新执行状态。  ### Next step Wait for user action while pending; otherwise refresh execution state.  ### 接口摘要 查询计划审批状态 / Get plan approval status  ### Operation summary 查询计划审批状态 / Get plan approval status
      * 查询计划审批状态 / Get plan approval status
      */
     getPlanStatus(requestParameters: GetPlanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanStatus>;
@@ -110,12 +142,12 @@ export declare class InteractionsApi extends runtime.BaseAPI {
      */
     getUserInputStatusRequestOpts(requestParameters: GetUserInputStatusRequest): Promise<runtime.RequestOpts>;
     /**
-     * 查询用户问答状态 / Get user-input status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 恢复页面时确认 Agent 问题是否仍待回答。  ### Use case Check whether an Agent question is still awaiting an answer after restoring a page.  ### 前置条件 questionId、conversationId 和 messageId 来自同一事件。  ### Prerequisites questionId, conversationId, and messageId come from the same event.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 仍 pending 时展示问题，否则继续恢复事件。  ### Next step Show the question while pending; otherwise continue event recovery.  ### 接口摘要 查询用户问答状态 / Get user-input status  ### Operation summary 查询用户问答状态 / Get user-input status
      * 查询用户问答状态 / Get user-input status
      */
     getUserInputStatusRaw(requestParameters: GetUserInputStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserInputStatus>>;
     /**
-     * 查询用户问答状态 / Get user-input status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 恢复页面时确认 Agent 问题是否仍待回答。  ### Use case Check whether an Agent question is still awaiting an answer after restoring a page.  ### 前置条件 questionId、conversationId 和 messageId 来自同一事件。  ### Prerequisites questionId, conversationId, and messageId come from the same event.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 仍 pending 时展示问题，否则继续恢复事件。  ### Next step Show the question while pending; otherwise continue event recovery.  ### 接口摘要 查询用户问答状态 / Get user-input status  ### Operation summary 查询用户问答状态 / Get user-input status
      * 查询用户问答状态 / Get user-input status
      */
     getUserInputStatus(requestParameters: GetUserInputStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserInputStatus>;

package/dist/apis/InteractionsApi.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Lingya Agents OpenAPI
- * Public, tenant-scoped Agent channel API authenticated with OPENAPI-HMAC-SHA256-V1. Studio administration endpoints are not part of this contract.
+ * Public Lingya Agents channel API. HMAC credentials belong on trusted servers; client tokens are single-use.
  *
- * The version of the OpenAPI document: 0.1.2
+ * The version of the OpenAPI document: 0.1.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,6 +24,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InteractionsApi = void 0;
 const runtime = require("../runtime");
+const OperationResult_1 = require("../models/OperationResult");
+const PlanApprovalInput_1 = require("../models/PlanApprovalInput");
+const PlanStatus_1 = require("../models/PlanStatus");
+const UserInputAnswerInput_1 = require("../models/UserInputAnswerInput");
+const UserInputStatus_1 = require("../models/UserInputStatus");
 /**
  *
  */
@@ -42,6 +47,9 @@ class InteractionsApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Token"] = yield this.configuration.apiKey("X-OpenAPI-Token"); // OpenApiToken authentication
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-OpenAPI-User"] = yield this.configuration.apiKey("X-OpenAPI-User"); // OpenApiUser authentication
             }
@@ -64,23 +72,23 @@ class InteractionsApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: requestParameters['userInputAnswerInput'],
+                body: (0, UserInputAnswerInput_1.UserInputAnswerInputToJSON)(requestParameters['userInputAnswerInput']),
             };
         });
     }
     /**
-     * 提交用户回答 / Submit a user answer 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 提交用户对 Agent 问题的选项或自定义回答。  ### Use case Submit selected options or custom input for an Agent question.  ### 前置条件 问题仍处于 pending 且标识与消息匹配。  ### Prerequisites The question is pending and identifiers match the message.  ### 行为与副作用 保存回答并可能推动执行继续。  ### Behavior and side effects Stores the answer and may resume execution.  ### 后续调用 继续监听 SSE 或查询消息状态。  ### Next step Continue listening to SSE or query message state.  ### 接口摘要 提交用户回答 / Submit a user answer  ### Operation summary 提交用户回答 / Submit a user answer
      * 提交用户回答 / Submit a user answer
      */
     answerUserInputRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.answerUserInputRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, OperationResult_1.OperationResultFromJSON)(jsonValue));
         });
     }
     /**
-     * 提交用户回答 / Submit a user answer 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 提交用户对 Agent 问题的选项或自定义回答。  ### Use case Submit selected options or custom input for an Agent question.  ### 前置条件 问题仍处于 pending 且标识与消息匹配。  ### Prerequisites The question is pending and identifiers match the message.  ### 行为与副作用 保存回答并可能推动执行继续。  ### Behavior and side effects Stores the answer and may resume execution.  ### 后续调用 继续监听 SSE 或查询消息状态。  ### Next step Continue listening to SSE or query message state.  ### 接口摘要 提交用户回答 / Submit a user answer  ### Operation summary 提交用户回答 / Submit a user answer
      * 提交用户回答 / Submit a user answer
      */
     answerUserInput(requestParameters, initOverrides) {
@@ -103,6 +111,9 @@ class InteractionsApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Token"] = yield this.configuration.apiKey("X-OpenAPI-Token"); // OpenApiToken authentication
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-OpenAPI-User"] = yield this.configuration.apiKey("X-OpenAPI-User"); // OpenApiUser authentication
             }
@@ -125,23 +136,23 @@ class InteractionsApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: requestParameters['planApprovalInput'],
+                body: (0, PlanApprovalInput_1.PlanApprovalInputToJSON)(requestParameters['planApprovalInput']),
             };
         });
     }
     /**
-     * 提交计划审批 / Submit plan approval 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 响应 Agent 发出的计划审批请求。  ### Use case Respond to a plan-approval request emitted by the Agent.  ### 前置条件 从事件取得 planId、conversationId 和 messageId。  ### Prerequisites Obtain planId, conversationId, and messageId from the event.  ### 行为与副作用 提交批准或拒绝，可能推动执行继续。  ### Behavior and side effects Submits approval or rejection and may resume execution.  ### 后续调用 查询计划状态并继续监听事件。  ### Next step Check plan status and continue listening for events.  ### 接口摘要 提交计划审批 / Submit plan approval  ### Operation summary 提交计划审批 / Submit plan approval
      * 提交计划审批 / Submit plan approval
      */
     approvePlanRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.approvePlanRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, OperationResult_1.OperationResultFromJSON)(jsonValue));
         });
     }
     /**
-     * 提交计划审批 / Submit plan approval 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 响应 Agent 发出的计划审批请求。  ### Use case Respond to a plan-approval request emitted by the Agent.  ### 前置条件 从事件取得 planId、conversationId 和 messageId。  ### Prerequisites Obtain planId, conversationId, and messageId from the event.  ### 行为与副作用 提交批准或拒绝，可能推动执行继续。  ### Behavior and side effects Submits approval or rejection and may resume execution.  ### 后续调用 查询计划状态并继续监听事件。  ### Next step Check plan status and continue listening for events.  ### 接口摘要 提交计划审批 / Submit plan approval  ### Operation summary 提交计划审批 / Submit plan approval
      * 提交计划审批 / Submit plan approval
      */
     approvePlan(requestParameters, initOverrides) {
@@ -150,6 +161,73 @@ class InteractionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getMessagePlanStatus without sending the request
+     */
+    getMessagePlanStatusRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['channelId'] == null) {
+                throw new runtime.RequiredError('channelId', 'Required parameter "channelId" was null or undefined when calling getMessagePlanStatus().');
+            }
+            if (requestParameters['conversationId'] == null) {
+                throw new runtime.RequiredError('conversationId', 'Required parameter "conversationId" was null or undefined when calling getMessagePlanStatus().');
+            }
+            if (requestParameters['messageId'] == null) {
+                throw new runtime.RequiredError('messageId', 'Required parameter "messageId" was null or undefined when calling getMessagePlanStatus().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Token"] = yield this.configuration.apiKey("X-OpenAPI-Token"); // OpenApiToken authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-User"] = yield this.configuration.apiKey("X-OpenAPI-User"); // OpenApiUser authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-AK"] = yield this.configuration.apiKey("X-OpenAPI-AK"); // OpenApiAccessKey authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Timestamp"] = yield this.configuration.apiKey("X-OpenAPI-Timestamp"); // OpenApiTimestamp authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Nonce"] = yield this.configuration.apiKey("X-OpenAPI-Nonce"); // OpenApiNonce authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Signature"] = yield this.configuration.apiKey("X-OpenAPI-Signature"); // OpenApiSignature authentication
+            }
+            let urlPath = `/api/agents/channel/openapi/v1/{channelId}/chat/conversations/{conversationId}/messages/{messageId}/plan/status`;
+            urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
+            urlPath = urlPath.replace('{conversationId}', encodeURIComponent(String(requestParameters['conversationId'])));
+            urlPath = urlPath.replace('{messageId}', encodeURIComponent(String(requestParameters['messageId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * ### 使用场景 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Use case Check whether plan approval is pending using conversationId and messageId.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Behavior and side effects Check whether plan approval is pending using conversationId and messageId.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 查询消息计划审批状态 / Get message plan status  ### Operation summary 查询消息计划审批状态 / Get message plan status
+     * 查询消息计划审批状态 / Get message plan status
+     */
+    getMessagePlanStatusRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getMessagePlanStatusRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, PlanStatus_1.PlanStatusFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * ### 使用场景 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Use case Check whether plan approval is pending using conversationId and messageId.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 使用 conversationId 和 messageId 检查计划审批是否仍在等待。  ### Behavior and side effects Check whether plan approval is pending using conversationId and messageId.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 查询消息计划审批状态 / Get message plan status  ### Operation summary 查询消息计划审批状态 / Get message plan status
+     * 查询消息计划审批状态 / Get message plan status
+     */
+    getMessagePlanStatus(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getMessagePlanStatusRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getPlanStatus without sending the request
      */
@@ -163,6 +241,9 @@ class InteractionsApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Token"] = yield this.configuration.apiKey("X-OpenAPI-Token"); // OpenApiToken authentication
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-OpenAPI-User"] = yield this.configuration.apiKey("X-OpenAPI-User"); // OpenApiUser authentication
             }
@@ -190,18 +271,18 @@ class InteractionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 查询计划审批状态 / Get plan approval status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 确认计划是否仍在等待或已经处理。  ### Use case Check whether a plan is still pending or has been handled.  ### 前置条件 持有事件返回的 planId。  ### Prerequisites A planId returned by an event is available.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 pending 时等待用户操作，否则刷新执行状态。  ### Next step Wait for user action while pending; otherwise refresh execution state.  ### 接口摘要 查询计划审批状态 / Get plan approval status  ### Operation summary 查询计划审批状态 / Get plan approval status
      * 查询计划审批状态 / Get plan approval status
      */
     getPlanStatusRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.getPlanStatusRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, PlanStatus_1.PlanStatusFromJSON)(jsonValue));
         });
     }
     /**
-     * 查询计划审批状态 / Get plan approval status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 确认计划是否仍在等待或已经处理。  ### Use case Check whether a plan is still pending or has been handled.  ### 前置条件 持有事件返回的 planId。  ### Prerequisites A planId returned by an event is available.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 pending 时等待用户操作，否则刷新执行状态。  ### Next step Wait for user action while pending; otherwise refresh execution state.  ### 接口摘要 查询计划审批状态 / Get plan approval status  ### Operation summary 查询计划审批状态 / Get plan approval status
      * 查询计划审批状态 / Get plan approval status
      */
     getPlanStatus(requestParameters, initOverrides) {
@@ -235,6 +316,9 @@ class InteractionsApi extends runtime.BaseAPI {
                 queryParameters['messageId'] = requestParameters['messageId'];
             }
             const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Token"] = yield this.configuration.apiKey("X-OpenAPI-Token"); // OpenApiToken authentication
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-OpenAPI-User"] = yield this.configuration.apiKey("X-OpenAPI-User"); // OpenApiUser authentication
             }
@@ -262,18 +346,18 @@ class InteractionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 查询用户问答状态 / Get user-input status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 恢复页面时确认 Agent 问题是否仍待回答。  ### Use case Check whether an Agent question is still awaiting an answer after restoring a page.  ### 前置条件 questionId、conversationId 和 messageId 来自同一事件。  ### Prerequisites questionId, conversationId, and messageId come from the same event.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 仍 pending 时展示问题，否则继续恢复事件。  ### Next step Show the question while pending; otherwise continue event recovery.  ### 接口摘要 查询用户问答状态 / Get user-input status  ### Operation summary 查询用户问答状态 / Get user-input status
      * 查询用户问答状态 / Get user-input status
      */
     getUserInputStatusRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.getUserInputStatusRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, UserInputStatus_1.UserInputStatusFromJSON)(jsonValue));
         });
     }
     /**
-     * 查询用户问答状态 / Get user-input status 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 恢复页面时确认 Agent 问题是否仍待回答。  ### Use case Check whether an Agent question is still awaiting an answer after restoring a page.  ### 前置条件 questionId、conversationId 和 messageId 来自同一事件。  ### Prerequisites questionId, conversationId, and messageId come from the same event.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 仍 pending 时展示问题，否则继续恢复事件。  ### Next step Show the question while pending; otherwise continue event recovery.  ### 接口摘要 查询用户问答状态 / Get user-input status  ### Operation summary 查询用户问答状态 / Get user-input status
      * 查询用户问答状态 / Get user-input status
      */
     getUserInputStatus(requestParameters, initOverrides) {

package/dist/apis/KnowledgeApi.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.
+ * Public Lingya Agents channel API. HMAC credentials belong on trusted servers; client tokens are single-use.
  *
- * The version of the OpenAPI document: 0.1.2
+ * The version of the OpenAPI document: 0.1.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CitationMetadata, CitationMetadataList, ReturnedReference } from '../models/index';
+import { type CitationMetadata } from '../models/CitationMetadata';
+import { type CitationMetadataList } from '../models/CitationMetadataList';
+import { type ReturnedReference } from '../models/ReturnedReference';
 export interface GetCitationMetadataRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -44,12 +46,12 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
      */
     getCitationMetadataRequestOpts(requestParameters: GetCitationMetadataRequest): Promise<runtime.RequestOpts>;
     /**
-     * 读取引用元数据 / Get citation metadata 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 用户展开单条引用时读取来源详情。  ### Use case Read source detail when a user expands one citation.  ### 前置条件 citationType 与 referenceId 来自服务端。  ### Prerequisites citationType and referenceId come from the server.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 展示标题、位置和其他元数据。  ### Next step Display title, location, and other metadata.  ### 接口摘要 读取引用元数据 / Get citation metadata  ### Operation summary 读取引用元数据 / Get citation metadata
      * 读取引用元数据 / Get citation metadata
      */
     getCitationMetadataRaw(requestParameters: GetCitationMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CitationMetadata>>;
     /**
-     * 读取引用元数据 / Get citation metadata 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 用户展开单条引用时读取来源详情。  ### Use case Read source detail when a user expands one citation.  ### 前置条件 citationType 与 referenceId 来自服务端。  ### Prerequisites citationType and referenceId come from the server.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 展示标题、位置和其他元数据。  ### Next step Display title, location, and other metadata.  ### 接口摘要 读取引用元数据 / Get citation metadata  ### Operation summary 读取引用元数据 / Get citation metadata
      * 读取引用元数据 / Get citation metadata
      */
     getCitationMetadata(requestParameters: GetCitationMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CitationMetadata>;
@@ -58,12 +60,12 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
      */
     getCitationMetadataBatchRequestOpts(requestParameters: GetCitationMetadataBatchRequest): Promise<runtime.RequestOpts>;
     /**
-     * 批量读取引用元数据 / Get citation metadata in batch 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 一次解析回答中的多条知识引用。  ### Use case Resolve multiple knowledge citations from an answer in one request.  ### 前置条件 引用列表来自服务端消息或事件。  ### Prerequisites The reference list comes from a server message or event.  ### 行为与副作用 只读，返回可展示元数据。  ### Behavior and side effects Read-only and returns display metadata.  ### 后续调用 按原引用顺序渲染来源。  ### Next step Render sources in the original reference order.  ### 接口摘要 批量读取引用元数据 / Get citation metadata in batch  ### Operation summary 批量读取引用元数据 / Get citation metadata in batch
      * 批量读取引用元数据 / Get citation metadata in batch
      */
     getCitationMetadataBatchRaw(requestParameters: GetCitationMetadataBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CitationMetadataList>>;
     /**
-     * 批量读取引用元数据 / Get citation metadata in batch 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 一次解析回答中的多条知识引用。  ### Use case Resolve multiple knowledge citations from an answer in one request.  ### 前置条件 引用列表来自服务端消息或事件。  ### Prerequisites The reference list comes from a server message or event.  ### 行为与副作用 只读，返回可展示元数据。  ### Behavior and side effects Read-only and returns display metadata.  ### 后续调用 按原引用顺序渲染来源。  ### Next step Render sources in the original reference order.  ### 接口摘要 批量读取引用元数据 / Get citation metadata in batch  ### Operation summary 批量读取引用元数据 / Get citation metadata in batch
      * 批量读取引用元数据 / Get citation metadata in batch
      */
     getCitationMetadataBatch(requestParameters: GetCitationMetadataBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CitationMetadataList>;

package/dist/apis/KnowledgeApi.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Lingya Agents OpenAPI
- * Public, tenant-scoped Agent channel API authenticated with OPENAPI-HMAC-SHA256-V1. Studio administration endpoints are not part of this contract.
+ * Public Lingya Agents channel API. HMAC credentials belong on trusted servers; client tokens are single-use.
  *
- * The version of the OpenAPI document: 0.1.2
+ * The version of the OpenAPI document: 0.1.7
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,6 +24,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KnowledgeApi = void 0;
 const runtime = require("../runtime");
+const CitationMetadata_1 = require("../models/CitationMetadata");
+const CitationMetadataList_1 = require("../models/CitationMetadataList");
+const ReturnedReference_1 = require("../models/ReturnedReference");
 /**
  *
  */
@@ -44,6 +47,9 @@ class KnowledgeApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Token"] = yield this.configuration.apiKey("X-OpenAPI-Token"); // OpenApiToken authentication
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-OpenAPI-User"] = yield this.configuration.apiKey("X-OpenAPI-User"); // OpenApiUser authentication
             }
@@ -72,18 +78,18 @@ class KnowledgeApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 读取引用元数据 / Get citation metadata 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 用户展开单条引用时读取来源详情。  ### Use case Read source detail when a user expands one citation.  ### 前置条件 citationType 与 referenceId 来自服务端。  ### Prerequisites citationType and referenceId come from the server.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 展示标题、位置和其他元数据。  ### Next step Display title, location, and other metadata.  ### 接口摘要 读取引用元数据 / Get citation metadata  ### Operation summary 读取引用元数据 / Get citation metadata
      * 读取引用元数据 / Get citation metadata
      */
     getCitationMetadataRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.getCitationMetadataRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CitationMetadata_1.CitationMetadataFromJSON)(jsonValue));
         });
     }
     /**
-     * 读取引用元数据 / Get citation metadata 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 用户展开单条引用时读取来源详情。  ### Use case Read source detail when a user expands one citation.  ### 前置条件 citationType 与 referenceId 来自服务端。  ### Prerequisites citationType and referenceId come from the server.  ### 行为与副作用 只读。  ### Behavior and side effects Read-only.  ### 后续调用 展示标题、位置和其他元数据。  ### Next step Display title, location, and other metadata.  ### 接口摘要 读取引用元数据 / Get citation metadata  ### Operation summary 读取引用元数据 / Get citation metadata
      * 读取引用元数据 / Get citation metadata
      */
     getCitationMetadata(requestParameters, initOverrides) {
@@ -106,6 +112,9 @@ class KnowledgeApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-OpenAPI-Token"] = yield this.configuration.apiKey("X-OpenAPI-Token"); // OpenApiToken authentication
+            }
             if (this.configuration && this.configuration.apiKey) {
                 headerParameters["X-OpenAPI-User"] = yield this.configuration.apiKey("X-OpenAPI-User"); // OpenApiUser authentication
             }
@@ -128,23 +137,23 @@ class KnowledgeApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: requestParameters['returnedReference'],
+                body: requestParameters['returnedReference'].map(ReturnedReference_1.ReturnedReferenceToJSON),
             };
         });
     }
     /**
-     * 批量读取引用元数据 / Get citation metadata in batch 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 一次解析回答中的多条知识引用。  ### Use case Resolve multiple knowledge citations from an answer in one request.  ### 前置条件 引用列表来自服务端消息或事件。  ### Prerequisites The reference list comes from a server message or event.  ### 行为与副作用 只读，返回可展示元数据。  ### Behavior and side effects Read-only and returns display metadata.  ### 后续调用 按原引用顺序渲染来源。  ### Next step Render sources in the original reference order.  ### 接口摘要 批量读取引用元数据 / Get citation metadata in batch  ### Operation summary 批量读取引用元数据 / Get citation metadata in batch
      * 批量读取引用元数据 / Get citation metadata in batch
      */
     getCitationMetadataBatchRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.getCitationMetadataBatchRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CitationMetadataList_1.CitationMetadataListFromJSON)(jsonValue));
         });
     }
     /**
-     * 批量读取引用元数据 / Get citation metadata in batch 请求会在身份验签和资源归属校验后执行；响应字段以本契约为准。 / The request runs after signature and resource-ownership validation; this contract defines the response fields.
+     * ### 使用场景 一次解析回答中的多条知识引用。  ### Use case Resolve multiple knowledge citations from an answer in one request.  ### 前置条件 引用列表来自服务端消息或事件。  ### Prerequisites The reference list comes from a server message or event.  ### 行为与副作用 只读，返回可展示元数据。  ### Behavior and side effects Read-only and returns display metadata.  ### 后续调用 按原引用顺序渲染来源。  ### Next step Render sources in the original reference order.  ### 接口摘要 批量读取引用元数据 / Get citation metadata in batch  ### Operation summary 批量读取引用元数据 / Get citation metadata in batch
      * 批量读取引用元数据 / Get citation metadata in batch
      */
     getCitationMetadataBatch(requestParameters, initOverrides) {