@lingya-ai/agents-sdk 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,50 +1,70 @@
1
1
  # 灵涯 Agents TypeScript SDK
2
2
  Lingya Agents SDK for TypeScript
3
3
 
4
- 这是面向可信 Node.js 服务端的灵涯 Agents OpenAPI 强类型 SDK;契约包含 46 个公共接口,并生成全部请求、响应、事件与工具扩展类型。
5
- This strongly typed Lingya Agents OpenAPI SDK is designed for trusted Node.js servers. Its contract covers 46 public operations and generates every request, response, event, and tool-extension type.
4
+ 用于在 Node.js 可信服务端调用灵涯 Agents OpenAPI。
5
+ Use this SDK to call Lingya Agents OpenAPI from a trusted Node.js server.
6
6
 
7
7
  ## 安装
8
8
  Installation
9
9
 
10
10
  ```bash
11
- npm install @lingya-ai/agents-sdk
11
+ npm install @lingya-ai/agents-sdk@0.4.0
12
12
  ```
13
13
 
14
- 包同时支持 CommonJS `require`、ES module `import` 与 TypeScript 类型声明,运行时要求 Node.js 20 或更高版本。
15
- The package supports CommonJS `require`, ES module `import`, and TypeScript declarations, and requires Node.js 20 or later.
14
+ 运行环境需要 Node.js 20 或更高版本。
15
+ The runtime requires Node.js 20 or later.
16
16
 
17
- ## 调用与 SSE
18
- Calls and SSE
17
+ ## 快速开始
18
+ Quick start
19
19
 
20
- ```ts
21
- import { LingyaAgentsClient } from '@lingya-ai/agents-sdk';
20
+ ```typescript
21
+ import { AgentsClient } from '@lingya-ai/agents-sdk';
22
22
 
23
- const user = new LingyaAgentsClient('https://lingtong.lingya.tech/', channelId, {
24
- accessKey: process.env.OPENAPI_AK!,
25
- secretKey: process.env.OPENAPI_SK!,
26
- }).forUser('external-user-id');
23
+ const user = new AgentsClient(
24
+ 'https://lingtong.lingya.tech/',
25
+ process.env.OPENAPI_CHANNEL_ID!,
26
+ {
27
+ accessKey: process.env.OPENAPI_AK!,
28
+ secretKey: process.env.OPENAPI_SK!,
29
+ },
30
+ ).forUser('external-user-id');
27
31
 
28
- const submission = await user.chat.createChat({
29
- query: '你好',
30
- });
32
+ const submission = await user.chat.createChat({ query: '你好' });
33
+ ```
34
+
35
+ `channelId` 只在创建 `AgentsClient` 时提供,业务方法不再接收它。
36
+ Provide `channelId` only when creating `AgentsClient`; business methods do not accept it.
31
37
 
38
+ ## SSE 事件流
39
+ SSE event stream
40
+
41
+ ```typescript
32
42
  for await (const event of user.chat.streamChatEvents(
33
43
  submission.conversationId,
34
44
  { messageId: submission.messageId },
35
45
  )) {
36
- if (event.type === 'end') break;
46
+ console.log(event.type);
37
47
  }
38
48
  ```
39
49
 
40
- 十个业务分组覆盖全部 46 个接口;`channelId` 只在根客户端构造时提供,`user.lowLevel` 仅作为迁移入口保留到 1.0。
41
- Ten business groups cover all 46 operations; provide `channelId` only to the root client, while `user.lowLevel` remains a migration-only escape hatch until 1.0.
50
+ ## API 分组
51
+ API groups
52
+
53
+ 可用分组为 `chat`、`configuration`、`conversations`、`events`、`files`、`interactions`、`knowledge`、`messages`、`sql` 和 `workspace`。
54
+ Available groups are `chat`, `configuration`, `conversations`, `events`, `files`, `interactions`, `knowledge`, `messages`, `sql`, and `workspace`.
42
55
 
43
- SDK 会在最终 URL、查询串、`Content-Type` 与正文(body)字节确定后签名;每次请求独立生成 nonce,secret 不会进入请求、日志或异常。
44
- The SDK signs only after the final URL, query string, `Content-Type`, and body bytes are fixed. Every request receives a fresh nonce, and the secret is never included in requests, logs, or exceptions.
56
+ ## 错误处理
57
+ Error handling
45
58
 
46
- 未知事件与工具扩展会分别保留为带 `rawJson` 的明确后备类型,已知结构不会退化为动态对象。
47
- Unknown events and tool extensions are retained in explicit fallback types with `rawJson`; known structures never degrade into dynamic objects.
59
+ ```typescript
60
+ import { ApiError } from '@lingya-ai/agents-sdk';
61
+
62
+ try {
63
+ await user.conversations.getConversationTitle('conversation-id');
64
+ } catch (error) {
65
+ if (error instanceof ApiError) console.error(error.status, error.responseBody);
66
+ }
67
+ ```
48
68
 
49
- 本 SDK 仅适用于可信服务端,不得在浏览器、桌面或移动客户端中分发 secret。
50
- This SDK is for trusted servers only. Never distribute the secret in browser, desktop, or mobile applications.
69
+ 请只在可信服务端保存 `secretKey`,不要将其放入浏览器、移动端、桌面端或日志。
70
+ Keep `secretKey` on trusted servers only; never put it in browsers, mobile apps, desktop apps, or logs.
package/dist/bound.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- import { ConfigurationApi, ChatApi, ConversationsApi, SQLApi, MessagesApi, EventsApi, InteractionsApi, FilesApi, KnowledgeApi, WorkspaceApi, type GetConversationConfigRequest, type CreateChatRequest, type ContinueChatRequest, type DeleteConversationRequest, type StreamChatEventsRequest, type ProbeEventStreamRequest, type InterruptConversationRequest, type CompactConversationRequest, type GetConversationContextUsageRequest, type ListConversationsRequest, type QueryConversationActivitiesRequest, type MarkConversationReadRequest, type GetConversationTitleRequest, type UpdateConversationTitleRequest, type UpdateConversationStatusRequest, type GetSqlQueryResultRequest, type GetSqlQueryChartDataRequest, type ExportSqlQueryResultRequest, type ListConversationMessagesRequest, type GetConversationMessageRequest, type ListConversationAsyncTasksRequest, type GetConversationAsyncTaskRequest, type CancelQueuedMessageRequest, type GetChatEventsRequest, type GetChatEventsBatchRequest, type ListConversationSharesRequest, type CreateConversationShareRequest, type RevokeConversationShareRequest, type ApprovePlanRequest, type GetPlanStatusRequest, type GetUserInputStatusRequest, type AnswerUserInputRequest, type CreatePreSignedUploadRequest, type ConfirmPreSignedUploadRequest, type CreateFileByContentMd5Request, type FileExistsByContentMd5Request, type GetConversationFilePreviewRequest, type GetPlanIntermediateFilePreviewRequest, type GetCitationMetadataBatchRequest, type GetCitationMetadataRequest, type ListWorkspaceArtifactsRequest, type GetWorkspaceFilePreviewRequest } from './apis';
1
+ import { ConfigurationApi as GeneratedConfigurationApi, ChatApi as GeneratedChatApi, ConversationsApi as GeneratedConversationsApi, SQLApi as GeneratedSQLApi, MessagesApi as GeneratedMessagesApi, EventsApi as GeneratedEventsApi, InteractionsApi as GeneratedInteractionsApi, FilesApi as GeneratedFilesApi, KnowledgeApi as GeneratedKnowledgeApi, WorkspaceApi as GeneratedWorkspaceApi, type GetConversationConfigRequest, type CreateChatRequest, type ContinueChatRequest, type DeleteConversationRequest, type StreamChatEventsRequest, type ProbeEventStreamRequest, type InterruptConversationRequest, type CompactConversationRequest, type GetConversationContextUsageRequest, type ListConversationsRequest, type QueryConversationActivitiesRequest, type MarkConversationReadRequest, type GetConversationTitleRequest, type UpdateConversationTitleRequest, type UpdateConversationStatusRequest, type GetSqlQueryResultRequest, type GetSqlQueryChartDataRequest, type ExportSqlQueryResultRequest, type ListConversationMessagesRequest, type GetConversationMessageRequest, type ListConversationAsyncTasksRequest, type GetConversationAsyncTaskRequest, type CancelQueuedMessageRequest, type GetChatEventsRequest, type GetChatEventsBatchRequest, type ListConversationSharesRequest, type CreateConversationShareRequest, type RevokeConversationShareRequest, type ApprovePlanRequest, type GetPlanStatusRequest, type GetUserInputStatusRequest, type AnswerUserInputRequest, type CreatePreSignedUploadRequest, type ConfirmPreSignedUploadRequest, type CreateFileByContentMd5Request, type FileExistsByContentMd5Request, type GetConversationFilePreviewRequest, type GetPlanIntermediateFilePreviewRequest, type GetCitationMetadataBatchRequest, type GetCitationMetadataRequest, type ListWorkspaceArtifactsRequest, type GetWorkspaceFilePreviewRequest } from './apis';
2
2
  import { type ChatStreamProbeEvent } from './models/ChatStreamProbeEvent';
3
- import { type LingyaAiChatBriefEvent } from './events';
3
+ import { type AiChatBriefEvent } from './events';
4
4
  type BoundRawRequest = (method: string, suffix: string, bodyJson: string | undefined, query: URLSearchParams | undefined, accept: string, requestId?: string) => Promise<Response>;
5
5
  /** Query values and optional request headers that are not bound by the client. */
6
6
  export type StreamChatEventsOptions = Omit<StreamChatEventsRequest, 'channelId' | 'conversationId' | 'aiChatStreamInput'>;
@@ -29,51 +29,51 @@ export type ListWorkspaceArtifactsOptions = Omit<ListWorkspaceArtifactsRequest,
29
29
  /** Query values and optional request headers that are not bound by the client. */
30
30
  export type GetWorkspaceFilePreviewOptions = Omit<GetWorkspaceFilePreviewRequest, 'channelId' | 'conversationId'>;
31
31
  /** Generated APIs retained as an explicit compatibility escape hatch until 1.0. */
32
- export declare class LingyaAgentsLowLevelApis {
33
- readonly configuration: ConfigurationApi;
34
- readonly chat: ChatApi;
35
- readonly conversations: ConversationsApi;
36
- readonly sql: SQLApi;
37
- readonly messages: MessagesApi;
38
- readonly events: EventsApi;
39
- readonly interactions: InteractionsApi;
40
- readonly files: FilesApi;
41
- readonly knowledge: KnowledgeApi;
42
- readonly workspace: WorkspaceApi;
43
- constructor(configuration: ConfigurationApi, chat: ChatApi, conversations: ConversationsApi, sql: SQLApi, messages: MessagesApi, events: EventsApi, interactions: InteractionsApi, files: FilesApi, knowledge: KnowledgeApi, workspace: WorkspaceApi);
32
+ export declare class AgentsLowLevelApis {
33
+ readonly configuration: GeneratedConfigurationApi;
34
+ readonly chat: GeneratedChatApi;
35
+ readonly conversations: GeneratedConversationsApi;
36
+ readonly sql: GeneratedSQLApi;
37
+ readonly messages: GeneratedMessagesApi;
38
+ readonly events: GeneratedEventsApi;
39
+ readonly interactions: GeneratedInteractionsApi;
40
+ readonly files: GeneratedFilesApi;
41
+ readonly knowledge: GeneratedKnowledgeApi;
42
+ readonly workspace: GeneratedWorkspaceApi;
43
+ constructor(configuration: GeneratedConfigurationApi, chat: GeneratedChatApi, conversations: GeneratedConversationsApi, sql: GeneratedSQLApi, messages: GeneratedMessagesApi, events: GeneratedEventsApi, interactions: GeneratedInteractionsApi, files: GeneratedFilesApi, knowledge: GeneratedKnowledgeApi, workspace: GeneratedWorkspaceApi);
44
44
  }
45
45
  /** Channel-bound configuration operations for one external user. */
46
- export declare class LingyaConfigurationApi {
46
+ export declare class ConfigurationApi {
47
47
  private readonly channelId;
48
48
  private readonly delegate;
49
- constructor(channelId: string, delegate: ConfigurationApi);
49
+ constructor(channelId: string, delegate: GeneratedConfigurationApi);
50
50
  /**
51
51
  * 读取 Agent 配置 / Get Agent configuration
52
52
  *
53
53
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
54
54
  */
55
- getAgentsConfig(): ReturnType<ConfigurationApi['getAgentsConfig']>;
55
+ getAgentsConfig(): ReturnType<GeneratedConfigurationApi['getAgentsConfig']>;
56
56
  /**
57
57
  * 读取会话配置 / Get conversation configuration
58
58
  *
59
59
  * @param conversationId - 会话 ID;必须属于当前外部用户。 / Conversation ID owned by the current external user.
60
60
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
61
61
  */
62
- getConversationConfig(conversationId: GetConversationConfigRequest['conversationId']): ReturnType<ConfigurationApi['getConversationConfig']>;
62
+ getConversationConfig(conversationId: GetConversationConfigRequest['conversationId']): ReturnType<GeneratedConfigurationApi['getConversationConfig']>;
63
63
  }
64
64
  /** Channel-bound chat operations for one external user. */
65
- export declare class LingyaChatApi {
65
+ export declare class ChatApi {
66
66
  private readonly channelId;
67
67
  private readonly delegate;
68
68
  private readonly rawRequest;
69
- constructor(channelId: string, delegate: ChatApi, rawRequest: BoundRawRequest);
69
+ constructor(channelId: string, delegate: GeneratedChatApi, rawRequest: BoundRawRequest);
70
70
  /**
71
71
  * 创建会话并提交消息 / Create a conversation and submit a message
72
72
  *
73
73
  * @param input - 创建会话并提交消息 / Create a conversation and submit a message 的强类型请求体。 / Typed request body for createChat.
74
74
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
75
75
  */
76
- createChat(input: CreateChatRequest['aiChatInput']): ReturnType<ChatApi['createChat']>;
76
+ createChat(input: CreateChatRequest['aiChatInput']): ReturnType<GeneratedChatApi['createChat']>;
77
77
  /**
78
78
  * 向已有会话提交消息 / Submit a message to an existing conversation
79
79
  *
@@ -81,7 +81,7 @@ export declare class LingyaChatApi {
81
81
  * @param input - 向已有会话提交消息 / Submit a message to an existing conversation 的强类型请求体。 / Typed request body for continueChat.
82
82
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
83
83
  */
84
- continueChat(conversationId: ContinueChatRequest['conversationId'], input: ContinueChatRequest['aiChatInput']): ReturnType<ChatApi['continueChat']>;
84
+ continueChat(conversationId: ContinueChatRequest['conversationId'], input: ContinueChatRequest['aiChatInput']): ReturnType<GeneratedChatApi['continueChat']>;
85
85
  /**
86
86
  * 订阅消息事件流 / Stream message events
87
87
  *
@@ -90,7 +90,7 @@ export declare class LingyaChatApi {
90
90
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
91
91
  * @returns 可取消的强类型事件序列。 / A cancellable typed event sequence.
92
92
  */
93
- streamChatEvents(conversationId: StreamChatEventsRequest['conversationId'], input: StreamChatEventsRequest['aiChatStreamInput'], options?: StreamChatEventsOptions): AsyncGenerator<LingyaAiChatBriefEvent>;
93
+ streamChatEvents(conversationId: StreamChatEventsRequest['conversationId'], input: StreamChatEventsRequest['aiChatStreamInput'], options?: StreamChatEventsOptions): AsyncGenerator<AiChatBriefEvent>;
94
94
  /**
95
95
  * 探测 SSE 连接 / Probe the SSE connection
96
96
  *
@@ -105,7 +105,7 @@ export declare class LingyaChatApi {
105
105
  * @param conversationId - 会话 ID;必须属于当前外部用户。 / Conversation ID owned by the current external user.
106
106
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
107
107
  */
108
- interruptConversation(conversationId: InterruptConversationRequest['conversationId']): ReturnType<ChatApi['interruptConversation']>;
108
+ interruptConversation(conversationId: InterruptConversationRequest['conversationId']): ReturnType<GeneratedChatApi['interruptConversation']>;
109
109
  /**
110
110
  * 压缩会话上下文 / Compact conversation context
111
111
  *
@@ -113,53 +113,53 @@ export declare class LingyaChatApi {
113
113
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
114
114
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
115
115
  */
116
- compactConversation(conversationId: CompactConversationRequest['conversationId'], options?: CompactConversationOptions): ReturnType<ChatApi['compactConversation']>;
116
+ compactConversation(conversationId: CompactConversationRequest['conversationId'], options?: CompactConversationOptions): ReturnType<GeneratedChatApi['compactConversation']>;
117
117
  }
118
118
  /** Channel-bound conversations operations for one external user. */
119
- export declare class LingyaConversationsApi {
119
+ export declare class ConversationsApi {
120
120
  private readonly channelId;
121
121
  private readonly delegate;
122
- constructor(channelId: string, delegate: ConversationsApi);
122
+ constructor(channelId: string, delegate: GeneratedConversationsApi);
123
123
  /**
124
124
  * 删除会话 / Delete a conversation
125
125
  *
126
126
  * @param conversationId - 会话 ID;必须属于当前外部用户。 / Conversation ID owned by the current external user.
127
127
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
128
128
  */
129
- deleteConversation(conversationId: DeleteConversationRequest['conversationId']): ReturnType<ConversationsApi['deleteConversation']>;
129
+ deleteConversation(conversationId: DeleteConversationRequest['conversationId']): ReturnType<GeneratedConversationsApi['deleteConversation']>;
130
130
  /**
131
131
  * 读取上下文占用 / Get context usage
132
132
  *
133
133
  * @param conversationId - 会话 ID;必须属于当前外部用户。 / Conversation ID owned by the current external user.
134
134
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
135
135
  */
136
- getConversationContextUsage(conversationId: GetConversationContextUsageRequest['conversationId']): ReturnType<ConversationsApi['getConversationContextUsage']>;
136
+ getConversationContextUsage(conversationId: GetConversationContextUsageRequest['conversationId']): ReturnType<GeneratedConversationsApi['getConversationContextUsage']>;
137
137
  /**
138
138
  * 分页查询会话 / List conversations
139
139
  *
140
140
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
141
141
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
142
142
  */
143
- listConversations(options?: ListConversationsOptions): ReturnType<ConversationsApi['listConversations']>;
143
+ listConversations(options?: ListConversationsOptions): ReturnType<GeneratedConversationsApi['listConversations']>;
144
144
  /**
145
145
  * 查询活动会话 / List active conversations
146
146
  *
147
147
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
148
148
  */
149
- listActiveConversations(): ReturnType<ConversationsApi['listActiveConversations']>;
149
+ listActiveConversations(): ReturnType<GeneratedConversationsApi['listActiveConversations']>;
150
150
  /**
151
151
  * 查询未读会话 / List unread conversations
152
152
  *
153
153
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
154
154
  */
155
- listUnreadConversations(): ReturnType<ConversationsApi['listUnreadConversations']>;
155
+ listUnreadConversations(): ReturnType<GeneratedConversationsApi['listUnreadConversations']>;
156
156
  /**
157
157
  * 批量查询会话活动 / Query conversation activities
158
158
  *
159
159
  * @param input - 批量查询会话活动 / Query conversation activities 的强类型请求体。 / Typed request body for queryConversationActivities.
160
160
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
161
161
  */
162
- queryConversationActivities(input: QueryConversationActivitiesRequest['conversationActivityBatchInput']): ReturnType<ConversationsApi['queryConversationActivities']>;
162
+ queryConversationActivities(input: QueryConversationActivitiesRequest['conversationActivityBatchInput']): ReturnType<GeneratedConversationsApi['queryConversationActivities']>;
163
163
  /**
164
164
  * 推进会话已读游标 / Mark a conversation as read
165
165
  *
@@ -167,20 +167,20 @@ export declare class LingyaConversationsApi {
167
167
  * @param input - 推进会话已读游标 / Mark a conversation as read 的强类型请求体。 / Typed request body for markConversationRead.
168
168
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
169
169
  */
170
- markConversationRead(conversationId: MarkConversationReadRequest['conversationId'], input: MarkConversationReadRequest['conversationReadReceiptInput']): ReturnType<ConversationsApi['markConversationRead']>;
170
+ markConversationRead(conversationId: MarkConversationReadRequest['conversationId'], input: MarkConversationReadRequest['conversationReadReceiptInput']): ReturnType<GeneratedConversationsApi['markConversationRead']>;
171
171
  /**
172
172
  * 读取会话统计 / Get conversation statistics
173
173
  *
174
174
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
175
175
  */
176
- getConversationStats(): ReturnType<ConversationsApi['getConversationStats']>;
176
+ getConversationStats(): ReturnType<GeneratedConversationsApi['getConversationStats']>;
177
177
  /**
178
178
  * 读取会话标题 / Get conversation title
179
179
  *
180
180
  * @param conversationId - 会话 ID;必须属于当前外部用户。 / Conversation ID owned by the current external user.
181
181
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
182
182
  */
183
- getConversationTitle(conversationId: GetConversationTitleRequest['conversationId']): ReturnType<ConversationsApi['getConversationTitle']>;
183
+ getConversationTitle(conversationId: GetConversationTitleRequest['conversationId']): ReturnType<GeneratedConversationsApi['getConversationTitle']>;
184
184
  /**
185
185
  * 更新会话标题 / Update conversation title
186
186
  *
@@ -188,7 +188,7 @@ export declare class LingyaConversationsApi {
188
188
  * @param input - 更新会话标题 / Update conversation title 的强类型请求体。 / Typed request body for updateConversationTitle.
189
189
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
190
190
  */
191
- updateConversationTitle(conversationId: UpdateConversationTitleRequest['conversationId'], input: UpdateConversationTitleRequest['conversationTitleInput']): ReturnType<ConversationsApi['updateConversationTitle']>;
191
+ updateConversationTitle(conversationId: UpdateConversationTitleRequest['conversationId'], input: UpdateConversationTitleRequest['conversationTitleInput']): ReturnType<GeneratedConversationsApi['updateConversationTitle']>;
192
192
  /**
193
193
  * 更新会话状态 / Update conversation status
194
194
  *
@@ -196,14 +196,14 @@ export declare class LingyaConversationsApi {
196
196
  * @param input - 更新会话状态 / Update conversation status 的强类型请求体。 / Typed request body for updateConversationStatus.
197
197
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
198
198
  */
199
- updateConversationStatus(conversationId: UpdateConversationStatusRequest['conversationId'], input: UpdateConversationStatusRequest['conversationStatusInput']): ReturnType<ConversationsApi['updateConversationStatus']>;
199
+ updateConversationStatus(conversationId: UpdateConversationStatusRequest['conversationId'], input: UpdateConversationStatusRequest['conversationStatusInput']): ReturnType<GeneratedConversationsApi['updateConversationStatus']>;
200
200
  /**
201
201
  * 查询会话分享 / List conversation shares
202
202
  *
203
203
  * @param conversationId - 会话 ID;必须属于当前外部用户。 / Conversation ID owned by the current external user.
204
204
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
205
205
  */
206
- listConversationShares(conversationId: ListConversationSharesRequest['conversationId']): ReturnType<ConversationsApi['listConversationShares']>;
206
+ listConversationShares(conversationId: ListConversationSharesRequest['conversationId']): ReturnType<GeneratedConversationsApi['listConversationShares']>;
207
207
  /**
208
208
  * 创建会话分享 / Create a conversation share
209
209
  *
@@ -211,7 +211,7 @@ export declare class LingyaConversationsApi {
211
211
  * @param input - 创建会话分享 / Create a conversation share 的强类型请求体。 / Typed request body for createConversationShare.
212
212
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
213
213
  */
214
- createConversationShare(conversationId: CreateConversationShareRequest['conversationId'], input: CreateConversationShareRequest['conversationShareInput']): ReturnType<ConversationsApi['createConversationShare']>;
214
+ createConversationShare(conversationId: CreateConversationShareRequest['conversationId'], input: CreateConversationShareRequest['conversationShareInput']): ReturnType<GeneratedConversationsApi['createConversationShare']>;
215
215
  /**
216
216
  * 撤销会话分享 / Revoke a conversation share
217
217
  *
@@ -219,13 +219,13 @@ export declare class LingyaConversationsApi {
219
219
  * @param shareId - 会话分享记录 ID。 / Conversation-share record ID.
220
220
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
221
221
  */
222
- revokeConversationShare(conversationId: RevokeConversationShareRequest['conversationId'], shareId: RevokeConversationShareRequest['shareId']): ReturnType<ConversationsApi['revokeConversationShare']>;
222
+ revokeConversationShare(conversationId: RevokeConversationShareRequest['conversationId'], shareId: RevokeConversationShareRequest['shareId']): ReturnType<GeneratedConversationsApi['revokeConversationShare']>;
223
223
  }
224
224
  /** Channel-bound sql operations for one external user. */
225
- export declare class LingyaSqlApi {
225
+ export declare class SqlApi {
226
226
  private readonly channelId;
227
227
  private readonly delegate;
228
- constructor(channelId: string, delegate: SQLApi);
228
+ constructor(channelId: string, delegate: GeneratedSQLApi);
229
229
  /**
230
230
  * 分页读取 SQL 结果 / Get paged SQL results
231
231
  *
@@ -234,7 +234,7 @@ export declare class LingyaSqlApi {
234
234
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
235
235
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
236
236
  */
237
- getSqlQueryResult(conversationId: GetSqlQueryResultRequest['conversationId'], resultId: GetSqlQueryResultRequest['resultId'], options?: GetSqlQueryResultOptions): ReturnType<SQLApi['getSqlQueryResult']>;
237
+ getSqlQueryResult(conversationId: GetSqlQueryResultRequest['conversationId'], resultId: GetSqlQueryResultRequest['resultId'], options?: GetSqlQueryResultOptions): ReturnType<GeneratedSQLApi['getSqlQueryResult']>;
238
238
  /**
239
239
  * 读取 SQL 图表数据 / Get SQL chart data
240
240
  *
@@ -242,7 +242,7 @@ export declare class LingyaSqlApi {
242
242
  * @param resultId - SQL 查询结果 ID。 / SQL query-result ID.
243
243
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
244
244
  */
245
- getSqlQueryChartData(conversationId: GetSqlQueryChartDataRequest['conversationId'], resultId: GetSqlQueryChartDataRequest['resultId']): ReturnType<SQLApi['getSqlQueryChartData']>;
245
+ getSqlQueryChartData(conversationId: GetSqlQueryChartDataRequest['conversationId'], resultId: GetSqlQueryChartDataRequest['resultId']): ReturnType<GeneratedSQLApi['getSqlQueryChartData']>;
246
246
  /**
247
247
  * 导出 SQL 结果 / Export SQL results
248
248
  *
@@ -254,10 +254,10 @@ export declare class LingyaSqlApi {
254
254
  exportSqlQueryResult(conversationId: ExportSqlQueryResultRequest['conversationId'], resultId: ExportSqlQueryResultRequest['resultId'], options: ExportSqlQueryResultOptions): Promise<Uint8Array>;
255
255
  }
256
256
  /** Channel-bound messages operations for one external user. */
257
- export declare class LingyaMessagesApi {
257
+ export declare class MessagesApi {
258
258
  private readonly channelId;
259
259
  private readonly delegate;
260
- constructor(channelId: string, delegate: MessagesApi);
260
+ constructor(channelId: string, delegate: GeneratedMessagesApi);
261
261
  /**
262
262
  * 分页查询会话消息 / List conversation messages
263
263
  *
@@ -265,7 +265,7 @@ export declare class LingyaMessagesApi {
265
265
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
266
266
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
267
267
  */
268
- listConversationMessages(conversationId: ListConversationMessagesRequest['conversationId'], options?: ListConversationMessagesOptions): ReturnType<MessagesApi['listConversationMessages']>;
268
+ listConversationMessages(conversationId: ListConversationMessagesRequest['conversationId'], options?: ListConversationMessagesOptions): ReturnType<GeneratedMessagesApi['listConversationMessages']>;
269
269
  /**
270
270
  * 读取单条会话消息 / Get a conversation message
271
271
  *
@@ -273,7 +273,7 @@ export declare class LingyaMessagesApi {
273
273
  * @param messageId - 用户消息 ID;必须属于指定会话。 / User-message ID owned by the specified conversation.
274
274
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
275
275
  */
276
- getConversationMessage(conversationId: GetConversationMessageRequest['conversationId'], messageId: GetConversationMessageRequest['messageId']): ReturnType<MessagesApi['getConversationMessage']>;
276
+ getConversationMessage(conversationId: GetConversationMessageRequest['conversationId'], messageId: GetConversationMessageRequest['messageId']): ReturnType<GeneratedMessagesApi['getConversationMessage']>;
277
277
  /**
278
278
  * 分页查询异步任务 / List asynchronous tasks
279
279
  *
@@ -281,7 +281,7 @@ export declare class LingyaMessagesApi {
281
281
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
282
282
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
283
283
  */
284
- listConversationAsyncTasks(conversationId: ListConversationAsyncTasksRequest['conversationId'], options?: ListConversationAsyncTasksOptions): ReturnType<MessagesApi['listConversationAsyncTasks']>;
284
+ listConversationAsyncTasks(conversationId: ListConversationAsyncTasksRequest['conversationId'], options?: ListConversationAsyncTasksOptions): ReturnType<GeneratedMessagesApi['listConversationAsyncTasks']>;
285
285
  /**
286
286
  * 读取异步任务 / Get an asynchronous task
287
287
  *
@@ -289,7 +289,7 @@ export declare class LingyaMessagesApi {
289
289
  * @param asyncTaskId - 异步任务 ID。 / Asynchronous task ID.
290
290
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
291
291
  */
292
- getConversationAsyncTask(conversationId: GetConversationAsyncTaskRequest['conversationId'], asyncTaskId: GetConversationAsyncTaskRequest['asyncTaskId']): ReturnType<MessagesApi['getConversationAsyncTask']>;
292
+ getConversationAsyncTask(conversationId: GetConversationAsyncTaskRequest['conversationId'], asyncTaskId: GetConversationAsyncTaskRequest['asyncTaskId']): ReturnType<GeneratedMessagesApi['getConversationAsyncTask']>;
293
293
  /**
294
294
  * 取消排队消息 / Cancel a queued message
295
295
  *
@@ -297,47 +297,47 @@ export declare class LingyaMessagesApi {
297
297
  * @param messageId - 用户消息 ID;必须属于指定会话。 / User-message ID owned by the specified conversation.
298
298
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
299
299
  */
300
- cancelQueuedMessage(conversationId: CancelQueuedMessageRequest['conversationId'], messageId: CancelQueuedMessageRequest['messageId']): ReturnType<MessagesApi['cancelQueuedMessage']>;
300
+ cancelQueuedMessage(conversationId: CancelQueuedMessageRequest['conversationId'], messageId: CancelQueuedMessageRequest['messageId']): ReturnType<GeneratedMessagesApi['cancelQueuedMessage']>;
301
301
  }
302
302
  /** Channel-bound events operations for one external user. */
303
- export declare class LingyaEventsApi {
303
+ export declare class EventsApi {
304
304
  private readonly channelId;
305
305
  private readonly delegate;
306
- constructor(channelId: string, delegate: EventsApi);
306
+ constructor(channelId: string, delegate: GeneratedEventsApi);
307
307
  /**
308
308
  * 读取消息事件 / Get message events
309
309
  *
310
310
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
311
311
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
312
312
  */
313
- getChatEvents(options: GetChatEventsOptions): ReturnType<EventsApi['getChatEvents']>;
313
+ getChatEvents(options: GetChatEventsOptions): ReturnType<GeneratedEventsApi['getChatEvents']>;
314
314
  /**
315
315
  * 批量读取消息事件 / Get message events in batch
316
316
  *
317
317
  * @param input - 批量读取消息事件 / Get message events in batch 的强类型请求体。 / Typed request body for getChatEventsBatch.
318
318
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
319
319
  */
320
- getChatEventsBatch(input: GetChatEventsBatchRequest['aiChatEventsBatchInput']): ReturnType<EventsApi['getChatEventsBatch']>;
320
+ getChatEventsBatch(input: GetChatEventsBatchRequest['aiChatEventsBatchInput']): ReturnType<GeneratedEventsApi['getChatEventsBatch']>;
321
321
  }
322
322
  /** Channel-bound interactions operations for one external user. */
323
- export declare class LingyaInteractionsApi {
323
+ export declare class InteractionsApi {
324
324
  private readonly channelId;
325
325
  private readonly delegate;
326
- constructor(channelId: string, delegate: InteractionsApi);
326
+ constructor(channelId: string, delegate: GeneratedInteractionsApi);
327
327
  /**
328
328
  * 提交计划审批 / Submit plan approval
329
329
  *
330
330
  * @param input - 提交计划审批 / Submit plan approval 的强类型请求体。 / Typed request body for approvePlan.
331
331
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
332
332
  */
333
- approvePlan(input: ApprovePlanRequest['planApprovalInput']): ReturnType<InteractionsApi['approvePlan']>;
333
+ approvePlan(input: ApprovePlanRequest['planApprovalInput']): ReturnType<GeneratedInteractionsApi['approvePlan']>;
334
334
  /**
335
335
  * 查询计划审批状态 / Get plan approval status
336
336
  *
337
337
  * @param planId - 等待审批的计划 ID。 / Pending plan-approval ID.
338
338
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
339
339
  */
340
- getPlanStatus(planId: GetPlanStatusRequest['planId']): ReturnType<InteractionsApi['getPlanStatus']>;
340
+ getPlanStatus(planId: GetPlanStatusRequest['planId']): ReturnType<GeneratedInteractionsApi['getPlanStatus']>;
341
341
  /**
342
342
  * 查询用户问答状态 / Get user-input status
343
343
  *
@@ -345,48 +345,48 @@ export declare class LingyaInteractionsApi {
345
345
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
346
346
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
347
347
  */
348
- getUserInputStatus(questionId: GetUserInputStatusRequest['questionId'], options: GetUserInputStatusOptions): ReturnType<InteractionsApi['getUserInputStatus']>;
348
+ getUserInputStatus(questionId: GetUserInputStatusRequest['questionId'], options: GetUserInputStatusOptions): ReturnType<GeneratedInteractionsApi['getUserInputStatus']>;
349
349
  /**
350
350
  * 提交用户回答 / Submit a user answer
351
351
  *
352
352
  * @param input - 提交用户回答 / Submit a user answer 的强类型请求体。 / Typed request body for answerUserInput.
353
353
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
354
354
  */
355
- answerUserInput(input: AnswerUserInputRequest['userInputAnswerInput']): ReturnType<InteractionsApi['answerUserInput']>;
355
+ answerUserInput(input: AnswerUserInputRequest['userInputAnswerInput']): ReturnType<GeneratedInteractionsApi['answerUserInput']>;
356
356
  }
357
357
  /** Channel-bound files operations for one external user. */
358
- export declare class LingyaFilesApi {
358
+ export declare class FilesApi {
359
359
  private readonly channelId;
360
360
  private readonly delegate;
361
- constructor(channelId: string, delegate: FilesApi);
361
+ constructor(channelId: string, delegate: GeneratedFilesApi);
362
362
  /**
363
363
  * 创建预签名上传地址 / Create a presigned upload URL
364
364
  *
365
365
  * @param input - 创建预签名上传地址 / Create a presigned upload URL 的强类型请求体。 / Typed request body for createPreSignedUpload.
366
366
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
367
367
  */
368
- createPreSignedUpload(input: CreatePreSignedUploadRequest['generatePreSignedUrlInput']): ReturnType<FilesApi['createPreSignedUpload']>;
368
+ createPreSignedUpload(input: CreatePreSignedUploadRequest['generatePreSignedUrlInput']): ReturnType<GeneratedFilesApi['createPreSignedUpload']>;
369
369
  /**
370
370
  * 确认预签名上传 / Confirm a presigned upload
371
371
  *
372
372
  * @param input - 确认预签名上传 / Confirm a presigned upload 的强类型请求体。 / Typed request body for confirmPreSignedUpload.
373
373
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
374
374
  */
375
- confirmPreSignedUpload(input: ConfirmPreSignedUploadRequest['confirmUploadInput']): ReturnType<FilesApi['confirmPreSignedUpload']>;
375
+ confirmPreSignedUpload(input: ConfirmPreSignedUploadRequest['confirmUploadInput']): ReturnType<GeneratedFilesApi['confirmPreSignedUpload']>;
376
376
  /**
377
377
  * 按 MD5 复用文件 / Reuse a file by MD5
378
378
  *
379
379
  * @param input - 按 MD5 复用文件 / Reuse a file by MD5 的强类型请求体。 / Typed request body for createFileByContentMd5.
380
380
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
381
381
  */
382
- createFileByContentMd5(input: CreateFileByContentMd5Request['createFileInput']): ReturnType<FilesApi['createFileByContentMd5']>;
382
+ createFileByContentMd5(input: CreateFileByContentMd5Request['createFileInput']): ReturnType<GeneratedFilesApi['createFileByContentMd5']>;
383
383
  /**
384
384
  * 检查 MD5 文件是否存在 / Check file existence by MD5
385
385
  *
386
386
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
387
387
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
388
388
  */
389
- fileExistsByContentMd5(options: FileExistsByContentMd5Options): ReturnType<FilesApi['fileExistsByContentMd5']>;
389
+ fileExistsByContentMd5(options: FileExistsByContentMd5Options): ReturnType<GeneratedFilesApi['fileExistsByContentMd5']>;
390
390
  /**
391
391
  * 创建会话文件预览地址 / Create a conversation file preview URL
392
392
  *
@@ -394,7 +394,7 @@ export declare class LingyaFilesApi {
394
394
  * @param fileId - 文件记录 ID。 / File record ID.
395
395
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
396
396
  */
397
- getConversationFilePreview(conversationId: GetConversationFilePreviewRequest['conversationId'], fileId: GetConversationFilePreviewRequest['fileId']): ReturnType<FilesApi['getConversationFilePreview']>;
397
+ getConversationFilePreview(conversationId: GetConversationFilePreviewRequest['conversationId'], fileId: GetConversationFilePreviewRequest['fileId']): ReturnType<GeneratedFilesApi['getConversationFilePreview']>;
398
398
  /**
399
399
  * 创建计划快照预览地址 / Create a plan snapshot preview URL
400
400
  *
@@ -403,20 +403,20 @@ export declare class LingyaFilesApi {
403
403
  * @param fileId - 文件记录 ID。 / File record ID.
404
404
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
405
405
  */
406
- getPlanIntermediateFilePreview(conversationId: GetPlanIntermediateFilePreviewRequest['conversationId'], messageId: GetPlanIntermediateFilePreviewRequest['messageId'], fileId: GetPlanIntermediateFilePreviewRequest['fileId']): ReturnType<FilesApi['getPlanIntermediateFilePreview']>;
406
+ getPlanIntermediateFilePreview(conversationId: GetPlanIntermediateFilePreviewRequest['conversationId'], messageId: GetPlanIntermediateFilePreviewRequest['messageId'], fileId: GetPlanIntermediateFilePreviewRequest['fileId']): ReturnType<GeneratedFilesApi['getPlanIntermediateFilePreview']>;
407
407
  }
408
408
  /** Channel-bound knowledge operations for one external user. */
409
- export declare class LingyaKnowledgeApi {
409
+ export declare class KnowledgeApi {
410
410
  private readonly channelId;
411
411
  private readonly delegate;
412
- constructor(channelId: string, delegate: KnowledgeApi);
412
+ constructor(channelId: string, delegate: GeneratedKnowledgeApi);
413
413
  /**
414
414
  * 批量读取引用元数据 / Get citation metadata in batch
415
415
  *
416
416
  * @param input - 批量读取引用元数据 / Get citation metadata in batch 的强类型请求体。 / Typed request body for getCitationMetadataBatch.
417
417
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
418
418
  */
419
- getCitationMetadataBatch(input: GetCitationMetadataBatchRequest['returnedReference']): ReturnType<KnowledgeApi['getCitationMetadataBatch']>;
419
+ getCitationMetadataBatch(input: GetCitationMetadataBatchRequest['returnedReference']): ReturnType<GeneratedKnowledgeApi['getCitationMetadataBatch']>;
420
420
  /**
421
421
  * 读取引用元数据 / Get citation metadata
422
422
  *
@@ -424,13 +424,13 @@ export declare class LingyaKnowledgeApi {
424
424
  * @param referenceId - 知识引用记录 ID。 / Knowledge-reference record ID.
425
425
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
426
426
  */
427
- getCitationMetadata(citationType: GetCitationMetadataRequest['citationType'], referenceId: GetCitationMetadataRequest['referenceId']): ReturnType<KnowledgeApi['getCitationMetadata']>;
427
+ getCitationMetadata(citationType: GetCitationMetadataRequest['citationType'], referenceId: GetCitationMetadataRequest['referenceId']): ReturnType<GeneratedKnowledgeApi['getCitationMetadata']>;
428
428
  }
429
429
  /** Channel-bound workspace operations for one external user. */
430
- export declare class LingyaWorkspaceApi {
430
+ export declare class WorkspaceApi {
431
431
  private readonly channelId;
432
432
  private readonly delegate;
433
- constructor(channelId: string, delegate: WorkspaceApi);
433
+ constructor(channelId: string, delegate: GeneratedWorkspaceApi);
434
434
  /**
435
435
  * 分页查询工作区制品 / List workspace artifacts
436
436
  *
@@ -438,7 +438,7 @@ export declare class LingyaWorkspaceApi {
438
438
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
439
439
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
440
440
  */
441
- listWorkspaceArtifacts(conversationId: ListWorkspaceArtifactsRequest['conversationId'], options?: ListWorkspaceArtifactsOptions): ReturnType<WorkspaceApi['listWorkspaceArtifacts']>;
441
+ listWorkspaceArtifacts(conversationId: ListWorkspaceArtifactsRequest['conversationId'], options?: ListWorkspaceArtifactsOptions): ReturnType<GeneratedWorkspaceApi['listWorkspaceArtifacts']>;
442
442
  /**
443
443
  * 创建工作区文件预览地址 / Create a workspace file preview URL
444
444
  *
@@ -446,6 +446,27 @@ export declare class LingyaWorkspaceApi {
446
446
  * @param options - 查询参数与可选请求头。 / Query parameters and optional request headers.
447
447
  * @returns 契约定义的强类型响应。 / The typed response defined by the contract.
448
448
  */
449
- getWorkspaceFilePreview(conversationId: GetWorkspaceFilePreviewRequest['conversationId'], options: GetWorkspaceFilePreviewOptions): ReturnType<WorkspaceApi['getWorkspaceFilePreview']>;
449
+ getWorkspaceFilePreview(conversationId: GetWorkspaceFilePreviewRequest['conversationId'], options: GetWorkspaceFilePreviewOptions): ReturnType<GeneratedWorkspaceApi['getWorkspaceFilePreview']>;
450
450
  }
451
- export {};
451
+ /** @deprecated Use AgentsLowLevelApis. */
452
+ export { AgentsLowLevelApis as LingyaAgentsLowLevelApis };
453
+ /** @deprecated Use ConfigurationApi. */
454
+ export { ConfigurationApi as LingyaConfigurationApi };
455
+ /** @deprecated Use ChatApi. */
456
+ export { ChatApi as LingyaChatApi };
457
+ /** @deprecated Use ConversationsApi. */
458
+ export { ConversationsApi as LingyaConversationsApi };
459
+ /** @deprecated Use SqlApi. */
460
+ export { SqlApi as LingyaSqlApi };
461
+ /** @deprecated Use MessagesApi. */
462
+ export { MessagesApi as LingyaMessagesApi };
463
+ /** @deprecated Use EventsApi. */
464
+ export { EventsApi as LingyaEventsApi };
465
+ /** @deprecated Use InteractionsApi. */
466
+ export { InteractionsApi as LingyaInteractionsApi };
467
+ /** @deprecated Use FilesApi. */
468
+ export { FilesApi as LingyaFilesApi };
469
+ /** @deprecated Use KnowledgeApi. */
470
+ export { KnowledgeApi as LingyaKnowledgeApi };
471
+ /** @deprecated Use WorkspaceApi. */
472
+ export { WorkspaceApi as LingyaWorkspaceApi };