summaryrefslogtreecommitdiff
path: root/data/paicopilot/2025-07-31/api-docs.php
blob: 09ea4365728f9947254485cbf74297edc9042360 (plain)
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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'PAICopilot', 'version' => '2025-07-31'],
    'components' => [
        'schemas' => [
            'Chat' => [
                'type' => 'object',
                'properties' => [
                    'ChatId' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string', 'format' => 'iso8601_normal'],
                    'GmtModified' => ['type' => 'string', 'format' => 'iso8601_normal'],
                    'Question' => ['$ref' => '#/components/schemas/ChatDetail'],
                    'Answer' => ['$ref' => '#/components/schemas/ChatDetail'],
                    'OwnerId' => ['type' => 'string'],
                    'UserId' => ['type' => 'string'],
                    'Title' => ['type' => 'string'],
                    'SessionId' => ['type' => 'string'],
                    'Status' => ['type' => 'string'],
                    'ExtraData' => ['type' => 'string'],
                    'Message' => ['type' => 'string'],
                ],
            ],
            'ChatDetail' => [
                'type' => 'object',
                'properties' => [
                    'UserInfo' => [
                        'type' => 'object',
                        'properties' => [
                            'Role' => ['type' => 'string'],
                            'Name' => ['type' => 'string'],
                        ],
                    ],
                    'Content' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string', 'format' => 'iso8601_normal'],
                ],
            ],
            'Feedback' => [
                'type' => 'object',
                'properties' => [
                    'FeedbackId' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string', 'format' => 'iso8601_normal'],
                    'GmtModified' => ['type' => 'string', 'format' => 'iso8601_normal'],
                    'FeedbackAction' => ['type' => 'string'],
                    'FeedbackMessage' => ['type' => 'string'],
                    'OwnerId' => ['type' => 'string'],
                    'UserId' => ['type' => 'string'],
                    'SessionId' => ['type' => 'string'],
                    'ChatId' => ['type' => 'string'],
                ],
            ],
            'Label' => [
                'type' => 'object',
                'properties' => [
                    'Key' => ['type' => 'string'],
                    'Value' => ['type' => 'string'],
                ],
            ],
            'Session' => [
                'type' => 'object',
                'properties' => [
                    'SessionId' => ['type' => 'string'],
                    'GmtCreateTime' => ['type' => 'string', 'format' => 'iso8601_normal'],
                    'GmtModified' => ['type' => 'string', 'format' => 'iso8601_normal'],
                    'OwnerId' => ['type' => 'string'],
                    'UserId' => ['type' => 'string'],
                    'SessionTitle' => ['type' => 'string'],
                ],
            ],
        ],
    ],
    'apis' => [
        'CreateChat' => [
            'path' => '/api/v1/sessions/{SessionId}/chats',
            'methods' => ['post'],
            'schemes' => ['https', 'sse'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => [],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SessionId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'Title' => ['type' => 'string', 'required' => false],
                            'ExtraData' => ['type' => 'string', 'required' => false],
                            'Question' => ['$ref' => '#/components/schemas/ChatDetail', 'required' => false],
                            'Payload' => ['type' => 'object', 'required' => false],
                        ],
                    ],
                ],
            ],
        ],
        'CreateSession' => [
            'path' => '/api/v1/sessions',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'Title' => ['type' => 'string', 'required' => false],
                            'Labels' => [
                                'type' => 'array',
                                'required' => false,
                                'items' => ['$ref' => '#/components/schemas/Label', 'required' => false],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'DeleteChat' => [
            'path' => '/api/v1/sessions/{SessionId}/chats/{ChatId}',
            'methods' => ['delete'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SessionId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'ChatId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'DeleteSession' => [
            'path' => '/api/v1/sessions/{SessionId}',
            'methods' => ['delete'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SessionId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'GetChat' => [
            'path' => '/api/v1/sessions/{SessionId}/chats/{ChatId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'ChatId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Verbose',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'SessionId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'GetSession' => [
            'path' => '/api/v1/sessions/{SessionId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SessionId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'ListChats' => [
            'path' => '/api/v1/sessions/{SessionId}/chats',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'PageNumber',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'SortBy',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'SessionId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Order',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Verbose',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
            ],
        ],
        'ListSessions' => [
            'path' => '/api/v1/sessions',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'PageNumber',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'SortBy',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Order',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'Labels',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'SearchInfo' => [
            'path' => '/api/v1/searches',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'KnowledgeBaseFilters' => [
                                'type' => 'array',
                                'required' => false,
                                'items' => [
                                    'type' => 'object',
                                    'required' => false,
                                    'properties' => [
                                        'CollectionName' => ['type' => 'string', 'required' => true],
                                        'ResultLimit' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                        'ScoreThreshold' => ['type' => 'number', 'format' => 'double', 'required' => false],
                                        'Query' => ['type' => 'string', 'required' => true],
                                    ],
                                ],
                            ],
                            'WebFilters' => [
                                'type' => 'array',
                                'required' => false,
                                'items' => [
                                    'type' => 'object',
                                    'required' => false,
                                    'properties' => [
                                        'ResultLimit' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                        'IncludeSites' => [
                                            'type' => 'array',
                                            'required' => false,
                                            'items' => ['type' => 'string', 'required' => false],
                                        ],
                                        'ScoreThreshold' => ['type' => 'number', 'format' => 'double', 'required' => false],
                                        'Query' => ['type' => 'string', 'required' => true],
                                        'Category' => ['type' => 'string', 'required' => false],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paicopilot.ap-southeast-1.aliyuncs.com', 'endpoint' => 'paicopilot.ap-southeast-1.aliyuncs.com', 'vpc' => 'paicopilot-vpc.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paicopilot.cn-beijing.aliyuncs.com', 'endpoint' => 'paicopilot.cn-beijing.aliyuncs.com', 'vpc' => 'paicopilot-vpc.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paicopilot.cn-hangzhou.aliyuncs.com', 'endpoint' => 'paicopilot.cn-hangzhou.aliyuncs.com', 'vpc' => 'paicopilot-vpc.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paicopilot.cn-shanghai.aliyuncs.com', 'endpoint' => 'paicopilot.cn-shanghai.aliyuncs.com', 'vpc' => 'paicopilot-vpc.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paicopilot.cn-shenzhen.aliyuncs.com', 'endpoint' => 'paicopilot.cn-shenzhen.aliyuncs.com', 'vpc' => 'paicopilot-vpc.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paicopilot.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'paicopilot.cn-wulanchabu.aliyuncs.com', 'vpc' => 'paicopilot-vpc.cn-wulanchabu.aliyuncs.com'],
    ],
];