@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.js
CHANGED
|
@@ -49,10 +49,6 @@ class Client extends openapi_core_1.default {
|
|
|
49
49
|
constructor(config) {
|
|
50
50
|
super(config);
|
|
51
51
|
this._endpointRule = "regional";
|
|
52
|
-
this._endpointMap = {
|
|
53
|
-
'cn-beijing': "bailian.cn-beijing.aliyuncs.com",
|
|
54
|
-
'ap-southeast-1': "bailian.ap-southeast-1.aliyuncs.com",
|
|
55
|
-
};
|
|
56
52
|
this.checkConfig(config);
|
|
57
53
|
this._endpoint = this.getEndpoint("bailian", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
|
|
58
54
|
}
|
|
@@ -269,10 +265,10 @@ class Client extends openapi_core_1.default {
|
|
|
269
265
|
* 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).
|
|
270
266
|
*
|
|
271
267
|
* @remarks
|
|
272
|
-
* -
|
|
268
|
+
* - 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).
|
|
273
269
|
* - This operation is not idempotent.
|
|
274
|
-
* **
|
|
275
|
-
* This operation is
|
|
270
|
+
* **Rate limiting:**
|
|
271
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
276
272
|
*
|
|
277
273
|
* @param tmpReq - AddFileRequest
|
|
278
274
|
* @param headers - map
|
|
@@ -332,10 +328,10 @@ class Client extends openapi_core_1.default {
|
|
|
332
328
|
* 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).
|
|
333
329
|
*
|
|
334
330
|
* @remarks
|
|
335
|
-
* -
|
|
331
|
+
* - 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).
|
|
336
332
|
* - This operation is not idempotent.
|
|
337
|
-
* **
|
|
338
|
-
* This operation is
|
|
333
|
+
* **Rate limiting:**
|
|
334
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
339
335
|
*
|
|
340
336
|
* @param request - AddFileRequest
|
|
341
337
|
* @returns AddFileResponse
|
|
@@ -619,7 +615,7 @@ class Client extends openapi_core_1.default {
|
|
|
619
615
|
return await this.applyTempStorageLeaseWithOptions(WorkspaceId, request, headers, runtime);
|
|
620
616
|
}
|
|
621
617
|
/**
|
|
622
|
-
*
|
|
618
|
+
* Batch updates document tags in a data connection.
|
|
623
619
|
*
|
|
624
620
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
625
621
|
* @param headers - map
|
|
@@ -658,7 +654,7 @@ class Client extends openapi_core_1.default {
|
|
|
658
654
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.BatchUpdateFileTagResponse({}));
|
|
659
655
|
}
|
|
660
656
|
/**
|
|
661
|
-
*
|
|
657
|
+
* Batch updates document tags in a data connection.
|
|
662
658
|
*
|
|
663
659
|
* @param request - BatchUpdateFileTagRequest
|
|
664
660
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -799,17 +795,17 @@ class Client extends openapi_core_1.default {
|
|
|
799
795
|
return await this.createAndPulishAgentWithOptions(workspaceId, request, headers, runtime);
|
|
800
796
|
}
|
|
801
797
|
/**
|
|
802
|
-
* Creates a knowledge base
|
|
798
|
+
* 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.
|
|
803
799
|
*
|
|
804
800
|
* @remarks
|
|
805
801
|
* - **Permission requirements**:
|
|
806
|
-
* - **Resource Access Management (RAM) user**:
|
|
802
|
+
* - **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).
|
|
807
803
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
808
|
-
* - **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
|
|
809
|
-
* - **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,
|
|
810
|
-
* - **Idempotence**: This operation
|
|
811
|
-
* **Rate
|
|
812
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
804
|
+
* - **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.
|
|
805
|
+
* - **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).
|
|
806
|
+
* - **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.
|
|
807
|
+
* **Rate limiting:**
|
|
808
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
813
809
|
*
|
|
814
810
|
* @param tmpReq - CreateIndexRequest
|
|
815
811
|
* @param headers - map
|
|
@@ -956,17 +952,17 @@ class Client extends openapi_core_1.default {
|
|
|
956
952
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIndexResponse({}));
|
|
957
953
|
}
|
|
958
954
|
/**
|
|
959
|
-
* Creates a knowledge base
|
|
955
|
+
* 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.
|
|
960
956
|
*
|
|
961
957
|
* @remarks
|
|
962
958
|
* - **Permission requirements**:
|
|
963
|
-
* - **Resource Access Management (RAM) user**:
|
|
959
|
+
* - **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).
|
|
964
960
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
965
|
-
* - **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
|
|
966
|
-
* - **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,
|
|
967
|
-
* - **Idempotence**: This operation
|
|
968
|
-
* **Rate
|
|
969
|
-
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are
|
|
961
|
+
* - **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.
|
|
962
|
+
* - **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).
|
|
963
|
+
* - **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.
|
|
964
|
+
* **Rate limiting:**
|
|
965
|
+
* This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
|
|
970
966
|
*
|
|
971
967
|
* @param request - CreateIndexRequest
|
|
972
968
|
* @returns CreateIndexResponse
|
|
@@ -2638,12 +2634,12 @@ class Client extends openapi_core_1.default {
|
|
|
2638
2634
|
return await this.listIndexDocumentsWithOptions(WorkspaceId, request, headers, runtime);
|
|
2639
2635
|
}
|
|
2640
2636
|
/**
|
|
2641
|
-
* Retrieves
|
|
2637
|
+
* Retrieves files and their details from a specified knowledge base.
|
|
2642
2638
|
*
|
|
2643
2639
|
* @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
|
|
2640
|
+
* - 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).
|
|
2641
|
+
* - 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).
|
|
2642
|
+
* - This operation has idempotence.
|
|
2647
2643
|
*
|
|
2648
2644
|
* @param request - ListIndexFileDetailsRequest
|
|
2649
2645
|
* @param headers - map
|
|
@@ -2689,12 +2685,12 @@ class Client extends openapi_core_1.default {
|
|
|
2689
2685
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexFileDetailsResponse({}));
|
|
2690
2686
|
}
|
|
2691
2687
|
/**
|
|
2692
|
-
* Retrieves
|
|
2688
|
+
* Retrieves files and their details from a specified knowledge base.
|
|
2693
2689
|
*
|
|
2694
2690
|
* @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
|
|
2691
|
+
* - 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).
|
|
2692
|
+
* - 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).
|
|
2693
|
+
* - This operation has idempotence.
|
|
2698
2694
|
*
|
|
2699
2695
|
* @param request - ListIndexFileDetailsRequest
|
|
2700
2696
|
* @returns ListIndexFileDetailsResponse
|
|
@@ -2708,10 +2704,10 @@ class Client extends openapi_core_1.default {
|
|
|
2708
2704
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2709
2705
|
*
|
|
2710
2706
|
* @remarks
|
|
2711
|
-
* -
|
|
2707
|
+
* - 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.
|
|
2712
2708
|
* - This operation is idempotent.
|
|
2713
2709
|
* **Rate limit:**
|
|
2714
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2710
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2715
2711
|
*
|
|
2716
2712
|
* @param request - ListIndicesRequest
|
|
2717
2713
|
* @param headers - map
|
|
@@ -2751,10 +2747,10 @@ class Client extends openapi_core_1.default {
|
|
|
2751
2747
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2752
2748
|
*
|
|
2753
2749
|
* @remarks
|
|
2754
|
-
* -
|
|
2750
|
+
* - 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.
|
|
2755
2751
|
* - This operation is idempotent.
|
|
2756
2752
|
* **Rate limit:**
|
|
2757
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2753
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2758
2754
|
*
|
|
2759
2755
|
* @param request - ListIndicesRequest
|
|
2760
2756
|
* @returns ListIndicesResponse
|
|
@@ -3105,19 +3101,20 @@ class Client extends openapi_core_1.default {
|
|
|
3105
3101
|
return await this.retrieveWithOptions(WorkspaceId, request, headers, runtime);
|
|
3106
3102
|
}
|
|
3107
3103
|
/**
|
|
3108
|
-
*
|
|
3104
|
+
* Appends parsed files to a specified knowledge base.
|
|
3109
3105
|
*
|
|
3110
3106
|
* @remarks
|
|
3111
3107
|
* <props="china">
|
|
3112
|
-
* - This
|
|
3108
|
+
* - 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
3109
|
* <props="intl">
|
|
3114
|
-
* - This
|
|
3115
|
-
* -
|
|
3116
|
-
* - Before
|
|
3117
|
-
* - Before
|
|
3118
|
-
* - After
|
|
3119
|
-
* -
|
|
3120
|
-
* **Rate
|
|
3110
|
+
* - 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).
|
|
3111
|
+
* - 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.
|
|
3112
|
+
* - 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).
|
|
3113
|
+
* - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
|
|
3114
|
+
* - 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.
|
|
3115
|
+
* - 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.
|
|
3116
|
+
* **Rate limit:**
|
|
3117
|
+
* Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
|
|
3121
3118
|
*
|
|
3122
3119
|
* @param tmpReq - SubmitIndexAddDocumentsJobRequest
|
|
3123
3120
|
* @param headers - map
|
|
@@ -3186,19 +3183,20 @@ class Client extends openapi_core_1.default {
|
|
|
3186
3183
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.SubmitIndexAddDocumentsJobResponse({}));
|
|
3187
3184
|
}
|
|
3188
3185
|
/**
|
|
3189
|
-
*
|
|
3186
|
+
* Appends parsed files to a specified knowledge base.
|
|
3190
3187
|
*
|
|
3191
3188
|
* @remarks
|
|
3192
3189
|
* <props="china">
|
|
3193
|
-
* - This
|
|
3190
|
+
* - 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
3191
|
* <props="intl">
|
|
3195
|
-
* - This
|
|
3196
|
-
* -
|
|
3197
|
-
* - Before
|
|
3198
|
-
* - Before
|
|
3199
|
-
* - After
|
|
3200
|
-
* -
|
|
3201
|
-
* **Rate
|
|
3192
|
+
* - 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).
|
|
3193
|
+
* - 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.
|
|
3194
|
+
* - 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).
|
|
3195
|
+
* - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
|
|
3196
|
+
* - 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.
|
|
3197
|
+
* - 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.
|
|
3198
|
+
* **Rate limit:**
|
|
3199
|
+
* Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
|
|
3202
3200
|
*
|
|
3203
3201
|
* @param request - SubmitIndexAddDocumentsJobRequest
|
|
3204
3202
|
* @returns SubmitIndexAddDocumentsJobResponse
|
|
@@ -3527,11 +3525,12 @@ class Client extends openapi_core_1.default {
|
|
|
3527
3525
|
return await this.updateConnectorWithOptions(WorkspaceId, ConnectorId, request, headers, runtime);
|
|
3528
3526
|
}
|
|
3529
3527
|
/**
|
|
3530
|
-
* Updates the tags
|
|
3528
|
+
* Updates the tags of a specified file.
|
|
3531
3529
|
*
|
|
3532
3530
|
* @remarks
|
|
3533
|
-
* -
|
|
3534
|
-
* **
|
|
3531
|
+
* - 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.
|
|
3532
|
+
* **Rate limiting:**
|
|
3533
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
3535
3534
|
*
|
|
3536
3535
|
* @param tmpReq - UpdateFileTagRequest
|
|
3537
3536
|
* @param headers - map
|
|
@@ -3567,11 +3566,12 @@ class Client extends openapi_core_1.default {
|
|
|
3567
3566
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateFileTagResponse({}));
|
|
3568
3567
|
}
|
|
3569
3568
|
/**
|
|
3570
|
-
* Updates the tags
|
|
3569
|
+
* Updates the tags of a specified file.
|
|
3571
3570
|
*
|
|
3572
3571
|
* @remarks
|
|
3573
|
-
* -
|
|
3574
|
-
* **
|
|
3572
|
+
* - 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.
|
|
3573
|
+
* **Rate limiting:**
|
|
3574
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
3575
3575
|
*
|
|
3576
3576
|
* @param request - UpdateFileTagRequest
|
|
3577
3577
|
* @returns UpdateFileTagResponse
|