@alicloud/bailian20231229 2.14.4 → 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.
Files changed (152) hide show
  1. package/dist/client.d.ts +278 -266
  2. package/dist/client.js +278 -266
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddCategoryRequest.d.ts +6 -7
  5. package/dist/models/AddCategoryRequest.js.map +1 -1
  6. package/dist/models/AddCategoryResponseBody.d.ts +9 -11
  7. package/dist/models/AddCategoryResponseBody.js.map +1 -1
  8. package/dist/models/AddConnectorRequest.d.ts +8 -6
  9. package/dist/models/AddConnectorRequest.js.map +1 -1
  10. package/dist/models/AddConnectorResponseBody.d.ts +8 -10
  11. package/dist/models/AddConnectorResponseBody.js.map +1 -1
  12. package/dist/models/AddConnectorShrinkRequest.d.ts +3 -3
  13. package/dist/models/AddFileRequest.d.ts +19 -19
  14. package/dist/models/AddFileResponseBody.d.ts +1 -1
  15. package/dist/models/AddFileShrinkRequest.d.ts +17 -17
  16. package/dist/models/AddFilesFromAuthorizedOssRequest.d.ts +27 -27
  17. package/dist/models/AddFilesFromAuthorizedOssResponseBody.d.ts +9 -9
  18. package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.d.ts +10 -10
  19. package/dist/models/AddTableRequest.d.ts +7 -1
  20. package/dist/models/AddTableRequest.js.map +1 -1
  21. package/dist/models/AddTableResponseBody.d.ts +5 -5
  22. package/dist/models/ApplyFileUploadLeaseRequest.d.ts +15 -15
  23. package/dist/models/ApplyFileUploadLeaseResponseBody.d.ts +12 -12
  24. package/dist/models/BatchUpdateFileTagRequest.d.ts +2 -4
  25. package/dist/models/BatchUpdateFileTagRequest.js.map +1 -1
  26. package/dist/models/BatchUpdateFileTagResponseBody.d.ts +2 -2
  27. package/dist/models/BatchUpdateFileTagShrinkRequest.d.ts +1 -3
  28. package/dist/models/BatchUpdateFileTagShrinkRequest.js.map +1 -1
  29. package/dist/models/ChangeParseSettingRequest.d.ts +11 -11
  30. package/dist/models/ChangeParseSettingResponseBody.d.ts +2 -2
  31. package/dist/models/ChangeParseSettingShrinkRequest.d.ts +6 -6
  32. package/dist/models/CreateIndexRequest.d.ts +128 -133
  33. package/dist/models/CreateIndexRequest.js.map +1 -1
  34. package/dist/models/CreateIndexResponseBody.d.ts +11 -5
  35. package/dist/models/CreateIndexResponseBody.js.map +1 -1
  36. package/dist/models/CreateIndexShrinkRequest.d.ts +100 -105
  37. package/dist/models/CreateIndexShrinkRequest.js.map +1 -1
  38. package/dist/models/CreateMemoryRequest.d.ts +2 -2
  39. package/dist/models/CreateMemoryResponseBody.d.ts +1 -1
  40. package/dist/models/DeleteCategoryResponseBody.d.ts +1 -1
  41. package/dist/models/DeleteChunkRequest.d.ts +1 -1
  42. package/dist/models/DeleteChunkResponseBody.d.ts +10 -4
  43. package/dist/models/DeleteChunkResponseBody.js.map +1 -1
  44. package/dist/models/DeleteChunkShrinkRequest.d.ts +1 -1
  45. package/dist/models/DeleteFileResponseBody.d.ts +6 -8
  46. package/dist/models/DeleteFileResponseBody.js.map +1 -1
  47. package/dist/models/DeleteFilesRequest.d.ts +1 -1
  48. package/dist/models/DeleteFilesResponseBody.d.ts +7 -7
  49. package/dist/models/DeleteFilesShrinkRequest.d.ts +1 -1
  50. package/dist/models/DescribeFileResponseBody.d.ts +54 -40
  51. package/dist/models/DescribeFileResponseBody.js +2 -0
  52. package/dist/models/DescribeFileResponseBody.js.map +1 -1
  53. package/dist/models/GetAvailableParserTypesRequest.d.ts +16 -1
  54. package/dist/models/GetAvailableParserTypesRequest.js.map +1 -1
  55. package/dist/models/GetAvailableParserTypesResponseBody.d.ts +13 -15
  56. package/dist/models/GetAvailableParserTypesResponseBody.js.map +1 -1
  57. package/dist/models/GetIndexJobStatusRequest.d.ts +4 -4
  58. package/dist/models/GetIndexJobStatusResponseBody.d.ts +27 -20
  59. package/dist/models/GetIndexJobStatusResponseBody.js.map +1 -1
  60. package/dist/models/GetParseSettingsRequest.d.ts +1 -1
  61. package/dist/models/GetParseSettingsResponseBody.d.ts +19 -21
  62. package/dist/models/GetParseSettingsResponseBody.js.map +1 -1
  63. package/dist/models/ListCategoryRequest.d.ts +14 -13
  64. package/dist/models/ListCategoryRequest.js.map +1 -1
  65. package/dist/models/ListCategoryResponseBody.d.ts +21 -27
  66. package/dist/models/ListCategoryResponseBody.js.map +1 -1
  67. package/dist/models/ListFileRequest.d.ts +7 -9
  68. package/dist/models/ListFileRequest.js.map +1 -1
  69. package/dist/models/ListFileResponseBody.d.ts +10 -10
  70. package/dist/models/ListFileShrinkRequest.d.ts +7 -9
  71. package/dist/models/ListFileShrinkRequest.js.map +1 -1
  72. package/dist/models/ListIndexDocumentsRequest.d.ts +9 -9
  73. package/dist/models/ListIndexDocumentsResponseBody.d.ts +2 -2
  74. package/dist/models/ListIndicesRequest.d.ts +2 -2
  75. package/dist/models/ListIndicesResponseBody.d.ts +25 -25
  76. package/dist/models/ListMemoriesResponseBody.d.ts +3 -3
  77. package/dist/models/RetrieveRequest.d.ts +68 -75
  78. package/dist/models/RetrieveRequest.js.map +1 -1
  79. package/dist/models/RetrieveResponseBody.d.ts +20 -23
  80. package/dist/models/RetrieveResponseBody.js.map +1 -1
  81. package/dist/models/RetrieveShrinkRequest.d.ts +29 -34
  82. package/dist/models/RetrieveShrinkRequest.js.map +1 -1
  83. package/dist/models/UpdateChunkRequest.d.ts +7 -7
  84. package/dist/models/UpdateChunkResponseBody.d.ts +8 -2
  85. package/dist/models/UpdateChunkResponseBody.js.map +1 -1
  86. package/dist/models/UpdateIndexRequest.d.ts +15 -15
  87. package/dist/models/UpdateIndexResponseBody.d.ts +5 -5
  88. package/dist/models/UpdateTableFromAuthorizedOssRequest.d.ts +6 -4
  89. package/dist/models/UpdateTableFromAuthorizedOssRequest.js.map +1 -1
  90. package/dist/models/UpdateTableFromAuthorizedOssResponseBody.d.ts +8 -8
  91. package/package.json +1 -1
  92. package/src/client.ts +278 -266
  93. package/src/models/AddCategoryRequest.ts +6 -7
  94. package/src/models/AddCategoryResponseBody.ts +9 -11
  95. package/src/models/AddConnectorRequest.ts +8 -6
  96. package/src/models/AddConnectorResponseBody.ts +8 -10
  97. package/src/models/AddConnectorShrinkRequest.ts +3 -3
  98. package/src/models/AddFileRequest.ts +19 -19
  99. package/src/models/AddFileResponseBody.ts +1 -1
  100. package/src/models/AddFileShrinkRequest.ts +17 -17
  101. package/src/models/AddFilesFromAuthorizedOssRequest.ts +27 -27
  102. package/src/models/AddFilesFromAuthorizedOssResponseBody.ts +9 -9
  103. package/src/models/AddFilesFromAuthorizedOssShrinkRequest.ts +10 -10
  104. package/src/models/AddTableRequest.ts +7 -1
  105. package/src/models/AddTableResponseBody.ts +5 -5
  106. package/src/models/ApplyFileUploadLeaseRequest.ts +15 -15
  107. package/src/models/ApplyFileUploadLeaseResponseBody.ts +12 -12
  108. package/src/models/BatchUpdateFileTagRequest.ts +2 -4
  109. package/src/models/BatchUpdateFileTagResponseBody.ts +2 -2
  110. package/src/models/BatchUpdateFileTagShrinkRequest.ts +1 -3
  111. package/src/models/ChangeParseSettingRequest.ts +11 -11
  112. package/src/models/ChangeParseSettingResponseBody.ts +2 -2
  113. package/src/models/ChangeParseSettingShrinkRequest.ts +6 -6
  114. package/src/models/CreateIndexRequest.ts +128 -133
  115. package/src/models/CreateIndexResponseBody.ts +11 -5
  116. package/src/models/CreateIndexShrinkRequest.ts +100 -105
  117. package/src/models/CreateMemoryRequest.ts +2 -2
  118. package/src/models/CreateMemoryResponseBody.ts +1 -1
  119. package/src/models/DeleteCategoryResponseBody.ts +1 -1
  120. package/src/models/DeleteChunkRequest.ts +1 -1
  121. package/src/models/DeleteChunkResponseBody.ts +10 -4
  122. package/src/models/DeleteChunkShrinkRequest.ts +1 -1
  123. package/src/models/DeleteFileResponseBody.ts +6 -8
  124. package/src/models/DeleteFilesRequest.ts +1 -1
  125. package/src/models/DeleteFilesResponseBody.ts +7 -7
  126. package/src/models/DeleteFilesShrinkRequest.ts +1 -1
  127. package/src/models/DescribeFileResponseBody.ts +56 -40
  128. package/src/models/GetAvailableParserTypesRequest.ts +16 -1
  129. package/src/models/GetAvailableParserTypesResponseBody.ts +13 -15
  130. package/src/models/GetIndexJobStatusRequest.ts +4 -4
  131. package/src/models/GetIndexJobStatusResponseBody.ts +27 -20
  132. package/src/models/GetParseSettingsRequest.ts +1 -1
  133. package/src/models/GetParseSettingsResponseBody.ts +19 -21
  134. package/src/models/ListCategoryRequest.ts +14 -13
  135. package/src/models/ListCategoryResponseBody.ts +21 -27
  136. package/src/models/ListFileRequest.ts +7 -9
  137. package/src/models/ListFileResponseBody.ts +10 -10
  138. package/src/models/ListFileShrinkRequest.ts +7 -9
  139. package/src/models/ListIndexDocumentsRequest.ts +9 -9
  140. package/src/models/ListIndexDocumentsResponseBody.ts +2 -2
  141. package/src/models/ListIndicesRequest.ts +2 -2
  142. package/src/models/ListIndicesResponseBody.ts +25 -25
  143. package/src/models/ListMemoriesResponseBody.ts +3 -3
  144. package/src/models/RetrieveRequest.ts +68 -75
  145. package/src/models/RetrieveResponseBody.ts +20 -23
  146. package/src/models/RetrieveShrinkRequest.ts +29 -34
  147. package/src/models/UpdateChunkRequest.ts +7 -7
  148. package/src/models/UpdateChunkResponseBody.ts +8 -2
  149. package/src/models/UpdateIndexRequest.ts +15 -15
  150. package/src/models/UpdateIndexResponseBody.ts +5 -5
  151. package/src/models/UpdateTableFromAuthorizedOssRequest.ts +6 -4
  152. package/src/models/UpdateTableFromAuthorizedOssResponseBody.ts +8 -8
package/dist/client.js CHANGED
@@ -62,13 +62,14 @@ class Client extends openapi_core_1.default {
62
62
  return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
63
63
  }
64
64
  /**
65
- * Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
65
+ * Creates a category in a specified workspace for classifying and managing files. A maximum of 500 categories can be created in each workspace.
66
66
  *
67
67
  * @remarks
68
- * - You cannot use an API to add data tables. To add data tables, go to the [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) page in the console.
69
- * - A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The `AliyunBailianDataFullAccess` permission, which includes the `sfm:AddCategory` permission, is required. An Alibaba Cloud account can call this operation directly without requiring authorization. To call this operation, use the latest version of the [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
70
- * - This operation is not idempotent.
71
- * **Rate limiting:** Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 5 calls per second. If rate limiting is triggered, try again later.
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.
72
73
  *
73
74
  * @param request - AddCategoryRequest
74
75
  * @param headers - map
@@ -108,13 +109,14 @@ class Client extends openapi_core_1.default {
108
109
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddCategoryResponse({}));
109
110
  }
110
111
  /**
111
- * Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
112
+ * Creates a category in a specified workspace for classifying and managing files. A maximum of 500 categories can be created in each workspace.
112
113
  *
113
114
  * @remarks
114
- * - You cannot use an API to add data tables. To add data tables, go to the [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) page in the console.
115
- * - A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The `AliyunBailianDataFullAccess` permission, which includes the `sfm:AddCategory` permission, is required. An Alibaba Cloud account can call this operation directly without requiring authorization. To call this operation, use the latest version of the [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
116
- * - This operation is not idempotent.
117
- * **Rate limiting:** Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 5 calls per second. If rate limiting is triggered, try again later.
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.
118
120
  *
119
121
  * @param request - AddCategoryRequest
120
122
  * @returns AddCategoryResponse
@@ -194,13 +196,13 @@ class Client extends openapi_core_1.default {
194
196
  return await this.addChunkWithOptions(WorkspaceId, request, headers, runtime);
195
197
  }
196
198
  /**
197
- * Creates a connector. This API currently supports only file connectors.
199
+ * Creates a connector. Currently, this operation supports creating only file-type connectors.
198
200
  *
199
201
  * @remarks
200
- * - To call this operation, a RAM user (sub-account) must first have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and be a member of a [business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:AddCategory permission. A primary account can call this operation directly without authorization. We recommend using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
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.
201
203
  * - This operation is not idempotent.
202
- * **Throttling:**
203
- * Do not call this operation more than 5 times per second. If a request is throttled, try again later.
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.
204
206
  *
205
207
  * @param tmpReq - AddConnectorRequest
206
208
  * @param headers - map
@@ -245,13 +247,13 @@ class Client extends openapi_core_1.default {
245
247
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddConnectorResponse({}));
246
248
  }
247
249
  /**
248
- * Creates a connector. This API currently supports only file connectors.
250
+ * Creates a connector. Currently, this operation supports creating only file-type connectors.
249
251
  *
250
252
  * @remarks
251
- * - To call this operation, a RAM user (sub-account) must first have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and be a member of a [business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:AddCategory permission. A primary account can call this operation directly without authorization. We recommend using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
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.
252
254
  * - This operation is not idempotent.
253
- * **Throttling:**
254
- * Do not call this operation more than 5 times per second. If a request is throttled, try again later.
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.
255
257
  *
256
258
  * @param request - AddConnectorRequest
257
259
  * @returns AddConnectorResponse
@@ -262,13 +264,13 @@ class Client extends openapi_core_1.default {
262
264
  return await this.addConnectorWithOptions(WorkspaceId, request, headers, runtime);
263
265
  }
264
266
  /**
265
- * 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).
266
268
  *
267
269
  * @remarks
268
- * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before 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).
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.
269
271
  * - This operation is not idempotent.
270
- * **Rate limiting:**
271
- * This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
272
+ * **Throttling:**
273
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
272
274
  *
273
275
  * @param tmpReq - AddFileRequest
274
276
  * @param headers - map
@@ -325,13 +327,13 @@ class Client extends openapi_core_1.default {
325
327
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddFileResponse({}));
326
328
  }
327
329
  /**
328
- * 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).
329
331
  *
330
332
  * @remarks
331
- * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before 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).
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.
332
334
  * - This operation is not idempotent.
333
- * **Rate limiting:**
334
- * This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
335
+ * **Throttling:**
336
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
335
337
  *
336
338
  * @param request - AddFileRequest
337
339
  * @returns AddFileResponse
@@ -345,14 +347,14 @@ class Client extends openapi_core_1.default {
345
347
  * Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
346
348
  *
347
349
  * @remarks
348
- * - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
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.
349
351
  *
350
- * - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
351
- * - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
352
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
353
- * - This operation does not have idempotence.
354
- * **Rate limit:**
355
- * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
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.
356
358
  *
357
359
  * @param tmpReq - AddFilesFromAuthorizedOssRequest
358
360
  * @param headers - map
@@ -412,14 +414,14 @@ class Client extends openapi_core_1.default {
412
414
  * Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
413
415
  *
414
416
  * @remarks
415
- * - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
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.
416
418
  *
417
- * - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
418
- * - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
419
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
420
- * - This operation does not have idempotence.
421
- * **Rate limit:**
422
- * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
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.
423
425
  *
424
426
  * @param request - AddFilesFromAuthorizedOssRequest
425
427
  * @returns AddFilesFromAuthorizedOssResponse
@@ -430,13 +432,13 @@ class Client extends openapi_core_1.default {
430
432
  return await this.addFilesFromAuthorizedOssWithOptions(WorkspaceId, request, headers, runtime);
431
433
  }
432
434
  /**
433
- * Add a table for the table data connector.
435
+ * Adds a table to a tabular data connector.
434
436
  *
435
437
  * @remarks
436
- * - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
437
- * - This API is not idempotent.
438
- * **Throttling:**
439
- * This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
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.
440
442
  *
441
443
  * @param tmpReq - AddTableRequest
442
444
  * @param headers - map
@@ -481,13 +483,13 @@ class Client extends openapi_core_1.default {
481
483
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddTableResponse({}));
482
484
  }
483
485
  /**
484
- * Add a table for the table data connector.
486
+ * Adds a table to a tabular data connector.
485
487
  *
486
488
  * @remarks
487
- * - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
488
- * - This API is not idempotent.
489
- * **Throttling:**
490
- * This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
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.
491
493
  *
492
494
  * @param request - AddTableRequest
493
495
  * @returns AddTableResponse
@@ -498,13 +500,13 @@ class Client extends openapi_core_1.default {
498
500
  return await this.addTableWithOptions(WorkspaceId, request, headers, runtime);
499
501
  }
500
502
  /**
501
- * Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
503
+ * Requests an upload lease for uploading a knowledge base file or a file for agent application session interaction.
502
504
  *
503
505
  * @remarks
504
- * - RAM users (sub-accounts) must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ApplyFileUploadLease permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can directly call this API without authorization. We recommend that you call this API by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
505
- * - This API is not idempotent.
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.
506
508
  * **Throttling:**
507
- * This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
509
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
508
510
  *
509
511
  * @param request - ApplyFileUploadLeaseRequest
510
512
  * @param headers - map
@@ -547,13 +549,13 @@ class Client extends openapi_core_1.default {
547
549
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ApplyFileUploadLeaseResponse({}));
548
550
  }
549
551
  /**
550
- * Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
552
+ * Requests an upload lease for uploading a knowledge base file or a file for agent application session interaction.
551
553
  *
552
554
  * @remarks
553
- * - RAM users (sub-accounts) must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ApplyFileUploadLease permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can directly call this API without authorization. We recommend that you call this API by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
554
- * - This API is not idempotent.
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.
555
557
  * **Throttling:**
556
- * This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
558
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
557
559
  *
558
560
  * @param request - ApplyFileUploadLeaseRequest
559
561
  * @returns ApplyFileUploadLeaseResponse
@@ -668,10 +670,10 @@ class Client extends openapi_core_1.default {
668
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.
669
671
  *
670
672
  * @remarks
671
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
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.
672
674
  * - This operation is not idempotent.
673
- * **Throttling:**
674
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
675
+ * **Rate limit:**
676
+ * This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
675
677
  *
676
678
  * @param tmpReq - ChangeParseSettingRequest
677
679
  * @param headers - map
@@ -719,10 +721,10 @@ class Client extends openapi_core_1.default {
719
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.
720
722
  *
721
723
  * @remarks
722
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
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.
723
725
  * - This operation is not idempotent.
724
- * **Throttling:**
725
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
726
+ * **Rate limit:**
727
+ * This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
726
728
  *
727
729
  * @param request - ChangeParseSettingRequest
728
730
  * @returns ChangeParseSettingResponse
@@ -795,17 +797,17 @@ class Client extends openapi_core_1.default {
795
797
  return await this.createAndPulishAgentWithOptions(workspaceId, request, headers, runtime);
796
798
  }
797
799
  /**
798
- * Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
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.
799
801
  *
800
802
  * @remarks
801
803
  * - **Permission requirements**:
802
- * - **Resource Access Management (RAM) user**: Before invoking this operation, 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:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
803
- * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
804
- * - **Calling method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
805
- * - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
806
- * - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
807
- * **Rate limiting:**
808
- * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
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.
809
811
  *
810
812
  * @param tmpReq - CreateIndexRequest
811
813
  * @param headers - map
@@ -952,17 +954,17 @@ class Client extends openapi_core_1.default {
952
954
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateIndexResponse({}));
953
955
  }
954
956
  /**
955
- * Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
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.
956
958
  *
957
959
  * @remarks
958
960
  * - **Permission requirements**:
959
- * - **Resource Access Management (RAM) user**: Before invoking this operation, 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:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
960
- * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
961
- * - **Calling method**: 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). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
962
- * - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
963
- * - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
964
- * **Rate limiting:**
965
- * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
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.
966
968
  *
967
969
  * @param request - CreateIndexRequest
968
970
  * @returns CreateIndexResponse
@@ -976,9 +978,9 @@ class Client extends openapi_core_1.default {
976
978
  * Creates a long-term memory.
977
979
  *
978
980
  * @remarks
979
- * - You can store specific information from conversations (memory nodes. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory)) in a long-term memory. Agent applications can then reference this information in subsequent conversations. This is not an automatic creation procedure. You must first invoke the [CreateMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememory) operation to create a long-term memory and obtain the `memoryId`. Then pass the `memoryId` when you [invoke the agent application through the API](https://www.alibabacloud.com/help/en/model-studio/user-guide/application-calling).
980
- * > Long-term memory does not support storing and managing user profiles through the API. Perform related operations in the console. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory#578ebae524m6l).
981
- * - If you pass a `memoryId`, the system uses automatic creation to generate memory nodes (MemoryNode) under the specified long-term memory based on conversation records. You can also invoke the [CreateMemoryNode](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememorynode) operation to manually create memory nodes.
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.
982
984
  * - This operation does not support idempotence.
983
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.
984
986
  *
@@ -1014,9 +1016,9 @@ class Client extends openapi_core_1.default {
1014
1016
  * Creates a long-term memory.
1015
1017
  *
1016
1018
  * @remarks
1017
- * - You can store specific information from conversations (memory nodes. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory)) in a long-term memory. Agent applications can then reference this information in subsequent conversations. This is not an automatic creation procedure. You must first invoke the [CreateMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememory) operation to create a long-term memory and obtain the `memoryId`. Then pass the `memoryId` when you [invoke the agent application through the API](https://www.alibabacloud.com/help/en/model-studio/user-guide/application-calling).
1018
- * > Long-term memory does not support storing and managing user profiles through the API. Perform related operations in the console. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory#578ebae524m6l).
1019
- * - If you pass a `memoryId`, the system uses automatic creation to generate memory nodes (MemoryNode) under the specified long-term memory based on conversation records. You can also invoke the [CreateMemoryNode](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememorynode) operation to manually create memory nodes.
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.
1020
1022
  * - This operation does not support idempotence.
1021
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.
1022
1024
  *
@@ -1162,10 +1164,10 @@ class Client extends openapi_core_1.default {
1162
1164
  * Permanently deletes a specified category.
1163
1165
  *
1164
1166
  * @remarks
1165
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1166
- * - This operation is idempotent.
1167
- * **Rate limiting:**
1168
- * This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
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.
1169
1171
  *
1170
1172
  * @param request - DeleteCategoryRequest
1171
1173
  * @param headers - map
@@ -1194,10 +1196,10 @@ class Client extends openapi_core_1.default {
1194
1196
  * Permanently deletes a specified category.
1195
1197
  *
1196
1198
  * @remarks
1197
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1198
- * - This operation is idempotent.
1199
- * **Rate limiting:**
1200
- * This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
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.
1201
1203
  *
1202
1204
  * @param request - DeleteCategoryRequest
1203
1205
  * @returns DeleteCategoryResponse
@@ -1208,18 +1210,18 @@ class Client extends openapi_core_1.default {
1208
1210
  return await this.deleteCategoryWithOptions(CategoryId, WorkspaceId, request, headers, runtime);
1209
1211
  }
1210
1212
  /**
1211
- * Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
1213
+ * Deletes a specified text chunk from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
1212
1214
  *
1213
1215
  * @remarks
1214
1216
  * <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
1215
1217
  * - **Permission requirements**:
1216
- * - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
1217
- * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
1218
- * - **Invocation method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
1219
- * - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
1220
- * - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
1221
- * **Rate limit:**
1222
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
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.
1223
1225
  *
1224
1226
  * @param tmpReq - DeleteChunkRequest
1225
1227
  * @param headers - map
@@ -1258,18 +1260,18 @@ class Client extends openapi_core_1.default {
1258
1260
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteChunkResponse({}));
1259
1261
  }
1260
1262
  /**
1261
- * Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
1263
+ * Deletes a specified text chunk from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
1262
1264
  *
1263
1265
  * @remarks
1264
1266
  * <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
1265
1267
  * - **Permission requirements**:
1266
- * - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
1267
- * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
1268
- * - **Invocation method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
1269
- * - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
1270
- * - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
1271
- * **Rate limit:**
1272
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
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.
1273
1275
  *
1274
1276
  * @param request - DeleteChunkRequest
1275
1277
  * @returns DeleteChunkResponse
@@ -1329,16 +1331,16 @@ class Client extends openapi_core_1.default {
1329
1331
  return await this.deleteConnectorWithOptions(ConnectorId, WorkspaceId, request, headers, runtime);
1330
1332
  }
1331
1333
  /**
1332
- * Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
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.
1333
1335
  *
1334
1336
  * @remarks
1335
- * - Deleting data tables via API is not supported. To delete a data table or specific data within a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) to perform the operation.
1336
- * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) and does not affect any knowledge bases that have already been built. To delete a file from a knowledge base, invoke the **DeleteIndexDocument** API.
1337
- * - A RAM user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the `sfm:DeleteFile` permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this API. An Alibaba Cloud account can invoke this API directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this API.
1338
- * - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
1339
- * - This API is idempotent.
1340
- * **Rate Limiting Notice:**
1341
- * Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
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.
1342
1344
  *
1343
1345
  * @param request - DeleteFileRequest
1344
1346
  * @param headers - map
@@ -1364,16 +1366,16 @@ class Client extends openapi_core_1.default {
1364
1366
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFileResponse({}));
1365
1367
  }
1366
1368
  /**
1367
- * Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
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.
1368
1370
  *
1369
1371
  * @remarks
1370
- * - Deleting data tables via API is not supported. To delete a data table or specific data within a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) to perform the operation.
1371
- * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) and does not affect any knowledge bases that have already been built. To delete a file from a knowledge base, invoke the **DeleteIndexDocument** API.
1372
- * - A RAM user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the `sfm:DeleteFile` permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this API. An Alibaba Cloud account can invoke this API directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this API.
1373
- * - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
1374
- * - This API is idempotent.
1375
- * **Rate Limiting Notice:**
1376
- * Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
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.
1377
1379
  *
1378
1380
  * @param request - DeleteFileRequest
1379
1381
  * @returns DeleteFileResponse
@@ -1384,16 +1386,16 @@ class Client extends openapi_core_1.default {
1384
1386
  return await this.deleteFileWithOptions(FileId, WorkspaceId, request, headers, runtime);
1385
1387
  }
1386
1388
  /**
1387
- * Delete files in batch
1389
+ * Deletes files in batches.
1388
1390
  *
1389
1391
  * @remarks
1390
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).
1391
- * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). It does not affect knowledge bases that have already been built. To delete files in a knowledge base, call the **DeleteIndexDocument** operation.
1392
- * - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which already includes the sfm:DeleteFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1393
- * - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
1394
- * - This operation is idempotent.
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.
1395
1397
  * **Throttling:**
1396
- * Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
1398
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
1397
1399
  *
1398
1400
  * @param tmpReq - DeleteFilesRequest
1399
1401
  * @param headers - map
@@ -1429,16 +1431,16 @@ class Client extends openapi_core_1.default {
1429
1431
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFilesResponse({}));
1430
1432
  }
1431
1433
  /**
1432
- * Delete files in batch
1434
+ * Deletes files in batches.
1433
1435
  *
1434
1436
  * @remarks
1435
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).
1436
- * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). It does not affect knowledge bases that have already been built. To delete files in a knowledge base, call the **DeleteIndexDocument** operation.
1437
- * - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which already includes the sfm:DeleteFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1438
- * - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
1439
- * - This operation is idempotent.
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.
1440
1442
  * **Throttling:**
1441
- * Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
1443
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
1442
1444
  *
1443
1445
  * @param request - DeleteFilesRequest
1444
1446
  * @returns DeleteFilesResponse
@@ -1709,10 +1711,10 @@ class Client extends openapi_core_1.default {
1709
1711
  * Queries the basic information of a file in application data, including the file name, type, and status.
1710
1712
  *
1711
1713
  * @remarks
1712
- * - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
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.
1713
1715
  * - This operation is idempotent.
1714
- * **Throttling:**
1715
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
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.
1716
1718
  *
1717
1719
  * @param request - DescribeFileRequest
1718
1720
  * @param headers - map
@@ -1741,10 +1743,10 @@ class Client extends openapi_core_1.default {
1741
1743
  * Queries the basic information of a file in application data, including the file name, type, and status.
1742
1744
  *
1743
1745
  * @remarks
1744
- * - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
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.
1745
1747
  * - This operation is idempotent.
1746
- * **Throttling:**
1747
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
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.
1748
1750
  *
1749
1751
  * @param request - DescribeFileRequest
1750
1752
  * @returns DescribeFileResponse
@@ -1845,13 +1847,13 @@ class Client extends openapi_core_1.default {
1845
1847
  return await this.getAlipayUrlWithOptions(request, headers, runtime);
1846
1848
  }
1847
1849
  /**
1848
- * Lists all supported parser types based on the input file type (file extension).
1850
+ * Retrieves the list of all supported parser types based on the specified file type (file name extension).
1849
1851
  *
1850
1852
  * @remarks
1851
- * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetAvailableParserTypes权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
1852
- * - 本接口具有幂等性。
1853
- * **限流说明:**
1854
- * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
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.
1855
1857
  *
1856
1858
  * @param request - GetAvailableParserTypesRequest
1857
1859
  * @param headers - map
@@ -1882,13 +1884,13 @@ class Client extends openapi_core_1.default {
1882
1884
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAvailableParserTypesResponse({}));
1883
1885
  }
1884
1886
  /**
1885
- * Lists all supported parser types based on the input file type (file extension).
1887
+ * Retrieves the list of all supported parser types based on the specified file type (file name extension).
1886
1888
  *
1887
1889
  * @remarks
1888
- * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetAvailableParserTypes权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
1889
- * - 本接口具有幂等性。
1890
- * **限流说明:**
1891
- * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
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.
1892
1894
  *
1893
1895
  * @param request - GetAvailableParserTypesRequest
1894
1896
  * @returns GetAvailableParserTypesResponse
@@ -1956,13 +1958,13 @@ class Client extends openapi_core_1.default {
1956
1958
  return await this.getConnectorWithOptions(WorkspaceId, request, headers, runtime);
1957
1959
  }
1958
1960
  /**
1959
- * Queries the current status of a specified knowledge base creation task or knowledge base document append task.
1961
+ * Queries the current status of a specified knowledge base creation task or knowledge base document addition task.
1960
1962
  *
1961
1963
  * @remarks
1962
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
1963
- * - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
1964
- * - Invoke this operation at intervals of 5 seconds or more.
1965
- * - This operation supports idempotence.
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.
1966
1968
  *
1967
1969
  * @param request - GetIndexJobStatusRequest
1968
1970
  * @param headers - map
@@ -2002,13 +2004,13 @@ class Client extends openapi_core_1.default {
2002
2004
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexJobStatusResponse({}));
2003
2005
  }
2004
2006
  /**
2005
- * Queries the current status of a specified knowledge base creation task or knowledge base document append task.
2007
+ * Queries the current status of a specified knowledge base creation task or knowledge base document addition task.
2006
2008
  *
2007
2009
  * @remarks
2008
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
2009
- * - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
2010
- * - Invoke this operation at intervals of 5 seconds or more.
2011
- * - This operation supports idempotence.
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.
2012
2014
  *
2013
2015
  * @param request - GetIndexJobStatusRequest
2014
2016
  * @returns GetIndexJobStatusResponse
@@ -2161,13 +2163,13 @@ class Client extends openapi_core_1.default {
2161
2163
  return await this.getMemoryNodeWithOptions(workspaceId, memoryId, memoryNodeId, request, headers, runtime);
2162
2164
  }
2163
2165
  /**
2164
- * Queries the data parsing settings in a specified category.
2166
+ * Queries the data parsing settings for a specified category.
2165
2167
  *
2166
2168
  * @remarks
2167
- * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetParseSettings权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
2168
- * - 本接口具有幂等性。
2169
- * **限流说明:**
2170
- * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
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.
2171
2173
  *
2172
2174
  * @param request - GetParseSettingsRequest
2173
2175
  * @param headers - map
@@ -2198,13 +2200,13 @@ class Client extends openapi_core_1.default {
2198
2200
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetParseSettingsResponse({}));
2199
2201
  }
2200
2202
  /**
2201
- * Queries the data parsing settings in a specified category.
2203
+ * Queries the data parsing settings for a specified category.
2202
2204
  *
2203
2205
  * @remarks
2204
- * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetParseSettings权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
2205
- * - 本接口具有幂等性。
2206
- * **限流说明:**
2207
- * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
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.
2208
2210
  *
2209
2211
  * @param request - GetParseSettingsRequest
2210
2212
  * @returns GetParseSettingsResponse
@@ -2349,11 +2351,12 @@ class Client extends openapi_core_1.default {
2349
2351
  * Retrieves the details of one or more categories in a specified workspace.
2350
2352
  *
2351
2353
  * @remarks
2352
- * - This API does not support querying data tables.
2353
- * - To call this API, a RAM user must first obtain the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` permission, which includes the `sfm:ListCategory` permission. Alibaba Cloud accounts can call this API directly. Use the latest version of the <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
2354
- * - This operation supports pagination. When making your first request, set the `MaxResults` parameter to specify the maximum number of items to return. If more items are available, the response includes a `NextToken`. To retrieve the next page of results, set the `NextToken` parameter to the value from the previous response and specify `MaxResults` again. An empty `NextToken` indicates that no more results are available.
2355
- * - This operation is idempotent.
2356
- * **Rate limiting:** This API is subject to rate limiting. Do not exceed 5 requests per second. If the system throttles a request, retry it after a short interval.
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.
2357
2360
  *
2358
2361
  * @param request - ListCategoryRequest
2359
2362
  * @param headers - map
@@ -2402,11 +2405,12 @@ class Client extends openapi_core_1.default {
2402
2405
  * Retrieves the details of one or more categories in a specified workspace.
2403
2406
  *
2404
2407
  * @remarks
2405
- * - This API does not support querying data tables.
2406
- * - To call this API, a RAM user must first obtain the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` permission, which includes the `sfm:ListCategory` permission. Alibaba Cloud accounts can call this API directly. Use the latest version of the <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
2407
- * - This operation supports pagination. When making your first request, set the `MaxResults` parameter to specify the maximum number of items to return. If more items are available, the response includes a `NextToken`. To retrieve the next page of results, set the `NextToken` parameter to the value from the previous response and specify `MaxResults` again. An empty `NextToken` indicates that no more results are available.
2408
- * - This operation is idempotent.
2409
- * **Rate limiting:** This API is subject to rate limiting. Do not exceed 5 requests per second. If the system throttles a request, retry it after a short interval.
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.
2410
2414
  *
2411
2415
  * @param request - ListCategoryRequest
2412
2416
  * @returns ListCategoryResponse
@@ -2493,11 +2497,11 @@ class Client extends openapi_core_1.default {
2493
2497
  * Retrieves the details of one or more documents in a specified category.
2494
2498
  *
2495
2499
  * @remarks
2496
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
2497
- * - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
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.
2498
2502
  * - This operation is idempotent.
2499
2503
  * **Rate limit:**
2500
- * 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.
2501
2505
  *
2502
2506
  * @param tmpReq - ListFileRequest
2503
2507
  * @param headers - map
@@ -2548,11 +2552,11 @@ class Client extends openapi_core_1.default {
2548
2552
  * Retrieves the details of one or more documents in a specified category.
2549
2553
  *
2550
2554
  * @remarks
2551
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
2552
- * - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
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.
2553
2557
  * - This operation is idempotent.
2554
2558
  * **Rate limit:**
2555
- * 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.
2556
2560
  *
2557
2561
  * @param request - ListFileRequest
2558
2562
  * @returns ListFileResponse
@@ -2563,14 +2567,14 @@ class Client extends openapi_core_1.default {
2563
2567
  return await this.listFileWithOptions(WorkspaceId, request, headers, runtime);
2564
2568
  }
2565
2569
  /**
2566
- * Retrieves files and their summary information from a specified knowledge base.
2570
+ * Retrieves the files and their summary information from a specified knowledge base.
2567
2571
  *
2568
2572
  * @remarks
2569
- * - 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.
2570
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).
2571
2575
  * - This operation has idempotence.
2572
2576
  * **Throttling:**
2573
- * This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
2577
+ * This operation is subject to throttling. Do not exceed 15 calls per second. If you are throttled, retry later.
2574
2578
  *
2575
2579
  * @param request - ListIndexDocumentsRequest
2576
2580
  * @param headers - map
@@ -2616,14 +2620,14 @@ class Client extends openapi_core_1.default {
2616
2620
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndexDocumentsResponse({}));
2617
2621
  }
2618
2622
  /**
2619
- * Retrieves files and their summary information from a specified knowledge base.
2623
+ * Retrieves the files and their summary information from a specified knowledge base.
2620
2624
  *
2621
2625
  * @remarks
2622
- * - 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.
2623
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).
2624
2628
  * - This operation has idempotence.
2625
2629
  * **Throttling:**
2626
- * This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
2630
+ * This operation is subject to throttling. Do not exceed 15 calls per second. If you are throttled, retry later.
2627
2631
  *
2628
2632
  * @param request - ListIndexDocumentsRequest
2629
2633
  * @returns ListIndexDocumentsResponse
@@ -2704,10 +2708,10 @@ class Client extends openapi_core_1.default {
2704
2708
  * Retrieves the list of knowledge bases in a specified workspace.
2705
2709
  *
2706
2710
  * @remarks
2707
- * - 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). Only then can they call this operation. Alibaba Cloud accounts (primary 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.
2708
- * - This operation is idempotent.
2709
- * **Rate limit:**
2710
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
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
+ * - This operation has idempotence.
2713
+ * **Throttling:**
2714
+ * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
2711
2715
  *
2712
2716
  * @param request - ListIndicesRequest
2713
2717
  * @param headers - map
@@ -2747,10 +2751,10 @@ class Client extends openapi_core_1.default {
2747
2751
  * Retrieves the list of knowledge bases in a specified workspace.
2748
2752
  *
2749
2753
  * @remarks
2750
- * - 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). Only then can they call this operation. Alibaba Cloud accounts (primary 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.
2751
- * - This operation is idempotent.
2752
- * **Rate limit:**
2753
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
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
+ * - This operation has idempotence.
2756
+ * **Throttling:**
2757
+ * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
2754
2758
  *
2755
2759
  * @param request - ListIndicesRequest
2756
2760
  * @returns ListIndicesResponse
@@ -2764,7 +2768,7 @@ class Client extends openapi_core_1.default {
2764
2768
  * Retrieves the details of one or more long-term memory entities in a specified workspace.
2765
2769
  *
2766
2770
  * @remarks
2767
- * - When querying the first page of a paging query, set only `MaxResults` to limit the number of entries returned. The `NextToken` value in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response as the query credential (if `NextToken` is empty, all results have been returned and no further requests are needed), and settings `MaxResults` to limit the number of entries returned.
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.
2768
2772
  * - This operation supports idempotence.
2769
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.
2770
2774
  *
@@ -2803,7 +2807,7 @@ class Client extends openapi_core_1.default {
2803
2807
  * Retrieves the details of one or more long-term memory entities in a specified workspace.
2804
2808
  *
2805
2809
  * @remarks
2806
- * - When querying the first page of a paging query, set only `MaxResults` to limit the number of entries returned. The `NextToken` value in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response as the query credential (if `NextToken` is empty, all results have been returned and no further requests are needed), and settings `MaxResults` to limit the number of entries returned.
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.
2807
2811
  * - This operation supports idempotence.
2808
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.
2809
2813
  *
@@ -2969,19 +2973,19 @@ class Client extends openapi_core_1.default {
2969
2973
  *
2970
2974
  * @remarks
2971
2975
  * <props="china">
2972
- * - **How to call**: To retrieve information from a knowledge base, use the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) with an [AccessKey](https://help.aliyun.com/document_detail/116401.html) or [Spring AI Alibaba](https://help.aliyun.com/document_detail/2990886.html) with an Alibaba Cloud Model Studio [API key](https://help.aliyun.com/document_detail/2712195.html). Both tools simplify your API calls by handling the complex signature calculation.
2973
- * - **Required permissions**:
2974
- * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
2975
- * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
2976
- * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
2977
- * - **Idempotency**: This API is idempotent.
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.
2978
2982
  * <props="intl">
2979
- * - **How to call**: We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API. The SDK simplifies API calls by handling the complex signature calculation.
2980
- * - **Required permissions**:
2981
- * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
2982
- * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
2983
- * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
2984
- * - **Idempotency**: This API is idempotent.
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.
2985
2989
  *
2986
2990
  * @param tmpReq - RetrieveRequest
2987
2991
  * @param headers - map
@@ -3078,19 +3082,19 @@ class Client extends openapi_core_1.default {
3078
3082
  *
3079
3083
  * @remarks
3080
3084
  * <props="china">
3081
- * - **How to call**: To retrieve information from a knowledge base, use the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) with an [AccessKey](https://help.aliyun.com/document_detail/116401.html) or [Spring AI Alibaba](https://help.aliyun.com/document_detail/2990886.html) with an Alibaba Cloud Model Studio [API key](https://help.aliyun.com/document_detail/2712195.html). Both tools simplify your API calls by handling the complex signature calculation.
3082
- * - **Required permissions**:
3083
- * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
3084
- * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
3085
- * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
3086
- * - **Idempotency**: This API is idempotent.
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.
3087
3091
  * <props="intl">
3088
- * - **How to call**: We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API. The SDK simplifies API calls by handling the complex signature calculation.
3089
- * - **Required permissions**:
3090
- * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
3091
- * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
3092
- * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
3093
- * - **Idempotency**: This API is idempotent.
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.
3094
3098
  *
3095
3099
  * @param request - RetrieveRequest
3096
3100
  * @returns RetrieveResponse
@@ -3394,15 +3398,15 @@ class Client extends openapi_core_1.default {
3394
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.
3395
3399
  *
3396
3400
  * @remarks
3397
- * - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
3401
+ * - **Key restrictions**: This operation supports only document search knowledge bases. Data query and image-based Q&A knowledge bases are not supported.
3398
3402
  * - **Permission requirements**:
3399
- * - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
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.
3400
3404
  * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
3401
- * - **Calling method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
3402
- * - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
3403
- * - **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.
3404
3408
  * **Rate limit:**
3405
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
3409
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry after a short wait.
3406
3410
  *
3407
3411
  * @param request - UpdateChunkRequest
3408
3412
  * @param headers - map
@@ -3451,15 +3455,15 @@ class Client extends openapi_core_1.default {
3451
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.
3452
3456
  *
3453
3457
  * @remarks
3454
- * - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
3458
+ * - **Key restrictions**: This operation supports only document search knowledge bases. Data query and image-based Q&A knowledge bases are not supported.
3455
3459
  * - **Permission requirements**:
3456
- * - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
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.
3457
3461
  * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
3458
- * - **Calling method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
3459
- * - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
3460
- * - **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.
3461
3465
  * **Rate limit:**
3462
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
3466
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry after a short wait.
3463
3467
  *
3464
3468
  * @param request - UpdateChunkRequest
3465
3469
  * @returns UpdateChunkResponse
@@ -3582,13 +3586,14 @@ class Client extends openapi_core_1.default {
3582
3586
  return await this.updateFileTagWithOptions(WorkspaceId, FileId, request, headers, runtime);
3583
3587
  }
3584
3588
  /**
3585
- * Updates the configuration of a specified knowledge base.
3589
+ * Updates partial configurations of a specified knowledge base.
3586
3590
  *
3587
3591
  * @remarks
3588
- * <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
3589
- * Before a RAM user can call this operation, the RAM user must have the `AliyunBailianDataFullAccess` permission for Alibaba Cloud Model Studio. For more information, see [Grant permissions](https://help.aliyun.com/document_detail/2848578.html). The RAM user must also be added to a workspace. For more information, see [Add a member to a workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this operation without authorization. Use the latest version of the Alibaba Cloud Model Studio SDK to call this operation. For more information, see [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29).
3590
- * Before you call this operation, ensure that the knowledge base is created and has not been deleted. The knowledge base ID (`Id`) must be valid.
3591
- * This operation is idempotent.
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.
3592
3597
  *
3593
3598
  * @param request - UpdateIndexRequest
3594
3599
  * @param headers - map
@@ -3640,13 +3645,14 @@ class Client extends openapi_core_1.default {
3640
3645
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateIndexResponse({}));
3641
3646
  }
3642
3647
  /**
3643
- * Updates the configuration of a specified knowledge base.
3648
+ * Updates partial configurations of a specified knowledge base.
3644
3649
  *
3645
3650
  * @remarks
3646
- * <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
3647
- * Before a RAM user can call this operation, the RAM user must have the `AliyunBailianDataFullAccess` permission for Alibaba Cloud Model Studio. For more information, see [Grant permissions](https://help.aliyun.com/document_detail/2848578.html). The RAM user must also be added to a workspace. For more information, see [Add a member to a workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this operation without authorization. Use the latest version of the Alibaba Cloud Model Studio SDK to call this operation. For more information, see [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29).
3648
- * Before you call this operation, ensure that the knowledge base is created and has not been deleted. The knowledge base ID (`Id`) must be valid.
3649
- * This operation is idempotent.
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.
3650
3656
  *
3651
3657
  * @param request - UpdateIndexRequest
3652
3658
  * @returns UpdateIndexResponse
@@ -3794,15 +3800,18 @@ class Client extends openapi_core_1.default {
3794
3800
  return await this.updatePromptTemplateWithOptions(workspaceId, promptTemplateId, request, headers, runtime);
3795
3801
  }
3796
3802
  /**
3797
- * Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
3803
+ * Updates a table in a table connector of Alibaba Cloud Model Studio Data Hub using a file from an authorized OSS bucket.
3798
3804
  *
3799
3805
  * @remarks
3800
- * - Ensure that the OSS bucket belongs to the same Alibaba Cloud account as your Alibaba Cloud Model Studio instance. You must also complete the authorization steps described in [Configure data import from OSS](https://help.aliyun.com/document_detail/2782155.html).
3801
- * - The bucket storage class must not be Archive, Cold Archive, or Deep Cold Archive. Buckets with server-side encryption are supported. public-read-write, public-read, and private buckets are also supported.
3802
- * - If you use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html), you must add `*.console.aliyun.com` to the Referer whitelist. For more information, see [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
3803
- * - Before a RAM user (sub-account) can call this operation, they must obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). The AliyunBailianDataFullAccess policy includes the required `sfm:UpdateTableFromAuthorizedOss` permission. An Alibaba Cloud account (root account) can call this operation directly without additional permissions. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) or <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
3804
- * - This operation is not idempotent.
3805
- * **Rate limiting:** This operation is subject to rate limiting. Do not call it more than five times per second. If you reach the limit, wait before you try again.
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.
3806
3815
  *
3807
3816
  * @param request - UpdateTableFromAuthorizedOssRequest
3808
3817
  * @param headers - map
@@ -3842,15 +3851,18 @@ class Client extends openapi_core_1.default {
3842
3851
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateTableFromAuthorizedOssResponse({}));
3843
3852
  }
3844
3853
  /**
3845
- * Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
3854
+ * Updates a table in a table connector of Alibaba Cloud Model Studio Data Hub using a file from an authorized OSS bucket.
3846
3855
  *
3847
3856
  * @remarks
3848
- * - Ensure that the OSS bucket belongs to the same Alibaba Cloud account as your Alibaba Cloud Model Studio instance. You must also complete the authorization steps described in [Configure data import from OSS](https://help.aliyun.com/document_detail/2782155.html).
3849
- * - The bucket storage class must not be Archive, Cold Archive, or Deep Cold Archive. Buckets with server-side encryption are supported. public-read-write, public-read, and private buckets are also supported.
3850
- * - If you use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html), you must add `*.console.aliyun.com` to the Referer whitelist. For more information, see [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
3851
- * - Before a RAM user (sub-account) can call this operation, they must obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). The AliyunBailianDataFullAccess policy includes the required `sfm:UpdateTableFromAuthorizedOss` permission. An Alibaba Cloud account (root account) can call this operation directly without additional permissions. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) or <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
3852
- * - This operation is not idempotent.
3853
- * **Rate limiting:** This operation is subject to rate limiting. Do not call it more than five times per second. If you reach the limit, wait before you try again.
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.
3854
3866
  *
3855
3867
  * @param request - UpdateTableFromAuthorizedOssRequest
3856
3868
  * @returns UpdateTableFromAuthorizedOssResponse