@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.js
CHANGED
|
@@ -49,10 +49,6 @@ class Client extends openapi_core_1.default {
|
|
|
49
49
|
constructor(config) {
|
|
50
50
|
super(config);
|
|
51
51
|
this._endpointRule = "regional";
|
|
52
|
-
this._endpointMap = {
|
|
53
|
-
'cn-beijing': "bailian.cn-beijing.aliyuncs.com",
|
|
54
|
-
'ap-southeast-1': "bailian.ap-southeast-1.aliyuncs.com",
|
|
55
|
-
};
|
|
56
52
|
this.checkConfig(config);
|
|
57
53
|
this._endpoint = this.getEndpoint("bailian", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
|
|
58
54
|
}
|
|
@@ -66,13 +62,14 @@ class Client extends openapi_core_1.default {
|
|
|
66
62
|
return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
|
|
67
63
|
}
|
|
68
64
|
/**
|
|
69
|
-
* Creates a category in a specified workspace
|
|
65
|
+
* Creates a category in a specified workspace for classifying and managing files. A maximum of 500 categories can be created in each workspace.
|
|
70
66
|
*
|
|
71
67
|
* @remarks
|
|
72
|
-
* -
|
|
73
|
-
* - A RAM user must obtain
|
|
74
|
-
* - This operation
|
|
75
|
-
* **
|
|
68
|
+
* - 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.
|
|
69
|
+
* - 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.
|
|
70
|
+
* - This operation does not support idempotence.
|
|
71
|
+
* **Throttling:**
|
|
72
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
76
73
|
*
|
|
77
74
|
* @param request - AddCategoryRequest
|
|
78
75
|
* @param headers - map
|
|
@@ -112,13 +109,14 @@ class Client extends openapi_core_1.default {
|
|
|
112
109
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddCategoryResponse({}));
|
|
113
110
|
}
|
|
114
111
|
/**
|
|
115
|
-
* Creates a category in a specified workspace
|
|
112
|
+
* Creates a category in a specified workspace for classifying and managing files. A maximum of 500 categories can be created in each workspace.
|
|
116
113
|
*
|
|
117
114
|
* @remarks
|
|
118
|
-
* -
|
|
119
|
-
* - A RAM user must obtain
|
|
120
|
-
* - This operation
|
|
121
|
-
* **
|
|
115
|
+
* - 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.
|
|
116
|
+
* - 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.
|
|
117
|
+
* - This operation does not support idempotence.
|
|
118
|
+
* **Throttling:**
|
|
119
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
122
120
|
*
|
|
123
121
|
* @param request - AddCategoryRequest
|
|
124
122
|
* @returns AddCategoryResponse
|
|
@@ -198,13 +196,13 @@ class Client extends openapi_core_1.default {
|
|
|
198
196
|
return await this.addChunkWithOptions(WorkspaceId, request, headers, runtime);
|
|
199
197
|
}
|
|
200
198
|
/**
|
|
201
|
-
* Creates a connector.
|
|
199
|
+
* Creates a connector. Currently, this operation supports creating only file-type connectors.
|
|
202
200
|
*
|
|
203
201
|
* @remarks
|
|
204
|
-
* -
|
|
202
|
+
* - 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.
|
|
205
203
|
* - This operation is not idempotent.
|
|
206
|
-
* **
|
|
207
|
-
*
|
|
204
|
+
* **Rate limit:**
|
|
205
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
208
206
|
*
|
|
209
207
|
* @param tmpReq - AddConnectorRequest
|
|
210
208
|
* @param headers - map
|
|
@@ -249,13 +247,13 @@ class Client extends openapi_core_1.default {
|
|
|
249
247
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddConnectorResponse({}));
|
|
250
248
|
}
|
|
251
249
|
/**
|
|
252
|
-
* Creates a connector.
|
|
250
|
+
* Creates a connector. Currently, this operation supports creating only file-type connectors.
|
|
253
251
|
*
|
|
254
252
|
* @remarks
|
|
255
|
-
* -
|
|
253
|
+
* - 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.
|
|
256
254
|
* - This operation is not idempotent.
|
|
257
|
-
* **
|
|
258
|
-
*
|
|
255
|
+
* **Rate limit:**
|
|
256
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
259
257
|
*
|
|
260
258
|
* @param request - AddConnectorRequest
|
|
261
259
|
* @returns AddConnectorResponse
|
|
@@ -266,13 +264,13 @@ class Client extends openapi_core_1.default {
|
|
|
266
264
|
return await this.addConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
267
265
|
}
|
|
268
266
|
/**
|
|
269
|
-
* 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).
|
|
267
|
+
* 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).
|
|
270
268
|
*
|
|
271
269
|
* @remarks
|
|
272
|
-
* - Resource Access Management (RAM)
|
|
270
|
+
* - 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.
|
|
273
271
|
* - This operation is not idempotent.
|
|
274
272
|
* **Throttling:**
|
|
275
|
-
* This operation is
|
|
273
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
276
274
|
*
|
|
277
275
|
* @param tmpReq - AddFileRequest
|
|
278
276
|
* @param headers - map
|
|
@@ -329,13 +327,13 @@ class Client extends openapi_core_1.default {
|
|
|
329
327
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFileResponse({}));
|
|
330
328
|
}
|
|
331
329
|
/**
|
|
332
|
-
* 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).
|
|
330
|
+
* 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).
|
|
333
331
|
*
|
|
334
332
|
* @remarks
|
|
335
|
-
* - Resource Access Management (RAM)
|
|
333
|
+
* - 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.
|
|
336
334
|
* - This operation is not idempotent.
|
|
337
335
|
* **Throttling:**
|
|
338
|
-
* This operation is
|
|
336
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
339
337
|
*
|
|
340
338
|
* @param request - AddFileRequest
|
|
341
339
|
* @returns AddFileResponse
|
|
@@ -349,14 +347,14 @@ class Client extends openapi_core_1.default {
|
|
|
349
347
|
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
350
348
|
*
|
|
351
349
|
* @remarks
|
|
352
|
-
* -
|
|
350
|
+
* - 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.
|
|
353
351
|
*
|
|
354
|
-
* - Supported bucket storage
|
|
355
|
-
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name
|
|
356
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the
|
|
357
|
-
* - This operation
|
|
358
|
-
* **
|
|
359
|
-
*
|
|
352
|
+
* - 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.
|
|
353
|
+
* - 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).
|
|
354
|
+
* - 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.
|
|
355
|
+
* - This operation is not idempotent.
|
|
356
|
+
* **Throttling:**
|
|
357
|
+
* Frequent calls to this operation are throttled. Do not exceed 5 calls per second. If throttling occurs, retry later.
|
|
360
358
|
*
|
|
361
359
|
* @param tmpReq - AddFilesFromAuthorizedOssRequest
|
|
362
360
|
* @param headers - map
|
|
@@ -416,14 +414,14 @@ class Client extends openapi_core_1.default {
|
|
|
416
414
|
* Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
|
|
417
415
|
*
|
|
418
416
|
* @remarks
|
|
419
|
-
* -
|
|
417
|
+
* - 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.
|
|
420
418
|
*
|
|
421
|
-
* - Supported bucket storage
|
|
422
|
-
* - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name
|
|
423
|
-
* - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the
|
|
424
|
-
* - This operation
|
|
425
|
-
* **
|
|
426
|
-
*
|
|
419
|
+
* - 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.
|
|
420
|
+
* - 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).
|
|
421
|
+
* - 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.
|
|
422
|
+
* - This operation is not idempotent.
|
|
423
|
+
* **Throttling:**
|
|
424
|
+
* Frequent calls to this operation are throttled. Do not exceed 5 calls per second. If throttling occurs, retry later.
|
|
427
425
|
*
|
|
428
426
|
* @param request - AddFilesFromAuthorizedOssRequest
|
|
429
427
|
* @returns AddFilesFromAuthorizedOssResponse
|
|
@@ -434,13 +432,13 @@ class Client extends openapi_core_1.default {
|
|
|
434
432
|
return await this.addFilesFromAuthorizedOssWithOptions(WorkspaceId, request, headers, runtime);
|
|
435
433
|
}
|
|
436
434
|
/**
|
|
437
|
-
*
|
|
435
|
+
* Adds a table to a tabular data connector.
|
|
438
436
|
*
|
|
439
437
|
* @remarks
|
|
440
|
-
* -
|
|
441
|
-
* - This
|
|
442
|
-
* **
|
|
443
|
-
* This
|
|
438
|
+
* - 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.
|
|
439
|
+
* - This operation is not idempotent.
|
|
440
|
+
* **Rate limit:**
|
|
441
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
444
442
|
*
|
|
445
443
|
* @param tmpReq - AddTableRequest
|
|
446
444
|
* @param headers - map
|
|
@@ -485,13 +483,13 @@ class Client extends openapi_core_1.default {
|
|
|
485
483
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddTableResponse({}));
|
|
486
484
|
}
|
|
487
485
|
/**
|
|
488
|
-
*
|
|
486
|
+
* Adds a table to a tabular data connector.
|
|
489
487
|
*
|
|
490
488
|
* @remarks
|
|
491
|
-
* -
|
|
492
|
-
* - This
|
|
493
|
-
* **
|
|
494
|
-
* This
|
|
489
|
+
* - 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.
|
|
490
|
+
* - This operation is not idempotent.
|
|
491
|
+
* **Rate limit:**
|
|
492
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
|
|
495
493
|
*
|
|
496
494
|
* @param request - AddTableRequest
|
|
497
495
|
* @returns AddTableResponse
|
|
@@ -502,13 +500,13 @@ class Client extends openapi_core_1.default {
|
|
|
502
500
|
return await this.addTableWithOptions(WorkspaceId, request, headers, runtime);
|
|
503
501
|
}
|
|
504
502
|
/**
|
|
505
|
-
*
|
|
503
|
+
* Requests an upload lease for uploading a knowledge base file or a file for agent application session interaction.
|
|
506
504
|
*
|
|
507
505
|
* @remarks
|
|
508
|
-
* -
|
|
509
|
-
* - This
|
|
506
|
+
* - 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.
|
|
507
|
+
* - This operation is not idempotent.
|
|
510
508
|
* **Throttling:**
|
|
511
|
-
* This
|
|
509
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
512
510
|
*
|
|
513
511
|
* @param request - ApplyFileUploadLeaseRequest
|
|
514
512
|
* @param headers - map
|
|
@@ -551,13 +549,13 @@ class Client extends openapi_core_1.default {
|
|
|
551
549
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ApplyFileUploadLeaseResponse({}));
|
|
552
550
|
}
|
|
553
551
|
/**
|
|
554
|
-
*
|
|
552
|
+
* Requests an upload lease for uploading a knowledge base file or a file for agent application session interaction.
|
|
555
553
|
*
|
|
556
554
|
* @remarks
|
|
557
|
-
* -
|
|
558
|
-
* - This
|
|
555
|
+
* - 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.
|
|
556
|
+
* - This operation is not idempotent.
|
|
559
557
|
* **Throttling:**
|
|
560
|
-
* This
|
|
558
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
561
559
|
*
|
|
562
560
|
* @param request - ApplyFileUploadLeaseRequest
|
|
563
561
|
* @returns ApplyFileUploadLeaseResponse
|
|
@@ -619,7 +617,7 @@ class Client extends openapi_core_1.default {
|
|
|
619
617
|
return await this.applyTempStorageLeaseWithOptions(WorkspaceId, request, headers, runtime);
|
|
620
618
|
}
|
|
621
619
|
/**
|
|
622
|
-
*
|
|
620
|
+
* Batch updates document tags in a data connection.
|
|
623
621
|
*
|
|
624
622
|
* @param tmpReq - BatchUpdateFileTagRequest
|
|
625
623
|
* @param headers - map
|
|
@@ -658,7 +656,7 @@ class Client extends openapi_core_1.default {
|
|
|
658
656
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.BatchUpdateFileTagResponse({}));
|
|
659
657
|
}
|
|
660
658
|
/**
|
|
661
|
-
*
|
|
659
|
+
* Batch updates document tags in a data connection.
|
|
662
660
|
*
|
|
663
661
|
* @param request - BatchUpdateFileTagRequest
|
|
664
662
|
* @returns BatchUpdateFileTagResponse
|
|
@@ -672,10 +670,10 @@ class Client extends openapi_core_1.default {
|
|
|
672
670
|
* 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.
|
|
673
671
|
*
|
|
674
672
|
* @remarks
|
|
675
|
-
* - Resource Access Management (RAM)
|
|
673
|
+
* - 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.
|
|
676
674
|
* - This operation is not idempotent.
|
|
677
|
-
* **
|
|
678
|
-
* This operation is
|
|
675
|
+
* **Rate limit:**
|
|
676
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
679
677
|
*
|
|
680
678
|
* @param tmpReq - ChangeParseSettingRequest
|
|
681
679
|
* @param headers - map
|
|
@@ -723,10 +721,10 @@ class Client extends openapi_core_1.default {
|
|
|
723
721
|
* 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.
|
|
724
722
|
*
|
|
725
723
|
* @remarks
|
|
726
|
-
* - Resource Access Management (RAM)
|
|
724
|
+
* - 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.
|
|
727
725
|
* - This operation is not idempotent.
|
|
728
|
-
* **
|
|
729
|
-
* This operation is
|
|
726
|
+
* **Rate limit:**
|
|
727
|
+
* This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
730
728
|
*
|
|
731
729
|
* @param request - ChangeParseSettingRequest
|
|
732
730
|
* @returns ChangeParseSettingResponse
|
|
@@ -799,17 +797,17 @@ class Client extends openapi_core_1.default {
|
|
|
799
797
|
return await this.createAndPulishAgentWithOptions(workspaceId, request, headers, runtime);
|
|
800
798
|
}
|
|
801
799
|
/**
|
|
802
|
-
* Creates
|
|
800
|
+
* 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.
|
|
803
801
|
*
|
|
804
802
|
* @remarks
|
|
805
803
|
* - **Permission requirements**:
|
|
806
|
-
* - **Resource Access Management (RAM)
|
|
807
|
-
* - **Alibaba Cloud
|
|
808
|
-
* - **
|
|
809
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After
|
|
810
|
-
* - **Idempotence**: This operation
|
|
811
|
-
* **
|
|
812
|
-
* This operation is
|
|
804
|
+
* - **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.
|
|
805
|
+
* - **Alibaba Cloud accounts**: By default, Alibaba Cloud accounts have the required permissions and can directly invoke this operation.
|
|
806
|
+
* - **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.
|
|
807
|
+
* - **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).
|
|
808
|
+
* - **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.
|
|
809
|
+
* **Throttling:**
|
|
810
|
+
* This operation is throttled if called frequently. Do not exceed 10 calls per second. If throttling occurs, retry later.
|
|
813
811
|
*
|
|
814
812
|
* @param tmpReq - CreateIndexRequest
|
|
815
813
|
* @param headers - map
|
|
@@ -956,17 +954,17 @@ class Client extends openapi_core_1.default {
|
|
|
956
954
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIndexResponse({}));
|
|
957
955
|
}
|
|
958
956
|
/**
|
|
959
|
-
* Creates
|
|
957
|
+
* 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.
|
|
960
958
|
*
|
|
961
959
|
* @remarks
|
|
962
960
|
* - **Permission requirements**:
|
|
963
|
-
* - **Resource Access Management (RAM)
|
|
964
|
-
* - **Alibaba Cloud
|
|
965
|
-
* - **
|
|
966
|
-
* - **What to do next**: This operation only performs initialization of the knowledge base creation job. After
|
|
967
|
-
* - **Idempotence**: This operation
|
|
968
|
-
* **
|
|
969
|
-
* This operation is
|
|
961
|
+
* - **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.
|
|
962
|
+
* - **Alibaba Cloud accounts**: By default, Alibaba Cloud accounts have the required permissions and can directly invoke this operation.
|
|
963
|
+
* - **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.
|
|
964
|
+
* - **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).
|
|
965
|
+
* - **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.
|
|
966
|
+
* **Throttling:**
|
|
967
|
+
* This operation is throttled if called frequently. Do not exceed 10 calls per second. If throttling occurs, retry later.
|
|
970
968
|
*
|
|
971
969
|
* @param request - CreateIndexRequest
|
|
972
970
|
* @returns CreateIndexResponse
|
|
@@ -980,9 +978,9 @@ class Client extends openapi_core_1.default {
|
|
|
980
978
|
* Creates a long-term memory.
|
|
981
979
|
*
|
|
982
980
|
* @remarks
|
|
983
|
-
* - You can store specific information from
|
|
984
|
-
* > Long-term memory does not support storing and managing user profiles
|
|
985
|
-
* - If you pass a `memoryId`, the system
|
|
981
|
+
* - 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).
|
|
982
|
+
* > 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).
|
|
983
|
+
* - 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.
|
|
986
984
|
* - This operation does not support idempotence.
|
|
987
985
|
* **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
988
986
|
*
|
|
@@ -1018,9 +1016,9 @@ class Client extends openapi_core_1.default {
|
|
|
1018
1016
|
* Creates a long-term memory.
|
|
1019
1017
|
*
|
|
1020
1018
|
* @remarks
|
|
1021
|
-
* - You can store specific information from
|
|
1022
|
-
* > Long-term memory does not support storing and managing user profiles
|
|
1023
|
-
* - If you pass a `memoryId`, the system
|
|
1019
|
+
* - 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).
|
|
1020
|
+
* > 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).
|
|
1021
|
+
* - 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.
|
|
1024
1022
|
* - This operation does not support idempotence.
|
|
1025
1023
|
* **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
|
|
1026
1024
|
*
|
|
@@ -1166,10 +1164,10 @@ class Client extends openapi_core_1.default {
|
|
|
1166
1164
|
* Permanently deletes a specified category.
|
|
1167
1165
|
*
|
|
1168
1166
|
* @remarks
|
|
1169
|
-
* - Resource Access Management (RAM)
|
|
1170
|
-
* - This operation
|
|
1171
|
-
* **
|
|
1172
|
-
* This operation is subject to
|
|
1167
|
+
* - 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.
|
|
1168
|
+
* - This operation has idempotence.
|
|
1169
|
+
* **Throttling:**
|
|
1170
|
+
* This operation is subject to throttling. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1173
1171
|
*
|
|
1174
1172
|
* @param request - DeleteCategoryRequest
|
|
1175
1173
|
* @param headers - map
|
|
@@ -1198,10 +1196,10 @@ class Client extends openapi_core_1.default {
|
|
|
1198
1196
|
* Permanently deletes a specified category.
|
|
1199
1197
|
*
|
|
1200
1198
|
* @remarks
|
|
1201
|
-
* - Resource Access Management (RAM)
|
|
1202
|
-
* - This operation
|
|
1203
|
-
* **
|
|
1204
|
-
* This operation is subject to
|
|
1199
|
+
* - 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.
|
|
1200
|
+
* - This operation has idempotence.
|
|
1201
|
+
* **Throttling:**
|
|
1202
|
+
* This operation is subject to throttling. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
1205
1203
|
*
|
|
1206
1204
|
* @param request - DeleteCategoryRequest
|
|
1207
1205
|
* @returns DeleteCategoryResponse
|
|
@@ -1212,18 +1210,18 @@ class Client extends openapi_core_1.default {
|
|
|
1212
1210
|
return await this.deleteCategoryWithOptions(CategoryId, WorkspaceId, request, headers, runtime);
|
|
1213
1211
|
}
|
|
1214
1212
|
/**
|
|
1215
|
-
* Deletes specified text
|
|
1213
|
+
* Deletes a specified text chunk from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
1216
1214
|
*
|
|
1217
1215
|
* @remarks
|
|
1218
1216
|
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
1219
1217
|
* - **Permission requirements**:
|
|
1220
|
-
* - **Resource Access Management (RAM) user**:
|
|
1221
|
-
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1222
|
-
* - **
|
|
1223
|
-
* - **Effective
|
|
1224
|
-
* - **Idempotence**: This operation is idempotent.
|
|
1225
|
-
* **Rate
|
|
1226
|
-
*
|
|
1218
|
+
* - **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.
|
|
1219
|
+
* - **Alibaba Cloud account (main account)**: Has permissions by default and can invoke this operation directly.
|
|
1220
|
+
* - **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.
|
|
1221
|
+
* - **Effective delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
1222
|
+
* - **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.
|
|
1223
|
+
* **Rate limiting:**
|
|
1224
|
+
* Frequent calls to this operation may be throttled. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
1227
1225
|
*
|
|
1228
1226
|
* @param tmpReq - DeleteChunkRequest
|
|
1229
1227
|
* @param headers - map
|
|
@@ -1262,18 +1260,18 @@ class Client extends openapi_core_1.default {
|
|
|
1262
1260
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteChunkResponse({}));
|
|
1263
1261
|
}
|
|
1264
1262
|
/**
|
|
1265
|
-
* Deletes specified text
|
|
1263
|
+
* Deletes a specified text chunk from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
|
|
1266
1264
|
*
|
|
1267
1265
|
* @remarks
|
|
1268
1266
|
* <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
|
|
1269
1267
|
* - **Permission requirements**:
|
|
1270
|
-
* - **Resource Access Management (RAM) user**:
|
|
1271
|
-
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
1272
|
-
* - **
|
|
1273
|
-
* - **Effective
|
|
1274
|
-
* - **Idempotence**: This operation is idempotent.
|
|
1275
|
-
* **Rate
|
|
1276
|
-
*
|
|
1268
|
+
* - **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.
|
|
1269
|
+
* - **Alibaba Cloud account (main account)**: Has permissions by default and can invoke this operation directly.
|
|
1270
|
+
* - **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.
|
|
1271
|
+
* - **Effective delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
1272
|
+
* - **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.
|
|
1273
|
+
* **Rate limiting:**
|
|
1274
|
+
* Frequent calls to this operation may be throttled. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
1277
1275
|
*
|
|
1278
1276
|
* @param request - DeleteChunkRequest
|
|
1279
1277
|
* @returns DeleteChunkResponse
|
|
@@ -1333,16 +1331,16 @@ class Client extends openapi_core_1.default {
|
|
|
1333
1331
|
return await this.deleteConnectorWithOptions(ConnectorId, WorkspaceId, request, headers, runtime);
|
|
1334
1332
|
}
|
|
1335
1333
|
/**
|
|
1336
|
-
* Permanently
|
|
1334
|
+
* 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.
|
|
1337
1335
|
*
|
|
1338
1336
|
* @remarks
|
|
1339
|
-
* - Deleting data tables
|
|
1340
|
-
* - This
|
|
1341
|
-
* - A RAM user must first obtain
|
|
1342
|
-
* - This
|
|
1343
|
-
* - This
|
|
1344
|
-
* **Rate
|
|
1345
|
-
*
|
|
1337
|
+
* - 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).
|
|
1338
|
+
* - 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.
|
|
1339
|
+
* - 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.
|
|
1340
|
+
* - This operation can only delete files in the parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS) state.
|
|
1341
|
+
* - This operation has idempotence.
|
|
1342
|
+
* **Rate limit:**
|
|
1343
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1346
1344
|
*
|
|
1347
1345
|
* @param request - DeleteFileRequest
|
|
1348
1346
|
* @param headers - map
|
|
@@ -1368,16 +1366,16 @@ class Client extends openapi_core_1.default {
|
|
|
1368
1366
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFileResponse({}));
|
|
1369
1367
|
}
|
|
1370
1368
|
/**
|
|
1371
|
-
* Permanently
|
|
1369
|
+
* 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.
|
|
1372
1370
|
*
|
|
1373
1371
|
* @remarks
|
|
1374
|
-
* - Deleting data tables
|
|
1375
|
-
* - This
|
|
1376
|
-
* - A RAM user must first obtain
|
|
1377
|
-
* - This
|
|
1378
|
-
* - This
|
|
1379
|
-
* **Rate
|
|
1380
|
-
*
|
|
1372
|
+
* - 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).
|
|
1373
|
+
* - 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.
|
|
1374
|
+
* - 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.
|
|
1375
|
+
* - This operation can only delete files in the parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS) state.
|
|
1376
|
+
* - This operation has idempotence.
|
|
1377
|
+
* **Rate limit:**
|
|
1378
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1381
1379
|
*
|
|
1382
1380
|
* @param request - DeleteFileRequest
|
|
1383
1381
|
* @returns DeleteFileResponse
|
|
@@ -1388,16 +1386,16 @@ class Client extends openapi_core_1.default {
|
|
|
1388
1386
|
return await this.deleteFileWithOptions(FileId, WorkspaceId, request, headers, runtime);
|
|
1389
1387
|
}
|
|
1390
1388
|
/**
|
|
1391
|
-
*
|
|
1389
|
+
* Deletes files in batches.
|
|
1392
1390
|
*
|
|
1393
1391
|
* @remarks
|
|
1394
1392
|
* - 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).
|
|
1395
|
-
* - This
|
|
1396
|
-
* - A
|
|
1397
|
-
* - This operation can only delete files
|
|
1398
|
-
* - This operation
|
|
1393
|
+
* - 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.
|
|
1394
|
+
* - 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.
|
|
1395
|
+
* - This operation can only delete files with a status of parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS).
|
|
1396
|
+
* - This operation has idempotence.
|
|
1399
1397
|
* **Throttling:**
|
|
1400
|
-
*
|
|
1398
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1401
1399
|
*
|
|
1402
1400
|
* @param tmpReq - DeleteFilesRequest
|
|
1403
1401
|
* @param headers - map
|
|
@@ -1433,16 +1431,16 @@ class Client extends openapi_core_1.default {
|
|
|
1433
1431
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFilesResponse({}));
|
|
1434
1432
|
}
|
|
1435
1433
|
/**
|
|
1436
|
-
*
|
|
1434
|
+
* Deletes files in batches.
|
|
1437
1435
|
*
|
|
1438
1436
|
* @remarks
|
|
1439
1437
|
* - 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).
|
|
1440
|
-
* - This
|
|
1441
|
-
* - A
|
|
1442
|
-
* - This operation can only delete files
|
|
1443
|
-
* - This operation
|
|
1438
|
+
* - 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.
|
|
1439
|
+
* - 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.
|
|
1440
|
+
* - This operation can only delete files with a status of parsing failed (PARSE_FAILED) or parsing completed (PARSE_SUCCESS).
|
|
1441
|
+
* - This operation has idempotence.
|
|
1444
1442
|
* **Throttling:**
|
|
1445
|
-
*
|
|
1443
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1446
1444
|
*
|
|
1447
1445
|
* @param request - DeleteFilesRequest
|
|
1448
1446
|
* @returns DeleteFilesResponse
|
|
@@ -1713,10 +1711,10 @@ class Client extends openapi_core_1.default {
|
|
|
1713
1711
|
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
1714
1712
|
*
|
|
1715
1713
|
* @remarks
|
|
1716
|
-
* -
|
|
1714
|
+
* - 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.
|
|
1717
1715
|
* - This operation is idempotent.
|
|
1718
|
-
* **Throttling:**
|
|
1719
|
-
* This operation is throttled if called too frequently. Do not
|
|
1716
|
+
* **Throttling rules:**
|
|
1717
|
+
* 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.
|
|
1720
1718
|
*
|
|
1721
1719
|
* @param request - DescribeFileRequest
|
|
1722
1720
|
* @param headers - map
|
|
@@ -1745,10 +1743,10 @@ class Client extends openapi_core_1.default {
|
|
|
1745
1743
|
* Queries the basic information of a file in application data, including the file name, type, and status.
|
|
1746
1744
|
*
|
|
1747
1745
|
* @remarks
|
|
1748
|
-
* -
|
|
1746
|
+
* - 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.
|
|
1749
1747
|
* - This operation is idempotent.
|
|
1750
|
-
* **Throttling:**
|
|
1751
|
-
* This operation is throttled if called too frequently. Do not
|
|
1748
|
+
* **Throttling rules:**
|
|
1749
|
+
* 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.
|
|
1752
1750
|
*
|
|
1753
1751
|
* @param request - DescribeFileRequest
|
|
1754
1752
|
* @returns DescribeFileResponse
|
|
@@ -1849,13 +1847,13 @@ class Client extends openapi_core_1.default {
|
|
|
1849
1847
|
return await this.getAlipayUrlWithOptions(request, headers, runtime);
|
|
1850
1848
|
}
|
|
1851
1849
|
/**
|
|
1852
|
-
*
|
|
1850
|
+
* Retrieves the list of all supported parser types based on the specified file type (file name extension).
|
|
1853
1851
|
*
|
|
1854
1852
|
* @remarks
|
|
1855
|
-
* - RAM
|
|
1856
|
-
* -
|
|
1857
|
-
*
|
|
1858
|
-
*
|
|
1853
|
+
* - 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.
|
|
1854
|
+
* - This operation is idempotent.
|
|
1855
|
+
* **Throttling:**
|
|
1856
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1859
1857
|
*
|
|
1860
1858
|
* @param request - GetAvailableParserTypesRequest
|
|
1861
1859
|
* @param headers - map
|
|
@@ -1886,13 +1884,13 @@ class Client extends openapi_core_1.default {
|
|
|
1886
1884
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAvailableParserTypesResponse({}));
|
|
1887
1885
|
}
|
|
1888
1886
|
/**
|
|
1889
|
-
*
|
|
1887
|
+
* Retrieves the list of all supported parser types based on the specified file type (file name extension).
|
|
1890
1888
|
*
|
|
1891
1889
|
* @remarks
|
|
1892
|
-
* - RAM
|
|
1893
|
-
* -
|
|
1894
|
-
*
|
|
1895
|
-
*
|
|
1890
|
+
* - 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.
|
|
1891
|
+
* - This operation is idempotent.
|
|
1892
|
+
* **Throttling:**
|
|
1893
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
1896
1894
|
*
|
|
1897
1895
|
* @param request - GetAvailableParserTypesRequest
|
|
1898
1896
|
* @returns GetAvailableParserTypesResponse
|
|
@@ -1960,13 +1958,13 @@ class Client extends openapi_core_1.default {
|
|
|
1960
1958
|
return await this.getConnectorWithOptions(WorkspaceId, request, headers, runtime);
|
|
1961
1959
|
}
|
|
1962
1960
|
/**
|
|
1963
|
-
* Queries the current status of a specified knowledge base creation task or knowledge base document
|
|
1961
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document addition task.
|
|
1964
1962
|
*
|
|
1965
1963
|
* @remarks
|
|
1966
|
-
* - Resource Access Management (RAM)
|
|
1967
|
-
* - You must have a knowledge base job that is
|
|
1968
|
-
* -
|
|
1969
|
-
* - This operation
|
|
1964
|
+
* - 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.
|
|
1965
|
+
* - 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`.
|
|
1966
|
+
* - Set the interval between invocations of this operation to at least 5 seconds.
|
|
1967
|
+
* - This operation is idempotent.
|
|
1970
1968
|
*
|
|
1971
1969
|
* @param request - GetIndexJobStatusRequest
|
|
1972
1970
|
* @param headers - map
|
|
@@ -2006,13 +2004,13 @@ class Client extends openapi_core_1.default {
|
|
|
2006
2004
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexJobStatusResponse({}));
|
|
2007
2005
|
}
|
|
2008
2006
|
/**
|
|
2009
|
-
* Queries the current status of a specified knowledge base creation task or knowledge base document
|
|
2007
|
+
* Queries the current status of a specified knowledge base creation task or knowledge base document addition task.
|
|
2010
2008
|
*
|
|
2011
2009
|
* @remarks
|
|
2012
|
-
* - Resource Access Management (RAM)
|
|
2013
|
-
* - You must have a knowledge base job that is
|
|
2014
|
-
* -
|
|
2015
|
-
* - This operation
|
|
2010
|
+
* - 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.
|
|
2011
|
+
* - 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`.
|
|
2012
|
+
* - Set the interval between invocations of this operation to at least 5 seconds.
|
|
2013
|
+
* - This operation is idempotent.
|
|
2016
2014
|
*
|
|
2017
2015
|
* @param request - GetIndexJobStatusRequest
|
|
2018
2016
|
* @returns GetIndexJobStatusResponse
|
|
@@ -2165,13 +2163,13 @@ class Client extends openapi_core_1.default {
|
|
|
2165
2163
|
return await this.getMemoryNodeWithOptions(workspaceId, memoryId, memoryNodeId, request, headers, runtime);
|
|
2166
2164
|
}
|
|
2167
2165
|
/**
|
|
2168
|
-
* Queries the data parsing settings
|
|
2166
|
+
* Queries the data parsing settings for a specified category.
|
|
2169
2167
|
*
|
|
2170
2168
|
* @remarks
|
|
2171
|
-
* - RAM
|
|
2172
|
-
* -
|
|
2173
|
-
*
|
|
2174
|
-
*
|
|
2169
|
+
* - 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).
|
|
2170
|
+
* - This operation is idempotent.
|
|
2171
|
+
* **Throttling:**
|
|
2172
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2175
2173
|
*
|
|
2176
2174
|
* @param request - GetParseSettingsRequest
|
|
2177
2175
|
* @param headers - map
|
|
@@ -2202,13 +2200,13 @@ class Client extends openapi_core_1.default {
|
|
|
2202
2200
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetParseSettingsResponse({}));
|
|
2203
2201
|
}
|
|
2204
2202
|
/**
|
|
2205
|
-
* Queries the data parsing settings
|
|
2203
|
+
* Queries the data parsing settings for a specified category.
|
|
2206
2204
|
*
|
|
2207
2205
|
* @remarks
|
|
2208
|
-
* - RAM
|
|
2209
|
-
* -
|
|
2210
|
-
*
|
|
2211
|
-
*
|
|
2206
|
+
* - 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).
|
|
2207
|
+
* - This operation is idempotent.
|
|
2208
|
+
* **Throttling:**
|
|
2209
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2212
2210
|
*
|
|
2213
2211
|
* @param request - GetParseSettingsRequest
|
|
2214
2212
|
* @returns GetParseSettingsResponse
|
|
@@ -2353,11 +2351,12 @@ class Client extends openapi_core_1.default {
|
|
|
2353
2351
|
* Retrieves the details of one or more categories in a specified workspace.
|
|
2354
2352
|
*
|
|
2355
2353
|
* @remarks
|
|
2356
|
-
* -
|
|
2357
|
-
* -
|
|
2358
|
-
* -
|
|
2359
|
-
* - This operation
|
|
2360
|
-
* **Rate
|
|
2354
|
+
* - Querying data tables by using API operations is not supported.
|
|
2355
|
+
* - 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.
|
|
2356
|
+
* - 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.
|
|
2357
|
+
* - This operation has idempotence.
|
|
2358
|
+
* **Rate limit:**
|
|
2359
|
+
* 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.
|
|
2361
2360
|
*
|
|
2362
2361
|
* @param request - ListCategoryRequest
|
|
2363
2362
|
* @param headers - map
|
|
@@ -2406,11 +2405,12 @@ class Client extends openapi_core_1.default {
|
|
|
2406
2405
|
* Retrieves the details of one or more categories in a specified workspace.
|
|
2407
2406
|
*
|
|
2408
2407
|
* @remarks
|
|
2409
|
-
* -
|
|
2410
|
-
* -
|
|
2411
|
-
* -
|
|
2412
|
-
* - This operation
|
|
2413
|
-
* **Rate
|
|
2408
|
+
* - Querying data tables by using API operations is not supported.
|
|
2409
|
+
* - 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.
|
|
2410
|
+
* - 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.
|
|
2411
|
+
* - This operation has idempotence.
|
|
2412
|
+
* **Rate limit:**
|
|
2413
|
+
* 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.
|
|
2414
2414
|
*
|
|
2415
2415
|
* @param request - ListCategoryRequest
|
|
2416
2416
|
* @returns ListCategoryResponse
|
|
@@ -2497,11 +2497,11 @@ class Client extends openapi_core_1.default {
|
|
|
2497
2497
|
* Retrieves the details of one or more documents in a specified category.
|
|
2498
2498
|
*
|
|
2499
2499
|
* @remarks
|
|
2500
|
-
* - 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)
|
|
2501
|
-
* -
|
|
2500
|
+
* - 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).
|
|
2501
|
+
* - 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.
|
|
2502
2502
|
* - This operation is idempotent.
|
|
2503
2503
|
* **Rate limit:**
|
|
2504
|
-
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
2504
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
2505
2505
|
*
|
|
2506
2506
|
* @param tmpReq - ListFileRequest
|
|
2507
2507
|
* @param headers - map
|
|
@@ -2552,11 +2552,11 @@ class Client extends openapi_core_1.default {
|
|
|
2552
2552
|
* Retrieves the details of one or more documents in a specified category.
|
|
2553
2553
|
*
|
|
2554
2554
|
* @remarks
|
|
2555
|
-
* - 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)
|
|
2556
|
-
* -
|
|
2555
|
+
* - 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).
|
|
2556
|
+
* - 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.
|
|
2557
2557
|
* - This operation is idempotent.
|
|
2558
2558
|
* **Rate limit:**
|
|
2559
|
-
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
|
|
2559
|
+
* This operation is throttled if called too frequently. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
2560
2560
|
*
|
|
2561
2561
|
* @param request - ListFileRequest
|
|
2562
2562
|
* @returns ListFileResponse
|
|
@@ -2567,14 +2567,14 @@ class Client extends openapi_core_1.default {
|
|
|
2567
2567
|
return await this.listFileWithOptions(WorkspaceId, request, headers, runtime);
|
|
2568
2568
|
}
|
|
2569
2569
|
/**
|
|
2570
|
-
* Retrieves files and their summary information from a specified knowledge base.
|
|
2570
|
+
* Retrieves the files and their summary information from a specified knowledge base.
|
|
2571
2571
|
*
|
|
2572
2572
|
* @remarks
|
|
2573
|
-
* - 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.
|
|
2573
|
+
* - 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.
|
|
2574
2574
|
* - 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).
|
|
2575
2575
|
* - This operation has idempotence.
|
|
2576
2576
|
* **Throttling:**
|
|
2577
|
-
* This operation is
|
|
2577
|
+
* This operation is subject to throttling. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
2578
2578
|
*
|
|
2579
2579
|
* @param request - ListIndexDocumentsRequest
|
|
2580
2580
|
* @param headers - map
|
|
@@ -2620,14 +2620,14 @@ class Client extends openapi_core_1.default {
|
|
|
2620
2620
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexDocumentsResponse({}));
|
|
2621
2621
|
}
|
|
2622
2622
|
/**
|
|
2623
|
-
* Retrieves files and their summary information from a specified knowledge base.
|
|
2623
|
+
* Retrieves the files and their summary information from a specified knowledge base.
|
|
2624
2624
|
*
|
|
2625
2625
|
* @remarks
|
|
2626
|
-
* - 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.
|
|
2626
|
+
* - 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.
|
|
2627
2627
|
* - 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).
|
|
2628
2628
|
* - This operation has idempotence.
|
|
2629
2629
|
* **Throttling:**
|
|
2630
|
-
* This operation is
|
|
2630
|
+
* This operation is subject to throttling. Do not exceed 15 calls per second. If you are throttled, retry later.
|
|
2631
2631
|
*
|
|
2632
2632
|
* @param request - ListIndexDocumentsRequest
|
|
2633
2633
|
* @returns ListIndexDocumentsResponse
|
|
@@ -2708,10 +2708,10 @@ class Client extends openapi_core_1.default {
|
|
|
2708
2708
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2709
2709
|
*
|
|
2710
2710
|
* @remarks
|
|
2711
|
-
* - 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.
|
|
2711
|
+
* - 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).
|
|
2712
2712
|
* - This operation has idempotence.
|
|
2713
|
-
* **
|
|
2714
|
-
* This operation is
|
|
2713
|
+
* **Throttling:**
|
|
2714
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2715
2715
|
*
|
|
2716
2716
|
* @param request - ListIndicesRequest
|
|
2717
2717
|
* @param headers - map
|
|
@@ -2751,10 +2751,10 @@ class Client extends openapi_core_1.default {
|
|
|
2751
2751
|
* Retrieves the list of knowledge bases in a specified workspace.
|
|
2752
2752
|
*
|
|
2753
2753
|
* @remarks
|
|
2754
|
-
* - 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.
|
|
2754
|
+
* - 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).
|
|
2755
2755
|
* - This operation has idempotence.
|
|
2756
|
-
* **
|
|
2757
|
-
* This operation is
|
|
2756
|
+
* **Throttling:**
|
|
2757
|
+
* This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
|
|
2758
2758
|
*
|
|
2759
2759
|
* @param request - ListIndicesRequest
|
|
2760
2760
|
* @returns ListIndicesResponse
|
|
@@ -2768,7 +2768,7 @@ class Client extends openapi_core_1.default {
|
|
|
2768
2768
|
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
2769
2769
|
*
|
|
2770
2770
|
* @remarks
|
|
2771
|
-
* - When
|
|
2771
|
+
* - 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.
|
|
2772
2772
|
* - This operation supports idempotence.
|
|
2773
2773
|
* **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.
|
|
2774
2774
|
*
|
|
@@ -2807,7 +2807,7 @@ class Client extends openapi_core_1.default {
|
|
|
2807
2807
|
* Retrieves the details of one or more long-term memory entities in a specified workspace.
|
|
2808
2808
|
*
|
|
2809
2809
|
* @remarks
|
|
2810
|
-
* - When
|
|
2810
|
+
* - 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.
|
|
2811
2811
|
* - This operation supports idempotence.
|
|
2812
2812
|
* **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.
|
|
2813
2813
|
*
|
|
@@ -2973,19 +2973,19 @@ class Client extends openapi_core_1.default {
|
|
|
2973
2973
|
*
|
|
2974
2974
|
* @remarks
|
|
2975
2975
|
* <props="china">
|
|
2976
|
-
* - **
|
|
2977
|
-
* - **
|
|
2978
|
-
* - **
|
|
2979
|
-
* - **Alibaba Cloud account
|
|
2980
|
-
* - **Response latency**:
|
|
2981
|
-
* - **
|
|
2976
|
+
* - **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.
|
|
2977
|
+
* - **Permission requirements**:
|
|
2978
|
+
* - **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.
|
|
2979
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
2980
|
+
* - **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.
|
|
2981
|
+
* - **Idempotence**: This operation is idempotent.
|
|
2982
2982
|
* <props="intl">
|
|
2983
|
-
* - **
|
|
2984
|
-
* - **
|
|
2985
|
-
* - **
|
|
2986
|
-
* - **Alibaba Cloud account
|
|
2987
|
-
* - **Response latency**:
|
|
2988
|
-
* - **
|
|
2983
|
+
* - **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.
|
|
2984
|
+
* - **Permission requirements**:
|
|
2985
|
+
* - **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.
|
|
2986
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
2987
|
+
* - **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.
|
|
2988
|
+
* - **Idempotence**: This operation is idempotent.
|
|
2989
2989
|
*
|
|
2990
2990
|
* @param tmpReq - RetrieveRequest
|
|
2991
2991
|
* @param headers - map
|
|
@@ -3082,19 +3082,19 @@ class Client extends openapi_core_1.default {
|
|
|
3082
3082
|
*
|
|
3083
3083
|
* @remarks
|
|
3084
3084
|
* <props="china">
|
|
3085
|
-
* - **
|
|
3086
|
-
* - **
|
|
3087
|
-
* - **
|
|
3088
|
-
* - **Alibaba Cloud account
|
|
3089
|
-
* - **Response latency**:
|
|
3090
|
-
* - **
|
|
3085
|
+
* - **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.
|
|
3086
|
+
* - **Permission requirements**:
|
|
3087
|
+
* - **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.
|
|
3088
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
3089
|
+
* - **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.
|
|
3090
|
+
* - **Idempotence**: This operation is idempotent.
|
|
3091
3091
|
* <props="intl">
|
|
3092
|
-
* - **
|
|
3093
|
-
* - **
|
|
3094
|
-
* - **
|
|
3095
|
-
* - **Alibaba Cloud account
|
|
3096
|
-
* - **Response latency**:
|
|
3097
|
-
* - **
|
|
3092
|
+
* - **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.
|
|
3093
|
+
* - **Permission requirements**:
|
|
3094
|
+
* - **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.
|
|
3095
|
+
* - **Alibaba Cloud account**: By default, an Alibaba Cloud account has the required permissions and can directly invoke this operation.
|
|
3096
|
+
* - **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.
|
|
3097
|
+
* - **Idempotence**: This operation is idempotent.
|
|
3098
3098
|
*
|
|
3099
3099
|
* @param request - RetrieveRequest
|
|
3100
3100
|
* @returns RetrieveResponse
|
|
@@ -3398,15 +3398,15 @@ class Client extends openapi_core_1.default {
|
|
|
3398
3398
|
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
3399
3399
|
*
|
|
3400
3400
|
* @remarks
|
|
3401
|
-
* - **Key
|
|
3401
|
+
* - **Key restrictions**: This operation supports only document search knowledge bases. Data query and image-based Q&A knowledge bases are not supported.
|
|
3402
3402
|
* - **Permission requirements**:
|
|
3403
|
-
* - **Resource Access Management (RAM) user**:
|
|
3403
|
+
* - **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.
|
|
3404
3404
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
3405
|
-
* - **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
|
|
3406
|
-
* - **
|
|
3407
|
-
* - **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.
|
|
3405
|
+
* - **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.
|
|
3406
|
+
* - **Propagation delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
3407
|
+
* - **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.
|
|
3408
3408
|
* **Rate limit:**
|
|
3409
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If
|
|
3409
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
3410
3410
|
*
|
|
3411
3411
|
* @param request - UpdateChunkRequest
|
|
3412
3412
|
* @param headers - map
|
|
@@ -3455,15 +3455,15 @@ class Client extends openapi_core_1.default {
|
|
|
3455
3455
|
* Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
|
|
3456
3456
|
*
|
|
3457
3457
|
* @remarks
|
|
3458
|
-
* - **Key
|
|
3458
|
+
* - **Key restrictions**: This operation supports only document search knowledge bases. Data query and image-based Q&A knowledge bases are not supported.
|
|
3459
3459
|
* - **Permission requirements**:
|
|
3460
|
-
* - **Resource Access Management (RAM) user**:
|
|
3460
|
+
* - **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.
|
|
3461
3461
|
* - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
|
|
3462
|
-
* - **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
|
|
3463
|
-
* - **
|
|
3464
|
-
* - **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.
|
|
3462
|
+
* - **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.
|
|
3463
|
+
* - **Propagation delay**: Updates typically take effect immediately. During peak periods, a slight delay (in seconds) may occur.
|
|
3464
|
+
* - **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.
|
|
3465
3465
|
* **Rate limit:**
|
|
3466
|
-
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If
|
|
3466
|
+
* This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry after a short wait.
|
|
3467
3467
|
*
|
|
3468
3468
|
* @param request - UpdateChunkRequest
|
|
3469
3469
|
* @returns UpdateChunkResponse
|
|
@@ -3529,11 +3529,12 @@ class Client extends openapi_core_1.default {
|
|
|
3529
3529
|
return await this.updateConnectorWithOptions(WorkspaceId, ConnectorId, request, headers, runtime);
|
|
3530
3530
|
}
|
|
3531
3531
|
/**
|
|
3532
|
-
* Updates the tags
|
|
3532
|
+
* Updates the tags of a specified file.
|
|
3533
3533
|
*
|
|
3534
3534
|
* @remarks
|
|
3535
|
-
* -
|
|
3536
|
-
* **
|
|
3535
|
+
* - 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.
|
|
3536
|
+
* **Rate limiting:**
|
|
3537
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
3537
3538
|
*
|
|
3538
3539
|
* @param tmpReq - UpdateFileTagRequest
|
|
3539
3540
|
* @param headers - map
|
|
@@ -3569,11 +3570,12 @@ class Client extends openapi_core_1.default {
|
|
|
3569
3570
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateFileTagResponse({}));
|
|
3570
3571
|
}
|
|
3571
3572
|
/**
|
|
3572
|
-
* Updates the tags
|
|
3573
|
+
* Updates the tags of a specified file.
|
|
3573
3574
|
*
|
|
3574
3575
|
* @remarks
|
|
3575
|
-
* -
|
|
3576
|
-
* **
|
|
3576
|
+
* - 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.
|
|
3577
|
+
* **Rate limiting:**
|
|
3578
|
+
* This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
|
|
3577
3579
|
*
|
|
3578
3580
|
* @param request - UpdateFileTagRequest
|
|
3579
3581
|
* @returns UpdateFileTagResponse
|
|
@@ -3584,13 +3586,14 @@ class Client extends openapi_core_1.default {
|
|
|
3584
3586
|
return await this.updateFileTagWithOptions(WorkspaceId, FileId, request, headers, runtime);
|
|
3585
3587
|
}
|
|
3586
3588
|
/**
|
|
3587
|
-
* Updates
|
|
3589
|
+
* Updates partial configurations of a specified knowledge base.
|
|
3588
3590
|
*
|
|
3589
3591
|
* @remarks
|
|
3590
|
-
* <props="intl">This operation is not
|
|
3591
|
-
*
|
|
3592
|
-
*
|
|
3593
|
-
*
|
|
3592
|
+
* <props="intl">This operation is not supported on the Chinese site.
|
|
3593
|
+
* <props="china">
|
|
3594
|
+
* 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.
|
|
3595
|
+
* 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).
|
|
3596
|
+
* This operation supports idempotence.
|
|
3594
3597
|
*
|
|
3595
3598
|
* @param request - UpdateIndexRequest
|
|
3596
3599
|
* @param headers - map
|
|
@@ -3642,13 +3645,14 @@ class Client extends openapi_core_1.default {
|
|
|
3642
3645
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateIndexResponse({}));
|
|
3643
3646
|
}
|
|
3644
3647
|
/**
|
|
3645
|
-
* Updates
|
|
3648
|
+
* Updates partial configurations of a specified knowledge base.
|
|
3646
3649
|
*
|
|
3647
3650
|
* @remarks
|
|
3648
|
-
* <props="intl">This operation is not
|
|
3649
|
-
*
|
|
3650
|
-
*
|
|
3651
|
-
*
|
|
3651
|
+
* <props="intl">This operation is not supported on the Chinese site.
|
|
3652
|
+
* <props="china">
|
|
3653
|
+
* 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.
|
|
3654
|
+
* 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).
|
|
3655
|
+
* This operation supports idempotence.
|
|
3652
3656
|
*
|
|
3653
3657
|
* @param request - UpdateIndexRequest
|
|
3654
3658
|
* @returns UpdateIndexResponse
|
|
@@ -3796,15 +3800,18 @@ class Client extends openapi_core_1.default {
|
|
|
3796
3800
|
return await this.updatePromptTemplateWithOptions(workspaceId, promptTemplateId, request, headers, runtime);
|
|
3797
3801
|
}
|
|
3798
3802
|
/**
|
|
3799
|
-
*
|
|
3803
|
+
* Updates a table in a table connector of Alibaba Cloud Model Studio Data Hub using a file from an authorized OSS bucket.
|
|
3800
3804
|
*
|
|
3801
3805
|
* @remarks
|
|
3802
|
-
* -
|
|
3803
|
-
*
|
|
3804
|
-
*
|
|
3805
|
-
*
|
|
3806
|
-
* -
|
|
3807
|
-
*
|
|
3806
|
+
* - 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.
|
|
3807
|
+
* - 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.
|
|
3808
|
+
*
|
|
3809
|
+
* - 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.
|
|
3810
|
+
* - 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.
|
|
3811
|
+
* - 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.
|
|
3812
|
+
* - This operation does not guarantee idempotence.
|
|
3813
|
+
* **Rate limit:**
|
|
3814
|
+
* 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.
|
|
3808
3815
|
*
|
|
3809
3816
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
3810
3817
|
* @param headers - map
|
|
@@ -3844,15 +3851,18 @@ class Client extends openapi_core_1.default {
|
|
|
3844
3851
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateTableFromAuthorizedOssResponse({}));
|
|
3845
3852
|
}
|
|
3846
3853
|
/**
|
|
3847
|
-
*
|
|
3854
|
+
* Updates a table in a table connector of Alibaba Cloud Model Studio Data Hub using a file from an authorized OSS bucket.
|
|
3848
3855
|
*
|
|
3849
3856
|
* @remarks
|
|
3850
|
-
* -
|
|
3851
|
-
*
|
|
3852
|
-
*
|
|
3853
|
-
*
|
|
3854
|
-
* -
|
|
3855
|
-
*
|
|
3857
|
+
* - 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.
|
|
3858
|
+
* - 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.
|
|
3859
|
+
*
|
|
3860
|
+
* - 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.
|
|
3861
|
+
* - 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.
|
|
3862
|
+
* - 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.
|
|
3863
|
+
* - This operation does not guarantee idempotence.
|
|
3864
|
+
* **Rate limit:**
|
|
3865
|
+
* 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.
|
|
3856
3866
|
*
|
|
3857
3867
|
* @param request - UpdateTableFromAuthorizedOssRequest
|
|
3858
3868
|
* @returns UpdateTableFromAuthorizedOssResponse
|