@alicloud/bailian20231229 2.13.1 → 2.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/dist/client.d.ts +106 -68
  2. package/dist/client.js +141 -68
  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/DescribeFileResponseBody.d.ts +33 -26
  37. package/dist/models/DescribeFileResponseBody.js.map +1 -1
  38. package/dist/models/GetIndexJobStatusRequest.d.ts +1 -1
  39. package/dist/models/GetIndexJobStatusResponseBody.d.ts +15 -13
  40. package/dist/models/GetIndexJobStatusResponseBody.js.map +1 -1
  41. package/dist/models/ListFileRequest.d.ts +2 -2
  42. package/dist/models/ListFileResponseBody.d.ts +8 -1
  43. package/dist/models/ListFileResponseBody.js.map +1 -1
  44. package/dist/models/ListFileShrinkRequest.d.ts +2 -2
  45. package/dist/models/ListIndexDocumentsRequest.d.ts +11 -9
  46. package/dist/models/ListIndexDocumentsRequest.js.map +1 -1
  47. package/dist/models/ListIndexDocumentsResponseBody.d.ts +13 -15
  48. package/dist/models/ListIndexDocumentsResponseBody.js.map +1 -1
  49. package/dist/models/ListIndexFileDetailsRequest.d.ts +15 -17
  50. package/dist/models/ListIndexFileDetailsRequest.js.map +1 -1
  51. package/dist/models/ListIndexFileDetailsResponseBody.d.ts +26 -30
  52. package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
  53. package/dist/models/model.d.ts +4 -0
  54. package/dist/models/model.js +13 -5
  55. package/dist/models/model.js.map +1 -1
  56. package/package.json +1 -1
  57. package/src/client.ts +147 -68
  58. package/src/models/AddChunkRequest.ts +71 -0
  59. package/src/models/AddChunkResponse.ts +40 -0
  60. package/src/models/AddChunkResponseBody.ts +84 -0
  61. package/src/models/AddChunkShrinkRequest.ts +68 -0
  62. package/src/models/AddFileRequest.ts +27 -39
  63. package/src/models/AddFileResponseBody.ts +8 -11
  64. package/src/models/AddFileShrinkRequest.ts +26 -38
  65. package/src/models/AddFilesFromAuthorizedOssRequest.ts +29 -29
  66. package/src/models/AddFilesFromAuthorizedOssResponseBody.ts +14 -14
  67. package/src/models/AddFilesFromAuthorizedOssShrinkRequest.ts +10 -10
  68. package/src/models/AddTableRequest.ts +7 -0
  69. package/src/models/AddTableResponseBody.ts +6 -6
  70. package/src/models/AddTableShrinkRequest.ts +7 -0
  71. package/src/models/ChangeParseSettingRequest.ts +10 -28
  72. package/src/models/ChangeParseSettingResponseBody.ts +8 -12
  73. package/src/models/ChangeParseSettingShrinkRequest.ts +9 -27
  74. package/src/models/DescribeFileResponseBody.ts +33 -26
  75. package/src/models/GetIndexJobStatusRequest.ts +1 -1
  76. package/src/models/GetIndexJobStatusResponseBody.ts +15 -13
  77. package/src/models/ListFileRequest.ts +2 -2
  78. package/src/models/ListFileResponseBody.ts +8 -1
  79. package/src/models/ListFileShrinkRequest.ts +2 -2
  80. package/src/models/ListIndexDocumentsRequest.ts +11 -9
  81. package/src/models/ListIndexDocumentsResponseBody.ts +13 -15
  82. package/src/models/ListIndexFileDetailsRequest.ts +15 -17
  83. package/src/models/ListIndexFileDetailsResponseBody.ts +26 -30
  84. package/src/models/model.ts +4 -0
package/dist/client.d.ts CHANGED
@@ -38,6 +38,42 @@ 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. Operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
46
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
47
+ * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
48
+ * - This operation has idempotence.
49
+ * **Related operations:**
50
+ * **Throttling:**
51
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
52
+ *
53
+ * @param tmpReq - AddChunkRequest
54
+ * @param headers - map
55
+ * @param runtime - runtime options for this request RuntimeOptions
56
+ * @returns AddChunkResponse
57
+ */
58
+ addChunkWithOptions(WorkspaceId: string, tmpReq: $_model.AddChunkRequest, headers: {
59
+ [key: string]: string;
60
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.AddChunkResponse>;
61
+ /**
62
+ * Adds chunks to a document search (document), data query (table), or image Q&A (image) knowledge base.
63
+ *
64
+ * @remarks
65
+ * - This operation adds chunk content to a specified knowledge base of the document search (document), data query (table), or image Q&A (image) type. Operations on multimedia search (multimedia) knowledge bases are not supported. For data query and image Q&A knowledge bases, this operation takes effect only when the data source is a spreadsheet connector (excel).
66
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:ChunkList permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest [Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
67
+ * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
68
+ * - This operation has idempotence.
69
+ * **Related operations:**
70
+ * **Throttling:**
71
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
72
+ *
73
+ * @param request - AddChunkRequest
74
+ * @returns AddChunkResponse
75
+ */
76
+ addChunk(WorkspaceId: string, request: $_model.AddChunkRequest): Promise<$_model.AddChunkResponse>;
41
77
  /**
42
78
  * Creates a connector. This API currently supports only file connectors.
43
79
  *
@@ -69,12 +105,13 @@ export default class Client extends OpenApi {
69
105
  */
70
106
  addConnector(WorkspaceId: string, request: $_model.AddConnectorRequest): Promise<$_model.AddConnectorResponse>;
71
107
  /**
72
- * Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
108
+ * Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
73
109
  *
74
110
  * @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.
111
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
112
+ * - This operation is not idempotent.
113
+ * **Throttling:**
114
+ * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
78
115
  *
79
116
  * @param tmpReq - AddFileRequest
80
117
  * @param headers - map
@@ -85,29 +122,30 @@ export default class Client extends OpenApi {
85
122
  [key: string]: string;
86
123
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddFileResponse>;
87
124
  /**
88
- * Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
125
+ * Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
89
126
  *
90
127
  * @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.
128
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
129
+ * - This operation is not idempotent.
130
+ * **Throttling:**
131
+ * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
94
132
  *
95
133
  * @param request - AddFileRequest
96
134
  * @returns AddFileResponse
97
135
  */
98
136
  addFile(WorkspaceId: string, request: $_model.AddFileRequest): Promise<$_model.AddFileResponse>;
99
137
  /**
100
- * Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
138
+ * Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
101
139
  *
102
140
  * @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).
141
+ * - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
104
142
  *
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.
143
+ * - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
144
+ * - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
145
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
146
+ * - This operation does not have idempotence.
147
+ * **Rate limit:**
148
+ * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
111
149
  *
112
150
  * @param tmpReq - AddFilesFromAuthorizedOssRequest
113
151
  * @param headers - map
@@ -118,30 +156,30 @@ export default class Client extends OpenApi {
118
156
  [key: string]: string;
119
157
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
120
158
  /**
121
- * Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
159
+ * Imports files from an authorized OSS bucket into Alibaba Cloud Model Studio application data.
122
160
  *
123
161
  * @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).
162
+ * - Make sure the OSS bucket belongs to the same Alibaba Cloud account as Model Studio and that authorization has been completed as described in [Importing data from OSS configuration instructions](https://help.aliyun.com/document_detail/2782155.html).
125
163
  *
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.
164
+ * - Supported bucket storage types do not include Archive, Cold Archive, or Deep Cold Archive. Buckets with content encryption enabled are supported. Buckets with public read/write, public read, or private access are supported.
165
+ * - To use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html) enabled, add the domain name `*.console.aliyun.com` to the Referer whitelist as described in [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
166
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (the `AliyunBailianDataFullAccess` permission is required, which includes the sfm:AddFilesFromAuthorizedOss permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Call this operation by using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
167
+ * - This operation does not have idempotence.
168
+ * **Rate limit:**
169
+ * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
132
170
  *
133
171
  * @param request - AddFilesFromAuthorizedOssRequest
134
172
  * @returns AddFilesFromAuthorizedOssResponse
135
173
  */
136
174
  addFilesFromAuthorizedOss(WorkspaceId: string, request: $_model.AddFilesFromAuthorizedOssRequest): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
137
175
  /**
138
- * Adds a table to a tabular data connector.
176
+ * Add a table for the table data connector.
139
177
  *
140
178
  * @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.
179
+ * - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
180
+ * - This API is not idempotent.
181
+ * **Throttling:**
182
+ * This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
145
183
  *
146
184
  * @param tmpReq - AddTableRequest
147
185
  * @param headers - map
@@ -152,13 +190,13 @@ export default class Client extends OpenApi {
152
190
  [key: string]: string;
153
191
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddTableResponse>;
154
192
  /**
155
- * Adds a table to a tabular data connector.
193
+ * Add a table for the table data connector.
156
194
  *
157
195
  * @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.
196
+ * - RAM users (sub-accounts) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Chinese China Bailian (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddTable permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can call this API directly without authorization. We recommend that you call this API by using the latest <props="china">[Chinese China Bailian SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Chinese China Bailian SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
197
+ * - This API is not idempotent.
198
+ * **Throttling:**
199
+ * This API is subject to throttling when called frequently. Do not exceed 10 calls per second. If throttling is triggered, retry later.
162
200
  *
163
201
  * @param request - AddTableRequest
164
202
  * @returns AddTableResponse
@@ -237,13 +275,13 @@ export default class Client extends OpenApi {
237
275
  */
238
276
  batchUpdateFileTag(WorkspaceId: string, request: $_model.BatchUpdateFileTagRequest): Promise<$_model.BatchUpdateFileTagResponse>;
239
277
  /**
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.
278
+ * Configures the parsing method for specific file types. For example, specifies large model document parsing for .pdf files or Qwen VL parsing for .jpg files.
241
279
  *
242
280
  * @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.
281
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
244
282
  * - 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.
283
+ * **Throttling:**
284
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
247
285
  *
248
286
  * @param tmpReq - ChangeParseSettingRequest
249
287
  * @param headers - map
@@ -254,13 +292,13 @@ export default class Client extends OpenApi {
254
292
  [key: string]: string;
255
293
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ChangeParseSettingResponse>;
256
294
  /**
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.
295
+ * Configures the parsing method for specific file types. For example, specifies large model document parsing for .pdf files or Qwen VL parsing for .jpg files.
258
296
  *
259
297
  * @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.
298
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ChangeParseSetting permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
261
299
  * - 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.
300
+ * **Throttling:**
301
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
264
302
  *
265
303
  * @param request - ChangeParseSettingRequest
266
304
  * @returns ChangeParseSettingResponse
@@ -731,12 +769,12 @@ export default class Client extends OpenApi {
731
769
  */
732
770
  deletePromptTemplate(workspaceId: string, promptTemplateId: string, request: $_model.DeletePromptTemplateRequest): Promise<$_model.DeletePromptTemplateResponse>;
733
771
  /**
734
- * Queries the basic information about a file in application data, including the file name, type, and status.
772
+ * Queries the basic information of a file in application data, including the file name, type, and status.
735
773
  *
736
774
  * @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).
775
+ * - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
738
776
  * - This operation is idempotent.
739
- * **Rate limit:**
777
+ * **Throttling:**
740
778
  * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
741
779
  *
742
780
  * @param request - DescribeFileRequest
@@ -748,12 +786,12 @@ export default class Client extends OpenApi {
748
786
  [key: string]: string;
749
787
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFileResponse>;
750
788
  /**
751
- * Queries the basic information about a file in application data, including the file name, type, and status.
789
+ * Queries the basic information of a file in application data, including the file name, type, and status.
752
790
  *
753
791
  * @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).
792
+ * - A Resource Access Management (RAM) user must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:DescribeFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. An Alibaba Cloud account can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
755
793
  * - This operation is idempotent.
756
- * **Rate limit:**
794
+ * **Throttling:**
757
795
  * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
758
796
  *
759
797
  * @param request - DescribeFileRequest
@@ -857,13 +895,13 @@ export default class Client extends OpenApi {
857
895
  */
858
896
  getConnector(WorkspaceId: string, request: $_model.GetConnectorRequest): Promise<$_model.GetConnectorResponse>;
859
897
  /**
860
- * Queries the current status of a specified knowledge base creation job or knowledge base document append job.
898
+ * Queries the current status of a specified knowledge base creation task or knowledge base document append task.
861
899
  *
862
900
  * @remarks
863
901
  * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
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.
902
+ * - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
865
903
  * - Invoke this operation at intervals of 5 seconds or more.
866
- * - This operation is idempotent.
904
+ * - This operation supports idempotence.
867
905
  *
868
906
  * @param request - GetIndexJobStatusRequest
869
907
  * @param headers - map
@@ -874,13 +912,13 @@ export default class Client extends OpenApi {
874
912
  [key: string]: string;
875
913
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexJobStatusResponse>;
876
914
  /**
877
- * Queries the current status of a specified knowledge base creation job or knowledge base document append job.
915
+ * Queries the current status of a specified knowledge base creation task or knowledge base document append task.
878
916
  *
879
917
  * @remarks
880
918
  * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` or `AliyunBailianDataReadOnlyAccess`, both of which include the sfm:GetIndexJobStatus permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
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.
919
+ * - You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the **SubmitIndexJob** operation, or create a knowledge base document append task by invoking the **SubmitIndexAddDocumentsJob** operation. Obtain the corresponding `JobId`.
882
920
  * - Invoke this operation at intervals of 5 seconds or more.
883
- * - This operation is idempotent.
921
+ * - This operation supports idempotence.
884
922
  *
885
923
  * @param request - GetIndexJobStatusRequest
886
924
  * @returns GetIndexJobStatusResponse
@@ -1115,7 +1153,7 @@ export default class Client extends OpenApi {
1115
1153
  *
1116
1154
  * @remarks
1117
1155
  * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
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.
1156
+ * - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
1119
1157
  * - This operation is idempotent.
1120
1158
  * **Rate limit:**
1121
1159
  * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
@@ -1133,7 +1171,7 @@ export default class Client extends OpenApi {
1133
1171
  *
1134
1172
  * @remarks
1135
1173
  * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
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.
1174
+ * - For paging on the first page, only set `MaxResults` to limit the number of entries returned. The `NextToken` in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response (if `NextToken` is empty, all results have been returned and no further requests are needed), and set `MaxResults` to limit the number of entries returned.
1137
1175
  * - This operation is idempotent.
1138
1176
  * **Rate limit:**
1139
1177
  * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
@@ -1143,10 +1181,10 @@ export default class Client extends OpenApi {
1143
1181
  */
1144
1182
  listFile(WorkspaceId: string, request: $_model.ListFileRequest): Promise<$_model.ListFileResponse>;
1145
1183
  /**
1146
- * Retrieves the files in a specified knowledge base along with their summary information.
1184
+ * Retrieves files and their summary information from a specified knowledge base.
1147
1185
  *
1148
1186
  * @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.
1187
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
1150
1188
  * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
1151
1189
  * - This operation has idempotence.
1152
1190
  * **Throttling:**
@@ -1161,10 +1199,10 @@ export default class Client extends OpenApi {
1161
1199
  [key: string]: string;
1162
1200
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexDocumentsResponse>;
1163
1201
  /**
1164
- * Retrieves the files in a specified knowledge base along with their summary information.
1202
+ * Retrieves files and their summary information from a specified knowledge base.
1165
1203
  *
1166
1204
  * @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.
1205
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
1168
1206
  * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
1169
1207
  * - This operation has idempotence.
1170
1208
  * **Throttling:**
@@ -1175,12 +1213,12 @@ export default class Client extends OpenApi {
1175
1213
  */
1176
1214
  listIndexDocuments(WorkspaceId: string, request: $_model.ListIndexDocumentsRequest): Promise<$_model.ListIndexDocumentsResponse>;
1177
1215
  /**
1178
- * Retrieves the details of one or more documents in a specified knowledge base.
1216
+ * Retrieves the files in a specified knowledge base along with their details.
1179
1217
  *
1180
1218
  * @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.
1183
- * - This operation is idempotent.
1219
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
1220
+ * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
1221
+ * - This operation has idempotence.
1184
1222
  *
1185
1223
  * @param request - ListIndexFileDetailsRequest
1186
1224
  * @param headers - map
@@ -1191,12 +1229,12 @@ export default class Client extends OpenApi {
1191
1229
  [key: string]: string;
1192
1230
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexFileDetailsResponse>;
1193
1231
  /**
1194
- * Retrieves the details of one or more documents in a specified knowledge base.
1232
+ * Retrieves the files in a specified knowledge base along with their details.
1195
1233
  *
1196
1234
  * @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.
1199
- * - This operation is idempotent.
1235
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (`AliyunBailianDataFullAccess` is required, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
1236
+ * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
1237
+ * - This operation has idempotence.
1200
1238
  *
1201
1239
  * @param request - ListIndexFileDetailsRequest
1202
1240
  * @returns ListIndexFileDetailsResponse