@alicloud/bailian20231229 2.13.0 → 2.13.1
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 +610 -244
- package/dist/client.js +618 -245
- package/dist/client.js.map +1 -1
- package/dist/models/AddCategoryRequest.d.ts +20 -1
- package/dist/models/AddCategoryRequest.js.map +1 -1
- package/dist/models/AddCategoryResponseBody.d.ts +33 -3
- package/dist/models/AddCategoryResponseBody.js.map +1 -1
- package/dist/models/AddConnectorRequest.d.ts +22 -0
- package/dist/models/AddConnectorRequest.js.map +1 -1
- package/dist/models/AddConnectorResponseBody.d.ts +24 -1
- package/dist/models/AddConnectorResponseBody.js.map +1 -1
- package/dist/models/AddConnectorShrinkRequest.d.ts +13 -0
- package/dist/models/AddConnectorShrinkRequest.js.map +1 -1
- package/dist/models/AddFileRequest.d.ts +80 -13
- package/dist/models/AddFileRequest.js.map +1 -1
- package/dist/models/AddFileResponseBody.d.ts +11 -10
- package/dist/models/AddFileResponseBody.js.map +1 -1
- package/dist/models/AddFileShrinkRequest.d.ts +70 -12
- package/dist/models/AddFileShrinkRequest.js.map +1 -1
- package/dist/models/AddFilesFromAuthorizedOssRequest.d.ts +70 -1
- package/dist/models/AddFilesFromAuthorizedOssRequest.js.map +1 -1
- package/dist/models/AddFilesFromAuthorizedOssResponseBody.d.ts +42 -2
- package/dist/models/AddFilesFromAuthorizedOssResponseBody.js.map +1 -1
- package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.d.ts +28 -0
- package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.js.map +1 -1
- package/dist/models/AddTableRequest.d.ts +14 -0
- package/dist/models/AddTableRequest.js +2 -0
- package/dist/models/AddTableRequest.js.map +1 -1
- package/dist/models/AddTableResponseBody.d.ts +22 -0
- package/dist/models/AddTableResponseBody.js.map +1 -1
- package/dist/models/AddTableShrinkRequest.d.ts +7 -0
- package/dist/models/AddTableShrinkRequest.js +2 -0
- package/dist/models/AddTableShrinkRequest.js.map +1 -1
- package/dist/models/ApplyFileUploadLeaseRequest.d.ts +57 -3
- package/dist/models/ApplyFileUploadLeaseRequest.js.map +1 -1
- package/dist/models/ApplyFileUploadLeaseResponseBody.d.ts +22 -20
- package/dist/models/ApplyFileUploadLeaseResponseBody.js.map +1 -1
- package/dist/models/BatchUpdateFileTagRequest.d.ts +9 -0
- package/dist/models/BatchUpdateFileTagRequest.js.map +1 -1
- package/dist/models/BatchUpdateFileTagResponseBody.d.ts +41 -1
- package/dist/models/BatchUpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/BatchUpdateFileTagShrinkRequest.d.ts +5 -0
- package/dist/models/BatchUpdateFileTagShrinkRequest.js.map +1 -1
- package/dist/models/ChangeParseSettingRequest.d.ts +48 -14
- package/dist/models/ChangeParseSettingRequest.js.map +1 -1
- package/dist/models/ChangeParseSettingResponseBody.d.ts +12 -7
- package/dist/models/ChangeParseSettingResponseBody.js.map +1 -1
- package/dist/models/ChangeParseSettingShrinkRequest.d.ts +41 -8
- package/dist/models/ChangeParseSettingShrinkRequest.js.map +1 -1
- package/dist/models/CreateIndexRequest.d.ts +340 -86
- package/dist/models/CreateIndexRequest.js.map +1 -1
- package/dist/models/CreateIndexResponseBody.d.ts +14 -19
- package/dist/models/CreateIndexResponseBody.js.map +1 -1
- package/dist/models/CreateIndexShrinkRequest.d.ts +261 -55
- package/dist/models/CreateIndexShrinkRequest.js.map +1 -1
- package/dist/models/CreateMemoryNodeRequest.d.ts +5 -0
- package/dist/models/CreateMemoryNodeRequest.js.map +1 -1
- package/dist/models/CreateMemoryNodeResponseBody.d.ts +8 -2
- package/dist/models/CreateMemoryNodeResponseBody.js.map +1 -1
- package/dist/models/CreateMemoryRequest.d.ts +7 -0
- package/dist/models/CreateMemoryRequest.js.map +1 -1
- package/dist/models/CreateMemoryResponseBody.d.ts +10 -2
- package/dist/models/CreateMemoryResponseBody.js.map +1 -1
- package/dist/models/CreatePromptTemplateRequest.d.ts +10 -0
- package/dist/models/CreatePromptTemplateRequest.js.map +1 -1
- package/dist/models/CreatePromptTemplateResponseBody.d.ts +6 -0
- package/dist/models/CreatePromptTemplateResponseBody.js.map +1 -1
- package/dist/models/DeleteCategoryResponseBody.d.ts +20 -3
- package/dist/models/DeleteCategoryResponseBody.js.map +1 -1
- package/dist/models/DeleteChunkRequest.d.ts +2 -2
- package/dist/models/DeleteChunkResponseBody.d.ts +6 -12
- package/dist/models/DeleteChunkResponseBody.js.map +1 -1
- package/dist/models/DeleteChunkShrinkRequest.d.ts +2 -2
- package/dist/models/DeleteConnectorResponseBody.d.ts +0 -3
- package/dist/models/DeleteConnectorResponseBody.js.map +1 -1
- package/dist/models/DeleteFileResponseBody.d.ts +24 -1
- package/dist/models/DeleteFileResponseBody.js.map +1 -1
- package/dist/models/DeleteFilesRequest.d.ts +2 -0
- package/dist/models/DeleteFilesRequest.js.map +1 -1
- package/dist/models/DeleteFilesResponseBody.d.ts +32 -0
- package/dist/models/DeleteFilesResponseBody.js.map +1 -1
- package/dist/models/DeleteFilesShrinkRequest.d.ts +2 -0
- package/dist/models/DeleteFilesShrinkRequest.js.map +1 -1
- package/dist/models/DeleteIndexDocumentRequest.d.ts +3 -3
- package/dist/models/DeleteIndexDocumentResponseBody.d.ts +7 -8
- package/dist/models/DeleteIndexDocumentResponseBody.js.map +1 -1
- package/dist/models/DeleteIndexDocumentShrinkRequest.d.ts +3 -3
- package/dist/models/DeleteIndexRequest.d.ts +2 -2
- package/dist/models/DeleteIndexResponseBody.d.ts +5 -6
- package/dist/models/DeleteIndexResponseBody.js.map +1 -1
- package/dist/models/DeleteMemoryNodeResponseBody.d.ts +3 -0
- package/dist/models/DeleteMemoryNodeResponseBody.js.map +1 -1
- package/dist/models/DeleteMemoryResponseBody.d.ts +4 -1
- package/dist/models/DeleteMemoryResponseBody.js.map +1 -1
- package/dist/models/DescribeFileResponseBody.d.ts +58 -26
- package/dist/models/DescribeFileResponseBody.js +2 -0
- package/dist/models/DescribeFileResponseBody.js.map +1 -1
- package/dist/models/GetAlipayTransferStatusRequest.d.ts +6 -0
- package/dist/models/GetAlipayTransferStatusRequest.js.map +1 -1
- package/dist/models/GetAlipayTransferStatusResponseBody.d.ts +90 -0
- package/dist/models/GetAlipayTransferStatusResponseBody.js.map +1 -1
- package/dist/models/GetAlipayUrlRequest.d.ts +14 -0
- package/dist/models/GetAlipayUrlRequest.js.map +1 -1
- package/dist/models/GetAlipayUrlResponseBody.d.ts +17 -0
- package/dist/models/GetAlipayUrlResponseBody.js.map +1 -1
- package/dist/models/GetAvailableParserTypesResponseBody.d.ts +3 -0
- package/dist/models/GetAvailableParserTypesResponseBody.js.map +1 -1
- package/dist/models/GetConnectorRequest.d.ts +11 -1
- package/dist/models/GetConnectorRequest.js.map +1 -1
- package/dist/models/GetConnectorResponseBody.d.ts +33 -1
- package/dist/models/GetConnectorResponseBody.js.map +1 -1
- package/dist/models/GetIndexJobStatusRequest.d.ts +5 -5
- package/dist/models/GetIndexJobStatusResponseBody.d.ts +26 -26
- package/dist/models/GetIndexJobStatusResponseBody.js.map +1 -1
- package/dist/models/GetIndexMonitorRequest.d.ts +6 -0
- package/dist/models/GetIndexMonitorRequest.js.map +1 -1
- package/dist/models/GetIndexMonitorResponseBody.d.ts +77 -1
- package/dist/models/GetIndexMonitorResponseBody.js.map +1 -1
- package/dist/models/GetMemoryNodeResponseBody.d.ts +19 -0
- package/dist/models/GetMemoryNodeResponseBody.js.map +1 -1
- package/dist/models/GetMemoryResponseBody.d.ts +19 -3
- package/dist/models/GetMemoryResponseBody.js.map +1 -1
- package/dist/models/GetParseSettingsResponseBody.d.ts +6 -8
- package/dist/models/GetParseSettingsResponseBody.js.map +1 -1
- package/dist/models/GetPromptTemplateResponseBody.d.ts +6 -0
- package/dist/models/GetPromptTemplateResponseBody.js.map +1 -1
- package/dist/models/HighCodeDeployResponseBody.d.ts +1 -1
- package/dist/models/ListCategoryRequest.d.ts +36 -1
- package/dist/models/ListCategoryRequest.js.map +1 -1
- package/dist/models/ListCategoryResponseBody.d.ts +70 -3
- package/dist/models/ListCategoryResponseBody.js.map +1 -1
- package/dist/models/ListChunksRequest.d.ts +39 -7
- package/dist/models/ListChunksRequest.js.map +1 -1
- package/dist/models/ListChunksResponseBody.d.ts +58 -15
- package/dist/models/ListChunksResponseBody.js.map +1 -1
- package/dist/models/ListFileRequest.d.ts +32 -2
- package/dist/models/ListFileRequest.js.map +1 -1
- package/dist/models/ListFileResponseBody.d.ts +69 -10
- package/dist/models/ListFileResponseBody.js +2 -0
- package/dist/models/ListFileResponseBody.js.map +1 -1
- package/dist/models/ListFileShrinkRequest.d.ts +32 -2
- package/dist/models/ListFileShrinkRequest.js.map +1 -1
- package/dist/models/ListIndexDocumentsRequest.d.ts +26 -12
- package/dist/models/ListIndexDocumentsRequest.js.map +1 -1
- package/dist/models/ListIndexDocumentsResponseBody.d.ts +53 -30
- package/dist/models/ListIndexDocumentsResponseBody.js.map +1 -1
- package/dist/models/ListIndexFileDetailsRequest.d.ts +38 -0
- package/dist/models/ListIndexFileDetailsRequest.js.map +1 -1
- package/dist/models/ListIndexFileDetailsResponseBody.d.ts +93 -3
- package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
- package/dist/models/ListIndicesRequest.d.ts +5 -4
- package/dist/models/ListIndicesRequest.js.map +1 -1
- package/dist/models/ListIndicesResponseBody.d.ts +93 -51
- package/dist/models/ListIndicesResponseBody.js.map +1 -1
- package/dist/models/ListMemoriesRequest.d.ts +9 -1
- package/dist/models/ListMemoriesRequest.js.map +1 -1
- package/dist/models/ListMemoriesResponseBody.d.ts +33 -4
- package/dist/models/ListMemoriesResponseBody.js.map +1 -1
- package/dist/models/ListMemoryNodesRequest.d.ts +6 -0
- package/dist/models/ListMemoryNodesRequest.js.map +1 -1
- package/dist/models/ListMemoryNodesResponseBody.d.ts +26 -0
- package/dist/models/ListMemoryNodesResponseBody.js.map +1 -1
- package/dist/models/ListPromptTemplatesRequest.d.ts +3 -0
- package/dist/models/ListPromptTemplatesRequest.js.map +1 -1
- package/dist/models/ListPromptTemplatesResponseBody.d.ts +6 -0
- package/dist/models/ListPromptTemplatesResponseBody.js.map +1 -1
- package/dist/models/RetrieveRequest.d.ts +143 -29
- package/dist/models/RetrieveRequest.js.map +1 -1
- package/dist/models/RetrieveResponseBody.d.ts +52 -10
- package/dist/models/RetrieveResponseBody.js.map +1 -1
- package/dist/models/RetrieveShrinkRequest.d.ts +43 -23
- package/dist/models/RetrieveShrinkRequest.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobRequest.d.ts +114 -8
- package/dist/models/SubmitIndexAddDocumentsJobRequest.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobResponseBody.d.ts +10 -9
- package/dist/models/SubmitIndexAddDocumentsJobResponseBody.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.d.ts +114 -8
- package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.js.map +1 -1
- package/dist/models/SubmitIndexJobRequest.d.ts +2 -2
- package/dist/models/SubmitIndexJobResponseBody.d.ts +13 -14
- package/dist/models/SubmitIndexJobResponseBody.js.map +1 -1
- package/dist/models/UpdateChunkRequest.d.ts +14 -8
- package/dist/models/UpdateChunkRequest.js.map +1 -1
- package/dist/models/UpdateChunkResponseBody.d.ts +7 -13
- package/dist/models/UpdateChunkResponseBody.js.map +1 -1
- package/dist/models/UpdateConnectorRequest.d.ts +4 -0
- package/dist/models/UpdateConnectorRequest.js.map +1 -1
- package/dist/models/UpdateConnectorResponseBody.d.ts +20 -1
- package/dist/models/UpdateConnectorResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagRequest.d.ts +2 -0
- package/dist/models/UpdateFileTagRequest.js.map +1 -1
- package/dist/models/UpdateFileTagResponseBody.d.ts +24 -1
- package/dist/models/UpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagShrinkRequest.d.ts +2 -0
- package/dist/models/UpdateFileTagShrinkRequest.js.map +1 -1
- package/dist/models/UpdateIndexRequest.d.ts +44 -0
- package/dist/models/UpdateIndexRequest.js.map +1 -1
- package/dist/models/UpdateIndexResponseBody.d.ts +26 -0
- package/dist/models/UpdateIndexResponseBody.js.map +1 -1
- package/dist/models/UpdateMemoryNodeRequest.d.ts +5 -0
- package/dist/models/UpdateMemoryNodeRequest.js.map +1 -1
- package/dist/models/UpdateMemoryNodeResponseBody.d.ts +3 -0
- package/dist/models/UpdateMemoryNodeResponseBody.js.map +1 -1
- package/dist/models/UpdateMemoryRequest.d.ts +7 -0
- package/dist/models/UpdateMemoryRequest.js.map +1 -1
- package/dist/models/UpdateMemoryResponseBody.d.ts +4 -1
- package/dist/models/UpdateMemoryResponseBody.js.map +1 -1
- package/dist/models/UpdatePromptTemplateRequest.d.ts +6 -0
- package/dist/models/UpdatePromptTemplateRequest.js.map +1 -1
- package/dist/models/UpdateTableFromAuthorizedOssRequest.d.ts +8 -0
- package/dist/models/UpdateTableFromAuthorizedOssRequest.js.map +1 -1
- package/dist/models/UpdateTableFromAuthorizedOssResponseBody.d.ts +23 -1
- package/dist/models/UpdateTableFromAuthorizedOssResponseBody.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +619 -245
- package/src/models/AddCategoryRequest.ts +20 -1
- package/src/models/AddCategoryResponseBody.ts +33 -3
- package/src/models/AddConnectorRequest.ts +22 -0
- package/src/models/AddConnectorResponseBody.ts +24 -1
- package/src/models/AddConnectorShrinkRequest.ts +13 -0
- package/src/models/AddFileRequest.ts +80 -13
- package/src/models/AddFileResponseBody.ts +11 -10
- package/src/models/AddFileShrinkRequest.ts +70 -12
- package/src/models/AddFilesFromAuthorizedOssRequest.ts +70 -1
- package/src/models/AddFilesFromAuthorizedOssResponseBody.ts +42 -2
- package/src/models/AddFilesFromAuthorizedOssShrinkRequest.ts +28 -0
- package/src/models/AddTableRequest.ts +16 -0
- package/src/models/AddTableResponseBody.ts +22 -0
- package/src/models/AddTableShrinkRequest.ts +9 -0
- package/src/models/ApplyFileUploadLeaseRequest.ts +57 -3
- package/src/models/ApplyFileUploadLeaseResponseBody.ts +22 -20
- package/src/models/BatchUpdateFileTagRequest.ts +9 -0
- package/src/models/BatchUpdateFileTagResponseBody.ts +41 -1
- package/src/models/BatchUpdateFileTagShrinkRequest.ts +5 -0
- package/src/models/ChangeParseSettingRequest.ts +48 -14
- package/src/models/ChangeParseSettingResponseBody.ts +12 -7
- package/src/models/ChangeParseSettingShrinkRequest.ts +41 -8
- package/src/models/CreateIndexRequest.ts +340 -86
- package/src/models/CreateIndexResponseBody.ts +14 -19
- package/src/models/CreateIndexShrinkRequest.ts +261 -55
- package/src/models/CreateMemoryNodeRequest.ts +5 -0
- package/src/models/CreateMemoryNodeResponseBody.ts +8 -2
- package/src/models/CreateMemoryRequest.ts +7 -0
- package/src/models/CreateMemoryResponseBody.ts +10 -2
- package/src/models/CreatePromptTemplateRequest.ts +10 -0
- package/src/models/CreatePromptTemplateResponseBody.ts +6 -0
- package/src/models/DeleteCategoryResponseBody.ts +20 -3
- package/src/models/DeleteChunkRequest.ts +2 -2
- package/src/models/DeleteChunkResponseBody.ts +6 -12
- package/src/models/DeleteChunkShrinkRequest.ts +2 -2
- package/src/models/DeleteConnectorResponseBody.ts +0 -3
- package/src/models/DeleteFileResponseBody.ts +24 -1
- package/src/models/DeleteFilesRequest.ts +2 -0
- package/src/models/DeleteFilesResponseBody.ts +32 -0
- package/src/models/DeleteFilesShrinkRequest.ts +2 -0
- package/src/models/DeleteIndexDocumentRequest.ts +3 -3
- package/src/models/DeleteIndexDocumentResponseBody.ts +7 -8
- package/src/models/DeleteIndexDocumentShrinkRequest.ts +3 -3
- package/src/models/DeleteIndexRequest.ts +2 -2
- package/src/models/DeleteIndexResponseBody.ts +5 -6
- package/src/models/DeleteMemoryNodeResponseBody.ts +3 -0
- package/src/models/DeleteMemoryResponseBody.ts +4 -1
- package/src/models/DescribeFileResponseBody.ts +60 -26
- package/src/models/GetAlipayTransferStatusRequest.ts +6 -0
- package/src/models/GetAlipayTransferStatusResponseBody.ts +90 -0
- package/src/models/GetAlipayUrlRequest.ts +14 -0
- package/src/models/GetAlipayUrlResponseBody.ts +17 -0
- package/src/models/GetAvailableParserTypesResponseBody.ts +3 -0
- package/src/models/GetConnectorRequest.ts +11 -1
- package/src/models/GetConnectorResponseBody.ts +33 -1
- package/src/models/GetIndexJobStatusRequest.ts +5 -5
- package/src/models/GetIndexJobStatusResponseBody.ts +26 -26
- package/src/models/GetIndexMonitorRequest.ts +6 -0
- package/src/models/GetIndexMonitorResponseBody.ts +77 -1
- package/src/models/GetMemoryNodeResponseBody.ts +19 -0
- package/src/models/GetMemoryResponseBody.ts +19 -3
- package/src/models/GetParseSettingsResponseBody.ts +6 -8
- package/src/models/GetPromptTemplateResponseBody.ts +6 -0
- package/src/models/HighCodeDeployResponseBody.ts +1 -1
- package/src/models/ListCategoryRequest.ts +36 -1
- package/src/models/ListCategoryResponseBody.ts +70 -3
- package/src/models/ListChunksRequest.ts +39 -7
- package/src/models/ListChunksResponseBody.ts +58 -15
- package/src/models/ListFileRequest.ts +32 -2
- package/src/models/ListFileResponseBody.ts +71 -10
- package/src/models/ListFileShrinkRequest.ts +32 -2
- package/src/models/ListIndexDocumentsRequest.ts +26 -12
- package/src/models/ListIndexDocumentsResponseBody.ts +53 -30
- package/src/models/ListIndexFileDetailsRequest.ts +38 -0
- package/src/models/ListIndexFileDetailsResponseBody.ts +93 -3
- package/src/models/ListIndicesRequest.ts +5 -4
- package/src/models/ListIndicesResponseBody.ts +93 -51
- package/src/models/ListMemoriesRequest.ts +9 -1
- package/src/models/ListMemoriesResponseBody.ts +33 -4
- package/src/models/ListMemoryNodesRequest.ts +6 -0
- package/src/models/ListMemoryNodesResponseBody.ts +26 -0
- package/src/models/ListPromptTemplatesRequest.ts +3 -0
- package/src/models/ListPromptTemplatesResponseBody.ts +6 -0
- package/src/models/RetrieveRequest.ts +143 -29
- package/src/models/RetrieveResponseBody.ts +52 -10
- package/src/models/RetrieveShrinkRequest.ts +43 -23
- package/src/models/SubmitIndexAddDocumentsJobRequest.ts +114 -8
- package/src/models/SubmitIndexAddDocumentsJobResponseBody.ts +10 -9
- package/src/models/SubmitIndexAddDocumentsJobShrinkRequest.ts +114 -8
- package/src/models/SubmitIndexJobRequest.ts +2 -2
- package/src/models/SubmitIndexJobResponseBody.ts +13 -14
- package/src/models/UpdateChunkRequest.ts +14 -8
- package/src/models/UpdateChunkResponseBody.ts +7 -13
- package/src/models/UpdateConnectorRequest.ts +4 -0
- package/src/models/UpdateConnectorResponseBody.ts +20 -1
- package/src/models/UpdateFileTagRequest.ts +2 -0
- package/src/models/UpdateFileTagResponseBody.ts +24 -1
- package/src/models/UpdateFileTagShrinkRequest.ts +2 -0
- package/src/models/UpdateIndexRequest.ts +44 -0
- package/src/models/UpdateIndexResponseBody.ts +26 -0
- package/src/models/UpdateMemoryNodeRequest.ts +5 -0
- package/src/models/UpdateMemoryNodeResponseBody.ts +3 -0
- package/src/models/UpdateMemoryRequest.ts +7 -0
- package/src/models/UpdateMemoryResponseBody.ts +4 -1
- package/src/models/UpdatePromptTemplateRequest.ts +6 -0
- package/src/models/UpdateTableFromAuthorizedOssRequest.ts +8 -0
- package/src/models/UpdateTableFromAuthorizedOssResponseBody.ts +23 -1
package/dist/client.js
CHANGED
|
@@ -48,7 +48,11 @@ __exportStar(require("./models/model"), exports);
|
|
|
48
48
|
class Client extends openapi_core_1.default {
|
|
49
49
|
constructor(config) {
|
|
50
50
|
super(config);
|
|
51
|
-
this._endpointRule = "";
|
|
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
|
+
};
|
|
52
56
|
this.checkConfig(config);
|
|
53
57
|
this._endpoint = this.getEndpoint("bailian", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
|
|
54
58
|
}
|
|
@@ -62,14 +66,13 @@ class Client extends openapi_core_1.default {
|
|
|
62
66
|
return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
|
|
63
67
|
}
|
|
64
68
|
/**
|
|
65
|
-
* Creates a category in
|
|
69
|
+
* Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
|
|
66
70
|
*
|
|
67
71
|
* @remarks
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
* **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
|
|
72
|
+
* - You cannot use an API to add data tables. To add data tables, go to the [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) page in the console.
|
|
73
|
+
* - A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The `AliyunBailianDataFullAccess` permission, which includes the `sfm:AddCategory` permission, is required. An Alibaba Cloud account can call this operation directly without requiring authorization. To call this operation, use the latest version of the [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
74
|
+
* - This operation is not idempotent.
|
|
75
|
+
* **Rate limiting:** Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 5 calls per second. If rate limiting is triggered, try again later.
|
|
73
76
|
*
|
|
74
77
|
* @param request - AddCategoryRequest
|
|
75
78
|
* @param headers - map
|
|
@@ -109,14 +112,13 @@ class Client extends openapi_core_1.default {
|
|
|
109
112
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddCategoryResponse({}));
|
|
110
113
|
}
|
|
111
114
|
/**
|
|
112
|
-
* Creates a category in
|
|
115
|
+
* Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
|
|
113
116
|
*
|
|
114
117
|
* @remarks
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
|
|
118
|
+
* - You cannot use an API to add data tables. To add data tables, go to the [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) page in the console.
|
|
119
|
+
* - A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The `AliyunBailianDataFullAccess` permission, which includes the `sfm:AddCategory` permission, is required. An Alibaba Cloud account can call this operation directly without requiring authorization. To call this operation, use the latest version of the [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
120
|
+
* - This operation is not idempotent.
|
|
121
|
+
* **Rate limiting:** Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 5 calls per second. If rate limiting is triggered, try again later.
|
|
120
122
|
*
|
|
121
123
|
* @param request - AddCategoryRequest
|
|
122
124
|
* @returns AddCategoryResponse
|
|
@@ -127,7 +129,13 @@ class Client extends openapi_core_1.default {
|
|
|
127
129
|
return await this.addCategoryWithOptions(WorkspaceId, request, headers, runtime);
|
|
128
130
|
}
|
|
129
131
|
/**
|
|
130
|
-
*
|
|
132
|
+
* Creates a connector. This API currently supports only file connectors.
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* - To call this operation, a RAM user (sub-account) must first have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and be a member of a [business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:AddCategory permission. A primary account can call this operation directly without authorization. We recommend 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) to call this operation.
|
|
136
|
+
* - This operation is not idempotent.
|
|
137
|
+
* **Throttling:**
|
|
138
|
+
* Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
131
139
|
*
|
|
132
140
|
* @param tmpReq - AddConnectorRequest
|
|
133
141
|
* @param headers - map
|
|
@@ -172,7 +180,13 @@ class Client extends openapi_core_1.default {
|
|
|
172
180
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddConnectorResponse({}));
|
|
173
181
|
}
|
|
174
182
|
/**
|
|
175
|
-
*
|
|
183
|
+
* Creates a connector. This API currently supports only file connectors.
|
|
184
|
+
*
|
|
185
|
+
* @remarks
|
|
186
|
+
* - To call this operation, a RAM user (sub-account) must first have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and be a member of a [business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:AddCategory permission. A primary account can call this operation directly without authorization. We recommend 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) to call this operation.
|
|
187
|
+
* - This operation is not idempotent.
|
|
188
|
+
* **Throttling:**
|
|
189
|
+
* Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
176
190
|
*
|
|
177
191
|
* @param request - AddConnectorRequest
|
|
178
192
|
* @returns AddConnectorResponse
|
|
@@ -183,14 +197,12 @@ class Client extends openapi_core_1.default {
|
|
|
183
197
|
return await this.addConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
184
198
|
}
|
|
185
199
|
/**
|
|
186
|
-
* Imports
|
|
200
|
+
* Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
|
|
187
201
|
*
|
|
188
202
|
* @remarks
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
* * After you call this operation, the system parses and imports your document. The process takes some time.
|
|
193
|
-
* * This interface is not idempotent.
|
|
203
|
+
* - To call this API, a RAM user (sub-account) must have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and be [added to a workspace](https://help.aliyun.com/document_detail/2851098.html). The required policy is `AliyunBailianDataFullAccess`, which includes the `sfm:AddFile` permission. An Alibaba Cloud account (primary account) can call this API directly without authorization. We recommend 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) to call this API.
|
|
204
|
+
* - This API is not idempotent.
|
|
205
|
+
* **Throttling:** Frequent calls to this API are subject to throttling. Do not exceed a rate of 10 calls per second. If your request is throttled, try again later.
|
|
194
206
|
*
|
|
195
207
|
* @param tmpReq - AddFileRequest
|
|
196
208
|
* @param headers - map
|
|
@@ -247,14 +259,12 @@ class Client extends openapi_core_1.default {
|
|
|
247
259
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFileResponse({}));
|
|
248
260
|
}
|
|
249
261
|
/**
|
|
250
|
-
* Imports
|
|
262
|
+
* Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
|
|
251
263
|
*
|
|
252
264
|
* @remarks
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
* * After you call this operation, the system parses and imports your document. The process takes some time.
|
|
257
|
-
* * This interface is not idempotent.
|
|
265
|
+
* - To call this API, a RAM user (sub-account) must have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and be [added to a workspace](https://help.aliyun.com/document_detail/2851098.html). The required policy is `AliyunBailianDataFullAccess`, which includes the `sfm:AddFile` permission. An Alibaba Cloud account (primary account) can call this API directly without authorization. We recommend 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) to call this API.
|
|
266
|
+
* - This API is not idempotent.
|
|
267
|
+
* **Throttling:** Frequent calls to this API are subject to throttling. Do not exceed a rate of 10 calls per second. If your request is throttled, try again later.
|
|
258
268
|
*
|
|
259
269
|
* @param request - AddFileRequest
|
|
260
270
|
* @returns AddFileResponse
|
|
@@ -265,7 +275,17 @@ class Client extends openapi_core_1.default {
|
|
|
265
275
|
return await this.addFileWithOptions(WorkspaceId, request, headers, runtime);
|
|
266
276
|
}
|
|
267
277
|
/**
|
|
268
|
-
*
|
|
278
|
+
* Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
|
|
279
|
+
*
|
|
280
|
+
* @remarks
|
|
281
|
+
* - Please ensure that the OSS Bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account (main account) and that authorization has been completed according to the [Configuration instructions for importing data from OSS](https://help.aliyun.com/document_detail/2782155.html).
|
|
282
|
+
*
|
|
283
|
+
* - Supported Bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption are supported. Public read/write, public read, and private Buckets are supported.
|
|
284
|
+
* - If you want to use a Bucket with [Referer hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, refer to [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html) to add the domain `*.console.aliyun.com` to the Referer allowlist.
|
|
285
|
+
* - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFilesFromAuthorizedOss permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this directly without authorization. We recommend that you call this operation through the latest version of the <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).
|
|
286
|
+
* - This operation is not idempotent.
|
|
287
|
+
* **Throttling description:**
|
|
288
|
+
* Frequent calls to this operation will be throttled. The frequency should not exceed 5 calls per second. If throttled, please try again later.
|
|
269
289
|
*
|
|
270
290
|
* @param tmpReq - AddFilesFromAuthorizedOssRequest
|
|
271
291
|
* @param headers - map
|
|
@@ -322,7 +342,17 @@ class Client extends openapi_core_1.default {
|
|
|
322
342
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFilesFromAuthorizedOssResponse({}));
|
|
323
343
|
}
|
|
324
344
|
/**
|
|
325
|
-
*
|
|
345
|
+
* Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
|
|
346
|
+
*
|
|
347
|
+
* @remarks
|
|
348
|
+
* - Please ensure that the OSS Bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account (main account) and that authorization has been completed according to the [Configuration instructions for importing data from OSS](https://help.aliyun.com/document_detail/2782155.html).
|
|
349
|
+
*
|
|
350
|
+
* - Supported Bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption are supported. Public read/write, public read, and private Buckets are supported.
|
|
351
|
+
* - If you want to use a Bucket with [Referer hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, refer to [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html) to add the domain `*.console.aliyun.com` to the Referer allowlist.
|
|
352
|
+
* - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFilesFromAuthorizedOss permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this directly without authorization. We recommend that you call this operation through the latest version of the <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).
|
|
353
|
+
* - This operation is not idempotent.
|
|
354
|
+
* **Throttling description:**
|
|
355
|
+
* Frequent calls to this operation will be throttled. The frequency should not exceed 5 calls per second. If throttled, please try again later.
|
|
326
356
|
*
|
|
327
357
|
* @param request - AddFilesFromAuthorizedOssRequest
|
|
328
358
|
* @returns AddFilesFromAuthorizedOssResponse
|
|
@@ -333,7 +363,13 @@ class Client extends openapi_core_1.default {
|
|
|
333
363
|
return await this.addFilesFromAuthorizedOssWithOptions(WorkspaceId, request, headers, runtime);
|
|
334
364
|
}
|
|
335
365
|
/**
|
|
336
|
-
*
|
|
366
|
+
* Adds a table to a tabular data connector.
|
|
367
|
+
*
|
|
368
|
+
* @remarks
|
|
369
|
+
* - 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:AddTable 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.
|
|
370
|
+
* - This operation is not idempotent.
|
|
371
|
+
* **Rate limit:**
|
|
372
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
337
373
|
*
|
|
338
374
|
* @param tmpReq - AddTableRequest
|
|
339
375
|
* @param headers - map
|
|
@@ -354,6 +390,9 @@ class Client extends openapi_core_1.default {
|
|
|
354
390
|
if (!$dara.isNull(request.tableColumnsShrink)) {
|
|
355
391
|
body["TableColumns"] = request.tableColumnsShrink;
|
|
356
392
|
}
|
|
393
|
+
if (!$dara.isNull(request.tableDesc)) {
|
|
394
|
+
body["TableDesc"] = request.tableDesc;
|
|
395
|
+
}
|
|
357
396
|
if (!$dara.isNull(request.tableName)) {
|
|
358
397
|
body["TableName"] = request.tableName;
|
|
359
398
|
}
|
|
@@ -375,7 +414,13 @@ class Client extends openapi_core_1.default {
|
|
|
375
414
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddTableResponse({}));
|
|
376
415
|
}
|
|
377
416
|
/**
|
|
378
|
-
*
|
|
417
|
+
* Adds a table to a tabular data connector.
|
|
418
|
+
*
|
|
419
|
+
* @remarks
|
|
420
|
+
* - 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:AddTable 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.
|
|
421
|
+
* - This operation is not idempotent.
|
|
422
|
+
* **Rate limit:**
|
|
423
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
379
424
|
*
|
|
380
425
|
* @param request - AddTableRequest
|
|
381
426
|
* @returns AddTableResponse
|
|
@@ -386,13 +431,13 @@ class Client extends openapi_core_1.default {
|
|
|
386
431
|
return await this.addTableWithOptions(WorkspaceId, request, headers, runtime);
|
|
387
432
|
}
|
|
388
433
|
/**
|
|
389
|
-
*
|
|
434
|
+
* Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
|
|
390
435
|
*
|
|
391
436
|
* @remarks
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
437
|
+
* - RAM users (sub-accounts) must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ApplyFileUploadLease permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can directly call this API without authorization. We recommend that you call this API 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).
|
|
438
|
+
* - This API is not idempotent.
|
|
439
|
+
* **Throttling:**
|
|
440
|
+
* This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
|
|
396
441
|
*
|
|
397
442
|
* @param request - ApplyFileUploadLeaseRequest
|
|
398
443
|
* @param headers - map
|
|
@@ -435,13 +480,13 @@ class Client extends openapi_core_1.default {
|
|
|
435
480
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ApplyFileUploadLeaseResponse({}));
|
|
436
481
|
}
|
|
437
482
|
/**
|
|
438
|
-
*
|
|
483
|
+
* Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
|
|
439
484
|
*
|
|
440
485
|
* @remarks
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
486
|
+
* - RAM users (sub-accounts) must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ApplyFileUploadLease permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can directly call this API without authorization. We recommend that you call this API 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).
|
|
487
|
+
* - This API is not idempotent.
|
|
488
|
+
* **Throttling:**
|
|
489
|
+
* This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
|
|
445
490
|
*
|
|
446
491
|
* @param request - ApplyFileUploadLeaseRequest
|
|
447
492
|
* @returns ApplyFileUploadLeaseResponse
|
|
@@ -503,7 +548,7 @@ class Client extends openapi_core_1.default {
|
|
|
503
548
|
return await this.applyTempStorageLeaseWithOptions(WorkspaceId, request, headers, runtime);
|
|
504
549
|
}
|
|
505
550
|
/**
|
|
506
|
-
*
|
|
551
|
+
* This operation updates document tags in a data connection in batches.
|
|
507
552
|
*
|
|
508
553
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
509
554
|
* @param headers - map
|
|
@@ -542,7 +587,7 @@ class Client extends openapi_core_1.default {
|
|
|
542
587
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.BatchUpdateFileTagResponse({}));
|
|
543
588
|
}
|
|
544
589
|
/**
|
|
545
|
-
*
|
|
590
|
+
* This operation updates document tags in a data connection in batches.
|
|
546
591
|
*
|
|
547
592
|
* @param request - BatchUpdateFileTagRequest
|
|
548
593
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -553,7 +598,13 @@ class Client extends openapi_core_1.default {
|
|
|
553
598
|
return await this.batchUpdateFileTagWithOptions(WorkspaceId, request, headers, runtime);
|
|
554
599
|
}
|
|
555
600
|
/**
|
|
556
|
-
*
|
|
601
|
+
* Configures the parsing method for a specific file type. For example, you can specify LLM-based document parsing for .pdf files and the Qwen VL Parser for .jpg files.
|
|
602
|
+
*
|
|
603
|
+
* @remarks
|
|
604
|
+
* - A RAM user (sub-account) must first obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:ChangeParseSetting` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (primary account) can call this operation directly without authorization. We recommend using the latest version of the <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.
|
|
605
|
+
* - This operation is not idempotent.
|
|
606
|
+
* **Throttling**
|
|
607
|
+
* The system throttles frequent calls to this operation. Do not exceed a frequency of 10 requests per second. If your request is throttled, try again later.
|
|
557
608
|
*
|
|
558
609
|
* @param tmpReq - ChangeParseSettingRequest
|
|
559
610
|
* @param headers - map
|
|
@@ -598,7 +649,13 @@ class Client extends openapi_core_1.default {
|
|
|
598
649
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ChangeParseSettingResponse({}));
|
|
599
650
|
}
|
|
600
651
|
/**
|
|
601
|
-
*
|
|
652
|
+
* Configures the parsing method for a specific file type. For example, you can specify LLM-based document parsing for .pdf files and the Qwen VL Parser for .jpg files.
|
|
653
|
+
*
|
|
654
|
+
* @remarks
|
|
655
|
+
* - A RAM user (sub-account) must first obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:ChangeParseSetting` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (primary account) can call this operation directly without authorization. We recommend using the latest version of the <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.
|
|
656
|
+
* - This operation is not idempotent.
|
|
657
|
+
* **Throttling**
|
|
658
|
+
* The system throttles frequent calls to this operation. Do not exceed a frequency of 10 requests per second. If your request is throttled, try again later.
|
|
602
659
|
*
|
|
603
660
|
* @param request - ChangeParseSettingRequest
|
|
604
661
|
* @returns ChangeParseSettingResponse
|
|
@@ -671,17 +728,17 @@ class Client extends openapi_core_1.default {
|
|
|
671
728
|
return await this.createAndPulishAgentWithOptions(workspaceId, request, headers, runtime);
|
|
672
729
|
}
|
|
673
730
|
/**
|
|
674
|
-
*
|
|
731
|
+
* Use this API to create two types of knowledge bases: unstructured knowledge bases for documents, audio, or video, and structured knowledge bases for data queries or image Q&A.
|
|
675
732
|
*
|
|
676
733
|
* @remarks
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
*
|
|
734
|
+
* - **Permissions**:
|
|
735
|
+
* - **RAM user**: A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. You can use the `AliyunBailianDataFullAccess` policy, which includes the \\`sfm:CreateIndex\\` permission required for this operation.
|
|
736
|
+
* - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
|
|
737
|
+
* - **How to call**: Use the latest version of the <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation. The SDK handles the complex signature calculation logic to simplify the process.
|
|
738
|
+
* - **What to do next**: This operation only initializes a knowledge base creation job. After calling this operation, you must call the **SubmitIndexJob** operation to complete the creation. Otherwise, an empty knowledge base is created. For related code examples, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
739
|
+
* - **Idempotence**: This operation is not idempotent. Repeated calls may create multiple knowledge bases with the same name. To ensure idempotence, query for the knowledge base before you create it.
|
|
740
|
+
* **Rate limiting:**
|
|
741
|
+
* Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 10 calls per second. If you encounter rate limiting, retry the call later.
|
|
685
742
|
*
|
|
686
743
|
* @param tmpReq - CreateIndexRequest
|
|
687
744
|
* @param headers - map
|
|
@@ -828,17 +885,17 @@ class Client extends openapi_core_1.default {
|
|
|
828
885
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIndexResponse({}));
|
|
829
886
|
}
|
|
830
887
|
/**
|
|
831
|
-
*
|
|
888
|
+
* Use this API to create two types of knowledge bases: unstructured knowledge bases for documents, audio, or video, and structured knowledge bases for data queries or image Q&A.
|
|
832
889
|
*
|
|
833
890
|
* @remarks
|
|
834
|
-
*
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
*
|
|
838
|
-
*
|
|
839
|
-
*
|
|
840
|
-
*
|
|
841
|
-
*
|
|
891
|
+
* - **Permissions**:
|
|
892
|
+
* - **RAM user**: A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. You can use the `AliyunBailianDataFullAccess` policy, which includes the \\`sfm:CreateIndex\\` permission required for this operation.
|
|
893
|
+
* - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
|
|
894
|
+
* - **How to call**: Use the latest version of the <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation. The SDK handles the complex signature calculation logic to simplify the process.
|
|
895
|
+
* - **What to do next**: This operation only initializes a knowledge base creation job. After calling this operation, you must call the **SubmitIndexJob** operation to complete the creation. Otherwise, an empty knowledge base is created. For related code examples, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
896
|
+
* - **Idempotence**: This operation is not idempotent. Repeated calls may create multiple knowledge bases with the same name. To ensure idempotence, query for the knowledge base before you create it.
|
|
897
|
+
* **Rate limiting:**
|
|
898
|
+
* Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 10 calls per second. If you encounter rate limiting, retry the call later.
|
|
842
899
|
*
|
|
843
900
|
* @param request - CreateIndexRequest
|
|
844
901
|
* @returns CreateIndexResponse
|
|
@@ -849,7 +906,14 @@ class Client extends openapi_core_1.default {
|
|
|
849
906
|
return await this.createIndexWithOptions(WorkspaceId, request, headers, runtime);
|
|
850
907
|
}
|
|
851
908
|
/**
|
|
852
|
-
*
|
|
909
|
+
* Creates a long-term memory.
|
|
910
|
+
*
|
|
911
|
+
* @remarks
|
|
912
|
+
* - You can store specific information from conversations (memory nodes. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory)) in a long-term memory. Agent applications can then reference this information in subsequent conversations. This is not an automatic creation procedure. You must first invoke the [CreateMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememory) operation to create a long-term memory and obtain the `memoryId`. Then pass the `memoryId` when you [invoke the agent application through the API](https://www.alibabacloud.com/help/en/model-studio/user-guide/application-calling).
|
|
913
|
+
* > Long-term memory does not support storing and managing user profiles through the API. Perform related operations in the console. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory#578ebae524m6l).
|
|
914
|
+
* - If you pass a `memoryId`, the system uses automatic creation to generate memory nodes (MemoryNode) under the specified long-term memory based on conversation records. You can also invoke the [CreateMemoryNode](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememorynode) operation to manually create memory nodes.
|
|
915
|
+
* - This operation does not support idempotence.
|
|
916
|
+
* **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
853
917
|
*
|
|
854
918
|
* @param request - CreateMemoryRequest
|
|
855
919
|
* @param headers - map
|
|
@@ -880,7 +944,14 @@ class Client extends openapi_core_1.default {
|
|
|
880
944
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateMemoryResponse({}));
|
|
881
945
|
}
|
|
882
946
|
/**
|
|
883
|
-
*
|
|
947
|
+
* Creates a long-term memory.
|
|
948
|
+
*
|
|
949
|
+
* @remarks
|
|
950
|
+
* - You can store specific information from conversations (memory nodes. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory)) in a long-term memory. Agent applications can then reference this information in subsequent conversations. This is not an automatic creation procedure. You must first invoke the [CreateMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememory) operation to create a long-term memory and obtain the `memoryId`. Then pass the `memoryId` when you [invoke the agent application through the API](https://www.alibabacloud.com/help/en/model-studio/user-guide/application-calling).
|
|
951
|
+
* > Long-term memory does not support storing and managing user profiles through the API. Perform related operations in the console. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory#578ebae524m6l).
|
|
952
|
+
* - If you pass a `memoryId`, the system uses automatic creation to generate memory nodes (MemoryNode) under the specified long-term memory based on conversation records. You can also invoke the [CreateMemoryNode](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememorynode) operation to manually create memory nodes.
|
|
953
|
+
* - This operation does not support idempotence.
|
|
954
|
+
* **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
884
955
|
*
|
|
885
956
|
* @param request - CreateMemoryRequest
|
|
886
957
|
* @returns CreateMemoryResponse
|
|
@@ -891,7 +962,7 @@ class Client extends openapi_core_1.default {
|
|
|
891
962
|
return await this.createMemoryWithOptions(workspaceId, request, headers, runtime);
|
|
892
963
|
}
|
|
893
964
|
/**
|
|
894
|
-
*
|
|
965
|
+
* Creates a memory node.
|
|
895
966
|
*
|
|
896
967
|
* @param request - CreateMemoryNodeRequest
|
|
897
968
|
* @param headers - map
|
|
@@ -922,7 +993,7 @@ class Client extends openapi_core_1.default {
|
|
|
922
993
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateMemoryNodeResponse({}));
|
|
923
994
|
}
|
|
924
995
|
/**
|
|
925
|
-
*
|
|
996
|
+
* Creates a memory node.
|
|
926
997
|
*
|
|
927
998
|
* @param request - CreateMemoryNodeRequest
|
|
928
999
|
* @returns CreateMemoryNodeResponse
|
|
@@ -933,7 +1004,10 @@ class Client extends openapi_core_1.default {
|
|
|
933
1004
|
return await this.createMemoryNodeWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
934
1005
|
}
|
|
935
1006
|
/**
|
|
936
|
-
*
|
|
1007
|
+
* Create a prompt template.
|
|
1008
|
+
*
|
|
1009
|
+
* @remarks
|
|
1010
|
+
* This API does not currently support the creation of text-to-image prompt templates.
|
|
937
1011
|
*
|
|
938
1012
|
* @param request - CreatePromptTemplateRequest
|
|
939
1013
|
* @param headers - map
|
|
@@ -967,7 +1041,10 @@ class Client extends openapi_core_1.default {
|
|
|
967
1041
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreatePromptTemplateResponse({}));
|
|
968
1042
|
}
|
|
969
1043
|
/**
|
|
970
|
-
*
|
|
1044
|
+
* Create a prompt template.
|
|
1045
|
+
*
|
|
1046
|
+
* @remarks
|
|
1047
|
+
* This API does not currently support the creation of text-to-image prompt templates.
|
|
971
1048
|
*
|
|
972
1049
|
* @param request - CreatePromptTemplateRequest
|
|
973
1050
|
* @returns CreatePromptTemplateResponse
|
|
@@ -1015,7 +1092,13 @@ class Client extends openapi_core_1.default {
|
|
|
1015
1092
|
return await this.deleteAgentWithOptions(workspaceId, appCode, request, headers, runtime);
|
|
1016
1093
|
}
|
|
1017
1094
|
/**
|
|
1018
|
-
*
|
|
1095
|
+
* Permanently deletes a specified category.
|
|
1096
|
+
*
|
|
1097
|
+
* @remarks
|
|
1098
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory 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.
|
|
1099
|
+
* - This operation is idempotent.
|
|
1100
|
+
* **Rate limiting:**
|
|
1101
|
+
* This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1019
1102
|
*
|
|
1020
1103
|
* @param request - DeleteCategoryRequest
|
|
1021
1104
|
* @param headers - map
|
|
@@ -1041,7 +1124,13 @@ class Client extends openapi_core_1.default {
|
|
|
1041
1124
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteCategoryResponse({}));
|
|
1042
1125
|
}
|
|
1043
1126
|
/**
|
|
1044
|
-
*
|
|
1127
|
+
* Permanently deletes a specified category.
|
|
1128
|
+
*
|
|
1129
|
+
* @remarks
|
|
1130
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory 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.
|
|
1131
|
+
* - This operation is idempotent.
|
|
1132
|
+
* **Rate limiting:**
|
|
1133
|
+
* This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1045
1134
|
*
|
|
1046
1135
|
* @param request - DeleteCategoryRequest
|
|
1047
1136
|
* @returns DeleteCategoryResponse
|
|
@@ -1052,18 +1141,18 @@ class Client extends openapi_core_1.default {
|
|
|
1052
1141
|
return await this.deleteCategoryWithOptions(CategoryId, WorkspaceId, request, headers, runtime);
|
|
1053
1142
|
}
|
|
1054
1143
|
/**
|
|
1055
|
-
* Deletes
|
|
1144
|
+
* Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
1056
1145
|
*
|
|
1057
1146
|
* @remarks
|
|
1058
|
-
*
|
|
1059
|
-
* **
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1147
|
+
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
1148
|
+
* - **Permission requirements**:
|
|
1149
|
+
* - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
|
|
1150
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1151
|
+
* - **Invocation method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
1152
|
+
* - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
|
|
1153
|
+
* - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
|
|
1154
|
+
* **Rate limit:**
|
|
1155
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1067
1156
|
*
|
|
1068
1157
|
* @param tmpReq - DeleteChunkRequest
|
|
1069
1158
|
* @param headers - map
|
|
@@ -1102,18 +1191,18 @@ class Client extends openapi_core_1.default {
|
|
|
1102
1191
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteChunkResponse({}));
|
|
1103
1192
|
}
|
|
1104
1193
|
/**
|
|
1105
|
-
* Deletes
|
|
1194
|
+
* Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
1106
1195
|
*
|
|
1107
1196
|
* @remarks
|
|
1108
|
-
*
|
|
1109
|
-
* **
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
*
|
|
1113
|
-
*
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1197
|
+
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
1198
|
+
* - **Permission requirements**:
|
|
1199
|
+
* - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
|
|
1200
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1201
|
+
* - **Invocation method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
1202
|
+
* - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
|
|
1203
|
+
* - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
|
|
1204
|
+
* **Rate limit:**
|
|
1205
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1117
1206
|
*
|
|
1118
1207
|
* @param request - DeleteChunkRequest
|
|
1119
1208
|
* @returns DeleteChunkResponse
|
|
@@ -1126,6 +1215,12 @@ class Client extends openapi_core_1.default {
|
|
|
1126
1215
|
/**
|
|
1127
1216
|
* 删除连接器
|
|
1128
1217
|
*
|
|
1218
|
+
* @remarks
|
|
1219
|
+
* - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(需要`AliyunBailianDataFullAccess`,已包括sfm:DeleteConnector权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
|
|
1220
|
+
* - 本接口不具备幂等性。
|
|
1221
|
+
* **限流说明:**
|
|
1222
|
+
* 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
|
|
1223
|
+
*
|
|
1129
1224
|
* @param request - DeleteConnectorRequest
|
|
1130
1225
|
* @param headers - map
|
|
1131
1226
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1152,6 +1247,12 @@ class Client extends openapi_core_1.default {
|
|
|
1152
1247
|
/**
|
|
1153
1248
|
* 删除连接器
|
|
1154
1249
|
*
|
|
1250
|
+
* @remarks
|
|
1251
|
+
* - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(需要`AliyunBailianDataFullAccess`,已包括sfm:DeleteConnector权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
|
|
1252
|
+
* - 本接口不具备幂等性。
|
|
1253
|
+
* **限流说明:**
|
|
1254
|
+
* 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
|
|
1255
|
+
*
|
|
1155
1256
|
* @param request - DeleteConnectorRequest
|
|
1156
1257
|
* @returns DeleteConnectorResponse
|
|
1157
1258
|
*/
|
|
@@ -1161,7 +1262,16 @@ class Client extends openapi_core_1.default {
|
|
|
1161
1262
|
return await this.deleteConnectorWithOptions(ConnectorId, WorkspaceId, request, headers, runtime);
|
|
1162
1263
|
}
|
|
1163
1264
|
/**
|
|
1164
|
-
*
|
|
1265
|
+
* Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
|
|
1266
|
+
*
|
|
1267
|
+
* @remarks
|
|
1268
|
+
* - Deleting data tables via API is not supported. To delete a data table or specific data within a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) to perform the operation.
|
|
1269
|
+
* - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) and does not affect any knowledge bases that have already been built. To delete a file from a knowledge base, invoke the **DeleteIndexDocument** API.
|
|
1270
|
+
* - A RAM user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the `sfm:DeleteFile` permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this API. An Alibaba Cloud account can invoke this API directly without authorization. We recommend that you use the latest version of the <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 API.
|
|
1271
|
+
* - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
|
|
1272
|
+
* - This API is idempotent.
|
|
1273
|
+
* **Rate Limiting Notice:**
|
|
1274
|
+
* Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
|
|
1165
1275
|
*
|
|
1166
1276
|
* @param request - DeleteFileRequest
|
|
1167
1277
|
* @param headers - map
|
|
@@ -1187,7 +1297,16 @@ class Client extends openapi_core_1.default {
|
|
|
1187
1297
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFileResponse({}));
|
|
1188
1298
|
}
|
|
1189
1299
|
/**
|
|
1190
|
-
*
|
|
1300
|
+
* Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
|
|
1301
|
+
*
|
|
1302
|
+
* @remarks
|
|
1303
|
+
* - Deleting data tables via API is not supported. To delete a data table or specific data within a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) to perform the operation.
|
|
1304
|
+
* - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) and does not affect any knowledge bases that have already been built. To delete a file from a knowledge base, invoke the **DeleteIndexDocument** API.
|
|
1305
|
+
* - A RAM user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the `sfm:DeleteFile` permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this API. An Alibaba Cloud account can invoke this API directly without authorization. We recommend that you use the latest version of the <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 API.
|
|
1306
|
+
* - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
|
|
1307
|
+
* - This API is idempotent.
|
|
1308
|
+
* **Rate Limiting Notice:**
|
|
1309
|
+
* Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
|
|
1191
1310
|
*
|
|
1192
1311
|
* @param request - DeleteFileRequest
|
|
1193
1312
|
* @returns DeleteFileResponse
|
|
@@ -1198,7 +1317,16 @@ class Client extends openapi_core_1.default {
|
|
|
1198
1317
|
return await this.deleteFileWithOptions(FileId, WorkspaceId, request, headers, runtime);
|
|
1199
1318
|
}
|
|
1200
1319
|
/**
|
|
1201
|
-
*
|
|
1320
|
+
* Delete files in batch
|
|
1321
|
+
*
|
|
1322
|
+
* @remarks
|
|
1323
|
+
* - Deleting data tables through the API is not supported. To delete a data table or specific data in a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
|
|
1324
|
+
* - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). It does not affect knowledge bases that have already been built. To delete files in a knowledge base, call the **DeleteIndexDocument** operation.
|
|
1325
|
+
* - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which already includes the sfm:DeleteFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend that you use the latest version of the <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.
|
|
1326
|
+
* - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
|
|
1327
|
+
* - This operation is idempotent.
|
|
1328
|
+
* **Throttling:**
|
|
1329
|
+
* Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
|
|
1202
1330
|
*
|
|
1203
1331
|
* @param tmpReq - DeleteFilesRequest
|
|
1204
1332
|
* @param headers - map
|
|
@@ -1234,7 +1362,16 @@ class Client extends openapi_core_1.default {
|
|
|
1234
1362
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFilesResponse({}));
|
|
1235
1363
|
}
|
|
1236
1364
|
/**
|
|
1237
|
-
*
|
|
1365
|
+
* Delete files in batch
|
|
1366
|
+
*
|
|
1367
|
+
* @remarks
|
|
1368
|
+
* - Deleting data tables through the API is not supported. To delete a data table or specific data in a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
|
|
1369
|
+
* - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). It does not affect knowledge bases that have already been built. To delete files in a knowledge base, call the **DeleteIndexDocument** operation.
|
|
1370
|
+
* - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which already includes the sfm:DeleteFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend that you use the latest version of the <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.
|
|
1371
|
+
* - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
|
|
1372
|
+
* - This operation is idempotent.
|
|
1373
|
+
* **Throttling:**
|
|
1374
|
+
* Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
|
|
1238
1375
|
*
|
|
1239
1376
|
* @param request - DeleteFilesRequest
|
|
1240
1377
|
* @returns DeleteFilesResponse
|
|
@@ -1245,14 +1382,17 @@ class Client extends openapi_core_1.default {
|
|
|
1245
1382
|
return await this.deleteFilesWithOptions(WorkspaceId, request, headers, runtime);
|
|
1246
1383
|
}
|
|
1247
1384
|
/**
|
|
1248
|
-
*
|
|
1385
|
+
* Permanently deletes a specified knowledge base.
|
|
1249
1386
|
*
|
|
1250
1387
|
* @remarks
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1253
|
-
*
|
|
1254
|
-
*
|
|
1255
|
-
*
|
|
1388
|
+
* - 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:DeleteIndex 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.
|
|
1389
|
+
* - 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).
|
|
1390
|
+
* - If the knowledge base is associated with an application, you must first dissociate it from the application before deleting it. This can currently only be done through the console. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
1391
|
+
* - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
|
|
1392
|
+
* - Invoking this operation does not delete files that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
|
|
1393
|
+
* - This operation has idempotence.
|
|
1394
|
+
* **Rate limit:**
|
|
1395
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1256
1396
|
*
|
|
1257
1397
|
* @param request - DeleteIndexRequest
|
|
1258
1398
|
* @param headers - map
|
|
@@ -1283,14 +1423,17 @@ class Client extends openapi_core_1.default {
|
|
|
1283
1423
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIndexResponse({}));
|
|
1284
1424
|
}
|
|
1285
1425
|
/**
|
|
1286
|
-
*
|
|
1426
|
+
* Permanently deletes a specified knowledge base.
|
|
1287
1427
|
*
|
|
1288
1428
|
* @remarks
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1429
|
+
* - 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:DeleteIndex 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.
|
|
1430
|
+
* - 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).
|
|
1431
|
+
* - If the knowledge base is associated with an application, you must first dissociate it from the application before deleting it. This can currently only be done through the console. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
1432
|
+
* - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
|
|
1433
|
+
* - Invoking this operation does not delete files that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
|
|
1434
|
+
* - This operation has idempotence.
|
|
1435
|
+
* **Rate limit:**
|
|
1436
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1294
1437
|
*
|
|
1295
1438
|
* @param request - DeleteIndexRequest
|
|
1296
1439
|
* @returns DeleteIndexResponse
|
|
@@ -1301,14 +1444,18 @@ class Client extends openapi_core_1.default {
|
|
|
1301
1444
|
return await this.deleteIndexWithOptions(WorkspaceId, request, headers, runtime);
|
|
1302
1445
|
}
|
|
1303
1446
|
/**
|
|
1304
|
-
*
|
|
1447
|
+
* Permanently deletes files from a specified knowledge base.
|
|
1305
1448
|
*
|
|
1306
1449
|
* @remarks
|
|
1307
|
-
*
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
*
|
|
1450
|
+
* - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
|
|
1451
|
+
* - 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:DeleteIndexDocument permission), before calling this operation. Alibaba Cloud accounts can call 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 call this operation.
|
|
1452
|
+
* - Before calling 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).
|
|
1453
|
+
* - You can only delete files whose status is import failed (INSERT_ERROR) or import succeeded (FINISH) in the knowledge base. To query the file status in a specified knowledge base, call the **ListIndexDocuments** operation.
|
|
1454
|
+
* - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
|
|
1455
|
+
* - Calling this operation does not delete documents that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
|
|
1456
|
+
* - This operation is idempotent.
|
|
1457
|
+
* **Throttling:**
|
|
1458
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1312
1459
|
*
|
|
1313
1460
|
* @param tmpReq - DeleteIndexDocumentRequest
|
|
1314
1461
|
* @param headers - map
|
|
@@ -1347,14 +1494,18 @@ class Client extends openapi_core_1.default {
|
|
|
1347
1494
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIndexDocumentResponse({}));
|
|
1348
1495
|
}
|
|
1349
1496
|
/**
|
|
1350
|
-
*
|
|
1497
|
+
* Permanently deletes files from a specified knowledge base.
|
|
1351
1498
|
*
|
|
1352
1499
|
* @remarks
|
|
1353
|
-
*
|
|
1354
|
-
*
|
|
1355
|
-
*
|
|
1356
|
-
*
|
|
1357
|
-
*
|
|
1500
|
+
* - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
|
|
1501
|
+
* - 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:DeleteIndexDocument permission), before calling this operation. Alibaba Cloud accounts can call 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 call this operation.
|
|
1502
|
+
* - Before calling 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).
|
|
1503
|
+
* - You can only delete files whose status is import failed (INSERT_ERROR) or import succeeded (FINISH) in the knowledge base. To query the file status in a specified knowledge base, call the **ListIndexDocuments** operation.
|
|
1504
|
+
* - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
|
|
1505
|
+
* - Calling this operation does not delete documents that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
|
|
1506
|
+
* - This operation is idempotent.
|
|
1507
|
+
* **Throttling:**
|
|
1508
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1358
1509
|
*
|
|
1359
1510
|
* @param request - DeleteIndexDocumentRequest
|
|
1360
1511
|
* @returns DeleteIndexDocumentResponse
|
|
@@ -1365,7 +1516,13 @@ class Client extends openapi_core_1.default {
|
|
|
1365
1516
|
return await this.deleteIndexDocumentWithOptions(WorkspaceId, request, headers, runtime);
|
|
1366
1517
|
}
|
|
1367
1518
|
/**
|
|
1368
|
-
*
|
|
1519
|
+
* Permanently deletes a specified long-term memory.
|
|
1520
|
+
*
|
|
1521
|
+
* @remarks
|
|
1522
|
+
* - Before calling this operation, make sure that your long-term memory has been created and has not been deleted (that is, the memoryId is valid).
|
|
1523
|
+
* - The delete operation is irreversible. The deleted long-term memory, including all of its long-term memory nodes, cannot be recovered. The [GetMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getmemory) operation will no longer be able to retrieve its information. Proceed with caution.
|
|
1524
|
+
* - This operation is idempotent.
|
|
1525
|
+
* **Rate limit:** Make sure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
1369
1526
|
*
|
|
1370
1527
|
* @param request - DeleteMemoryRequest
|
|
1371
1528
|
* @param headers - map
|
|
@@ -1391,7 +1548,13 @@ class Client extends openapi_core_1.default {
|
|
|
1391
1548
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteMemoryResponse({}));
|
|
1392
1549
|
}
|
|
1393
1550
|
/**
|
|
1394
|
-
*
|
|
1551
|
+
* Permanently deletes a specified long-term memory.
|
|
1552
|
+
*
|
|
1553
|
+
* @remarks
|
|
1554
|
+
* - Before calling this operation, make sure that your long-term memory has been created and has not been deleted (that is, the memoryId is valid).
|
|
1555
|
+
* - The delete operation is irreversible. The deleted long-term memory, including all of its long-term memory nodes, cannot be recovered. The [GetMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getmemory) operation will no longer be able to retrieve its information. Proceed with caution.
|
|
1556
|
+
* - This operation is idempotent.
|
|
1557
|
+
* **Rate limit:** Make sure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
1395
1558
|
*
|
|
1396
1559
|
* @param request - DeleteMemoryRequest
|
|
1397
1560
|
* @returns DeleteMemoryResponse
|
|
@@ -1402,7 +1565,7 @@ class Client extends openapi_core_1.default {
|
|
|
1402
1565
|
return await this.deleteMemoryWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
1403
1566
|
}
|
|
1404
1567
|
/**
|
|
1405
|
-
*
|
|
1568
|
+
* Deletes a memory fragment.
|
|
1406
1569
|
*
|
|
1407
1570
|
* @param request - DeleteMemoryNodeRequest
|
|
1408
1571
|
* @param headers - map
|
|
@@ -1428,7 +1591,7 @@ class Client extends openapi_core_1.default {
|
|
|
1428
1591
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteMemoryNodeResponse({}));
|
|
1429
1592
|
}
|
|
1430
1593
|
/**
|
|
1431
|
-
*
|
|
1594
|
+
* Deletes a memory fragment.
|
|
1432
1595
|
*
|
|
1433
1596
|
* @param request - DeleteMemoryNodeRequest
|
|
1434
1597
|
* @returns DeleteMemoryNodeResponse
|
|
@@ -1476,13 +1639,13 @@ class Client extends openapi_core_1.default {
|
|
|
1476
1639
|
return await this.deletePromptTemplateWithOptions(workspaceId, promptTemplateId, request, headers, runtime);
|
|
1477
1640
|
}
|
|
1478
1641
|
/**
|
|
1479
|
-
*
|
|
1642
|
+
* Queries the basic information about a file in application data, including the file name, type, and status.
|
|
1480
1643
|
*
|
|
1481
1644
|
* @remarks
|
|
1482
|
-
*
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1485
|
-
*
|
|
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. Invoke 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).
|
|
1646
|
+
* - This operation is idempotent.
|
|
1647
|
+
* **Rate limit:**
|
|
1648
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1486
1649
|
*
|
|
1487
1650
|
* @param request - DescribeFileRequest
|
|
1488
1651
|
* @param headers - map
|
|
@@ -1508,13 +1671,13 @@ class Client extends openapi_core_1.default {
|
|
|
1508
1671
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeFileResponse({}));
|
|
1509
1672
|
}
|
|
1510
1673
|
/**
|
|
1511
|
-
*
|
|
1674
|
+
* Queries the basic information about a file in application data, including the file name, type, and status.
|
|
1512
1675
|
*
|
|
1513
1676
|
* @remarks
|
|
1514
|
-
*
|
|
1515
|
-
*
|
|
1516
|
-
*
|
|
1517
|
-
*
|
|
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. Invoke 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).
|
|
1678
|
+
* - This operation is idempotent.
|
|
1679
|
+
* **Rate limit:**
|
|
1680
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1518
1681
|
*
|
|
1519
1682
|
* @param request - DescribeFileRequest
|
|
1520
1683
|
* @returns DescribeFileResponse
|
|
@@ -1525,7 +1688,7 @@ class Client extends openapi_core_1.default {
|
|
|
1525
1688
|
return await this.describeFileWithOptions(WorkspaceId, FileId, request, headers, runtime);
|
|
1526
1689
|
}
|
|
1527
1690
|
/**
|
|
1528
|
-
*
|
|
1691
|
+
* Queries the tipping status of the Alipay wallet bound to an application.
|
|
1529
1692
|
*
|
|
1530
1693
|
* @param request - GetAlipayTransferStatusRequest
|
|
1531
1694
|
* @param headers - map
|
|
@@ -1559,7 +1722,7 @@ class Client extends openapi_core_1.default {
|
|
|
1559
1722
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAlipayTransferStatusResponse({}));
|
|
1560
1723
|
}
|
|
1561
1724
|
/**
|
|
1562
|
-
*
|
|
1725
|
+
* Queries the tipping status of the Alipay wallet bound to an application.
|
|
1563
1726
|
*
|
|
1564
1727
|
* @param request - GetAlipayTransferStatusRequest
|
|
1565
1728
|
* @returns GetAlipayTransferStatusResponse
|
|
@@ -1570,7 +1733,7 @@ class Client extends openapi_core_1.default {
|
|
|
1570
1733
|
return await this.getAlipayTransferStatusWithOptions(request, headers, runtime);
|
|
1571
1734
|
}
|
|
1572
1735
|
/**
|
|
1573
|
-
*
|
|
1736
|
+
* Retrieves the Alipay tipping URL for an application.
|
|
1574
1737
|
*
|
|
1575
1738
|
* @param request - GetAlipayUrlRequest
|
|
1576
1739
|
* @param headers - map
|
|
@@ -1604,7 +1767,7 @@ class Client extends openapi_core_1.default {
|
|
|
1604
1767
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAlipayUrlResponse({}));
|
|
1605
1768
|
}
|
|
1606
1769
|
/**
|
|
1607
|
-
*
|
|
1770
|
+
* Retrieves the Alipay tipping URL for an application.
|
|
1608
1771
|
*
|
|
1609
1772
|
* @param request - GetAlipayUrlRequest
|
|
1610
1773
|
* @returns GetAlipayUrlResponse
|
|
@@ -1617,6 +1780,12 @@ class Client extends openapi_core_1.default {
|
|
|
1617
1780
|
/**
|
|
1618
1781
|
* Lists all supported parser types based on the input file type (file extension).
|
|
1619
1782
|
*
|
|
1783
|
+
* @remarks
|
|
1784
|
+
* - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetAvailableParserTypes权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
|
|
1785
|
+
* - 本接口具有幂等性。
|
|
1786
|
+
* **限流说明:**
|
|
1787
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
1788
|
+
*
|
|
1620
1789
|
* @param request - GetAvailableParserTypesRequest
|
|
1621
1790
|
* @param headers - map
|
|
1622
1791
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1648,6 +1817,12 @@ class Client extends openapi_core_1.default {
|
|
|
1648
1817
|
/**
|
|
1649
1818
|
* Lists all supported parser types based on the input file type (file extension).
|
|
1650
1819
|
*
|
|
1820
|
+
* @remarks
|
|
1821
|
+
* - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetAvailableParserTypes权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
|
|
1822
|
+
* - 本接口具有幂等性。
|
|
1823
|
+
* **限流说明:**
|
|
1824
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
1825
|
+
*
|
|
1651
1826
|
* @param request - GetAvailableParserTypesRequest
|
|
1652
1827
|
* @returns GetAvailableParserTypesResponse
|
|
1653
1828
|
*/
|
|
@@ -1657,7 +1832,13 @@ class Client extends openapi_core_1.default {
|
|
|
1657
1832
|
return await this.getAvailableParserTypesWithOptions(WorkspaceId, request, headers, runtime);
|
|
1658
1833
|
}
|
|
1659
1834
|
/**
|
|
1660
|
-
*
|
|
1835
|
+
* Retrieves details about a connector. This operation currently supports only file connectors.
|
|
1836
|
+
*
|
|
1837
|
+
* @remarks
|
|
1838
|
+
* - To call this operation, a RAM user (sub-account) must have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and must [join a business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:GetConnector permission. An Alibaba Cloud account (primary account) can call this operation directly. We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1839
|
+
* - This operation is idempotent.
|
|
1840
|
+
* **Throttling:**
|
|
1841
|
+
* This operation is subject to throttling. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
|
|
1661
1842
|
*
|
|
1662
1843
|
* @param request - GetConnectorRequest
|
|
1663
1844
|
* @param headers - map
|
|
@@ -1691,7 +1872,13 @@ class Client extends openapi_core_1.default {
|
|
|
1691
1872
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetConnectorResponse({}));
|
|
1692
1873
|
}
|
|
1693
1874
|
/**
|
|
1694
|
-
*
|
|
1875
|
+
* Retrieves details about a connector. This operation currently supports only file connectors.
|
|
1876
|
+
*
|
|
1877
|
+
* @remarks
|
|
1878
|
+
* - To call this operation, a RAM user (sub-account) must have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and must [join a business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:GetConnector permission. An Alibaba Cloud account (primary account) can call this operation directly. We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1879
|
+
* - This operation is idempotent.
|
|
1880
|
+
* **Throttling:**
|
|
1881
|
+
* This operation is subject to throttling. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
|
|
1695
1882
|
*
|
|
1696
1883
|
* @param request - GetConnectorRequest
|
|
1697
1884
|
* @returns GetConnectorResponse
|
|
@@ -1702,12 +1889,13 @@ class Client extends openapi_core_1.default {
|
|
|
1702
1889
|
return await this.getConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
1703
1890
|
}
|
|
1704
1891
|
/**
|
|
1705
|
-
* Queries the current status of a specified knowledge base creation or
|
|
1892
|
+
* Queries the current status of a specified knowledge base creation job or knowledge base document append job.
|
|
1706
1893
|
*
|
|
1707
1894
|
* @remarks
|
|
1708
|
-
*
|
|
1709
|
-
*
|
|
1710
|
-
*
|
|
1895
|
+
* - 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 task in progress. To create a knowledge base creation task, invoke the **SubmitIndexJob** operation. To create a knowledge base document append task, invoke the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId` from the response.
|
|
1897
|
+
* - Invoke this operation at intervals of 5 seconds or more.
|
|
1898
|
+
* - This operation is idempotent.
|
|
1711
1899
|
*
|
|
1712
1900
|
* @param request - GetIndexJobStatusRequest
|
|
1713
1901
|
* @param headers - map
|
|
@@ -1747,12 +1935,13 @@ class Client extends openapi_core_1.default {
|
|
|
1747
1935
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexJobStatusResponse({}));
|
|
1748
1936
|
}
|
|
1749
1937
|
/**
|
|
1750
|
-
* Queries the current status of a specified knowledge base creation or
|
|
1938
|
+
* Queries the current status of a specified knowledge base creation job or knowledge base document append job.
|
|
1751
1939
|
*
|
|
1752
1940
|
* @remarks
|
|
1753
|
-
*
|
|
1754
|
-
*
|
|
1755
|
-
*
|
|
1941
|
+
* - 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 task in progress. To create a knowledge base creation task, invoke the **SubmitIndexJob** operation. To create a knowledge base document append task, invoke the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId` from the response.
|
|
1943
|
+
* - Invoke this operation at intervals of 5 seconds or more.
|
|
1944
|
+
* - This operation is idempotent.
|
|
1756
1945
|
*
|
|
1757
1946
|
* @param request - GetIndexJobStatusRequest
|
|
1758
1947
|
* @returns GetIndexJobStatusResponse
|
|
@@ -1763,7 +1952,13 @@ class Client extends openapi_core_1.default {
|
|
|
1763
1952
|
return await this.getIndexJobStatusWithOptions(WorkspaceId, request, headers, runtime);
|
|
1764
1953
|
}
|
|
1765
1954
|
/**
|
|
1766
|
-
*
|
|
1955
|
+
* You can call the GetIndexMonitor operation to query monitoring data for a specified knowledge base within a specific time range. This data is crucial for App Performance Analytics, capacity planning, and cost management. The monitoring data includes two main dimensions: storage and retrieval. Storage monitoring retrieves the index storage limit and current usage of the knowledge base. Retrieval monitoring retrieves performance metrics for the query period, such as peak queries per second (QPS), total requests, and average QPS. The metrics are provided as totals and are also broken down by time window. The requests are categorized as successful, failed, and rate-limited.
|
|
1956
|
+
*
|
|
1957
|
+
* @remarks
|
|
1958
|
+
* <props="intl">
|
|
1959
|
+
* This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
|
|
1960
|
+
* <props="china">
|
|
1961
|
+
* - Before you call this operation, a RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (which requires the `AliyunBailianDataFullAccess` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). Alibaba Cloud accounts can call this operation directly without authorization. You can call this operation using the latest version of the [Alibaba Cloud Model Studio software development kit (SDK)](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29). Before you call this operation, make sure that the specified knowledge base has been created and has not been deleted. This means that the knowledge base ID (`IndexId`) must be valid. This operation is idempotent. The maximum query time range (EndTimestamp - StartTimestamp) is 30 days. The granularity of the time window in the returned data is dynamically adjusted based on the query time range.
|
|
1767
1962
|
*
|
|
1768
1963
|
* @param request - GetIndexMonitorRequest
|
|
1769
1964
|
* @param headers - map
|
|
@@ -1800,7 +1995,13 @@ class Client extends openapi_core_1.default {
|
|
|
1800
1995
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexMonitorResponse({}));
|
|
1801
1996
|
}
|
|
1802
1997
|
/**
|
|
1803
|
-
*
|
|
1998
|
+
* You can call the GetIndexMonitor operation to query monitoring data for a specified knowledge base within a specific time range. This data is crucial for App Performance Analytics, capacity planning, and cost management. The monitoring data includes two main dimensions: storage and retrieval. Storage monitoring retrieves the index storage limit and current usage of the knowledge base. Retrieval monitoring retrieves performance metrics for the query period, such as peak queries per second (QPS), total requests, and average QPS. The metrics are provided as totals and are also broken down by time window. The requests are categorized as successful, failed, and rate-limited.
|
|
1999
|
+
*
|
|
2000
|
+
* @remarks
|
|
2001
|
+
* <props="intl">
|
|
2002
|
+
* This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
|
|
2003
|
+
* <props="china">
|
|
2004
|
+
* - Before you call this operation, a RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (which requires the `AliyunBailianDataFullAccess` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). Alibaba Cloud accounts can call this operation directly without authorization. You can call this operation using the latest version of the [Alibaba Cloud Model Studio software development kit (SDK)](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29). Before you call this operation, make sure that the specified knowledge base has been created and has not been deleted. This means that the knowledge base ID (`IndexId`) must be valid. This operation is idempotent. The maximum query time range (EndTimestamp - StartTimestamp) is 30 days. The granularity of the time window in the returned data is dynamically adjusted based on the query time range.
|
|
1804
2005
|
*
|
|
1805
2006
|
* @param request - GetIndexMonitorRequest
|
|
1806
2007
|
* @returns GetIndexMonitorResponse
|
|
@@ -1811,7 +2012,11 @@ class Client extends openapi_core_1.default {
|
|
|
1811
2012
|
return await this.getIndexMonitorWithOptions(WorkspaceId, request, headers, runtime);
|
|
1812
2013
|
}
|
|
1813
2014
|
/**
|
|
1814
|
-
*
|
|
2015
|
+
* Retrieves the description of a specified long-term memory.
|
|
2016
|
+
*
|
|
2017
|
+
* @remarks
|
|
2018
|
+
* - This operation is idempotent.
|
|
2019
|
+
* **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
1815
2020
|
*
|
|
1816
2021
|
* @param request - GetMemoryRequest
|
|
1817
2022
|
* @param headers - map
|
|
@@ -1837,7 +2042,11 @@ class Client extends openapi_core_1.default {
|
|
|
1837
2042
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetMemoryResponse({}));
|
|
1838
2043
|
}
|
|
1839
2044
|
/**
|
|
1840
|
-
*
|
|
2045
|
+
* Retrieves the description of a specified long-term memory.
|
|
2046
|
+
*
|
|
2047
|
+
* @remarks
|
|
2048
|
+
* - This operation is idempotent.
|
|
2049
|
+
* **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
1841
2050
|
*
|
|
1842
2051
|
* @param request - GetMemoryRequest
|
|
1843
2052
|
* @returns GetMemoryResponse
|
|
@@ -1848,7 +2057,7 @@ class Client extends openapi_core_1.default {
|
|
|
1848
2057
|
return await this.getMemoryWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
1849
2058
|
}
|
|
1850
2059
|
/**
|
|
1851
|
-
*
|
|
2060
|
+
* Retrieves a memory fragment.
|
|
1852
2061
|
*
|
|
1853
2062
|
* @param request - GetMemoryNodeRequest
|
|
1854
2063
|
* @param headers - map
|
|
@@ -1874,7 +2083,7 @@ class Client extends openapi_core_1.default {
|
|
|
1874
2083
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetMemoryNodeResponse({}));
|
|
1875
2084
|
}
|
|
1876
2085
|
/**
|
|
1877
|
-
*
|
|
2086
|
+
* Retrieves a memory fragment.
|
|
1878
2087
|
*
|
|
1879
2088
|
* @param request - GetMemoryNodeRequest
|
|
1880
2089
|
* @returns GetMemoryNodeResponse
|
|
@@ -1887,6 +2096,12 @@ class Client extends openapi_core_1.default {
|
|
|
1887
2096
|
/**
|
|
1888
2097
|
* Queries the data parsing settings in a specified category.
|
|
1889
2098
|
*
|
|
2099
|
+
* @remarks
|
|
2100
|
+
* - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetParseSettings权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
|
|
2101
|
+
* - 本接口具有幂等性。
|
|
2102
|
+
* **限流说明:**
|
|
2103
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
2104
|
+
*
|
|
1890
2105
|
* @param request - GetParseSettingsRequest
|
|
1891
2106
|
* @param headers - map
|
|
1892
2107
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1918,6 +2133,12 @@ class Client extends openapi_core_1.default {
|
|
|
1918
2133
|
/**
|
|
1919
2134
|
* Queries the data parsing settings in a specified category.
|
|
1920
2135
|
*
|
|
2136
|
+
* @remarks
|
|
2137
|
+
* - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetParseSettings权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
|
|
2138
|
+
* - 本接口具有幂等性。
|
|
2139
|
+
* **限流说明:**
|
|
2140
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
2141
|
+
*
|
|
1921
2142
|
* @param request - GetParseSettingsRequest
|
|
1922
2143
|
* @returns GetParseSettingsResponse
|
|
1923
2144
|
*/
|
|
@@ -2058,7 +2279,14 @@ class Client extends openapi_core_1.default {
|
|
|
2058
2279
|
return await this.highCodeDeployWithOptions(workspaceId, request, headers, runtime);
|
|
2059
2280
|
}
|
|
2060
2281
|
/**
|
|
2061
|
-
*
|
|
2282
|
+
* Retrieves the details of one or more categories in a specified workspace.
|
|
2283
|
+
*
|
|
2284
|
+
* @remarks
|
|
2285
|
+
* - This API does not support querying data tables.
|
|
2286
|
+
* - To call this API, a RAM user must first obtain the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` permission, which includes the `sfm:ListCategory` permission. Alibaba Cloud accounts can call this API directly. Use the latest version of the <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).
|
|
2287
|
+
* - This operation supports pagination. When making your first request, set the `MaxResults` parameter to specify the maximum number of items to return. If more items are available, the response includes a `NextToken`. To retrieve the next page of results, set the `NextToken` parameter to the value from the previous response and specify `MaxResults` again. An empty `NextToken` indicates that no more results are available.
|
|
2288
|
+
* - This operation is idempotent.
|
|
2289
|
+
* **Rate limiting:** This API is subject to rate limiting. Do not exceed 5 requests per second. If the system throttles a request, retry it after a short interval.
|
|
2062
2290
|
*
|
|
2063
2291
|
* @param request - ListCategoryRequest
|
|
2064
2292
|
* @param headers - map
|
|
@@ -2104,7 +2332,14 @@ class Client extends openapi_core_1.default {
|
|
|
2104
2332
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListCategoryResponse({}));
|
|
2105
2333
|
}
|
|
2106
2334
|
/**
|
|
2107
|
-
*
|
|
2335
|
+
* Retrieves the details of one or more categories in a specified workspace.
|
|
2336
|
+
*
|
|
2337
|
+
* @remarks
|
|
2338
|
+
* - This API does not support querying data tables.
|
|
2339
|
+
* - To call this API, a RAM user must first obtain the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` permission, which includes the `sfm:ListCategory` permission. Alibaba Cloud accounts can call this API directly. Use the latest version of the <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).
|
|
2340
|
+
* - This operation supports pagination. When making your first request, set the `MaxResults` parameter to specify the maximum number of items to return. If more items are available, the response includes a `NextToken`. To retrieve the next page of results, set the `NextToken` parameter to the value from the previous response and specify `MaxResults` again. An empty `NextToken` indicates that no more results are available.
|
|
2341
|
+
* - This operation is idempotent.
|
|
2342
|
+
* **Rate limiting:** This API is subject to rate limiting. Do not exceed 5 requests per second. If the system throttles a request, retry it after a short interval.
|
|
2108
2343
|
*
|
|
2109
2344
|
* @param request - ListCategoryRequest
|
|
2110
2345
|
* @returns ListCategoryResponse
|
|
@@ -2115,11 +2350,15 @@ class Client extends openapi_core_1.default {
|
|
|
2115
2350
|
return await this.listCategoryWithOptions(WorkspaceId, request, headers, runtime);
|
|
2116
2351
|
}
|
|
2117
2352
|
/**
|
|
2118
|
-
*
|
|
2353
|
+
* Queries the list and information of text chunks.
|
|
2119
2354
|
*
|
|
2120
2355
|
* @remarks
|
|
2121
|
-
*
|
|
2122
|
-
*
|
|
2356
|
+
* - For document search<props="china"> or audio/video search knowledge bases, this operation queries all chunks of a specified file. For data query or image Q&A knowledge bases, this operation retrieves information about all text chunks.
|
|
2357
|
+
* - 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: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 <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.
|
|
2358
|
+
* - 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).
|
|
2359
|
+
* - This operation has idempotence.
|
|
2360
|
+
* **Rate limit:**
|
|
2361
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2123
2362
|
*
|
|
2124
2363
|
* @param request - ListChunksRequest
|
|
2125
2364
|
* @param headers - map
|
|
@@ -2165,11 +2404,15 @@ class Client extends openapi_core_1.default {
|
|
|
2165
2404
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListChunksResponse({}));
|
|
2166
2405
|
}
|
|
2167
2406
|
/**
|
|
2168
|
-
*
|
|
2407
|
+
* Queries the list and information of text chunks.
|
|
2169
2408
|
*
|
|
2170
2409
|
* @remarks
|
|
2171
|
-
*
|
|
2172
|
-
*
|
|
2410
|
+
* - For document search<props="china"> or audio/video search knowledge bases, this operation queries all chunks of a specified file. For data query or image Q&A knowledge bases, this operation retrieves information about all text chunks.
|
|
2411
|
+
* - 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: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 <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.
|
|
2412
|
+
* - 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).
|
|
2413
|
+
* - This operation has idempotence.
|
|
2414
|
+
* **Rate limit:**
|
|
2415
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2173
2416
|
*
|
|
2174
2417
|
* @param request - ListChunksRequest
|
|
2175
2418
|
* @returns ListChunksResponse
|
|
@@ -2180,13 +2423,14 @@ class Client extends openapi_core_1.default {
|
|
|
2180
2423
|
return await this.listChunksWithOptions(WorkspaceId, request, headers, runtime);
|
|
2181
2424
|
}
|
|
2182
2425
|
/**
|
|
2183
|
-
*
|
|
2426
|
+
* Retrieves the details of one or more documents in a specified category.
|
|
2184
2427
|
*
|
|
2185
2428
|
* @remarks
|
|
2186
|
-
*
|
|
2187
|
-
*
|
|
2188
|
-
*
|
|
2189
|
-
* **
|
|
2429
|
+
* - 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
|
+
* - When performing paging for 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 as the query credential (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
|
+
* - This operation is idempotent.
|
|
2432
|
+
* **Rate limit:**
|
|
2433
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
2190
2434
|
*
|
|
2191
2435
|
* @param tmpReq - ListFileRequest
|
|
2192
2436
|
* @param headers - map
|
|
@@ -2234,13 +2478,14 @@ class Client extends openapi_core_1.default {
|
|
|
2234
2478
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListFileResponse({}));
|
|
2235
2479
|
}
|
|
2236
2480
|
/**
|
|
2237
|
-
*
|
|
2481
|
+
* Retrieves the details of one or more documents in a specified category.
|
|
2238
2482
|
*
|
|
2239
2483
|
* @remarks
|
|
2240
|
-
*
|
|
2241
|
-
*
|
|
2242
|
-
*
|
|
2243
|
-
* **
|
|
2484
|
+
* - 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
|
+
* - When performing paging for 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 as the query credential (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
|
+
* - This operation is idempotent.
|
|
2487
|
+
* **Rate limit:**
|
|
2488
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
2244
2489
|
*
|
|
2245
2490
|
* @param request - ListFileRequest
|
|
2246
2491
|
* @returns ListFileResponse
|
|
@@ -2251,11 +2496,14 @@ class Client extends openapi_core_1.default {
|
|
|
2251
2496
|
return await this.listFileWithOptions(WorkspaceId, request, headers, runtime);
|
|
2252
2497
|
}
|
|
2253
2498
|
/**
|
|
2254
|
-
*
|
|
2499
|
+
* Retrieves the files in a specified knowledge base along with their summary information.
|
|
2255
2500
|
*
|
|
2256
2501
|
* @remarks
|
|
2257
|
-
*
|
|
2258
|
-
*
|
|
2502
|
+
* - 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: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
|
+
* - 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
|
+
* - This operation has idempotence.
|
|
2505
|
+
* **Throttling:**
|
|
2506
|
+
* This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
2259
2507
|
*
|
|
2260
2508
|
* @param request - ListIndexDocumentsRequest
|
|
2261
2509
|
* @param headers - map
|
|
@@ -2301,11 +2549,14 @@ class Client extends openapi_core_1.default {
|
|
|
2301
2549
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexDocumentsResponse({}));
|
|
2302
2550
|
}
|
|
2303
2551
|
/**
|
|
2304
|
-
*
|
|
2552
|
+
* Retrieves the files in a specified knowledge base along with their summary information.
|
|
2305
2553
|
*
|
|
2306
2554
|
* @remarks
|
|
2307
|
-
*
|
|
2308
|
-
*
|
|
2555
|
+
* - 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: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
|
+
* - 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
|
+
* - This operation has idempotence.
|
|
2558
|
+
* **Throttling:**
|
|
2559
|
+
* This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
2309
2560
|
*
|
|
2310
2561
|
* @param request - ListIndexDocumentsRequest
|
|
2311
2562
|
* @returns ListIndexDocumentsResponse
|
|
@@ -2316,7 +2567,12 @@ class Client extends openapi_core_1.default {
|
|
|
2316
2567
|
return await this.listIndexDocumentsWithOptions(WorkspaceId, request, headers, runtime);
|
|
2317
2568
|
}
|
|
2318
2569
|
/**
|
|
2319
|
-
*
|
|
2570
|
+
* Retrieves the details of one or more documents in a specified knowledge base.
|
|
2571
|
+
*
|
|
2572
|
+
* @remarks
|
|
2573
|
+
* - A RAM user must have the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio to call this operation. The `AliyunBailianDataFullAccess` permission, which includes the \\`sfm:ListIndexFiles\\` permission, is required. An Alibaba Cloud account can call this operation without authorization. You can call this operation using the latest version of the <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).
|
|
2574
|
+
* - Before you call this operation, ensure that your knowledge base exists and its ID, `IndexId`, is valid.
|
|
2575
|
+
* - This operation is idempotent.
|
|
2320
2576
|
*
|
|
2321
2577
|
* @param request - ListIndexFileDetailsRequest
|
|
2322
2578
|
* @param headers - map
|
|
@@ -2362,7 +2618,12 @@ class Client extends openapi_core_1.default {
|
|
|
2362
2618
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexFileDetailsResponse({}));
|
|
2363
2619
|
}
|
|
2364
2620
|
/**
|
|
2365
|
-
*
|
|
2621
|
+
* Retrieves the details of one or more documents in a specified knowledge base.
|
|
2622
|
+
*
|
|
2623
|
+
* @remarks
|
|
2624
|
+
* - A RAM user must have the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio to call this operation. The `AliyunBailianDataFullAccess` permission, which includes the \\`sfm:ListIndexFiles\\` permission, is required. An Alibaba Cloud account can call this operation without authorization. You can call this operation using the latest version of the <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).
|
|
2625
|
+
* - Before you call this operation, ensure that your knowledge base exists and its ID, `IndexId`, is valid.
|
|
2626
|
+
* - This operation is idempotent.
|
|
2366
2627
|
*
|
|
2367
2628
|
* @param request - ListIndexFileDetailsRequest
|
|
2368
2629
|
* @returns ListIndexFileDetailsResponse
|
|
@@ -2373,10 +2634,13 @@ class Client extends openapi_core_1.default {
|
|
|
2373
2634
|
return await this.listIndexFileDetailsWithOptions(WorkspaceId, request, headers, runtime);
|
|
2374
2635
|
}
|
|
2375
2636
|
/**
|
|
2376
|
-
*
|
|
2637
|
+
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2377
2638
|
*
|
|
2378
2639
|
* @remarks
|
|
2379
|
-
*
|
|
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:ListIndex permission) 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.
|
|
2641
|
+
* - This operation is idempotent.
|
|
2642
|
+
* **Rate limit:**
|
|
2643
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2380
2644
|
*
|
|
2381
2645
|
* @param request - ListIndicesRequest
|
|
2382
2646
|
* @param headers - map
|
|
@@ -2413,10 +2677,13 @@ class Client extends openapi_core_1.default {
|
|
|
2413
2677
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndicesResponse({}));
|
|
2414
2678
|
}
|
|
2415
2679
|
/**
|
|
2416
|
-
*
|
|
2680
|
+
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2417
2681
|
*
|
|
2418
2682
|
* @remarks
|
|
2419
|
-
*
|
|
2683
|
+
* - 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) 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.
|
|
2684
|
+
* - This operation is idempotent.
|
|
2685
|
+
* **Rate limit:**
|
|
2686
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2420
2687
|
*
|
|
2421
2688
|
* @param request - ListIndicesRequest
|
|
2422
2689
|
* @returns ListIndicesResponse
|
|
@@ -2427,7 +2694,12 @@ class Client extends openapi_core_1.default {
|
|
|
2427
2694
|
return await this.listIndicesWithOptions(WorkspaceId, request, headers, runtime);
|
|
2428
2695
|
}
|
|
2429
2696
|
/**
|
|
2430
|
-
*
|
|
2697
|
+
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
2698
|
+
*
|
|
2699
|
+
* @remarks
|
|
2700
|
+
* - When querying the first page of a paging query, set only `MaxResults` to limit the number of entries returned. The `NextToken` value 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 as the query credential (if `NextToken` is empty, all results have been returned and no further requests are needed), and settings `MaxResults` to limit the number of entries returned.
|
|
2701
|
+
* - This operation supports idempotence.
|
|
2702
|
+
* **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
2431
2703
|
*
|
|
2432
2704
|
* @param request - ListMemoriesRequest
|
|
2433
2705
|
* @param headers - map
|
|
@@ -2461,7 +2733,12 @@ class Client extends openapi_core_1.default {
|
|
|
2461
2733
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemoriesResponse({}));
|
|
2462
2734
|
}
|
|
2463
2735
|
/**
|
|
2464
|
-
*
|
|
2736
|
+
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
2737
|
+
*
|
|
2738
|
+
* @remarks
|
|
2739
|
+
* - When querying the first page of a paging query, set only `MaxResults` to limit the number of entries returned. The `NextToken` value 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 as the query credential (if `NextToken` is empty, all results have been returned and no further requests are needed), and settings `MaxResults` to limit the number of entries returned.
|
|
2740
|
+
* - This operation supports idempotence.
|
|
2741
|
+
* **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
2465
2742
|
*
|
|
2466
2743
|
* @param request - ListMemoriesRequest
|
|
2467
2744
|
* @returns ListMemoriesResponse
|
|
@@ -2472,7 +2749,7 @@ class Client extends openapi_core_1.default {
|
|
|
2472
2749
|
return await this.listMemoriesWithOptions(workspaceId, request, headers, runtime);
|
|
2473
2750
|
}
|
|
2474
2751
|
/**
|
|
2475
|
-
*
|
|
2752
|
+
* Retrieves a list of memory nodes.
|
|
2476
2753
|
*
|
|
2477
2754
|
* @param request - ListMemoryNodesRequest
|
|
2478
2755
|
* @param headers - map
|
|
@@ -2506,7 +2783,7 @@ class Client extends openapi_core_1.default {
|
|
|
2506
2783
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemoryNodesResponse({}));
|
|
2507
2784
|
}
|
|
2508
2785
|
/**
|
|
2509
|
-
*
|
|
2786
|
+
* Retrieves a list of memory nodes.
|
|
2510
2787
|
*
|
|
2511
2788
|
* @param request - ListMemoryNodesRequest
|
|
2512
2789
|
* @returns ListMemoryNodesResponse
|
|
@@ -2613,12 +2890,23 @@ class Client extends openapi_core_1.default {
|
|
|
2613
2890
|
return await this.listPublishedAgentWithOptions(workspaceId, request, headers, runtime);
|
|
2614
2891
|
}
|
|
2615
2892
|
/**
|
|
2616
|
-
*
|
|
2893
|
+
* Retrieves information from a specified knowledge base.
|
|
2617
2894
|
*
|
|
2618
2895
|
* @remarks
|
|
2619
|
-
*
|
|
2620
|
-
*
|
|
2621
|
-
*
|
|
2896
|
+
* <props="china">
|
|
2897
|
+
* - **How to call**: To retrieve information from a knowledge base, use the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) with an [AccessKey](https://help.aliyun.com/document_detail/116401.html) or [Spring AI Alibaba](https://help.aliyun.com/document_detail/2990886.html) with an Alibaba Cloud Model Studio [API key](https://help.aliyun.com/document_detail/2712195.html). Both tools simplify your API calls by handling the complex signature calculation.
|
|
2898
|
+
* - **Required permissions**:
|
|
2899
|
+
* - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
|
|
2900
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
2901
|
+
* - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
|
|
2902
|
+
* - **Idempotency**: This API is idempotent.
|
|
2903
|
+
* <props="intl">
|
|
2904
|
+
* - **How to call**: We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API. The SDK simplifies API calls by handling the complex signature calculation.
|
|
2905
|
+
* - **Required permissions**:
|
|
2906
|
+
* - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
|
|
2907
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
2908
|
+
* - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
|
|
2909
|
+
* - **Idempotency**: This API is idempotent.
|
|
2622
2910
|
*
|
|
2623
2911
|
* @param tmpReq - RetrieveRequest
|
|
2624
2912
|
* @param headers - map
|
|
@@ -2711,12 +2999,23 @@ class Client extends openapi_core_1.default {
|
|
|
2711
2999
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.RetrieveResponse({}));
|
|
2712
3000
|
}
|
|
2713
3001
|
/**
|
|
2714
|
-
*
|
|
3002
|
+
* Retrieves information from a specified knowledge base.
|
|
2715
3003
|
*
|
|
2716
3004
|
* @remarks
|
|
2717
|
-
*
|
|
2718
|
-
*
|
|
2719
|
-
*
|
|
3005
|
+
* <props="china">
|
|
3006
|
+
* - **How to call**: To retrieve information from a knowledge base, use the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) with an [AccessKey](https://help.aliyun.com/document_detail/116401.html) or [Spring AI Alibaba](https://help.aliyun.com/document_detail/2990886.html) with an Alibaba Cloud Model Studio [API key](https://help.aliyun.com/document_detail/2712195.html). Both tools simplify your API calls by handling the complex signature calculation.
|
|
3007
|
+
* - **Required permissions**:
|
|
3008
|
+
* - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
|
|
3009
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
3010
|
+
* - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
|
|
3011
|
+
* - **Idempotency**: This API is idempotent.
|
|
3012
|
+
* <props="intl">
|
|
3013
|
+
* - **How to call**: We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API. The SDK simplifies API calls by handling the complex signature calculation.
|
|
3014
|
+
* - **Required permissions**:
|
|
3015
|
+
* - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
|
|
3016
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
3017
|
+
* - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
|
|
3018
|
+
* - **Idempotency**: This API is idempotent.
|
|
2720
3019
|
*
|
|
2721
3020
|
* @param request - RetrieveRequest
|
|
2722
3021
|
* @returns RetrieveResponse
|
|
@@ -2727,13 +3026,19 @@ class Client extends openapi_core_1.default {
|
|
|
2727
3026
|
return await this.retrieveWithOptions(WorkspaceId, request, headers, runtime);
|
|
2728
3027
|
}
|
|
2729
3028
|
/**
|
|
2730
|
-
* Adds parsed
|
|
3029
|
+
* Adds parsed files to the specified knowledge base.
|
|
2731
3030
|
*
|
|
2732
3031
|
* @remarks
|
|
2733
|
-
*
|
|
2734
|
-
*
|
|
2735
|
-
*
|
|
2736
|
-
*
|
|
3032
|
+
* <props="china">
|
|
3033
|
+
* - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
|
|
3034
|
+
* <props="intl">
|
|
3035
|
+
* - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
|
|
3036
|
+
* - A RAM user (sub-account) can call this API only after being granted the required [api permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (specifically, the `AliyunBailianDataFullAccess` policy, which includes the `sfm:SubmitIndexAddDocumentsJob` permission) and joining a [workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this API directly without authorization. We recommend using the latest version of the <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 API.
|
|
3037
|
+
* - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
|
|
3038
|
+
* - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
|
|
3039
|
+
* - After calling this API, the job runs in the background and may take several hours to complete, especially during peak times. Do not submit duplicate requests until the job is complete. To check the job status, call the **GetIndexJobStatus** API. The `Documents` file list returned by the GetIndexJobStatus API contains all files for the job, which is uniquely identified by the `job_id` you provided. You can check this list to verify whether each file was imported (parsed) successfully. Note that frequent calls to the GetIndexJobStatus API are subject to rate limiting. Do not exceed 20 calls per minute.
|
|
3040
|
+
* - A successful API call indicates the job has been submitted for processing, which takes time. This API is not idempotent, so do not send duplicate requests; doing so will create multiple jobs.
|
|
3041
|
+
* **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
|
|
2737
3042
|
*
|
|
2738
3043
|
* @param tmpReq - SubmitIndexAddDocumentsJobRequest
|
|
2739
3044
|
* @param headers - map
|
|
@@ -2802,13 +3107,19 @@ class Client extends openapi_core_1.default {
|
|
|
2802
3107
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.SubmitIndexAddDocumentsJobResponse({}));
|
|
2803
3108
|
}
|
|
2804
3109
|
/**
|
|
2805
|
-
* Adds parsed
|
|
3110
|
+
* Adds parsed files to the specified knowledge base.
|
|
2806
3111
|
*
|
|
2807
3112
|
* @remarks
|
|
2808
|
-
*
|
|
2809
|
-
*
|
|
2810
|
-
*
|
|
2811
|
-
*
|
|
3113
|
+
* <props="china">
|
|
3114
|
+
* - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
|
|
3115
|
+
* <props="intl">
|
|
3116
|
+
* - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
|
|
3117
|
+
* - A RAM user (sub-account) can call this API only after being granted the required [api permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (specifically, the `AliyunBailianDataFullAccess` policy, which includes the `sfm:SubmitIndexAddDocumentsJob` permission) and joining a [workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this API directly without authorization. We recommend using the latest version of the <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 API.
|
|
3118
|
+
* - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
|
|
3119
|
+
* - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
|
|
3120
|
+
* - After calling this API, the job runs in the background and may take several hours to complete, especially during peak times. Do not submit duplicate requests until the job is complete. To check the job status, call the **GetIndexJobStatus** API. The `Documents` file list returned by the GetIndexJobStatus API contains all files for the job, which is uniquely identified by the `job_id` you provided. You can check this list to verify whether each file was imported (parsed) successfully. Note that frequent calls to the GetIndexJobStatus API are subject to rate limiting. Do not exceed 20 calls per minute.
|
|
3121
|
+
* - A successful API call indicates the job has been submitted for processing, which takes time. This API is not idempotent, so do not send duplicate requests; doing so will create multiple jobs.
|
|
3122
|
+
* **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
|
|
2812
3123
|
*
|
|
2813
3124
|
* @param request - SubmitIndexAddDocumentsJobRequest
|
|
2814
3125
|
* @returns SubmitIndexAddDocumentsJobResponse
|
|
@@ -2819,13 +3130,16 @@ class Client extends openapi_core_1.default {
|
|
|
2819
3130
|
return await this.submitIndexAddDocumentsJobWithOptions(WorkspaceId, request, headers, runtime);
|
|
2820
3131
|
}
|
|
2821
3132
|
/**
|
|
2822
|
-
* Submits a specified CreateIndex
|
|
3133
|
+
* Submits a specified CreateIndex task to complete knowledge base creation.
|
|
2823
3134
|
*
|
|
2824
3135
|
* @remarks
|
|
2825
|
-
*
|
|
2826
|
-
*
|
|
2827
|
-
*
|
|
2828
|
-
*
|
|
3136
|
+
* - 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:SubmitIndexJob 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.
|
|
3137
|
+
* - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
|
|
3138
|
+
* - 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 completes. To query the node execution status, invoke the **GetIndexJobStatus** operation.
|
|
3139
|
+
* - After the knowledge base is created, you can associate it with an agent application<props="china"> or workflow application in the same workspace through <props="china">[Application Management](https://bailian.console.aliyun.com/?tab=app#/app-center)<props="intl">[Application Management](https://modelstudio.console.alibabacloud.com/?tab=app#/app-center) (or pass the `IndexID` through `rag_options` in [Application Calls](https://help.aliyun.com/document_detail/2846132.html)) to supplement your Model Studio application with private knowledge and up-to-date information. You can also choose not to use a Model Studio application and directly query the knowledge base by invoking the **Retrieve** operation.
|
|
3140
|
+
* - This operation does not support idempotence.
|
|
3141
|
+
* **Rate limit:**
|
|
3142
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2829
3143
|
*
|
|
2830
3144
|
* @param request - SubmitIndexJobRequest
|
|
2831
3145
|
* @param headers - map
|
|
@@ -2856,13 +3170,16 @@ class Client extends openapi_core_1.default {
|
|
|
2856
3170
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.SubmitIndexJobResponse({}));
|
|
2857
3171
|
}
|
|
2858
3172
|
/**
|
|
2859
|
-
* Submits a specified CreateIndex
|
|
3173
|
+
* Submits a specified CreateIndex task to complete knowledge base creation.
|
|
2860
3174
|
*
|
|
2861
3175
|
* @remarks
|
|
2862
|
-
*
|
|
2863
|
-
*
|
|
2864
|
-
*
|
|
2865
|
-
*
|
|
3176
|
+
* - 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:SubmitIndexJob 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.
|
|
3177
|
+
* - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
|
|
3178
|
+
* - 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 completes. To query the node execution status, invoke the **GetIndexJobStatus** operation.
|
|
3179
|
+
* - After the knowledge base is created, you can associate it with an agent application<props="china"> or workflow application in the same workspace through <props="china">[Application Management](https://bailian.console.aliyun.com/?tab=app#/app-center)<props="intl">[Application Management](https://modelstudio.console.alibabacloud.com/?tab=app#/app-center) (or pass the `IndexID` through `rag_options` in [Application Calls](https://help.aliyun.com/document_detail/2846132.html)) to supplement your Model Studio application with private knowledge and up-to-date information. You can also choose not to use a Model Studio application and directly query the knowledge base by invoking the **Retrieve** operation.
|
|
3180
|
+
* - This operation does not support idempotence.
|
|
3181
|
+
* **Rate limit:**
|
|
3182
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2866
3183
|
*
|
|
2867
3184
|
* @param request - SubmitIndexJobRequest
|
|
2868
3185
|
* @returns SubmitIndexJobResponse
|
|
@@ -2997,17 +3314,18 @@ class Client extends openapi_core_1.default {
|
|
|
2997
3314
|
return await this.updateAndPublishAgentSelectiveWithOptions(workspaceId, appCode, request, headers, runtime);
|
|
2998
3315
|
}
|
|
2999
3316
|
/**
|
|
3000
|
-
* Modifies the content and title of a specified text chunk in
|
|
3317
|
+
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
3001
3318
|
*
|
|
3002
3319
|
* @remarks
|
|
3003
|
-
*
|
|
3004
|
-
*
|
|
3005
|
-
*
|
|
3006
|
-
*
|
|
3007
|
-
*
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
3010
|
-
* **Rate limit:**
|
|
3320
|
+
* - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
|
|
3321
|
+
* - **Permission requirements**:
|
|
3322
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
3323
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
3324
|
+
* - **Calling method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
3325
|
+
* - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
|
|
3326
|
+
* - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been updated, the operation returns a success response.
|
|
3327
|
+
* **Rate limit:**
|
|
3328
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
3011
3329
|
*
|
|
3012
3330
|
* @param request - UpdateChunkRequest
|
|
3013
3331
|
* @param headers - map
|
|
@@ -3053,17 +3371,18 @@ class Client extends openapi_core_1.default {
|
|
|
3053
3371
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateChunkResponse({}));
|
|
3054
3372
|
}
|
|
3055
3373
|
/**
|
|
3056
|
-
* Modifies the content and title of a specified text chunk in
|
|
3374
|
+
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
3057
3375
|
*
|
|
3058
3376
|
* @remarks
|
|
3059
|
-
*
|
|
3060
|
-
*
|
|
3061
|
-
*
|
|
3062
|
-
*
|
|
3063
|
-
*
|
|
3064
|
-
*
|
|
3065
|
-
*
|
|
3066
|
-
* **Rate limit:**
|
|
3377
|
+
* - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
|
|
3378
|
+
* - **Permission requirements**:
|
|
3379
|
+
* - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
|
|
3380
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
3381
|
+
* - **Calling method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
|
|
3382
|
+
* - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
|
|
3383
|
+
* - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been updated, the operation returns a success response.
|
|
3384
|
+
* **Rate limit:**
|
|
3385
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
3067
3386
|
*
|
|
3068
3387
|
* @param request - UpdateChunkRequest
|
|
3069
3388
|
* @returns UpdateChunkResponse
|
|
@@ -3074,7 +3393,12 @@ class Client extends openapi_core_1.default {
|
|
|
3074
3393
|
return await this.updateChunkWithOptions(WorkspaceId, request, headers, runtime);
|
|
3075
3394
|
}
|
|
3076
3395
|
/**
|
|
3077
|
-
*
|
|
3396
|
+
* Updates a connector.
|
|
3397
|
+
*
|
|
3398
|
+
* @remarks
|
|
3399
|
+
* - A RAM user can call this operation only after they join a workspace and are granted the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (Bailian). The `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateConnector` permission, is required. An Alibaba Cloud account can call this operation directly. Use the latest version of the <props="china">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
3400
|
+
* - This operation is not idempotent.
|
|
3401
|
+
* **Throttling:** If you call this operation too frequently, the system may throttle your requests. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
|
|
3078
3402
|
*
|
|
3079
3403
|
* @param request - UpdateConnectorRequest
|
|
3080
3404
|
* @param headers - map
|
|
@@ -3108,7 +3432,12 @@ class Client extends openapi_core_1.default {
|
|
|
3108
3432
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateConnectorResponse({}));
|
|
3109
3433
|
}
|
|
3110
3434
|
/**
|
|
3111
|
-
*
|
|
3435
|
+
* Updates a connector.
|
|
3436
|
+
*
|
|
3437
|
+
* @remarks
|
|
3438
|
+
* - A RAM user can call this operation only after they join a workspace and are granted the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (Bailian). The `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateConnector` permission, is required. An Alibaba Cloud account can call this operation directly. Use the latest version of the <props="china">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
3439
|
+
* - This operation is not idempotent.
|
|
3440
|
+
* **Throttling:** If you call this operation too frequently, the system may throttle your requests. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
|
|
3112
3441
|
*
|
|
3113
3442
|
* @param request - UpdateConnectorRequest
|
|
3114
3443
|
* @returns UpdateConnectorResponse
|
|
@@ -3119,7 +3448,11 @@ class Client extends openapi_core_1.default {
|
|
|
3119
3448
|
return await this.updateConnectorWithOptions(WorkspaceId, ConnectorId, request, headers, runtime);
|
|
3120
3449
|
}
|
|
3121
3450
|
/**
|
|
3122
|
-
* Updates the tags
|
|
3451
|
+
* Updates the tags for a specified file.
|
|
3452
|
+
*
|
|
3453
|
+
* @remarks
|
|
3454
|
+
* - A RAM User (sub-account) must be granted the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateFileTag` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend using the latest version of the <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.
|
|
3455
|
+
* **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
3123
3456
|
*
|
|
3124
3457
|
* @param tmpReq - UpdateFileTagRequest
|
|
3125
3458
|
* @param headers - map
|
|
@@ -3155,7 +3488,11 @@ class Client extends openapi_core_1.default {
|
|
|
3155
3488
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateFileTagResponse({}));
|
|
3156
3489
|
}
|
|
3157
3490
|
/**
|
|
3158
|
-
* Updates the tags
|
|
3491
|
+
* Updates the tags for a specified file.
|
|
3492
|
+
*
|
|
3493
|
+
* @remarks
|
|
3494
|
+
* - A RAM User (sub-account) must be granted the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateFileTag` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend using the latest version of the <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.
|
|
3495
|
+
* **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
3159
3496
|
*
|
|
3160
3497
|
* @param request - UpdateFileTagRequest
|
|
3161
3498
|
* @returns UpdateFileTagResponse
|
|
@@ -3166,7 +3503,13 @@ class Client extends openapi_core_1.default {
|
|
|
3166
3503
|
return await this.updateFileTagWithOptions(WorkspaceId, FileId, request, headers, runtime);
|
|
3167
3504
|
}
|
|
3168
3505
|
/**
|
|
3169
|
-
*
|
|
3506
|
+
* Updates the configuration of a specified knowledge base.
|
|
3507
|
+
*
|
|
3508
|
+
* @remarks
|
|
3509
|
+
* <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
|
|
3510
|
+
* Before a RAM user can call this operation, the RAM user must have the `AliyunBailianDataFullAccess` permission for Alibaba Cloud Model Studio. For more information, see [Grant permissions](https://help.aliyun.com/document_detail/2848578.html). The RAM user must also be added to a workspace. For more information, see [Add a member to a workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this operation without authorization. Use the latest version of the Alibaba Cloud Model Studio SDK to call this operation. For more information, see [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
3511
|
+
* Before you call this operation, ensure that the knowledge base is created and has not been deleted. The knowledge base ID (`Id`) must be valid.
|
|
3512
|
+
* This operation is idempotent.
|
|
3170
3513
|
*
|
|
3171
3514
|
* @param request - UpdateIndexRequest
|
|
3172
3515
|
* @param headers - map
|
|
@@ -3218,7 +3561,13 @@ class Client extends openapi_core_1.default {
|
|
|
3218
3561
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateIndexResponse({}));
|
|
3219
3562
|
}
|
|
3220
3563
|
/**
|
|
3221
|
-
*
|
|
3564
|
+
* Updates the configuration of a specified knowledge base.
|
|
3565
|
+
*
|
|
3566
|
+
* @remarks
|
|
3567
|
+
* <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
|
|
3568
|
+
* Before a RAM user can call this operation, the RAM user must have the `AliyunBailianDataFullAccess` permission for Alibaba Cloud Model Studio. For more information, see [Grant permissions](https://help.aliyun.com/document_detail/2848578.html). The RAM user must also be added to a workspace. For more information, see [Add a member to a workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this operation without authorization. Use the latest version of the Alibaba Cloud Model Studio SDK to call this operation. For more information, see [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
3569
|
+
* Before you call this operation, ensure that the knowledge base is created and has not been deleted. The knowledge base ID (`Id`) must be valid.
|
|
3570
|
+
* This operation is idempotent.
|
|
3222
3571
|
*
|
|
3223
3572
|
* @param request - UpdateIndexRequest
|
|
3224
3573
|
* @returns UpdateIndexResponse
|
|
@@ -3229,7 +3578,11 @@ class Client extends openapi_core_1.default {
|
|
|
3229
3578
|
return await this.updateIndexWithOptions(WorkspaceId, request, headers, runtime);
|
|
3230
3579
|
}
|
|
3231
3580
|
/**
|
|
3232
|
-
*
|
|
3581
|
+
* Updates the description of a specified long-term memory.
|
|
3582
|
+
*
|
|
3583
|
+
* @remarks
|
|
3584
|
+
* - This operation is idempotent.
|
|
3585
|
+
* **Rate limit:** Ensure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
3233
3586
|
*
|
|
3234
3587
|
* @param request - UpdateMemoryRequest
|
|
3235
3588
|
* @param headers - map
|
|
@@ -3260,7 +3613,11 @@ class Client extends openapi_core_1.default {
|
|
|
3260
3613
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateMemoryResponse({}));
|
|
3261
3614
|
}
|
|
3262
3615
|
/**
|
|
3263
|
-
*
|
|
3616
|
+
* Updates the description of a specified long-term memory.
|
|
3617
|
+
*
|
|
3618
|
+
* @remarks
|
|
3619
|
+
* - This operation is idempotent.
|
|
3620
|
+
* **Rate limit:** Ensure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
3264
3621
|
*
|
|
3265
3622
|
* @param request - UpdateMemoryRequest
|
|
3266
3623
|
* @returns UpdateMemoryResponse
|
|
@@ -3271,7 +3628,7 @@ class Client extends openapi_core_1.default {
|
|
|
3271
3628
|
return await this.updateMemoryWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
3272
3629
|
}
|
|
3273
3630
|
/**
|
|
3274
|
-
*
|
|
3631
|
+
* Updates a memory fragment.
|
|
3275
3632
|
*
|
|
3276
3633
|
* @param request - UpdateMemoryNodeRequest
|
|
3277
3634
|
* @param headers - map
|
|
@@ -3302,7 +3659,7 @@ class Client extends openapi_core_1.default {
|
|
|
3302
3659
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateMemoryNodeResponse({}));
|
|
3303
3660
|
}
|
|
3304
3661
|
/**
|
|
3305
|
-
*
|
|
3662
|
+
* Updates a memory fragment.
|
|
3306
3663
|
*
|
|
3307
3664
|
* @param request - UpdateMemoryNodeRequest
|
|
3308
3665
|
* @returns UpdateMemoryNodeResponse
|
|
@@ -3358,7 +3715,15 @@ class Client extends openapi_core_1.default {
|
|
|
3358
3715
|
return await this.updatePromptTemplateWithOptions(workspaceId, promptTemplateId, request, headers, runtime);
|
|
3359
3716
|
}
|
|
3360
3717
|
/**
|
|
3361
|
-
*
|
|
3718
|
+
* Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
|
|
3719
|
+
*
|
|
3720
|
+
* @remarks
|
|
3721
|
+
* - Ensure that the OSS bucket belongs to the same Alibaba Cloud account as your Alibaba Cloud Model Studio instance. You must also complete the authorization steps described in [Configure data import from OSS](https://help.aliyun.com/document_detail/2782155.html).
|
|
3722
|
+
* - The bucket storage class must not be Archive, Cold Archive, or Deep Cold Archive. Buckets with server-side encryption are supported. public-read-write, public-read, and private buckets are also supported.
|
|
3723
|
+
* - If you use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html), you must add `*.console.aliyun.com` to the Referer whitelist. For more information, see [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
3724
|
+
* - Before a RAM user (sub-account) can call this operation, they must obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). The AliyunBailianDataFullAccess policy includes the required `sfm:UpdateTableFromAuthorizedOss` permission. An Alibaba Cloud account (root account) can call this operation directly without additional permissions. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) or <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
3725
|
+
* - This operation is not idempotent.
|
|
3726
|
+
* **Rate limiting:** This operation is subject to rate limiting. Do not call it more than five times per second. If you reach the limit, wait before you try again.
|
|
3362
3727
|
*
|
|
3363
3728
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
3364
3729
|
* @param headers - map
|
|
@@ -3398,7 +3763,15 @@ class Client extends openapi_core_1.default {
|
|
|
3398
3763
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateTableFromAuthorizedOssResponse({}));
|
|
3399
3764
|
}
|
|
3400
3765
|
/**
|
|
3401
|
-
*
|
|
3766
|
+
* Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
|
|
3767
|
+
*
|
|
3768
|
+
* @remarks
|
|
3769
|
+
* - Ensure that the OSS bucket belongs to the same Alibaba Cloud account as your Alibaba Cloud Model Studio instance. You must also complete the authorization steps described in [Configure data import from OSS](https://help.aliyun.com/document_detail/2782155.html).
|
|
3770
|
+
* - The bucket storage class must not be Archive, Cold Archive, or Deep Cold Archive. Buckets with server-side encryption are supported. public-read-write, public-read, and private buckets are also supported.
|
|
3771
|
+
* - If you use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html), you must add `*.console.aliyun.com` to the Referer whitelist. For more information, see [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
3772
|
+
* - Before a RAM user (sub-account) can call this operation, they must obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). The AliyunBailianDataFullAccess policy includes the required `sfm:UpdateTableFromAuthorizedOss` permission. An Alibaba Cloud account (root account) can call this operation directly without additional permissions. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) or <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
3773
|
+
* - This operation is not idempotent.
|
|
3774
|
+
* **Rate limiting:** This operation is subject to rate limiting. Do not call it more than five times per second. If you reach the limit, wait before you try again.
|
|
3402
3775
|
*
|
|
3403
3776
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
3404
3777
|
* @returns UpdateTableFromAuthorizedOssResponse
|