@lingya-ai/agents-sdk 0.4.0 → 0.7.0

package/README.md

@@ -1,19 +1,52 @@
 # 灵涯 Agents TypeScript SDK
 Lingya Agents SDK for TypeScript
 
-用于在 Node.js 可信服务端调用灵涯 Agents OpenAPI。
-Use this SDK to call Lingya Agents OpenAPI from a trusted Node.js server.
+支持 Node.js 服务端 HMAC 认证及浏览器一次性令牌认证。
+Use HMAC on trusted Node.js servers or single-use tokens in browsers.
 
 ## 安装
 Installation
 
 ```bash
-npm install @lingya-ai/agents-sdk@0.4.0
+npm install @lingya-ai/agents-sdk@0.7.0
 ```
 
-运行环境需要 Node.js 20 或更高版本。
+Node 入口需要 Node.js 20 或更高版本；浏览器入口使用现代 Web API。
 The runtime requires Node.js 20 or later.
 
+## 一次性令牌与浏览器
+
+浏览器使用专用入口；支持浏览器条件导出的打包器也会自动选择此入口。它不包含 `node:crypto`，只接受 token 回调。服务端入口同时支持 HMAC 和 token。
+The browser entry excludes Node crypto and only accepts token callbacks. The Node entry supports both authentication modes.
+
+```typescript
+import { AgentsClient } from '@lingya-ai/agents-sdk/browser';
+
+const client = new AgentsClient({
+    baseUrl: 'https://agents.example.com',
+    channelId: 'channel-id',
+    auth: {
+        type: 'token',
+        tokenProvider: async ({ fetch, signal }) => {
+            // 自己的业务服务端根据登录用户签发一枚新令牌。
+            const response = await fetch('/api/agents-token', {
+                method: 'POST', credentials: 'same-origin', signal,
+            });
+            if (!response.ok) throw new Error('获取令牌失败');
+            const { token } = await response.json();
+            return token;
+        },
+    },
+});
+await client.chat.createChat({ query: '你好' });
+```
+
+Node 新选项构造支持 `auth: { type: 'hmac', accessKey, secretKey, externalUserId }`，并在 `client` 上直接提供业务分组；原有三参数构造加 `forUser` 保持兼容。选项构造已绑定身份，不能再调用 `forUser` 切换用户。浏览器部署需要服务端 CORS 放行页面来源和 `X-OpenAPI-Token` 请求头。浏览器 SSE 使用 Fetch 响应流和增量 `TextDecoder` 解码，不依赖 `TextDecoderStream`；取消与计时由 SDK 管理，不依赖 `AbortSignal.any/timeout` 或 `throwIfAborted`。浏览器仍需提供 Fetch、ReadableStream、TextDecoder 和 AbortController。
+Node options also accept HMAC credentials and an external user ID. Legacy constructors remain supported. Options clients already bind identity. Configure CORS for your browser origin and token header; Fetch-based SSE uses incremental TextDecoder decoding without TextDecoderStream. The SDK manages cancellation and timers without AbortSignal.any/timeout or throwIfAborted; Fetch, ReadableStream, TextDecoder, and AbortController are still required.
+
+令牌有效期十分钟，但只允许认证一次；每次请求、手动重试和 SSE/WebSocket 重新连接都独立调用回调，不缓存、不合并并发签发、不自动重试或跟随重定向。认证成功后即消费，业务失败不能复用。Token 模式不携带 HMAC 头，不能调用 `createOpenApiToken`；需由持有 AK/SK 的可信服务端签发。回调异常及非法 token 会在业务请求发出前拒绝。`/api/agents-token`、`issue_fresh_token` / `issueFreshToken` 都是业务系统示意，并非 SDK 新增接口。签发服务应从登录态确定用户和允许的渠道。
+Tokens expire after ten minutes but authenticate only once. Each request, explicit retry, and SSE/WebSocket reconnection invokes the provider independently. Token clients do not cache, share issuance, retry automatically, follow redirects, send HMAC headers, or call presign. Use a trusted server to issue tokens for the authenticated business user and permitted channel; the example issuer functions/routes belong to your application.
+
 ## 快速开始
 Quick start
 
@@ -62,9 +95,34 @@ import { ApiError } from '@lingya-ai/agents-sdk';
 try {
   await user.conversations.getConversationTitle('conversation-id');
 } catch (error) {
-  if (error instanceof ApiError) console.error(error.status, error.responseBody);
+  if (error instanceof ApiError) console.error(error.kind, error.status, error.code, error.message, error.fields, error.requestId);
 }
 ```
 
 请只在可信服务端保存 `secretKey`，不要将其放入浏览器、移动端、桌面端或日志。
 Keep `secretKey` on trusted servers only; never put it in browsers, mobile apps, desktop apps, or logs.
+
+
+## 0.7 请求生命周期与订阅
+
+```typescript
+const client = new AgentsClient({
+    baseUrl, channelId, fetch: customFetch,
+    auth: { type: 'token', tokenProvider: async ({ fetch, signal }) => {
+        const response = await fetch('/api/agents-token', { method: 'POST', signal });
+        if (!response.ok) throw new Error('Token issuance failed');
+        return (await response.json()).token;
+    } },
+});
+const controller = new AbortController();
+await client.configuration.getAgentsConfig({ signal: controller.signal, timeoutMs: 5000 });
+const subscription = client.chat.subscribeChatEvents(conversationId, { messageId }, {
+    transport: 'websocket', signal: controller.signal, idleTimeoutMs: 30000,
+    onConnectionEvent: event => console.debug(event),
+});
+try { for await (const event of subscription) consume(event); }
+finally { subscription.close(); await subscription.closed; }
+const download = await client.sql.exportSqlQueryResultWithMetadata(conversationId, resultId, { format: 'CSV' });
+```
+
+超时覆盖获取令牌、建连和完整响应；SDK 不自动重试或重连。业务 End 立即释放连接，WebSocket complete/1000 不补造 End。错误包含可判别分类、HTTP 状态和可取得的业务错误及请求标识。详见 [生命周期、错误和生成机制](docs/request-lifecycle.md)。运行时由契约项目统一生成，修改生成产物会被 CI 检出。

package/dist/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.
+ * 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,31 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AiChatBriefEvent, AiChatInput, AiChatStreamInput, AiChatSubmission, ChatStreamProbeEvent, ChatStreamProbeInput } from '../models/index';
+import { type AgentGoal } from '../models/AgentGoal';
+import { type AgentGoalHistory } from '../models/AgentGoalHistory';
+import { type AgentGoalRefInput } from '../models/AgentGoalRefInput';
+import { type AgentGoalView } from '../models/AgentGoalView';
+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';
+import { type EditAgentGoalInput } from '../models/EditAgentGoalInput';
+export interface ClearGoalRequest {
+    /**
+     * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
+     */
+    channelId: string;
+    /**
+     * 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     */
+    conversationId: string;
+    /**
+     *
+     */
+    agentGoalRefInput: AgentGoalRefInput;
+}
 export interface CompactConversationRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -49,6 +73,48 @@ export interface CreateChatRequest {
      */
     aiChatInput: AiChatInput;
 }
+export interface EditGoalRequest {
+    /**
+     * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
+     */
+    channelId: string;
+    /**
+     * 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     */
+    conversationId: string;
+    /**
+     *
+     */
+    editAgentGoalInput: EditAgentGoalInput;
+}
+export interface GetGoalRequest {
+    /**
+     * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
+     */
+    channelId: string;
+    /**
+     * 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     */
+    conversationId: string;
+}
+export interface GetGoalHistoryRequest {
+    /**
+     * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
+     */
+    channelId: string;
+    /**
+     * 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     */
+    conversationId: string;
+    /**
+     * 分页信息 / page metadata。
+     */
+    page?: number;
+    /**
+     * 单页记录数。 / Number of records per page.
+     */
+    size?: number;
+}
 export interface InterruptConversationRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -59,6 +125,20 @@ export interface InterruptConversationRequest {
      */
     conversationId: string;
 }
+export interface PauseGoalRequest {
+    /**
+     * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
+     */
+    channelId: string;
+    /**
+     * 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     */
+    conversationId: string;
+    /**
+     *
+     */
+    agentGoalRefInput: AgentGoalRefInput;
+}
 export interface ProbeEventStreamRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -73,6 +153,20 @@ export interface ProbeEventStreamRequest {
      */
     xRequestID?: string;
 }
+export interface ResumeGoalRequest {
+    /**
+     * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
+     */
+    channelId: string;
+    /**
+     * 会话 ID；必须属于当前外部用户。 / Conversation ID owned by the current external user.
+     */
+    conversationId: string;
+    /**
+     *
+     */
+    agentGoalRefInput: AgentGoalRefInput;
+}
 export interface StreamChatEventsRequest {
     /**
      * Agent OpenAPI 渠道 UUID。 / Agent OpenAPI channel UUID.
@@ -95,17 +189,31 @@ export interface StreamChatEventsRequest {
  *
  */
 export declare class ChatApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for clearGoal without sending the request
+     */
+    clearGoalRequestOpts(requestParameters: ClearGoalRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### 使用场景 携带目标标识与版本，清除目标并保留墓碑。  ### Use case Clear the identified goal at the expected revision and preserve its tombstone.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带目标标识与版本，清除目标并保留墓碑。  ### Behavior and side effects Clear the identified goal at the expected revision and preserve its tombstone.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 清除目标 / Clear goal  ### Operation summary 清除目标 / Clear goal
+     * 清除目标 / Clear goal
+     */
+    clearGoalRaw(requestParameters: ClearGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentGoal>>;
+    /**
+     * ### 使用场景 携带目标标识与版本，清除目标并保留墓碑。  ### Use case Clear the identified goal at the expected revision and preserve its tombstone.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带目标标识与版本，清除目标并保留墓碑。  ### Behavior and side effects Clear the identified goal at the expected revision and preserve its tombstone.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 清除目标 / Clear goal  ### Operation summary 清除目标 / Clear goal
+     * 清除目标 / Clear goal
+     */
+    clearGoal(requestParameters: ClearGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentGoal>;
     /**
      * Creates request options for compactConversation without sending the request
      */
     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 +222,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,54 +236,124 @@ 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>;
+    /**
+     * Creates request options for editGoal without sending the request
+     */
+    editGoalRequestOpts(requestParameters: EditGoalRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### 使用场景 携带 goalId 和 goalRevision 更新目标正文，不改变激活状态；陈旧版本返回 409，失效目标返回 410。  ### Use case Update the objective with goalId and goalRevision without changing activation; stale revisions return 409 and invalidated goals return 410.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带 goalId 和 goalRevision 更新目标正文，不改变激活状态；陈旧版本返回 409，失效目标返回 410。  ### Behavior and side effects Update the objective with goalId and goalRevision without changing activation; stale revisions return 409 and invalidated goals return 410.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 编辑目标 / Edit goal  ### Operation summary 编辑目标 / Edit goal
+     * 编辑目标 / Edit goal
+     */
+    editGoalRaw(requestParameters: EditGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentGoal>>;
+    /**
+     * ### 使用场景 携带 goalId 和 goalRevision 更新目标正文，不改变激活状态；陈旧版本返回 409，失效目标返回 410。  ### Use case Update the objective with goalId and goalRevision without changing activation; stale revisions return 409 and invalidated goals return 410.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带 goalId 和 goalRevision 更新目标正文，不改变激活状态；陈旧版本返回 409，失效目标返回 410。  ### Behavior and side effects Update the objective with goalId and goalRevision without changing activation; stale revisions return 409 and invalidated goals return 410.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 编辑目标 / Edit goal  ### Operation summary 编辑目标 / Edit goal
+     * 编辑目标 / Edit goal
+     */
+    editGoal(requestParameters: EditGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentGoal>;
+    /**
+     * Creates request options for getGoal without sending the request
+     */
+    getGoalRequestOpts(requestParameters: GetGoalRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### 使用场景 无当前目标时返回 goal=null。  ### Use case Return goal=null when no current goal exists.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 无当前目标时返回 goal=null。  ### Behavior and side effects Return goal=null when no current goal exists.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 读取当前目标 / Get current goal  ### Operation summary 读取当前目标 / Get current goal
+     * 读取当前目标 / Get current goal
+     */
+    getGoalRaw(requestParameters: GetGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentGoalView>>;
+    /**
+     * ### 使用场景 无当前目标时返回 goal=null。  ### Use case Return goal=null when no current goal exists.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 无当前目标时返回 goal=null。  ### Behavior and side effects Return goal=null when no current goal exists.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 读取当前目标 / Get current goal  ### Operation summary 读取当前目标 / Get current goal
+     * 读取当前目标 / Get current goal
+     */
+    getGoal(requestParameters: GetGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentGoalView>;
+    /**
+     * Creates request options for getGoalHistory without sending the request
+     */
+    getGoalHistoryRequestOpts(requestParameters: GetGoalHistoryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### 使用场景 分页读取当前会话的目标历史。  ### Use case Read paged goal history for the conversation.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 分页读取当前会话的目标历史。  ### Behavior and side effects Read paged goal history for the conversation.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 查询目标历史 / Get goal history  ### Operation summary 查询目标历史 / Get goal history
+     * 查询目标历史 / Get goal history
+     */
+    getGoalHistoryRaw(requestParameters: GetGoalHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentGoalHistory>>;
+    /**
+     * ### 使用场景 分页读取当前会话的目标历史。  ### Use case Read paged goal history for the conversation.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 分页读取当前会话的目标历史。  ### Behavior and side effects Read paged goal history for the conversation.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 查询目标历史 / Get goal history  ### Operation summary 查询目标历史 / Get goal history
+     * 查询目标历史 / Get goal history
+     */
+    getGoalHistory(requestParameters: GetGoalHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentGoalHistory>;
     /**
      * Creates request options for interruptConversation without sending the request
      */
     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>;
+    /**
+     * Creates request options for pauseGoal without sending the request
+     */
+    pauseGoalRequestOpts(requestParameters: PauseGoalRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### 使用场景 携带目标标识与版本，暂停并撤销自动续跑授权。  ### Use case Pause the identified goal at the expected revision and revoke automatic continuation.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带目标标识与版本，暂停并撤销自动续跑授权。  ### Behavior and side effects Pause the identified goal at the expected revision and revoke automatic continuation.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 暂停目标 / Pause goal  ### Operation summary 暂停目标 / Pause goal
+     * 暂停目标 / Pause goal
+     */
+    pauseGoalRaw(requestParameters: PauseGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentGoal>>;
+    /**
+     * ### 使用场景 携带目标标识与版本，暂停并撤销自动续跑授权。  ### Use case Pause the identified goal at the expected revision and revoke automatic continuation.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带目标标识与版本，暂停并撤销自动续跑授权。  ### Behavior and side effects Pause the identified goal at the expected revision and revoke automatic continuation.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 暂停目标 / Pause goal  ### Operation summary 暂停目标 / Pause goal
+     * 暂停目标 / Pause goal
+     */
+    pauseGoal(requestParameters: PauseGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentGoal>;
     /**
      * Creates request options for probeEventStream without sending the request
      */
     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>;
+    /**
+     * Creates request options for resumeGoal without sending the request
+     */
+    resumeGoalRequestOpts(requestParameters: ResumeGoalRequest): Promise<runtime.RequestOpts>;
+    /**
+     * ### 使用场景 携带目标标识与版本，恢复目标并重新授予自动续跑授权。  ### Use case Resume the identified goal at the expected revision and authorize automatic continuation.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带目标标识与版本，恢复目标并重新授予自动续跑授权。  ### Behavior and side effects Resume the identified goal at the expected revision and authorize automatic continuation.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 恢复目标 / Resume goal  ### Operation summary 恢复目标 / Resume goal
+     * 恢复目标 / Resume goal
+     */
+    resumeGoalRaw(requestParameters: ResumeGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentGoal>>;
+    /**
+     * ### 使用场景 携带目标标识与版本，恢复目标并重新授予自动续跑授权。  ### Use case Resume the identified goal at the expected revision and authorize automatic continuation.  ### 前置条件 有效渠道身份；会话资源必须属于当前用户。  ### Prerequisites Valid channel identity; conversation resources must belong to the current user.  ### 行为与副作用 携带目标标识与版本，恢复目标并重新授予自动续跑授权。  ### Behavior and side effects Resume the identified goal at the expected revision and authorize automatic continuation.  ### 后续调用 根据返回的权威状态更新客户端。  ### Next step Update the client using the returned authoritative state.  ### 接口摘要 恢复目标 / Resume goal  ### Operation summary 恢复目标 / Resume goal
+     * 恢复目标 / Resume goal
+     */
+    resumeGoal(requestParameters: ResumeGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentGoal>;
     /**
      * Creates request options for streamChatEvents without sending the request
      */
     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>;