1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'AlikafkaKopilot', 'version' => '2026-04-14'],
'directories' => ['KopilotChatStream', 'KopilotFeedback', 'KopilotListConversationChatMessages', 'KopilotListConversations', 'KopilotQueryStatus'],
'components' => [
'schemas' => [],
],
'apis' => [
'KopilotChatStream' => [
'path' => '/',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREalikafkaH77LGU'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'Message',
'in' => 'query',
'schema' => ['description' => 'The chat message content entered by the user.', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'efff104e-c0b1-4005-8c73-*********', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Role' => ['description' => 'The role identifier.', 'type' => 'string', 'example' => 'assistant', 'title' => ''],
'Type' => ['description' => 'The event or message type.', 'type' => 'string', 'example' => 'delta', 'title' => ''],
'Message' => ['description' => 'The message body.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'ThreadId' => ['description' => 'The session thread ID.', 'type' => 'string', 'example' => 'thread_abc123xyz', 'title' => ''],
'Delta' => ['description' => 'The streaming incremental content.', 'type' => 'string', 'example' => 'hello', 'title' => ''],
'ToolCallId' => ['description' => 'The unique ID of the tool invoke.', 'type' => 'string', 'example' => 'call_xyz789012', 'title' => ''],
'Content' => ['description' => 'The actual content.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'ToolCallName' => ['description' => 'The tool or function name.', 'type' => 'string', 'example' => 'search_knowledge_base', 'title' => ''],
'RunId' => ['description' => 'The run task ID.', 'type' => 'string', 'example' => '5737d000********', 'title' => ''],
'MessageId' => ['description' => 'The unique message ID.', 'type' => 'string', 'example' => '4b209618fd066c4354037b4b0634ffc9', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '76E1F1AA-6046-5074-96E2-79A37AFBD2FA', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Agent stream chat session',
'summary' => 'Initiates an agent stream chat session.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Role\\": \\"assistant\\",\\n \\"Type\\": \\"delta\\",\\n \\"Message\\": \\"test\\",\\n \\"ThreadId\\": \\"thread_abc123xyz\\",\\n \\"Delta\\": \\"hello\\",\\n \\"ToolCallId\\": \\"call_xyz789012\\",\\n \\"Content\\": \\"test\\",\\n \\"ToolCallName\\": \\"search_knowledge_base\\",\\n \\"RunId\\": \\"5737d000********\\",\\n \\"MessageId\\": \\"4b209618fd066c4354037b4b0634ffc9\\",\\n \\"RequestId\\": \\"76E1F1AA-6046-5074-96E2-79A37AFBD2FA\\"\\n}","type":"json"}]',
],
'KopilotFeedback' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREalikafkaH77LGU'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'e356c91c-8220-425c-9d86-********', 'title' => ''],
],
[
'name' => 'TurnId',
'in' => 'query',
'schema' => ['description' => 'The primary key ID.', 'type' => 'string', 'required' => false, 'example' => '5243231*****', 'title' => ''],
],
[
'name' => 'Feedback',
'in' => 'query',
'schema' => [
'description' => 'The user satisfaction level. Valid values:'."\n"
."\n"
.'- 1: satisfied'."\n"
.'- -1: not satisfied'."\n"
.'- 0: cancel the evaluation',
'enumValueTitles' => [],
'type' => 'string',
'required' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => 'The user feedback comment.', 'type' => 'string', 'required' => false, 'example' => 'good', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E522C7AB-AA99-53B1-BEE7-8BA83ED678F7'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Data' => [
'description' => 'The data returned when the call is successful.',
'type' => 'object',
'additionalProperties' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Evaluate user session',
'summary' => 'Evaluates a user session.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E522C7AB-AA99-53B1-BEE7-8BA83ED678F7\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"key\\": 1234\\n }\\n}","type":"json"}]',
],
'KopilotListConversationChatMessages' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREalikafkaH77LGU'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'e356c91c-8220-425c-9d86-********', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'BeforeTurnId',
'in' => 'query',
'schema' => ['description' => 'The cursor.'."\n"
."\n"
.'> If this parameter is not specified, the last pageSize turn IDs are returned. If this parameter is specified, the corresponding turn IDs are returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2345', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F69385B9-2139-5A07-AE64-37C4B6ED308E'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The return code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Data' => [
'description' => 'The data returned if the call is successful.',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '87ce9505-7dec-4fd7-bc7c-e66d949bfdc9', 'title' => ''],
'TotalTurns' => ['description' => 'The total number of turn IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'Messages' => [
'description' => 'The list of messages.',
'type' => 'array',
'items' => [
'description' => 'The message body.',
'type' => 'object',
'properties' => [
'Role' => ['description' => 'The role identifier.', 'type' => 'string', 'example' => 'assistant', 'title' => ''],
'Content' => ['description' => 'The actual content of the message.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '17575885545677', 'title' => ''],
'TurnId' => ['description' => 'The primary key ID.', 'type' => 'string', 'example' => '2345', 'title' => ''],
'Feedback' => ['description' => 'The user satisfaction level.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'HasMore' => ['description' => 'Indicates whether more data is available.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'NextBeforeTurnId' => ['description' => 'The cursor for the next page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query historical conversations',
'summary' => 'Queries historical conversations.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F69385B9-2139-5A07-AE64-37C4B6ED308E\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"SessionId\\": \\"87ce9505-7dec-4fd7-bc7c-e66d949bfdc9\\",\\n \\"TotalTurns\\": 2,\\n \\"Messages\\": [\\n {\\n \\"Role\\": \\"assistant\\",\\n \\"Content\\": \\"test\\",\\n \\"CreateTime\\": \\"17575885545677\\",\\n \\"TurnId\\": \\"2345\\",\\n \\"Feedback\\": \\"1\\"\\n }\\n ],\\n \\"HasMore\\": true,\\n \\"NextBeforeTurnId\\": 1\\n }\\n}","type":"json"}]',
],
'KopilotListConversations' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREalikafkaH77LGU'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Size',
'in' => 'query',
'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2DF166F2-F581-5254-AAB6-B482083FA7B4'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Data' => [
'description' => 'The data returned if the call is successful.',
'type' => 'object',
'properties' => [
'UserId' => ['description' => 'The user UID.', 'type' => 'string', 'example' => '1734455674565', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ConversationIds' => [
'description' => 'The list of session IDs.',
'type' => 'array',
'items' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'ids', 'title' => ''],
'title' => '',
'example' => '',
],
'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Size' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query all session iDs of a user',
'summary' => 'Queries the session IDs of the current user in the Console channel, sorted by creation time in descending order. Pagination is supported.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DF166F2-F581-5254-AAB6-B482083FA7B4\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"UserId\\": \\"1734455674565\\",\\n \\"Count\\": 1,\\n \\"ConversationIds\\": [\\n \\"ids\\"\\n ],\\n \\"Page\\": 1,\\n \\"Size\\": 10,\\n \\"Total\\": 2,\\n \\"TotalPages\\": 1\\n }\\n}","type":"json"}]',
],
'KopilotQueryStatus' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREalikafkaH77LGU'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => true, 'example' => '1590639435720201', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2DF166F2-F581-5254-AAB6-B482083FA7B4'],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Data' => [
'description' => 'The status information returned when the call is successful.',
'type' => 'object',
'properties' => [
'Uid' => ['description' => 'The UID of the user.', 'type' => 'string', 'example' => '206022063004684756', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''],
'LifeStatus' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'NotActivated', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'ActivateTime' => ['description' => 'The activation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '17346565678778', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query instance activation status',
'summary' => 'Queries the activation status of an instance.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DF166F2-F581-5254-AAB6-B482083FA7B4\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"Uid\\": \\"206022063004684756\\",\\n \\"InstanceId\\": \\"instanceId\\",\\n \\"LifeStatus\\": \\"NotActivated\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ActivateTime\\": 17346565678778\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [],
'errorCodes' => [],
'changeSet' => [],
];
|
