@alicloud/bailian20231229 2.13.1 → 2.14.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/dist/client.d.ts +106 -68
- package/dist/client.js +141 -68
- package/dist/client.js.map +1 -1
- package/dist/models/AddChunkRequest.d.ts +53 -0
- package/dist/models/AddChunkRequest.js +65 -0
- package/dist/models/AddChunkRequest.js.map +1 -0
- package/dist/models/AddChunkResponse.d.ts +19 -0
- package/dist/models/AddChunkResponse.js +69 -0
- package/dist/models/AddChunkResponse.js.map +1 -0
- package/dist/models/AddChunkResponseBody.d.ts +61 -0
- package/dist/models/AddChunkResponseBody.js +68 -0
- package/dist/models/AddChunkResponseBody.js.map +1 -0
- package/dist/models/AddChunkShrinkRequest.d.ts +51 -0
- package/dist/models/AddChunkShrinkRequest.js +62 -0
- package/dist/models/AddChunkShrinkRequest.js.map +1 -0
- package/dist/models/AddFileRequest.d.ts +27 -39
- package/dist/models/AddFileRequest.js.map +1 -1
- package/dist/models/AddFileResponseBody.d.ts +8 -11
- package/dist/models/AddFileResponseBody.js.map +1 -1
- package/dist/models/AddFileShrinkRequest.d.ts +26 -38
- package/dist/models/AddFileShrinkRequest.js.map +1 -1
- package/dist/models/AddFilesFromAuthorizedOssRequest.d.ts +29 -29
- package/dist/models/AddFilesFromAuthorizedOssResponseBody.d.ts +14 -14
- package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.d.ts +10 -10
- package/dist/models/AddTableRequest.d.ts +7 -0
- package/dist/models/AddTableRequest.js.map +1 -1
- package/dist/models/AddTableResponseBody.d.ts +6 -6
- package/dist/models/AddTableShrinkRequest.d.ts +7 -0
- package/dist/models/AddTableShrinkRequest.js.map +1 -1
- package/dist/models/ChangeParseSettingRequest.d.ts +10 -28
- package/dist/models/ChangeParseSettingRequest.js.map +1 -1
- package/dist/models/ChangeParseSettingResponseBody.d.ts +8 -12
- package/dist/models/ChangeParseSettingResponseBody.js.map +1 -1
- package/dist/models/ChangeParseSettingShrinkRequest.d.ts +9 -27
- package/dist/models/ChangeParseSettingShrinkRequest.js.map +1 -1
- package/dist/models/DescribeFileResponseBody.d.ts +33 -26
- package/dist/models/DescribeFileResponseBody.js.map +1 -1
- package/dist/models/GetIndexJobStatusRequest.d.ts +1 -1
- package/dist/models/GetIndexJobStatusResponseBody.d.ts +15 -13
- package/dist/models/GetIndexJobStatusResponseBody.js.map +1 -1
- package/dist/models/ListFileRequest.d.ts +2 -2
- package/dist/models/ListFileResponseBody.d.ts +8 -1
- package/dist/models/ListFileResponseBody.js.map +1 -1
- package/dist/models/ListFileShrinkRequest.d.ts +2 -2
- package/dist/models/ListIndexDocumentsRequest.d.ts +11 -9
- package/dist/models/ListIndexDocumentsRequest.js.map +1 -1
- package/dist/models/ListIndexDocumentsResponseBody.d.ts +13 -15
- package/dist/models/ListIndexDocumentsResponseBody.js.map +1 -1
- package/dist/models/ListIndexFileDetailsRequest.d.ts +15 -17
- package/dist/models/ListIndexFileDetailsRequest.js.map +1 -1
- package/dist/models/ListIndexFileDetailsResponseBody.d.ts +26 -30
- package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
- package/dist/models/model.d.ts +4 -0
- package/dist/models/model.js +13 -5
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +147 -68
- package/src/models/AddChunkRequest.ts +71 -0
- package/src/models/AddChunkResponse.ts +40 -0
- package/src/models/AddChunkResponseBody.ts +84 -0
- package/src/models/AddChunkShrinkRequest.ts +68 -0
- package/src/models/AddFileRequest.ts +27 -39
- package/src/models/AddFileResponseBody.ts +8 -11
- package/src/models/AddFileShrinkRequest.ts +26 -38
- package/src/models/AddFilesFromAuthorizedOssRequest.ts +29 -29
- package/src/models/AddFilesFromAuthorizedOssResponseBody.ts +14 -14
- package/src/models/AddFilesFromAuthorizedOssShrinkRequest.ts +10 -10
- package/src/models/AddTableRequest.ts +7 -0
- package/src/models/AddTableResponseBody.ts +6 -6
- package/src/models/AddTableShrinkRequest.ts +7 -0
- package/src/models/ChangeParseSettingRequest.ts +10 -28
- package/src/models/ChangeParseSettingResponseBody.ts +8 -12
- package/src/models/ChangeParseSettingShrinkRequest.ts +9 -27
- package/src/models/DescribeFileResponseBody.ts +33 -26
- package/src/models/GetIndexJobStatusRequest.ts +1 -1
- package/src/models/GetIndexJobStatusResponseBody.ts +15 -13
- package/src/models/ListFileRequest.ts +2 -2
- package/src/models/ListFileResponseBody.ts +8 -1
- package/src/models/ListFileShrinkRequest.ts +2 -2
- package/src/models/ListIndexDocumentsRequest.ts +11 -9
- package/src/models/ListIndexDocumentsResponseBody.ts +13 -15
- package/src/models/ListIndexFileDetailsRequest.ts +15 -17
- package/src/models/ListIndexFileDetailsResponseBody.ts +26 -30
- package/src/models/model.ts +4 -0
package/dist/client.js
CHANGED
|
@@ -128,6 +128,77 @@ class Client extends openapi_core_1.default {
|
|
|
128
128
|
let headers = {};
|
|
129
129
|
return await this.addCategoryWithOptions(WorkspaceId, request, headers, runtime);
|
|
130
130
|
}
|
|
131
|
+
/**
|
|
132
|
+
* Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* - This operation adds chunk content to a specified knowledge base of the document search (document), data query (table), or image Q&A (image) type. Operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
|
|
136
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
137
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
138
|
+
* - This operation has idempotence.
|
|
139
|
+
* **Related operations:**
|
|
140
|
+
* **Throttling:**
|
|
141
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
142
|
+
*
|
|
143
|
+
* @param tmpReq - AddChunkRequest
|
|
144
|
+
* @param headers - map
|
|
145
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
146
|
+
* @returns AddChunkResponse
|
|
147
|
+
*/
|
|
148
|
+
async addChunkWithOptions(WorkspaceId, tmpReq, headers, runtime) {
|
|
149
|
+
tmpReq.validate();
|
|
150
|
+
let request = new $_model.AddChunkShrinkRequest({});
|
|
151
|
+
openapi_core_2.OpenApiUtil.convert(tmpReq, request);
|
|
152
|
+
if (!$dara.isNull(tmpReq.field)) {
|
|
153
|
+
request.fieldShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.field, "field", "json");
|
|
154
|
+
}
|
|
155
|
+
let query = {};
|
|
156
|
+
if (!$dara.isNull(request.pipelineId)) {
|
|
157
|
+
query["PipelineId"] = request.pipelineId;
|
|
158
|
+
}
|
|
159
|
+
if (!$dara.isNull(request.dataId)) {
|
|
160
|
+
query["dataId"] = request.dataId;
|
|
161
|
+
}
|
|
162
|
+
if (!$dara.isNull(request.fieldShrink)) {
|
|
163
|
+
query["field"] = request.fieldShrink;
|
|
164
|
+
}
|
|
165
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
166
|
+
headers: headers,
|
|
167
|
+
query: openapi_core_2.OpenApiUtil.query(query),
|
|
168
|
+
});
|
|
169
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
170
|
+
action: "AddChunk",
|
|
171
|
+
version: "2023-12-29",
|
|
172
|
+
protocol: "HTTPS",
|
|
173
|
+
pathname: `/${$dara.URL.percentEncode(WorkspaceId)}/chunk/create`,
|
|
174
|
+
method: "POST",
|
|
175
|
+
authType: "AK",
|
|
176
|
+
style: "ROA",
|
|
177
|
+
reqBodyType: "json",
|
|
178
|
+
bodyType: "json",
|
|
179
|
+
});
|
|
180
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddChunkResponse({}));
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
|
|
184
|
+
*
|
|
185
|
+
* @remarks
|
|
186
|
+
* - This operation adds chunk content to a specified knowledge base of the document search (document), data query (table), or image Q&A (image) type. Operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
|
|
187
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
188
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
189
|
+
* - This operation has idempotence.
|
|
190
|
+
* **Related operations:**
|
|
191
|
+
* **Throttling:**
|
|
192
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
193
|
+
*
|
|
194
|
+
* @param request - AddChunkRequest
|
|
195
|
+
* @returns AddChunkResponse
|
|
196
|
+
*/
|
|
197
|
+
async addChunk(WorkspaceId, request) {
|
|
198
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
199
|
+
let headers = {};
|
|
200
|
+
return await this.addChunkWithOptions(WorkspaceId, request, headers, runtime);
|
|
201
|
+
}
|
|
131
202
|
/**
|
|
132
203
|
* Creates a connector. This API currently supports only file connectors.
|
|
133
204
|
*
|
|
@@ -197,12 +268,13 @@ class Client extends openapi_core_1.default {
|
|
|
197
268
|
return await this.addConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
198
269
|
}
|
|
199
270
|
/**
|
|
200
|
-
* Imports a file from the temporary storage
|
|
271
|
+
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
201
272
|
*
|
|
202
273
|
* @remarks
|
|
203
|
-
* -
|
|
204
|
-
* - This
|
|
205
|
-
* **Throttling:**
|
|
274
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
275
|
+
* - This operation is not idempotent.
|
|
276
|
+
* **Throttling:**
|
|
277
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
206
278
|
*
|
|
207
279
|
* @param tmpReq - AddFileRequest
|
|
208
280
|
* @param headers - map
|
|
@@ -259,12 +331,13 @@ class Client extends openapi_core_1.default {
|
|
|
259
331
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFileResponse({}));
|
|
260
332
|
}
|
|
261
333
|
/**
|
|
262
|
-
* Imports a file from the temporary storage
|
|
334
|
+
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
263
335
|
*
|
|
264
336
|
* @remarks
|
|
265
|
-
* -
|
|
266
|
-
* - This
|
|
267
|
-
* **Throttling:**
|
|
337
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
338
|
+
* - This operation is not idempotent.
|
|
339
|
+
* **Throttling:**
|
|
340
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
268
341
|
*
|
|
269
342
|
* @param request - AddFileRequest
|
|
270
343
|
* @returns AddFileResponse
|
|
@@ -275,17 +348,17 @@ class Client extends openapi_core_1.default {
|
|
|
275
348
|
return await this.addFileWithOptions(WorkspaceId, request, headers, runtime);
|
|
276
349
|
}
|
|
277
350
|
/**
|
|
278
|
-
* Imports files from an authorized OSS
|
|
351
|
+
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
279
352
|
*
|
|
280
353
|
* @remarks
|
|
281
|
-
* -
|
|
354
|
+
* - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
|
|
282
355
|
*
|
|
283
|
-
* - Supported
|
|
284
|
-
* -
|
|
285
|
-
* -
|
|
286
|
-
* - This operation
|
|
287
|
-
* **
|
|
288
|
-
*
|
|
356
|
+
* - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
|
|
357
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
358
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
359
|
+
* - This operation does not have idempotence.
|
|
360
|
+
* **Rate limit:**
|
|
361
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
289
362
|
*
|
|
290
363
|
* @param tmpReq - AddFilesFromAuthorizedOssRequest
|
|
291
364
|
* @param headers - map
|
|
@@ -342,17 +415,17 @@ class Client extends openapi_core_1.default {
|
|
|
342
415
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFilesFromAuthorizedOssResponse({}));
|
|
343
416
|
}
|
|
344
417
|
/**
|
|
345
|
-
* Imports files from an authorized OSS
|
|
418
|
+
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
346
419
|
*
|
|
347
420
|
* @remarks
|
|
348
|
-
* -
|
|
421
|
+
* - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
|
|
349
422
|
*
|
|
350
|
-
* - Supported
|
|
351
|
-
* -
|
|
352
|
-
* -
|
|
353
|
-
* - This operation
|
|
354
|
-
* **
|
|
355
|
-
*
|
|
423
|
+
* - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
|
|
424
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
425
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
426
|
+
* - This operation does not have idempotence.
|
|
427
|
+
* **Rate limit:**
|
|
428
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
356
429
|
*
|
|
357
430
|
* @param request - AddFilesFromAuthorizedOssRequest
|
|
358
431
|
* @returns AddFilesFromAuthorizedOssResponse
|
|
@@ -363,13 +436,13 @@ class Client extends openapi_core_1.default {
|
|
|
363
436
|
return await this.addFilesFromAuthorizedOssWithOptions(WorkspaceId, request, headers, runtime);
|
|
364
437
|
}
|
|
365
438
|
/**
|
|
366
|
-
*
|
|
439
|
+
* Add a table for the table data connector.
|
|
367
440
|
*
|
|
368
441
|
* @remarks
|
|
369
|
-
* -
|
|
370
|
-
* - This
|
|
371
|
-
* **
|
|
372
|
-
* This
|
|
442
|
+
* - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
443
|
+
* - This API is not idempotent.
|
|
444
|
+
* **Throttling:**
|
|
445
|
+
* This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
|
|
373
446
|
*
|
|
374
447
|
* @param tmpReq - AddTableRequest
|
|
375
448
|
* @param headers - map
|
|
@@ -414,13 +487,13 @@ class Client extends openapi_core_1.default {
|
|
|
414
487
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddTableResponse({}));
|
|
415
488
|
}
|
|
416
489
|
/**
|
|
417
|
-
*
|
|
490
|
+
* Add a table for the table data connector.
|
|
418
491
|
*
|
|
419
492
|
* @remarks
|
|
420
|
-
* -
|
|
421
|
-
* - This
|
|
422
|
-
* **
|
|
423
|
-
* This
|
|
493
|
+
* - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
494
|
+
* - This API is not idempotent.
|
|
495
|
+
* **Throttling:**
|
|
496
|
+
* This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
|
|
424
497
|
*
|
|
425
498
|
* @param request - AddTableRequest
|
|
426
499
|
* @returns AddTableResponse
|
|
@@ -598,13 +671,13 @@ class Client extends openapi_core_1.default {
|
|
|
598
671
|
return await this.batchUpdateFileTagWithOptions(WorkspaceId, request, headers, runtime);
|
|
599
672
|
}
|
|
600
673
|
/**
|
|
601
|
-
* Configures the parsing method for
|
|
674
|
+
* Configures the parsing method for specific file types. For example, specifies large model document parsing for .pdf files or Qwen VL parsing for .jpg files.
|
|
602
675
|
*
|
|
603
676
|
* @remarks
|
|
604
|
-
* -
|
|
677
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
605
678
|
* - This operation is not idempotent.
|
|
606
|
-
* **Throttling
|
|
607
|
-
*
|
|
679
|
+
* **Throttling:**
|
|
680
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
608
681
|
*
|
|
609
682
|
* @param tmpReq - ChangeParseSettingRequest
|
|
610
683
|
* @param headers - map
|
|
@@ -649,13 +722,13 @@ class Client extends openapi_core_1.default {
|
|
|
649
722
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ChangeParseSettingResponse({}));
|
|
650
723
|
}
|
|
651
724
|
/**
|
|
652
|
-
* Configures the parsing method for
|
|
725
|
+
* Configures the parsing method for specific file types. For example, specifies large model document parsing for .pdf files or Qwen VL parsing for .jpg files.
|
|
653
726
|
*
|
|
654
727
|
* @remarks
|
|
655
|
-
* -
|
|
728
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
656
729
|
* - This operation is not idempotent.
|
|
657
|
-
* **Throttling
|
|
658
|
-
*
|
|
730
|
+
* **Throttling:**
|
|
731
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
659
732
|
*
|
|
660
733
|
* @param request - ChangeParseSettingRequest
|
|
661
734
|
* @returns ChangeParseSettingResponse
|
|
@@ -1639,12 +1712,12 @@ class Client extends openapi_core_1.default {
|
|
|
1639
1712
|
return await this.deletePromptTemplateWithOptions(workspaceId, promptTemplateId, request, headers, runtime);
|
|
1640
1713
|
}
|
|
1641
1714
|
/**
|
|
1642
|
-
* Queries the basic information
|
|
1715
|
+
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
1643
1716
|
*
|
|
1644
1717
|
* @remarks
|
|
1645
|
-
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization.
|
|
1718
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1646
1719
|
* - This operation is idempotent.
|
|
1647
|
-
* **
|
|
1720
|
+
* **Throttling:**
|
|
1648
1721
|
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1649
1722
|
*
|
|
1650
1723
|
* @param request - DescribeFileRequest
|
|
@@ -1671,12 +1744,12 @@ class Client extends openapi_core_1.default {
|
|
|
1671
1744
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeFileResponse({}));
|
|
1672
1745
|
}
|
|
1673
1746
|
/**
|
|
1674
|
-
* Queries the basic information
|
|
1747
|
+
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
1675
1748
|
*
|
|
1676
1749
|
* @remarks
|
|
1677
|
-
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization.
|
|
1750
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1678
1751
|
* - This operation is idempotent.
|
|
1679
|
-
* **
|
|
1752
|
+
* **Throttling:**
|
|
1680
1753
|
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1681
1754
|
*
|
|
1682
1755
|
* @param request - DescribeFileRequest
|
|
@@ -1889,13 +1962,13 @@ class Client extends openapi_core_1.default {
|
|
|
1889
1962
|
return await this.getConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
1890
1963
|
}
|
|
1891
1964
|
/**
|
|
1892
|
-
* Queries the current status of a specified knowledge base creation
|
|
1965
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document append task.
|
|
1893
1966
|
*
|
|
1894
1967
|
* @remarks
|
|
1895
1968
|
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1896
|
-
* - You must have a knowledge base job
|
|
1969
|
+
* - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
|
|
1897
1970
|
* - Invoke this operation at intervals of 5 seconds or more.
|
|
1898
|
-
* - This operation
|
|
1971
|
+
* - This operation supports idempotence.
|
|
1899
1972
|
*
|
|
1900
1973
|
* @param request - GetIndexJobStatusRequest
|
|
1901
1974
|
* @param headers - map
|
|
@@ -1935,13 +2008,13 @@ class Client extends openapi_core_1.default {
|
|
|
1935
2008
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexJobStatusResponse({}));
|
|
1936
2009
|
}
|
|
1937
2010
|
/**
|
|
1938
|
-
* Queries the current status of a specified knowledge base creation
|
|
2011
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document append task.
|
|
1939
2012
|
*
|
|
1940
2013
|
* @remarks
|
|
1941
2014
|
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1942
|
-
* - You must have a knowledge base job
|
|
2015
|
+
* - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
|
|
1943
2016
|
* - Invoke this operation at intervals of 5 seconds or more.
|
|
1944
|
-
* - This operation
|
|
2017
|
+
* - This operation supports idempotence.
|
|
1945
2018
|
*
|
|
1946
2019
|
* @param request - GetIndexJobStatusRequest
|
|
1947
2020
|
* @returns GetIndexJobStatusResponse
|
|
@@ -2427,7 +2500,7 @@ class Client extends openapi_core_1.default {
|
|
|
2427
2500
|
*
|
|
2428
2501
|
* @remarks
|
|
2429
2502
|
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
2430
|
-
* -
|
|
2503
|
+
* - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
|
|
2431
2504
|
* - This operation is idempotent.
|
|
2432
2505
|
* **Rate limit:**
|
|
2433
2506
|
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
@@ -2482,7 +2555,7 @@ class Client extends openapi_core_1.default {
|
|
|
2482
2555
|
*
|
|
2483
2556
|
* @remarks
|
|
2484
2557
|
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
2485
|
-
* -
|
|
2558
|
+
* - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
|
|
2486
2559
|
* - This operation is idempotent.
|
|
2487
2560
|
* **Rate limit:**
|
|
2488
2561
|
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
@@ -2496,10 +2569,10 @@ class Client extends openapi_core_1.default {
|
|
|
2496
2569
|
return await this.listFileWithOptions(WorkspaceId, request, headers, runtime);
|
|
2497
2570
|
}
|
|
2498
2571
|
/**
|
|
2499
|
-
* Retrieves
|
|
2572
|
+
* Retrieves files and their summary information from a specified knowledge base.
|
|
2500
2573
|
*
|
|
2501
2574
|
* @remarks
|
|
2502
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (
|
|
2575
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2503
2576
|
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2504
2577
|
* - This operation has idempotence.
|
|
2505
2578
|
* **Throttling:**
|
|
@@ -2549,10 +2622,10 @@ class Client extends openapi_core_1.default {
|
|
|
2549
2622
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexDocumentsResponse({}));
|
|
2550
2623
|
}
|
|
2551
2624
|
/**
|
|
2552
|
-
* Retrieves
|
|
2625
|
+
* Retrieves files and their summary information from a specified knowledge base.
|
|
2553
2626
|
*
|
|
2554
2627
|
* @remarks
|
|
2555
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (
|
|
2628
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2556
2629
|
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2557
2630
|
* - This operation has idempotence.
|
|
2558
2631
|
* **Throttling:**
|
|
@@ -2567,12 +2640,12 @@ class Client extends openapi_core_1.default {
|
|
|
2567
2640
|
return await this.listIndexDocumentsWithOptions(WorkspaceId, request, headers, runtime);
|
|
2568
2641
|
}
|
|
2569
2642
|
/**
|
|
2570
|
-
* Retrieves the
|
|
2643
|
+
* Retrieves the files in a specified knowledge base along with their details.
|
|
2571
2644
|
*
|
|
2572
2645
|
* @remarks
|
|
2573
|
-
* -
|
|
2574
|
-
* - Before
|
|
2575
|
-
* - This operation
|
|
2646
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2647
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2648
|
+
* - This operation has idempotence.
|
|
2576
2649
|
*
|
|
2577
2650
|
* @param request - ListIndexFileDetailsRequest
|
|
2578
2651
|
* @param headers - map
|
|
@@ -2618,12 +2691,12 @@ class Client extends openapi_core_1.default {
|
|
|
2618
2691
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexFileDetailsResponse({}));
|
|
2619
2692
|
}
|
|
2620
2693
|
/**
|
|
2621
|
-
* Retrieves the
|
|
2694
|
+
* Retrieves the files in a specified knowledge base along with their details.
|
|
2622
2695
|
*
|
|
2623
2696
|
* @remarks
|
|
2624
|
-
* -
|
|
2625
|
-
* - Before
|
|
2626
|
-
* - This operation
|
|
2697
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2698
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2699
|
+
* - This operation has idempotence.
|
|
2627
2700
|
*
|
|
2628
2701
|
* @param request - ListIndexFileDetailsRequest
|
|
2629
2702
|
* @returns ListIndexFileDetailsResponse
|