@alicloud/bailian20231229 2.14.2 → 2.14.4
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 +62 -58
- package/dist/client.js +62 -62
- package/dist/client.js.map +1 -1
- package/dist/models/AddFileRequest.d.ts +20 -20
- package/dist/models/AddFileResponseBody.d.ts +5 -5
- package/dist/models/AddFileShrinkRequest.d.ts +16 -16
- package/dist/models/BatchUpdateFileTagRequest.d.ts +6 -4
- package/dist/models/BatchUpdateFileTagRequest.js.map +1 -1
- package/dist/models/BatchUpdateFileTagResponseBody.d.ts +14 -18
- package/dist/models/BatchUpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/BatchUpdateFileTagShrinkRequest.d.ts +4 -2
- package/dist/models/BatchUpdateFileTagShrinkRequest.js.map +1 -1
- package/dist/models/CreateIndexRequest.d.ts +60 -60
- package/dist/models/CreateIndexResponseBody.d.ts +3 -3
- package/dist/models/CreateIndexShrinkRequest.d.ts +52 -52
- package/dist/models/ListIndexFileDetailsRequest.d.ts +3 -3
- package/dist/models/ListIndexFileDetailsResponseBody.d.ts +14 -4
- package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
- package/dist/models/ListIndicesRequest.d.ts +2 -2
- package/dist/models/ListIndicesResponseBody.d.ts +98 -29
- package/dist/models/ListIndicesResponseBody.js +37 -1
- package/dist/models/ListIndicesResponseBody.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobRequest.d.ts +33 -44
- package/dist/models/SubmitIndexAddDocumentsJobRequest.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobResponseBody.d.ts +8 -9
- package/dist/models/SubmitIndexAddDocumentsJobResponseBody.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.d.ts +33 -44
- package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.js.map +1 -1
- package/dist/models/UpdateFileTagRequest.d.ts +1 -1
- package/dist/models/UpdateFileTagResponseBody.d.ts +8 -9
- package/dist/models/UpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagShrinkRequest.d.ts +1 -1
- package/dist/models/model.d.ts +1 -0
- package/dist/models/model.js +12 -10
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +62 -62
- package/src/models/AddFileRequest.ts +20 -20
- package/src/models/AddFileResponseBody.ts +5 -5
- package/src/models/AddFileShrinkRequest.ts +16 -16
- package/src/models/BatchUpdateFileTagRequest.ts +6 -4
- package/src/models/BatchUpdateFileTagResponseBody.ts +14 -18
- package/src/models/BatchUpdateFileTagShrinkRequest.ts +4 -2
- package/src/models/CreateIndexRequest.ts +60 -60
- package/src/models/CreateIndexResponseBody.ts +3 -3
- package/src/models/CreateIndexShrinkRequest.ts +52 -52
- package/src/models/ListIndexFileDetailsRequest.ts +3 -3
- package/src/models/ListIndexFileDetailsResponseBody.ts +14 -4
- package/src/models/ListIndicesRequest.ts +2 -2
- package/src/models/ListIndicesResponseBody.ts +125 -29
- package/src/models/SubmitIndexAddDocumentsJobRequest.ts +33 -44
- package/src/models/SubmitIndexAddDocumentsJobResponseBody.ts +8 -9
- package/src/models/SubmitIndexAddDocumentsJobShrinkRequest.ts +33 -44
- package/src/models/UpdateFileTagRequest.ts +1 -1
- package/src/models/UpdateFileTagResponseBody.ts +8 -9
- package/src/models/UpdateFileTagShrinkRequest.ts +1 -1
- package/src/models/model.ts +1 -0
package/dist/client.d.ts
CHANGED
|
@@ -106,10 +106,10 @@ export default class Client extends OpenApi {
|
|
|
106
106
|
* 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).
|
|
107
107
|
*
|
|
108
108
|
* @remarks
|
|
109
|
-
* -
|
|
109
|
+
* - 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 calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call 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).
|
|
110
110
|
* - This operation is not idempotent.
|
|
111
|
-
* **
|
|
112
|
-
* This operation is
|
|
111
|
+
* **Rate limiting:**
|
|
112
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
113
113
|
*
|
|
114
114
|
* @param tmpReq - AddFileRequest
|
|
115
115
|
* @param headers - map
|
|
@@ -123,10 +123,10 @@ export default class Client extends OpenApi {
|
|
|
123
123
|
* 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).
|
|
124
124
|
*
|
|
125
125
|
* @remarks
|
|
126
|
-
* -
|
|
126
|
+
* - 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 calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call 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).
|
|
127
127
|
* - This operation is not idempotent.
|
|
128
|
-
* **
|
|
129
|
-
* This operation is
|
|
128
|
+
* **Rate limiting:**
|
|
129
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
130
130
|
*
|
|
131
131
|
* @param request - AddFileRequest
|
|
132
132
|
* @returns AddFileResponse
|
|
@@ -255,7 +255,7 @@ export default class Client extends OpenApi {
|
|
|
255
255
|
*/
|
|
256
256
|
applyTempStorageLease(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest): Promise<$_model.ApplyTempStorageLeaseResponse>;
|
|
257
257
|
/**
|
|
258
|
-
*
|
|
258
|
+
* Batch updates document tags in a data connection.
|
|
259
259
|
*
|
|
260
260
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
261
261
|
* @param headers - map
|
|
@@ -266,7 +266,7 @@ export default class Client extends OpenApi {
|
|
|
266
266
|
[key: string]: string;
|
|
267
267
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.BatchUpdateFileTagResponse>;
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* Batch updates document tags in a data connection.
|
|
270
270
|
*
|
|
271
271
|
* @param request - BatchUpdateFileTagRequest
|
|
272
272
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -321,17 +321,17 @@ export default class Client extends OpenApi {
|
|
|
321
321
|
*/
|
|
322
322
|
createAndPulishAgent(workspaceId: string, request: $_model.CreateAndPulishAgentRequest): Promise<$_model.CreateAndPulishAgentResponse>;
|
|
323
323
|
/**
|
|
324
|
-
* Creates a knowledge base
|
|
324
|
+
* Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
|
|
325
325
|
*
|
|
326
326
|
* @remarks
|
|
327
327
|
* - **Permission requirements**:
|
|
328
|
-
* - **Resource Access Management (RAM) user**:
|
|
328
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
329
329
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
330
|
-
* - **Calling method**: 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). The SDK
|
|
331
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples,
|
|
332
|
-
* - **Idempotence**: This operation
|
|
333
|
-
* **Rate
|
|
334
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
330
|
+
* - **Calling method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
331
|
+
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
332
|
+
* - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
|
|
333
|
+
* **Rate limiting:**
|
|
334
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
335
335
|
*
|
|
336
336
|
* @param tmpReq - CreateIndexRequest
|
|
337
337
|
* @param headers - map
|
|
@@ -342,17 +342,17 @@ export default class Client extends OpenApi {
|
|
|
342
342
|
[key: string]: string;
|
|
343
343
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIndexResponse>;
|
|
344
344
|
/**
|
|
345
|
-
* Creates a knowledge base
|
|
345
|
+
* Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
|
|
346
346
|
*
|
|
347
347
|
* @remarks
|
|
348
348
|
* - **Permission requirements**:
|
|
349
|
-
* - **Resource Access Management (RAM) user**:
|
|
349
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
350
350
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
351
|
-
* - **Calling method**: 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). The SDK
|
|
352
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples,
|
|
353
|
-
* - **Idempotence**: This operation
|
|
354
|
-
* **Rate
|
|
355
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
351
|
+
* - **Calling method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
352
|
+
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
353
|
+
* - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
|
|
354
|
+
* **Rate limiting:**
|
|
355
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
356
356
|
*
|
|
357
357
|
* @param request - CreateIndexRequest
|
|
358
358
|
* @returns CreateIndexResponse
|
|
@@ -1211,12 +1211,12 @@ export default class Client extends OpenApi {
|
|
|
1211
1211
|
*/
|
|
1212
1212
|
listIndexDocuments(WorkspaceId: string, request: $_model.ListIndexDocumentsRequest): Promise<$_model.ListIndexDocumentsResponse>;
|
|
1213
1213
|
/**
|
|
1214
|
-
* Retrieves
|
|
1214
|
+
* Retrieves files and their details from a specified knowledge base.
|
|
1215
1215
|
*
|
|
1216
1216
|
* @remarks
|
|
1217
|
-
* - 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:ListIndexFiles permission), before
|
|
1218
|
-
* - Before
|
|
1219
|
-
* - This operation
|
|
1217
|
+
* - 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:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation through 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).
|
|
1218
|
+
* - Before invoking this operation, make sure your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
1219
|
+
* - This operation has idempotence.
|
|
1220
1220
|
*
|
|
1221
1221
|
* @param request - ListIndexFileDetailsRequest
|
|
1222
1222
|
* @param headers - map
|
|
@@ -1227,12 +1227,12 @@ export default class Client extends OpenApi {
|
|
|
1227
1227
|
[key: string]: string;
|
|
1228
1228
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexFileDetailsResponse>;
|
|
1229
1229
|
/**
|
|
1230
|
-
* Retrieves
|
|
1230
|
+
* Retrieves files and their details from a specified knowledge base.
|
|
1231
1231
|
*
|
|
1232
1232
|
* @remarks
|
|
1233
|
-
* - 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:ListIndexFiles permission), before
|
|
1234
|
-
* - Before
|
|
1235
|
-
* - This operation
|
|
1233
|
+
* - 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:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation through 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).
|
|
1234
|
+
* - Before invoking this operation, make sure your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
1235
|
+
* - This operation has idempotence.
|
|
1236
1236
|
*
|
|
1237
1237
|
* @param request - ListIndexFileDetailsRequest
|
|
1238
1238
|
* @returns ListIndexFileDetailsResponse
|
|
@@ -1242,10 +1242,10 @@ export default class Client extends OpenApi {
|
|
|
1242
1242
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1243
1243
|
*
|
|
1244
1244
|
* @remarks
|
|
1245
|
-
* -
|
|
1245
|
+
* - 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:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call 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 call this operation.
|
|
1246
1246
|
* - This operation is idempotent.
|
|
1247
1247
|
* **Rate limit:**
|
|
1248
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1248
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1249
1249
|
*
|
|
1250
1250
|
* @param request - ListIndicesRequest
|
|
1251
1251
|
* @param headers - map
|
|
@@ -1259,10 +1259,10 @@ export default class Client extends OpenApi {
|
|
|
1259
1259
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1260
1260
|
*
|
|
1261
1261
|
* @remarks
|
|
1262
|
-
* -
|
|
1262
|
+
* - 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:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call 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 call this operation.
|
|
1263
1263
|
* - This operation is idempotent.
|
|
1264
1264
|
* **Rate limit:**
|
|
1265
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1265
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1266
1266
|
*
|
|
1267
1267
|
* @param request - ListIndicesRequest
|
|
1268
1268
|
* @returns ListIndicesResponse
|
|
@@ -1401,19 +1401,20 @@ export default class Client extends OpenApi {
|
|
|
1401
1401
|
*/
|
|
1402
1402
|
retrieve(WorkspaceId: string, request: $_model.RetrieveRequest): Promise<$_model.RetrieveResponse>;
|
|
1403
1403
|
/**
|
|
1404
|
-
*
|
|
1404
|
+
* Appends parsed files to a specified knowledge base.
|
|
1405
1405
|
*
|
|
1406
1406
|
* @remarks
|
|
1407
1407
|
* <props="china">
|
|
1408
|
-
* - This
|
|
1408
|
+
* - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
1409
1409
|
* <props="intl">
|
|
1410
|
-
* - This
|
|
1411
|
-
* -
|
|
1412
|
-
* - Before
|
|
1413
|
-
* - Before
|
|
1414
|
-
* - After
|
|
1415
|
-
* -
|
|
1416
|
-
* **Rate
|
|
1410
|
+
* - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
1411
|
+
* - 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:SubmitIndexAddDocumentsJob 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.
|
|
1412
|
+
* - 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).
|
|
1413
|
+
* - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
|
|
1414
|
+
* - After invoking this operation, the node requires time to execute and may take several hours during peak periods. Do not submit duplicate requests before the node is complete. To query the node execution status, invoke the **GetIndexJobStatus** operation. The `Documents` file list returned by this operation contains all files in this append job (uniquely identified by the `job_id` you provide), and you can check whether each file was imported (parsed) successfully. Note that invoking GetIndexJobStatus too frequently will trigger rate limiting. Do not exceed a frequency of 20 times per minute.
|
|
1415
|
+
* - After this operation is invoked successfully, it takes some time to execute. Do not submit duplicate requests before the response is returned. This operation does not have idempotence.
|
|
1416
|
+
* **Rate limit:**
|
|
1417
|
+
* Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1417
1418
|
*
|
|
1418
1419
|
* @param tmpReq - SubmitIndexAddDocumentsJobRequest
|
|
1419
1420
|
* @param headers - map
|
|
@@ -1424,19 +1425,20 @@ export default class Client extends OpenApi {
|
|
|
1424
1425
|
[key: string]: string;
|
|
1425
1426
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.SubmitIndexAddDocumentsJobResponse>;
|
|
1426
1427
|
/**
|
|
1427
|
-
*
|
|
1428
|
+
* Appends parsed files to a specified knowledge base.
|
|
1428
1429
|
*
|
|
1429
1430
|
* @remarks
|
|
1430
1431
|
* <props="china">
|
|
1431
|
-
* - This
|
|
1432
|
+
* - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
1432
1433
|
* <props="intl">
|
|
1433
|
-
* - This
|
|
1434
|
-
* -
|
|
1435
|
-
* - Before
|
|
1436
|
-
* - Before
|
|
1437
|
-
* - After
|
|
1438
|
-
* -
|
|
1439
|
-
* **Rate
|
|
1434
|
+
* - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
1435
|
+
* - 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:SubmitIndexAddDocumentsJob 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.
|
|
1436
|
+
* - 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).
|
|
1437
|
+
* - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
|
|
1438
|
+
* - After invoking this operation, the node requires time to execute and may take several hours during peak periods. Do not submit duplicate requests before the node is complete. To query the node execution status, invoke the **GetIndexJobStatus** operation. The `Documents` file list returned by this operation contains all files in this append job (uniquely identified by the `job_id` you provide), and you can check whether each file was imported (parsed) successfully. Note that invoking GetIndexJobStatus too frequently will trigger rate limiting. Do not exceed a frequency of 20 times per minute.
|
|
1439
|
+
* - After this operation is invoked successfully, it takes some time to execute. Do not submit duplicate requests before the response is returned. This operation does not have idempotence.
|
|
1440
|
+
* **Rate limit:**
|
|
1441
|
+
* Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1440
1442
|
*
|
|
1441
1443
|
* @param request - SubmitIndexAddDocumentsJobRequest
|
|
1442
1444
|
* @returns SubmitIndexAddDocumentsJobResponse
|
|
@@ -1583,11 +1585,12 @@ export default class Client extends OpenApi {
|
|
|
1583
1585
|
*/
|
|
1584
1586
|
updateConnector(WorkspaceId: string, ConnectorId: string, request: $_model.UpdateConnectorRequest): Promise<$_model.UpdateConnectorResponse>;
|
|
1585
1587
|
/**
|
|
1586
|
-
* Updates the tags
|
|
1588
|
+
* Updates the tags of a specified file.
|
|
1587
1589
|
*
|
|
1588
1590
|
* @remarks
|
|
1589
|
-
* -
|
|
1590
|
-
* **
|
|
1591
|
+
* - 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:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call 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 call this operation.
|
|
1592
|
+
* **Rate limiting:**
|
|
1593
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1591
1594
|
*
|
|
1592
1595
|
* @param tmpReq - UpdateFileTagRequest
|
|
1593
1596
|
* @param headers - map
|
|
@@ -1598,11 +1601,12 @@ export default class Client extends OpenApi {
|
|
|
1598
1601
|
[key: string]: string;
|
|
1599
1602
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateFileTagResponse>;
|
|
1600
1603
|
/**
|
|
1601
|
-
* Updates the tags
|
|
1604
|
+
* Updates the tags of a specified file.
|
|
1602
1605
|
*
|
|
1603
1606
|
* @remarks
|
|
1604
|
-
* -
|
|
1605
|
-
* **
|
|
1607
|
+
* - 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:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call 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 call this operation.
|
|
1608
|
+
* **Rate limiting:**
|
|
1609
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1606
1610
|
*
|
|
1607
1611
|
* @param request - UpdateFileTagRequest
|
|
1608
1612
|
* @returns UpdateFileTagResponse
|