@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.d.ts
CHANGED
|
@@ -9,14 +9,13 @@ export default class Client extends OpenApi {
|
|
|
9
9
|
[key: string]: string;
|
|
10
10
|
}, endpoint: string): string;
|
|
11
11
|
/**
|
|
12
|
-
* Creates a category in
|
|
12
|
+
* Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* **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.
|
|
15
|
+
* - 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.
|
|
16
|
+
* - 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).
|
|
17
|
+
* - This operation is not idempotent.
|
|
18
|
+
* **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.
|
|
20
19
|
*
|
|
21
20
|
* @param request - AddCategoryRequest
|
|
22
21
|
* @param headers - map
|
|
@@ -27,21 +26,62 @@ export default class Client extends OpenApi {
|
|
|
27
26
|
[key: string]: string;
|
|
28
27
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddCategoryResponse>;
|
|
29
28
|
/**
|
|
30
|
-
* Creates a category in
|
|
29
|
+
* Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
|
|
31
30
|
*
|
|
32
31
|
* @remarks
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* **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.
|
|
32
|
+
* - 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.
|
|
33
|
+
* - 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).
|
|
34
|
+
* - This operation is not idempotent.
|
|
35
|
+
* **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.
|
|
38
36
|
*
|
|
39
37
|
* @param request - AddCategoryRequest
|
|
40
38
|
* @returns AddCategoryResponse
|
|
41
39
|
*/
|
|
42
40
|
addCategory(WorkspaceId: string, request: $_model.AddCategoryRequest): Promise<$_model.AddCategoryResponse>;
|
|
43
41
|
/**
|
|
44
|
-
*
|
|
42
|
+
* Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* - 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).
|
|
46
|
+
* - 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.
|
|
47
|
+
* - 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).
|
|
48
|
+
* - This operation has idempotence.
|
|
49
|
+
* **Related operations:**
|
|
50
|
+
* **Throttling:**
|
|
51
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
52
|
+
*
|
|
53
|
+
* @param tmpReq - AddChunkRequest
|
|
54
|
+
* @param headers - map
|
|
55
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
56
|
+
* @returns AddChunkResponse
|
|
57
|
+
*/
|
|
58
|
+
addChunkWithOptions(WorkspaceId: string, tmpReq: $_model.AddChunkRequest, headers: {
|
|
59
|
+
[key: string]: string;
|
|
60
|
+
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddChunkResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* - 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).
|
|
66
|
+
* - 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.
|
|
67
|
+
* - 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).
|
|
68
|
+
* - This operation has idempotence.
|
|
69
|
+
* **Related operations:**
|
|
70
|
+
* **Throttling:**
|
|
71
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
72
|
+
*
|
|
73
|
+
* @param request - AddChunkRequest
|
|
74
|
+
* @returns AddChunkResponse
|
|
75
|
+
*/
|
|
76
|
+
addChunk(WorkspaceId: string, request: $_model.AddChunkRequest): Promise<$_model.AddChunkResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* Creates a connector. This API currently supports only file connectors.
|
|
79
|
+
*
|
|
80
|
+
* @remarks
|
|
81
|
+
* - 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.
|
|
82
|
+
* - This operation is not idempotent.
|
|
83
|
+
* **Throttling:**
|
|
84
|
+
* Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
45
85
|
*
|
|
46
86
|
* @param tmpReq - AddConnectorRequest
|
|
47
87
|
* @param headers - map
|
|
@@ -52,21 +92,26 @@ export default class Client extends OpenApi {
|
|
|
52
92
|
[key: string]: string;
|
|
53
93
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddConnectorResponse>;
|
|
54
94
|
/**
|
|
55
|
-
*
|
|
95
|
+
* Creates a connector. This API currently supports only file connectors.
|
|
96
|
+
*
|
|
97
|
+
* @remarks
|
|
98
|
+
* - 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.
|
|
99
|
+
* - This operation is not idempotent.
|
|
100
|
+
* **Throttling:**
|
|
101
|
+
* Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
56
102
|
*
|
|
57
103
|
* @param request - AddConnectorRequest
|
|
58
104
|
* @returns AddConnectorResponse
|
|
59
105
|
*/
|
|
60
106
|
addConnector(WorkspaceId: string, request: $_model.AddConnectorRequest): Promise<$_model.AddConnectorResponse>;
|
|
61
107
|
/**
|
|
62
|
-
* Imports
|
|
108
|
+
* 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).
|
|
63
109
|
*
|
|
64
110
|
* @remarks
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* * This interface is not idempotent.
|
|
111
|
+
* - 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).
|
|
112
|
+
* - This operation is not idempotent.
|
|
113
|
+
* **Throttling:**
|
|
114
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
70
115
|
*
|
|
71
116
|
* @param tmpReq - AddFileRequest
|
|
72
117
|
* @param headers - map
|
|
@@ -77,21 +122,30 @@ export default class Client extends OpenApi {
|
|
|
77
122
|
[key: string]: string;
|
|
78
123
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddFileResponse>;
|
|
79
124
|
/**
|
|
80
|
-
* Imports
|
|
125
|
+
* 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).
|
|
81
126
|
*
|
|
82
127
|
* @remarks
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* * This interface is not idempotent.
|
|
128
|
+
* - 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).
|
|
129
|
+
* - This operation is not idempotent.
|
|
130
|
+
* **Throttling:**
|
|
131
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
88
132
|
*
|
|
89
133
|
* @param request - AddFileRequest
|
|
90
134
|
* @returns AddFileResponse
|
|
91
135
|
*/
|
|
92
136
|
addFile(WorkspaceId: string, request: $_model.AddFileRequest): Promise<$_model.AddFileResponse>;
|
|
93
137
|
/**
|
|
94
|
-
*
|
|
138
|
+
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
139
|
+
*
|
|
140
|
+
* @remarks
|
|
141
|
+
* - 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).
|
|
142
|
+
*
|
|
143
|
+
* - 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.
|
|
144
|
+
* - 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).
|
|
145
|
+
* - 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).
|
|
146
|
+
* - This operation does not have idempotence.
|
|
147
|
+
* **Rate limit:**
|
|
148
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
95
149
|
*
|
|
96
150
|
* @param tmpReq - AddFilesFromAuthorizedOssRequest
|
|
97
151
|
* @param headers - map
|
|
@@ -102,14 +156,30 @@ export default class Client extends OpenApi {
|
|
|
102
156
|
[key: string]: string;
|
|
103
157
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
|
|
104
158
|
/**
|
|
105
|
-
*
|
|
159
|
+
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
160
|
+
*
|
|
161
|
+
* @remarks
|
|
162
|
+
* - 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).
|
|
163
|
+
*
|
|
164
|
+
* - 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.
|
|
165
|
+
* - 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).
|
|
166
|
+
* - 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).
|
|
167
|
+
* - This operation does not have idempotence.
|
|
168
|
+
* **Rate limit:**
|
|
169
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
106
170
|
*
|
|
107
171
|
* @param request - AddFilesFromAuthorizedOssRequest
|
|
108
172
|
* @returns AddFilesFromAuthorizedOssResponse
|
|
109
173
|
*/
|
|
110
174
|
addFilesFromAuthorizedOss(WorkspaceId: string, request: $_model.AddFilesFromAuthorizedOssRequest): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
|
|
111
175
|
/**
|
|
112
|
-
*
|
|
176
|
+
* Add a table for the table data connector.
|
|
177
|
+
*
|
|
178
|
+
* @remarks
|
|
179
|
+
* - 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).
|
|
180
|
+
* - This API is not idempotent.
|
|
181
|
+
* **Throttling:**
|
|
182
|
+
* This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
|
|
113
183
|
*
|
|
114
184
|
* @param tmpReq - AddTableRequest
|
|
115
185
|
* @param headers - map
|
|
@@ -120,20 +190,26 @@ export default class Client extends OpenApi {
|
|
|
120
190
|
[key: string]: string;
|
|
121
191
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddTableResponse>;
|
|
122
192
|
/**
|
|
123
|
-
*
|
|
193
|
+
* Add a table for the table data connector.
|
|
194
|
+
*
|
|
195
|
+
* @remarks
|
|
196
|
+
* - 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).
|
|
197
|
+
* - This API is not idempotent.
|
|
198
|
+
* **Throttling:**
|
|
199
|
+
* This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
|
|
124
200
|
*
|
|
125
201
|
* @param request - AddTableRequest
|
|
126
202
|
* @returns AddTableResponse
|
|
127
203
|
*/
|
|
128
204
|
addTable(WorkspaceId: string, request: $_model.AddTableRequest): Promise<$_model.AddTableResponse>;
|
|
129
205
|
/**
|
|
130
|
-
*
|
|
206
|
+
* Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
|
|
131
207
|
*
|
|
132
208
|
* @remarks
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
209
|
+
* - 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).
|
|
210
|
+
* - This API is not idempotent.
|
|
211
|
+
* **Throttling:**
|
|
212
|
+
* This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
|
|
137
213
|
*
|
|
138
214
|
* @param request - ApplyFileUploadLeaseRequest
|
|
139
215
|
* @param headers - map
|
|
@@ -144,13 +220,13 @@ export default class Client extends OpenApi {
|
|
|
144
220
|
[key: string]: string;
|
|
145
221
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ApplyFileUploadLeaseResponse>;
|
|
146
222
|
/**
|
|
147
|
-
*
|
|
223
|
+
* Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
|
|
148
224
|
*
|
|
149
225
|
* @remarks
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
226
|
+
* - 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).
|
|
227
|
+
* - This API is not idempotent.
|
|
228
|
+
* **Throttling:**
|
|
229
|
+
* This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
|
|
154
230
|
*
|
|
155
231
|
* @param request - ApplyFileUploadLeaseRequest
|
|
156
232
|
* @returns ApplyFileUploadLeaseResponse
|
|
@@ -181,7 +257,7 @@ export default class Client extends OpenApi {
|
|
|
181
257
|
*/
|
|
182
258
|
applyTempStorageLease(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest): Promise<$_model.ApplyTempStorageLeaseResponse>;
|
|
183
259
|
/**
|
|
184
|
-
*
|
|
260
|
+
* This operation updates document tags in a data connection in batches.
|
|
185
261
|
*
|
|
186
262
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
187
263
|
* @param headers - map
|
|
@@ -192,14 +268,20 @@ export default class Client extends OpenApi {
|
|
|
192
268
|
[key: string]: string;
|
|
193
269
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.BatchUpdateFileTagResponse>;
|
|
194
270
|
/**
|
|
195
|
-
*
|
|
271
|
+
* This operation updates document tags in a data connection in batches.
|
|
196
272
|
*
|
|
197
273
|
* @param request - BatchUpdateFileTagRequest
|
|
198
274
|
* @returns BatchUpdateFileTagResponse
|
|
199
275
|
*/
|
|
200
276
|
batchUpdateFileTag(WorkspaceId: string, request: $_model.BatchUpdateFileTagRequest): Promise<$_model.BatchUpdateFileTagResponse>;
|
|
201
277
|
/**
|
|
202
|
-
*
|
|
278
|
+
* 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.
|
|
279
|
+
*
|
|
280
|
+
* @remarks
|
|
281
|
+
* - 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).
|
|
282
|
+
* - This operation is not idempotent.
|
|
283
|
+
* **Throttling:**
|
|
284
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
203
285
|
*
|
|
204
286
|
* @param tmpReq - ChangeParseSettingRequest
|
|
205
287
|
* @param headers - map
|
|
@@ -210,7 +292,13 @@ export default class Client extends OpenApi {
|
|
|
210
292
|
[key: string]: string;
|
|
211
293
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ChangeParseSettingResponse>;
|
|
212
294
|
/**
|
|
213
|
-
*
|
|
295
|
+
* 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.
|
|
296
|
+
*
|
|
297
|
+
* @remarks
|
|
298
|
+
* - 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).
|
|
299
|
+
* - This operation is not idempotent.
|
|
300
|
+
* **Throttling:**
|
|
301
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
214
302
|
*
|
|
215
303
|
* @param request - ChangeParseSettingRequest
|
|
216
304
|
* @returns ChangeParseSettingResponse
|
|
@@ -235,17 +323,17 @@ export default class Client extends OpenApi {
|
|
|
235
323
|
*/
|
|
236
324
|
createAndPulishAgent(workspaceId: string, request: $_model.CreateAndPulishAgentRequest): Promise<$_model.CreateAndPulishAgentResponse>;
|
|
237
325
|
/**
|
|
238
|
-
*
|
|
326
|
+
* 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.
|
|
239
327
|
*
|
|
240
328
|
* @remarks
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
329
|
+
* - **Permissions**:
|
|
330
|
+
* - **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.
|
|
331
|
+
* - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
|
|
332
|
+
* - **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.
|
|
333
|
+
* - **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).
|
|
334
|
+
* - **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.
|
|
335
|
+
* **Rate limiting:**
|
|
336
|
+
* 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.
|
|
249
337
|
*
|
|
250
338
|
* @param tmpReq - CreateIndexRequest
|
|
251
339
|
* @param headers - map
|
|
@@ -256,24 +344,31 @@ export default class Client extends OpenApi {
|
|
|
256
344
|
[key: string]: string;
|
|
257
345
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIndexResponse>;
|
|
258
346
|
/**
|
|
259
|
-
*
|
|
347
|
+
* 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.
|
|
260
348
|
*
|
|
261
349
|
* @remarks
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
*
|
|
269
|
-
*
|
|
350
|
+
* - **Permissions**:
|
|
351
|
+
* - **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.
|
|
352
|
+
* - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
|
|
353
|
+
* - **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.
|
|
354
|
+
* - **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).
|
|
355
|
+
* - **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.
|
|
356
|
+
* **Rate limiting:**
|
|
357
|
+
* 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.
|
|
270
358
|
*
|
|
271
359
|
* @param request - CreateIndexRequest
|
|
272
360
|
* @returns CreateIndexResponse
|
|
273
361
|
*/
|
|
274
362
|
createIndex(WorkspaceId: string, request: $_model.CreateIndexRequest): Promise<$_model.CreateIndexResponse>;
|
|
275
363
|
/**
|
|
276
|
-
*
|
|
364
|
+
* Creates a long-term memory.
|
|
365
|
+
*
|
|
366
|
+
* @remarks
|
|
367
|
+
* - 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).
|
|
368
|
+
* > 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).
|
|
369
|
+
* - 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.
|
|
370
|
+
* - This operation does not support idempotence.
|
|
371
|
+
* **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
277
372
|
*
|
|
278
373
|
* @param request - CreateMemoryRequest
|
|
279
374
|
* @param headers - map
|
|
@@ -284,14 +379,21 @@ export default class Client extends OpenApi {
|
|
|
284
379
|
[key: string]: string;
|
|
285
380
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMemoryResponse>;
|
|
286
381
|
/**
|
|
287
|
-
*
|
|
382
|
+
* Creates a long-term memory.
|
|
383
|
+
*
|
|
384
|
+
* @remarks
|
|
385
|
+
* - 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).
|
|
386
|
+
* > 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).
|
|
387
|
+
* - 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.
|
|
388
|
+
* - This operation does not support idempotence.
|
|
389
|
+
* **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
288
390
|
*
|
|
289
391
|
* @param request - CreateMemoryRequest
|
|
290
392
|
* @returns CreateMemoryResponse
|
|
291
393
|
*/
|
|
292
394
|
createMemory(workspaceId: string, request: $_model.CreateMemoryRequest): Promise<$_model.CreateMemoryResponse>;
|
|
293
395
|
/**
|
|
294
|
-
*
|
|
396
|
+
* Creates a memory node.
|
|
295
397
|
*
|
|
296
398
|
* @param request - CreateMemoryNodeRequest
|
|
297
399
|
* @param headers - map
|
|
@@ -302,14 +404,17 @@ export default class Client extends OpenApi {
|
|
|
302
404
|
[key: string]: string;
|
|
303
405
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMemoryNodeResponse>;
|
|
304
406
|
/**
|
|
305
|
-
*
|
|
407
|
+
* Creates a memory node.
|
|
306
408
|
*
|
|
307
409
|
* @param request - CreateMemoryNodeRequest
|
|
308
410
|
* @returns CreateMemoryNodeResponse
|
|
309
411
|
*/
|
|
310
412
|
createMemoryNode(workspaceId: string, memoryId: string, request: $_model.CreateMemoryNodeRequest): Promise<$_model.CreateMemoryNodeResponse>;
|
|
311
413
|
/**
|
|
312
|
-
*
|
|
414
|
+
* Create a prompt template.
|
|
415
|
+
*
|
|
416
|
+
* @remarks
|
|
417
|
+
* This API does not currently support the creation of text-to-image prompt templates.
|
|
313
418
|
*
|
|
314
419
|
* @param request - CreatePromptTemplateRequest
|
|
315
420
|
* @param headers - map
|
|
@@ -320,7 +425,10 @@ export default class Client extends OpenApi {
|
|
|
320
425
|
[key: string]: string;
|
|
321
426
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePromptTemplateResponse>;
|
|
322
427
|
/**
|
|
323
|
-
*
|
|
428
|
+
* Create a prompt template.
|
|
429
|
+
*
|
|
430
|
+
* @remarks
|
|
431
|
+
* This API does not currently support the creation of text-to-image prompt templates.
|
|
324
432
|
*
|
|
325
433
|
* @param request - CreatePromptTemplateRequest
|
|
326
434
|
* @returns CreatePromptTemplateResponse
|
|
@@ -345,7 +453,13 @@ export default class Client extends OpenApi {
|
|
|
345
453
|
*/
|
|
346
454
|
deleteAgent(workspaceId: string, appCode: string, request: $_model.DeleteAgentRequest): Promise<$_model.DeleteAgentResponse>;
|
|
347
455
|
/**
|
|
348
|
-
*
|
|
456
|
+
* Permanently deletes a specified category.
|
|
457
|
+
*
|
|
458
|
+
* @remarks
|
|
459
|
+
* - 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.
|
|
460
|
+
* - This operation is idempotent.
|
|
461
|
+
* **Rate limiting:**
|
|
462
|
+
* This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
349
463
|
*
|
|
350
464
|
* @param request - DeleteCategoryRequest
|
|
351
465
|
* @param headers - map
|
|
@@ -356,25 +470,31 @@ export default class Client extends OpenApi {
|
|
|
356
470
|
[key: string]: string;
|
|
357
471
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCategoryResponse>;
|
|
358
472
|
/**
|
|
359
|
-
*
|
|
473
|
+
* Permanently deletes a specified category.
|
|
474
|
+
*
|
|
475
|
+
* @remarks
|
|
476
|
+
* - 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.
|
|
477
|
+
* - This operation is idempotent.
|
|
478
|
+
* **Rate limiting:**
|
|
479
|
+
* This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
360
480
|
*
|
|
361
481
|
* @param request - DeleteCategoryRequest
|
|
362
482
|
* @returns DeleteCategoryResponse
|
|
363
483
|
*/
|
|
364
484
|
deleteCategory(CategoryId: string, WorkspaceId: string, request: $_model.DeleteCategoryRequest): Promise<$_model.DeleteCategoryResponse>;
|
|
365
485
|
/**
|
|
366
|
-
* Deletes
|
|
486
|
+
* Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
367
487
|
*
|
|
368
488
|
* @remarks
|
|
369
|
-
*
|
|
370
|
-
* **
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
489
|
+
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
490
|
+
* - **Permission requirements**:
|
|
491
|
+
* - **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.
|
|
492
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
493
|
+
* - **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.
|
|
494
|
+
* - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
|
|
495
|
+
* - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
|
|
496
|
+
* **Rate limit:**
|
|
497
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
378
498
|
*
|
|
379
499
|
* @param tmpReq - DeleteChunkRequest
|
|
380
500
|
* @param headers - map
|
|
@@ -385,18 +505,18 @@ export default class Client extends OpenApi {
|
|
|
385
505
|
[key: string]: string;
|
|
386
506
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteChunkResponse>;
|
|
387
507
|
/**
|
|
388
|
-
* Deletes
|
|
508
|
+
* Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
389
509
|
*
|
|
390
510
|
* @remarks
|
|
391
|
-
*
|
|
392
|
-
* **
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
*
|
|
399
|
-
*
|
|
511
|
+
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
512
|
+
* - **Permission requirements**:
|
|
513
|
+
* - **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.
|
|
514
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
515
|
+
* - **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.
|
|
516
|
+
* - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
|
|
517
|
+
* - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
|
|
518
|
+
* **Rate limit:**
|
|
519
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
400
520
|
*
|
|
401
521
|
* @param request - DeleteChunkRequest
|
|
402
522
|
* @returns DeleteChunkResponse
|
|
@@ -405,6 +525,12 @@ export default class Client extends OpenApi {
|
|
|
405
525
|
/**
|
|
406
526
|
* 删除连接器
|
|
407
527
|
*
|
|
528
|
+
* @remarks
|
|
529
|
+
* - 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)来调用本接口。
|
|
530
|
+
* - 本接口不具备幂等性。
|
|
531
|
+
* **限流说明:**
|
|
532
|
+
* 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
|
|
533
|
+
*
|
|
408
534
|
* @param request - DeleteConnectorRequest
|
|
409
535
|
* @param headers - map
|
|
410
536
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -416,12 +542,27 @@ export default class Client extends OpenApi {
|
|
|
416
542
|
/**
|
|
417
543
|
* 删除连接器
|
|
418
544
|
*
|
|
545
|
+
* @remarks
|
|
546
|
+
* - 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)来调用本接口。
|
|
547
|
+
* - 本接口不具备幂等性。
|
|
548
|
+
* **限流说明:**
|
|
549
|
+
* 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
|
|
550
|
+
*
|
|
419
551
|
* @param request - DeleteConnectorRequest
|
|
420
552
|
* @returns DeleteConnectorResponse
|
|
421
553
|
*/
|
|
422
554
|
deleteConnector(ConnectorId: string, WorkspaceId: string, request: $_model.DeleteConnectorRequest): Promise<$_model.DeleteConnectorResponse>;
|
|
423
555
|
/**
|
|
424
|
-
*
|
|
556
|
+
* Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
|
|
557
|
+
*
|
|
558
|
+
* @remarks
|
|
559
|
+
* - 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.
|
|
560
|
+
* - 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.
|
|
561
|
+
* - 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.
|
|
562
|
+
* - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
|
|
563
|
+
* - This API is idempotent.
|
|
564
|
+
* **Rate Limiting Notice:**
|
|
565
|
+
* Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
|
|
425
566
|
*
|
|
426
567
|
* @param request - DeleteFileRequest
|
|
427
568
|
* @param headers - map
|
|
@@ -432,14 +573,32 @@ export default class Client extends OpenApi {
|
|
|
432
573
|
[key: string]: string;
|
|
433
574
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFileResponse>;
|
|
434
575
|
/**
|
|
435
|
-
*
|
|
576
|
+
* Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
|
|
577
|
+
*
|
|
578
|
+
* @remarks
|
|
579
|
+
* - 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.
|
|
580
|
+
* - 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.
|
|
581
|
+
* - 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.
|
|
582
|
+
* - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
|
|
583
|
+
* - This API is idempotent.
|
|
584
|
+
* **Rate Limiting Notice:**
|
|
585
|
+
* Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
|
|
436
586
|
*
|
|
437
587
|
* @param request - DeleteFileRequest
|
|
438
588
|
* @returns DeleteFileResponse
|
|
439
589
|
*/
|
|
440
590
|
deleteFile(FileId: string, WorkspaceId: string, request: $_model.DeleteFileRequest): Promise<$_model.DeleteFileResponse>;
|
|
441
591
|
/**
|
|
442
|
-
*
|
|
592
|
+
* Delete files in batch
|
|
593
|
+
*
|
|
594
|
+
* @remarks
|
|
595
|
+
* - 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).
|
|
596
|
+
* - 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.
|
|
597
|
+
* - 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.
|
|
598
|
+
* - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
|
|
599
|
+
* - This operation is idempotent.
|
|
600
|
+
* **Throttling:**
|
|
601
|
+
* Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
|
|
443
602
|
*
|
|
444
603
|
* @param tmpReq - DeleteFilesRequest
|
|
445
604
|
* @param headers - map
|
|
@@ -450,21 +609,33 @@ export default class Client extends OpenApi {
|
|
|
450
609
|
[key: string]: string;
|
|
451
610
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFilesResponse>;
|
|
452
611
|
/**
|
|
453
|
-
*
|
|
612
|
+
* Delete files in batch
|
|
613
|
+
*
|
|
614
|
+
* @remarks
|
|
615
|
+
* - 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).
|
|
616
|
+
* - 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.
|
|
617
|
+
* - 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.
|
|
618
|
+
* - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
|
|
619
|
+
* - This operation is idempotent.
|
|
620
|
+
* **Throttling:**
|
|
621
|
+
* Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
|
|
454
622
|
*
|
|
455
623
|
* @param request - DeleteFilesRequest
|
|
456
624
|
* @returns DeleteFilesResponse
|
|
457
625
|
*/
|
|
458
626
|
deleteFiles(WorkspaceId: string, request: $_model.DeleteFilesRequest): Promise<$_model.DeleteFilesResponse>;
|
|
459
627
|
/**
|
|
460
|
-
*
|
|
628
|
+
* Permanently deletes a specified knowledge base.
|
|
461
629
|
*
|
|
462
630
|
* @remarks
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
631
|
+
* - 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.
|
|
632
|
+
* - 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).
|
|
633
|
+
* - 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).
|
|
634
|
+
* - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
|
|
635
|
+
* - 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).
|
|
636
|
+
* - This operation has idempotence.
|
|
637
|
+
* **Rate limit:**
|
|
638
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
468
639
|
*
|
|
469
640
|
* @param request - DeleteIndexRequest
|
|
470
641
|
* @param headers - map
|
|
@@ -475,28 +646,35 @@ export default class Client extends OpenApi {
|
|
|
475
646
|
[key: string]: string;
|
|
476
647
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIndexResponse>;
|
|
477
648
|
/**
|
|
478
|
-
*
|
|
649
|
+
* Permanently deletes a specified knowledge base.
|
|
479
650
|
*
|
|
480
651
|
* @remarks
|
|
481
|
-
*
|
|
482
|
-
*
|
|
483
|
-
*
|
|
484
|
-
*
|
|
485
|
-
*
|
|
652
|
+
* - 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.
|
|
653
|
+
* - 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).
|
|
654
|
+
* - 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).
|
|
655
|
+
* - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
|
|
656
|
+
* - 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).
|
|
657
|
+
* - This operation has idempotence.
|
|
658
|
+
* **Rate limit:**
|
|
659
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
486
660
|
*
|
|
487
661
|
* @param request - DeleteIndexRequest
|
|
488
662
|
* @returns DeleteIndexResponse
|
|
489
663
|
*/
|
|
490
664
|
deleteIndex(WorkspaceId: string, request: $_model.DeleteIndexRequest): Promise<$_model.DeleteIndexResponse>;
|
|
491
665
|
/**
|
|
492
|
-
*
|
|
666
|
+
* Permanently deletes files from a specified knowledge base.
|
|
493
667
|
*
|
|
494
668
|
* @remarks
|
|
495
|
-
*
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
499
|
-
*
|
|
669
|
+
* - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
|
|
670
|
+
* - 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.
|
|
671
|
+
* - 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).
|
|
672
|
+
* - 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.
|
|
673
|
+
* - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
|
|
674
|
+
* - 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).
|
|
675
|
+
* - This operation is idempotent.
|
|
676
|
+
* **Throttling:**
|
|
677
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
500
678
|
*
|
|
501
679
|
* @param tmpReq - DeleteIndexDocumentRequest
|
|
502
680
|
* @param headers - map
|
|
@@ -507,21 +685,31 @@ export default class Client extends OpenApi {
|
|
|
507
685
|
[key: string]: string;
|
|
508
686
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIndexDocumentResponse>;
|
|
509
687
|
/**
|
|
510
|
-
*
|
|
688
|
+
* Permanently deletes files from a specified knowledge base.
|
|
511
689
|
*
|
|
512
690
|
* @remarks
|
|
513
|
-
*
|
|
514
|
-
*
|
|
515
|
-
*
|
|
516
|
-
*
|
|
517
|
-
*
|
|
691
|
+
* - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
|
|
692
|
+
* - 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.
|
|
693
|
+
* - 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).
|
|
694
|
+
* - 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.
|
|
695
|
+
* - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
|
|
696
|
+
* - 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).
|
|
697
|
+
* - This operation is idempotent.
|
|
698
|
+
* **Throttling:**
|
|
699
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
518
700
|
*
|
|
519
701
|
* @param request - DeleteIndexDocumentRequest
|
|
520
702
|
* @returns DeleteIndexDocumentResponse
|
|
521
703
|
*/
|
|
522
704
|
deleteIndexDocument(WorkspaceId: string, request: $_model.DeleteIndexDocumentRequest): Promise<$_model.DeleteIndexDocumentResponse>;
|
|
523
705
|
/**
|
|
524
|
-
*
|
|
706
|
+
* Permanently deletes a specified long-term memory.
|
|
707
|
+
*
|
|
708
|
+
* @remarks
|
|
709
|
+
* - 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).
|
|
710
|
+
* - 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.
|
|
711
|
+
* - This operation is idempotent.
|
|
712
|
+
* **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.
|
|
525
713
|
*
|
|
526
714
|
* @param request - DeleteMemoryRequest
|
|
527
715
|
* @param headers - map
|
|
@@ -532,14 +720,20 @@ export default class Client extends OpenApi {
|
|
|
532
720
|
[key: string]: string;
|
|
533
721
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMemoryResponse>;
|
|
534
722
|
/**
|
|
535
|
-
*
|
|
723
|
+
* Permanently deletes a specified long-term memory.
|
|
724
|
+
*
|
|
725
|
+
* @remarks
|
|
726
|
+
* - 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).
|
|
727
|
+
* - 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.
|
|
728
|
+
* - This operation is idempotent.
|
|
729
|
+
* **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.
|
|
536
730
|
*
|
|
537
731
|
* @param request - DeleteMemoryRequest
|
|
538
732
|
* @returns DeleteMemoryResponse
|
|
539
733
|
*/
|
|
540
734
|
deleteMemory(workspaceId: string, memoryId: string, request: $_model.DeleteMemoryRequest): Promise<$_model.DeleteMemoryResponse>;
|
|
541
735
|
/**
|
|
542
|
-
*
|
|
736
|
+
* Deletes a memory fragment.
|
|
543
737
|
*
|
|
544
738
|
* @param request - DeleteMemoryNodeRequest
|
|
545
739
|
* @param headers - map
|
|
@@ -550,7 +744,7 @@ export default class Client extends OpenApi {
|
|
|
550
744
|
[key: string]: string;
|
|
551
745
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMemoryNodeResponse>;
|
|
552
746
|
/**
|
|
553
|
-
*
|
|
747
|
+
* Deletes a memory fragment.
|
|
554
748
|
*
|
|
555
749
|
* @param request - DeleteMemoryNodeRequest
|
|
556
750
|
* @returns DeleteMemoryNodeResponse
|
|
@@ -575,13 +769,13 @@ export default class Client extends OpenApi {
|
|
|
575
769
|
*/
|
|
576
770
|
deletePromptTemplate(workspaceId: string, promptTemplateId: string, request: $_model.DeletePromptTemplateRequest): Promise<$_model.DeletePromptTemplateResponse>;
|
|
577
771
|
/**
|
|
578
|
-
*
|
|
772
|
+
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
579
773
|
*
|
|
580
774
|
* @remarks
|
|
581
|
-
*
|
|
582
|
-
*
|
|
583
|
-
*
|
|
584
|
-
*
|
|
775
|
+
* - 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.
|
|
776
|
+
* - This operation is idempotent.
|
|
777
|
+
* **Throttling:**
|
|
778
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
585
779
|
*
|
|
586
780
|
* @param request - DescribeFileRequest
|
|
587
781
|
* @param headers - map
|
|
@@ -592,20 +786,20 @@ export default class Client extends OpenApi {
|
|
|
592
786
|
[key: string]: string;
|
|
593
787
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFileResponse>;
|
|
594
788
|
/**
|
|
595
|
-
*
|
|
789
|
+
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
596
790
|
*
|
|
597
791
|
* @remarks
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
792
|
+
* - 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.
|
|
793
|
+
* - This operation is idempotent.
|
|
794
|
+
* **Throttling:**
|
|
795
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
602
796
|
*
|
|
603
797
|
* @param request - DescribeFileRequest
|
|
604
798
|
* @returns DescribeFileResponse
|
|
605
799
|
*/
|
|
606
800
|
describeFile(WorkspaceId: string, FileId: string, request: $_model.DescribeFileRequest): Promise<$_model.DescribeFileResponse>;
|
|
607
801
|
/**
|
|
608
|
-
*
|
|
802
|
+
* Queries the tipping status of the Alipay wallet bound to an application.
|
|
609
803
|
*
|
|
610
804
|
* @param request - GetAlipayTransferStatusRequest
|
|
611
805
|
* @param headers - map
|
|
@@ -616,14 +810,14 @@ export default class Client extends OpenApi {
|
|
|
616
810
|
[key: string]: string;
|
|
617
811
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetAlipayTransferStatusResponse>;
|
|
618
812
|
/**
|
|
619
|
-
*
|
|
813
|
+
* Queries the tipping status of the Alipay wallet bound to an application.
|
|
620
814
|
*
|
|
621
815
|
* @param request - GetAlipayTransferStatusRequest
|
|
622
816
|
* @returns GetAlipayTransferStatusResponse
|
|
623
817
|
*/
|
|
624
818
|
getAlipayTransferStatus(request: $_model.GetAlipayTransferStatusRequest): Promise<$_model.GetAlipayTransferStatusResponse>;
|
|
625
819
|
/**
|
|
626
|
-
*
|
|
820
|
+
* Retrieves the Alipay tipping URL for an application.
|
|
627
821
|
*
|
|
628
822
|
* @param request - GetAlipayUrlRequest
|
|
629
823
|
* @param headers - map
|
|
@@ -634,7 +828,7 @@ export default class Client extends OpenApi {
|
|
|
634
828
|
[key: string]: string;
|
|
635
829
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetAlipayUrlResponse>;
|
|
636
830
|
/**
|
|
637
|
-
*
|
|
831
|
+
* Retrieves the Alipay tipping URL for an application.
|
|
638
832
|
*
|
|
639
833
|
* @param request - GetAlipayUrlRequest
|
|
640
834
|
* @returns GetAlipayUrlResponse
|
|
@@ -643,6 +837,12 @@ export default class Client extends OpenApi {
|
|
|
643
837
|
/**
|
|
644
838
|
* Lists all supported parser types based on the input file type (file extension).
|
|
645
839
|
*
|
|
840
|
+
* @remarks
|
|
841
|
+
* - 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)来调用本接口。
|
|
842
|
+
* - 本接口具有幂等性。
|
|
843
|
+
* **限流说明:**
|
|
844
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
845
|
+
*
|
|
646
846
|
* @param request - GetAvailableParserTypesRequest
|
|
647
847
|
* @param headers - map
|
|
648
848
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -654,12 +854,24 @@ export default class Client extends OpenApi {
|
|
|
654
854
|
/**
|
|
655
855
|
* Lists all supported parser types based on the input file type (file extension).
|
|
656
856
|
*
|
|
857
|
+
* @remarks
|
|
858
|
+
* - 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)来调用本接口。
|
|
859
|
+
* - 本接口具有幂等性。
|
|
860
|
+
* **限流说明:**
|
|
861
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
862
|
+
*
|
|
657
863
|
* @param request - GetAvailableParserTypesRequest
|
|
658
864
|
* @returns GetAvailableParserTypesResponse
|
|
659
865
|
*/
|
|
660
866
|
getAvailableParserTypes(WorkspaceId: string, request: $_model.GetAvailableParserTypesRequest): Promise<$_model.GetAvailableParserTypesResponse>;
|
|
661
867
|
/**
|
|
662
|
-
*
|
|
868
|
+
* Retrieves details about a connector. This operation currently supports only file connectors.
|
|
869
|
+
*
|
|
870
|
+
* @remarks
|
|
871
|
+
* - 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.
|
|
872
|
+
* - This operation is idempotent.
|
|
873
|
+
* **Throttling:**
|
|
874
|
+
* This operation is subject to throttling. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
|
|
663
875
|
*
|
|
664
876
|
* @param request - GetConnectorRequest
|
|
665
877
|
* @param headers - map
|
|
@@ -670,19 +882,26 @@ export default class Client extends OpenApi {
|
|
|
670
882
|
[key: string]: string;
|
|
671
883
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetConnectorResponse>;
|
|
672
884
|
/**
|
|
673
|
-
*
|
|
885
|
+
* Retrieves details about a connector. This operation currently supports only file connectors.
|
|
886
|
+
*
|
|
887
|
+
* @remarks
|
|
888
|
+
* - 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.
|
|
889
|
+
* - This operation is idempotent.
|
|
890
|
+
* **Throttling:**
|
|
891
|
+
* This operation is subject to throttling. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
|
|
674
892
|
*
|
|
675
893
|
* @param request - GetConnectorRequest
|
|
676
894
|
* @returns GetConnectorResponse
|
|
677
895
|
*/
|
|
678
896
|
getConnector(WorkspaceId: string, request: $_model.GetConnectorRequest): Promise<$_model.GetConnectorResponse>;
|
|
679
897
|
/**
|
|
680
|
-
* Queries the current status of a specified knowledge base creation or
|
|
898
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document append task.
|
|
681
899
|
*
|
|
682
900
|
* @remarks
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
*
|
|
901
|
+
* - 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.
|
|
902
|
+
* - 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`.
|
|
903
|
+
* - Invoke this operation at intervals of 5 seconds or more.
|
|
904
|
+
* - This operation supports idempotence.
|
|
686
905
|
*
|
|
687
906
|
* @param request - GetIndexJobStatusRequest
|
|
688
907
|
* @param headers - map
|
|
@@ -693,19 +912,26 @@ export default class Client extends OpenApi {
|
|
|
693
912
|
[key: string]: string;
|
|
694
913
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexJobStatusResponse>;
|
|
695
914
|
/**
|
|
696
|
-
* Queries the current status of a specified knowledge base creation or
|
|
915
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document append task.
|
|
697
916
|
*
|
|
698
917
|
* @remarks
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
*
|
|
918
|
+
* - 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.
|
|
919
|
+
* - 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`.
|
|
920
|
+
* - Invoke this operation at intervals of 5 seconds or more.
|
|
921
|
+
* - This operation supports idempotence.
|
|
702
922
|
*
|
|
703
923
|
* @param request - GetIndexJobStatusRequest
|
|
704
924
|
* @returns GetIndexJobStatusResponse
|
|
705
925
|
*/
|
|
706
926
|
getIndexJobStatus(WorkspaceId: string, request: $_model.GetIndexJobStatusRequest): Promise<$_model.GetIndexJobStatusResponse>;
|
|
707
927
|
/**
|
|
708
|
-
*
|
|
928
|
+
* 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.
|
|
929
|
+
*
|
|
930
|
+
* @remarks
|
|
931
|
+
* <props="intl">
|
|
932
|
+
* This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
|
|
933
|
+
* <props="china">
|
|
934
|
+
* - 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.
|
|
709
935
|
*
|
|
710
936
|
* @param request - GetIndexMonitorRequest
|
|
711
937
|
* @param headers - map
|
|
@@ -716,14 +942,24 @@ export default class Client extends OpenApi {
|
|
|
716
942
|
[key: string]: string;
|
|
717
943
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexMonitorResponse>;
|
|
718
944
|
/**
|
|
719
|
-
*
|
|
945
|
+
* 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.
|
|
946
|
+
*
|
|
947
|
+
* @remarks
|
|
948
|
+
* <props="intl">
|
|
949
|
+
* This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
|
|
950
|
+
* <props="china">
|
|
951
|
+
* - 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.
|
|
720
952
|
*
|
|
721
953
|
* @param request - GetIndexMonitorRequest
|
|
722
954
|
* @returns GetIndexMonitorResponse
|
|
723
955
|
*/
|
|
724
956
|
getIndexMonitor(WorkspaceId: string, request: $_model.GetIndexMonitorRequest): Promise<$_model.GetIndexMonitorResponse>;
|
|
725
957
|
/**
|
|
726
|
-
*
|
|
958
|
+
* Retrieves the description of a specified long-term memory.
|
|
959
|
+
*
|
|
960
|
+
* @remarks
|
|
961
|
+
* - This operation is idempotent.
|
|
962
|
+
* **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.
|
|
727
963
|
*
|
|
728
964
|
* @param request - GetMemoryRequest
|
|
729
965
|
* @param headers - map
|
|
@@ -734,14 +970,18 @@ export default class Client extends OpenApi {
|
|
|
734
970
|
[key: string]: string;
|
|
735
971
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetMemoryResponse>;
|
|
736
972
|
/**
|
|
737
|
-
*
|
|
973
|
+
* Retrieves the description of a specified long-term memory.
|
|
974
|
+
*
|
|
975
|
+
* @remarks
|
|
976
|
+
* - This operation is idempotent.
|
|
977
|
+
* **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.
|
|
738
978
|
*
|
|
739
979
|
* @param request - GetMemoryRequest
|
|
740
980
|
* @returns GetMemoryResponse
|
|
741
981
|
*/
|
|
742
982
|
getMemory(workspaceId: string, memoryId: string, request: $_model.GetMemoryRequest): Promise<$_model.GetMemoryResponse>;
|
|
743
983
|
/**
|
|
744
|
-
*
|
|
984
|
+
* Retrieves a memory fragment.
|
|
745
985
|
*
|
|
746
986
|
* @param request - GetMemoryNodeRequest
|
|
747
987
|
* @param headers - map
|
|
@@ -752,7 +992,7 @@ export default class Client extends OpenApi {
|
|
|
752
992
|
[key: string]: string;
|
|
753
993
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetMemoryNodeResponse>;
|
|
754
994
|
/**
|
|
755
|
-
*
|
|
995
|
+
* Retrieves a memory fragment.
|
|
756
996
|
*
|
|
757
997
|
* @param request - GetMemoryNodeRequest
|
|
758
998
|
* @returns GetMemoryNodeResponse
|
|
@@ -761,6 +1001,12 @@ export default class Client extends OpenApi {
|
|
|
761
1001
|
/**
|
|
762
1002
|
* Queries the data parsing settings in a specified category.
|
|
763
1003
|
*
|
|
1004
|
+
* @remarks
|
|
1005
|
+
* - 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)来调用本接口。
|
|
1006
|
+
* - 本接口具有幂等性。
|
|
1007
|
+
* **限流说明:**
|
|
1008
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
1009
|
+
*
|
|
764
1010
|
* @param request - GetParseSettingsRequest
|
|
765
1011
|
* @param headers - map
|
|
766
1012
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -772,6 +1018,12 @@ export default class Client extends OpenApi {
|
|
|
772
1018
|
/**
|
|
773
1019
|
* Queries the data parsing settings in a specified category.
|
|
774
1020
|
*
|
|
1021
|
+
* @remarks
|
|
1022
|
+
* - 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)来调用本接口。
|
|
1023
|
+
* - 本接口具有幂等性。
|
|
1024
|
+
* **限流说明:**
|
|
1025
|
+
* 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
|
|
1026
|
+
*
|
|
775
1027
|
* @param request - GetParseSettingsRequest
|
|
776
1028
|
* @returns GetParseSettingsResponse
|
|
777
1029
|
*/
|
|
@@ -831,7 +1083,14 @@ export default class Client extends OpenApi {
|
|
|
831
1083
|
*/
|
|
832
1084
|
highCodeDeploy(workspaceId: string, request: $_model.HighCodeDeployRequest): Promise<$_model.HighCodeDeployResponse>;
|
|
833
1085
|
/**
|
|
834
|
-
*
|
|
1086
|
+
* Retrieves the details of one or more categories in a specified workspace.
|
|
1087
|
+
*
|
|
1088
|
+
* @remarks
|
|
1089
|
+
* - This API does not support querying data tables.
|
|
1090
|
+
* - 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).
|
|
1091
|
+
* - 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.
|
|
1092
|
+
* - This operation is idempotent.
|
|
1093
|
+
* **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.
|
|
835
1094
|
*
|
|
836
1095
|
* @param request - ListCategoryRequest
|
|
837
1096
|
* @param headers - map
|
|
@@ -842,18 +1101,29 @@ export default class Client extends OpenApi {
|
|
|
842
1101
|
[key: string]: string;
|
|
843
1102
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListCategoryResponse>;
|
|
844
1103
|
/**
|
|
845
|
-
*
|
|
1104
|
+
* Retrieves the details of one or more categories in a specified workspace.
|
|
1105
|
+
*
|
|
1106
|
+
* @remarks
|
|
1107
|
+
* - This API does not support querying data tables.
|
|
1108
|
+
* - 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).
|
|
1109
|
+
* - 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.
|
|
1110
|
+
* - This operation is idempotent.
|
|
1111
|
+
* **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.
|
|
846
1112
|
*
|
|
847
1113
|
* @param request - ListCategoryRequest
|
|
848
1114
|
* @returns ListCategoryResponse
|
|
849
1115
|
*/
|
|
850
1116
|
listCategory(WorkspaceId: string, request: $_model.ListCategoryRequest): Promise<$_model.ListCategoryResponse>;
|
|
851
1117
|
/**
|
|
852
|
-
*
|
|
1118
|
+
* Queries the list and information of text chunks.
|
|
853
1119
|
*
|
|
854
1120
|
* @remarks
|
|
855
|
-
*
|
|
856
|
-
*
|
|
1121
|
+
* - 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.
|
|
1122
|
+
* - 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.
|
|
1123
|
+
* - 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).
|
|
1124
|
+
* - This operation has idempotence.
|
|
1125
|
+
* **Rate limit:**
|
|
1126
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
857
1127
|
*
|
|
858
1128
|
* @param request - ListChunksRequest
|
|
859
1129
|
* @param headers - map
|
|
@@ -864,24 +1134,29 @@ export default class Client extends OpenApi {
|
|
|
864
1134
|
[key: string]: string;
|
|
865
1135
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListChunksResponse>;
|
|
866
1136
|
/**
|
|
867
|
-
*
|
|
1137
|
+
* Queries the list and information of text chunks.
|
|
868
1138
|
*
|
|
869
1139
|
* @remarks
|
|
870
|
-
*
|
|
871
|
-
*
|
|
1140
|
+
* - 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.
|
|
1141
|
+
* - 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.
|
|
1142
|
+
* - 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).
|
|
1143
|
+
* - This operation has idempotence.
|
|
1144
|
+
* **Rate limit:**
|
|
1145
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
872
1146
|
*
|
|
873
1147
|
* @param request - ListChunksRequest
|
|
874
1148
|
* @returns ListChunksResponse
|
|
875
1149
|
*/
|
|
876
1150
|
listChunks(WorkspaceId: string, request: $_model.ListChunksRequest): Promise<$_model.ListChunksResponse>;
|
|
877
1151
|
/**
|
|
878
|
-
*
|
|
1152
|
+
* Retrieves the details of one or more documents in a specified category.
|
|
879
1153
|
*
|
|
880
1154
|
* @remarks
|
|
881
|
-
*
|
|
882
|
-
*
|
|
883
|
-
*
|
|
884
|
-
* **
|
|
1155
|
+
* - 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).
|
|
1156
|
+
* - 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.
|
|
1157
|
+
* - This operation is idempotent.
|
|
1158
|
+
* **Rate limit:**
|
|
1159
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
885
1160
|
*
|
|
886
1161
|
* @param tmpReq - ListFileRequest
|
|
887
1162
|
* @param headers - map
|
|
@@ -892,24 +1167,28 @@ export default class Client extends OpenApi {
|
|
|
892
1167
|
[key: string]: string;
|
|
893
1168
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListFileResponse>;
|
|
894
1169
|
/**
|
|
895
|
-
*
|
|
1170
|
+
* Retrieves the details of one or more documents in a specified category.
|
|
896
1171
|
*
|
|
897
1172
|
* @remarks
|
|
898
|
-
*
|
|
899
|
-
*
|
|
900
|
-
*
|
|
901
|
-
* **
|
|
1173
|
+
* - 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).
|
|
1174
|
+
* - 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.
|
|
1175
|
+
* - This operation is idempotent.
|
|
1176
|
+
* **Rate limit:**
|
|
1177
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
902
1178
|
*
|
|
903
1179
|
* @param request - ListFileRequest
|
|
904
1180
|
* @returns ListFileResponse
|
|
905
1181
|
*/
|
|
906
1182
|
listFile(WorkspaceId: string, request: $_model.ListFileRequest): Promise<$_model.ListFileResponse>;
|
|
907
1183
|
/**
|
|
908
|
-
*
|
|
1184
|
+
* Retrieves files and their summary information from a specified knowledge base.
|
|
909
1185
|
*
|
|
910
1186
|
* @remarks
|
|
911
|
-
*
|
|
912
|
-
*
|
|
1187
|
+
* - 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.
|
|
1188
|
+
* - 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).
|
|
1189
|
+
* - This operation has idempotence.
|
|
1190
|
+
* **Throttling:**
|
|
1191
|
+
* This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
913
1192
|
*
|
|
914
1193
|
* @param request - ListIndexDocumentsRequest
|
|
915
1194
|
* @param headers - map
|
|
@@ -920,18 +1199,26 @@ export default class Client extends OpenApi {
|
|
|
920
1199
|
[key: string]: string;
|
|
921
1200
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexDocumentsResponse>;
|
|
922
1201
|
/**
|
|
923
|
-
*
|
|
1202
|
+
* Retrieves files and their summary information from a specified knowledge base.
|
|
924
1203
|
*
|
|
925
1204
|
* @remarks
|
|
926
|
-
*
|
|
927
|
-
*
|
|
1205
|
+
* - 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.
|
|
1206
|
+
* - 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).
|
|
1207
|
+
* - This operation has idempotence.
|
|
1208
|
+
* **Throttling:**
|
|
1209
|
+
* This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
928
1210
|
*
|
|
929
1211
|
* @param request - ListIndexDocumentsRequest
|
|
930
1212
|
* @returns ListIndexDocumentsResponse
|
|
931
1213
|
*/
|
|
932
1214
|
listIndexDocuments(WorkspaceId: string, request: $_model.ListIndexDocumentsRequest): Promise<$_model.ListIndexDocumentsResponse>;
|
|
933
1215
|
/**
|
|
934
|
-
*
|
|
1216
|
+
* Retrieves the files in a specified knowledge base along with their details.
|
|
1217
|
+
*
|
|
1218
|
+
* @remarks
|
|
1219
|
+
* - 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.
|
|
1220
|
+
* - 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).
|
|
1221
|
+
* - This operation has idempotence.
|
|
935
1222
|
*
|
|
936
1223
|
* @param request - ListIndexFileDetailsRequest
|
|
937
1224
|
* @param headers - map
|
|
@@ -942,17 +1229,25 @@ export default class Client extends OpenApi {
|
|
|
942
1229
|
[key: string]: string;
|
|
943
1230
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexFileDetailsResponse>;
|
|
944
1231
|
/**
|
|
945
|
-
*
|
|
1232
|
+
* Retrieves the files in a specified knowledge base along with their details.
|
|
1233
|
+
*
|
|
1234
|
+
* @remarks
|
|
1235
|
+
* - 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.
|
|
1236
|
+
* - 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).
|
|
1237
|
+
* - This operation has idempotence.
|
|
946
1238
|
*
|
|
947
1239
|
* @param request - ListIndexFileDetailsRequest
|
|
948
1240
|
* @returns ListIndexFileDetailsResponse
|
|
949
1241
|
*/
|
|
950
1242
|
listIndexFileDetails(WorkspaceId: string, request: $_model.ListIndexFileDetailsRequest): Promise<$_model.ListIndexFileDetailsResponse>;
|
|
951
1243
|
/**
|
|
952
|
-
*
|
|
1244
|
+
* Retrieves the list of knowledge bases in a specified workspace.
|
|
953
1245
|
*
|
|
954
1246
|
* @remarks
|
|
955
|
-
*
|
|
1247
|
+
* - 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.
|
|
1248
|
+
* - This operation is idempotent.
|
|
1249
|
+
* **Rate limit:**
|
|
1250
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
956
1251
|
*
|
|
957
1252
|
* @param request - ListIndicesRequest
|
|
958
1253
|
* @param headers - map
|
|
@@ -963,17 +1258,25 @@ export default class Client extends OpenApi {
|
|
|
963
1258
|
[key: string]: string;
|
|
964
1259
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndicesResponse>;
|
|
965
1260
|
/**
|
|
966
|
-
*
|
|
1261
|
+
* Retrieves the list of knowledge bases in a specified workspace.
|
|
967
1262
|
*
|
|
968
1263
|
* @remarks
|
|
969
|
-
*
|
|
1264
|
+
* - 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.
|
|
1265
|
+
* - This operation is idempotent.
|
|
1266
|
+
* **Rate limit:**
|
|
1267
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
970
1268
|
*
|
|
971
1269
|
* @param request - ListIndicesRequest
|
|
972
1270
|
* @returns ListIndicesResponse
|
|
973
1271
|
*/
|
|
974
1272
|
listIndices(WorkspaceId: string, request: $_model.ListIndicesRequest): Promise<$_model.ListIndicesResponse>;
|
|
975
1273
|
/**
|
|
976
|
-
*
|
|
1274
|
+
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
1275
|
+
*
|
|
1276
|
+
* @remarks
|
|
1277
|
+
* - 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.
|
|
1278
|
+
* - This operation supports idempotence.
|
|
1279
|
+
* **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.
|
|
977
1280
|
*
|
|
978
1281
|
* @param request - ListMemoriesRequest
|
|
979
1282
|
* @param headers - map
|
|
@@ -984,14 +1287,19 @@ export default class Client extends OpenApi {
|
|
|
984
1287
|
[key: string]: string;
|
|
985
1288
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemoriesResponse>;
|
|
986
1289
|
/**
|
|
987
|
-
*
|
|
1290
|
+
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
1291
|
+
*
|
|
1292
|
+
* @remarks
|
|
1293
|
+
* - 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.
|
|
1294
|
+
* - This operation supports idempotence.
|
|
1295
|
+
* **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.
|
|
988
1296
|
*
|
|
989
1297
|
* @param request - ListMemoriesRequest
|
|
990
1298
|
* @returns ListMemoriesResponse
|
|
991
1299
|
*/
|
|
992
1300
|
listMemories(workspaceId: string, request: $_model.ListMemoriesRequest): Promise<$_model.ListMemoriesResponse>;
|
|
993
1301
|
/**
|
|
994
|
-
*
|
|
1302
|
+
* Retrieves a list of memory nodes.
|
|
995
1303
|
*
|
|
996
1304
|
* @param request - ListMemoryNodesRequest
|
|
997
1305
|
* @param headers - map
|
|
@@ -1002,7 +1310,7 @@ export default class Client extends OpenApi {
|
|
|
1002
1310
|
[key: string]: string;
|
|
1003
1311
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemoryNodesResponse>;
|
|
1004
1312
|
/**
|
|
1005
|
-
*
|
|
1313
|
+
* Retrieves a list of memory nodes.
|
|
1006
1314
|
*
|
|
1007
1315
|
* @param request - ListMemoryNodesRequest
|
|
1008
1316
|
* @returns ListMemoryNodesResponse
|
|
@@ -1045,12 +1353,23 @@ export default class Client extends OpenApi {
|
|
|
1045
1353
|
*/
|
|
1046
1354
|
listPublishedAgent(workspaceId: string, request: $_model.ListPublishedAgentRequest): Promise<$_model.ListPublishedAgentResponse>;
|
|
1047
1355
|
/**
|
|
1048
|
-
*
|
|
1356
|
+
* Retrieves information from a specified knowledge base.
|
|
1049
1357
|
*
|
|
1050
1358
|
* @remarks
|
|
1051
|
-
*
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1359
|
+
* <props="china">
|
|
1360
|
+
* - **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.
|
|
1361
|
+
* - **Required permissions**:
|
|
1362
|
+
* - **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.
|
|
1363
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
1364
|
+
* - **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.
|
|
1365
|
+
* - **Idempotency**: This API is idempotent.
|
|
1366
|
+
* <props="intl">
|
|
1367
|
+
* - **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.
|
|
1368
|
+
* - **Required permissions**:
|
|
1369
|
+
* - **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.
|
|
1370
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
1371
|
+
* - **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.
|
|
1372
|
+
* - **Idempotency**: This API is idempotent.
|
|
1054
1373
|
*
|
|
1055
1374
|
* @param tmpReq - RetrieveRequest
|
|
1056
1375
|
* @param headers - map
|
|
@@ -1061,25 +1380,42 @@ export default class Client extends OpenApi {
|
|
|
1061
1380
|
[key: string]: string;
|
|
1062
1381
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.RetrieveResponse>;
|
|
1063
1382
|
/**
|
|
1064
|
-
*
|
|
1383
|
+
* Retrieves information from a specified knowledge base.
|
|
1065
1384
|
*
|
|
1066
1385
|
* @remarks
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1386
|
+
* <props="china">
|
|
1387
|
+
* - **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.
|
|
1388
|
+
* - **Required permissions**:
|
|
1389
|
+
* - **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.
|
|
1390
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
1391
|
+
* - **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.
|
|
1392
|
+
* - **Idempotency**: This API is idempotent.
|
|
1393
|
+
* <props="intl">
|
|
1394
|
+
* - **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.
|
|
1395
|
+
* - **Required permissions**:
|
|
1396
|
+
* - **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.
|
|
1397
|
+
* - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
|
|
1398
|
+
* - **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.
|
|
1399
|
+
* - **Idempotency**: This API is idempotent.
|
|
1070
1400
|
*
|
|
1071
1401
|
* @param request - RetrieveRequest
|
|
1072
1402
|
* @returns RetrieveResponse
|
|
1073
1403
|
*/
|
|
1074
1404
|
retrieve(WorkspaceId: string, request: $_model.RetrieveRequest): Promise<$_model.RetrieveResponse>;
|
|
1075
1405
|
/**
|
|
1076
|
-
* Adds parsed
|
|
1406
|
+
* Adds parsed files to the specified knowledge base.
|
|
1077
1407
|
*
|
|
1078
1408
|
* @remarks
|
|
1079
|
-
*
|
|
1080
|
-
*
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1409
|
+
* <props="china">
|
|
1410
|
+
* - 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.
|
|
1411
|
+
* <props="intl">
|
|
1412
|
+
* - 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.
|
|
1413
|
+
* - 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.
|
|
1414
|
+
* - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
|
|
1415
|
+
* - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
|
|
1416
|
+
* - 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.
|
|
1417
|
+
* - 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.
|
|
1418
|
+
* **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
|
|
1083
1419
|
*
|
|
1084
1420
|
* @param tmpReq - SubmitIndexAddDocumentsJobRequest
|
|
1085
1421
|
* @param headers - map
|
|
@@ -1090,26 +1426,35 @@ export default class Client extends OpenApi {
|
|
|
1090
1426
|
[key: string]: string;
|
|
1091
1427
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.SubmitIndexAddDocumentsJobResponse>;
|
|
1092
1428
|
/**
|
|
1093
|
-
* Adds parsed
|
|
1429
|
+
* Adds parsed files to the specified knowledge base.
|
|
1094
1430
|
*
|
|
1095
1431
|
* @remarks
|
|
1096
|
-
*
|
|
1097
|
-
*
|
|
1098
|
-
*
|
|
1099
|
-
*
|
|
1432
|
+
* <props="china">
|
|
1433
|
+
* - 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.
|
|
1434
|
+
* <props="intl">
|
|
1435
|
+
* - 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.
|
|
1436
|
+
* - 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.
|
|
1437
|
+
* - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
|
|
1438
|
+
* - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
|
|
1439
|
+
* - 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.
|
|
1440
|
+
* - 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.
|
|
1441
|
+
* **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
|
|
1100
1442
|
*
|
|
1101
1443
|
* @param request - SubmitIndexAddDocumentsJobRequest
|
|
1102
1444
|
* @returns SubmitIndexAddDocumentsJobResponse
|
|
1103
1445
|
*/
|
|
1104
1446
|
submitIndexAddDocumentsJob(WorkspaceId: string, request: $_model.SubmitIndexAddDocumentsJobRequest): Promise<$_model.SubmitIndexAddDocumentsJobResponse>;
|
|
1105
1447
|
/**
|
|
1106
|
-
* Submits a specified CreateIndex
|
|
1448
|
+
* Submits a specified CreateIndex task to complete knowledge base creation.
|
|
1107
1449
|
*
|
|
1108
1450
|
* @remarks
|
|
1109
|
-
*
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
*
|
|
1451
|
+
* - 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.
|
|
1452
|
+
* - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
|
|
1453
|
+
* - 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.
|
|
1454
|
+
* - 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.
|
|
1455
|
+
* - This operation does not support idempotence.
|
|
1456
|
+
* **Rate limit:**
|
|
1457
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1113
1458
|
*
|
|
1114
1459
|
* @param request - SubmitIndexJobRequest
|
|
1115
1460
|
* @param headers - map
|
|
@@ -1120,13 +1465,16 @@ export default class Client extends OpenApi {
|
|
|
1120
1465
|
[key: string]: string;
|
|
1121
1466
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.SubmitIndexJobResponse>;
|
|
1122
1467
|
/**
|
|
1123
|
-
* Submits a specified CreateIndex
|
|
1468
|
+
* Submits a specified CreateIndex task to complete knowledge base creation.
|
|
1124
1469
|
*
|
|
1125
1470
|
* @remarks
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
1471
|
+
* - 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.
|
|
1472
|
+
* - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
|
|
1473
|
+
* - 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.
|
|
1474
|
+
* - 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.
|
|
1475
|
+
* - This operation does not support idempotence.
|
|
1476
|
+
* **Rate limit:**
|
|
1477
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
1130
1478
|
*
|
|
1131
1479
|
* @param request - SubmitIndexJobRequest
|
|
1132
1480
|
* @returns SubmitIndexJobResponse
|
|
@@ -1169,17 +1517,18 @@ export default class Client extends OpenApi {
|
|
|
1169
1517
|
*/
|
|
1170
1518
|
updateAndPublishAgentSelective(workspaceId: string, appCode: string, request: $_model.UpdateAndPublishAgentSelectiveRequest): Promise<$_model.UpdateAndPublishAgentSelectiveResponse>;
|
|
1171
1519
|
/**
|
|
1172
|
-
* Modifies the content and title of a specified text chunk in
|
|
1520
|
+
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
1173
1521
|
*
|
|
1174
1522
|
* @remarks
|
|
1175
|
-
*
|
|
1176
|
-
*
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
*
|
|
1181
|
-
*
|
|
1182
|
-
* **Rate limit:**
|
|
1523
|
+
* - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
|
|
1524
|
+
* - **Permission requirements**:
|
|
1525
|
+
* - **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).
|
|
1526
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1527
|
+
* - **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.
|
|
1528
|
+
* - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
|
|
1529
|
+
* - **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.
|
|
1530
|
+
* **Rate limit:**
|
|
1531
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1183
1532
|
*
|
|
1184
1533
|
* @param request - UpdateChunkRequest
|
|
1185
1534
|
* @param headers - map
|
|
@@ -1190,24 +1539,30 @@ export default class Client extends OpenApi {
|
|
|
1190
1539
|
[key: string]: string;
|
|
1191
1540
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateChunkResponse>;
|
|
1192
1541
|
/**
|
|
1193
|
-
* Modifies the content and title of a specified text chunk in
|
|
1542
|
+
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
1194
1543
|
*
|
|
1195
1544
|
* @remarks
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1202
|
-
*
|
|
1203
|
-
* **Rate limit:**
|
|
1545
|
+
* - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
|
|
1546
|
+
* - **Permission requirements**:
|
|
1547
|
+
* - **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).
|
|
1548
|
+
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1549
|
+
* - **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.
|
|
1550
|
+
* - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
|
|
1551
|
+
* - **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.
|
|
1552
|
+
* **Rate limit:**
|
|
1553
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1204
1554
|
*
|
|
1205
1555
|
* @param request - UpdateChunkRequest
|
|
1206
1556
|
* @returns UpdateChunkResponse
|
|
1207
1557
|
*/
|
|
1208
1558
|
updateChunk(WorkspaceId: string, request: $_model.UpdateChunkRequest): Promise<$_model.UpdateChunkResponse>;
|
|
1209
1559
|
/**
|
|
1210
|
-
*
|
|
1560
|
+
* Updates a connector.
|
|
1561
|
+
*
|
|
1562
|
+
* @remarks
|
|
1563
|
+
* - 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.
|
|
1564
|
+
* - This operation is not idempotent.
|
|
1565
|
+
* **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.
|
|
1211
1566
|
*
|
|
1212
1567
|
* @param request - UpdateConnectorRequest
|
|
1213
1568
|
* @param headers - map
|
|
@@ -1218,14 +1573,23 @@ export default class Client extends OpenApi {
|
|
|
1218
1573
|
[key: string]: string;
|
|
1219
1574
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateConnectorResponse>;
|
|
1220
1575
|
/**
|
|
1221
|
-
*
|
|
1576
|
+
* Updates a connector.
|
|
1577
|
+
*
|
|
1578
|
+
* @remarks
|
|
1579
|
+
* - 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.
|
|
1580
|
+
* - This operation is not idempotent.
|
|
1581
|
+
* **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.
|
|
1222
1582
|
*
|
|
1223
1583
|
* @param request - UpdateConnectorRequest
|
|
1224
1584
|
* @returns UpdateConnectorResponse
|
|
1225
1585
|
*/
|
|
1226
1586
|
updateConnector(WorkspaceId: string, ConnectorId: string, request: $_model.UpdateConnectorRequest): Promise<$_model.UpdateConnectorResponse>;
|
|
1227
1587
|
/**
|
|
1228
|
-
* Updates the tags
|
|
1588
|
+
* Updates the tags for a specified file.
|
|
1589
|
+
*
|
|
1590
|
+
* @remarks
|
|
1591
|
+
* - 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.
|
|
1592
|
+
* **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
1229
1593
|
*
|
|
1230
1594
|
* @param tmpReq - UpdateFileTagRequest
|
|
1231
1595
|
* @param headers - map
|
|
@@ -1236,14 +1600,24 @@ export default class Client extends OpenApi {
|
|
|
1236
1600
|
[key: string]: string;
|
|
1237
1601
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateFileTagResponse>;
|
|
1238
1602
|
/**
|
|
1239
|
-
* Updates the tags
|
|
1603
|
+
* Updates the tags for a specified file.
|
|
1604
|
+
*
|
|
1605
|
+
* @remarks
|
|
1606
|
+
* - 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.
|
|
1607
|
+
* **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
|
|
1240
1608
|
*
|
|
1241
1609
|
* @param request - UpdateFileTagRequest
|
|
1242
1610
|
* @returns UpdateFileTagResponse
|
|
1243
1611
|
*/
|
|
1244
1612
|
updateFileTag(WorkspaceId: string, FileId: string, request: $_model.UpdateFileTagRequest): Promise<$_model.UpdateFileTagResponse>;
|
|
1245
1613
|
/**
|
|
1246
|
-
*
|
|
1614
|
+
* Updates the configuration of a specified knowledge base.
|
|
1615
|
+
*
|
|
1616
|
+
* @remarks
|
|
1617
|
+
* <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
|
|
1618
|
+
* 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).
|
|
1619
|
+
* 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.
|
|
1620
|
+
* This operation is idempotent.
|
|
1247
1621
|
*
|
|
1248
1622
|
* @param request - UpdateIndexRequest
|
|
1249
1623
|
* @param headers - map
|
|
@@ -1254,14 +1628,24 @@ export default class Client extends OpenApi {
|
|
|
1254
1628
|
[key: string]: string;
|
|
1255
1629
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIndexResponse>;
|
|
1256
1630
|
/**
|
|
1257
|
-
*
|
|
1631
|
+
* Updates the configuration of a specified knowledge base.
|
|
1632
|
+
*
|
|
1633
|
+
* @remarks
|
|
1634
|
+
* <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
|
|
1635
|
+
* 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).
|
|
1636
|
+
* 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.
|
|
1637
|
+
* This operation is idempotent.
|
|
1258
1638
|
*
|
|
1259
1639
|
* @param request - UpdateIndexRequest
|
|
1260
1640
|
* @returns UpdateIndexResponse
|
|
1261
1641
|
*/
|
|
1262
1642
|
updateIndex(WorkspaceId: string, request: $_model.UpdateIndexRequest): Promise<$_model.UpdateIndexResponse>;
|
|
1263
1643
|
/**
|
|
1264
|
-
*
|
|
1644
|
+
* Updates the description of a specified long-term memory.
|
|
1645
|
+
*
|
|
1646
|
+
* @remarks
|
|
1647
|
+
* - This operation is idempotent.
|
|
1648
|
+
* **Rate limit:** Ensure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
1265
1649
|
*
|
|
1266
1650
|
* @param request - UpdateMemoryRequest
|
|
1267
1651
|
* @param headers - map
|
|
@@ -1272,14 +1656,18 @@ export default class Client extends OpenApi {
|
|
|
1272
1656
|
[key: string]: string;
|
|
1273
1657
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMemoryResponse>;
|
|
1274
1658
|
/**
|
|
1275
|
-
*
|
|
1659
|
+
* Updates the description of a specified long-term memory.
|
|
1660
|
+
*
|
|
1661
|
+
* @remarks
|
|
1662
|
+
* - This operation is idempotent.
|
|
1663
|
+
* **Rate limit:** Ensure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
1276
1664
|
*
|
|
1277
1665
|
* @param request - UpdateMemoryRequest
|
|
1278
1666
|
* @returns UpdateMemoryResponse
|
|
1279
1667
|
*/
|
|
1280
1668
|
updateMemory(workspaceId: string, memoryId: string, request: $_model.UpdateMemoryRequest): Promise<$_model.UpdateMemoryResponse>;
|
|
1281
1669
|
/**
|
|
1282
|
-
*
|
|
1670
|
+
* Updates a memory fragment.
|
|
1283
1671
|
*
|
|
1284
1672
|
* @param request - UpdateMemoryNodeRequest
|
|
1285
1673
|
* @param headers - map
|
|
@@ -1290,7 +1678,7 @@ export default class Client extends OpenApi {
|
|
|
1290
1678
|
[key: string]: string;
|
|
1291
1679
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMemoryNodeResponse>;
|
|
1292
1680
|
/**
|
|
1293
|
-
*
|
|
1681
|
+
* Updates a memory fragment.
|
|
1294
1682
|
*
|
|
1295
1683
|
* @param request - UpdateMemoryNodeRequest
|
|
1296
1684
|
* @returns UpdateMemoryNodeResponse
|
|
@@ -1315,7 +1703,15 @@ export default class Client extends OpenApi {
|
|
|
1315
1703
|
*/
|
|
1316
1704
|
updatePromptTemplate(workspaceId: string, promptTemplateId: string, request: $_model.UpdatePromptTemplateRequest): Promise<$_model.UpdatePromptTemplateResponse>;
|
|
1317
1705
|
/**
|
|
1318
|
-
*
|
|
1706
|
+
* Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
|
|
1707
|
+
*
|
|
1708
|
+
* @remarks
|
|
1709
|
+
* - 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).
|
|
1710
|
+
* - 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.
|
|
1711
|
+
* - 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).
|
|
1712
|
+
* - 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).
|
|
1713
|
+
* - This operation is not idempotent.
|
|
1714
|
+
* **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.
|
|
1319
1715
|
*
|
|
1320
1716
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
1321
1717
|
* @param headers - map
|
|
@@ -1326,7 +1722,15 @@ export default class Client extends OpenApi {
|
|
|
1326
1722
|
[key: string]: string;
|
|
1327
1723
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTableFromAuthorizedOssResponse>;
|
|
1328
1724
|
/**
|
|
1329
|
-
*
|
|
1725
|
+
* Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
|
|
1726
|
+
*
|
|
1727
|
+
* @remarks
|
|
1728
|
+
* - 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).
|
|
1729
|
+
* - 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.
|
|
1730
|
+
* - 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).
|
|
1731
|
+
* - 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).
|
|
1732
|
+
* - This operation is not idempotent.
|
|
1733
|
+
* **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.
|
|
1330
1734
|
*
|
|
1331
1735
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
1332
1736
|
* @returns UpdateTableFromAuthorizedOssResponse
|