data/aisearchengine/2026-04-17/api-docs.php


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

<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'AiSearchEngine', 'version' => '2026-04-17'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'EngineSearch' => [
            'path' => '/api/v1/platform/app/search',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
                [
                    'ApiKey' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'appId' => ['type' => 'string', 'required' => true],
                            'sessionId' => ['type' => 'string', 'required' => false],
                            'query' => [
                                'type' => 'object',
                                'required' => true,
                                'properties' => [
                                    'texts' => [
                                        'type' => 'array',
                                        'required' => false,
                                        'items' => ['type' => 'string', 'required' => false],
                                    ],
                                    'imageUrls' => [
                                        'type' => 'array',
                                        'required' => false,
                                        'items' => ['type' => 'string', 'required' => false],
                                    ],
                                    'pageSize' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'pageNo' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                    'excludeIds' => [
                                        'type' => 'array',
                                        'required' => false,
                                        'items' => ['type' => 'string', 'required' => false],
                                    ],
                                ],
                            ],
                            'grey' => ['type' => 'boolean', 'required' => false],
                            'user' => [
                                'type' => 'object',
                                'required' => false,
                                'properties' => [
                                    'userId' => ['type' => 'string', 'required' => false],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'GetDatasetResourceUrl' => [
            'path' => '/api/v1/dataset/open/resources',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
                [
                    'ApiKey' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'datasetId' => ['type' => 'string', 'format' => 'int64', 'required' => true],
                            'primaryKey' => ['type' => 'string', 'required' => true],
                        ],
                    ],
                ],
            ],
        ],
        'ImportDatasetData' => [
            'path' => '/api/v1/dataset/open/upsert',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
                [
                    'ApiKey' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'datasetId' => ['type' => 'string', 'format' => 'int64', 'required' => true],
                            'records' => [
                                'type' => 'array',
                                'required' => true,
                                'items' => [
                                    'type' => 'object',
                                    'required' => false,
                                    'additionalProperties' => ['type' => 'any'],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'QaChat' => [
            'path' => '/api/v1/platform/app/chat',
            'methods' => ['post'],
            'schemes' => ['https', 'sse'],
            'security' => [
                [
                    'AK' => [],
                ],
                [
                    'ApiKey' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['text/event-stream', 'application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'appId' => ['type' => 'string', 'required' => true],
                            'sessionId' => ['type' => 'string', 'required' => false],
                            'message' => [
                                'type' => 'object',
                                'required' => true,
                                'properties' => [
                                    'role' => ['type' => 'string', 'required' => false],
                                    'parts' => [
                                        'type' => 'array',
                                        'required' => false,
                                        'items' => [
                                            'type' => 'object',
                                            'required' => false,
                                            'properties' => [
                                                'type' => ['type' => 'string', 'required' => false],
                                                'text' => ['type' => 'string', 'required' => false],
                                                'url' => ['type' => 'string', 'required' => false],
                                                'mediaType' => ['type' => 'string', 'required' => false],
                                                'data' => ['type' => 'any', 'required' => false],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                            'options' => ['type' => 'object', 'required' => false],
                        ],
                    ],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aisearchengine.aliyuncs.com', 'endpoint' => 'aisearchengine.aliyuncs.com', 'vpc' => ''],
    ],
];