@alicloud/bailian20231229 2.13.1 → 2.14.1

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 (94) hide show
  1. package/dist/client.d.ts +120 -84
  2. package/dist/client.js +155 -84
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddChunkRequest.d.ts +53 -0
  5. package/dist/models/AddChunkRequest.js +65 -0
  6. package/dist/models/AddChunkRequest.js.map +1 -0
  7. package/dist/models/AddChunkResponse.d.ts +19 -0
  8. package/dist/models/AddChunkResponse.js +69 -0
  9. package/dist/models/AddChunkResponse.js.map +1 -0
  10. package/dist/models/AddChunkResponseBody.d.ts +61 -0
  11. package/dist/models/AddChunkResponseBody.js +68 -0
  12. package/dist/models/AddChunkResponseBody.js.map +1 -0
  13. package/dist/models/AddChunkShrinkRequest.d.ts +51 -0
  14. package/dist/models/AddChunkShrinkRequest.js +62 -0
  15. package/dist/models/AddChunkShrinkRequest.js.map +1 -0
  16. package/dist/models/AddFileRequest.d.ts +27 -39
  17. package/dist/models/AddFileRequest.js.map +1 -1
  18. package/dist/models/AddFileResponseBody.d.ts +8 -11
  19. package/dist/models/AddFileResponseBody.js.map +1 -1
  20. package/dist/models/AddFileShrinkRequest.d.ts +26 -38
  21. package/dist/models/AddFileShrinkRequest.js.map +1 -1
  22. package/dist/models/AddFilesFromAuthorizedOssRequest.d.ts +29 -29
  23. package/dist/models/AddFilesFromAuthorizedOssResponseBody.d.ts +14 -14
  24. package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.d.ts +10 -10
  25. package/dist/models/AddTableRequest.d.ts +7 -0
  26. package/dist/models/AddTableRequest.js.map +1 -1
  27. package/dist/models/AddTableResponseBody.d.ts +6 -6
  28. package/dist/models/AddTableShrinkRequest.d.ts +7 -0
  29. package/dist/models/AddTableShrinkRequest.js.map +1 -1
  30. package/dist/models/ChangeParseSettingRequest.d.ts +10 -28
  31. package/dist/models/ChangeParseSettingRequest.js.map +1 -1
  32. package/dist/models/ChangeParseSettingResponseBody.d.ts +8 -12
  33. package/dist/models/ChangeParseSettingResponseBody.js.map +1 -1
  34. package/dist/models/ChangeParseSettingShrinkRequest.d.ts +9 -27
  35. package/dist/models/ChangeParseSettingShrinkRequest.js.map +1 -1
  36. package/dist/models/CreateIndexRequest.d.ts +163 -159
  37. package/dist/models/CreateIndexRequest.js.map +1 -1
  38. package/dist/models/CreateIndexResponseBody.d.ts +11 -13
  39. package/dist/models/CreateIndexResponseBody.js.map +1 -1
  40. package/dist/models/CreateIndexShrinkRequest.d.ts +137 -127
  41. package/dist/models/CreateIndexShrinkRequest.js.map +1 -1
  42. package/dist/models/DescribeFileResponseBody.d.ts +33 -26
  43. package/dist/models/DescribeFileResponseBody.js.map +1 -1
  44. package/dist/models/GetIndexJobStatusRequest.d.ts +1 -1
  45. package/dist/models/GetIndexJobStatusResponseBody.d.ts +15 -13
  46. package/dist/models/GetIndexJobStatusResponseBody.js.map +1 -1
  47. package/dist/models/ListFileRequest.d.ts +2 -2
  48. package/dist/models/ListFileResponseBody.d.ts +8 -1
  49. package/dist/models/ListFileResponseBody.js.map +1 -1
  50. package/dist/models/ListFileShrinkRequest.d.ts +2 -2
  51. package/dist/models/ListIndexDocumentsRequest.d.ts +11 -9
  52. package/dist/models/ListIndexDocumentsRequest.js.map +1 -1
  53. package/dist/models/ListIndexDocumentsResponseBody.d.ts +13 -15
  54. package/dist/models/ListIndexDocumentsResponseBody.js.map +1 -1
  55. package/dist/models/ListIndexFileDetailsRequest.d.ts +16 -18
  56. package/dist/models/ListIndexFileDetailsRequest.js.map +1 -1
  57. package/dist/models/ListIndexFileDetailsResponseBody.d.ts +29 -32
  58. package/dist/models/ListIndexFileDetailsResponseBody.js +2 -0
  59. package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
  60. package/dist/models/model.d.ts +4 -0
  61. package/dist/models/model.js +13 -5
  62. package/dist/models/model.js.map +1 -1
  63. package/package.json +2 -2
  64. package/src/client.ts +161 -84
  65. package/src/models/AddChunkRequest.ts +71 -0
  66. package/src/models/AddChunkResponse.ts +40 -0
  67. package/src/models/AddChunkResponseBody.ts +84 -0
  68. package/src/models/AddChunkShrinkRequest.ts +68 -0
  69. package/src/models/AddFileRequest.ts +27 -39
  70. package/src/models/AddFileResponseBody.ts +8 -11
  71. package/src/models/AddFileShrinkRequest.ts +26 -38
  72. package/src/models/AddFilesFromAuthorizedOssRequest.ts +29 -29
  73. package/src/models/AddFilesFromAuthorizedOssResponseBody.ts +14 -14
  74. package/src/models/AddFilesFromAuthorizedOssShrinkRequest.ts +10 -10
  75. package/src/models/AddTableRequest.ts +7 -0
  76. package/src/models/AddTableResponseBody.ts +6 -6
  77. package/src/models/AddTableShrinkRequest.ts +7 -0
  78. package/src/models/ChangeParseSettingRequest.ts +10 -28
  79. package/src/models/ChangeParseSettingResponseBody.ts +8 -12
  80. package/src/models/ChangeParseSettingShrinkRequest.ts +9 -27
  81. package/src/models/CreateIndexRequest.ts +163 -159
  82. package/src/models/CreateIndexResponseBody.ts +11 -13
  83. package/src/models/CreateIndexShrinkRequest.ts +137 -127
  84. package/src/models/DescribeFileResponseBody.ts +33 -26
  85. package/src/models/GetIndexJobStatusRequest.ts +1 -1
  86. package/src/models/GetIndexJobStatusResponseBody.ts +15 -13
  87. package/src/models/ListFileRequest.ts +2 -2
  88. package/src/models/ListFileResponseBody.ts +8 -1
  89. package/src/models/ListFileShrinkRequest.ts +2 -2
  90. package/src/models/ListIndexDocumentsRequest.ts +11 -9
  91. package/src/models/ListIndexDocumentsResponseBody.ts +13 -15
  92. package/src/models/ListIndexFileDetailsRequest.ts +16 -18
  93. package/src/models/ListIndexFileDetailsResponseBody.ts +31 -32
  94. package/src/models/model.ts +4 -0
package/dist/client.d.ts CHANGED
@@ -38,6 +38,40 @@ export default class Client extends OpenApi {
38
38
  * @returns AddCategoryResponse
39
39
  */
40
40
  addCategory(WorkspaceId: string, request: $_model.AddCategoryRequest): Promise<$_model.AddCategoryResponse>;
41
+ /**
42
+ * Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
43
+ *
44
+ * @remarks
45
+ * - This operation adds chunk content to a specified knowledge base of the document search (document), data query (table), or image Q&A (image) type. Related operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
46
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
47
+ * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
48
+ * - This operation has idempotence.
49
+ * **Throttling:**
50
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
51
+ *
52
+ * @param tmpReq - AddChunkRequest
53
+ * @param headers - map
54
+ * @param runtime - runtime options for this request RuntimeOptions
55
+ * @returns AddChunkResponse
56
+ */
57
+ addChunkWithOptions(WorkspaceId: string, tmpReq: $_model.AddChunkRequest, headers: {
58
+ [key: string]: string;
59
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.AddChunkResponse>;
60
+ /**
61
+ * Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
62
+ *
63
+ * @remarks
64
+ * - This operation adds chunk content to a specified knowledge base of the document search (document), data query (table), or image Q&A (image) type. Related operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
65
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
66
+ * - 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).
67
+ * - This operation has idempotence.
68
+ * **Throttling:**
69
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
70
+ *
71
+ * @param request - AddChunkRequest
72
+ * @returns AddChunkResponse
73
+ */
74
+ addChunk(WorkspaceId: string, request: $_model.AddChunkRequest): Promise<$_model.AddChunkResponse>;
41
75
  /**
42
76
  * Creates a connector. This API currently supports only file connectors.
43
77
  *
@@ -69,12 +103,13 @@ export default class Client extends OpenApi {
69
103
  */
70
104
  addConnector(WorkspaceId: string, request: $_model.AddConnectorRequest): Promise<$_model.AddConnectorResponse>;
71
105
  /**
72
- * Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
106
+ * Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
73
107
  *
74
108
  * @remarks
75
- * - To call this API, a RAM user (sub-account) must have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and be [added to a workspace](https://help.aliyun.com/document_detail/2851098.html). The required policy is `AliyunBailianDataFullAccess`, which includes the `sfm:AddFile` permission. An Alibaba Cloud account (primary account) can call this API directly without authorization. We recommend 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) to call this API.
76
- * - This API is not idempotent.
77
- * **Throttling:** Frequent calls to this API are subject to throttling. Do not exceed a rate of 10 calls per second. If your request is throttled, try again later.
109
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
110
+ * - This operation is not idempotent.
111
+ * **Throttling:**
112
+ * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
78
113
  *
79
114
  * @param tmpReq - AddFileRequest
80
115
  * @param headers - map
@@ -85,29 +120,30 @@ export default class Client extends OpenApi {
85
120
  [key: string]: string;
86
121
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddFileResponse>;
87
122
  /**
88
- * Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
123
+ * Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
89
124
  *
90
125
  * @remarks
91
- * - To call this API, a RAM user (sub-account) must have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and be [added to a workspace](https://help.aliyun.com/document_detail/2851098.html). The required policy is `AliyunBailianDataFullAccess`, which includes the `sfm:AddFile` permission. An Alibaba Cloud account (primary account) can call this API directly without authorization. We recommend 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) to call this API.
92
- * - This API is not idempotent.
93
- * **Throttling:** Frequent calls to this API are subject to throttling. Do not exceed a rate of 10 calls per second. If your request is throttled, try again later.
126
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
127
+ * - This operation is not idempotent.
128
+ * **Throttling:**
129
+ * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
94
130
  *
95
131
  * @param request - AddFileRequest
96
132
  * @returns AddFileResponse
97
133
  */
98
134
  addFile(WorkspaceId: string, request: $_model.AddFileRequest): Promise<$_model.AddFileResponse>;
99
135
  /**
100
- * Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
136
+ * Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
101
137
  *
102
138
  * @remarks
103
- * - Please ensure that the OSS Bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account (main account) and that authorization has been completed according to the [Configuration instructions for importing data from OSS](https://help.aliyun.com/document_detail/2782155.html).
139
+ * - 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).
104
140
  *
105
- * - Supported Bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption are supported. Public read/write, public read, and private Buckets are supported.
106
- * - If you want to use a Bucket with [Referer hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, refer to [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html) to add the domain `*.console.aliyun.com` to the Referer allowlist.
107
- * - 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 includes the sfm:AddFilesFromAuthorizedOss permission point) 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 directly without authorization. We recommend that you call this operation through 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).
108
- * - This operation is not idempotent.
109
- * **Throttling description:**
110
- * Frequent calls to this operation will be throttled. The frequency should not exceed 5 calls per second. If throttled, please try again later.
141
+ * - 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.
142
+ * - 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).
143
+ * - 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).
144
+ * - This operation does not have idempotence.
145
+ * **Rate limit:**
146
+ * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
111
147
  *
112
148
  * @param tmpReq - AddFilesFromAuthorizedOssRequest
113
149
  * @param headers - map
@@ -118,30 +154,30 @@ export default class Client extends OpenApi {
118
154
  [key: string]: string;
119
155
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
120
156
  /**
121
- * Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
157
+ * Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
122
158
  *
123
159
  * @remarks
124
- * - Please ensure that the OSS Bucket and Alibaba Cloud Model Studio belong to the same Alibaba Cloud account (main account) and that authorization has been completed according to the [Configuration instructions for importing data from OSS](https://help.aliyun.com/document_detail/2782155.html).
160
+ * - 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).
125
161
  *
126
- * - Supported Bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption are supported. Public read/write, public read, and private Buckets are supported.
127
- * - If you want to use a Bucket with [Referer hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, refer to [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html) to add the domain `*.console.aliyun.com` to the Referer allowlist.
128
- * - 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 includes the sfm:AddFilesFromAuthorizedOss permission point) 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 directly without authorization. We recommend that you call this operation through 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).
129
- * - This operation is not idempotent.
130
- * **Throttling description:**
131
- * Frequent calls to this operation will be throttled. The frequency should not exceed 5 calls per second. If throttled, please try again later.
162
+ * - 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.
163
+ * - 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).
164
+ * - 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).
165
+ * - This operation does not have idempotence.
166
+ * **Rate limit:**
167
+ * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
132
168
  *
133
169
  * @param request - AddFilesFromAuthorizedOssRequest
134
170
  * @returns AddFilesFromAuthorizedOssResponse
135
171
  */
136
172
  addFilesFromAuthorizedOss(WorkspaceId: string, request: $_model.AddFilesFromAuthorizedOssRequest): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
137
173
  /**
138
- * Adds a table to a tabular data connector.
174
+ * Add a table for the table data connector.
139
175
  *
140
176
  * @remarks
141
- * - 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 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.
142
- * - This operation is not idempotent.
143
- * **Rate limit:**
144
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
177
+ * - 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).
178
+ * - This API is not idempotent.
179
+ * **Throttling:**
180
+ * This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
145
181
  *
146
182
  * @param tmpReq - AddTableRequest
147
183
  * @param headers - map
@@ -152,13 +188,13 @@ export default class Client extends OpenApi {
152
188
  [key: string]: string;
153
189
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddTableResponse>;
154
190
  /**
155
- * Adds a table to a tabular data connector.
191
+ * Add a table for the table data connector.
156
192
  *
157
193
  * @remarks
158
- * - 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 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.
159
- * - This operation is not idempotent.
160
- * **Rate limit:**
161
- * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
194
+ * - 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).
195
+ * - This API is not idempotent.
196
+ * **Throttling:**
197
+ * This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
162
198
  *
163
199
  * @param request - AddTableRequest
164
200
  * @returns AddTableResponse
@@ -237,13 +273,13 @@ export default class Client extends OpenApi {
237
273
  */
238
274
  batchUpdateFileTag(WorkspaceId: string, request: $_model.BatchUpdateFileTagRequest): Promise<$_model.BatchUpdateFileTagResponse>;
239
275
  /**
240
- * Configures the parsing method for a specific file type. For example, you can specify LLM-based document parsing for .pdf files and the Qwen VL Parser for .jpg files.
276
+ * 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.
241
277
  *
242
278
  * @remarks
243
- * - A RAM user (sub-account) must first obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:ChangeParseSetting` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (primary account) can call this operation directly without authorization. We recommend using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
279
+ * - 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).
244
280
  * - This operation is not idempotent.
245
- * **Throttling**
246
- * The system throttles frequent calls to this operation. Do not exceed a frequency of 10 requests per second. If your request is throttled, try again later.
281
+ * **Throttling:**
282
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
247
283
  *
248
284
  * @param tmpReq - ChangeParseSettingRequest
249
285
  * @param headers - map
@@ -254,13 +290,13 @@ export default class Client extends OpenApi {
254
290
  [key: string]: string;
255
291
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ChangeParseSettingResponse>;
256
292
  /**
257
- * Configures the parsing method for a specific file type. For example, you can specify LLM-based document parsing for .pdf files and the Qwen VL Parser for .jpg files.
293
+ * 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.
258
294
  *
259
295
  * @remarks
260
- * - A RAM user (sub-account) must first obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:ChangeParseSetting` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (primary account) can call this operation directly without authorization. We recommend using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
296
+ * - 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).
261
297
  * - This operation is not idempotent.
262
- * **Throttling**
263
- * The system throttles frequent calls to this operation. Do not exceed a frequency of 10 requests per second. If your request is throttled, try again later.
298
+ * **Throttling:**
299
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
264
300
  *
265
301
  * @param request - ChangeParseSettingRequest
266
302
  * @returns ChangeParseSettingResponse
@@ -285,17 +321,17 @@ export default class Client extends OpenApi {
285
321
  */
286
322
  createAndPulishAgent(workspaceId: string, request: $_model.CreateAndPulishAgentRequest): Promise<$_model.CreateAndPulishAgentResponse>;
287
323
  /**
288
- * Use this API to create two types of knowledge bases: unstructured knowledge bases for documents, audio, or video, and structured knowledge bases for data queries or image Q&A.
324
+ * Creates a knowledge base, either an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
289
325
  *
290
326
  * @remarks
291
- * - **Permissions**:
292
- * - **RAM user**: A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. You can use the `AliyunBailianDataFullAccess` policy, which includes the \\`sfm:CreateIndex\\` permission required for this operation.
293
- * - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
294
- * - **How to call**: Use the latest version of the <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation. The SDK handles the complex signature calculation logic to simplify the process.
295
- * - **What to do next**: This operation only initializes a knowledge base creation job. After calling this operation, you must call the **SubmitIndexJob** operation to complete the creation. Otherwise, an empty knowledge base is created. For related code examples, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
296
- * - **Idempotence**: This operation is not idempotent. Repeated calls may create multiple knowledge bases with the same name. To ensure idempotence, query for the knowledge base before you create it.
297
- * **Rate limiting:**
298
- * Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 10 calls per second. If you encounter rate limiting, retry the call later.
327
+ * - **Permission requirements**:
328
+ * - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio first (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 invoking this operation.
329
+ * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
330
+ * - **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 has encapsulated the complex signature calculation logic and simplifies the invocation procedure.
331
+ * - **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, refer to [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
332
+ * - **Idempotence**: This operation does not have idempotence. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent invocations by querying first and then creating.
333
+ * **Rate limit:**
334
+ * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are throttled, retry later.
299
335
  *
300
336
  * @param tmpReq - CreateIndexRequest
301
337
  * @param headers - map
@@ -306,17 +342,17 @@ export default class Client extends OpenApi {
306
342
  [key: string]: string;
307
343
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIndexResponse>;
308
344
  /**
309
- * Use this API to create two types of knowledge bases: unstructured knowledge bases for documents, audio, or video, and structured knowledge bases for data queries or image Q&A.
345
+ * Creates a knowledge base, either an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
310
346
  *
311
347
  * @remarks
312
- * - **Permissions**:
313
- * - **RAM user**: A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. You can use the `AliyunBailianDataFullAccess` policy, which includes the \\`sfm:CreateIndex\\` permission required for this operation.
314
- * - **Alibaba Cloud account**: By default, Alibaba Cloud accounts have the required permissions and can call this operation directly.
315
- * - **How to call**: Use the latest version of the <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation. The SDK handles the complex signature calculation logic to simplify the process.
316
- * - **What to do next**: This operation only initializes a knowledge base creation job. After calling this operation, you must call the **SubmitIndexJob** operation to complete the creation. Otherwise, an empty knowledge base is created. For related code examples, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
317
- * - **Idempotence**: This operation is not idempotent. Repeated calls may create multiple knowledge bases with the same name. To ensure idempotence, query for the knowledge base before you create it.
318
- * **Rate limiting:**
319
- * Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 10 calls per second. If you encounter rate limiting, retry the call later.
348
+ * - **Permission requirements**:
349
+ * - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio first (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 invoking this operation.
350
+ * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
351
+ * - **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 has encapsulated the complex signature calculation logic and simplifies the invocation procedure.
352
+ * - **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, refer to [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
353
+ * - **Idempotence**: This operation does not have idempotence. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent invocations by querying first and then creating.
354
+ * **Rate limit:**
355
+ * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are throttled, retry later.
320
356
  *
321
357
  * @param request - CreateIndexRequest
322
358
  * @returns CreateIndexResponse
@@ -731,12 +767,12 @@ export default class Client extends OpenApi {
731
767
  */
732
768
  deletePromptTemplate(workspaceId: string, promptTemplateId: string, request: $_model.DeletePromptTemplateRequest): Promise<$_model.DeletePromptTemplateResponse>;
733
769
  /**
734
- * Queries the basic information about a file in application data, including the file name, type, and status.
770
+ * Queries the basic information of a file in application data, including the file name, type, and status.
735
771
  *
736
772
  * @remarks
737
- * - 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. Invoke 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).
773
+ * - 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.
738
774
  * - This operation is idempotent.
739
- * **Rate limit:**
775
+ * **Throttling:**
740
776
  * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
741
777
  *
742
778
  * @param request - DescribeFileRequest
@@ -748,12 +784,12 @@ export default class Client extends OpenApi {
748
784
  [key: string]: string;
749
785
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFileResponse>;
750
786
  /**
751
- * Queries the basic information about a file in application data, including the file name, type, and status.
787
+ * Queries the basic information of a file in application data, including the file name, type, and status.
752
788
  *
753
789
  * @remarks
754
- * - 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. Invoke 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).
790
+ * - 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.
755
791
  * - This operation is idempotent.
756
- * **Rate limit:**
792
+ * **Throttling:**
757
793
  * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
758
794
  *
759
795
  * @param request - DescribeFileRequest
@@ -857,13 +893,13 @@ export default class Client extends OpenApi {
857
893
  */
858
894
  getConnector(WorkspaceId: string, request: $_model.GetConnectorRequest): Promise<$_model.GetConnectorResponse>;
859
895
  /**
860
- * Queries the current status of a specified knowledge base creation job or knowledge base document append job.
896
+ * Queries the current status of a specified knowledge base creation task or knowledge base document append task.
861
897
  *
862
898
  * @remarks
863
899
  * - 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.
864
- * - You must have a knowledge base job task in progress. To create a knowledge base creation task, invoke the **SubmitIndexJob** operation. To create a knowledge base document append task, invoke the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId` from the response.
900
+ * - 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`.
865
901
  * - Invoke this operation at intervals of 5 seconds or more.
866
- * - This operation is idempotent.
902
+ * - This operation supports idempotence.
867
903
  *
868
904
  * @param request - GetIndexJobStatusRequest
869
905
  * @param headers - map
@@ -874,13 +910,13 @@ export default class Client extends OpenApi {
874
910
  [key: string]: string;
875
911
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexJobStatusResponse>;
876
912
  /**
877
- * Queries the current status of a specified knowledge base creation job or knowledge base document append job.
913
+ * Queries the current status of a specified knowledge base creation task or knowledge base document append task.
878
914
  *
879
915
  * @remarks
880
916
  * - 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.
881
- * - You must have a knowledge base job task in progress. To create a knowledge base creation task, invoke the **SubmitIndexJob** operation. To create a knowledge base document append task, invoke the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId` from the response.
917
+ * - 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`.
882
918
  * - Invoke this operation at intervals of 5 seconds or more.
883
- * - This operation is idempotent.
919
+ * - This operation supports idempotence.
884
920
  *
885
921
  * @param request - GetIndexJobStatusRequest
886
922
  * @returns GetIndexJobStatusResponse
@@ -1115,7 +1151,7 @@ export default class Client extends OpenApi {
1115
1151
  *
1116
1152
  * @remarks
1117
1153
  * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), 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).
1118
- * - When performing paging for 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 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.
1154
+ * - 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.
1119
1155
  * - This operation is idempotent.
1120
1156
  * **Rate limit:**
1121
1157
  * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
@@ -1133,7 +1169,7 @@ export default class Client extends OpenApi {
1133
1169
  *
1134
1170
  * @remarks
1135
1171
  * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), 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).
1136
- * - When performing paging for 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 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.
1172
+ * - 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.
1137
1173
  * - This operation is idempotent.
1138
1174
  * **Rate limit:**
1139
1175
  * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
@@ -1143,10 +1179,10 @@ export default class Client extends OpenApi {
1143
1179
  */
1144
1180
  listFile(WorkspaceId: string, request: $_model.ListFileRequest): Promise<$_model.ListFileResponse>;
1145
1181
  /**
1146
- * Retrieves the files in a specified knowledge base along with their summary information.
1182
+ * Retrieves files and their summary information from a specified knowledge base.
1147
1183
  *
1148
1184
  * @remarks
1149
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm: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.
1185
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
1150
1186
  * - 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).
1151
1187
  * - This operation has idempotence.
1152
1188
  * **Throttling:**
@@ -1161,10 +1197,10 @@ export default class Client extends OpenApi {
1161
1197
  [key: string]: string;
1162
1198
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexDocumentsResponse>;
1163
1199
  /**
1164
- * Retrieves the files in a specified knowledge base along with their summary information.
1200
+ * Retrieves files and their summary information from a specified knowledge base.
1165
1201
  *
1166
1202
  * @remarks
1167
- * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm: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.
1203
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
1168
1204
  * - 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).
1169
1205
  * - This operation has idempotence.
1170
1206
  * **Throttling:**
@@ -1175,11 +1211,11 @@ export default class Client extends OpenApi {
1175
1211
  */
1176
1212
  listIndexDocuments(WorkspaceId: string, request: $_model.ListIndexDocumentsRequest): Promise<$_model.ListIndexDocumentsResponse>;
1177
1213
  /**
1178
- * Retrieves the details of one or more documents in a specified knowledge base.
1214
+ * Retrieves the files in a specified knowledge base along with their details.
1179
1215
  *
1180
1216
  * @remarks
1181
- * - A RAM user must have the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio to call this operation. The `AliyunBailianDataFullAccess` permission, which includes the \\`sfm:ListIndexFiles\\` permission, is required. An Alibaba Cloud account can call this operation without authorization. You can call this operation using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
1182
- * - Before you call this operation, ensure that your knowledge base exists and its ID, `IndexId`, is valid.
1217
+ * - 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), 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.
1218
+ * - Before calling this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
1183
1219
  * - This operation is idempotent.
1184
1220
  *
1185
1221
  * @param request - ListIndexFileDetailsRequest
@@ -1191,11 +1227,11 @@ export default class Client extends OpenApi {
1191
1227
  [key: string]: string;
1192
1228
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexFileDetailsResponse>;
1193
1229
  /**
1194
- * Retrieves the details of one or more documents in a specified knowledge base.
1230
+ * Retrieves the files in a specified knowledge base along with their details.
1195
1231
  *
1196
1232
  * @remarks
1197
- * - A RAM user must have the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio to call this operation. The `AliyunBailianDataFullAccess` permission, which includes the \\`sfm:ListIndexFiles\\` permission, is required. An Alibaba Cloud account can call this operation without authorization. You can call this operation using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
1198
- * - Before you call this operation, ensure that your knowledge base exists and its ID, `IndexId`, is valid.
1233
+ * - 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), 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.
1234
+ * - Before calling this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
1199
1235
  * - This operation is idempotent.
1200
1236
  *
1201
1237
  * @param request - ListIndexFileDetailsRequest