@alicloud/bailian20231229 2.12.0 → 2.13.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 (333) hide show
  1. package/dist/client.d.ts +626 -242
  2. package/dist/client.js +663 -243
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddCategoryRequest.d.ts +20 -1
  5. package/dist/models/AddCategoryRequest.js.map +1 -1
  6. package/dist/models/AddCategoryResponseBody.d.ts +33 -3
  7. package/dist/models/AddCategoryResponseBody.js.map +1 -1
  8. package/dist/models/AddConnectorRequest.d.ts +22 -0
  9. package/dist/models/AddConnectorRequest.js.map +1 -1
  10. package/dist/models/AddConnectorResponseBody.d.ts +24 -1
  11. package/dist/models/AddConnectorResponseBody.js.map +1 -1
  12. package/dist/models/AddConnectorShrinkRequest.d.ts +13 -0
  13. package/dist/models/AddConnectorShrinkRequest.js.map +1 -1
  14. package/dist/models/AddFileRequest.d.ts +80 -13
  15. package/dist/models/AddFileRequest.js.map +1 -1
  16. package/dist/models/AddFileResponseBody.d.ts +11 -10
  17. package/dist/models/AddFileResponseBody.js.map +1 -1
  18. package/dist/models/AddFileShrinkRequest.d.ts +70 -12
  19. package/dist/models/AddFileShrinkRequest.js.map +1 -1
  20. package/dist/models/AddFilesFromAuthorizedOssRequest.d.ts +70 -1
  21. package/dist/models/AddFilesFromAuthorizedOssRequest.js.map +1 -1
  22. package/dist/models/AddFilesFromAuthorizedOssResponseBody.d.ts +42 -2
  23. package/dist/models/AddFilesFromAuthorizedOssResponseBody.js.map +1 -1
  24. package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.d.ts +28 -0
  25. package/dist/models/AddFilesFromAuthorizedOssShrinkRequest.js.map +1 -1
  26. package/dist/models/AddTableRequest.d.ts +14 -0
  27. package/dist/models/AddTableRequest.js +2 -0
  28. package/dist/models/AddTableRequest.js.map +1 -1
  29. package/dist/models/AddTableResponseBody.d.ts +22 -0
  30. package/dist/models/AddTableResponseBody.js.map +1 -1
  31. package/dist/models/AddTableShrinkRequest.d.ts +7 -0
  32. package/dist/models/AddTableShrinkRequest.js +2 -0
  33. package/dist/models/AddTableShrinkRequest.js.map +1 -1
  34. package/dist/models/ApplyFileUploadLeaseRequest.d.ts +57 -3
  35. package/dist/models/ApplyFileUploadLeaseRequest.js.map +1 -1
  36. package/dist/models/ApplyFileUploadLeaseResponseBody.d.ts +22 -20
  37. package/dist/models/ApplyFileUploadLeaseResponseBody.js.map +1 -1
  38. package/dist/models/BatchUpdateFileTagRequest.d.ts +9 -0
  39. package/dist/models/BatchUpdateFileTagRequest.js.map +1 -1
  40. package/dist/models/BatchUpdateFileTagResponseBody.d.ts +41 -1
  41. package/dist/models/BatchUpdateFileTagResponseBody.js.map +1 -1
  42. package/dist/models/BatchUpdateFileTagShrinkRequest.d.ts +5 -0
  43. package/dist/models/BatchUpdateFileTagShrinkRequest.js.map +1 -1
  44. package/dist/models/ChangeParseSettingRequest.d.ts +48 -14
  45. package/dist/models/ChangeParseSettingRequest.js.map +1 -1
  46. package/dist/models/ChangeParseSettingResponseBody.d.ts +12 -7
  47. package/dist/models/ChangeParseSettingResponseBody.js.map +1 -1
  48. package/dist/models/ChangeParseSettingShrinkRequest.d.ts +41 -8
  49. package/dist/models/ChangeParseSettingShrinkRequest.js.map +1 -1
  50. package/dist/models/CreateIndexRequest.d.ts +340 -86
  51. package/dist/models/CreateIndexRequest.js.map +1 -1
  52. package/dist/models/CreateIndexResponseBody.d.ts +14 -19
  53. package/dist/models/CreateIndexResponseBody.js.map +1 -1
  54. package/dist/models/CreateIndexShrinkRequest.d.ts +261 -55
  55. package/dist/models/CreateIndexShrinkRequest.js.map +1 -1
  56. package/dist/models/CreateMemoryNodeRequest.d.ts +5 -0
  57. package/dist/models/CreateMemoryNodeRequest.js.map +1 -1
  58. package/dist/models/CreateMemoryNodeResponseBody.d.ts +8 -2
  59. package/dist/models/CreateMemoryNodeResponseBody.js.map +1 -1
  60. package/dist/models/CreateMemoryRequest.d.ts +7 -0
  61. package/dist/models/CreateMemoryRequest.js.map +1 -1
  62. package/dist/models/CreateMemoryResponseBody.d.ts +10 -2
  63. package/dist/models/CreateMemoryResponseBody.js.map +1 -1
  64. package/dist/models/CreatePromptTemplateRequest.d.ts +10 -0
  65. package/dist/models/CreatePromptTemplateRequest.js.map +1 -1
  66. package/dist/models/CreatePromptTemplateResponseBody.d.ts +6 -0
  67. package/dist/models/CreatePromptTemplateResponseBody.js.map +1 -1
  68. package/dist/models/DeleteCategoryResponseBody.d.ts +20 -3
  69. package/dist/models/DeleteCategoryResponseBody.js.map +1 -1
  70. package/dist/models/DeleteChunkRequest.d.ts +2 -2
  71. package/dist/models/DeleteChunkResponseBody.d.ts +6 -12
  72. package/dist/models/DeleteChunkResponseBody.js.map +1 -1
  73. package/dist/models/DeleteChunkShrinkRequest.d.ts +2 -2
  74. package/dist/models/DeleteConnectorResponseBody.d.ts +0 -3
  75. package/dist/models/DeleteConnectorResponseBody.js.map +1 -1
  76. package/dist/models/DeleteFileResponseBody.d.ts +24 -1
  77. package/dist/models/DeleteFileResponseBody.js.map +1 -1
  78. package/dist/models/DeleteFilesRequest.d.ts +20 -0
  79. package/dist/models/DeleteFilesRequest.js +61 -0
  80. package/dist/models/DeleteFilesRequest.js.map +1 -0
  81. package/dist/models/DeleteFilesResponse.d.ts +19 -0
  82. package/dist/models/DeleteFilesResponse.js +69 -0
  83. package/dist/models/DeleteFilesResponse.js.map +1 -0
  84. package/dist/models/DeleteFilesResponseBody.d.ts +109 -0
  85. package/dist/models/DeleteFilesResponseBody.js +114 -0
  86. package/dist/models/DeleteFilesResponseBody.js.map +1 -0
  87. package/dist/models/DeleteFilesShrinkRequest.d.ts +20 -0
  88. package/dist/models/DeleteFilesShrinkRequest.js +58 -0
  89. package/dist/models/DeleteFilesShrinkRequest.js.map +1 -0
  90. package/dist/models/DeleteIndexDocumentRequest.d.ts +3 -3
  91. package/dist/models/DeleteIndexDocumentResponseBody.d.ts +7 -8
  92. package/dist/models/DeleteIndexDocumentResponseBody.js.map +1 -1
  93. package/dist/models/DeleteIndexDocumentShrinkRequest.d.ts +3 -3
  94. package/dist/models/DeleteIndexRequest.d.ts +2 -2
  95. package/dist/models/DeleteIndexResponseBody.d.ts +5 -6
  96. package/dist/models/DeleteIndexResponseBody.js.map +1 -1
  97. package/dist/models/DeleteMemoryNodeResponseBody.d.ts +3 -0
  98. package/dist/models/DeleteMemoryNodeResponseBody.js.map +1 -1
  99. package/dist/models/DeleteMemoryResponseBody.d.ts +4 -1
  100. package/dist/models/DeleteMemoryResponseBody.js.map +1 -1
  101. package/dist/models/DescribeFileResponseBody.d.ts +58 -26
  102. package/dist/models/DescribeFileResponseBody.js +2 -0
  103. package/dist/models/DescribeFileResponseBody.js.map +1 -1
  104. package/dist/models/GetAlipayTransferStatusRequest.d.ts +6 -0
  105. package/dist/models/GetAlipayTransferStatusRequest.js.map +1 -1
  106. package/dist/models/GetAlipayTransferStatusResponseBody.d.ts +90 -0
  107. package/dist/models/GetAlipayTransferStatusResponseBody.js.map +1 -1
  108. package/dist/models/GetAlipayUrlRequest.d.ts +14 -0
  109. package/dist/models/GetAlipayUrlRequest.js.map +1 -1
  110. package/dist/models/GetAlipayUrlResponseBody.d.ts +17 -0
  111. package/dist/models/GetAlipayUrlResponseBody.js.map +1 -1
  112. package/dist/models/GetAvailableParserTypesResponseBody.d.ts +3 -0
  113. package/dist/models/GetAvailableParserTypesResponseBody.js.map +1 -1
  114. package/dist/models/GetConnectorRequest.d.ts +11 -1
  115. package/dist/models/GetConnectorRequest.js.map +1 -1
  116. package/dist/models/GetConnectorResponseBody.d.ts +33 -1
  117. package/dist/models/GetConnectorResponseBody.js.map +1 -1
  118. package/dist/models/GetIndexJobStatusRequest.d.ts +5 -5
  119. package/dist/models/GetIndexJobStatusResponseBody.d.ts +26 -26
  120. package/dist/models/GetIndexJobStatusResponseBody.js.map +1 -1
  121. package/dist/models/GetIndexMonitorRequest.d.ts +6 -0
  122. package/dist/models/GetIndexMonitorRequest.js.map +1 -1
  123. package/dist/models/GetIndexMonitorResponseBody.d.ts +77 -1
  124. package/dist/models/GetIndexMonitorResponseBody.js.map +1 -1
  125. package/dist/models/GetMemoryNodeResponseBody.d.ts +19 -0
  126. package/dist/models/GetMemoryNodeResponseBody.js.map +1 -1
  127. package/dist/models/GetMemoryResponseBody.d.ts +19 -3
  128. package/dist/models/GetMemoryResponseBody.js.map +1 -1
  129. package/dist/models/GetParseSettingsResponseBody.d.ts +6 -8
  130. package/dist/models/GetParseSettingsResponseBody.js.map +1 -1
  131. package/dist/models/GetPromptTemplateResponseBody.d.ts +6 -0
  132. package/dist/models/GetPromptTemplateResponseBody.js.map +1 -1
  133. package/dist/models/HighCodeDeployResponseBody.d.ts +1 -1
  134. package/dist/models/ListCategoryRequest.d.ts +36 -1
  135. package/dist/models/ListCategoryRequest.js.map +1 -1
  136. package/dist/models/ListCategoryResponseBody.d.ts +70 -3
  137. package/dist/models/ListCategoryResponseBody.js.map +1 -1
  138. package/dist/models/ListChunksRequest.d.ts +39 -7
  139. package/dist/models/ListChunksRequest.js.map +1 -1
  140. package/dist/models/ListChunksResponseBody.d.ts +58 -15
  141. package/dist/models/ListChunksResponseBody.js.map +1 -1
  142. package/dist/models/ListFileRequest.d.ts +32 -2
  143. package/dist/models/ListFileRequest.js.map +1 -1
  144. package/dist/models/ListFileResponseBody.d.ts +69 -10
  145. package/dist/models/ListFileResponseBody.js +2 -0
  146. package/dist/models/ListFileResponseBody.js.map +1 -1
  147. package/dist/models/ListFileShrinkRequest.d.ts +32 -2
  148. package/dist/models/ListFileShrinkRequest.js.map +1 -1
  149. package/dist/models/ListIndexDocumentsRequest.d.ts +26 -12
  150. package/dist/models/ListIndexDocumentsRequest.js.map +1 -1
  151. package/dist/models/ListIndexDocumentsResponseBody.d.ts +53 -30
  152. package/dist/models/ListIndexDocumentsResponseBody.js.map +1 -1
  153. package/dist/models/ListIndexFileDetailsRequest.d.ts +38 -0
  154. package/dist/models/ListIndexFileDetailsRequest.js.map +1 -1
  155. package/dist/models/ListIndexFileDetailsResponseBody.d.ts +93 -3
  156. package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
  157. package/dist/models/ListIndicesRequest.d.ts +5 -4
  158. package/dist/models/ListIndicesRequest.js.map +1 -1
  159. package/dist/models/ListIndicesResponseBody.d.ts +93 -51
  160. package/dist/models/ListIndicesResponseBody.js.map +1 -1
  161. package/dist/models/ListMemoriesRequest.d.ts +9 -1
  162. package/dist/models/ListMemoriesRequest.js.map +1 -1
  163. package/dist/models/ListMemoriesResponseBody.d.ts +33 -4
  164. package/dist/models/ListMemoriesResponseBody.js.map +1 -1
  165. package/dist/models/ListMemoryNodesRequest.d.ts +6 -0
  166. package/dist/models/ListMemoryNodesRequest.js.map +1 -1
  167. package/dist/models/ListMemoryNodesResponseBody.d.ts +26 -0
  168. package/dist/models/ListMemoryNodesResponseBody.js.map +1 -1
  169. package/dist/models/ListPromptTemplatesRequest.d.ts +3 -0
  170. package/dist/models/ListPromptTemplatesRequest.js.map +1 -1
  171. package/dist/models/ListPromptTemplatesResponseBody.d.ts +6 -0
  172. package/dist/models/ListPromptTemplatesResponseBody.js.map +1 -1
  173. package/dist/models/RetrieveRequest.d.ts +143 -29
  174. package/dist/models/RetrieveRequest.js.map +1 -1
  175. package/dist/models/RetrieveResponseBody.d.ts +52 -10
  176. package/dist/models/RetrieveResponseBody.js.map +1 -1
  177. package/dist/models/RetrieveShrinkRequest.d.ts +43 -23
  178. package/dist/models/RetrieveShrinkRequest.js.map +1 -1
  179. package/dist/models/SubmitIndexAddDocumentsJobRequest.d.ts +114 -8
  180. package/dist/models/SubmitIndexAddDocumentsJobRequest.js.map +1 -1
  181. package/dist/models/SubmitIndexAddDocumentsJobResponseBody.d.ts +10 -9
  182. package/dist/models/SubmitIndexAddDocumentsJobResponseBody.js.map +1 -1
  183. package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.d.ts +114 -8
  184. package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.js.map +1 -1
  185. package/dist/models/SubmitIndexJobRequest.d.ts +2 -2
  186. package/dist/models/SubmitIndexJobResponseBody.d.ts +13 -14
  187. package/dist/models/SubmitIndexJobResponseBody.js.map +1 -1
  188. package/dist/models/UpdateChunkRequest.d.ts +14 -8
  189. package/dist/models/UpdateChunkRequest.js.map +1 -1
  190. package/dist/models/UpdateChunkResponseBody.d.ts +7 -13
  191. package/dist/models/UpdateChunkResponseBody.js.map +1 -1
  192. package/dist/models/UpdateConnectorRequest.d.ts +4 -0
  193. package/dist/models/UpdateConnectorRequest.js.map +1 -1
  194. package/dist/models/UpdateConnectorResponseBody.d.ts +20 -1
  195. package/dist/models/UpdateConnectorResponseBody.js.map +1 -1
  196. package/dist/models/UpdateFileTagRequest.d.ts +2 -0
  197. package/dist/models/UpdateFileTagRequest.js.map +1 -1
  198. package/dist/models/UpdateFileTagResponseBody.d.ts +24 -1
  199. package/dist/models/UpdateFileTagResponseBody.js.map +1 -1
  200. package/dist/models/UpdateFileTagShrinkRequest.d.ts +2 -0
  201. package/dist/models/UpdateFileTagShrinkRequest.js.map +1 -1
  202. package/dist/models/UpdateIndexRequest.d.ts +44 -0
  203. package/dist/models/UpdateIndexRequest.js.map +1 -1
  204. package/dist/models/UpdateIndexResponseBody.d.ts +26 -0
  205. package/dist/models/UpdateIndexResponseBody.js.map +1 -1
  206. package/dist/models/UpdateMemoryNodeRequest.d.ts +5 -0
  207. package/dist/models/UpdateMemoryNodeRequest.js.map +1 -1
  208. package/dist/models/UpdateMemoryNodeResponseBody.d.ts +3 -0
  209. package/dist/models/UpdateMemoryNodeResponseBody.js.map +1 -1
  210. package/dist/models/UpdateMemoryRequest.d.ts +7 -0
  211. package/dist/models/UpdateMemoryRequest.js.map +1 -1
  212. package/dist/models/UpdateMemoryResponseBody.d.ts +4 -1
  213. package/dist/models/UpdateMemoryResponseBody.js.map +1 -1
  214. package/dist/models/UpdatePromptTemplateRequest.d.ts +6 -0
  215. package/dist/models/UpdatePromptTemplateRequest.js.map +1 -1
  216. package/dist/models/UpdateTableFromAuthorizedOssRequest.d.ts +8 -0
  217. package/dist/models/UpdateTableFromAuthorizedOssRequest.js.map +1 -1
  218. package/dist/models/UpdateTableFromAuthorizedOssResponseBody.d.ts +23 -1
  219. package/dist/models/UpdateTableFromAuthorizedOssResponseBody.js.map +1 -1
  220. package/dist/models/model.d.ts +6 -0
  221. package/dist/models/model.js +19 -7
  222. package/dist/models/model.js.map +1 -1
  223. package/package.json +1 -1
  224. package/src/client.ts +668 -243
  225. package/src/models/AddCategoryRequest.ts +20 -1
  226. package/src/models/AddCategoryResponseBody.ts +33 -3
  227. package/src/models/AddConnectorRequest.ts +22 -0
  228. package/src/models/AddConnectorResponseBody.ts +24 -1
  229. package/src/models/AddConnectorShrinkRequest.ts +13 -0
  230. package/src/models/AddFileRequest.ts +80 -13
  231. package/src/models/AddFileResponseBody.ts +11 -10
  232. package/src/models/AddFileShrinkRequest.ts +70 -12
  233. package/src/models/AddFilesFromAuthorizedOssRequest.ts +70 -1
  234. package/src/models/AddFilesFromAuthorizedOssResponseBody.ts +42 -2
  235. package/src/models/AddFilesFromAuthorizedOssShrinkRequest.ts +28 -0
  236. package/src/models/AddTableRequest.ts +16 -0
  237. package/src/models/AddTableResponseBody.ts +22 -0
  238. package/src/models/AddTableShrinkRequest.ts +9 -0
  239. package/src/models/ApplyFileUploadLeaseRequest.ts +57 -3
  240. package/src/models/ApplyFileUploadLeaseResponseBody.ts +22 -20
  241. package/src/models/BatchUpdateFileTagRequest.ts +9 -0
  242. package/src/models/BatchUpdateFileTagResponseBody.ts +41 -1
  243. package/src/models/BatchUpdateFileTagShrinkRequest.ts +5 -0
  244. package/src/models/ChangeParseSettingRequest.ts +48 -14
  245. package/src/models/ChangeParseSettingResponseBody.ts +12 -7
  246. package/src/models/ChangeParseSettingShrinkRequest.ts +41 -8
  247. package/src/models/CreateIndexRequest.ts +340 -86
  248. package/src/models/CreateIndexResponseBody.ts +14 -19
  249. package/src/models/CreateIndexShrinkRequest.ts +261 -55
  250. package/src/models/CreateMemoryNodeRequest.ts +5 -0
  251. package/src/models/CreateMemoryNodeResponseBody.ts +8 -2
  252. package/src/models/CreateMemoryRequest.ts +7 -0
  253. package/src/models/CreateMemoryResponseBody.ts +10 -2
  254. package/src/models/CreatePromptTemplateRequest.ts +10 -0
  255. package/src/models/CreatePromptTemplateResponseBody.ts +6 -0
  256. package/src/models/DeleteCategoryResponseBody.ts +20 -3
  257. package/src/models/DeleteChunkRequest.ts +2 -2
  258. package/src/models/DeleteChunkResponseBody.ts +6 -12
  259. package/src/models/DeleteChunkShrinkRequest.ts +2 -2
  260. package/src/models/DeleteConnectorResponseBody.ts +0 -3
  261. package/src/models/DeleteFileResponseBody.ts +24 -1
  262. package/src/models/DeleteFilesRequest.ts +36 -0
  263. package/src/models/DeleteFilesResponse.ts +40 -0
  264. package/src/models/DeleteFilesResponseBody.ts +160 -0
  265. package/src/models/DeleteFilesShrinkRequest.ts +33 -0
  266. package/src/models/DeleteIndexDocumentRequest.ts +3 -3
  267. package/src/models/DeleteIndexDocumentResponseBody.ts +7 -8
  268. package/src/models/DeleteIndexDocumentShrinkRequest.ts +3 -3
  269. package/src/models/DeleteIndexRequest.ts +2 -2
  270. package/src/models/DeleteIndexResponseBody.ts +5 -6
  271. package/src/models/DeleteMemoryNodeResponseBody.ts +3 -0
  272. package/src/models/DeleteMemoryResponseBody.ts +4 -1
  273. package/src/models/DescribeFileResponseBody.ts +60 -26
  274. package/src/models/GetAlipayTransferStatusRequest.ts +6 -0
  275. package/src/models/GetAlipayTransferStatusResponseBody.ts +90 -0
  276. package/src/models/GetAlipayUrlRequest.ts +14 -0
  277. package/src/models/GetAlipayUrlResponseBody.ts +17 -0
  278. package/src/models/GetAvailableParserTypesResponseBody.ts +3 -0
  279. package/src/models/GetConnectorRequest.ts +11 -1
  280. package/src/models/GetConnectorResponseBody.ts +33 -1
  281. package/src/models/GetIndexJobStatusRequest.ts +5 -5
  282. package/src/models/GetIndexJobStatusResponseBody.ts +26 -26
  283. package/src/models/GetIndexMonitorRequest.ts +6 -0
  284. package/src/models/GetIndexMonitorResponseBody.ts +77 -1
  285. package/src/models/GetMemoryNodeResponseBody.ts +19 -0
  286. package/src/models/GetMemoryResponseBody.ts +19 -3
  287. package/src/models/GetParseSettingsResponseBody.ts +6 -8
  288. package/src/models/GetPromptTemplateResponseBody.ts +6 -0
  289. package/src/models/HighCodeDeployResponseBody.ts +1 -1
  290. package/src/models/ListCategoryRequest.ts +36 -1
  291. package/src/models/ListCategoryResponseBody.ts +70 -3
  292. package/src/models/ListChunksRequest.ts +39 -7
  293. package/src/models/ListChunksResponseBody.ts +58 -15
  294. package/src/models/ListFileRequest.ts +32 -2
  295. package/src/models/ListFileResponseBody.ts +71 -10
  296. package/src/models/ListFileShrinkRequest.ts +32 -2
  297. package/src/models/ListIndexDocumentsRequest.ts +26 -12
  298. package/src/models/ListIndexDocumentsResponseBody.ts +53 -30
  299. package/src/models/ListIndexFileDetailsRequest.ts +38 -0
  300. package/src/models/ListIndexFileDetailsResponseBody.ts +93 -3
  301. package/src/models/ListIndicesRequest.ts +5 -4
  302. package/src/models/ListIndicesResponseBody.ts +93 -51
  303. package/src/models/ListMemoriesRequest.ts +9 -1
  304. package/src/models/ListMemoriesResponseBody.ts +33 -4
  305. package/src/models/ListMemoryNodesRequest.ts +6 -0
  306. package/src/models/ListMemoryNodesResponseBody.ts +26 -0
  307. package/src/models/ListPromptTemplatesRequest.ts +3 -0
  308. package/src/models/ListPromptTemplatesResponseBody.ts +6 -0
  309. package/src/models/RetrieveRequest.ts +143 -29
  310. package/src/models/RetrieveResponseBody.ts +52 -10
  311. package/src/models/RetrieveShrinkRequest.ts +43 -23
  312. package/src/models/SubmitIndexAddDocumentsJobRequest.ts +114 -8
  313. package/src/models/SubmitIndexAddDocumentsJobResponseBody.ts +10 -9
  314. package/src/models/SubmitIndexAddDocumentsJobShrinkRequest.ts +114 -8
  315. package/src/models/SubmitIndexJobRequest.ts +2 -2
  316. package/src/models/SubmitIndexJobResponseBody.ts +13 -14
  317. package/src/models/UpdateChunkRequest.ts +14 -8
  318. package/src/models/UpdateChunkResponseBody.ts +7 -13
  319. package/src/models/UpdateConnectorRequest.ts +4 -0
  320. package/src/models/UpdateConnectorResponseBody.ts +20 -1
  321. package/src/models/UpdateFileTagRequest.ts +2 -0
  322. package/src/models/UpdateFileTagResponseBody.ts +24 -1
  323. package/src/models/UpdateFileTagShrinkRequest.ts +2 -0
  324. package/src/models/UpdateIndexRequest.ts +44 -0
  325. package/src/models/UpdateIndexResponseBody.ts +26 -0
  326. package/src/models/UpdateMemoryNodeRequest.ts +5 -0
  327. package/src/models/UpdateMemoryNodeResponseBody.ts +3 -0
  328. package/src/models/UpdateMemoryRequest.ts +7 -0
  329. package/src/models/UpdateMemoryResponseBody.ts +4 -1
  330. package/src/models/UpdatePromptTemplateRequest.ts +6 -0
  331. package/src/models/UpdateTableFromAuthorizedOssRequest.ts +8 -0
  332. package/src/models/UpdateTableFromAuthorizedOssResponseBody.ts +23 -1
  333. package/src/models/model.ts +6 -0
package/dist/client.d.ts CHANGED
@@ -9,14 +9,13 @@ export default class Client extends OpenApi {
9
9
  [key: string]: string;
10
10
  }, endpoint: string): string;
11
11
  /**
12
- * Creates a category in the specified workspace to categorize and manage documents. You can create up to 1,000 categories in each workspace.
12
+ * Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
13
13
  *
14
14
  * @remarks
15
- * You cannot use API to create structured table. To create a table, go to [Data Management](https://bailian.console.alibabacloud.com/#/data-center) in the console. You can associate a knowledge base with ApsaraDB for RDS to automatically update structured knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
16
- * * If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:AddCategory) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
17
- * * You can create up to 1,000 categories in each workspace.
18
- * * This interface is not idempotent.
19
- * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
15
+ * - You cannot use an API to add data tables. To add data tables, go to the [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) page in the console.
16
+ * - A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The `AliyunBailianDataFullAccess` permission, which includes the `sfm:AddCategory` permission, is required. An Alibaba Cloud account can call this operation directly without requiring authorization. To call this operation, use the latest version of the [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
17
+ * - This operation is not idempotent.
18
+ * **Rate limiting:** Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 5 calls per second. If rate limiting is triggered, try again later.
20
19
  *
21
20
  * @param request - AddCategoryRequest
22
21
  * @param headers - map
@@ -27,21 +26,26 @@ export default class Client extends OpenApi {
27
26
  [key: string]: string;
28
27
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddCategoryResponse>;
29
28
  /**
30
- * Creates a category in the specified workspace to categorize and manage documents. You can create up to 1,000 categories in each workspace.
29
+ * Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.
31
30
  *
32
31
  * @remarks
33
- * You cannot use API to create structured table. To create a table, go to [Data Management](https://bailian.console.alibabacloud.com/#/data-center) in the console. You can associate a knowledge base with ApsaraDB for RDS to automatically update structured knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
34
- * * If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:AddCategory) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
35
- * * You can create up to 1,000 categories in each workspace.
36
- * * This interface is not idempotent.
37
- * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
32
+ * - You cannot use an API to add data tables. To add data tables, go to the [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) page in the console.
33
+ * - A RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The `AliyunBailianDataFullAccess` permission, which includes the `sfm:AddCategory` permission, is required. An Alibaba Cloud account can call this operation directly without requiring authorization. To call this operation, use the latest version of the [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
34
+ * - This operation is not idempotent.
35
+ * **Rate limiting:** Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 5 calls per second. If rate limiting is triggered, try again later.
38
36
  *
39
37
  * @param request - AddCategoryRequest
40
38
  * @returns AddCategoryResponse
41
39
  */
42
40
  addCategory(WorkspaceId: string, request: $_model.AddCategoryRequest): Promise<$_model.AddCategoryResponse>;
43
41
  /**
44
- * 创建连接器
42
+ * Creates a connector. This API currently supports only file connectors.
43
+ *
44
+ * @remarks
45
+ * - To call this operation, a RAM user (sub-account) must first have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and be a member of a [business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:AddCategory permission. A primary account can call this operation directly without authorization. We recommend using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
46
+ * - This operation is not idempotent.
47
+ * **Throttling:**
48
+ * Do not call this operation more than 5 times per second. If a request is throttled, try again later.
45
49
  *
46
50
  * @param tmpReq - AddConnectorRequest
47
51
  * @param headers - map
@@ -52,21 +56,25 @@ export default class Client extends OpenApi {
52
56
  [key: string]: string;
53
57
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddConnectorResponse>;
54
58
  /**
55
- * 创建连接器
59
+ * Creates a connector. This API currently supports only file connectors.
60
+ *
61
+ * @remarks
62
+ * - To call this operation, a RAM user (sub-account) must first have the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and be a member of a [business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:AddCategory permission. A primary account can call this operation directly without authorization. We recommend using the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
63
+ * - This operation is not idempotent.
64
+ * **Throttling:**
65
+ * Do not call this operation more than 5 times per second. If a request is throttled, try again later.
56
66
  *
57
67
  * @param request - AddConnectorRequest
58
68
  * @returns AddConnectorResponse
59
69
  */
60
70
  addConnector(WorkspaceId: string, request: $_model.AddConnectorRequest): Promise<$_model.AddConnectorResponse>;
61
71
  /**
62
- * Imports an unstructured document stored in the temporary storage space to Data Management. You cannot use the API to import structured documents. Use the console instead.
72
+ * Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
63
73
  *
64
74
  * @remarks
65
- * Before you call this operation, make sure that you have obtained the lease and uploaded the document to the temporary storage space by using the [ApplyFileUploadLease](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. For more information, see [Upload files by calling API](https://www.alibabacloud.com/help/en/model-studio/developer-reference/upload-files-by-calling-api).
66
- * > After you call this operation, the used lease ID expires immediately. Do not use the same lease ID to submit new requests.
67
- * * You must call this operation within 12 hours after you call the [ApplyFileUploadLease](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. Otherwise, the lease expires and the request fails.
68
- * * After you call this operation, the system parses and imports your document. The process takes some time.
69
- * * This interface is not idempotent.
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.
70
78
  *
71
79
  * @param tmpReq - AddFileRequest
72
80
  * @param headers - map
@@ -77,21 +85,29 @@ export default class Client extends OpenApi {
77
85
  [key: string]: string;
78
86
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddFileResponse>;
79
87
  /**
80
- * Imports an unstructured document stored in the temporary storage space to Data Management. You cannot use the API to import structured documents. Use the console instead.
88
+ * Imports a file from the temporary storage space of Alibaba Cloud Model Studio into a data connection (formerly known as application data).
81
89
  *
82
90
  * @remarks
83
- * Before you call this operation, make sure that you have obtained the lease and uploaded the document to the temporary storage space by using the [ApplyFileUploadLease](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. For more information, see [Upload files by calling API](https://www.alibabacloud.com/help/en/model-studio/developer-reference/upload-files-by-calling-api).
84
- * > After you call this operation, the used lease ID expires immediately. Do not use the same lease ID to submit new requests.
85
- * * You must call this operation within 12 hours after you call the [ApplyFileUploadLease](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. Otherwise, the lease expires and the request fails.
86
- * * After you call this operation, the system parses and imports your document. The process takes some time.
87
- * * This interface is not idempotent.
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.
88
94
  *
89
95
  * @param request - AddFileRequest
90
96
  * @returns AddFileResponse
91
97
  */
92
98
  addFile(WorkspaceId: string, request: $_model.AddFileRequest): Promise<$_model.AddFileResponse>;
93
99
  /**
94
- * 将已授权OSS Bucket中的文件添加到百炼应用数据
100
+ * Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
101
+ *
102
+ * @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).
104
+ *
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.
95
111
  *
96
112
  * @param tmpReq - AddFilesFromAuthorizedOssRequest
97
113
  * @param headers - map
@@ -102,14 +118,30 @@ export default class Client extends OpenApi {
102
118
  [key: string]: string;
103
119
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
104
120
  /**
105
- * 将已授权OSS Bucket中的文件添加到百炼应用数据
121
+ * Imports files from an authorized OSS Bucket into Alibaba Cloud Model Studio (Bailian) application data.
122
+ *
123
+ * @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).
125
+ *
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.
106
132
  *
107
133
  * @param request - AddFilesFromAuthorizedOssRequest
108
134
  * @returns AddFilesFromAuthorizedOssResponse
109
135
  */
110
136
  addFilesFromAuthorizedOss(WorkspaceId: string, request: $_model.AddFilesFromAuthorizedOssRequest): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
111
137
  /**
112
- * 添加表格
138
+ * Adds a table to a tabular data connector.
139
+ *
140
+ * @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.
113
145
  *
114
146
  * @param tmpReq - AddTableRequest
115
147
  * @param headers - map
@@ -120,20 +152,26 @@ export default class Client extends OpenApi {
120
152
  [key: string]: string;
121
153
  }, runtime: $dara.RuntimeOptions): Promise<$_model.AddTableResponse>;
122
154
  /**
123
- * 添加表格
155
+ * Adds a table to a tabular data connector.
156
+ *
157
+ * @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.
124
162
  *
125
163
  * @param request - AddTableRequest
126
164
  * @returns AddTableResponse
127
165
  */
128
166
  addTable(WorkspaceId: string, request: $_model.AddTableRequest): Promise<$_model.AddTableResponse>;
129
167
  /**
130
- * Applies for a document upload lease to upload a document. You cannot use the API to upload structured documents. Use the console instead.
168
+ * Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
131
169
  *
132
170
  * @remarks
133
- * This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
134
- * * The HTTP URL returned by this operation is valid only for minutes. Upload the document before the URL expires.
135
- * * After you apply for a lease and upload a document, the document is stored in a temporary storage space for 12 hours.
136
- * * This interface is not idempotent.
171
+ * - RAM users (sub-accounts) must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ApplyFileUploadLease permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can directly call this API without authorization. We recommend that you call this API by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
172
+ * - This API is not idempotent.
173
+ * **Throttling:**
174
+ * This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
137
175
  *
138
176
  * @param request - ApplyFileUploadLeaseRequest
139
177
  * @param headers - map
@@ -144,13 +182,13 @@ export default class Client extends OpenApi {
144
182
  [key: string]: string;
145
183
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ApplyFileUploadLeaseResponse>;
146
184
  /**
147
- * Applies for a document upload lease to upload a document. You cannot use the API to upload structured documents. Use the console instead.
185
+ * Request an upload lease for uploading knowledge base files or files for agent application conversational interactions.
148
186
  *
149
187
  * @remarks
150
- * This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
151
- * * The HTTP URL returned by this operation is valid only for minutes. Upload the document before the URL expires.
152
- * * After you apply for a lease and upload a document, the document is stored in a temporary storage space for 12 hours.
153
- * * This interface is not idempotent.
188
+ * - RAM users (sub-accounts) must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ApplyFileUploadLease permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this API. Alibaba Cloud accounts (primary accounts) can directly call this API without authorization. We recommend that you call this API by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
189
+ * - This API is not idempotent.
190
+ * **Throttling:**
191
+ * This API is subject to throttling if called too frequently. The frequency must not exceed 10 calls per second. If throttled, please retry later.
154
192
  *
155
193
  * @param request - ApplyFileUploadLeaseRequest
156
194
  * @returns ApplyFileUploadLeaseResponse
@@ -181,7 +219,7 @@ export default class Client extends OpenApi {
181
219
  */
182
220
  applyTempStorageLease(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest): Promise<$_model.ApplyTempStorageLeaseResponse>;
183
221
  /**
184
- * 批量更新文档Tag
222
+ * This operation updates document tags in a data connection in batches.
185
223
  *
186
224
  * @param tmpReq - BatchUpdateFileTagRequest
187
225
  * @param headers - map
@@ -192,14 +230,20 @@ export default class Client extends OpenApi {
192
230
  [key: string]: string;
193
231
  }, runtime: $dara.RuntimeOptions): Promise<$_model.BatchUpdateFileTagResponse>;
194
232
  /**
195
- * 批量更新文档Tag
233
+ * This operation updates document tags in a data connection in batches.
196
234
  *
197
235
  * @param request - BatchUpdateFileTagRequest
198
236
  * @returns BatchUpdateFileTagResponse
199
237
  */
200
238
  batchUpdateFileTag(WorkspaceId: string, request: $_model.BatchUpdateFileTagRequest): Promise<$_model.BatchUpdateFileTagResponse>;
201
239
  /**
202
- * Configure the parsing method for a specific file type. For example, use LLM parsing for .pdf files, or use Qwen VL parsing for .jpg files.
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.
241
+ *
242
+ * @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.
244
+ * - 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.
203
247
  *
204
248
  * @param tmpReq - ChangeParseSettingRequest
205
249
  * @param headers - map
@@ -210,7 +254,13 @@ export default class Client extends OpenApi {
210
254
  [key: string]: string;
211
255
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ChangeParseSettingResponse>;
212
256
  /**
213
- * Configure the parsing method for a specific file type. For example, use LLM parsing for .pdf files, or use Qwen VL parsing for .jpg files.
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.
258
+ *
259
+ * @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.
261
+ * - 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.
214
264
  *
215
265
  * @param request - ChangeParseSettingRequest
216
266
  * @returns ChangeParseSettingResponse
@@ -235,17 +285,17 @@ export default class Client extends OpenApi {
235
285
  */
236
286
  createAndPulishAgent(workspaceId: string, request: $_model.CreateAndPulishAgentRequest): Promise<$_model.CreateAndPulishAgentResponse>;
237
287
  /**
238
- * Create a knowledge base of the document search type.
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.
239
289
  *
240
290
  * @remarks
241
- * **Limits**: This operation can create only knowledge base of the document search type. Data query and image Q\\&A types are not supported. Use the console instead.
242
- * * **Required permissions**
243
- * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
244
- * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
245
- * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
246
- * * **What to do next**: This operation only initializes knowledge base creation job. After that, call **SubmitIndexJob** to complete the creation. Otherwise, you will get an empty knowledge base. For more information about the sample code, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
247
- * * **Idempotence**: This operation is not idempotent. If you call the operation for multiple times, you may create several knowledge bases with the same name. We recommend following a "query first, then create" logic.
248
- * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
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.
249
299
  *
250
300
  * @param tmpReq - CreateIndexRequest
251
301
  * @param headers - map
@@ -256,24 +306,31 @@ export default class Client extends OpenApi {
256
306
  [key: string]: string;
257
307
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIndexResponse>;
258
308
  /**
259
- * Create a knowledge base of the document search type.
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.
260
310
  *
261
311
  * @remarks
262
- * **Limits**: This operation can create only knowledge base of the document search type. Data query and image Q\\&A types are not supported. Use the console instead.
263
- * * **Required permissions**
264
- * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
265
- * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
266
- * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
267
- * * **What to do next**: This operation only initializes knowledge base creation job. After that, call **SubmitIndexJob** to complete the creation. Otherwise, you will get an empty knowledge base. For more information about the sample code, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
268
- * * **Idempotence**: This operation is not idempotent. If you call the operation for multiple times, you may create several knowledge bases with the same name. We recommend following a "query first, then create" logic.
269
- * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
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.
270
320
  *
271
321
  * @param request - CreateIndexRequest
272
322
  * @returns CreateIndexResponse
273
323
  */
274
324
  createIndex(WorkspaceId: string, request: $_model.CreateIndexRequest): Promise<$_model.CreateIndexResponse>;
275
325
  /**
276
- * 创建Memory
326
+ * Creates a long-term memory.
327
+ *
328
+ * @remarks
329
+ * - You can store specific information from conversations (memory nodes. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory)) in a long-term memory. Agent applications can then reference this information in subsequent conversations. This is not an automatic creation procedure. You must first invoke the [CreateMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememory) operation to create a long-term memory and obtain the `memoryId`. Then pass the `memoryId` when you [invoke the agent application through the API](https://www.alibabacloud.com/help/en/model-studio/user-guide/application-calling).
330
+ * > Long-term memory does not support storing and managing user profiles through the API. Perform related operations in the console. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory#578ebae524m6l).
331
+ * - If you pass a `memoryId`, the system uses automatic creation to generate memory nodes (MemoryNode) under the specified long-term memory based on conversation records. You can also invoke the [CreateMemoryNode](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememorynode) operation to manually create memory nodes.
332
+ * - This operation does not support idempotence.
333
+ * **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
277
334
  *
278
335
  * @param request - CreateMemoryRequest
279
336
  * @param headers - map
@@ -284,14 +341,21 @@ export default class Client extends OpenApi {
284
341
  [key: string]: string;
285
342
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMemoryResponse>;
286
343
  /**
287
- * 创建Memory
344
+ * Creates a long-term memory.
345
+ *
346
+ * @remarks
347
+ * - You can store specific information from conversations (memory nodes. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory)) in a long-term memory. Agent applications can then reference this information in subsequent conversations. This is not an automatic creation procedure. You must first invoke the [CreateMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememory) operation to create a long-term memory and obtain the `memoryId`. Then pass the `memoryId` when you [invoke the agent application through the API](https://www.alibabacloud.com/help/en/model-studio/user-guide/application-calling).
348
+ * > Long-term memory does not support storing and managing user profiles through the API. Perform related operations in the console. For more information, see [Long-term memory](https://www.alibabacloud.com/help/en/model-studio/user-guide/long-term-memory#578ebae524m6l).
349
+ * - If you pass a `memoryId`, the system uses automatic creation to generate memory nodes (MemoryNode) under the specified long-term memory based on conversation records. You can also invoke the [CreateMemoryNode](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-creatememorynode) operation to manually create memory nodes.
350
+ * - This operation does not support idempotence.
351
+ * **Throttling:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
288
352
  *
289
353
  * @param request - CreateMemoryRequest
290
354
  * @returns CreateMemoryResponse
291
355
  */
292
356
  createMemory(workspaceId: string, request: $_model.CreateMemoryRequest): Promise<$_model.CreateMemoryResponse>;
293
357
  /**
294
- * 创建记忆Node
358
+ * Creates a memory node.
295
359
  *
296
360
  * @param request - CreateMemoryNodeRequest
297
361
  * @param headers - map
@@ -302,14 +366,17 @@ export default class Client extends OpenApi {
302
366
  [key: string]: string;
303
367
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMemoryNodeResponse>;
304
368
  /**
305
- * 创建记忆Node
369
+ * Creates a memory node.
306
370
  *
307
371
  * @param request - CreateMemoryNodeRequest
308
372
  * @returns CreateMemoryNodeResponse
309
373
  */
310
374
  createMemoryNode(workspaceId: string, memoryId: string, request: $_model.CreateMemoryNodeRequest): Promise<$_model.CreateMemoryNodeResponse>;
311
375
  /**
312
- * Creates a prompt template.
376
+ * Create a prompt template.
377
+ *
378
+ * @remarks
379
+ * This API does not currently support the creation of text-to-image prompt templates.
313
380
  *
314
381
  * @param request - CreatePromptTemplateRequest
315
382
  * @param headers - map
@@ -320,7 +387,10 @@ export default class Client extends OpenApi {
320
387
  [key: string]: string;
321
388
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePromptTemplateResponse>;
322
389
  /**
323
- * Creates a prompt template.
390
+ * Create a prompt template.
391
+ *
392
+ * @remarks
393
+ * This API does not currently support the creation of text-to-image prompt templates.
324
394
  *
325
395
  * @param request - CreatePromptTemplateRequest
326
396
  * @returns CreatePromptTemplateResponse
@@ -345,7 +415,13 @@ export default class Client extends OpenApi {
345
415
  */
346
416
  deleteAgent(workspaceId: string, appCode: string, request: $_model.DeleteAgentRequest): Promise<$_model.DeleteAgentResponse>;
347
417
  /**
348
- * Deletes a specified category permanently.
418
+ * Permanently deletes a specified category.
419
+ *
420
+ * @remarks
421
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
422
+ * - This operation is idempotent.
423
+ * **Rate limiting:**
424
+ * This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
349
425
  *
350
426
  * @param request - DeleteCategoryRequest
351
427
  * @param headers - map
@@ -356,25 +432,31 @@ export default class Client extends OpenApi {
356
432
  [key: string]: string;
357
433
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCategoryResponse>;
358
434
  /**
359
- * Deletes a specified category permanently.
435
+ * Permanently deletes a specified category.
436
+ *
437
+ * @remarks
438
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:DeleteCategory permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
439
+ * - This operation is idempotent.
440
+ * **Rate limiting:**
441
+ * This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry later.
360
442
  *
361
443
  * @param request - DeleteCategoryRequest
362
444
  * @returns DeleteCategoryResponse
363
445
  */
364
446
  deleteCategory(CategoryId: string, WorkspaceId: string, request: $_model.DeleteCategoryRequest): Promise<$_model.DeleteCategoryResponse>;
365
447
  /**
366
- * Deletes a specified text chunk from a knowledge base. The deleted chunk cannot be retrieved or recalled.
448
+ * Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
367
449
  *
368
450
  * @remarks
369
- * *
370
- * **Warning** After a text chunk is deleted, it cannot be restored. Proceed with caution.
371
- * * **Required permissions**:
372
- * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
373
- * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
374
- * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
375
- * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
376
- * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been deleted, the interface returns a success.
377
- * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
451
+ * <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
452
+ * - **Permission requirements**:
453
+ * - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
454
+ * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
455
+ * - **Invocation method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
456
+ * - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
457
+ * - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
458
+ * **Rate limit:**
459
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
378
460
  *
379
461
  * @param tmpReq - DeleteChunkRequest
380
462
  * @param headers - map
@@ -385,18 +467,18 @@ export default class Client extends OpenApi {
385
467
  [key: string]: string;
386
468
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteChunkResponse>;
387
469
  /**
388
- * Deletes a specified text chunk from a knowledge base. The deleted chunk cannot be retrieved or recalled.
470
+ * Deletes specified text chunks from a knowledge base. Deleted text chunks cannot be retrieved or recalled.
389
471
  *
390
472
  * @remarks
391
- * *
392
- * **Warning** After a text chunk is deleted, it cannot be restored. Proceed with caution.
393
- * * **Required permissions**:
394
- * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
395
- * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
396
- * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
397
- * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
398
- * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been deleted, the interface returns a success.
399
- * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
473
+ * <warning> Deleted text chunks cannot be recovered (hard delete). Proceed with caution.
474
+ * - **Permission requirements**:
475
+ * - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
476
+ * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
477
+ * - **Invocation method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
478
+ * - **Effective latency**: Changes typically take effect immediately. During peak hours, there may be a slight delay (seconds).
479
+ * - **Idempotence**: This operation is idempotent. Repeated calls to delete an already deleted text chunk return a success response.
480
+ * **Rate limit:**
481
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
400
482
  *
401
483
  * @param request - DeleteChunkRequest
402
484
  * @returns DeleteChunkResponse
@@ -405,6 +487,12 @@ export default class Client extends OpenApi {
405
487
  /**
406
488
  * 删除连接器
407
489
  *
490
+ * @remarks
491
+ * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(需要`AliyunBailianDataFullAccess`,已包括sfm:DeleteConnector权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
492
+ * - 本接口不具备幂等性。
493
+ * **限流说明:**
494
+ * 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
495
+ *
408
496
  * @param request - DeleteConnectorRequest
409
497
  * @param headers - map
410
498
  * @param runtime - runtime options for this request RuntimeOptions
@@ -416,12 +504,27 @@ export default class Client extends OpenApi {
416
504
  /**
417
505
  * 删除连接器
418
506
  *
507
+ * @remarks
508
+ * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(需要`AliyunBailianDataFullAccess`,已包括sfm:DeleteConnector权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
509
+ * - 本接口不具备幂等性。
510
+ * **限流说明:**
511
+ * 本接口频繁调用会被限流,频率请勿超过5次/秒。如遇限流,请稍后重试。
512
+ *
419
513
  * @param request - DeleteConnectorRequest
420
514
  * @returns DeleteConnectorResponse
421
515
  */
422
516
  deleteConnector(ConnectorId: string, WorkspaceId: string, request: $_model.DeleteConnectorRequest): Promise<$_model.DeleteConnectorResponse>;
423
517
  /**
424
- * Deletes a specified unstructured document permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
518
+ * Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
519
+ *
520
+ * @remarks
521
+ * - Deleting data tables via API is not supported. To delete a data table or specific data within a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) to perform the operation.
522
+ * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) and does not affect any knowledge bases that have already been built. To delete a file from a knowledge base, invoke the **DeleteIndexDocument** API.
523
+ * - A RAM user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the `sfm:DeleteFile` permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this API. An Alibaba Cloud account can invoke this API directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this API.
524
+ * - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
525
+ * - This API is idempotent.
526
+ * **Rate Limiting Notice:**
527
+ * Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
425
528
  *
426
529
  * @param request - DeleteFileRequest
427
530
  * @param headers - map
@@ -432,21 +535,69 @@ export default class Client extends OpenApi {
432
535
  [key: string]: string;
433
536
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFileResponse>;
434
537
  /**
435
- * Deletes a specified unstructured document permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
538
+ * Permanently delete a specified file from application data. Deleting data tables via API is not supported. For details, see the API Guide below.
539
+ *
540
+ * @remarks
541
+ * - Deleting data tables via API is not supported. To delete a data table or specific data within a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) to perform the operation.
542
+ * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) and does not affect any knowledge bases that have already been built. To delete a file from a knowledge base, invoke the **DeleteIndexDocument** API.
543
+ * - A RAM user must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the `sfm:DeleteFile` permission point) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this API. An Alibaba Cloud account can invoke this API directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this API.
544
+ * - This API can only delete files whose status is either Failed to Parse (`PARSE_FAILED`) or Parse Succeeded (`PARSE_SUCCESS`).
545
+ * - This API is idempotent.
546
+ * **Rate Limiting Notice:**
547
+ * Frequent invocation of this API will trigger rate limiting. Do not exceed 10 requests per second. If rate limited, retry after a short wait.
436
548
  *
437
549
  * @param request - DeleteFileRequest
438
550
  * @returns DeleteFileResponse
439
551
  */
440
552
  deleteFile(FileId: string, WorkspaceId: string, request: $_model.DeleteFileRequest): Promise<$_model.DeleteFileResponse>;
441
553
  /**
442
- * Deletes a specified knowledge base permanently.
554
+ * Delete files in batch
555
+ *
556
+ * @remarks
557
+ * - Deleting data tables through the API is not supported. To delete a data table or specific data in a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
558
+ * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). It does not affect knowledge bases that have already been built. To delete files in a knowledge base, call the **DeleteIndexDocument** operation.
559
+ * - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which already includes the sfm:DeleteFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
560
+ * - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
561
+ * - This operation is idempotent.
562
+ * **Throttling:**
563
+ * Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
564
+ *
565
+ * @param tmpReq - DeleteFilesRequest
566
+ * @param headers - map
567
+ * @param runtime - runtime options for this request RuntimeOptions
568
+ * @returns DeleteFilesResponse
569
+ */
570
+ deleteFilesWithOptions(WorkspaceId: string, tmpReq: $_model.DeleteFilesRequest, headers: {
571
+ [key: string]: string;
572
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFilesResponse>;
573
+ /**
574
+ * Delete files in batch
443
575
  *
444
576
  * @remarks
445
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
446
- * * If a knowledge base is being called by an application, disassociate the knowledge base before you can delete it. To disassociate the knowledge base, you must use the console. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base).
447
- * * After you delete a knowledge base, it cannot be recovered. We recommend that you proceed with caution.
448
- * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
449
- * * This interface is idempotent.
577
+ * - Deleting data tables through the API is not supported. To delete a data table or specific data in a table, go to <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
578
+ * - This API is used to delete files in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). It does not affect knowledge bases that have already been built. To delete files in a knowledge base, call the **DeleteIndexDocument** operation.
579
+ * - A RAM user (sub-account) must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which already includes the sfm:DeleteFiles permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. The Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
580
+ * - This operation can only delete files whose status is parsing failed (PARSE_FAILED) or parsing succeeded (PARSE_SUCCESS).
581
+ * - This operation is idempotent.
582
+ * **Throttling:**
583
+ * Frequent calls to this operation are throttled. Do not exceed 10 queries per second (QPS). If you are throttled, try again later.
584
+ *
585
+ * @param request - DeleteFilesRequest
586
+ * @returns DeleteFilesResponse
587
+ */
588
+ deleteFiles(WorkspaceId: string, request: $_model.DeleteFilesRequest): Promise<$_model.DeleteFilesResponse>;
589
+ /**
590
+ * Permanently deletes a specified knowledge base.
591
+ *
592
+ * @remarks
593
+ * - 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:DeleteIndex 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.
594
+ * - 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).
595
+ * - If the knowledge base is associated with an application, you must first dissociate it from the application before deleting it. This can currently only be done through the console. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
596
+ * - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
597
+ * - Invoking this operation does not delete files that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
598
+ * - This operation has idempotence.
599
+ * **Rate limit:**
600
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
450
601
  *
451
602
  * @param request - DeleteIndexRequest
452
603
  * @param headers - map
@@ -457,28 +608,35 @@ export default class Client extends OpenApi {
457
608
  [key: string]: string;
458
609
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIndexResponse>;
459
610
  /**
460
- * Deletes a specified knowledge base permanently.
611
+ * Permanently deletes a specified knowledge base.
461
612
  *
462
613
  * @remarks
463
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
464
- * * If a knowledge base is being called by an application, disassociate the knowledge base before you can delete it. To disassociate the knowledge base, you must use the console. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base).
465
- * * After you delete a knowledge base, it cannot be recovered. We recommend that you proceed with caution.
466
- * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
467
- * * This interface is idempotent.
614
+ * - 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:DeleteIndex 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.
615
+ * - 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).
616
+ * - If the knowledge base is associated with an application, you must first dissociate it from the application before deleting it. This can currently only be done through the console. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
617
+ * - Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
618
+ * - Invoking this operation does not delete files that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
619
+ * - This operation has idempotence.
620
+ * **Rate limit:**
621
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
468
622
  *
469
623
  * @param request - DeleteIndexRequest
470
624
  * @returns DeleteIndexResponse
471
625
  */
472
626
  deleteIndex(WorkspaceId: string, request: $_model.DeleteIndexRequest): Promise<$_model.DeleteIndexResponse>;
473
627
  /**
474
- * Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
628
+ * Permanently deletes files from a specified knowledge base.
475
629
  *
476
630
  * @remarks
477
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
478
- * * Only documents with the INSERT_ERROR and FINISH states can be deleted. To query the status of documents in a specified knowledge base, call the [ListIndexDocuments](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-listindexdocuments) operation.
479
- * * After you delete a document, it cannot be recovered and the [Retrieve](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-retrieve) operation cannot query information about the document. We recommend that you proceed with caution.
480
- * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
481
- * * This interface is idempotent.
631
+ * - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
632
+ * - 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:DeleteIndexDocument permission), before calling this operation. Alibaba Cloud accounts can call 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 call this operation.
633
+ * - 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).
634
+ * - You can only delete files whose status is import failed (INSERT_ERROR) or import succeeded (FINISH) in the knowledge base. To query the file status in a specified knowledge base, call the **ListIndexDocuments** operation.
635
+ * - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
636
+ * - Calling this operation does not delete documents that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
637
+ * - This operation is idempotent.
638
+ * **Throttling:**
639
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
482
640
  *
483
641
  * @param tmpReq - DeleteIndexDocumentRequest
484
642
  * @param headers - map
@@ -489,21 +647,31 @@ export default class Client extends OpenApi {
489
647
  [key: string]: string;
490
648
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIndexDocumentResponse>;
491
649
  /**
492
- * Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
650
+ * Permanently deletes files from a specified knowledge base.
493
651
  *
494
652
  * @remarks
495
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
496
- * * Only documents with the INSERT_ERROR and FINISH states can be deleted. To query the status of documents in a specified knowledge base, call the [ListIndexDocuments](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-listindexdocuments) operation.
497
- * * After you delete a document, it cannot be recovered and the [Retrieve](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-retrieve) operation cannot query information about the document. We recommend that you proceed with caution.
498
- * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
499
- * * This interface is idempotent.
653
+ * - This operation does not support deleting data from data query or image Q&A knowledge bases. Use the Model Studio console instead.
654
+ * - 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:DeleteIndexDocument permission), before calling this operation. Alibaba Cloud accounts can call 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 call this operation.
655
+ * - 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).
656
+ * - You can only delete files whose status is import failed (INSERT_ERROR) or import succeeded (FINISH) in the knowledge base. To query the file status in a specified knowledge base, call the **ListIndexDocuments** operation.
657
+ * - Deletion is irreversible. The content of deleted files cannot be recovered, and the **Retrieve** operation can no longer retrieve related information. Proceed with caution.
658
+ * - Calling this operation does not delete documents that have been imported into <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center).
659
+ * - This operation is idempotent.
660
+ * **Throttling:**
661
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
500
662
  *
501
663
  * @param request - DeleteIndexDocumentRequest
502
664
  * @returns DeleteIndexDocumentResponse
503
665
  */
504
666
  deleteIndexDocument(WorkspaceId: string, request: $_model.DeleteIndexDocumentRequest): Promise<$_model.DeleteIndexDocumentResponse>;
505
667
  /**
506
- * 删除memory
668
+ * Permanently deletes a specified long-term memory.
669
+ *
670
+ * @remarks
671
+ * - Before calling this operation, make sure that your long-term memory has been created and has not been deleted (that is, the memoryId is valid).
672
+ * - The delete operation is irreversible. The deleted long-term memory, including all of its long-term memory nodes, cannot be recovered. The [GetMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getmemory) operation will no longer be able to retrieve its information. Proceed with caution.
673
+ * - This operation is idempotent.
674
+ * **Rate limit:** Make sure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
507
675
  *
508
676
  * @param request - DeleteMemoryRequest
509
677
  * @param headers - map
@@ -514,14 +682,20 @@ export default class Client extends OpenApi {
514
682
  [key: string]: string;
515
683
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMemoryResponse>;
516
684
  /**
517
- * 删除memory
685
+ * Permanently deletes a specified long-term memory.
686
+ *
687
+ * @remarks
688
+ * - Before calling this operation, make sure that your long-term memory has been created and has not been deleted (that is, the memoryId is valid).
689
+ * - The delete operation is irreversible. The deleted long-term memory, including all of its long-term memory nodes, cannot be recovered. The [GetMemory](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getmemory) operation will no longer be able to retrieve its information. Proceed with caution.
690
+ * - This operation is idempotent.
691
+ * **Rate limit:** Make sure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
518
692
  *
519
693
  * @param request - DeleteMemoryRequest
520
694
  * @returns DeleteMemoryResponse
521
695
  */
522
696
  deleteMemory(workspaceId: string, memoryId: string, request: $_model.DeleteMemoryRequest): Promise<$_model.DeleteMemoryResponse>;
523
697
  /**
524
- * 删除记忆Node
698
+ * Deletes a memory fragment.
525
699
  *
526
700
  * @param request - DeleteMemoryNodeRequest
527
701
  * @param headers - map
@@ -532,7 +706,7 @@ export default class Client extends OpenApi {
532
706
  [key: string]: string;
533
707
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMemoryNodeResponse>;
534
708
  /**
535
- * 删除记忆Node
709
+ * Deletes a memory fragment.
536
710
  *
537
711
  * @param request - DeleteMemoryNodeRequest
538
712
  * @returns DeleteMemoryNodeResponse
@@ -557,13 +731,13 @@ export default class Client extends OpenApi {
557
731
  */
558
732
  deletePromptTemplate(workspaceId: string, promptTemplateId: string, request: $_model.DeletePromptTemplateRequest): Promise<$_model.DeletePromptTemplateResponse>;
559
733
  /**
560
- * Obtains the basic information of a document, including the document name, type, and status.
734
+ * Queries the basic information about a file in application data, including the file name, type, and status.
561
735
  *
562
736
  * @remarks
563
- * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
564
- * * You can also call this operation to query unstructured documents that you upload on the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page.
565
- * * This operation is idempotent.
566
- * **Throttling:** Make sure that the interval between the two queries is at least 15 seconds. Otherwise, you may trigger system throttling. If throttling is triggered, try again later.
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).
738
+ * - This operation is idempotent.
739
+ * **Rate limit:**
740
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
567
741
  *
568
742
  * @param request - DescribeFileRequest
569
743
  * @param headers - map
@@ -574,20 +748,20 @@ export default class Client extends OpenApi {
574
748
  [key: string]: string;
575
749
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFileResponse>;
576
750
  /**
577
- * Obtains the basic information of a document, including the document name, type, and status.
751
+ * Queries the basic information about a file in application data, including the file name, type, and status.
578
752
  *
579
753
  * @remarks
580
- * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
581
- * * You can also call this operation to query unstructured documents that you upload on the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page.
582
- * * This operation is idempotent.
583
- * **Throttling:** Make sure that the interval between the two queries is at least 15 seconds. Otherwise, you may trigger system throttling. If throttling is triggered, try again later.
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).
755
+ * - This operation is idempotent.
756
+ * **Rate limit:**
757
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
584
758
  *
585
759
  * @param request - DescribeFileRequest
586
760
  * @returns DescribeFileResponse
587
761
  */
588
762
  describeFile(WorkspaceId: string, FileId: string, request: $_model.DescribeFileRequest): Promise<$_model.DescribeFileResponse>;
589
763
  /**
590
- * 查询支付宝打赏状态
764
+ * Queries the tipping status of the Alipay wallet bound to an application.
591
765
  *
592
766
  * @param request - GetAlipayTransferStatusRequest
593
767
  * @param headers - map
@@ -598,14 +772,14 @@ export default class Client extends OpenApi {
598
772
  [key: string]: string;
599
773
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetAlipayTransferStatusResponse>;
600
774
  /**
601
- * 查询支付宝打赏状态
775
+ * Queries the tipping status of the Alipay wallet bound to an application.
602
776
  *
603
777
  * @param request - GetAlipayTransferStatusRequest
604
778
  * @returns GetAlipayTransferStatusResponse
605
779
  */
606
780
  getAlipayTransferStatus(request: $_model.GetAlipayTransferStatusRequest): Promise<$_model.GetAlipayTransferStatusResponse>;
607
781
  /**
608
- * 支付宝打赏链接
782
+ * Retrieves the Alipay tipping URL for an application.
609
783
  *
610
784
  * @param request - GetAlipayUrlRequest
611
785
  * @param headers - map
@@ -616,7 +790,7 @@ export default class Client extends OpenApi {
616
790
  [key: string]: string;
617
791
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetAlipayUrlResponse>;
618
792
  /**
619
- * 支付宝打赏链接
793
+ * Retrieves the Alipay tipping URL for an application.
620
794
  *
621
795
  * @param request - GetAlipayUrlRequest
622
796
  * @returns GetAlipayUrlResponse
@@ -625,6 +799,12 @@ export default class Client extends OpenApi {
625
799
  /**
626
800
  * Lists all supported parser types based on the input file type (file extension).
627
801
  *
802
+ * @remarks
803
+ * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetAvailableParserTypes权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
804
+ * - 本接口具有幂等性。
805
+ * **限流说明:**
806
+ * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
807
+ *
628
808
  * @param request - GetAvailableParserTypesRequest
629
809
  * @param headers - map
630
810
  * @param runtime - runtime options for this request RuntimeOptions
@@ -636,12 +816,24 @@ export default class Client extends OpenApi {
636
816
  /**
637
817
  * Lists all supported parser types based on the input file type (file extension).
638
818
  *
819
+ * @remarks
820
+ * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetAvailableParserTypes权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
821
+ * - 本接口具有幂等性。
822
+ * **限流说明:**
823
+ * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
824
+ *
639
825
  * @param request - GetAvailableParserTypesRequest
640
826
  * @returns GetAvailableParserTypesResponse
641
827
  */
642
828
  getAvailableParserTypes(WorkspaceId: string, request: $_model.GetAvailableParserTypesRequest): Promise<$_model.GetAvailableParserTypesResponse>;
643
829
  /**
644
- * GetConnector
830
+ * Retrieves details about a connector. This operation currently supports only file connectors.
831
+ *
832
+ * @remarks
833
+ * - To call this operation, 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 must [join a business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:GetConnector permission. An Alibaba Cloud account (primary account) can call this operation directly. We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
834
+ * - This operation is idempotent.
835
+ * **Throttling:**
836
+ * This operation is subject to throttling. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
645
837
  *
646
838
  * @param request - GetConnectorRequest
647
839
  * @param headers - map
@@ -652,19 +844,26 @@ export default class Client extends OpenApi {
652
844
  [key: string]: string;
653
845
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetConnectorResponse>;
654
846
  /**
655
- * GetConnector
847
+ * Retrieves details about a connector. This operation currently supports only file connectors.
848
+ *
849
+ * @remarks
850
+ * - To call this operation, 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 must [join a business space](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` policy, which includes the sfm:GetConnector permission. An Alibaba Cloud account (primary account) can call this operation directly. We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
851
+ * - This operation is idempotent.
852
+ * **Throttling:**
853
+ * This operation is subject to throttling. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
656
854
  *
657
855
  * @param request - GetConnectorRequest
658
856
  * @returns GetConnectorResponse
659
857
  */
660
858
  getConnector(WorkspaceId: string, request: $_model.GetConnectorRequest): Promise<$_model.GetConnectorResponse>;
661
859
  /**
662
- * Queries the current status of a specified knowledge base creation or add document job.
860
+ * Queries the current status of a specified knowledge base creation job or knowledge base document append job.
663
861
  *
664
862
  * @remarks
665
- * 1. A knowledge base job is running. You can call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to create a creation job or the [SubmitIndexAddDocumentsJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexadddocumentsjob) operation to create a add document job. Then, obtain the `JobId` returned by the operations.
666
- * 2. We recommend that you call this operation at intervals of more than 5 seconds.
667
- * 3. This interface is idempotent.
863
+ * - 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.
865
+ * - Invoke this operation at intervals of 5 seconds or more.
866
+ * - This operation is idempotent.
668
867
  *
669
868
  * @param request - GetIndexJobStatusRequest
670
869
  * @param headers - map
@@ -675,19 +874,26 @@ export default class Client extends OpenApi {
675
874
  [key: string]: string;
676
875
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexJobStatusResponse>;
677
876
  /**
678
- * Queries the current status of a specified knowledge base creation or add document job.
877
+ * Queries the current status of a specified knowledge base creation job or knowledge base document append job.
679
878
  *
680
879
  * @remarks
681
- * 1. A knowledge base job is running. You can call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to create a creation job or the [SubmitIndexAddDocumentsJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexadddocumentsjob) operation to create a add document job. Then, obtain the `JobId` returned by the operations.
682
- * 2. We recommend that you call this operation at intervals of more than 5 seconds.
683
- * 3. This interface is idempotent.
880
+ * - 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.
882
+ * - Invoke this operation at intervals of 5 seconds or more.
883
+ * - This operation is idempotent.
684
884
  *
685
885
  * @param request - GetIndexJobStatusRequest
686
886
  * @returns GetIndexJobStatusResponse
687
887
  */
688
888
  getIndexJobStatus(WorkspaceId: string, request: $_model.GetIndexJobStatusRequest): Promise<$_model.GetIndexJobStatusResponse>;
689
889
  /**
690
- * \\<props="intl">Currently, this API is not supported.\\
890
+ * You can call the GetIndexMonitor operation to query monitoring data for a specified knowledge base within a specific time range. This data is crucial for App Performance Analytics, capacity planning, and cost management. The monitoring data includes two main dimensions: storage and retrieval. Storage monitoring retrieves the index storage limit and current usage of the knowledge base. Retrieval monitoring retrieves performance metrics for the query period, such as peak queries per second (QPS), total requests, and average QPS. The metrics are provided as totals and are also broken down by time window. The requests are categorized as successful, failed, and rate-limited.
891
+ *
892
+ * @remarks
893
+ * <props="intl">
894
+ * This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
895
+ * <props="china">
896
+ * - Before you call this operation, a RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (which requires the `AliyunBailianDataFullAccess` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). Alibaba Cloud accounts can call this operation directly without authorization. You can call this operation using the latest version of the [Alibaba Cloud Model Studio software development kit (SDK)](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29). Before you call this operation, make sure that the specified knowledge base has been created and has not been deleted. This means that the knowledge base ID (`IndexId`) must be valid. This operation is idempotent. The maximum query time range (EndTimestamp - StartTimestamp) is 30 days. The granularity of the time window in the returned data is dynamically adjusted based on the query time range.
691
897
  *
692
898
  * @param request - GetIndexMonitorRequest
693
899
  * @param headers - map
@@ -698,14 +904,24 @@ export default class Client extends OpenApi {
698
904
  [key: string]: string;
699
905
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexMonitorResponse>;
700
906
  /**
701
- * \\<props="intl">Currently, this API is not supported.\\
907
+ * You can call the GetIndexMonitor operation to query monitoring data for a specified knowledge base within a specific time range. This data is crucial for App Performance Analytics, capacity planning, and cost management. The monitoring data includes two main dimensions: storage and retrieval. Storage monitoring retrieves the index storage limit and current usage of the knowledge base. Retrieval monitoring retrieves performance metrics for the query period, such as peak queries per second (QPS), total requests, and average QPS. The metrics are provided as totals and are also broken down by time window. The requests are categorized as successful, failed, and rate-limited.
908
+ *
909
+ * @remarks
910
+ * <props="intl">
911
+ * This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).
912
+ * <props="china">
913
+ * - Before you call this operation, a RAM user must obtain the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (which requires the `AliyunBailianDataFullAccess` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). Alibaba Cloud accounts can call this operation directly without authorization. You can call this operation using the latest version of the [Alibaba Cloud Model Studio software development kit (SDK)](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29). Before you call this operation, make sure that the specified knowledge base has been created and has not been deleted. This means that the knowledge base ID (`IndexId`) must be valid. This operation is idempotent. The maximum query time range (EndTimestamp - StartTimestamp) is 30 days. The granularity of the time window in the returned data is dynamically adjusted based on the query time range.
702
914
  *
703
915
  * @param request - GetIndexMonitorRequest
704
916
  * @returns GetIndexMonitorResponse
705
917
  */
706
918
  getIndexMonitor(WorkspaceId: string, request: $_model.GetIndexMonitorRequest): Promise<$_model.GetIndexMonitorResponse>;
707
919
  /**
708
- * 获取memory
920
+ * Retrieves the description of a specified long-term memory.
921
+ *
922
+ * @remarks
923
+ * - This operation is idempotent.
924
+ * **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
709
925
  *
710
926
  * @param request - GetMemoryRequest
711
927
  * @param headers - map
@@ -716,14 +932,18 @@ export default class Client extends OpenApi {
716
932
  [key: string]: string;
717
933
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetMemoryResponse>;
718
934
  /**
719
- * 获取memory
935
+ * Retrieves the description of a specified long-term memory.
936
+ *
937
+ * @remarks
938
+ * - This operation is idempotent.
939
+ * **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
720
940
  *
721
941
  * @param request - GetMemoryRequest
722
942
  * @returns GetMemoryResponse
723
943
  */
724
944
  getMemory(workspaceId: string, memoryId: string, request: $_model.GetMemoryRequest): Promise<$_model.GetMemoryResponse>;
725
945
  /**
726
- * 获取记忆Node
946
+ * Retrieves a memory fragment.
727
947
  *
728
948
  * @param request - GetMemoryNodeRequest
729
949
  * @param headers - map
@@ -734,7 +954,7 @@ export default class Client extends OpenApi {
734
954
  [key: string]: string;
735
955
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetMemoryNodeResponse>;
736
956
  /**
737
- * 获取记忆Node
957
+ * Retrieves a memory fragment.
738
958
  *
739
959
  * @param request - GetMemoryNodeRequest
740
960
  * @returns GetMemoryNodeResponse
@@ -743,6 +963,12 @@ export default class Client extends OpenApi {
743
963
  /**
744
964
  * Queries the data parsing settings in a specified category.
745
965
  *
966
+ * @remarks
967
+ * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetParseSettings权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
968
+ * - 本接口具有幂等性。
969
+ * **限流说明:**
970
+ * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
971
+ *
746
972
  * @param request - GetParseSettingsRequest
747
973
  * @param headers - map
748
974
  * @param runtime - runtime options for this request RuntimeOptions
@@ -754,6 +980,12 @@ export default class Client extends OpenApi {
754
980
  /**
755
981
  * Queries the data parsing settings in a specified category.
756
982
  *
983
+ * @remarks
984
+ * - RAM用户(子账号)需要首先获取阿里云百炼的[API权限](https://help.aliyun.com/document_detail/2848578.html)(`AliyunBailianDataFullAccess`或`AliyunBailianDataReadOnlyAccess`均可,已包括sfm:GetParseSettings权限点),并[加入一个业务空间](https://help.aliyun.com/document_detail/2851098.html)后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版<props="china">[阿里云百炼SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[阿里云百炼SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29)来调用本接口。
985
+ * - 本接口具有幂等性。
986
+ * **限流说明:**
987
+ * 本接口频繁调用会被限流,频率请勿超过10次/秒。如遇限流,请稍后重试。
988
+ *
757
989
  * @param request - GetParseSettingsRequest
758
990
  * @returns GetParseSettingsResponse
759
991
  */
@@ -813,7 +1045,14 @@ export default class Client extends OpenApi {
813
1045
  */
814
1046
  highCodeDeploy(workspaceId: string, request: $_model.HighCodeDeployRequest): Promise<$_model.HighCodeDeployResponse>;
815
1047
  /**
816
- * Lists the details about the next or multiple categories in a specified workspace.
1048
+ * Retrieves the details of one or more categories in a specified workspace.
1049
+ *
1050
+ * @remarks
1051
+ * - This API does not support querying data tables.
1052
+ * - To call this API, a RAM user must first obtain the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` permission, which includes the `sfm:ListCategory` permission. Alibaba Cloud accounts can call this API directly. Use the latest version of the <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
1053
+ * - This operation supports pagination. When making your first request, set the `MaxResults` parameter to specify the maximum number of items to return. If more items are available, the response includes a `NextToken`. To retrieve the next page of results, set the `NextToken` parameter to the value from the previous response and specify `MaxResults` again. An empty `NextToken` indicates that no more results are available.
1054
+ * - This operation is idempotent.
1055
+ * **Rate limiting:** This API is subject to rate limiting. Do not exceed 5 requests per second. If the system throttles a request, retry it after a short interval.
817
1056
  *
818
1057
  * @param request - ListCategoryRequest
819
1058
  * @param headers - map
@@ -824,18 +1063,29 @@ export default class Client extends OpenApi {
824
1063
  [key: string]: string;
825
1064
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListCategoryResponse>;
826
1065
  /**
827
- * Lists the details about the next or multiple categories in a specified workspace.
1066
+ * Retrieves the details of one or more categories in a specified workspace.
1067
+ *
1068
+ * @remarks
1069
+ * - This API does not support querying data tables.
1070
+ * - To call this API, a RAM user must first obtain the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). This requires the `AliyunBailianDataFullAccess` permission, which includes the `sfm:ListCategory` permission. Alibaba Cloud accounts can call this API directly. Use the latest version of the <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
1071
+ * - This operation supports pagination. When making your first request, set the `MaxResults` parameter to specify the maximum number of items to return. If more items are available, the response includes a `NextToken`. To retrieve the next page of results, set the `NextToken` parameter to the value from the previous response and specify `MaxResults` again. An empty `NextToken` indicates that no more results are available.
1072
+ * - This operation is idempotent.
1073
+ * **Rate limiting:** This API is subject to rate limiting. Do not exceed 5 requests per second. If the system throttles a request, retry it after a short interval.
828
1074
  *
829
1075
  * @param request - ListCategoryRequest
830
1076
  * @returns ListCategoryResponse
831
1077
  */
832
1078
  listCategory(WorkspaceId: string, request: $_model.ListCategoryRequest): Promise<$_model.ListCategoryResponse>;
833
1079
  /**
834
- * For unstructured knowledge base, obtains the details of all chunks of a specified document; for structured knowledge base, obtains the details of all chunks.
1080
+ * Queries the list and information of text chunks.
835
1081
  *
836
1082
  * @remarks
837
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
838
- * * This interface is idempotent.
1083
+ * - For document search<props="china"> or audio/video search knowledge bases, this operation queries all chunks of a specified file. For data query or image Q&A knowledge bases, this operation retrieves information about all text chunks.
1084
+ * - 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: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 <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.
1085
+ * - 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).
1086
+ * - This operation has idempotence.
1087
+ * **Rate limit:**
1088
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
839
1089
  *
840
1090
  * @param request - ListChunksRequest
841
1091
  * @param headers - map
@@ -846,24 +1096,29 @@ export default class Client extends OpenApi {
846
1096
  [key: string]: string;
847
1097
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListChunksResponse>;
848
1098
  /**
849
- * For unstructured knowledge base, obtains the details of all chunks of a specified document; for structured knowledge base, obtains the details of all chunks.
1099
+ * Queries the list and information of text chunks.
850
1100
  *
851
1101
  * @remarks
852
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
853
- * * This interface is idempotent.
1102
+ * - For document search<props="china"> or audio/video search knowledge bases, this operation queries all chunks of a specified file. For data query or image Q&A knowledge bases, this operation retrieves information about all text chunks.
1103
+ * - 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: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 <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.
1104
+ * - 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).
1105
+ * - This operation has idempotence.
1106
+ * **Rate limit:**
1107
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
854
1108
  *
855
1109
  * @param request - ListChunksRequest
856
1110
  * @returns ListChunksResponse
857
1111
  */
858
1112
  listChunks(WorkspaceId: string, request: $_model.ListChunksRequest): Promise<$_model.ListChunksResponse>;
859
1113
  /**
860
- * Queries the details of one or more documents in a specified category.
1114
+ * Retrieves the details of one or more documents in a specified category.
861
1115
  *
862
1116
  * @remarks
863
- * If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:ListFile) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
864
- * * During a paged query, set `MaxResults` to specify the maximum number of entries to return. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you query subsequent pages, set the `NextToken` parameter to the `NextToken` obtained in the last returned result. You can also set the `MaxResults` parameter to limit the number of entries to be returned. If no `NextToken` is returned, the result is completely returned and no more requests are required.
865
- * * This operation is idempotent.
866
- * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
1117
+ * - 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.
1119
+ * - This operation is idempotent.
1120
+ * **Rate limit:**
1121
+ * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
867
1122
  *
868
1123
  * @param tmpReq - ListFileRequest
869
1124
  * @param headers - map
@@ -874,24 +1129,28 @@ export default class Client extends OpenApi {
874
1129
  [key: string]: string;
875
1130
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListFileResponse>;
876
1131
  /**
877
- * Queries the details of one or more documents in a specified category.
1132
+ * Retrieves the details of one or more documents in a specified category.
878
1133
  *
879
1134
  * @remarks
880
- * If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:ListFile) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
881
- * * During a paged query, set `MaxResults` to specify the maximum number of entries to return. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you query subsequent pages, set the `NextToken` parameter to the `NextToken` obtained in the last returned result. You can also set the `MaxResults` parameter to limit the number of entries to be returned. If no `NextToken` is returned, the result is completely returned and no more requests are required.
882
- * * This operation is idempotent.
883
- * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
1135
+ * - 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.
1137
+ * - This operation is idempotent.
1138
+ * **Rate limit:**
1139
+ * This operation is throttled if called too frequently. Do not exceed 5 calls per second. If throttled, retry later.
884
1140
  *
885
1141
  * @param request - ListFileRequest
886
1142
  * @returns ListFileResponse
887
1143
  */
888
1144
  listFile(WorkspaceId: string, request: $_model.ListFileRequest): Promise<$_model.ListFileResponse>;
889
1145
  /**
890
- * Queries the details of one or more documents in a specified knowledge base.
1146
+ * Retrieves the files in a specified knowledge base along with their summary information.
891
1147
  *
892
1148
  * @remarks
893
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
894
- * * This interface is idempotent.
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.
1150
+ * - 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
+ * - This operation has idempotence.
1152
+ * **Throttling:**
1153
+ * This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
895
1154
  *
896
1155
  * @param request - ListIndexDocumentsRequest
897
1156
  * @param headers - map
@@ -902,18 +1161,26 @@ export default class Client extends OpenApi {
902
1161
  [key: string]: string;
903
1162
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexDocumentsResponse>;
904
1163
  /**
905
- * Queries the details of one or more documents in a specified knowledge base.
1164
+ * Retrieves the files in a specified knowledge base along with their summary information.
906
1165
  *
907
1166
  * @remarks
908
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
909
- * * This interface is idempotent.
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.
1168
+ * - 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
+ * - This operation has idempotence.
1170
+ * **Throttling:**
1171
+ * This operation is throttled if called too frequently. Do not exceed 15 calls per second. If you are throttled, retry later.
910
1172
  *
911
1173
  * @param request - ListIndexDocumentsRequest
912
1174
  * @returns ListIndexDocumentsResponse
913
1175
  */
914
1176
  listIndexDocuments(WorkspaceId: string, request: $_model.ListIndexDocumentsRequest): Promise<$_model.ListIndexDocumentsResponse>;
915
1177
  /**
916
- * 查询Index文件详情
1178
+ * Retrieves the details of one or more documents in a specified knowledge base.
1179
+ *
1180
+ * @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.
917
1184
  *
918
1185
  * @param request - ListIndexFileDetailsRequest
919
1186
  * @param headers - map
@@ -924,17 +1191,25 @@ export default class Client extends OpenApi {
924
1191
  [key: string]: string;
925
1192
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndexFileDetailsResponse>;
926
1193
  /**
927
- * 查询Index文件详情
1194
+ * Retrieves the details of one or more documents in a specified knowledge base.
1195
+ *
1196
+ * @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.
928
1200
  *
929
1201
  * @param request - ListIndexFileDetailsRequest
930
1202
  * @returns ListIndexFileDetailsResponse
931
1203
  */
932
1204
  listIndexFileDetails(WorkspaceId: string, request: $_model.ListIndexFileDetailsRequest): Promise<$_model.ListIndexFileDetailsResponse>;
933
1205
  /**
934
- * Lists the details about the next or multiple knowledge bases in a specified workspace.
1206
+ * Retrieves the list of knowledge bases in a specified workspace.
935
1207
  *
936
1208
  * @remarks
937
- * This interface is idempotent.
1209
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission) 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.
1210
+ * - This operation is idempotent.
1211
+ * **Rate limit:**
1212
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
938
1213
  *
939
1214
  * @param request - ListIndicesRequest
940
1215
  * @param headers - map
@@ -945,17 +1220,25 @@ export default class Client extends OpenApi {
945
1220
  [key: string]: string;
946
1221
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndicesResponse>;
947
1222
  /**
948
- * Lists the details about the next or multiple knowledge bases in a specified workspace.
1223
+ * Retrieves the list of knowledge bases in a specified workspace.
949
1224
  *
950
1225
  * @remarks
951
- * This interface is idempotent.
1226
+ * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission) 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.
1227
+ * - This operation is idempotent.
1228
+ * **Rate limit:**
1229
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
952
1230
  *
953
1231
  * @param request - ListIndicesRequest
954
1232
  * @returns ListIndicesResponse
955
1233
  */
956
1234
  listIndices(WorkspaceId: string, request: $_model.ListIndicesRequest): Promise<$_model.ListIndicesResponse>;
957
1235
  /**
958
- * 获取memory
1236
+ * Retrieves the details of one or more long-term memory entities in a specified workspace.
1237
+ *
1238
+ * @remarks
1239
+ * - When querying the first page of a paging query, set only `MaxResults` to limit the number of entries returned. The `NextToken` value in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response as the query credential (if `NextToken` is empty, all results have been returned and no further requests are needed), and settings `MaxResults` to limit the number of entries returned.
1240
+ * - This operation supports idempotence.
1241
+ * **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
959
1242
  *
960
1243
  * @param request - ListMemoriesRequest
961
1244
  * @param headers - map
@@ -966,14 +1249,19 @@ export default class Client extends OpenApi {
966
1249
  [key: string]: string;
967
1250
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemoriesResponse>;
968
1251
  /**
969
- * 获取memory
1252
+ * Retrieves the details of one or more long-term memory entities in a specified workspace.
1253
+ *
1254
+ * @remarks
1255
+ * - When querying the first page of a paging query, set only `MaxResults` to limit the number of entries returned. The `NextToken` value in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the `NextToken` value obtained from the previous response as the query credential (if `NextToken` is empty, all results have been returned and no further requests are needed), and settings `MaxResults` to limit the number of entries returned.
1256
+ * - This operation supports idempotence.
1257
+ * **Rate limit:** Ensure that the interval between two consecutive requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
970
1258
  *
971
1259
  * @param request - ListMemoriesRequest
972
1260
  * @returns ListMemoriesResponse
973
1261
  */
974
1262
  listMemories(workspaceId: string, request: $_model.ListMemoriesRequest): Promise<$_model.ListMemoriesResponse>;
975
1263
  /**
976
- * 获取记忆Node列表
1264
+ * Retrieves a list of memory nodes.
977
1265
  *
978
1266
  * @param request - ListMemoryNodesRequest
979
1267
  * @param headers - map
@@ -984,7 +1272,7 @@ export default class Client extends OpenApi {
984
1272
  [key: string]: string;
985
1273
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMemoryNodesResponse>;
986
1274
  /**
987
- * 获取记忆Node列表
1275
+ * Retrieves a list of memory nodes.
988
1276
  *
989
1277
  * @param request - ListMemoryNodesRequest
990
1278
  * @returns ListMemoryNodesResponse
@@ -1027,12 +1315,23 @@ export default class Client extends OpenApi {
1027
1315
  */
1028
1316
  listPublishedAgent(workspaceId: string, request: $_model.ListPublishedAgentRequest): Promise<$_model.ListPublishedAgentResponse>;
1029
1317
  /**
1030
- * Queries information from a specified knowledge base.
1318
+ * Retrieves information from a specified knowledge base.
1031
1319
  *
1032
1320
  * @remarks
1033
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
1034
- * * The response time may be long because this operation involves complex retrieval and matching. We recommend that you set appropriate timeout and retry policy for requests.
1035
- * * This interface is idempotent.
1321
+ * <props="china">
1322
+ * - **How to call**: To retrieve information from a knowledge base, use the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) with an [AccessKey](https://help.aliyun.com/document_detail/116401.html) or [Spring AI Alibaba](https://help.aliyun.com/document_detail/2990886.html) with an Alibaba Cloud Model Studio [API key](https://help.aliyun.com/document_detail/2712195.html). Both tools simplify your API calls by handling the complex signature calculation.
1323
+ * - **Required permissions**:
1324
+ * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
1325
+ * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
1326
+ * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
1327
+ * - **Idempotency**: This API is idempotent.
1328
+ * <props="intl">
1329
+ * - **How to call**: We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API. The SDK simplifies API calls by handling the complex signature calculation.
1330
+ * - **Required permissions**:
1331
+ * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
1332
+ * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
1333
+ * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
1334
+ * - **Idempotency**: This API is idempotent.
1036
1335
  *
1037
1336
  * @param tmpReq - RetrieveRequest
1038
1337
  * @param headers - map
@@ -1043,25 +1342,42 @@ export default class Client extends OpenApi {
1043
1342
  [key: string]: string;
1044
1343
  }, runtime: $dara.RuntimeOptions): Promise<$_model.RetrieveResponse>;
1045
1344
  /**
1046
- * Queries information from a specified knowledge base.
1345
+ * Retrieves information from a specified knowledge base.
1047
1346
  *
1048
1347
  * @remarks
1049
- * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
1050
- * * The response time may be long because this operation involves complex retrieval and matching. We recommend that you set appropriate timeout and retry policy for requests.
1051
- * * This interface is idempotent.
1348
+ * <props="china">
1349
+ * - **How to call**: To retrieve information from a knowledge base, use the latest [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) with an [AccessKey](https://help.aliyun.com/document_detail/116401.html) or [Spring AI Alibaba](https://help.aliyun.com/document_detail/2990886.html) with an Alibaba Cloud Model Studio [API key](https://help.aliyun.com/document_detail/2712195.html). Both tools simplify your API calls by handling the complex signature calculation.
1350
+ * - **Required permissions**:
1351
+ * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
1352
+ * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
1353
+ * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
1354
+ * - **Idempotency**: This API is idempotent.
1355
+ * <props="intl">
1356
+ * - **How to call**: We recommend using the latest [Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API. The SDK simplifies API calls by handling the complex signature calculation.
1357
+ * - **Required permissions**:
1358
+ * - **RAM user (sub-account)**: To call this API, a RAM user must be granted [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). You can use the `AliyunBailianDataFullAccess` policy, which includes the required `sfm:Retrieve` permission.
1359
+ * - **Alibaba Cloud account (main account)**: This account has the required permissions by default and can call the API directly.
1360
+ * - **Response latency**: This API call involves complex retrieval and matching operations, which can cause longer response times. We recommend configuring appropriate request timeouts and retry strategies.
1361
+ * - **Idempotency**: This API is idempotent.
1052
1362
  *
1053
1363
  * @param request - RetrieveRequest
1054
1364
  * @returns RetrieveResponse
1055
1365
  */
1056
1366
  retrieve(WorkspaceId: string, request: $_model.RetrieveRequest): Promise<$_model.RetrieveResponse>;
1057
1367
  /**
1058
- * Adds parsed documents to an unstructured knowledge base. You cannot use the API to add knowledge to structured knowledge bases, see the Usage notes section of this topic.
1368
+ * Adds parsed files to the specified knowledge base.
1059
1369
  *
1060
1370
  * @remarks
1061
- * You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
1062
- * * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
1063
- * * After you call this operation, you can call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation to query the status of the job. More than 20 calls to the GetIndexJobStatus operation per minute may trigger throttling.
1064
- * * Execution takes a period of time after this operation is called. Do not make new request before the request is returned. This interface is not idempotent.
1371
+ * <props="china">
1372
+ * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
1373
+ * <props="intl">
1374
+ * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
1375
+ * - A RAM user (sub-account) can call this API only after being granted the required [api permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (specifically, the `AliyunBailianDataFullAccess` policy, which includes the `sfm:SubmitIndexAddDocumentsJob` permission) and joining a [workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this API 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 API.
1376
+ * - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
1377
+ * - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
1378
+ * - After calling this API, the job runs in the background and may take several hours to complete, especially during peak times. Do not submit duplicate requests until the job is complete. To check the job status, call the **GetIndexJobStatus** API. The `Documents` file list returned by the GetIndexJobStatus API contains all files for the job, which is uniquely identified by the `job_id` you provided. You can check this list to verify whether each file was imported (parsed) successfully. Note that frequent calls to the GetIndexJobStatus API are subject to rate limiting. Do not exceed 20 calls per minute.
1379
+ * - A successful API call indicates the job has been submitted for processing, which takes time. This API is not idempotent, so do not send duplicate requests; doing so will create multiple jobs.
1380
+ * **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
1065
1381
  *
1066
1382
  * @param tmpReq - SubmitIndexAddDocumentsJobRequest
1067
1383
  * @param headers - map
@@ -1072,26 +1388,35 @@ export default class Client extends OpenApi {
1072
1388
  [key: string]: string;
1073
1389
  }, runtime: $dara.RuntimeOptions): Promise<$_model.SubmitIndexAddDocumentsJobResponse>;
1074
1390
  /**
1075
- * Adds parsed documents to an unstructured knowledge base. You cannot use the API to add knowledge to structured knowledge bases, see the Usage notes section of this topic.
1391
+ * Adds parsed files to the specified knowledge base.
1076
1392
  *
1077
1393
  * @remarks
1078
- * You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
1079
- * * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
1080
- * * After you call this operation, you can call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation to query the status of the job. More than 20 calls to the GetIndexJobStatus operation per minute may trigger throttling.
1081
- * * Execution takes a period of time after this operation is called. Do not make new request before the request is returned. This interface is not idempotent.
1394
+ * <props="china">
1395
+ * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
1396
+ * <props="intl">
1397
+ * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
1398
+ * - A RAM user (sub-account) can call this API only after being granted the required [api permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (specifically, the `AliyunBailianDataFullAccess` policy, which includes the `sfm:SubmitIndexAddDocumentsJob` permission) and joining a [workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this API 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 API.
1399
+ * - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
1400
+ * - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
1401
+ * - After calling this API, the job runs in the background and may take several hours to complete, especially during peak times. Do not submit duplicate requests until the job is complete. To check the job status, call the **GetIndexJobStatus** API. The `Documents` file list returned by the GetIndexJobStatus API contains all files for the job, which is uniquely identified by the `job_id` you provided. You can check this list to verify whether each file was imported (parsed) successfully. Note that frequent calls to the GetIndexJobStatus API are subject to rate limiting. Do not exceed 20 calls per minute.
1402
+ * - A successful API call indicates the job has been submitted for processing, which takes time. This API is not idempotent, so do not send duplicate requests; doing so will create multiple jobs.
1403
+ * **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
1082
1404
  *
1083
1405
  * @param request - SubmitIndexAddDocumentsJobRequest
1084
1406
  * @returns SubmitIndexAddDocumentsJobResponse
1085
1407
  */
1086
1408
  submitIndexAddDocumentsJob(WorkspaceId: string, request: $_model.SubmitIndexAddDocumentsJobRequest): Promise<$_model.SubmitIndexAddDocumentsJobResponse>;
1087
1409
  /**
1088
- * Submits a specified CreateIndex job to complete knowledge base creation.
1410
+ * Submits a specified CreateIndex task to complete knowledge base creation.
1089
1411
  *
1090
1412
  * @remarks
1091
- * 1. Before you call this operation, you must call the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation and obtain the `IndexId`.
1092
- * 2. Execution takes a period of time after this operation is called. Do not make new request before the request is returned.
1093
- * 3. If you want to query the execution status of the job after you call this operation, call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
1094
- * 4. This interface is not idempotent.
1413
+ * - 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:SubmitIndexJob 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.
1414
+ * - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
1415
+ * - After invoking this operation, the node requires time to execute and may take several hours during peak periods. Do not submit duplicate requests before the node completes. To query the node execution status, invoke the **GetIndexJobStatus** operation.
1416
+ * - After the knowledge base is created, you can associate it with an agent application<props="china"> or workflow application in the same workspace through <props="china">[Application Management](https://bailian.console.aliyun.com/?tab=app#/app-center)<props="intl">[Application Management](https://modelstudio.console.alibabacloud.com/?tab=app#/app-center) (or pass the `IndexID` through `rag_options` in [Application Calls](https://help.aliyun.com/document_detail/2846132.html)) to supplement your Model Studio application with private knowledge and up-to-date information. You can also choose not to use a Model Studio application and directly query the knowledge base by invoking the **Retrieve** operation.
1417
+ * - This operation does not support idempotence.
1418
+ * **Rate limit:**
1419
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
1095
1420
  *
1096
1421
  * @param request - SubmitIndexJobRequest
1097
1422
  * @param headers - map
@@ -1102,13 +1427,16 @@ export default class Client extends OpenApi {
1102
1427
  [key: string]: string;
1103
1428
  }, runtime: $dara.RuntimeOptions): Promise<$_model.SubmitIndexJobResponse>;
1104
1429
  /**
1105
- * Submits a specified CreateIndex job to complete knowledge base creation.
1430
+ * Submits a specified CreateIndex task to complete knowledge base creation.
1106
1431
  *
1107
1432
  * @remarks
1108
- * 1. Before you call this operation, you must call the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation and obtain the `IndexId`.
1109
- * 2. Execution takes a period of time after this operation is called. Do not make new request before the request is returned.
1110
- * 3. If you want to query the execution status of the job after you call this operation, call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
1111
- * 4. This interface is not idempotent.
1433
+ * - 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:SubmitIndexJob 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.
1434
+ * - Before invoking this operation, you must invoke the **CreateIndex** operation and obtain the corresponding `IndexId`.
1435
+ * - After invoking this operation, the node requires time to execute and may take several hours during peak periods. Do not submit duplicate requests before the node completes. To query the node execution status, invoke the **GetIndexJobStatus** operation.
1436
+ * - After the knowledge base is created, you can associate it with an agent application<props="china"> or workflow application in the same workspace through <props="china">[Application Management](https://bailian.console.aliyun.com/?tab=app#/app-center)<props="intl">[Application Management](https://modelstudio.console.alibabacloud.com/?tab=app#/app-center) (or pass the `IndexID` through `rag_options` in [Application Calls](https://help.aliyun.com/document_detail/2846132.html)) to supplement your Model Studio application with private knowledge and up-to-date information. You can also choose not to use a Model Studio application and directly query the knowledge base by invoking the **Retrieve** operation.
1437
+ * - This operation does not support idempotence.
1438
+ * **Rate limit:**
1439
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
1112
1440
  *
1113
1441
  * @param request - SubmitIndexJobRequest
1114
1442
  * @returns SubmitIndexJobResponse
@@ -1151,17 +1479,18 @@ export default class Client extends OpenApi {
1151
1479
  */
1152
1480
  updateAndPublishAgentSelective(workspaceId: string, appCode: string, request: $_model.UpdateAndPublishAgentSelectiveRequest): Promise<$_model.UpdateAndPublishAgentSelectiveResponse>;
1153
1481
  /**
1154
- * Modifies the content and title of a specified text chunk in the knowledge base, and sets whether the chunk participates in knowledge base retrieval.
1482
+ * Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
1155
1483
  *
1156
1484
  * @remarks
1157
- * **Limits**: This operation supports only knowledge base of the document search type. Data query and image Q\\&A types are not supported.
1158
- * * **Required permissions**:
1159
- * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
1160
- * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
1161
- * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
1162
- * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
1163
- * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been updated, the interface returns a success.
1164
- * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
1485
+ * - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
1486
+ * - **Permission requirements**:
1487
+ * - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
1488
+ * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
1489
+ * - **Calling method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
1490
+ * - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
1491
+ * - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been updated, the operation returns a success response.
1492
+ * **Rate limit:**
1493
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
1165
1494
  *
1166
1495
  * @param request - UpdateChunkRequest
1167
1496
  * @param headers - map
@@ -1172,24 +1501,30 @@ export default class Client extends OpenApi {
1172
1501
  [key: string]: string;
1173
1502
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateChunkResponse>;
1174
1503
  /**
1175
- * Modifies the content and title of a specified text chunk in the knowledge base, and sets whether the chunk participates in knowledge base retrieval.
1504
+ * Modifies the content and title of a specified text chunk in a knowledge base, and specifies whether the chunk participates in knowledge base retrieval.
1176
1505
  *
1177
1506
  * @remarks
1178
- * **Limits**: This operation supports only knowledge base of the document search type. Data query and image Q\\&A types are not supported.
1179
- * * **Required permissions**:
1180
- * * **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
1181
- * * **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
1182
- * * **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
1183
- * * **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
1184
- * * **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been updated, the interface returns a success.
1185
- * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
1507
+ * - **Key limits**: This operation supports only document search knowledge bases. Data query and image Q&A knowledge bases are not supported.
1508
+ * - **Permission requirements**:
1509
+ * - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
1510
+ * - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
1511
+ * - **Calling method**: Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
1512
+ * - **Effective latency**: Updates typically take effect immediately. During peak hours, a slight delay (seconds) may occur.
1513
+ * - **Idempotence**: This operation is idempotent. If you repeat the operation on a text chunk that has already been updated, the operation returns a success response.
1514
+ * **Rate limit:**
1515
+ * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
1186
1516
  *
1187
1517
  * @param request - UpdateChunkRequest
1188
1518
  * @returns UpdateChunkResponse
1189
1519
  */
1190
1520
  updateChunk(WorkspaceId: string, request: $_model.UpdateChunkRequest): Promise<$_model.UpdateChunkResponse>;
1191
1521
  /**
1192
- * 编辑连接器
1522
+ * Updates a connector.
1523
+ *
1524
+ * @remarks
1525
+ * - A RAM user can call this operation only after they join a workspace and are granted the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (Bailian). The `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateConnector` permission, is required. An Alibaba Cloud account can call this operation directly. Use the latest version of the <props="china">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1526
+ * - This operation is not idempotent.
1527
+ * **Throttling:** If you call this operation too frequently, the system may throttle your requests. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
1193
1528
  *
1194
1529
  * @param request - UpdateConnectorRequest
1195
1530
  * @param headers - map
@@ -1200,14 +1535,23 @@ export default class Client extends OpenApi {
1200
1535
  [key: string]: string;
1201
1536
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateConnectorResponse>;
1202
1537
  /**
1203
- * 编辑连接器
1538
+ * Updates a connector.
1539
+ *
1540
+ * @remarks
1541
+ * - A RAM user can call this operation only after they join a workspace and are granted the required [API permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (Bailian). The `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateConnector` permission, is required. An Alibaba Cloud account can call this operation directly. Use the latest version of the <props="china">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio (Bailian) SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
1542
+ * - This operation is not idempotent.
1543
+ * **Throttling:** If you call this operation too frequently, the system may throttle your requests. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.
1204
1544
  *
1205
1545
  * @param request - UpdateConnectorRequest
1206
1546
  * @returns UpdateConnectorResponse
1207
1547
  */
1208
1548
  updateConnector(WorkspaceId: string, ConnectorId: string, request: $_model.UpdateConnectorRequest): Promise<$_model.UpdateConnectorResponse>;
1209
1549
  /**
1210
- * Updates the tags of a specified document.
1550
+ * Updates the tags for a specified file.
1551
+ *
1552
+ * @remarks
1553
+ * - A RAM User (sub-account) must be granted the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateFileTag` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (main 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.
1554
+ * **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
1211
1555
  *
1212
1556
  * @param tmpReq - UpdateFileTagRequest
1213
1557
  * @param headers - map
@@ -1218,14 +1562,24 @@ export default class Client extends OpenApi {
1218
1562
  [key: string]: string;
1219
1563
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateFileTagResponse>;
1220
1564
  /**
1221
- * Updates the tags of a specified document.
1565
+ * Updates the tags for a specified file.
1566
+ *
1567
+ * @remarks
1568
+ * - A RAM User (sub-account) must be granted the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateFileTag` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (main 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.
1569
+ * **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
1222
1570
  *
1223
1571
  * @param request - UpdateFileTagRequest
1224
1572
  * @returns UpdateFileTagResponse
1225
1573
  */
1226
1574
  updateFileTag(WorkspaceId: string, FileId: string, request: $_model.UpdateFileTagRequest): Promise<$_model.UpdateFileTagResponse>;
1227
1575
  /**
1228
- * \\<props="intl">Currently, this API is not supported.\\
1576
+ * Updates the configuration of a specified knowledge base.
1577
+ *
1578
+ * @remarks
1579
+ * <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
1580
+ * Before a RAM user can call this operation, the RAM user must have the `AliyunBailianDataFullAccess` permission for Alibaba Cloud Model Studio. For more information, see [Grant permissions](https://help.aliyun.com/document_detail/2848578.html). The RAM user must also be added to a workspace. For more information, see [Add a member to a workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this operation without authorization. Use the latest version of the Alibaba Cloud Model Studio SDK to call this operation. For more information, see [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29).
1581
+ * Before you call this operation, ensure that the knowledge base is created and has not been deleted. The knowledge base ID (`Id`) must be valid.
1582
+ * This operation is idempotent.
1229
1583
  *
1230
1584
  * @param request - UpdateIndexRequest
1231
1585
  * @param headers - map
@@ -1236,14 +1590,24 @@ export default class Client extends OpenApi {
1236
1590
  [key: string]: string;
1237
1591
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIndexResponse>;
1238
1592
  /**
1239
- * \\<props="intl">Currently, this API is not supported.\\
1593
+ * Updates the configuration of a specified knowledge base.
1594
+ *
1595
+ * @remarks
1596
+ * <props="intl">This operation is not available on the Alibaba Cloud International Website (www\\.alibabacloud.com).<props="china">
1597
+ * Before a RAM user can call this operation, the RAM user must have the `AliyunBailianDataFullAccess` permission for Alibaba Cloud Model Studio. For more information, see [Grant permissions](https://help.aliyun.com/document_detail/2848578.html). The RAM user must also be added to a workspace. For more information, see [Add a member to a workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this operation without authorization. Use the latest version of the Alibaba Cloud Model Studio SDK to call this operation. For more information, see [Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29).
1598
+ * Before you call this operation, ensure that the knowledge base is created and has not been deleted. The knowledge base ID (`Id`) must be valid.
1599
+ * This operation is idempotent.
1240
1600
  *
1241
1601
  * @param request - UpdateIndexRequest
1242
1602
  * @returns UpdateIndexResponse
1243
1603
  */
1244
1604
  updateIndex(WorkspaceId: string, request: $_model.UpdateIndexRequest): Promise<$_model.UpdateIndexResponse>;
1245
1605
  /**
1246
- * 更新memory
1606
+ * Updates the description of a specified long-term memory.
1607
+ *
1608
+ * @remarks
1609
+ * - This operation is idempotent.
1610
+ * **Rate limit:** Ensure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
1247
1611
  *
1248
1612
  * @param request - UpdateMemoryRequest
1249
1613
  * @param headers - map
@@ -1254,14 +1618,18 @@ export default class Client extends OpenApi {
1254
1618
  [key: string]: string;
1255
1619
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMemoryResponse>;
1256
1620
  /**
1257
- * 更新memory
1621
+ * Updates the description of a specified long-term memory.
1622
+ *
1623
+ * @remarks
1624
+ * - This operation is idempotent.
1625
+ * **Rate limit:** Ensure that the interval between two requests is at least 1 second. Otherwise, throttling may be triggered. If throttling occurs, retry later.
1258
1626
  *
1259
1627
  * @param request - UpdateMemoryRequest
1260
1628
  * @returns UpdateMemoryResponse
1261
1629
  */
1262
1630
  updateMemory(workspaceId: string, memoryId: string, request: $_model.UpdateMemoryRequest): Promise<$_model.UpdateMemoryResponse>;
1263
1631
  /**
1264
- * 更新记忆Node
1632
+ * Updates a memory fragment.
1265
1633
  *
1266
1634
  * @param request - UpdateMemoryNodeRequest
1267
1635
  * @param headers - map
@@ -1272,7 +1640,7 @@ export default class Client extends OpenApi {
1272
1640
  [key: string]: string;
1273
1641
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMemoryNodeResponse>;
1274
1642
  /**
1275
- * 更新记忆Node
1643
+ * Updates a memory fragment.
1276
1644
  *
1277
1645
  * @param request - UpdateMemoryNodeRequest
1278
1646
  * @returns UpdateMemoryNodeResponse
@@ -1297,7 +1665,15 @@ export default class Client extends OpenApi {
1297
1665
  */
1298
1666
  updatePromptTemplate(workspaceId: string, promptTemplateId: string, request: $_model.UpdatePromptTemplateRequest): Promise<$_model.UpdatePromptTemplateResponse>;
1299
1667
  /**
1300
- * 从oss上传table
1668
+ * Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
1669
+ *
1670
+ * @remarks
1671
+ * - Ensure that the OSS bucket belongs to the same Alibaba Cloud account as your Alibaba Cloud Model Studio instance. You must also complete the authorization steps described in [Configure data import from OSS](https://help.aliyun.com/document_detail/2782155.html).
1672
+ * - The bucket storage class must not be Archive, Cold Archive, or Deep Cold Archive. Buckets with server-side encryption are supported. public-read-write, public-read, and private buckets are also supported.
1673
+ * - If you use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html), you must add `*.console.aliyun.com` to the Referer whitelist. For more information, see [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
1674
+ * - Before a RAM user (sub-account) can call this operation, they must obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). The AliyunBailianDataFullAccess policy includes the required `sfm:UpdateTableFromAuthorizedOss` permission. An Alibaba Cloud account (root account) can call this operation directly without additional permissions. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) or <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
1675
+ * - This operation is not idempotent.
1676
+ * **Rate limiting:** This operation is subject to rate limiting. Do not call it more than five times per second. If you reach the limit, wait before you try again.
1301
1677
  *
1302
1678
  * @param request - UpdateTableFromAuthorizedOssRequest
1303
1679
  * @param headers - map
@@ -1308,7 +1684,15 @@ export default class Client extends OpenApi {
1308
1684
  [key: string]: string;
1309
1685
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTableFromAuthorizedOssResponse>;
1310
1686
  /**
1311
- * 从oss上传table
1687
+ * Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket.
1688
+ *
1689
+ * @remarks
1690
+ * - Ensure that the OSS bucket belongs to the same Alibaba Cloud account as your Alibaba Cloud Model Studio instance. You must also complete the authorization steps described in [Configure data import from OSS](https://help.aliyun.com/document_detail/2782155.html).
1691
+ * - The bucket storage class must not be Archive, Cold Archive, or Deep Cold Archive. Buckets with server-side encryption are supported. public-read-write, public-read, and private buckets are also supported.
1692
+ * - If you use a bucket with [Referer-based hotlink protection](https://help.aliyun.com/document_detail/2636937.html), you must add `*.console.aliyun.com` to the Referer whitelist. For more information, see [Allow access only from trusted websites](https://help.aliyun.com/document_detail/2636937.html).
1693
+ * - Before a RAM user (sub-account) can call this operation, they must obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio and [join a workspace](https://help.aliyun.com/document_detail/2851098.html). The AliyunBailianDataFullAccess policy includes the required `sfm:UpdateTableFromAuthorizedOss` permission. An Alibaba Cloud account (root account) can call this operation directly without additional permissions. We recommend that you use the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29) or <props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
1694
+ * - This operation is not idempotent.
1695
+ * **Rate limiting:** This operation is subject to rate limiting. Do not call it more than five times per second. If you reach the limit, wait before you try again.
1312
1696
  *
1313
1697
  * @param request - UpdateTableFromAuthorizedOssRequest
1314
1698
  * @returns UpdateTableFromAuthorizedOssResponse