@alicloud/bailian20231229 2.14.2 → 2.14.3
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 +32 -30
- package/dist/client.js +32 -30
- package/dist/client.js.map +1 -1
- 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 +1 -1
- package/dist/models/ListIndicesResponseBody.d.ts +35 -22
- package/dist/models/ListIndicesResponseBody.js +31 -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/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 +32 -30
- package/src/models/ListIndexFileDetailsRequest.ts +3 -3
- package/src/models/ListIndexFileDetailsResponseBody.ts +14 -4
- package/src/models/ListIndicesRequest.ts +1 -1
- package/src/models/ListIndicesResponseBody.ts +56 -22
- package/src/models/SubmitIndexAddDocumentsJobRequest.ts +33 -44
- package/src/models/SubmitIndexAddDocumentsJobResponseBody.ts +8 -9
- package/src/models/SubmitIndexAddDocumentsJobShrinkRequest.ts +33 -44
- package/src/models/model.ts +1 -0
package/dist/client.d.ts
CHANGED
|
@@ -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,8 +1242,8 @@ export default class Client extends OpenApi {
|
|
|
1242
1242
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1243
1243
|
*
|
|
1244
1244
|
* @remarks
|
|
1245
|
-
* - 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:ListIndex permission)
|
|
1246
|
-
* - This operation
|
|
1245
|
+
* - 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:ListIndex permission). 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.
|
|
1246
|
+
* - This operation has idempotence.
|
|
1247
1247
|
* **Rate limit:**
|
|
1248
1248
|
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1249
1249
|
*
|
|
@@ -1259,8 +1259,8 @@ export default class Client extends OpenApi {
|
|
|
1259
1259
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1260
1260
|
*
|
|
1261
1261
|
* @remarks
|
|
1262
|
-
* - 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:ListIndex permission)
|
|
1263
|
-
* - This operation
|
|
1262
|
+
* - 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:ListIndex permission). 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.
|
|
1263
|
+
* - This operation has idempotence.
|
|
1264
1264
|
* **Rate limit:**
|
|
1265
1265
|
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1266
1266
|
*
|
|
@@ -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
|
package/dist/client.js
CHANGED
|
@@ -2638,12 +2638,12 @@ class Client extends openapi_core_1.default {
|
|
|
2638
2638
|
return await this.listIndexDocumentsWithOptions(WorkspaceId, request, headers, runtime);
|
|
2639
2639
|
}
|
|
2640
2640
|
/**
|
|
2641
|
-
* Retrieves
|
|
2641
|
+
* Retrieves files and their details from a specified knowledge base.
|
|
2642
2642
|
*
|
|
2643
2643
|
* @remarks
|
|
2644
|
-
* - 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
|
|
2645
|
-
* - Before
|
|
2646
|
-
* - This operation
|
|
2644
|
+
* - 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).
|
|
2645
|
+
* - 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).
|
|
2646
|
+
* - This operation has idempotence.
|
|
2647
2647
|
*
|
|
2648
2648
|
* @param request - ListIndexFileDetailsRequest
|
|
2649
2649
|
* @param headers - map
|
|
@@ -2689,12 +2689,12 @@ class Client extends openapi_core_1.default {
|
|
|
2689
2689
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexFileDetailsResponse({}));
|
|
2690
2690
|
}
|
|
2691
2691
|
/**
|
|
2692
|
-
* Retrieves
|
|
2692
|
+
* Retrieves files and their details from a specified knowledge base.
|
|
2693
2693
|
*
|
|
2694
2694
|
* @remarks
|
|
2695
|
-
* - 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
|
|
2696
|
-
* - Before
|
|
2697
|
-
* - This operation
|
|
2695
|
+
* - 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).
|
|
2696
|
+
* - 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).
|
|
2697
|
+
* - This operation has idempotence.
|
|
2698
2698
|
*
|
|
2699
2699
|
* @param request - ListIndexFileDetailsRequest
|
|
2700
2700
|
* @returns ListIndexFileDetailsResponse
|
|
@@ -2708,8 +2708,8 @@ class Client extends openapi_core_1.default {
|
|
|
2708
2708
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2709
2709
|
*
|
|
2710
2710
|
* @remarks
|
|
2711
|
-
* - 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:ListIndex permission)
|
|
2712
|
-
* - This operation
|
|
2711
|
+
* - 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:ListIndex permission). 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.
|
|
2712
|
+
* - This operation has idempotence.
|
|
2713
2713
|
* **Rate limit:**
|
|
2714
2714
|
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2715
2715
|
*
|
|
@@ -2751,8 +2751,8 @@ class Client extends openapi_core_1.default {
|
|
|
2751
2751
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2752
2752
|
*
|
|
2753
2753
|
* @remarks
|
|
2754
|
-
* - 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:ListIndex permission)
|
|
2755
|
-
* - This operation
|
|
2754
|
+
* - 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:ListIndex permission). 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.
|
|
2755
|
+
* - This operation has idempotence.
|
|
2756
2756
|
* **Rate limit:**
|
|
2757
2757
|
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2758
2758
|
*
|
|
@@ -3105,19 +3105,20 @@ class Client extends openapi_core_1.default {
|
|
|
3105
3105
|
return await this.retrieveWithOptions(WorkspaceId, request, headers, runtime);
|
|
3106
3106
|
}
|
|
3107
3107
|
/**
|
|
3108
|
-
*
|
|
3108
|
+
* Appends parsed files to a specified knowledge base.
|
|
3109
3109
|
*
|
|
3110
3110
|
* @remarks
|
|
3111
3111
|
* <props="china">
|
|
3112
|
-
* - This
|
|
3112
|
+
* - 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).
|
|
3113
3113
|
* <props="intl">
|
|
3114
|
-
* - This
|
|
3115
|
-
* -
|
|
3116
|
-
* - Before
|
|
3117
|
-
* - Before
|
|
3118
|
-
* - After
|
|
3119
|
-
* -
|
|
3120
|
-
* **Rate
|
|
3114
|
+
* - 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).
|
|
3115
|
+
* - 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.
|
|
3116
|
+
* - 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).
|
|
3117
|
+
* - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
|
|
3118
|
+
* - 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.
|
|
3119
|
+
* - 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.
|
|
3120
|
+
* **Rate limit:**
|
|
3121
|
+
* Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
|
|
3121
3122
|
*
|
|
3122
3123
|
* @param tmpReq - SubmitIndexAddDocumentsJobRequest
|
|
3123
3124
|
* @param headers - map
|
|
@@ -3186,19 +3187,20 @@ class Client extends openapi_core_1.default {
|
|
|
3186
3187
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.SubmitIndexAddDocumentsJobResponse({}));
|
|
3187
3188
|
}
|
|
3188
3189
|
/**
|
|
3189
|
-
*
|
|
3190
|
+
* Appends parsed files to a specified knowledge base.
|
|
3190
3191
|
*
|
|
3191
3192
|
* @remarks
|
|
3192
3193
|
* <props="china">
|
|
3193
|
-
* - This
|
|
3194
|
+
* - 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).
|
|
3194
3195
|
* <props="intl">
|
|
3195
|
-
* - This
|
|
3196
|
-
* -
|
|
3197
|
-
* - Before
|
|
3198
|
-
* - Before
|
|
3199
|
-
* - After
|
|
3200
|
-
* -
|
|
3201
|
-
* **Rate
|
|
3196
|
+
* - 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).
|
|
3197
|
+
* - 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.
|
|
3198
|
+
* - 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).
|
|
3199
|
+
* - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
|
|
3200
|
+
* - 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.
|
|
3201
|
+
* - 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.
|
|
3202
|
+
* **Rate limit:**
|
|
3203
|
+
* Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
|
|
3202
3204
|
*
|
|
3203
3205
|
* @param request - SubmitIndexAddDocumentsJobRequest
|
|
3204
3206
|
* @returns SubmitIndexAddDocumentsJobResponse
|