@alicloud/bailian20231229 2.13.0 → 2.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +648 -244
- package/dist/client.js +691 -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/AddChunkRequest.d.ts +53 -0
- package/dist/models/AddChunkRequest.js +65 -0
- package/dist/models/AddChunkRequest.js.map +1 -0
- package/dist/models/AddChunkResponse.d.ts +19 -0
- package/dist/models/AddChunkResponse.js +69 -0
- package/dist/models/AddChunkResponse.js.map +1 -0
- package/dist/models/AddChunkResponseBody.d.ts +61 -0
- package/dist/models/AddChunkResponseBody.js +68 -0
- package/dist/models/AddChunkResponseBody.js.map +1 -0
- package/dist/models/AddChunkShrinkRequest.d.ts +51 -0
- package/dist/models/AddChunkShrinkRequest.js +62 -0
- package/dist/models/AddChunkShrinkRequest.js.map +1 -0
- package/dist/models/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 +68 -13
- package/dist/models/AddFileRequest.js.map +1 -1
- package/dist/models/AddFileResponseBody.d.ts +10 -12
- package/dist/models/AddFileResponseBody.js.map +1 -1
- package/dist/models/AddFileShrinkRequest.d.ts +58 -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 +21 -0
- package/dist/models/AddTableRequest.js +2 -0
- package/dist/models/AddTableRequest.js.map +1 -1
- package/dist/models/AddTableResponseBody.d.ts +23 -1
- package/dist/models/AddTableResponseBody.js.map +1 -1
- package/dist/models/AddTableShrinkRequest.d.ts +14 -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 +31 -15
- package/dist/models/ChangeParseSettingRequest.js.map +1 -1
- package/dist/models/ChangeParseSettingResponseBody.d.ts +9 -8
- package/dist/models/ChangeParseSettingResponseBody.js.map +1 -1
- package/dist/models/ChangeParseSettingShrinkRequest.d.ts +24 -9
- 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 +65 -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 +28 -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 +76 -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 +28 -12
- package/dist/models/ListIndexDocumentsRequest.js.map +1 -1
- package/dist/models/ListIndexDocumentsResponseBody.d.ts +51 -30
- package/dist/models/ListIndexDocumentsResponseBody.js.map +1 -1
- package/dist/models/ListIndexFileDetailsRequest.d.ts +36 -0
- package/dist/models/ListIndexFileDetailsRequest.js.map +1 -1
- package/dist/models/ListIndexFileDetailsResponseBody.d.ts +89 -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/dist/models/model.d.ts +4 -0
- package/dist/models/model.js +13 -5
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +698 -245
- package/src/models/AddCategoryRequest.ts +20 -1
- package/src/models/AddCategoryResponseBody.ts +33 -3
- package/src/models/AddChunkRequest.ts +71 -0
- package/src/models/AddChunkResponse.ts +40 -0
- package/src/models/AddChunkResponseBody.ts +84 -0
- package/src/models/AddChunkShrinkRequest.ts +68 -0
- package/src/models/AddConnectorRequest.ts +22 -0
- package/src/models/AddConnectorResponseBody.ts +24 -1
- package/src/models/AddConnectorShrinkRequest.ts +13 -0
- package/src/models/AddFileRequest.ts +68 -13
- package/src/models/AddFileResponseBody.ts +10 -12
- package/src/models/AddFileShrinkRequest.ts +58 -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 +23 -0
- package/src/models/AddTableResponseBody.ts +23 -1
- package/src/models/AddTableShrinkRequest.ts +16 -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 +31 -15
- package/src/models/ChangeParseSettingResponseBody.ts +9 -8
- package/src/models/ChangeParseSettingShrinkRequest.ts +24 -9
- 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 +67 -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 +28 -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 +78 -10
- package/src/models/ListFileShrinkRequest.ts +32 -2
- package/src/models/ListIndexDocumentsRequest.ts +28 -12
- package/src/models/ListIndexDocumentsResponseBody.ts +51 -30
- package/src/models/ListIndexFileDetailsRequest.ts +36 -0
- package/src/models/ListIndexFileDetailsResponseBody.ts +89 -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/src/models/model.ts +4 -0
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,84 @@ class Client extends openapi_core_1.default {
|
|
|
127
129
|
return await this.addCategoryWithOptions(WorkspaceId, request, headers, runtime);
|
|
128
130
|
}
|
|
129
131
|
/**
|
|
130
|
-
*
|
|
132
|
+
* Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* - This operation adds chunk content to a specified knowledge base of the document search (document), data query (table), or image Q&A (image) type. Operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
|
|
136
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
137
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
138
|
+
* - This operation has idempotence.
|
|
139
|
+
* **Related operations:**
|
|
140
|
+
* **Throttling:**
|
|
141
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
142
|
+
*
|
|
143
|
+
* @param tmpReq - AddChunkRequest
|
|
144
|
+
* @param headers - map
|
|
145
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
146
|
+
* @returns AddChunkResponse
|
|
147
|
+
*/
|
|
148
|
+
async addChunkWithOptions(WorkspaceId, tmpReq, headers, runtime) {
|
|
149
|
+
tmpReq.validate();
|
|
150
|
+
let request = new $_model.AddChunkShrinkRequest({});
|
|
151
|
+
openapi_core_2.OpenApiUtil.convert(tmpReq, request);
|
|
152
|
+
if (!$dara.isNull(tmpReq.field)) {
|
|
153
|
+
request.fieldShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.field, "field", "json");
|
|
154
|
+
}
|
|
155
|
+
let query = {};
|
|
156
|
+
if (!$dara.isNull(request.pipelineId)) {
|
|
157
|
+
query["PipelineId"] = request.pipelineId;
|
|
158
|
+
}
|
|
159
|
+
if (!$dara.isNull(request.dataId)) {
|
|
160
|
+
query["dataId"] = request.dataId;
|
|
161
|
+
}
|
|
162
|
+
if (!$dara.isNull(request.fieldShrink)) {
|
|
163
|
+
query["field"] = request.fieldShrink;
|
|
164
|
+
}
|
|
165
|
+
let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
|
|
166
|
+
headers: headers,
|
|
167
|
+
query: openapi_core_2.OpenApiUtil.query(query),
|
|
168
|
+
});
|
|
169
|
+
let params = new openapi_core_2.$OpenApiUtil.Params({
|
|
170
|
+
action: "AddChunk",
|
|
171
|
+
version: "2023-12-29",
|
|
172
|
+
protocol: "HTTPS",
|
|
173
|
+
pathname: `/${$dara.URL.percentEncode(WorkspaceId)}/chunk/create`,
|
|
174
|
+
method: "POST",
|
|
175
|
+
authType: "AK",
|
|
176
|
+
style: "ROA",
|
|
177
|
+
reqBodyType: "json",
|
|
178
|
+
bodyType: "json",
|
|
179
|
+
});
|
|
180
|
+
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddChunkResponse({}));
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
|
|
184
|
+
*
|
|
185
|
+
* @remarks
|
|
186
|
+
* - This operation adds chunk content to a specified knowledge base of the document search (document), data query (table), or image Q&A (image) type. Operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
|
|
187
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
188
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
189
|
+
* - This operation has idempotence.
|
|
190
|
+
* **Related operations:**
|
|
191
|
+
* **Throttling:**
|
|
192
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
193
|
+
*
|
|
194
|
+
* @param request - AddChunkRequest
|
|
195
|
+
* @returns AddChunkResponse
|
|
196
|
+
*/
|
|
197
|
+
async addChunk(WorkspaceId, request) {
|
|
198
|
+
let runtime = new $dara.RuntimeOptions({});
|
|
199
|
+
let headers = {};
|
|
200
|
+
return await this.addChunkWithOptions(WorkspaceId, request, headers, runtime);
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Creates a connector. This API currently supports only file connectors.
|
|
204
|
+
*
|
|
205
|
+
* @remarks
|
|
206
|
+
* - 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.
|
|
207
|
+
* - This operation is not idempotent.
|
|
208
|
+
* **Throttling:**
|
|
209
|
+
* Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
131
210
|
*
|
|
132
211
|
* @param tmpReq - AddConnectorRequest
|
|
133
212
|
* @param headers - map
|
|
@@ -172,7 +251,13 @@ class Client extends openapi_core_1.default {
|
|
|
172
251
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddConnectorResponse({}));
|
|
173
252
|
}
|
|
174
253
|
/**
|
|
175
|
-
*
|
|
254
|
+
* Creates a connector. This API currently supports only file connectors.
|
|
255
|
+
*
|
|
256
|
+
* @remarks
|
|
257
|
+
* - 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.
|
|
258
|
+
* - This operation is not idempotent.
|
|
259
|
+
* **Throttling:**
|
|
260
|
+
* Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
176
261
|
*
|
|
177
262
|
* @param request - AddConnectorRequest
|
|
178
263
|
* @returns AddConnectorResponse
|
|
@@ -183,14 +268,13 @@ class Client extends openapi_core_1.default {
|
|
|
183
268
|
return await this.addConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
184
269
|
}
|
|
185
270
|
/**
|
|
186
|
-
* Imports
|
|
271
|
+
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
187
272
|
*
|
|
188
273
|
* @remarks
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
* * This interface is not idempotent.
|
|
274
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
275
|
+
* - This operation is not idempotent.
|
|
276
|
+
* **Throttling:**
|
|
277
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
194
278
|
*
|
|
195
279
|
* @param tmpReq - AddFileRequest
|
|
196
280
|
* @param headers - map
|
|
@@ -247,14 +331,13 @@ class Client extends openapi_core_1.default {
|
|
|
247
331
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFileResponse({}));
|
|
248
332
|
}
|
|
249
333
|
/**
|
|
250
|
-
* Imports
|
|
334
|
+
* Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
251
335
|
*
|
|
252
336
|
* @remarks
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
* * This interface is not idempotent.
|
|
337
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
338
|
+
* - This operation is not idempotent.
|
|
339
|
+
* **Throttling:**
|
|
340
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
258
341
|
*
|
|
259
342
|
* @param request - AddFileRequest
|
|
260
343
|
* @returns AddFileResponse
|
|
@@ -265,7 +348,17 @@ class Client extends openapi_core_1.default {
|
|
|
265
348
|
return await this.addFileWithOptions(WorkspaceId, request, headers, runtime);
|
|
266
349
|
}
|
|
267
350
|
/**
|
|
268
|
-
*
|
|
351
|
+
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
352
|
+
*
|
|
353
|
+
* @remarks
|
|
354
|
+
* - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
|
|
355
|
+
*
|
|
356
|
+
* - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
|
|
357
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
358
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
359
|
+
* - This operation does not have idempotence.
|
|
360
|
+
* **Rate limit:**
|
|
361
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
269
362
|
*
|
|
270
363
|
* @param tmpReq - AddFilesFromAuthorizedOssRequest
|
|
271
364
|
* @param headers - map
|
|
@@ -322,7 +415,17 @@ class Client extends openapi_core_1.default {
|
|
|
322
415
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFilesFromAuthorizedOssResponse({}));
|
|
323
416
|
}
|
|
324
417
|
/**
|
|
325
|
-
*
|
|
418
|
+
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
419
|
+
*
|
|
420
|
+
* @remarks
|
|
421
|
+
* - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
|
|
422
|
+
*
|
|
423
|
+
* - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
|
|
424
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
425
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
426
|
+
* - This operation does not have idempotence.
|
|
427
|
+
* **Rate limit:**
|
|
428
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
326
429
|
*
|
|
327
430
|
* @param request - AddFilesFromAuthorizedOssRequest
|
|
328
431
|
* @returns AddFilesFromAuthorizedOssResponse
|
|
@@ -333,7 +436,13 @@ class Client extends openapi_core_1.default {
|
|
|
333
436
|
return await this.addFilesFromAuthorizedOssWithOptions(WorkspaceId, request, headers, runtime);
|
|
334
437
|
}
|
|
335
438
|
/**
|
|
336
|
-
*
|
|
439
|
+
* Add a table for the table data connector.
|
|
440
|
+
*
|
|
441
|
+
* @remarks
|
|
442
|
+
* - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
443
|
+
* - This API is not idempotent.
|
|
444
|
+
* **Throttling:**
|
|
445
|
+
* This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
|
|
337
446
|
*
|
|
338
447
|
* @param tmpReq - AddTableRequest
|
|
339
448
|
* @param headers - map
|
|
@@ -354,6 +463,9 @@ class Client extends openapi_core_1.default {
|
|
|
354
463
|
if (!$dara.isNull(request.tableColumnsShrink)) {
|
|
355
464
|
body["TableColumns"] = request.tableColumnsShrink;
|
|
356
465
|
}
|
|
466
|
+
if (!$dara.isNull(request.tableDesc)) {
|
|
467
|
+
body["TableDesc"] = request.tableDesc;
|
|
468
|
+
}
|
|
357
469
|
if (!$dara.isNull(request.tableName)) {
|
|
358
470
|
body["TableName"] = request.tableName;
|
|
359
471
|
}
|
|
@@ -375,7 +487,13 @@ class Client extends openapi_core_1.default {
|
|
|
375
487
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddTableResponse({}));
|
|
376
488
|
}
|
|
377
489
|
/**
|
|
378
|
-
*
|
|
490
|
+
* Add a table for the table data connector.
|
|
491
|
+
*
|
|
492
|
+
* @remarks
|
|
493
|
+
* - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
494
|
+
* - This API is not idempotent.
|
|
495
|
+
* **Throttling:**
|
|
496
|
+
* This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
|
|
379
497
|
*
|
|
380
498
|
* @param request - AddTableRequest
|
|
381
499
|
* @returns AddTableResponse
|
|
@@ -386,13 +504,13 @@ class Client extends openapi_core_1.default {
|
|
|
386
504
|
return await this.addTableWithOptions(WorkspaceId, request, headers, runtime);
|
|
387
505
|
}
|
|
388
506
|
/**
|
|
389
|
-
*
|
|
507
|
+
* Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
|
|
390
508
|
*
|
|
391
509
|
* @remarks
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
510
|
+
* - 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).
|
|
511
|
+
* - This API is not idempotent.
|
|
512
|
+
* **Throttling:**
|
|
513
|
+
* 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
514
|
*
|
|
397
515
|
* @param request - ApplyFileUploadLeaseRequest
|
|
398
516
|
* @param headers - map
|
|
@@ -435,13 +553,13 @@ class Client extends openapi_core_1.default {
|
|
|
435
553
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ApplyFileUploadLeaseResponse({}));
|
|
436
554
|
}
|
|
437
555
|
/**
|
|
438
|
-
*
|
|
556
|
+
* Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
|
|
439
557
|
*
|
|
440
558
|
* @remarks
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
559
|
+
* - 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).
|
|
560
|
+
* - This API is not idempotent.
|
|
561
|
+
* **Throttling:**
|
|
562
|
+
* 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
563
|
*
|
|
446
564
|
* @param request - ApplyFileUploadLeaseRequest
|
|
447
565
|
* @returns ApplyFileUploadLeaseResponse
|
|
@@ -503,7 +621,7 @@ class Client extends openapi_core_1.default {
|
|
|
503
621
|
return await this.applyTempStorageLeaseWithOptions(WorkspaceId, request, headers, runtime);
|
|
504
622
|
}
|
|
505
623
|
/**
|
|
506
|
-
*
|
|
624
|
+
* This operation updates document tags in a data connection in batches.
|
|
507
625
|
*
|
|
508
626
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
509
627
|
* @param headers - map
|
|
@@ -542,7 +660,7 @@ class Client extends openapi_core_1.default {
|
|
|
542
660
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.BatchUpdateFileTagResponse({}));
|
|
543
661
|
}
|
|
544
662
|
/**
|
|
545
|
-
*
|
|
663
|
+
* This operation updates document tags in a data connection in batches.
|
|
546
664
|
*
|
|
547
665
|
* @param request - BatchUpdateFileTagRequest
|
|
548
666
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -553,7 +671,13 @@ class Client extends openapi_core_1.default {
|
|
|
553
671
|
return await this.batchUpdateFileTagWithOptions(WorkspaceId, request, headers, runtime);
|
|
554
672
|
}
|
|
555
673
|
/**
|
|
556
|
-
*
|
|
674
|
+
* Configures the parsing method for specific file types. For example, specifies large model document parsing for .pdf files or Qwen VL parsing for .jpg files.
|
|
675
|
+
*
|
|
676
|
+
* @remarks
|
|
677
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
678
|
+
* - This operation is not idempotent.
|
|
679
|
+
* **Throttling:**
|
|
680
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
557
681
|
*
|
|
558
682
|
* @param tmpReq - ChangeParseSettingRequest
|
|
559
683
|
* @param headers - map
|
|
@@ -598,7 +722,13 @@ class Client extends openapi_core_1.default {
|
|
|
598
722
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ChangeParseSettingResponse({}));
|
|
599
723
|
}
|
|
600
724
|
/**
|
|
601
|
-
*
|
|
725
|
+
* Configures the parsing method for specific file types. For example, specifies large model document parsing for .pdf files or Qwen VL parsing for .jpg files.
|
|
726
|
+
*
|
|
727
|
+
* @remarks
|
|
728
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
729
|
+
* - This operation is not idempotent.
|
|
730
|
+
* **Throttling:**
|
|
731
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
602
732
|
*
|
|
603
733
|
* @param request - ChangeParseSettingRequest
|
|
604
734
|
* @returns ChangeParseSettingResponse
|
|
@@ -671,17 +801,17 @@ class Client extends openapi_core_1.default {
|
|
|
671
801
|
return await this.createAndPulishAgentWithOptions(workspaceId, request, headers, runtime);
|
|
672
802
|
}
|
|
673
803
|
/**
|
|
674
|
-
*
|
|
804
|
+
* 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
805
|
*
|
|
676
806
|
* @remarks
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
*
|
|
807
|
+
* - **Permissions**:
|
|
808
|
+
* - **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.
|
|
809
|
+
* - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
|
|
810
|
+
* - **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.
|
|
811
|
+
* - **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).
|
|
812
|
+
* - **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.
|
|
813
|
+
* **Rate limiting:**
|
|
814
|
+
* 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
815
|
*
|
|
686
816
|
* @param tmpReq - CreateIndexRequest
|
|
687
817
|
* @param headers - map
|
|
@@ -828,17 +958,17 @@ class Client extends openapi_core_1.default {
|
|
|
828
958
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIndexResponse({}));
|
|
829
959
|
}
|
|
830
960
|
/**
|
|
831
|
-
*
|
|
961
|
+
* 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
962
|
*
|
|
833
963
|
* @remarks
|
|
834
|
-
*
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
*
|
|
838
|
-
*
|
|
839
|
-
*
|
|
840
|
-
*
|
|
841
|
-
*
|
|
964
|
+
* - **Permissions**:
|
|
965
|
+
* - **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.
|
|
966
|
+
* - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
|
|
967
|
+
* - **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.
|
|
968
|
+
* - **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).
|
|
969
|
+
* - **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.
|
|
970
|
+
* **Rate limiting:**
|
|
971
|
+
* 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
972
|
*
|
|
843
973
|
* @param request - CreateIndexRequest
|
|
844
974
|
* @returns CreateIndexResponse
|
|
@@ -849,7 +979,14 @@ class Client extends openapi_core_1.default {
|
|
|
849
979
|
return await this.createIndexWithOptions(WorkspaceId, request, headers, runtime);
|
|
850
980
|
}
|
|
851
981
|
/**
|
|
852
|
-
*
|
|
982
|
+
* Creates a long-term memory.
|
|
983
|
+
*
|
|
984
|
+
* @remarks
|
|
985
|
+
* - 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).
|
|
986
|
+
* > 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).
|
|
987
|
+
* - 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.
|
|
988
|
+
* - This operation does not support idempotence.
|
|
989
|
+
* **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
990
|
*
|
|
854
991
|
* @param request - CreateMemoryRequest
|
|
855
992
|
* @param headers - map
|
|
@@ -880,7 +1017,14 @@ class Client extends openapi_core_1.default {
|
|
|
880
1017
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateMemoryResponse({}));
|
|
881
1018
|
}
|
|
882
1019
|
/**
|
|
883
|
-
*
|
|
1020
|
+
* Creates a long-term memory.
|
|
1021
|
+
*
|
|
1022
|
+
* @remarks
|
|
1023
|
+
* - 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).
|
|
1024
|
+
* > 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).
|
|
1025
|
+
* - 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.
|
|
1026
|
+
* - This operation does not support idempotence.
|
|
1027
|
+
* **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
1028
|
*
|
|
885
1029
|
* @param request - CreateMemoryRequest
|
|
886
1030
|
* @returns CreateMemoryResponse
|
|
@@ -891,7 +1035,7 @@ class Client extends openapi_core_1.default {
|
|
|
891
1035
|
return await this.createMemoryWithOptions(workspaceId, request, headers, runtime);
|
|
892
1036
|
}
|
|
893
1037
|
/**
|
|
894
|
-
*
|
|
1038
|
+
* Creates a memory node.
|
|
895
1039
|
*
|
|
896
1040
|
* @param request - CreateMemoryNodeRequest
|
|
897
1041
|
* @param headers - map
|
|
@@ -922,7 +1066,7 @@ class Client extends openapi_core_1.default {
|
|
|
922
1066
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateMemoryNodeResponse({}));
|
|
923
1067
|
}
|
|
924
1068
|
/**
|
|
925
|
-
*
|
|
1069
|
+
* Creates a memory node.
|
|
926
1070
|
*
|
|
927
1071
|
* @param request - CreateMemoryNodeRequest
|
|
928
1072
|
* @returns CreateMemoryNodeResponse
|
|
@@ -933,7 +1077,10 @@ class Client extends openapi_core_1.default {
|
|
|
933
1077
|
return await this.createMemoryNodeWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
934
1078
|
}
|
|
935
1079
|
/**
|
|
936
|
-
*
|
|
1080
|
+
* Create a prompt template.
|
|
1081
|
+
*
|
|
1082
|
+
* @remarks
|
|
1083
|
+
* This API does not currently support the creation of text-to-image prompt templates.
|
|
937
1084
|
*
|
|
938
1085
|
* @param request - CreatePromptTemplateRequest
|
|
939
1086
|
* @param headers - map
|
|
@@ -967,7 +1114,10 @@ class Client extends openapi_core_1.default {
|
|
|
967
1114
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreatePromptTemplateResponse({}));
|
|
968
1115
|
}
|
|
969
1116
|
/**
|
|
970
|
-
*
|
|
1117
|
+
* Create a prompt template.
|
|
1118
|
+
*
|
|
1119
|
+
* @remarks
|
|
1120
|
+
* This API does not currently support the creation of text-to-image prompt templates.
|
|
971
1121
|
*
|
|
972
1122
|
* @param request - CreatePromptTemplateRequest
|
|
973
1123
|
* @returns CreatePromptTemplateResponse
|
|
@@ -1015,7 +1165,13 @@ class Client extends openapi_core_1.default {
|
|
|
1015
1165
|
return await this.deleteAgentWithOptions(workspaceId, appCode, request, headers, runtime);
|
|
1016
1166
|
}
|
|
1017
1167
|
/**
|
|
1018
|
-
*
|
|
1168
|
+
* Permanently deletes a specified category.
|
|
1169
|
+
*
|
|
1170
|
+
* @remarks
|
|
1171
|
+
* - 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.
|
|
1172
|
+
* - This operation is idempotent.
|
|
1173
|
+
* **Rate limiting:**
|
|
1174
|
+
* This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1019
1175
|
*
|
|
1020
1176
|
* @param request - DeleteCategoryRequest
|
|
1021
1177
|
* @param headers - map
|
|
@@ -1041,7 +1197,13 @@ class Client extends openapi_core_1.default {
|
|
|
1041
1197
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteCategoryResponse({}));
|
|
1042
1198
|
}
|
|
1043
1199
|
/**
|
|
1044
|
-
*
|
|
1200
|
+
* Permanently deletes a specified category.
|
|
1201
|
+
*
|
|
1202
|
+
* @remarks
|
|
1203
|
+
* - 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.
|
|
1204
|
+
* - This operation is idempotent.
|
|
1205
|
+
* **Rate limiting:**
|
|
1206
|
+
* This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1045
1207
|
*
|
|
1046
1208
|
* @param request - DeleteCategoryRequest
|
|
1047
1209
|
* @returns DeleteCategoryResponse
|
|
@@ -1052,18 +1214,18 @@ class Client extends openapi_core_1.default {
|
|
|
1052
1214
|
return await this.deleteCategoryWithOptions(CategoryId, WorkspaceId, request, headers, runtime);
|
|
1053
1215
|
}
|
|
1054
1216
|
/**
|
|
1055
|
-
* Deletes
|
|
1217
|
+
* Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
1056
1218
|
*
|
|
1057
1219
|
* @remarks
|
|
1058
|
-
*
|
|
1059
|
-
* **
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1220
|
+
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
1221
|
+
* - **Permission requirements**:
|
|
1222
|
+
* - **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.
|
|
1223
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1224
|
+
* - **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.
|
|
1225
|
+
* - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
|
|
1226
|
+
* - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
|
|
1227
|
+
* **Rate limit:**
|
|
1228
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1067
1229
|
*
|
|
1068
1230
|
* @param tmpReq - DeleteChunkRequest
|
|
1069
1231
|
* @param headers - map
|
|
@@ -1102,18 +1264,18 @@ class Client extends openapi_core_1.default {
|
|
|
1102
1264
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteChunkResponse({}));
|
|
1103
1265
|
}
|
|
1104
1266
|
/**
|
|
1105
|
-
* Deletes
|
|
1267
|
+
* Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
1106
1268
|
*
|
|
1107
1269
|
* @remarks
|
|
1108
|
-
*
|
|
1109
|
-
* **
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
*
|
|
1113
|
-
*
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1270
|
+
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
1271
|
+
* - **Permission requirements**:
|
|
1272
|
+
* - **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.
|
|
1273
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1274
|
+
* - **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.
|
|
1275
|
+
* - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
|
|
1276
|
+
* - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
|
|
1277
|
+
* **Rate limit:**
|
|
1278
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1117
1279
|
*
|
|
1118
1280
|
* @param request - DeleteChunkRequest
|
|
1119
1281
|
* @returns DeleteChunkResponse
|
|
@@ -1126,6 +1288,12 @@ class Client extends openapi_core_1.default {
|
|
|
1126
1288
|
/**
|
|
1127
1289
|
* 删除连接器
|
|
1128
1290
|
*
|
|
1291
|
+
* @remarks
|
|
1292
|
+
* - 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)来调用本接口。
|
|
1293
|
+
* - 本接口不具备幂等性。
|
|
1294
|
+
* **限流说明:**
|
|
1295
|
+
* 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
|
|
1296
|
+
*
|
|
1129
1297
|
* @param request - DeleteConnectorRequest
|
|
1130
1298
|
* @param headers - map
|
|
1131
1299
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1152,6 +1320,12 @@ class Client extends openapi_core_1.default {
|
|
|
1152
1320
|
/**
|
|
1153
1321
|
* 删除连接器
|
|
1154
1322
|
*
|
|
1323
|
+
* @remarks
|
|
1324
|
+
* - 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)来调用本接口。
|
|
1325
|
+
* - 本接口不具备幂等性。
|
|
1326
|
+
* **限流说明:**
|
|
1327
|
+
* 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
|
|
1328
|
+
*
|
|
1155
1329
|
* @param request - DeleteConnectorRequest
|
|
1156
1330
|
* @returns DeleteConnectorResponse
|
|
1157
1331
|
*/
|
|
@@ -1161,7 +1335,16 @@ class Client extends openapi_core_1.default {
|
|
|
1161
1335
|
return await this.deleteConnectorWithOptions(ConnectorId, WorkspaceId, request, headers, runtime);
|
|
1162
1336
|
}
|
|
1163
1337
|
/**
|
|
1164
|
-
*
|
|
1338
|
+
* Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
|
|
1339
|
+
*
|
|
1340
|
+
* @remarks
|
|
1341
|
+
* - 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.
|
|
1342
|
+
* - 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.
|
|
1343
|
+
* - 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.
|
|
1344
|
+
* - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
|
|
1345
|
+
* - This API is idempotent.
|
|
1346
|
+
* **Rate Limiting Notice:**
|
|
1347
|
+
* 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
1348
|
*
|
|
1166
1349
|
* @param request - DeleteFileRequest
|
|
1167
1350
|
* @param headers - map
|
|
@@ -1187,7 +1370,16 @@ class Client extends openapi_core_1.default {
|
|
|
1187
1370
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFileResponse({}));
|
|
1188
1371
|
}
|
|
1189
1372
|
/**
|
|
1190
|
-
*
|
|
1373
|
+
* Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
|
|
1374
|
+
*
|
|
1375
|
+
* @remarks
|
|
1376
|
+
* - 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.
|
|
1377
|
+
* - 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.
|
|
1378
|
+
* - 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.
|
|
1379
|
+
* - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
|
|
1380
|
+
* - This API is idempotent.
|
|
1381
|
+
* **Rate Limiting Notice:**
|
|
1382
|
+
* 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
1383
|
*
|
|
1192
1384
|
* @param request - DeleteFileRequest
|
|
1193
1385
|
* @returns DeleteFileResponse
|
|
@@ -1198,7 +1390,16 @@ class Client extends openapi_core_1.default {
|
|
|
1198
1390
|
return await this.deleteFileWithOptions(FileId, WorkspaceId, request, headers, runtime);
|
|
1199
1391
|
}
|
|
1200
1392
|
/**
|
|
1201
|
-
*
|
|
1393
|
+
* Delete files in batch
|
|
1394
|
+
*
|
|
1395
|
+
* @remarks
|
|
1396
|
+
* - 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).
|
|
1397
|
+
* - 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.
|
|
1398
|
+
* - 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.
|
|
1399
|
+
* - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
|
|
1400
|
+
* - This operation is idempotent.
|
|
1401
|
+
* **Throttling:**
|
|
1402
|
+
* Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
|
|
1202
1403
|
*
|
|
1203
1404
|
* @param tmpReq - DeleteFilesRequest
|
|
1204
1405
|
* @param headers - map
|
|
@@ -1234,7 +1435,16 @@ class Client extends openapi_core_1.default {
|
|
|
1234
1435
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFilesResponse({}));
|
|
1235
1436
|
}
|
|
1236
1437
|
/**
|
|
1237
|
-
*
|
|
1438
|
+
* Delete files in batch
|
|
1439
|
+
*
|
|
1440
|
+
* @remarks
|
|
1441
|
+
* - 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).
|
|
1442
|
+
* - 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.
|
|
1443
|
+
* - 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.
|
|
1444
|
+
* - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
|
|
1445
|
+
* - This operation is idempotent.
|
|
1446
|
+
* **Throttling:**
|
|
1447
|
+
* Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
|
|
1238
1448
|
*
|
|
1239
1449
|
* @param request - DeleteFilesRequest
|
|
1240
1450
|
* @returns DeleteFilesResponse
|
|
@@ -1245,14 +1455,17 @@ class Client extends openapi_core_1.default {
|
|
|
1245
1455
|
return await this.deleteFilesWithOptions(WorkspaceId, request, headers, runtime);
|
|
1246
1456
|
}
|
|
1247
1457
|
/**
|
|
1248
|
-
*
|
|
1458
|
+
* Permanently deletes a specified knowledge base.
|
|
1249
1459
|
*
|
|
1250
1460
|
* @remarks
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1253
|
-
*
|
|
1254
|
-
*
|
|
1255
|
-
*
|
|
1461
|
+
* - 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.
|
|
1462
|
+
* - 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).
|
|
1463
|
+
* - 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).
|
|
1464
|
+
* - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
|
|
1465
|
+
* - 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).
|
|
1466
|
+
* - This operation has idempotence.
|
|
1467
|
+
* **Rate limit:**
|
|
1468
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1256
1469
|
*
|
|
1257
1470
|
* @param request - DeleteIndexRequest
|
|
1258
1471
|
* @param headers - map
|
|
@@ -1283,14 +1496,17 @@ class Client extends openapi_core_1.default {
|
|
|
1283
1496
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIndexResponse({}));
|
|
1284
1497
|
}
|
|
1285
1498
|
/**
|
|
1286
|
-
*
|
|
1499
|
+
* Permanently deletes a specified knowledge base.
|
|
1287
1500
|
*
|
|
1288
1501
|
* @remarks
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1502
|
+
* - 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.
|
|
1503
|
+
* - 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).
|
|
1504
|
+
* - 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).
|
|
1505
|
+
* - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
|
|
1506
|
+
* - 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).
|
|
1507
|
+
* - This operation has idempotence.
|
|
1508
|
+
* **Rate limit:**
|
|
1509
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1294
1510
|
*
|
|
1295
1511
|
* @param request - DeleteIndexRequest
|
|
1296
1512
|
* @returns DeleteIndexResponse
|
|
@@ -1301,14 +1517,18 @@ class Client extends openapi_core_1.default {
|
|
|
1301
1517
|
return await this.deleteIndexWithOptions(WorkspaceId, request, headers, runtime);
|
|
1302
1518
|
}
|
|
1303
1519
|
/**
|
|
1304
|
-
*
|
|
1520
|
+
* Permanently deletes files from a specified knowledge base.
|
|
1305
1521
|
*
|
|
1306
1522
|
* @remarks
|
|
1307
|
-
*
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
*
|
|
1523
|
+
* - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
|
|
1524
|
+
* - 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.
|
|
1525
|
+
* - 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).
|
|
1526
|
+
* - 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.
|
|
1527
|
+
* - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
|
|
1528
|
+
* - 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).
|
|
1529
|
+
* - This operation is idempotent.
|
|
1530
|
+
* **Throttling:**
|
|
1531
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1312
1532
|
*
|
|
1313
1533
|
* @param tmpReq - DeleteIndexDocumentRequest
|
|
1314
1534
|
* @param headers - map
|
|
@@ -1347,14 +1567,18 @@ class Client extends openapi_core_1.default {
|
|
|
1347
1567
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIndexDocumentResponse({}));
|
|
1348
1568
|
}
|
|
1349
1569
|
/**
|
|
1350
|
-
*
|
|
1570
|
+
* Permanently deletes files from a specified knowledge base.
|
|
1351
1571
|
*
|
|
1352
1572
|
* @remarks
|
|
1353
|
-
*
|
|
1354
|
-
*
|
|
1355
|
-
*
|
|
1356
|
-
*
|
|
1357
|
-
*
|
|
1573
|
+
* - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
|
|
1574
|
+
* - 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.
|
|
1575
|
+
* - 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).
|
|
1576
|
+
* - 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.
|
|
1577
|
+
* - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
|
|
1578
|
+
* - 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).
|
|
1579
|
+
* - This operation is idempotent.
|
|
1580
|
+
* **Throttling:**
|
|
1581
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1358
1582
|
*
|
|
1359
1583
|
* @param request - DeleteIndexDocumentRequest
|
|
1360
1584
|
* @returns DeleteIndexDocumentResponse
|
|
@@ -1365,7 +1589,13 @@ class Client extends openapi_core_1.default {
|
|
|
1365
1589
|
return await this.deleteIndexDocumentWithOptions(WorkspaceId, request, headers, runtime);
|
|
1366
1590
|
}
|
|
1367
1591
|
/**
|
|
1368
|
-
*
|
|
1592
|
+
* Permanently deletes a specified long-term memory.
|
|
1593
|
+
*
|
|
1594
|
+
* @remarks
|
|
1595
|
+
* - 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).
|
|
1596
|
+
* - 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.
|
|
1597
|
+
* - This operation is idempotent.
|
|
1598
|
+
* **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
1599
|
*
|
|
1370
1600
|
* @param request - DeleteMemoryRequest
|
|
1371
1601
|
* @param headers - map
|
|
@@ -1391,7 +1621,13 @@ class Client extends openapi_core_1.default {
|
|
|
1391
1621
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteMemoryResponse({}));
|
|
1392
1622
|
}
|
|
1393
1623
|
/**
|
|
1394
|
-
*
|
|
1624
|
+
* Permanently deletes a specified long-term memory.
|
|
1625
|
+
*
|
|
1626
|
+
* @remarks
|
|
1627
|
+
* - 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).
|
|
1628
|
+
* - 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.
|
|
1629
|
+
* - This operation is idempotent.
|
|
1630
|
+
* **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
1631
|
*
|
|
1396
1632
|
* @param request - DeleteMemoryRequest
|
|
1397
1633
|
* @returns DeleteMemoryResponse
|
|
@@ -1402,7 +1638,7 @@ class Client extends openapi_core_1.default {
|
|
|
1402
1638
|
return await this.deleteMemoryWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
1403
1639
|
}
|
|
1404
1640
|
/**
|
|
1405
|
-
*
|
|
1641
|
+
* Deletes a memory fragment.
|
|
1406
1642
|
*
|
|
1407
1643
|
* @param request - DeleteMemoryNodeRequest
|
|
1408
1644
|
* @param headers - map
|
|
@@ -1428,7 +1664,7 @@ class Client extends openapi_core_1.default {
|
|
|
1428
1664
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteMemoryNodeResponse({}));
|
|
1429
1665
|
}
|
|
1430
1666
|
/**
|
|
1431
|
-
*
|
|
1667
|
+
* Deletes a memory fragment.
|
|
1432
1668
|
*
|
|
1433
1669
|
* @param request - DeleteMemoryNodeRequest
|
|
1434
1670
|
* @returns DeleteMemoryNodeResponse
|
|
@@ -1476,13 +1712,13 @@ class Client extends openapi_core_1.default {
|
|
|
1476
1712
|
return await this.deletePromptTemplateWithOptions(workspaceId, promptTemplateId, request, headers, runtime);
|
|
1477
1713
|
}
|
|
1478
1714
|
/**
|
|
1479
|
-
*
|
|
1715
|
+
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
1480
1716
|
*
|
|
1481
1717
|
* @remarks
|
|
1482
|
-
*
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1485
|
-
*
|
|
1718
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1719
|
+
* - This operation is idempotent.
|
|
1720
|
+
* **Throttling:**
|
|
1721
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1486
1722
|
*
|
|
1487
1723
|
* @param request - DescribeFileRequest
|
|
1488
1724
|
* @param headers - map
|
|
@@ -1508,13 +1744,13 @@ class Client extends openapi_core_1.default {
|
|
|
1508
1744
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeFileResponse({}));
|
|
1509
1745
|
}
|
|
1510
1746
|
/**
|
|
1511
|
-
*
|
|
1747
|
+
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
1512
1748
|
*
|
|
1513
1749
|
* @remarks
|
|
1514
|
-
*
|
|
1515
|
-
*
|
|
1516
|
-
*
|
|
1517
|
-
*
|
|
1750
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1751
|
+
* - This operation is idempotent.
|
|
1752
|
+
* **Throttling:**
|
|
1753
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1518
1754
|
*
|
|
1519
1755
|
* @param request - DescribeFileRequest
|
|
1520
1756
|
* @returns DescribeFileResponse
|
|
@@ -1525,7 +1761,7 @@ class Client extends openapi_core_1.default {
|
|
|
1525
1761
|
return await this.describeFileWithOptions(WorkspaceId, FileId, request, headers, runtime);
|
|
1526
1762
|
}
|
|
1527
1763
|
/**
|
|
1528
|
-
*
|
|
1764
|
+
* Queries the tipping status of the Alipay wallet bound to an application.
|
|
1529
1765
|
*
|
|
1530
1766
|
* @param request - GetAlipayTransferStatusRequest
|
|
1531
1767
|
* @param headers - map
|
|
@@ -1559,7 +1795,7 @@ class Client extends openapi_core_1.default {
|
|
|
1559
1795
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAlipayTransferStatusResponse({}));
|
|
1560
1796
|
}
|
|
1561
1797
|
/**
|
|
1562
|
-
*
|
|
1798
|
+
* Queries the tipping status of the Alipay wallet bound to an application.
|
|
1563
1799
|
*
|
|
1564
1800
|
* @param request - GetAlipayTransferStatusRequest
|
|
1565
1801
|
* @returns GetAlipayTransferStatusResponse
|
|
@@ -1570,7 +1806,7 @@ class Client extends openapi_core_1.default {
|
|
|
1570
1806
|
return await this.getAlipayTransferStatusWithOptions(request, headers, runtime);
|
|
1571
1807
|
}
|
|
1572
1808
|
/**
|
|
1573
|
-
*
|
|
1809
|
+
* Retrieves the Alipay tipping URL for an application.
|
|
1574
1810
|
*
|
|
1575
1811
|
* @param request - GetAlipayUrlRequest
|
|
1576
1812
|
* @param headers - map
|
|
@@ -1604,7 +1840,7 @@ class Client extends openapi_core_1.default {
|
|
|
1604
1840
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAlipayUrlResponse({}));
|
|
1605
1841
|
}
|
|
1606
1842
|
/**
|
|
1607
|
-
*
|
|
1843
|
+
* Retrieves the Alipay tipping URL for an application.
|
|
1608
1844
|
*
|
|
1609
1845
|
* @param request - GetAlipayUrlRequest
|
|
1610
1846
|
* @returns GetAlipayUrlResponse
|
|
@@ -1617,6 +1853,12 @@ class Client extends openapi_core_1.default {
|
|
|
1617
1853
|
/**
|
|
1618
1854
|
* Lists all supported parser types based on the input file type (file extension).
|
|
1619
1855
|
*
|
|
1856
|
+
* @remarks
|
|
1857
|
+
* - 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)来调用本接口。
|
|
1858
|
+
* - 本接口具有幂等性。
|
|
1859
|
+
* **限流说明:**
|
|
1860
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
1861
|
+
*
|
|
1620
1862
|
* @param request - GetAvailableParserTypesRequest
|
|
1621
1863
|
* @param headers - map
|
|
1622
1864
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1648,6 +1890,12 @@ class Client extends openapi_core_1.default {
|
|
|
1648
1890
|
/**
|
|
1649
1891
|
* Lists all supported parser types based on the input file type (file extension).
|
|
1650
1892
|
*
|
|
1893
|
+
* @remarks
|
|
1894
|
+
* - 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)来调用本接口。
|
|
1895
|
+
* - 本接口具有幂等性。
|
|
1896
|
+
* **限流说明:**
|
|
1897
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
1898
|
+
*
|
|
1651
1899
|
* @param request - GetAvailableParserTypesRequest
|
|
1652
1900
|
* @returns GetAvailableParserTypesResponse
|
|
1653
1901
|
*/
|
|
@@ -1657,7 +1905,13 @@ class Client extends openapi_core_1.default {
|
|
|
1657
1905
|
return await this.getAvailableParserTypesWithOptions(WorkspaceId, request, headers, runtime);
|
|
1658
1906
|
}
|
|
1659
1907
|
/**
|
|
1660
|
-
*
|
|
1908
|
+
* Retrieves details about a connector. This operation currently supports only file connectors.
|
|
1909
|
+
*
|
|
1910
|
+
* @remarks
|
|
1911
|
+
* - 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.
|
|
1912
|
+
* - This operation is idempotent.
|
|
1913
|
+
* **Throttling:**
|
|
1914
|
+
* 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
1915
|
*
|
|
1662
1916
|
* @param request - GetConnectorRequest
|
|
1663
1917
|
* @param headers - map
|
|
@@ -1691,7 +1945,13 @@ class Client extends openapi_core_1.default {
|
|
|
1691
1945
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetConnectorResponse({}));
|
|
1692
1946
|
}
|
|
1693
1947
|
/**
|
|
1694
|
-
*
|
|
1948
|
+
* Retrieves details about a connector. This operation currently supports only file connectors.
|
|
1949
|
+
*
|
|
1950
|
+
* @remarks
|
|
1951
|
+
* - 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.
|
|
1952
|
+
* - This operation is idempotent.
|
|
1953
|
+
* **Throttling:**
|
|
1954
|
+
* 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
1955
|
*
|
|
1696
1956
|
* @param request - GetConnectorRequest
|
|
1697
1957
|
* @returns GetConnectorResponse
|
|
@@ -1702,12 +1962,13 @@ class Client extends openapi_core_1.default {
|
|
|
1702
1962
|
return await this.getConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
1703
1963
|
}
|
|
1704
1964
|
/**
|
|
1705
|
-
* Queries the current status of a specified knowledge base creation or
|
|
1965
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document append task.
|
|
1706
1966
|
*
|
|
1707
1967
|
* @remarks
|
|
1708
|
-
*
|
|
1709
|
-
*
|
|
1710
|
-
*
|
|
1968
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1969
|
+
* - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
|
|
1970
|
+
* - Invoke this operation at intervals of 5 seconds or more.
|
|
1971
|
+
* - This operation supports idempotence.
|
|
1711
1972
|
*
|
|
1712
1973
|
* @param request - GetIndexJobStatusRequest
|
|
1713
1974
|
* @param headers - map
|
|
@@ -1747,12 +2008,13 @@ class Client extends openapi_core_1.default {
|
|
|
1747
2008
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexJobStatusResponse({}));
|
|
1748
2009
|
}
|
|
1749
2010
|
/**
|
|
1750
|
-
* Queries the current status of a specified knowledge base creation or
|
|
2011
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document append task.
|
|
1751
2012
|
*
|
|
1752
2013
|
* @remarks
|
|
1753
|
-
*
|
|
1754
|
-
*
|
|
1755
|
-
*
|
|
2014
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2015
|
+
* - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
|
|
2016
|
+
* - Invoke this operation at intervals of 5 seconds or more.
|
|
2017
|
+
* - This operation supports idempotence.
|
|
1756
2018
|
*
|
|
1757
2019
|
* @param request - GetIndexJobStatusRequest
|
|
1758
2020
|
* @returns GetIndexJobStatusResponse
|
|
@@ -1763,7 +2025,13 @@ class Client extends openapi_core_1.default {
|
|
|
1763
2025
|
return await this.getIndexJobStatusWithOptions(WorkspaceId, request, headers, runtime);
|
|
1764
2026
|
}
|
|
1765
2027
|
/**
|
|
1766
|
-
*
|
|
2028
|
+
* 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.
|
|
2029
|
+
*
|
|
2030
|
+
* @remarks
|
|
2031
|
+
* <props="intl">
|
|
2032
|
+
* This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
|
|
2033
|
+
* <props="china">
|
|
2034
|
+
* - 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
2035
|
*
|
|
1768
2036
|
* @param request - GetIndexMonitorRequest
|
|
1769
2037
|
* @param headers - map
|
|
@@ -1800,7 +2068,13 @@ class Client extends openapi_core_1.default {
|
|
|
1800
2068
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexMonitorResponse({}));
|
|
1801
2069
|
}
|
|
1802
2070
|
/**
|
|
1803
|
-
*
|
|
2071
|
+
* 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.
|
|
2072
|
+
*
|
|
2073
|
+
* @remarks
|
|
2074
|
+
* <props="intl">
|
|
2075
|
+
* This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
|
|
2076
|
+
* <props="china">
|
|
2077
|
+
* - 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
2078
|
*
|
|
1805
2079
|
* @param request - GetIndexMonitorRequest
|
|
1806
2080
|
* @returns GetIndexMonitorResponse
|
|
@@ -1811,7 +2085,11 @@ class Client extends openapi_core_1.default {
|
|
|
1811
2085
|
return await this.getIndexMonitorWithOptions(WorkspaceId, request, headers, runtime);
|
|
1812
2086
|
}
|
|
1813
2087
|
/**
|
|
1814
|
-
*
|
|
2088
|
+
* Retrieves the description of a specified long-term memory.
|
|
2089
|
+
*
|
|
2090
|
+
* @remarks
|
|
2091
|
+
* - This operation is idempotent.
|
|
2092
|
+
* **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
2093
|
*
|
|
1816
2094
|
* @param request - GetMemoryRequest
|
|
1817
2095
|
* @param headers - map
|
|
@@ -1837,7 +2115,11 @@ class Client extends openapi_core_1.default {
|
|
|
1837
2115
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetMemoryResponse({}));
|
|
1838
2116
|
}
|
|
1839
2117
|
/**
|
|
1840
|
-
*
|
|
2118
|
+
* Retrieves the description of a specified long-term memory.
|
|
2119
|
+
*
|
|
2120
|
+
* @remarks
|
|
2121
|
+
* - This operation is idempotent.
|
|
2122
|
+
* **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
2123
|
*
|
|
1842
2124
|
* @param request - GetMemoryRequest
|
|
1843
2125
|
* @returns GetMemoryResponse
|
|
@@ -1848,7 +2130,7 @@ class Client extends openapi_core_1.default {
|
|
|
1848
2130
|
return await this.getMemoryWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
1849
2131
|
}
|
|
1850
2132
|
/**
|
|
1851
|
-
*
|
|
2133
|
+
* Retrieves a memory fragment.
|
|
1852
2134
|
*
|
|
1853
2135
|
* @param request - GetMemoryNodeRequest
|
|
1854
2136
|
* @param headers - map
|
|
@@ -1874,7 +2156,7 @@ class Client extends openapi_core_1.default {
|
|
|
1874
2156
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetMemoryNodeResponse({}));
|
|
1875
2157
|
}
|
|
1876
2158
|
/**
|
|
1877
|
-
*
|
|
2159
|
+
* Retrieves a memory fragment.
|
|
1878
2160
|
*
|
|
1879
2161
|
* @param request - GetMemoryNodeRequest
|
|
1880
2162
|
* @returns GetMemoryNodeResponse
|
|
@@ -1887,6 +2169,12 @@ class Client extends openapi_core_1.default {
|
|
|
1887
2169
|
/**
|
|
1888
2170
|
* Queries the data parsing settings in a specified category.
|
|
1889
2171
|
*
|
|
2172
|
+
* @remarks
|
|
2173
|
+
* - 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)来调用本接口。
|
|
2174
|
+
* - 本接口具有幂等性。
|
|
2175
|
+
* **限流说明:**
|
|
2176
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
2177
|
+
*
|
|
1890
2178
|
* @param request - GetParseSettingsRequest
|
|
1891
2179
|
* @param headers - map
|
|
1892
2180
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1918,6 +2206,12 @@ class Client extends openapi_core_1.default {
|
|
|
1918
2206
|
/**
|
|
1919
2207
|
* Queries the data parsing settings in a specified category.
|
|
1920
2208
|
*
|
|
2209
|
+
* @remarks
|
|
2210
|
+
* - 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)来调用本接口。
|
|
2211
|
+
* - 本接口具有幂等性。
|
|
2212
|
+
* **限流说明:**
|
|
2213
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
2214
|
+
*
|
|
1921
2215
|
* @param request - GetParseSettingsRequest
|
|
1922
2216
|
* @returns GetParseSettingsResponse
|
|
1923
2217
|
*/
|
|
@@ -2058,7 +2352,14 @@ class Client extends openapi_core_1.default {
|
|
|
2058
2352
|
return await this.highCodeDeployWithOptions(workspaceId, request, headers, runtime);
|
|
2059
2353
|
}
|
|
2060
2354
|
/**
|
|
2061
|
-
*
|
|
2355
|
+
* Retrieves the details of one or more categories in a specified workspace.
|
|
2356
|
+
*
|
|
2357
|
+
* @remarks
|
|
2358
|
+
* - This API does not support querying data tables.
|
|
2359
|
+
* - 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).
|
|
2360
|
+
* - 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.
|
|
2361
|
+
* - This operation is idempotent.
|
|
2362
|
+
* **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
2363
|
*
|
|
2063
2364
|
* @param request - ListCategoryRequest
|
|
2064
2365
|
* @param headers - map
|
|
@@ -2104,7 +2405,14 @@ class Client extends openapi_core_1.default {
|
|
|
2104
2405
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListCategoryResponse({}));
|
|
2105
2406
|
}
|
|
2106
2407
|
/**
|
|
2107
|
-
*
|
|
2408
|
+
* Retrieves the details of one or more categories in a specified workspace.
|
|
2409
|
+
*
|
|
2410
|
+
* @remarks
|
|
2411
|
+
* - This API does not support querying data tables.
|
|
2412
|
+
* - 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).
|
|
2413
|
+
* - 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.
|
|
2414
|
+
* - This operation is idempotent.
|
|
2415
|
+
* **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
2416
|
*
|
|
2109
2417
|
* @param request - ListCategoryRequest
|
|
2110
2418
|
* @returns ListCategoryResponse
|
|
@@ -2115,11 +2423,15 @@ class Client extends openapi_core_1.default {
|
|
|
2115
2423
|
return await this.listCategoryWithOptions(WorkspaceId, request, headers, runtime);
|
|
2116
2424
|
}
|
|
2117
2425
|
/**
|
|
2118
|
-
*
|
|
2426
|
+
* Queries the list and information of text chunks.
|
|
2119
2427
|
*
|
|
2120
2428
|
* @remarks
|
|
2121
|
-
*
|
|
2122
|
-
*
|
|
2429
|
+
* - 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.
|
|
2430
|
+
* - 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.
|
|
2431
|
+
* - 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).
|
|
2432
|
+
* - This operation has idempotence.
|
|
2433
|
+
* **Rate limit:**
|
|
2434
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2123
2435
|
*
|
|
2124
2436
|
* @param request - ListChunksRequest
|
|
2125
2437
|
* @param headers - map
|
|
@@ -2165,11 +2477,15 @@ class Client extends openapi_core_1.default {
|
|
|
2165
2477
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListChunksResponse({}));
|
|
2166
2478
|
}
|
|
2167
2479
|
/**
|
|
2168
|
-
*
|
|
2480
|
+
* Queries the list and information of text chunks.
|
|
2169
2481
|
*
|
|
2170
2482
|
* @remarks
|
|
2171
|
-
*
|
|
2172
|
-
*
|
|
2483
|
+
* - 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.
|
|
2484
|
+
* - 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.
|
|
2485
|
+
* - 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).
|
|
2486
|
+
* - This operation has idempotence.
|
|
2487
|
+
* **Rate limit:**
|
|
2488
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2173
2489
|
*
|
|
2174
2490
|
* @param request - ListChunksRequest
|
|
2175
2491
|
* @returns ListChunksResponse
|
|
@@ -2180,13 +2496,14 @@ class Client extends openapi_core_1.default {
|
|
|
2180
2496
|
return await this.listChunksWithOptions(WorkspaceId, request, headers, runtime);
|
|
2181
2497
|
}
|
|
2182
2498
|
/**
|
|
2183
|
-
*
|
|
2499
|
+
* Retrieves the details of one or more documents in a specified category.
|
|
2184
2500
|
*
|
|
2185
2501
|
* @remarks
|
|
2186
|
-
*
|
|
2187
|
-
*
|
|
2188
|
-
*
|
|
2189
|
-
* **
|
|
2502
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
2503
|
+
* - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
|
|
2504
|
+
* - This operation is idempotent.
|
|
2505
|
+
* **Rate limit:**
|
|
2506
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
2190
2507
|
*
|
|
2191
2508
|
* @param tmpReq - ListFileRequest
|
|
2192
2509
|
* @param headers - map
|
|
@@ -2234,13 +2551,14 @@ class Client extends openapi_core_1.default {
|
|
|
2234
2551
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListFileResponse({}));
|
|
2235
2552
|
}
|
|
2236
2553
|
/**
|
|
2237
|
-
*
|
|
2554
|
+
* Retrieves the details of one or more documents in a specified category.
|
|
2238
2555
|
*
|
|
2239
2556
|
* @remarks
|
|
2240
|
-
*
|
|
2241
|
-
*
|
|
2242
|
-
*
|
|
2243
|
-
* **
|
|
2557
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
2558
|
+
* - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
|
|
2559
|
+
* - This operation is idempotent.
|
|
2560
|
+
* **Rate limit:**
|
|
2561
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
2244
2562
|
*
|
|
2245
2563
|
* @param request - ListFileRequest
|
|
2246
2564
|
* @returns ListFileResponse
|
|
@@ -2251,11 +2569,14 @@ class Client extends openapi_core_1.default {
|
|
|
2251
2569
|
return await this.listFileWithOptions(WorkspaceId, request, headers, runtime);
|
|
2252
2570
|
}
|
|
2253
2571
|
/**
|
|
2254
|
-
*
|
|
2572
|
+
* Retrieves files and their summary information from a specified knowledge base.
|
|
2255
2573
|
*
|
|
2256
2574
|
* @remarks
|
|
2257
|
-
*
|
|
2258
|
-
*
|
|
2575
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2576
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2577
|
+
* - This operation has idempotence.
|
|
2578
|
+
* **Throttling:**
|
|
2579
|
+
* This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
2259
2580
|
*
|
|
2260
2581
|
* @param request - ListIndexDocumentsRequest
|
|
2261
2582
|
* @param headers - map
|
|
@@ -2301,11 +2622,14 @@ class Client extends openapi_core_1.default {
|
|
|
2301
2622
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexDocumentsResponse({}));
|
|
2302
2623
|
}
|
|
2303
2624
|
/**
|
|
2304
|
-
*
|
|
2625
|
+
* Retrieves files and their summary information from a specified knowledge base.
|
|
2305
2626
|
*
|
|
2306
2627
|
* @remarks
|
|
2307
|
-
*
|
|
2308
|
-
*
|
|
2628
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2629
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2630
|
+
* - This operation has idempotence.
|
|
2631
|
+
* **Throttling:**
|
|
2632
|
+
* This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
2309
2633
|
*
|
|
2310
2634
|
* @param request - ListIndexDocumentsRequest
|
|
2311
2635
|
* @returns ListIndexDocumentsResponse
|
|
@@ -2316,7 +2640,12 @@ class Client extends openapi_core_1.default {
|
|
|
2316
2640
|
return await this.listIndexDocumentsWithOptions(WorkspaceId, request, headers, runtime);
|
|
2317
2641
|
}
|
|
2318
2642
|
/**
|
|
2319
|
-
*
|
|
2643
|
+
* Retrieves the files in a specified knowledge base along with their details.
|
|
2644
|
+
*
|
|
2645
|
+
* @remarks
|
|
2646
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2647
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2648
|
+
* - This operation has idempotence.
|
|
2320
2649
|
*
|
|
2321
2650
|
* @param request - ListIndexFileDetailsRequest
|
|
2322
2651
|
* @param headers - map
|
|
@@ -2362,7 +2691,12 @@ class Client extends openapi_core_1.default {
|
|
|
2362
2691
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexFileDetailsResponse({}));
|
|
2363
2692
|
}
|
|
2364
2693
|
/**
|
|
2365
|
-
*
|
|
2694
|
+
* Retrieves the files in a specified knowledge base along with their details.
|
|
2695
|
+
*
|
|
2696
|
+
* @remarks
|
|
2697
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
2698
|
+
* - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
|
|
2699
|
+
* - This operation has idempotence.
|
|
2366
2700
|
*
|
|
2367
2701
|
* @param request - ListIndexFileDetailsRequest
|
|
2368
2702
|
* @returns ListIndexFileDetailsResponse
|
|
@@ -2373,10 +2707,13 @@ class Client extends openapi_core_1.default {
|
|
|
2373
2707
|
return await this.listIndexFileDetailsWithOptions(WorkspaceId, request, headers, runtime);
|
|
2374
2708
|
}
|
|
2375
2709
|
/**
|
|
2376
|
-
*
|
|
2710
|
+
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2377
2711
|
*
|
|
2378
2712
|
* @remarks
|
|
2379
|
-
*
|
|
2713
|
+
* - 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.
|
|
2714
|
+
* - This operation is idempotent.
|
|
2715
|
+
* **Rate limit:**
|
|
2716
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2380
2717
|
*
|
|
2381
2718
|
* @param request - ListIndicesRequest
|
|
2382
2719
|
* @param headers - map
|
|
@@ -2413,10 +2750,13 @@ class Client extends openapi_core_1.default {
|
|
|
2413
2750
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndicesResponse({}));
|
|
2414
2751
|
}
|
|
2415
2752
|
/**
|
|
2416
|
-
*
|
|
2753
|
+
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2417
2754
|
*
|
|
2418
2755
|
* @remarks
|
|
2419
|
-
*
|
|
2756
|
+
* - 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.
|
|
2757
|
+
* - This operation is idempotent.
|
|
2758
|
+
* **Rate limit:**
|
|
2759
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2420
2760
|
*
|
|
2421
2761
|
* @param request - ListIndicesRequest
|
|
2422
2762
|
* @returns ListIndicesResponse
|
|
@@ -2427,7 +2767,12 @@ class Client extends openapi_core_1.default {
|
|
|
2427
2767
|
return await this.listIndicesWithOptions(WorkspaceId, request, headers, runtime);
|
|
2428
2768
|
}
|
|
2429
2769
|
/**
|
|
2430
|
-
*
|
|
2770
|
+
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
2771
|
+
*
|
|
2772
|
+
* @remarks
|
|
2773
|
+
* - 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.
|
|
2774
|
+
* - This operation supports idempotence.
|
|
2775
|
+
* **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
2776
|
*
|
|
2432
2777
|
* @param request - ListMemoriesRequest
|
|
2433
2778
|
* @param headers - map
|
|
@@ -2461,7 +2806,12 @@ class Client extends openapi_core_1.default {
|
|
|
2461
2806
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemoriesResponse({}));
|
|
2462
2807
|
}
|
|
2463
2808
|
/**
|
|
2464
|
-
*
|
|
2809
|
+
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
2810
|
+
*
|
|
2811
|
+
* @remarks
|
|
2812
|
+
* - 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.
|
|
2813
|
+
* - This operation supports idempotence.
|
|
2814
|
+
* **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
2815
|
*
|
|
2466
2816
|
* @param request - ListMemoriesRequest
|
|
2467
2817
|
* @returns ListMemoriesResponse
|
|
@@ -2472,7 +2822,7 @@ class Client extends openapi_core_1.default {
|
|
|
2472
2822
|
return await this.listMemoriesWithOptions(workspaceId, request, headers, runtime);
|
|
2473
2823
|
}
|
|
2474
2824
|
/**
|
|
2475
|
-
*
|
|
2825
|
+
* Retrieves a list of memory nodes.
|
|
2476
2826
|
*
|
|
2477
2827
|
* @param request - ListMemoryNodesRequest
|
|
2478
2828
|
* @param headers - map
|
|
@@ -2506,7 +2856,7 @@ class Client extends openapi_core_1.default {
|
|
|
2506
2856
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMemoryNodesResponse({}));
|
|
2507
2857
|
}
|
|
2508
2858
|
/**
|
|
2509
|
-
*
|
|
2859
|
+
* Retrieves a list of memory nodes.
|
|
2510
2860
|
*
|
|
2511
2861
|
* @param request - ListMemoryNodesRequest
|
|
2512
2862
|
* @returns ListMemoryNodesResponse
|
|
@@ -2613,12 +2963,23 @@ class Client extends openapi_core_1.default {
|
|
|
2613
2963
|
return await this.listPublishedAgentWithOptions(workspaceId, request, headers, runtime);
|
|
2614
2964
|
}
|
|
2615
2965
|
/**
|
|
2616
|
-
*
|
|
2966
|
+
* Retrieves information from a specified knowledge base.
|
|
2617
2967
|
*
|
|
2618
2968
|
* @remarks
|
|
2619
|
-
*
|
|
2620
|
-
*
|
|
2621
|
-
*
|
|
2969
|
+
* <props="china">
|
|
2970
|
+
* - **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.
|
|
2971
|
+
* - **Required permissions**:
|
|
2972
|
+
* - **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.
|
|
2973
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
2974
|
+
* - **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.
|
|
2975
|
+
* - **Idempotency**: This API is idempotent.
|
|
2976
|
+
* <props="intl">
|
|
2977
|
+
* - **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.
|
|
2978
|
+
* - **Required permissions**:
|
|
2979
|
+
* - **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.
|
|
2980
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
2981
|
+
* - **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.
|
|
2982
|
+
* - **Idempotency**: This API is idempotent.
|
|
2622
2983
|
*
|
|
2623
2984
|
* @param tmpReq - RetrieveRequest
|
|
2624
2985
|
* @param headers - map
|
|
@@ -2711,12 +3072,23 @@ class Client extends openapi_core_1.default {
|
|
|
2711
3072
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.RetrieveResponse({}));
|
|
2712
3073
|
}
|
|
2713
3074
|
/**
|
|
2714
|
-
*
|
|
3075
|
+
* Retrieves information from a specified knowledge base.
|
|
2715
3076
|
*
|
|
2716
3077
|
* @remarks
|
|
2717
|
-
*
|
|
2718
|
-
*
|
|
2719
|
-
*
|
|
3078
|
+
* <props="china">
|
|
3079
|
+
* - **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.
|
|
3080
|
+
* - **Required permissions**:
|
|
3081
|
+
* - **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.
|
|
3082
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
3083
|
+
* - **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.
|
|
3084
|
+
* - **Idempotency**: This API is idempotent.
|
|
3085
|
+
* <props="intl">
|
|
3086
|
+
* - **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.
|
|
3087
|
+
* - **Required permissions**:
|
|
3088
|
+
* - **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.
|
|
3089
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
3090
|
+
* - **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.
|
|
3091
|
+
* - **Idempotency**: This API is idempotent.
|
|
2720
3092
|
*
|
|
2721
3093
|
* @param request - RetrieveRequest
|
|
2722
3094
|
* @returns RetrieveResponse
|
|
@@ -2727,13 +3099,19 @@ class Client extends openapi_core_1.default {
|
|
|
2727
3099
|
return await this.retrieveWithOptions(WorkspaceId, request, headers, runtime);
|
|
2728
3100
|
}
|
|
2729
3101
|
/**
|
|
2730
|
-
* Adds parsed
|
|
3102
|
+
* Adds parsed files to the specified knowledge base.
|
|
2731
3103
|
*
|
|
2732
3104
|
* @remarks
|
|
2733
|
-
*
|
|
2734
|
-
*
|
|
2735
|
-
*
|
|
2736
|
-
*
|
|
3105
|
+
* <props="china">
|
|
3106
|
+
* - 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.
|
|
3107
|
+
* <props="intl">
|
|
3108
|
+
* - 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.
|
|
3109
|
+
* - 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.
|
|
3110
|
+
* - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
|
|
3111
|
+
* - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
|
|
3112
|
+
* - 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.
|
|
3113
|
+
* - 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.
|
|
3114
|
+
* **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
|
|
2737
3115
|
*
|
|
2738
3116
|
* @param tmpReq - SubmitIndexAddDocumentsJobRequest
|
|
2739
3117
|
* @param headers - map
|
|
@@ -2802,13 +3180,19 @@ class Client extends openapi_core_1.default {
|
|
|
2802
3180
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.SubmitIndexAddDocumentsJobResponse({}));
|
|
2803
3181
|
}
|
|
2804
3182
|
/**
|
|
2805
|
-
* Adds parsed
|
|
3183
|
+
* Adds parsed files to the specified knowledge base.
|
|
2806
3184
|
*
|
|
2807
3185
|
* @remarks
|
|
2808
|
-
*
|
|
2809
|
-
*
|
|
2810
|
-
*
|
|
2811
|
-
*
|
|
3186
|
+
* <props="china">
|
|
3187
|
+
* - 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.
|
|
3188
|
+
* <props="intl">
|
|
3189
|
+
* - 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.
|
|
3190
|
+
* - 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.
|
|
3191
|
+
* - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
|
|
3192
|
+
* - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
|
|
3193
|
+
* - 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.
|
|
3194
|
+
* - 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.
|
|
3195
|
+
* **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
|
|
2812
3196
|
*
|
|
2813
3197
|
* @param request - SubmitIndexAddDocumentsJobRequest
|
|
2814
3198
|
* @returns SubmitIndexAddDocumentsJobResponse
|
|
@@ -2819,13 +3203,16 @@ class Client extends openapi_core_1.default {
|
|
|
2819
3203
|
return await this.submitIndexAddDocumentsJobWithOptions(WorkspaceId, request, headers, runtime);
|
|
2820
3204
|
}
|
|
2821
3205
|
/**
|
|
2822
|
-
* Submits a specified CreateIndex
|
|
3206
|
+
* Submits a specified CreateIndex task to complete knowledge base creation.
|
|
2823
3207
|
*
|
|
2824
3208
|
* @remarks
|
|
2825
|
-
*
|
|
2826
|
-
*
|
|
2827
|
-
*
|
|
2828
|
-
*
|
|
3209
|
+
* - 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.
|
|
3210
|
+
* - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
|
|
3211
|
+
* - 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.
|
|
3212
|
+
* - 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.
|
|
3213
|
+
* - This operation does not support idempotence.
|
|
3214
|
+
* **Rate limit:**
|
|
3215
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2829
3216
|
*
|
|
2830
3217
|
* @param request - SubmitIndexJobRequest
|
|
2831
3218
|
* @param headers - map
|
|
@@ -2856,13 +3243,16 @@ class Client extends openapi_core_1.default {
|
|
|
2856
3243
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.SubmitIndexJobResponse({}));
|
|
2857
3244
|
}
|
|
2858
3245
|
/**
|
|
2859
|
-
* Submits a specified CreateIndex
|
|
3246
|
+
* Submits a specified CreateIndex task to complete knowledge base creation.
|
|
2860
3247
|
*
|
|
2861
3248
|
* @remarks
|
|
2862
|
-
*
|
|
2863
|
-
*
|
|
2864
|
-
*
|
|
2865
|
-
*
|
|
3249
|
+
* - 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.
|
|
3250
|
+
* - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
|
|
3251
|
+
* - 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.
|
|
3252
|
+
* - 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.
|
|
3253
|
+
* - This operation does not support idempotence.
|
|
3254
|
+
* **Rate limit:**
|
|
3255
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
2866
3256
|
*
|
|
2867
3257
|
* @param request - SubmitIndexJobRequest
|
|
2868
3258
|
* @returns SubmitIndexJobResponse
|
|
@@ -2997,17 +3387,18 @@ class Client extends openapi_core_1.default {
|
|
|
2997
3387
|
return await this.updateAndPublishAgentSelectiveWithOptions(workspaceId, appCode, request, headers, runtime);
|
|
2998
3388
|
}
|
|
2999
3389
|
/**
|
|
3000
|
-
* Modifies the content and title of a specified text chunk in
|
|
3390
|
+
* 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
3391
|
*
|
|
3002
3392
|
* @remarks
|
|
3003
|
-
*
|
|
3004
|
-
*
|
|
3005
|
-
*
|
|
3006
|
-
*
|
|
3007
|
-
*
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
3010
|
-
* **Rate limit:**
|
|
3393
|
+
* - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
|
|
3394
|
+
* - **Permission requirements**:
|
|
3395
|
+
* - **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).
|
|
3396
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
3397
|
+
* - **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.
|
|
3398
|
+
* - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
|
|
3399
|
+
* - **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.
|
|
3400
|
+
* **Rate limit:**
|
|
3401
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
3011
3402
|
*
|
|
3012
3403
|
* @param request - UpdateChunkRequest
|
|
3013
3404
|
* @param headers - map
|
|
@@ -3053,17 +3444,18 @@ class Client extends openapi_core_1.default {
|
|
|
3053
3444
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateChunkResponse({}));
|
|
3054
3445
|
}
|
|
3055
3446
|
/**
|
|
3056
|
-
* Modifies the content and title of a specified text chunk in
|
|
3447
|
+
* 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
3448
|
*
|
|
3058
3449
|
* @remarks
|
|
3059
|
-
*
|
|
3060
|
-
*
|
|
3061
|
-
*
|
|
3062
|
-
*
|
|
3063
|
-
*
|
|
3064
|
-
*
|
|
3065
|
-
*
|
|
3066
|
-
* **Rate limit:**
|
|
3450
|
+
* - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
|
|
3451
|
+
* - **Permission requirements**:
|
|
3452
|
+
* - **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).
|
|
3453
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
3454
|
+
* - **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.
|
|
3455
|
+
* - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
|
|
3456
|
+
* - **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.
|
|
3457
|
+
* **Rate limit:**
|
|
3458
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
3067
3459
|
*
|
|
3068
3460
|
* @param request - UpdateChunkRequest
|
|
3069
3461
|
* @returns UpdateChunkResponse
|
|
@@ -3074,7 +3466,12 @@ class Client extends openapi_core_1.default {
|
|
|
3074
3466
|
return await this.updateChunkWithOptions(WorkspaceId, request, headers, runtime);
|
|
3075
3467
|
}
|
|
3076
3468
|
/**
|
|
3077
|
-
*
|
|
3469
|
+
* Updates a connector.
|
|
3470
|
+
*
|
|
3471
|
+
* @remarks
|
|
3472
|
+
* - 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.
|
|
3473
|
+
* - This operation is not idempotent.
|
|
3474
|
+
* **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
3475
|
*
|
|
3079
3476
|
* @param request - UpdateConnectorRequest
|
|
3080
3477
|
* @param headers - map
|
|
@@ -3108,7 +3505,12 @@ class Client extends openapi_core_1.default {
|
|
|
3108
3505
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateConnectorResponse({}));
|
|
3109
3506
|
}
|
|
3110
3507
|
/**
|
|
3111
|
-
*
|
|
3508
|
+
* Updates a connector.
|
|
3509
|
+
*
|
|
3510
|
+
* @remarks
|
|
3511
|
+
* - 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.
|
|
3512
|
+
* - This operation is not idempotent.
|
|
3513
|
+
* **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
3514
|
*
|
|
3113
3515
|
* @param request - UpdateConnectorRequest
|
|
3114
3516
|
* @returns UpdateConnectorResponse
|
|
@@ -3119,7 +3521,11 @@ class Client extends openapi_core_1.default {
|
|
|
3119
3521
|
return await this.updateConnectorWithOptions(WorkspaceId, ConnectorId, request, headers, runtime);
|
|
3120
3522
|
}
|
|
3121
3523
|
/**
|
|
3122
|
-
* Updates the tags
|
|
3524
|
+
* Updates the tags for a specified file.
|
|
3525
|
+
*
|
|
3526
|
+
* @remarks
|
|
3527
|
+
* - 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.
|
|
3528
|
+
* **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
3123
3529
|
*
|
|
3124
3530
|
* @param tmpReq - UpdateFileTagRequest
|
|
3125
3531
|
* @param headers - map
|
|
@@ -3155,7 +3561,11 @@ class Client extends openapi_core_1.default {
|
|
|
3155
3561
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateFileTagResponse({}));
|
|
3156
3562
|
}
|
|
3157
3563
|
/**
|
|
3158
|
-
* Updates the tags
|
|
3564
|
+
* Updates the tags for a specified file.
|
|
3565
|
+
*
|
|
3566
|
+
* @remarks
|
|
3567
|
+
* - 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.
|
|
3568
|
+
* **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
3159
3569
|
*
|
|
3160
3570
|
* @param request - UpdateFileTagRequest
|
|
3161
3571
|
* @returns UpdateFileTagResponse
|
|
@@ -3166,7 +3576,13 @@ class Client extends openapi_core_1.default {
|
|
|
3166
3576
|
return await this.updateFileTagWithOptions(WorkspaceId, FileId, request, headers, runtime);
|
|
3167
3577
|
}
|
|
3168
3578
|
/**
|
|
3169
|
-
*
|
|
3579
|
+
* Updates the configuration of a specified knowledge base.
|
|
3580
|
+
*
|
|
3581
|
+
* @remarks
|
|
3582
|
+
* <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
|
|
3583
|
+
* 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).
|
|
3584
|
+
* 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.
|
|
3585
|
+
* This operation is idempotent.
|
|
3170
3586
|
*
|
|
3171
3587
|
* @param request - UpdateIndexRequest
|
|
3172
3588
|
* @param headers - map
|
|
@@ -3218,7 +3634,13 @@ class Client extends openapi_core_1.default {
|
|
|
3218
3634
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateIndexResponse({}));
|
|
3219
3635
|
}
|
|
3220
3636
|
/**
|
|
3221
|
-
*
|
|
3637
|
+
* Updates the configuration of a specified knowledge base.
|
|
3638
|
+
*
|
|
3639
|
+
* @remarks
|
|
3640
|
+
* <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
|
|
3641
|
+
* 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).
|
|
3642
|
+
* 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.
|
|
3643
|
+
* This operation is idempotent.
|
|
3222
3644
|
*
|
|
3223
3645
|
* @param request - UpdateIndexRequest
|
|
3224
3646
|
* @returns UpdateIndexResponse
|
|
@@ -3229,7 +3651,11 @@ class Client extends openapi_core_1.default {
|
|
|
3229
3651
|
return await this.updateIndexWithOptions(WorkspaceId, request, headers, runtime);
|
|
3230
3652
|
}
|
|
3231
3653
|
/**
|
|
3232
|
-
*
|
|
3654
|
+
* Updates the description of a specified long-term memory.
|
|
3655
|
+
*
|
|
3656
|
+
* @remarks
|
|
3657
|
+
* - This operation is idempotent.
|
|
3658
|
+
* **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
3659
|
*
|
|
3234
3660
|
* @param request - UpdateMemoryRequest
|
|
3235
3661
|
* @param headers - map
|
|
@@ -3260,7 +3686,11 @@ class Client extends openapi_core_1.default {
|
|
|
3260
3686
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateMemoryResponse({}));
|
|
3261
3687
|
}
|
|
3262
3688
|
/**
|
|
3263
|
-
*
|
|
3689
|
+
* Updates the description of a specified long-term memory.
|
|
3690
|
+
*
|
|
3691
|
+
* @remarks
|
|
3692
|
+
* - This operation is idempotent.
|
|
3693
|
+
* **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
3694
|
*
|
|
3265
3695
|
* @param request - UpdateMemoryRequest
|
|
3266
3696
|
* @returns UpdateMemoryResponse
|
|
@@ -3271,7 +3701,7 @@ class Client extends openapi_core_1.default {
|
|
|
3271
3701
|
return await this.updateMemoryWithOptions(workspaceId, memoryId, request, headers, runtime);
|
|
3272
3702
|
}
|
|
3273
3703
|
/**
|
|
3274
|
-
*
|
|
3704
|
+
* Updates a memory fragment.
|
|
3275
3705
|
*
|
|
3276
3706
|
* @param request - UpdateMemoryNodeRequest
|
|
3277
3707
|
* @param headers - map
|
|
@@ -3302,7 +3732,7 @@ class Client extends openapi_core_1.default {
|
|
|
3302
3732
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateMemoryNodeResponse({}));
|
|
3303
3733
|
}
|
|
3304
3734
|
/**
|
|
3305
|
-
*
|
|
3735
|
+
* Updates a memory fragment.
|
|
3306
3736
|
*
|
|
3307
3737
|
* @param request - UpdateMemoryNodeRequest
|
|
3308
3738
|
* @returns UpdateMemoryNodeResponse
|
|
@@ -3358,7 +3788,15 @@ class Client extends openapi_core_1.default {
|
|
|
3358
3788
|
return await this.updatePromptTemplateWithOptions(workspaceId, promptTemplateId, request, headers, runtime);
|
|
3359
3789
|
}
|
|
3360
3790
|
/**
|
|
3361
|
-
*
|
|
3791
|
+
* Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
|
|
3792
|
+
*
|
|
3793
|
+
* @remarks
|
|
3794
|
+
* - 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).
|
|
3795
|
+
* - 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.
|
|
3796
|
+
* - 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).
|
|
3797
|
+
* - 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).
|
|
3798
|
+
* - This operation is not idempotent.
|
|
3799
|
+
* **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
3800
|
*
|
|
3363
3801
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
3364
3802
|
* @param headers - map
|
|
@@ -3398,7 +3836,15 @@ class Client extends openapi_core_1.default {
|
|
|
3398
3836
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateTableFromAuthorizedOssResponse({}));
|
|
3399
3837
|
}
|
|
3400
3838
|
/**
|
|
3401
|
-
*
|
|
3839
|
+
* Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
|
|
3840
|
+
*
|
|
3841
|
+
* @remarks
|
|
3842
|
+
* - 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).
|
|
3843
|
+
* - 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.
|
|
3844
|
+
* - 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).
|
|
3845
|
+
* - 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).
|
|
3846
|
+
* - This operation is not idempotent.
|
|
3847
|
+
* **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
3848
|
*
|
|
3403
3849
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
3404
3850
|
* @returns UpdateTableFromAuthorizedOssResponse
|