@alicloud/bailian20231229 2.14.3 → 2.14.5
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 +284 -270
- package/dist/client.js +284 -274
- package/dist/client.js.map +1 -1
- package/dist/models/AddCategoryRequest.d.ts +6 -7
- package/dist/models/AddCategoryRequest.js.map +1 -1
- package/dist/models/AddCategoryResponseBody.d.ts +9 -11
- package/dist/models/AddCategoryResponseBody.js.map +1 -1
- package/dist/models/AddConnectorRequest.d.ts +8 -6
- package/dist/models/AddConnectorRequest.js.map +1 -1
- package/dist/models/AddConnectorResponseBody.d.ts +8 -10
- package/dist/models/AddConnectorResponseBody.js.map +1 -1
- package/dist/models/AddConnectorShrinkRequest.d.ts +3 -3
- package/dist/models/AddFileRequest.d.ts +22 -22
- package/dist/models/AddFileResponseBody.d.ts +6 -6
- package/dist/models/AddFileShrinkRequest.d.ts +18 -18
- package/dist/models/AddFilesFromAuthorizedOssRequest.d.ts +27 -27
- package/dist/models/AddFilesFromAuthorizedOssResponseBody.d.ts +9 -9
- package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.d.ts +10 -10
- package/dist/models/AddTableRequest.d.ts +7 -1
- package/dist/models/AddTableRequest.js.map +1 -1
- package/dist/models/AddTableResponseBody.d.ts +5 -5
- package/dist/models/ApplyFileUploadLeaseRequest.d.ts +15 -15
- package/dist/models/ApplyFileUploadLeaseResponseBody.d.ts +12 -12
- package/dist/models/BatchUpdateFileTagRequest.d.ts +4 -4
- package/dist/models/BatchUpdateFileTagResponseBody.d.ts +14 -18
- package/dist/models/BatchUpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/BatchUpdateFileTagShrinkRequest.d.ts +2 -2
- package/dist/models/ChangeParseSettingRequest.d.ts +11 -11
- package/dist/models/ChangeParseSettingResponseBody.d.ts +2 -2
- package/dist/models/ChangeParseSettingShrinkRequest.d.ts +6 -6
- package/dist/models/CreateIndexRequest.d.ts +115 -120
- package/dist/models/CreateIndexRequest.js.map +1 -1
- package/dist/models/CreateIndexResponseBody.d.ts +13 -7
- package/dist/models/CreateIndexResponseBody.js.map +1 -1
- package/dist/models/CreateIndexShrinkRequest.d.ts +91 -96
- package/dist/models/CreateIndexShrinkRequest.js.map +1 -1
- package/dist/models/CreateMemoryRequest.d.ts +2 -2
- package/dist/models/CreateMemoryResponseBody.d.ts +1 -1
- package/dist/models/DeleteCategoryResponseBody.d.ts +1 -1
- package/dist/models/DeleteChunkRequest.d.ts +1 -1
- package/dist/models/DeleteChunkResponseBody.d.ts +10 -4
- package/dist/models/DeleteChunkResponseBody.js.map +1 -1
- package/dist/models/DeleteChunkShrinkRequest.d.ts +1 -1
- package/dist/models/DeleteFileResponseBody.d.ts +6 -8
- package/dist/models/DeleteFileResponseBody.js.map +1 -1
- package/dist/models/DeleteFilesRequest.d.ts +1 -1
- package/dist/models/DeleteFilesResponseBody.d.ts +7 -7
- package/dist/models/DeleteFilesShrinkRequest.d.ts +1 -1
- package/dist/models/DescribeFileResponseBody.d.ts +54 -40
- package/dist/models/DescribeFileResponseBody.js +2 -0
- package/dist/models/DescribeFileResponseBody.js.map +1 -1
- package/dist/models/GetAvailableParserTypesRequest.d.ts +16 -1
- package/dist/models/GetAvailableParserTypesRequest.js.map +1 -1
- package/dist/models/GetAvailableParserTypesResponseBody.d.ts +13 -15
- package/dist/models/GetAvailableParserTypesResponseBody.js.map +1 -1
- package/dist/models/GetIndexJobStatusRequest.d.ts +4 -4
- package/dist/models/GetIndexJobStatusResponseBody.d.ts +27 -20
- package/dist/models/GetIndexJobStatusResponseBody.js.map +1 -1
- package/dist/models/GetParseSettingsRequest.d.ts +1 -1
- package/dist/models/GetParseSettingsResponseBody.d.ts +19 -21
- package/dist/models/GetParseSettingsResponseBody.js.map +1 -1
- package/dist/models/ListCategoryRequest.d.ts +14 -13
- package/dist/models/ListCategoryRequest.js.map +1 -1
- package/dist/models/ListCategoryResponseBody.d.ts +21 -27
- package/dist/models/ListCategoryResponseBody.js.map +1 -1
- package/dist/models/ListFileRequest.d.ts +7 -9
- package/dist/models/ListFileRequest.js.map +1 -1
- package/dist/models/ListFileResponseBody.d.ts +10 -10
- package/dist/models/ListFileShrinkRequest.d.ts +7 -9
- package/dist/models/ListFileShrinkRequest.js.map +1 -1
- package/dist/models/ListIndexDocumentsRequest.d.ts +9 -9
- package/dist/models/ListIndexDocumentsResponseBody.d.ts +2 -2
- package/dist/models/ListIndicesRequest.d.ts +1 -1
- package/dist/models/ListIndicesResponseBody.d.ts +69 -13
- package/dist/models/ListIndicesResponseBody.js +6 -0
- package/dist/models/ListIndicesResponseBody.js.map +1 -1
- package/dist/models/ListMemoriesResponseBody.d.ts +3 -3
- package/dist/models/RetrieveRequest.d.ts +68 -75
- package/dist/models/RetrieveRequest.js.map +1 -1
- package/dist/models/RetrieveResponseBody.d.ts +20 -23
- package/dist/models/RetrieveResponseBody.js.map +1 -1
- package/dist/models/RetrieveShrinkRequest.d.ts +29 -34
- package/dist/models/RetrieveShrinkRequest.js.map +1 -1
- package/dist/models/UpdateChunkRequest.d.ts +7 -7
- package/dist/models/UpdateChunkResponseBody.d.ts +8 -2
- package/dist/models/UpdateChunkResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagRequest.d.ts +1 -1
- package/dist/models/UpdateFileTagResponseBody.d.ts +8 -9
- package/dist/models/UpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateIndexRequest.d.ts +15 -15
- package/dist/models/UpdateIndexResponseBody.d.ts +5 -5
- package/dist/models/UpdateTableFromAuthorizedOssRequest.d.ts +6 -4
- package/dist/models/UpdateTableFromAuthorizedOssRequest.js.map +1 -1
- package/dist/models/UpdateTableFromAuthorizedOssResponseBody.d.ts +8 -8
- package/package.json +1 -1
- package/src/client.ts +284 -274
- package/src/models/AddCategoryRequest.ts +6 -7
- package/src/models/AddCategoryResponseBody.ts +9 -11
- package/src/models/AddConnectorRequest.ts +8 -6
- package/src/models/AddConnectorResponseBody.ts +8 -10
- package/src/models/AddConnectorShrinkRequest.ts +3 -3
- package/src/models/AddFileRequest.ts +22 -22
- package/src/models/AddFileResponseBody.ts +6 -6
- package/src/models/AddFileShrinkRequest.ts +18 -18
- package/src/models/AddFilesFromAuthorizedOssRequest.ts +27 -27
- package/src/models/AddFilesFromAuthorizedOssResponseBody.ts +9 -9
- package/src/models/AddFilesFromAuthorizedOssShrinkRequest.ts +10 -10
- package/src/models/AddTableRequest.ts +7 -1
- package/src/models/AddTableResponseBody.ts +5 -5
- package/src/models/ApplyFileUploadLeaseRequest.ts +15 -15
- package/src/models/ApplyFileUploadLeaseResponseBody.ts +12 -12
- package/src/models/BatchUpdateFileTagRequest.ts +4 -4
- package/src/models/BatchUpdateFileTagResponseBody.ts +14 -18
- package/src/models/BatchUpdateFileTagShrinkRequest.ts +2 -2
- package/src/models/ChangeParseSettingRequest.ts +11 -11
- package/src/models/ChangeParseSettingResponseBody.ts +2 -2
- package/src/models/ChangeParseSettingShrinkRequest.ts +6 -6
- package/src/models/CreateIndexRequest.ts +115 -120
- package/src/models/CreateIndexResponseBody.ts +13 -7
- package/src/models/CreateIndexShrinkRequest.ts +91 -96
- package/src/models/CreateMemoryRequest.ts +2 -2
- package/src/models/CreateMemoryResponseBody.ts +1 -1
- package/src/models/DeleteCategoryResponseBody.ts +1 -1
- package/src/models/DeleteChunkRequest.ts +1 -1
- package/src/models/DeleteChunkResponseBody.ts +10 -4
- package/src/models/DeleteChunkShrinkRequest.ts +1 -1
- package/src/models/DeleteFileResponseBody.ts +6 -8
- package/src/models/DeleteFilesRequest.ts +1 -1
- package/src/models/DeleteFilesResponseBody.ts +7 -7
- package/src/models/DeleteFilesShrinkRequest.ts +1 -1
- package/src/models/DescribeFileResponseBody.ts +56 -40
- package/src/models/GetAvailableParserTypesRequest.ts +16 -1
- package/src/models/GetAvailableParserTypesResponseBody.ts +13 -15
- package/src/models/GetIndexJobStatusRequest.ts +4 -4
- package/src/models/GetIndexJobStatusResponseBody.ts +27 -20
- package/src/models/GetParseSettingsRequest.ts +1 -1
- package/src/models/GetParseSettingsResponseBody.ts +19 -21
- package/src/models/ListCategoryRequest.ts +14 -13
- package/src/models/ListCategoryResponseBody.ts +21 -27
- package/src/models/ListFileRequest.ts +7 -9
- package/src/models/ListFileResponseBody.ts +10 -10
- package/src/models/ListFileShrinkRequest.ts +7 -9
- package/src/models/ListIndexDocumentsRequest.ts +9 -9
- package/src/models/ListIndexDocumentsResponseBody.ts +2 -2
- package/src/models/ListIndicesRequest.ts +1 -1
- package/src/models/ListIndicesResponseBody.ts +75 -13
- package/src/models/ListMemoriesResponseBody.ts +3 -3
- package/src/models/RetrieveRequest.ts +68 -75
- package/src/models/RetrieveResponseBody.ts +20 -23
- package/src/models/RetrieveShrinkRequest.ts +29 -34
- package/src/models/UpdateChunkRequest.ts +7 -7
- package/src/models/UpdateChunkResponseBody.ts +8 -2
- package/src/models/UpdateFileTagRequest.ts +1 -1
- package/src/models/UpdateFileTagResponseBody.ts +8 -9
- package/src/models/UpdateFileTagShrinkRequest.ts +1 -1
- package/src/models/UpdateIndexRequest.ts +15 -15
- package/src/models/UpdateIndexResponseBody.ts +5 -5
- package/src/models/UpdateTableFromAuthorizedOssRequest.ts +6 -4
- package/src/models/UpdateTableFromAuthorizedOssResponseBody.ts +8 -8
package/dist/client.d.ts
CHANGED
|
@@ -9,13 +9,14 @@ export default class Client extends OpenApi {
|
|
|
9
9
|
[key: string]: string;
|
|
10
10
|
}, endpoint: string): string;
|
|
11
11
|
/**
|
|
12
|
-
* Creates a category in a specified workspace
|
|
12
|
+
* Creates a category in a specified workspace for classifying and managing files. A maximum of 500 categories can be created in each workspace.
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* -
|
|
16
|
-
* - A RAM user must obtain
|
|
17
|
-
* - This operation
|
|
18
|
-
* **
|
|
15
|
+
* - Creating data tables through the API is not supported. Use the <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) page in the console.
|
|
16
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddCategory 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">[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.
|
|
17
|
+
* - This operation does not support idempotence.
|
|
18
|
+
* **Throttling:**
|
|
19
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
19
20
|
*
|
|
20
21
|
* @param request - AddCategoryRequest
|
|
21
22
|
* @param headers - map
|
|
@@ -26,13 +27,14 @@ export default class Client extends OpenApi {
|
|
|
26
27
|
[key: string]: string;
|
|
27
28
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddCategoryResponse>;
|
|
28
29
|
/**
|
|
29
|
-
* Creates a category in a specified workspace
|
|
30
|
+
* Creates a category in a specified workspace for classifying and managing files. A maximum of 500 categories can be created in each workspace.
|
|
30
31
|
*
|
|
31
32
|
* @remarks
|
|
32
|
-
* -
|
|
33
|
-
* - A RAM user must obtain
|
|
34
|
-
* - This operation
|
|
35
|
-
* **
|
|
33
|
+
* - Creating data tables through the API is not supported. Use the <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) page in the console.
|
|
34
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddCategory 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">[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.
|
|
35
|
+
* - This operation does not support idempotence.
|
|
36
|
+
* **Throttling:**
|
|
37
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
36
38
|
*
|
|
37
39
|
* @param request - AddCategoryRequest
|
|
38
40
|
* @returns AddCategoryResponse
|
|
@@ -73,13 +75,13 @@ export default class Client extends OpenApi {
|
|
|
73
75
|
*/
|
|
74
76
|
addChunk(WorkspaceId: string, request: $_model.AddChunkRequest): Promise<$_model.AddChunkResponse>;
|
|
75
77
|
/**
|
|
76
|
-
* Creates a connector.
|
|
78
|
+
* Creates a connector. Currently, this operation supports creating only file-type connectors.
|
|
77
79
|
*
|
|
78
80
|
* @remarks
|
|
79
|
-
* -
|
|
81
|
+
* - 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:AddCategory 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.
|
|
80
82
|
* - This operation is not idempotent.
|
|
81
|
-
* **
|
|
82
|
-
*
|
|
83
|
+
* **Rate limit:**
|
|
84
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
83
85
|
*
|
|
84
86
|
* @param tmpReq - AddConnectorRequest
|
|
85
87
|
* @param headers - map
|
|
@@ -90,26 +92,26 @@ export default class Client extends OpenApi {
|
|
|
90
92
|
[key: string]: string;
|
|
91
93
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddConnectorResponse>;
|
|
92
94
|
/**
|
|
93
|
-
* Creates a connector.
|
|
95
|
+
* Creates a connector. Currently, this operation supports creating only file-type connectors.
|
|
94
96
|
*
|
|
95
97
|
* @remarks
|
|
96
|
-
* -
|
|
98
|
+
* - 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:AddCategory 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.
|
|
97
99
|
* - This operation is not idempotent.
|
|
98
|
-
* **
|
|
99
|
-
*
|
|
100
|
+
* **Rate limit:**
|
|
101
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
100
102
|
*
|
|
101
103
|
* @param request - AddConnectorRequest
|
|
102
104
|
* @returns AddConnectorResponse
|
|
103
105
|
*/
|
|
104
106
|
addConnector(WorkspaceId: string, request: $_model.AddConnectorRequest): Promise<$_model.AddConnectorResponse>;
|
|
105
107
|
/**
|
|
106
|
-
* 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).
|
|
108
|
+
* Imports a file from the temporary storage space of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
107
109
|
*
|
|
108
110
|
* @remarks
|
|
109
|
-
* - Resource Access Management (RAM)
|
|
111
|
+
* - Before invoking this operation, a Resource Access Management (RAM) user must 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). An Alibaba Cloud account 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.
|
|
110
112
|
* - This operation is not idempotent.
|
|
111
113
|
* **Throttling:**
|
|
112
|
-
* This operation is
|
|
114
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
113
115
|
*
|
|
114
116
|
* @param tmpReq - AddFileRequest
|
|
115
117
|
* @param headers - map
|
|
@@ -120,13 +122,13 @@ export default class Client extends OpenApi {
|
|
|
120
122
|
[key: string]: string;
|
|
121
123
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddFileResponse>;
|
|
122
124
|
/**
|
|
123
|
-
* 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).
|
|
125
|
+
* Imports a file from the temporary storage space of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
|
|
124
126
|
*
|
|
125
127
|
* @remarks
|
|
126
|
-
* - Resource Access Management (RAM)
|
|
128
|
+
* - Before invoking this operation, a Resource Access Management (RAM) user must 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). An Alibaba Cloud account 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.
|
|
127
129
|
* - This operation is not idempotent.
|
|
128
130
|
* **Throttling:**
|
|
129
|
-
* This operation is
|
|
131
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
130
132
|
*
|
|
131
133
|
* @param request - AddFileRequest
|
|
132
134
|
* @returns AddFileResponse
|
|
@@ -136,14 +138,14 @@ export default class Client extends OpenApi {
|
|
|
136
138
|
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
137
139
|
*
|
|
138
140
|
* @remarks
|
|
139
|
-
* -
|
|
141
|
+
* - Ensure that the OSS bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account. Before you call this operation, you must authorize the OSS service-linked role as prompted in the Model Studio console (service name: datahub.sfm.aliyuncs.com) and add a tag with the key bailian-datahub-access and the value read to the destination bucket. This tag is used to authorize OSS data import for this operation and is different from the bailian-connector-access tag used in the console data connection process.
|
|
140
142
|
*
|
|
141
|
-
* - Supported bucket storage
|
|
142
|
-
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name
|
|
143
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the
|
|
144
|
-
* - This operation
|
|
145
|
-
* **
|
|
146
|
-
*
|
|
143
|
+
* - Supported bucket storage classes do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption are supported. Buckets with public read/write, public read, or private ACLs are supported.
|
|
144
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, you must add the domain name *.console.aliyun.com to the Referer whitelist by referring to [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
145
|
+
* - Resource Access Management (RAM) users must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the AliyunBailianDataFullAccess policy is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before they can call this operation. Alibaba Cloud accounts 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.
|
|
146
|
+
* - This operation is not idempotent.
|
|
147
|
+
* **Throttling:**
|
|
148
|
+
* Frequent calls to this operation are throttled. Do not exceed 5 calls per second. If throttling occurs, retry later.
|
|
147
149
|
*
|
|
148
150
|
* @param tmpReq - AddFilesFromAuthorizedOssRequest
|
|
149
151
|
* @param headers - map
|
|
@@ -157,27 +159,27 @@ export default class Client extends OpenApi {
|
|
|
157
159
|
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
158
160
|
*
|
|
159
161
|
* @remarks
|
|
160
|
-
* -
|
|
162
|
+
* - Ensure that the OSS bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account. Before you call this operation, you must authorize the OSS service-linked role as prompted in the Model Studio console (service name: datahub.sfm.aliyuncs.com) and add a tag with the key bailian-datahub-access and the value read to the destination bucket. This tag is used to authorize OSS data import for this operation and is different from the bailian-connector-access tag used in the console data connection process.
|
|
161
163
|
*
|
|
162
|
-
* - Supported bucket storage
|
|
163
|
-
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name
|
|
164
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the
|
|
165
|
-
* - This operation
|
|
166
|
-
* **
|
|
167
|
-
*
|
|
164
|
+
* - Supported bucket storage classes do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption are supported. Buckets with public read/write, public read, or private ACLs are supported.
|
|
165
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, you must add the domain name *.console.aliyun.com to the Referer whitelist by referring to [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
|
|
166
|
+
* - Resource Access Management (RAM) users must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the AliyunBailianDataFullAccess policy is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before they can call this operation. Alibaba Cloud accounts 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.
|
|
167
|
+
* - This operation is not idempotent.
|
|
168
|
+
* **Throttling:**
|
|
169
|
+
* Frequent calls to this operation are throttled. Do not exceed 5 calls per second. If throttling occurs, retry later.
|
|
168
170
|
*
|
|
169
171
|
* @param request - AddFilesFromAuthorizedOssRequest
|
|
170
172
|
* @returns AddFilesFromAuthorizedOssResponse
|
|
171
173
|
*/
|
|
172
174
|
addFilesFromAuthorizedOss(WorkspaceId: string, request: $_model.AddFilesFromAuthorizedOssRequest): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
|
|
173
175
|
/**
|
|
174
|
-
*
|
|
176
|
+
* Adds a table to a tabular data connector.
|
|
175
177
|
*
|
|
176
178
|
* @remarks
|
|
177
|
-
* -
|
|
178
|
-
* - This
|
|
179
|
-
* **
|
|
180
|
-
* This
|
|
179
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before 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.
|
|
180
|
+
* - This operation is not idempotent.
|
|
181
|
+
* **Rate limit:**
|
|
182
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
181
183
|
*
|
|
182
184
|
* @param tmpReq - AddTableRequest
|
|
183
185
|
* @param headers - map
|
|
@@ -188,26 +190,26 @@ export default class Client extends OpenApi {
|
|
|
188
190
|
[key: string]: string;
|
|
189
191
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.AddTableResponse>;
|
|
190
192
|
/**
|
|
191
|
-
*
|
|
193
|
+
* Adds a table to a tabular data connector.
|
|
192
194
|
*
|
|
193
195
|
* @remarks
|
|
194
|
-
* -
|
|
195
|
-
* - This
|
|
196
|
-
* **
|
|
197
|
-
* This
|
|
196
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before 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.
|
|
197
|
+
* - This operation is not idempotent.
|
|
198
|
+
* **Rate limit:**
|
|
199
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
198
200
|
*
|
|
199
201
|
* @param request - AddTableRequest
|
|
200
202
|
* @returns AddTableResponse
|
|
201
203
|
*/
|
|
202
204
|
addTable(WorkspaceId: string, request: $_model.AddTableRequest): Promise<$_model.AddTableResponse>;
|
|
203
205
|
/**
|
|
204
|
-
*
|
|
206
|
+
* Requests an upload lease for uploading a knowledge base file or a file for agent application session interaction.
|
|
205
207
|
*
|
|
206
208
|
* @remarks
|
|
207
|
-
* -
|
|
208
|
-
* - This
|
|
209
|
+
* - 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:ApplyFileUploadLease 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.
|
|
210
|
+
* - This operation is not idempotent.
|
|
209
211
|
* **Throttling:**
|
|
210
|
-
* This
|
|
212
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
211
213
|
*
|
|
212
214
|
* @param request - ApplyFileUploadLeaseRequest
|
|
213
215
|
* @param headers - map
|
|
@@ -218,13 +220,13 @@ export default class Client extends OpenApi {
|
|
|
218
220
|
[key: string]: string;
|
|
219
221
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ApplyFileUploadLeaseResponse>;
|
|
220
222
|
/**
|
|
221
|
-
*
|
|
223
|
+
* Requests an upload lease for uploading a knowledge base file or a file for agent application session interaction.
|
|
222
224
|
*
|
|
223
225
|
* @remarks
|
|
224
|
-
* -
|
|
225
|
-
* - This
|
|
226
|
+
* - 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:ApplyFileUploadLease 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.
|
|
227
|
+
* - This operation is not idempotent.
|
|
226
228
|
* **Throttling:**
|
|
227
|
-
* This
|
|
229
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
228
230
|
*
|
|
229
231
|
* @param request - ApplyFileUploadLeaseRequest
|
|
230
232
|
* @returns ApplyFileUploadLeaseResponse
|
|
@@ -255,7 +257,7 @@ export default class Client extends OpenApi {
|
|
|
255
257
|
*/
|
|
256
258
|
applyTempStorageLease(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest): Promise<$_model.ApplyTempStorageLeaseResponse>;
|
|
257
259
|
/**
|
|
258
|
-
*
|
|
260
|
+
* Batch updates document tags in a data connection.
|
|
259
261
|
*
|
|
260
262
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
261
263
|
* @param headers - map
|
|
@@ -266,7 +268,7 @@ export default class Client extends OpenApi {
|
|
|
266
268
|
[key: string]: string;
|
|
267
269
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.BatchUpdateFileTagResponse>;
|
|
268
270
|
/**
|
|
269
|
-
*
|
|
271
|
+
* Batch updates document tags in a data connection.
|
|
270
272
|
*
|
|
271
273
|
* @param request - BatchUpdateFileTagRequest
|
|
272
274
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -276,10 +278,10 @@ export default class Client extends OpenApi {
|
|
|
276
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.
|
|
277
279
|
*
|
|
278
280
|
* @remarks
|
|
279
|
-
* - Resource Access Management (RAM)
|
|
281
|
+
* - A Resource Access Management (RAM) user 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. An Alibaba Cloud account 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.
|
|
280
282
|
* - This operation is not idempotent.
|
|
281
|
-
* **
|
|
282
|
-
* This operation is
|
|
283
|
+
* **Rate limit:**
|
|
284
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
283
285
|
*
|
|
284
286
|
* @param tmpReq - ChangeParseSettingRequest
|
|
285
287
|
* @param headers - map
|
|
@@ -293,10 +295,10 @@ export default class Client extends OpenApi {
|
|
|
293
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.
|
|
294
296
|
*
|
|
295
297
|
* @remarks
|
|
296
|
-
* - Resource Access Management (RAM)
|
|
298
|
+
* - A Resource Access Management (RAM) user 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. An Alibaba Cloud account 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.
|
|
297
299
|
* - This operation is not idempotent.
|
|
298
|
-
* **
|
|
299
|
-
* This operation is
|
|
300
|
+
* **Rate limit:**
|
|
301
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
300
302
|
*
|
|
301
303
|
* @param request - ChangeParseSettingRequest
|
|
302
304
|
* @returns ChangeParseSettingResponse
|
|
@@ -321,17 +323,17 @@ export default class Client extends OpenApi {
|
|
|
321
323
|
*/
|
|
322
324
|
createAndPulishAgent(workspaceId: string, request: $_model.CreateAndPulishAgentRequest): Promise<$_model.CreateAndPulishAgentResponse>;
|
|
323
325
|
/**
|
|
324
|
-
* Creates
|
|
326
|
+
* Creates two types of knowledge bases: unstructured knowledge bases based on documents or audio and video, and structured knowledge bases for data querying or image question answering.
|
|
325
327
|
*
|
|
326
328
|
* @remarks
|
|
327
329
|
* - **Permission requirements**:
|
|
328
|
-
* - **Resource Access Management (RAM)
|
|
329
|
-
* - **Alibaba Cloud
|
|
330
|
-
* - **
|
|
331
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After
|
|
332
|
-
* - **Idempotence**: This operation
|
|
333
|
-
* **
|
|
334
|
-
* This operation is
|
|
330
|
+
* - **Resource Access Management (RAM) users**: You must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the AliyunBailianDataFullAccess policy, which includes the sfm:CreateIndex permission required by this operation) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you can invoke this operation.
|
|
331
|
+
* - **Alibaba Cloud accounts**: By default, Alibaba Cloud accounts have the required permissions and can directly invoke this operation.
|
|
332
|
+
* - **Invocation method**: 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 operation. The SDK provides encapsulation for the complex signature calculation logic and simplifies the procedure to invoke the operation.
|
|
333
|
+
* - **What to do next**: This operation only performs the initialization of the knowledge base creation job. After you invoke this operation, you must invoke the **SubmitIndexJob** operation to complete the creation. Otherwise, you will get an empty knowledge base. For corresponding code examples, refer to the [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
334
|
+
* - **Idempotence**: This operation is not idempotent. If you invoke this operation repeatedly, multiple knowledge bases with the same name may be created. Implement idempotence by using the "query first, then create" logic when you invoke this operation.
|
|
335
|
+
* **Throttling:**
|
|
336
|
+
* This operation is throttled if called frequently. Do not exceed 10 calls per second. If throttling occurs, retry later.
|
|
335
337
|
*
|
|
336
338
|
* @param tmpReq - CreateIndexRequest
|
|
337
339
|
* @param headers - map
|
|
@@ -342,17 +344,17 @@ export default class Client extends OpenApi {
|
|
|
342
344
|
[key: string]: string;
|
|
343
345
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIndexResponse>;
|
|
344
346
|
/**
|
|
345
|
-
* Creates
|
|
347
|
+
* Creates two types of knowledge bases: unstructured knowledge bases based on documents or audio and video, and structured knowledge bases for data querying or image question answering.
|
|
346
348
|
*
|
|
347
349
|
* @remarks
|
|
348
350
|
* - **Permission requirements**:
|
|
349
|
-
* - **Resource Access Management (RAM)
|
|
350
|
-
* - **Alibaba Cloud
|
|
351
|
-
* - **
|
|
352
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After
|
|
353
|
-
* - **Idempotence**: This operation
|
|
354
|
-
* **
|
|
355
|
-
* This operation is
|
|
351
|
+
* - **Resource Access Management (RAM) users**: You must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the AliyunBailianDataFullAccess policy, which includes the sfm:CreateIndex permission required by this operation) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you can invoke this operation.
|
|
352
|
+
* - **Alibaba Cloud accounts**: By default, Alibaba Cloud accounts have the required permissions and can directly invoke this operation.
|
|
353
|
+
* - **Invocation method**: 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 operation. The SDK provides encapsulation for the complex signature calculation logic and simplifies the procedure to invoke the operation.
|
|
354
|
+
* - **What to do next**: This operation only performs the initialization of the knowledge base creation job. After you invoke this operation, you must invoke the **SubmitIndexJob** operation to complete the creation. Otherwise, you will get an empty knowledge base. For corresponding code examples, refer to the [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
|
|
355
|
+
* - **Idempotence**: This operation is not idempotent. If you invoke this operation repeatedly, multiple knowledge bases with the same name may be created. Implement idempotence by using the "query first, then create" logic when you invoke this operation.
|
|
356
|
+
* **Throttling:**
|
|
357
|
+
* This operation is throttled if called frequently. Do not exceed 10 calls per second. If throttling occurs, retry later.
|
|
356
358
|
*
|
|
357
359
|
* @param request - CreateIndexRequest
|
|
358
360
|
* @returns CreateIndexResponse
|
|
@@ -362,9 +364,9 @@ export default class Client extends OpenApi {
|
|
|
362
364
|
* Creates a long-term memory.
|
|
363
365
|
*
|
|
364
366
|
* @remarks
|
|
365
|
-
* - You can store specific information from
|
|
366
|
-
* > Long-term memory does not support storing and managing user profiles
|
|
367
|
-
* - If you pass a `memoryId`, the system
|
|
367
|
+
* - You can store specific information from the conversation procedure (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 automatic. 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. 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 performs automatic creation of 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.
|
|
368
370
|
* - This operation does not support idempotence.
|
|
369
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.
|
|
370
372
|
*
|
|
@@ -380,9 +382,9 @@ export default class Client extends OpenApi {
|
|
|
380
382
|
* Creates a long-term memory.
|
|
381
383
|
*
|
|
382
384
|
* @remarks
|
|
383
|
-
* - You can store specific information from
|
|
384
|
-
* > Long-term memory does not support storing and managing user profiles
|
|
385
|
-
* - If you pass a `memoryId`, the system
|
|
385
|
+
* - You can store specific information from the conversation procedure (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 automatic. 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. 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 performs automatic creation of 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.
|
|
386
388
|
* - This operation does not support idempotence.
|
|
387
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.
|
|
388
390
|
*
|
|
@@ -454,10 +456,10 @@ export default class Client extends OpenApi {
|
|
|
454
456
|
* Permanently deletes a specified category.
|
|
455
457
|
*
|
|
456
458
|
* @remarks
|
|
457
|
-
* - Resource Access Management (RAM)
|
|
458
|
-
* - This operation
|
|
459
|
-
* **
|
|
460
|
-
* This operation is subject to
|
|
459
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory 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">[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.
|
|
460
|
+
* - This operation has idempotence.
|
|
461
|
+
* **Throttling:**
|
|
462
|
+
* This operation is subject to throttling. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
461
463
|
*
|
|
462
464
|
* @param request - DeleteCategoryRequest
|
|
463
465
|
* @param headers - map
|
|
@@ -471,28 +473,28 @@ export default class Client extends OpenApi {
|
|
|
471
473
|
* Permanently deletes a specified category.
|
|
472
474
|
*
|
|
473
475
|
* @remarks
|
|
474
|
-
* - Resource Access Management (RAM)
|
|
475
|
-
* - This operation
|
|
476
|
-
* **
|
|
477
|
-
* This operation is subject to
|
|
476
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory 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">[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.
|
|
477
|
+
* - This operation has idempotence.
|
|
478
|
+
* **Throttling:**
|
|
479
|
+
* This operation is subject to throttling. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
478
480
|
*
|
|
479
481
|
* @param request - DeleteCategoryRequest
|
|
480
482
|
* @returns DeleteCategoryResponse
|
|
481
483
|
*/
|
|
482
484
|
deleteCategory(CategoryId: string, WorkspaceId: string, request: $_model.DeleteCategoryRequest): Promise<$_model.DeleteCategoryResponse>;
|
|
483
485
|
/**
|
|
484
|
-
* Deletes specified text
|
|
486
|
+
* Deletes a specified text chunk from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
485
487
|
*
|
|
486
488
|
* @remarks
|
|
487
489
|
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
488
490
|
* - **Permission requirements**:
|
|
489
|
-
* - **Resource Access Management (RAM) user**:
|
|
490
|
-
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
491
|
-
* - **
|
|
492
|
-
* - **Effective
|
|
493
|
-
* - **Idempotence**: This operation is idempotent.
|
|
494
|
-
* **Rate
|
|
495
|
-
*
|
|
491
|
+
* - **Resource Access Management (RAM) user (sub-account)**: You must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm: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 (main account)**: Has permissions by default and can invoke this operation directly.
|
|
493
|
+
* - **Calling method**: 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). The SDK encapsulates the complex signature calculation logic as an encapsulation of the signing procedure, simplifying your invocation process.
|
|
494
|
+
* - **Effective delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
495
|
+
* - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been successfully deleted, the operation returns a success response.
|
|
496
|
+
* **Rate limiting:**
|
|
497
|
+
* Frequent calls to this operation may be throttled. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
496
498
|
*
|
|
497
499
|
* @param tmpReq - DeleteChunkRequest
|
|
498
500
|
* @param headers - map
|
|
@@ -503,18 +505,18 @@ export default class Client extends OpenApi {
|
|
|
503
505
|
[key: string]: string;
|
|
504
506
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteChunkResponse>;
|
|
505
507
|
/**
|
|
506
|
-
* Deletes specified text
|
|
508
|
+
* Deletes a specified text chunk from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
507
509
|
*
|
|
508
510
|
* @remarks
|
|
509
511
|
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
510
512
|
* - **Permission requirements**:
|
|
511
|
-
* - **Resource Access Management (RAM) user**:
|
|
512
|
-
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
513
|
-
* - **
|
|
514
|
-
* - **Effective
|
|
515
|
-
* - **Idempotence**: This operation is idempotent.
|
|
516
|
-
* **Rate
|
|
517
|
-
*
|
|
513
|
+
* - **Resource Access Management (RAM) user (sub-account)**: You must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm: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 (main account)**: Has permissions by default and can invoke this operation directly.
|
|
515
|
+
* - **Calling method**: 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). The SDK encapsulates the complex signature calculation logic as an encapsulation of the signing procedure, simplifying your invocation process.
|
|
516
|
+
* - **Effective delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
517
|
+
* - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been successfully deleted, the operation returns a success response.
|
|
518
|
+
* **Rate limiting:**
|
|
519
|
+
* Frequent calls to this operation may be throttled. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
518
520
|
*
|
|
519
521
|
* @param request - DeleteChunkRequest
|
|
520
522
|
* @returns DeleteChunkResponse
|
|
@@ -551,16 +553,16 @@ export default class Client extends OpenApi {
|
|
|
551
553
|
*/
|
|
552
554
|
deleteConnector(ConnectorId: string, WorkspaceId: string, request: $_model.DeleteConnectorRequest): Promise<$_model.DeleteConnectorResponse>;
|
|
553
555
|
/**
|
|
554
|
-
* Permanently
|
|
556
|
+
* Permanently deletes a specified file from application data. Deleting data tables through the API is not supported. For more information, see the operation description below.
|
|
555
557
|
*
|
|
556
558
|
* @remarks
|
|
557
|
-
* - Deleting data tables
|
|
558
|
-
* - This
|
|
559
|
-
* - A RAM user must first obtain
|
|
560
|
-
* - This
|
|
561
|
-
* - This
|
|
562
|
-
* **Rate
|
|
563
|
-
*
|
|
559
|
+
* - 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).
|
|
560
|
+
* - This operation deletes files from <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 knowledge bases that have already been built. To delete files from a knowledge base, invoke the **DeleteIndexDocument** operation.
|
|
561
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:DeleteFile 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">[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.
|
|
562
|
+
* - This operation can only delete files in the parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS) state.
|
|
563
|
+
* - This operation has idempotence.
|
|
564
|
+
* **Rate limit:**
|
|
565
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
564
566
|
*
|
|
565
567
|
* @param request - DeleteFileRequest
|
|
566
568
|
* @param headers - map
|
|
@@ -571,32 +573,32 @@ export default class Client extends OpenApi {
|
|
|
571
573
|
[key: string]: string;
|
|
572
574
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFileResponse>;
|
|
573
575
|
/**
|
|
574
|
-
* Permanently
|
|
576
|
+
* Permanently deletes a specified file from application data. Deleting data tables through the API is not supported. For more information, see the operation description below.
|
|
575
577
|
*
|
|
576
578
|
* @remarks
|
|
577
|
-
* - Deleting data tables
|
|
578
|
-
* - This
|
|
579
|
-
* - A RAM user must first obtain
|
|
580
|
-
* - This
|
|
581
|
-
* - This
|
|
582
|
-
* **Rate
|
|
583
|
-
*
|
|
579
|
+
* - 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).
|
|
580
|
+
* - This operation deletes files from <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 knowledge bases that have already been built. To delete files from a knowledge base, invoke the **DeleteIndexDocument** operation.
|
|
581
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:DeleteFile 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">[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.
|
|
582
|
+
* - This operation can only delete files in the parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS) state.
|
|
583
|
+
* - This operation has idempotence.
|
|
584
|
+
* **Rate limit:**
|
|
585
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
584
586
|
*
|
|
585
587
|
* @param request - DeleteFileRequest
|
|
586
588
|
* @returns DeleteFileResponse
|
|
587
589
|
*/
|
|
588
590
|
deleteFile(FileId: string, WorkspaceId: string, request: $_model.DeleteFileRequest): Promise<$_model.DeleteFileResponse>;
|
|
589
591
|
/**
|
|
590
|
-
*
|
|
592
|
+
* Deletes files in batches.
|
|
591
593
|
*
|
|
592
594
|
* @remarks
|
|
593
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).
|
|
594
|
-
* - This
|
|
595
|
-
* - A
|
|
596
|
-
* - This operation can only delete files
|
|
597
|
-
* - This operation
|
|
596
|
+
* - This operation deletes files from <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 knowledge bases that have already been built. To delete files from a knowledge base, invoke the **DeleteIndexDocument** operation.
|
|
597
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:DeleteFiles 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">[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.
|
|
598
|
+
* - This operation can only delete files with a status of parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS).
|
|
599
|
+
* - This operation has idempotence.
|
|
598
600
|
* **Throttling:**
|
|
599
|
-
*
|
|
601
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
600
602
|
*
|
|
601
603
|
* @param tmpReq - DeleteFilesRequest
|
|
602
604
|
* @param headers - map
|
|
@@ -607,16 +609,16 @@ export default class Client extends OpenApi {
|
|
|
607
609
|
[key: string]: string;
|
|
608
610
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFilesResponse>;
|
|
609
611
|
/**
|
|
610
|
-
*
|
|
612
|
+
* Deletes files in batches.
|
|
611
613
|
*
|
|
612
614
|
* @remarks
|
|
613
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).
|
|
614
|
-
* - This
|
|
615
|
-
* - A
|
|
616
|
-
* - This operation can only delete files
|
|
617
|
-
* - This operation
|
|
616
|
+
* - This operation deletes files from <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 knowledge bases that have already been built. To delete files from a knowledge base, invoke the **DeleteIndexDocument** operation.
|
|
617
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:DeleteFiles 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">[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.
|
|
618
|
+
* - This operation can only delete files with a status of parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS).
|
|
619
|
+
* - This operation has idempotence.
|
|
618
620
|
* **Throttling:**
|
|
619
|
-
*
|
|
621
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
620
622
|
*
|
|
621
623
|
* @param request - DeleteFilesRequest
|
|
622
624
|
* @returns DeleteFilesResponse
|
|
@@ -770,10 +772,10 @@ export default class Client extends OpenApi {
|
|
|
770
772
|
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
771
773
|
*
|
|
772
774
|
* @remarks
|
|
773
|
-
* -
|
|
775
|
+
* - Resource Access Management (RAM) users must first obtain the [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 they can call this operation. Alibaba Cloud accounts can call this operation directly without authorization. We recommend that you 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) to call this operation.
|
|
774
776
|
* - This operation is idempotent.
|
|
775
|
-
* **Throttling:**
|
|
776
|
-
* This operation is throttled if called too frequently. Do not
|
|
777
|
+
* **Throttling rules:**
|
|
778
|
+
* This operation is throttled if it is called too frequently. Do not call this operation more than 10 times per second. If the operation is throttled, retry later.
|
|
777
779
|
*
|
|
778
780
|
* @param request - DescribeFileRequest
|
|
779
781
|
* @param headers - map
|
|
@@ -787,10 +789,10 @@ export default class Client extends OpenApi {
|
|
|
787
789
|
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
788
790
|
*
|
|
789
791
|
* @remarks
|
|
790
|
-
* -
|
|
792
|
+
* - Resource Access Management (RAM) users must first obtain the [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 they can call this operation. Alibaba Cloud accounts can call this operation directly without authorization. We recommend that you 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) to call this operation.
|
|
791
793
|
* - This operation is idempotent.
|
|
792
|
-
* **Throttling:**
|
|
793
|
-
* This operation is throttled if called too frequently. Do not
|
|
794
|
+
* **Throttling rules:**
|
|
795
|
+
* This operation is throttled if it is called too frequently. Do not call this operation more than 10 times per second. If the operation is throttled, retry later.
|
|
794
796
|
*
|
|
795
797
|
* @param request - DescribeFileRequest
|
|
796
798
|
* @returns DescribeFileResponse
|
|
@@ -833,13 +835,13 @@ export default class Client extends OpenApi {
|
|
|
833
835
|
*/
|
|
834
836
|
getAlipayUrl(request: $_model.GetAlipayUrlRequest): Promise<$_model.GetAlipayUrlResponse>;
|
|
835
837
|
/**
|
|
836
|
-
*
|
|
838
|
+
* Retrieves the list of all supported parser types based on the specified file type (file name extension).
|
|
837
839
|
*
|
|
838
840
|
* @remarks
|
|
839
|
-
* - RAM
|
|
840
|
-
* -
|
|
841
|
-
*
|
|
842
|
-
*
|
|
841
|
+
* - Resource Access Management (RAM) users 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:GetAvailableParserTypes 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.
|
|
842
|
+
* - This operation is idempotent.
|
|
843
|
+
* **Throttling:**
|
|
844
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
843
845
|
*
|
|
844
846
|
* @param request - GetAvailableParserTypesRequest
|
|
845
847
|
* @param headers - map
|
|
@@ -850,13 +852,13 @@ export default class Client extends OpenApi {
|
|
|
850
852
|
[key: string]: string;
|
|
851
853
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetAvailableParserTypesResponse>;
|
|
852
854
|
/**
|
|
853
|
-
*
|
|
855
|
+
* Retrieves the list of all supported parser types based on the specified file type (file name extension).
|
|
854
856
|
*
|
|
855
857
|
* @remarks
|
|
856
|
-
* - RAM
|
|
857
|
-
* -
|
|
858
|
-
*
|
|
859
|
-
*
|
|
858
|
+
* - Resource Access Management (RAM) users 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:GetAvailableParserTypes 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.
|
|
859
|
+
* - This operation is idempotent.
|
|
860
|
+
* **Throttling:**
|
|
861
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
860
862
|
*
|
|
861
863
|
* @param request - GetAvailableParserTypesRequest
|
|
862
864
|
* @returns GetAvailableParserTypesResponse
|
|
@@ -893,13 +895,13 @@ export default class Client extends OpenApi {
|
|
|
893
895
|
*/
|
|
894
896
|
getConnector(WorkspaceId: string, request: $_model.GetConnectorRequest): Promise<$_model.GetConnectorResponse>;
|
|
895
897
|
/**
|
|
896
|
-
* Queries the current status of a specified knowledge base creation task or knowledge base document
|
|
898
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document addition task.
|
|
897
899
|
*
|
|
898
900
|
* @remarks
|
|
899
|
-
* - Resource Access Management (RAM)
|
|
900
|
-
* - You must have a knowledge base job that is
|
|
901
|
-
* -
|
|
902
|
-
* - This operation
|
|
901
|
+
* - To invoke this operation, a Resource Access Management (RAM) user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for 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). An Alibaba Cloud account can invoke this operation directly without authorization. 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) to invoke this operation.
|
|
902
|
+
* - You must have a knowledge base job task that is being executed. To create a knowledge base task, invoke the **SubmitIndexJob** operation. To create a knowledge base append task, invoke the **SubmitIndexAddDocumentsJob** operation. You must also obtain the corresponding `JobId`.
|
|
903
|
+
* - Set the interval between invocations of this operation to at least 5 seconds.
|
|
904
|
+
* - This operation is idempotent.
|
|
903
905
|
*
|
|
904
906
|
* @param request - GetIndexJobStatusRequest
|
|
905
907
|
* @param headers - map
|
|
@@ -910,13 +912,13 @@ export default class Client extends OpenApi {
|
|
|
910
912
|
[key: string]: string;
|
|
911
913
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexJobStatusResponse>;
|
|
912
914
|
/**
|
|
913
|
-
* Queries the current status of a specified knowledge base creation task or knowledge base document
|
|
915
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document addition task.
|
|
914
916
|
*
|
|
915
917
|
* @remarks
|
|
916
|
-
* - Resource Access Management (RAM)
|
|
917
|
-
* - You must have a knowledge base job that is
|
|
918
|
-
* -
|
|
919
|
-
* - This operation
|
|
918
|
+
* - To invoke this operation, a Resource Access Management (RAM) user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for 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). An Alibaba Cloud account can invoke this operation directly without authorization. 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) to invoke this operation.
|
|
919
|
+
* - You must have a knowledge base job task that is being executed. To create a knowledge base task, invoke the **SubmitIndexJob** operation. To create a knowledge base append task, invoke the **SubmitIndexAddDocumentsJob** operation. You must also obtain the corresponding `JobId`.
|
|
920
|
+
* - Set the interval between invocations of this operation to at least 5 seconds.
|
|
921
|
+
* - This operation is idempotent.
|
|
920
922
|
*
|
|
921
923
|
* @param request - GetIndexJobStatusRequest
|
|
922
924
|
* @returns GetIndexJobStatusResponse
|
|
@@ -997,13 +999,13 @@ export default class Client extends OpenApi {
|
|
|
997
999
|
*/
|
|
998
1000
|
getMemoryNode(workspaceId: string, memoryId: string, memoryNodeId: string, request: $_model.GetMemoryNodeRequest): Promise<$_model.GetMemoryNodeResponse>;
|
|
999
1001
|
/**
|
|
1000
|
-
* Queries the data parsing settings
|
|
1002
|
+
* Queries the data parsing settings for a specified category.
|
|
1001
1003
|
*
|
|
1002
1004
|
* @remarks
|
|
1003
|
-
* - RAM
|
|
1004
|
-
* -
|
|
1005
|
-
*
|
|
1006
|
-
*
|
|
1005
|
+
* - 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:GetParseSettings permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
1006
|
+
* - This operation is idempotent.
|
|
1007
|
+
* **Throttling:**
|
|
1008
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1007
1009
|
*
|
|
1008
1010
|
* @param request - GetParseSettingsRequest
|
|
1009
1011
|
* @param headers - map
|
|
@@ -1014,13 +1016,13 @@ export default class Client extends OpenApi {
|
|
|
1014
1016
|
[key: string]: string;
|
|
1015
1017
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetParseSettingsResponse>;
|
|
1016
1018
|
/**
|
|
1017
|
-
* Queries the data parsing settings
|
|
1019
|
+
* Queries the data parsing settings for a specified category.
|
|
1018
1020
|
*
|
|
1019
1021
|
* @remarks
|
|
1020
|
-
* - RAM
|
|
1021
|
-
* -
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1022
|
+
* - 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:GetParseSettings permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
1023
|
+
* - This operation is idempotent.
|
|
1024
|
+
* **Throttling:**
|
|
1025
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1024
1026
|
*
|
|
1025
1027
|
* @param request - GetParseSettingsRequest
|
|
1026
1028
|
* @returns GetParseSettingsResponse
|
|
@@ -1084,11 +1086,12 @@ export default class Client extends OpenApi {
|
|
|
1084
1086
|
* Retrieves the details of one or more categories in a specified workspace.
|
|
1085
1087
|
*
|
|
1086
1088
|
* @remarks
|
|
1087
|
-
* -
|
|
1088
|
-
* -
|
|
1089
|
-
* -
|
|
1090
|
-
* - This operation
|
|
1091
|
-
* **Rate
|
|
1089
|
+
* - Querying data tables by using API operations is not supported.
|
|
1090
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListCategory 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">[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.
|
|
1091
|
+
* - When performing a paging query for the first page, 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 set `MaxResults` to limit the number of entries returned.
|
|
1092
|
+
* - This operation has idempotence.
|
|
1093
|
+
* **Rate limit:**
|
|
1094
|
+
* This operation is subject to rate limiting if called too frequently. Do not exceed 5 calls per second. If you are rate-limited, retry later.
|
|
1092
1095
|
*
|
|
1093
1096
|
* @param request - ListCategoryRequest
|
|
1094
1097
|
* @param headers - map
|
|
@@ -1102,11 +1105,12 @@ export default class Client extends OpenApi {
|
|
|
1102
1105
|
* Retrieves the details of one or more categories in a specified workspace.
|
|
1103
1106
|
*
|
|
1104
1107
|
* @remarks
|
|
1105
|
-
* -
|
|
1106
|
-
* -
|
|
1107
|
-
* -
|
|
1108
|
-
* - This operation
|
|
1109
|
-
* **Rate
|
|
1108
|
+
* - Querying data tables by using API operations is not supported.
|
|
1109
|
+
* - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListCategory 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">[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.
|
|
1110
|
+
* - When performing a paging query for the first page, 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 set `MaxResults` to limit the number of entries returned.
|
|
1111
|
+
* - This operation has idempotence.
|
|
1112
|
+
* **Rate limit:**
|
|
1113
|
+
* This operation is subject to rate limiting if called too frequently. Do not exceed 5 calls per second. If you are rate-limited, retry later.
|
|
1110
1114
|
*
|
|
1111
1115
|
* @param request - ListCategoryRequest
|
|
1112
1116
|
* @returns ListCategoryResponse
|
|
@@ -1150,11 +1154,11 @@ export default class Client extends OpenApi {
|
|
|
1150
1154
|
* Retrieves the details of one or more documents in a specified category.
|
|
1151
1155
|
*
|
|
1152
1156
|
* @remarks
|
|
1153
|
-
* - 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)
|
|
1154
|
-
* -
|
|
1157
|
+
* - 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. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
1158
|
+
* - When querying the first page with paging, simply set `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 set `MaxResults` to limit the number of entries returned.
|
|
1155
1159
|
* - This operation is idempotent.
|
|
1156
1160
|
* **Rate limit:**
|
|
1157
|
-
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
1161
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1158
1162
|
*
|
|
1159
1163
|
* @param tmpReq - ListFileRequest
|
|
1160
1164
|
* @param headers - map
|
|
@@ -1168,25 +1172,25 @@ export default class Client extends OpenApi {
|
|
|
1168
1172
|
* Retrieves the details of one or more documents in a specified category.
|
|
1169
1173
|
*
|
|
1170
1174
|
* @remarks
|
|
1171
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission)
|
|
1172
|
-
* -
|
|
1175
|
+
* - 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. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
|
|
1176
|
+
* - When querying the first page with paging, simply set `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 set `MaxResults` to limit the number of entries returned.
|
|
1173
1177
|
* - This operation is idempotent.
|
|
1174
1178
|
* **Rate limit:**
|
|
1175
|
-
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
1179
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1176
1180
|
*
|
|
1177
1181
|
* @param request - ListFileRequest
|
|
1178
1182
|
* @returns ListFileResponse
|
|
1179
1183
|
*/
|
|
1180
1184
|
listFile(WorkspaceId: string, request: $_model.ListFileRequest): Promise<$_model.ListFileResponse>;
|
|
1181
1185
|
/**
|
|
1182
|
-
* Retrieves files and their summary information from a specified knowledge base.
|
|
1186
|
+
* Retrieves the files and their summary information from a specified knowledge base.
|
|
1183
1187
|
*
|
|
1184
1188
|
* @remarks
|
|
1185
|
-
* - 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.
|
|
1189
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission), 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.
|
|
1186
1190
|
* - 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).
|
|
1187
1191
|
* - This operation has idempotence.
|
|
1188
1192
|
* **Throttling:**
|
|
1189
|
-
* This operation is
|
|
1193
|
+
* This operation is subject to throttling. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
1190
1194
|
*
|
|
1191
1195
|
* @param request - ListIndexDocumentsRequest
|
|
1192
1196
|
* @param headers - map
|
|
@@ -1197,14 +1201,14 @@ export default class Client extends OpenApi {
|
|
|
1197
1201
|
[key: string]: string;
|
|
1198
1202
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexDocumentsResponse>;
|
|
1199
1203
|
/**
|
|
1200
|
-
* Retrieves files and their summary information from a specified knowledge base.
|
|
1204
|
+
* Retrieves the files and their summary information from a specified knowledge base.
|
|
1201
1205
|
*
|
|
1202
1206
|
* @remarks
|
|
1203
|
-
* - 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.
|
|
1207
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission), 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.
|
|
1204
1208
|
* - 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).
|
|
1205
1209
|
* - This operation has idempotence.
|
|
1206
1210
|
* **Throttling:**
|
|
1207
|
-
* This operation is
|
|
1211
|
+
* This operation is subject to throttling. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
1208
1212
|
*
|
|
1209
1213
|
* @param request - ListIndexDocumentsRequest
|
|
1210
1214
|
* @returns ListIndexDocumentsResponse
|
|
@@ -1242,10 +1246,10 @@ export default class Client extends OpenApi {
|
|
|
1242
1246
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1243
1247
|
*
|
|
1244
1248
|
* @remarks
|
|
1245
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Alibaba Cloud accounts can invoke this operation directly without authorization.
|
|
1249
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Alibaba Cloud accounts can invoke this operation directly without authorization. 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).
|
|
1246
1250
|
* - This operation has idempotence.
|
|
1247
|
-
* **
|
|
1248
|
-
* This operation is
|
|
1251
|
+
* **Throttling:**
|
|
1252
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1249
1253
|
*
|
|
1250
1254
|
* @param request - ListIndicesRequest
|
|
1251
1255
|
* @param headers - map
|
|
@@ -1259,10 +1263,10 @@ export default class Client extends OpenApi {
|
|
|
1259
1263
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
1260
1264
|
*
|
|
1261
1265
|
* @remarks
|
|
1262
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Alibaba Cloud accounts can invoke this operation directly without authorization.
|
|
1266
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Alibaba Cloud accounts can invoke this operation directly without authorization. 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).
|
|
1263
1267
|
* - This operation has idempotence.
|
|
1264
|
-
* **
|
|
1265
|
-
* This operation is
|
|
1268
|
+
* **Throttling:**
|
|
1269
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1266
1270
|
*
|
|
1267
1271
|
* @param request - ListIndicesRequest
|
|
1268
1272
|
* @returns ListIndicesResponse
|
|
@@ -1272,7 +1276,7 @@ export default class Client extends OpenApi {
|
|
|
1272
1276
|
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
1273
1277
|
*
|
|
1274
1278
|
* @remarks
|
|
1275
|
-
* - When
|
|
1279
|
+
* - When performing a paged query for the first page, only set `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 set `MaxResults` to limit the number of entries returned.
|
|
1276
1280
|
* - This operation supports idempotence.
|
|
1277
1281
|
* **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.
|
|
1278
1282
|
*
|
|
@@ -1288,7 +1292,7 @@ export default class Client extends OpenApi {
|
|
|
1288
1292
|
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
1289
1293
|
*
|
|
1290
1294
|
* @remarks
|
|
1291
|
-
* - When
|
|
1295
|
+
* - When performing a paged query for the first page, only set `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 set `MaxResults` to limit the number of entries returned.
|
|
1292
1296
|
* - This operation supports idempotence.
|
|
1293
1297
|
* **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.
|
|
1294
1298
|
*
|
|
@@ -1355,19 +1359,19 @@ export default class Client extends OpenApi {
|
|
|
1355
1359
|
*
|
|
1356
1360
|
* @remarks
|
|
1357
1361
|
* <props="china">
|
|
1358
|
-
* - **
|
|
1359
|
-
* - **
|
|
1360
|
-
* - **
|
|
1361
|
-
* - **Alibaba Cloud account
|
|
1362
|
-
* - **Response latency**:
|
|
1363
|
-
* - **
|
|
1362
|
+
* - **Invocation method**: You can retrieve the knowledge base by using the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) (with an Alibaba Cloud [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 methods provide encapsulation of complex signature calculation logic to simplify the invocation procedure.
|
|
1363
|
+
* - **Permission requirements**:
|
|
1364
|
+
* - **Resource Access Management (RAM) user**: You must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:Retrieve permission required by this operation) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you can invoke this operation.
|
|
1365
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
1366
|
+
* - **Response latency**: Because the operation involves complex retrieval and matching, the response time may be long. Configure appropriate timeout and retry settings for your requests.
|
|
1367
|
+
* - **Idempotence**: This operation is idempotent.
|
|
1364
1368
|
* <props="intl">
|
|
1365
|
-
* - **
|
|
1366
|
-
* - **
|
|
1367
|
-
* - **
|
|
1368
|
-
* - **Alibaba Cloud account
|
|
1369
|
-
* - **Response latency**:
|
|
1370
|
-
* - **
|
|
1369
|
+
* - **Invocation method**: Use the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic to simplify the invocation procedure.
|
|
1370
|
+
* - **Permission requirements**:
|
|
1371
|
+
* - **Resource Access Management (RAM) user**: You must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:Retrieve permission required by this operation) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you can invoke this operation.
|
|
1372
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
1373
|
+
* - **Response latency**: Because the operation involves complex retrieval and matching, the response time may be long. Configure appropriate timeout and retry settings for your requests.
|
|
1374
|
+
* - **Idempotence**: This operation is idempotent.
|
|
1371
1375
|
*
|
|
1372
1376
|
* @param tmpReq - RetrieveRequest
|
|
1373
1377
|
* @param headers - map
|
|
@@ -1382,19 +1386,19 @@ export default class Client extends OpenApi {
|
|
|
1382
1386
|
*
|
|
1383
1387
|
* @remarks
|
|
1384
1388
|
* <props="china">
|
|
1385
|
-
* - **
|
|
1386
|
-
* - **
|
|
1387
|
-
* - **
|
|
1388
|
-
* - **Alibaba Cloud account
|
|
1389
|
-
* - **Response latency**:
|
|
1390
|
-
* - **
|
|
1389
|
+
* - **Invocation method**: You can retrieve the knowledge base by using the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) (with an Alibaba Cloud [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 methods provide encapsulation of complex signature calculation logic to simplify the invocation procedure.
|
|
1390
|
+
* - **Permission requirements**:
|
|
1391
|
+
* - **Resource Access Management (RAM) user**: You must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:Retrieve permission required by this operation) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you can invoke this operation.
|
|
1392
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
1393
|
+
* - **Response latency**: Because the operation involves complex retrieval and matching, the response time may be long. Configure appropriate timeout and retry settings for your requests.
|
|
1394
|
+
* - **Idempotence**: This operation is idempotent.
|
|
1391
1395
|
* <props="intl">
|
|
1392
|
-
* - **
|
|
1393
|
-
* - **
|
|
1394
|
-
* - **
|
|
1395
|
-
* - **Alibaba Cloud account
|
|
1396
|
-
* - **Response latency**:
|
|
1397
|
-
* - **
|
|
1396
|
+
* - **Invocation method**: Use the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic to simplify the invocation procedure.
|
|
1397
|
+
* - **Permission requirements**:
|
|
1398
|
+
* - **Resource Access Management (RAM) user**: You must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:Retrieve permission required by this operation) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you can invoke this operation.
|
|
1399
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
1400
|
+
* - **Response latency**: Because the operation involves complex retrieval and matching, the response time may be long. Configure appropriate timeout and retry settings for your requests.
|
|
1401
|
+
* - **Idempotence**: This operation is idempotent.
|
|
1398
1402
|
*
|
|
1399
1403
|
* @param request - RetrieveRequest
|
|
1400
1404
|
* @returns RetrieveResponse
|
|
@@ -1520,15 +1524,15 @@ export default class Client extends OpenApi {
|
|
|
1520
1524
|
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
1521
1525
|
*
|
|
1522
1526
|
* @remarks
|
|
1523
|
-
* - **Key
|
|
1527
|
+
* - **Key restrictions**: This operation supports only document search knowledge bases. Data query and image-based Q&A knowledge bases are not supported.
|
|
1524
1528
|
* - **Permission requirements**:
|
|
1525
|
-
* - **Resource Access Management (RAM) user**:
|
|
1529
|
+
* - **Resource Access Management (RAM) user (sub-account)**: You must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you invoke this operation.
|
|
1526
1530
|
* - **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
|
|
1528
|
-
* - **
|
|
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.
|
|
1531
|
+
* - **Calling method**: 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). The SDK encapsulates the complex signature calculation logic as encapsulation to simplify the invocation procedure.
|
|
1532
|
+
* - **Propagation delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
1533
|
+
* - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been successfully updated, the operation returns a success response.
|
|
1530
1534
|
* **Rate limit:**
|
|
1531
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If
|
|
1535
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
1532
1536
|
*
|
|
1533
1537
|
* @param request - UpdateChunkRequest
|
|
1534
1538
|
* @param headers - map
|
|
@@ -1542,15 +1546,15 @@ export default class Client extends OpenApi {
|
|
|
1542
1546
|
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
1543
1547
|
*
|
|
1544
1548
|
* @remarks
|
|
1545
|
-
* - **Key
|
|
1549
|
+
* - **Key restrictions**: This operation supports only document search knowledge bases. Data query and image-based Q&A knowledge bases are not supported.
|
|
1546
1550
|
* - **Permission requirements**:
|
|
1547
|
-
* - **Resource Access Management (RAM) user**:
|
|
1551
|
+
* - **Resource Access Management (RAM) user (sub-account)**: You must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before you invoke this operation.
|
|
1548
1552
|
* - **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
|
|
1550
|
-
* - **
|
|
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.
|
|
1553
|
+
* - **Calling method**: 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). The SDK encapsulates the complex signature calculation logic as encapsulation to simplify the invocation procedure.
|
|
1554
|
+
* - **Propagation delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
1555
|
+
* - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been successfully updated, the operation returns a success response.
|
|
1552
1556
|
* **Rate limit:**
|
|
1553
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If
|
|
1557
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
1554
1558
|
*
|
|
1555
1559
|
* @param request - UpdateChunkRequest
|
|
1556
1560
|
* @returns UpdateChunkResponse
|
|
@@ -1585,11 +1589,12 @@ export default class Client extends OpenApi {
|
|
|
1585
1589
|
*/
|
|
1586
1590
|
updateConnector(WorkspaceId: string, ConnectorId: string, request: $_model.UpdateConnectorRequest): Promise<$_model.UpdateConnectorResponse>;
|
|
1587
1591
|
/**
|
|
1588
|
-
* Updates the tags
|
|
1592
|
+
* Updates the tags of a specified file.
|
|
1589
1593
|
*
|
|
1590
1594
|
* @remarks
|
|
1591
|
-
* -
|
|
1592
|
-
* **
|
|
1595
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1596
|
+
* **Rate limiting:**
|
|
1597
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1593
1598
|
*
|
|
1594
1599
|
* @param tmpReq - UpdateFileTagRequest
|
|
1595
1600
|
* @param headers - map
|
|
@@ -1600,24 +1605,26 @@ export default class Client extends OpenApi {
|
|
|
1600
1605
|
[key: string]: string;
|
|
1601
1606
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateFileTagResponse>;
|
|
1602
1607
|
/**
|
|
1603
|
-
* Updates the tags
|
|
1608
|
+
* Updates the tags of a specified file.
|
|
1604
1609
|
*
|
|
1605
1610
|
* @remarks
|
|
1606
|
-
* -
|
|
1607
|
-
* **
|
|
1611
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
|
|
1612
|
+
* **Rate limiting:**
|
|
1613
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1608
1614
|
*
|
|
1609
1615
|
* @param request - UpdateFileTagRequest
|
|
1610
1616
|
* @returns UpdateFileTagResponse
|
|
1611
1617
|
*/
|
|
1612
1618
|
updateFileTag(WorkspaceId: string, FileId: string, request: $_model.UpdateFileTagRequest): Promise<$_model.UpdateFileTagResponse>;
|
|
1613
1619
|
/**
|
|
1614
|
-
* Updates
|
|
1620
|
+
* Updates partial configurations of a specified knowledge base.
|
|
1615
1621
|
*
|
|
1616
1622
|
* @remarks
|
|
1617
|
-
* <props="intl">This operation is not
|
|
1618
|
-
*
|
|
1619
|
-
*
|
|
1620
|
-
*
|
|
1623
|
+
* <props="intl">This operation is not supported on the Chinese site.
|
|
1624
|
+
* <props="china">
|
|
1625
|
+
* A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required) 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 [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1626
|
+
* 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).
|
|
1627
|
+
* This operation supports idempotence.
|
|
1621
1628
|
*
|
|
1622
1629
|
* @param request - UpdateIndexRequest
|
|
1623
1630
|
* @param headers - map
|
|
@@ -1628,13 +1635,14 @@ export default class Client extends OpenApi {
|
|
|
1628
1635
|
[key: string]: string;
|
|
1629
1636
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIndexResponse>;
|
|
1630
1637
|
/**
|
|
1631
|
-
* Updates
|
|
1638
|
+
* Updates partial configurations of a specified knowledge base.
|
|
1632
1639
|
*
|
|
1633
1640
|
* @remarks
|
|
1634
|
-
* <props="intl">This operation is not
|
|
1635
|
-
*
|
|
1636
|
-
*
|
|
1637
|
-
*
|
|
1641
|
+
* <props="intl">This operation is not supported on the Chinese site.
|
|
1642
|
+
* <props="china">
|
|
1643
|
+
* A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required) 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 [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
|
|
1644
|
+
* 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).
|
|
1645
|
+
* This operation supports idempotence.
|
|
1638
1646
|
*
|
|
1639
1647
|
* @param request - UpdateIndexRequest
|
|
1640
1648
|
* @returns UpdateIndexResponse
|
|
@@ -1703,15 +1711,18 @@ export default class Client extends OpenApi {
|
|
|
1703
1711
|
*/
|
|
1704
1712
|
updatePromptTemplate(workspaceId: string, promptTemplateId: string, request: $_model.UpdatePromptTemplateRequest): Promise<$_model.UpdatePromptTemplateResponse>;
|
|
1705
1713
|
/**
|
|
1706
|
-
*
|
|
1714
|
+
* Updates a table in a table connector of Alibaba Cloud Model Studio Data Hub using a file from an authorized OSS bucket.
|
|
1707
1715
|
*
|
|
1708
1716
|
* @remarks
|
|
1709
|
-
* -
|
|
1710
|
-
*
|
|
1711
|
-
*
|
|
1712
|
-
*
|
|
1713
|
-
* -
|
|
1714
|
-
*
|
|
1717
|
+
* - Before calling this operation, the target data table must already exist. Pass its table ID as `TableId`. This operation only updates the specified table and does not create data tables.
|
|
1718
|
+
* - Make sure the OSS bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account. Add the tag key `bailian-datahub-access` and tag value `read` to the target bucket before importing.
|
|
1719
|
+
*
|
|
1720
|
+
* - Supported bucket storage classes exclude Archive, Cold Archive, and Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
|
|
1721
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, refer to [Allow only trusted websites to access](https://help.aliyun.com/document_detail/2636937.html) and add the domain `*.console.aliyun.com` to the Referer whitelist.
|
|
1722
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` permission policy is required, which includes the sfm:UpdateTableFromAuthorizedOss 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 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 operation.
|
|
1723
|
+
* - This operation does not guarantee idempotence.
|
|
1724
|
+
* **Rate limit:**
|
|
1725
|
+
* This operation is subject to rate limiting if called too frequently. Do not exceed 5 calls per second. If rate limiting occurs, retry after a short wait.
|
|
1715
1726
|
*
|
|
1716
1727
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
1717
1728
|
* @param headers - map
|
|
@@ -1722,15 +1733,18 @@ export default class Client extends OpenApi {
|
|
|
1722
1733
|
[key: string]: string;
|
|
1723
1734
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTableFromAuthorizedOssResponse>;
|
|
1724
1735
|
/**
|
|
1725
|
-
*
|
|
1736
|
+
* Updates a table in a table connector of Alibaba Cloud Model Studio Data Hub using a file from an authorized OSS bucket.
|
|
1726
1737
|
*
|
|
1727
1738
|
* @remarks
|
|
1728
|
-
* -
|
|
1729
|
-
*
|
|
1730
|
-
*
|
|
1731
|
-
*
|
|
1732
|
-
* -
|
|
1733
|
-
*
|
|
1739
|
+
* - Before calling this operation, the target data table must already exist. Pass its table ID as `TableId`. This operation only updates the specified table and does not create data tables.
|
|
1740
|
+
* - Make sure the OSS bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account. Add the tag key `bailian-datahub-access` and tag value `read` to the target bucket before importing.
|
|
1741
|
+
*
|
|
1742
|
+
* - Supported bucket storage classes exclude Archive, Cold Archive, and Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
|
|
1743
|
+
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, refer to [Allow only trusted websites to access](https://help.aliyun.com/document_detail/2636937.html) and add the domain `*.console.aliyun.com` to the Referer whitelist.
|
|
1744
|
+
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` permission policy is required, which includes the sfm:UpdateTableFromAuthorizedOss 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 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 operation.
|
|
1745
|
+
* - This operation does not guarantee idempotence.
|
|
1746
|
+
* **Rate limit:**
|
|
1747
|
+
* This operation is subject to rate limiting if called too frequently. Do not exceed 5 calls per second. If rate limiting occurs, retry after a short wait.
|
|
1734
1748
|
*
|
|
1735
1749
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
1736
1750
|
* @returns UpdateTableFromAuthorizedOssResponse
|