@mistralai/mistralai 1.7.3 → 1.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (510) hide show
  1. package/README.md +60 -2
  2. package/docs/sdks/accesses/README.md +263 -0
  3. package/docs/sdks/audio/README.md +6 -0
  4. package/docs/sdks/documents/README.md +809 -0
  5. package/docs/sdks/libraries/README.md +395 -0
  6. package/docs/sdks/transcriptions/README.md +167 -0
  7. package/examples/src/async_audio_transcription_stream.ts +17 -0
  8. package/funcs/audioTranscriptionsComplete.d.ts +13 -0
  9. package/funcs/audioTranscriptionsComplete.d.ts.map +1 -0
  10. package/funcs/audioTranscriptionsComplete.js +133 -0
  11. package/funcs/audioTranscriptionsComplete.js.map +1 -0
  12. package/funcs/audioTranscriptionsStream.d.ts +14 -0
  13. package/funcs/audioTranscriptionsStream.d.ts.map +1 -0
  14. package/funcs/audioTranscriptionsStream.js +143 -0
  15. package/funcs/audioTranscriptionsStream.js.map +1 -0
  16. package/funcs/batchJobsList.js +1 -0
  17. package/funcs/batchJobsList.js.map +1 -1
  18. package/funcs/betaLibrariesAccessesDelete.d.ts +18 -0
  19. package/funcs/betaLibrariesAccessesDelete.d.ts.map +1 -0
  20. package/funcs/betaLibrariesAccessesDelete.js +113 -0
  21. package/funcs/betaLibrariesAccessesDelete.js.map +1 -0
  22. package/funcs/betaLibrariesAccessesList.d.ts +18 -0
  23. package/funcs/betaLibrariesAccessesList.d.ts.map +1 -0
  24. package/funcs/betaLibrariesAccessesList.js +112 -0
  25. package/funcs/betaLibrariesAccessesList.js.map +1 -0
  26. package/funcs/betaLibrariesAccessesUpdateOrCreate.d.ts +18 -0
  27. package/funcs/betaLibrariesAccessesUpdateOrCreate.d.ts.map +1 -0
  28. package/funcs/betaLibrariesAccessesUpdateOrCreate.js +113 -0
  29. package/funcs/betaLibrariesAccessesUpdateOrCreate.js.map +1 -0
  30. package/funcs/betaLibrariesCreate.d.ts +17 -0
  31. package/funcs/betaLibrariesCreate.d.ts.map +1 -0
  32. package/funcs/betaLibrariesCreate.js +106 -0
  33. package/funcs/betaLibrariesCreate.js.map +1 -0
  34. package/funcs/betaLibrariesDelete.d.ts +18 -0
  35. package/funcs/betaLibrariesDelete.d.ts.map +1 -0
  36. package/funcs/betaLibrariesDelete.js +112 -0
  37. package/funcs/betaLibrariesDelete.js.map +1 -0
  38. package/funcs/betaLibrariesDocumentsDelete.d.ts +17 -0
  39. package/funcs/betaLibrariesDocumentsDelete.d.ts.map +1 -0
  40. package/funcs/betaLibrariesDocumentsDelete.js +116 -0
  41. package/funcs/betaLibrariesDocumentsDelete.js.map +1 -0
  42. package/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.d.ts +17 -0
  43. package/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.d.ts.map +1 -0
  44. package/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js +118 -0
  45. package/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js.map +1 -0
  46. package/funcs/betaLibrariesDocumentsGet.d.ts +18 -0
  47. package/funcs/betaLibrariesDocumentsGet.d.ts.map +1 -0
  48. package/funcs/betaLibrariesDocumentsGet.js +116 -0
  49. package/funcs/betaLibrariesDocumentsGet.js.map +1 -0
  50. package/funcs/betaLibrariesDocumentsGetSignedUrl.d.ts +17 -0
  51. package/funcs/betaLibrariesDocumentsGetSignedUrl.d.ts.map +1 -0
  52. package/funcs/betaLibrariesDocumentsGetSignedUrl.js +116 -0
  53. package/funcs/betaLibrariesDocumentsGetSignedUrl.js.map +1 -0
  54. package/funcs/betaLibrariesDocumentsList.d.ts +18 -0
  55. package/funcs/betaLibrariesDocumentsList.d.ts.map +1 -0
  56. package/funcs/betaLibrariesDocumentsList.js +120 -0
  57. package/funcs/betaLibrariesDocumentsList.js.map +1 -0
  58. package/funcs/betaLibrariesDocumentsReprocess.d.ts +17 -0
  59. package/funcs/betaLibrariesDocumentsReprocess.d.ts.map +1 -0
  60. package/funcs/betaLibrariesDocumentsReprocess.js +116 -0
  61. package/funcs/betaLibrariesDocumentsReprocess.js.map +1 -0
  62. package/funcs/betaLibrariesDocumentsStatus.d.ts +18 -0
  63. package/funcs/betaLibrariesDocumentsStatus.d.ts.map +1 -0
  64. package/funcs/betaLibrariesDocumentsStatus.js +116 -0
  65. package/funcs/betaLibrariesDocumentsStatus.js.map +1 -0
  66. package/funcs/betaLibrariesDocumentsTextContent.d.ts +18 -0
  67. package/funcs/betaLibrariesDocumentsTextContent.d.ts.map +1 -0
  68. package/funcs/betaLibrariesDocumentsTextContent.js +116 -0
  69. package/funcs/betaLibrariesDocumentsTextContent.js.map +1 -0
  70. package/funcs/betaLibrariesDocumentsUpdate.d.ts +18 -0
  71. package/funcs/betaLibrariesDocumentsUpdate.d.ts.map +1 -0
  72. package/funcs/betaLibrariesDocumentsUpdate.js +117 -0
  73. package/funcs/betaLibrariesDocumentsUpdate.js.map +1 -0
  74. package/funcs/betaLibrariesDocumentsUpload.d.ts +18 -0
  75. package/funcs/betaLibrariesDocumentsUpload.d.ts.map +1 -0
  76. package/funcs/betaLibrariesDocumentsUpload.js +128 -0
  77. package/funcs/betaLibrariesDocumentsUpload.js.map +1 -0
  78. package/funcs/betaLibrariesGet.d.ts +18 -0
  79. package/funcs/betaLibrariesGet.d.ts.map +1 -0
  80. package/funcs/betaLibrariesGet.js +112 -0
  81. package/funcs/betaLibrariesGet.js.map +1 -0
  82. package/funcs/betaLibrariesList.d.ts +16 -0
  83. package/funcs/betaLibrariesList.d.ts.map +1 -0
  84. package/funcs/betaLibrariesList.js +92 -0
  85. package/funcs/betaLibrariesList.js.map +1 -0
  86. package/funcs/betaLibrariesUpdate.d.ts +18 -0
  87. package/funcs/betaLibrariesUpdate.d.ts.map +1 -0
  88. package/funcs/betaLibrariesUpdate.js +113 -0
  89. package/funcs/betaLibrariesUpdate.js.map +1 -0
  90. package/jsr.json +1 -1
  91. package/lib/config.d.ts +2 -2
  92. package/lib/config.js +2 -2
  93. package/models/components/audiochunk.d.ts +54 -0
  94. package/models/components/audiochunk.d.ts.map +1 -0
  95. package/models/components/audiochunk.js +88 -0
  96. package/models/components/audiochunk.js.map +1 -0
  97. package/models/components/audiotranscriptionrequest.d.ts +57 -0
  98. package/models/components/audiotranscriptionrequest.d.ts.map +1 -0
  99. package/models/components/audiotranscriptionrequest.js +91 -0
  100. package/models/components/audiotranscriptionrequest.js.map +1 -0
  101. package/models/components/audiotranscriptionrequeststream.d.ts +57 -0
  102. package/models/components/audiotranscriptionrequeststream.d.ts.map +1 -0
  103. package/models/components/audiotranscriptionrequeststream.js +91 -0
  104. package/models/components/audiotranscriptionrequeststream.js.map +1 -0
  105. package/models/components/basemodelcard.d.ts +23 -0
  106. package/models/components/basemodelcard.d.ts.map +1 -1
  107. package/models/components/basemodelcard.js +19 -1
  108. package/models/components/basemodelcard.js.map +1 -1
  109. package/models/components/batchjobin.d.ts +4 -2
  110. package/models/components/batchjobin.d.ts.map +1 -1
  111. package/models/components/batchjobin.js +6 -2
  112. package/models/components/batchjobin.js.map +1 -1
  113. package/models/components/batchjobout.d.ts +4 -2
  114. package/models/components/batchjobout.d.ts.map +1 -1
  115. package/models/components/batchjobout.js +6 -2
  116. package/models/components/batchjobout.js.map +1 -1
  117. package/models/components/classifierftmodelout.d.ts +4 -0
  118. package/models/components/classifierftmodelout.d.ts.map +1 -1
  119. package/models/components/classifierftmodelout.js +8 -0
  120. package/models/components/classifierftmodelout.js.map +1 -1
  121. package/models/components/completionargs.d.ts +2 -2
  122. package/models/components/completionargs.d.ts.map +1 -1
  123. package/models/components/completionargs.js +2 -2
  124. package/models/components/completionargs.js.map +1 -1
  125. package/models/components/completionftmodelout.d.ts +4 -0
  126. package/models/components/completionftmodelout.d.ts.map +1 -1
  127. package/models/components/completionftmodelout.js +8 -0
  128. package/models/components/completionftmodelout.js.map +1 -1
  129. package/models/components/contentchunk.d.ts +10 -0
  130. package/models/components/contentchunk.d.ts.map +1 -1
  131. package/models/components/contentchunk.js +14 -0
  132. package/models/components/contentchunk.js.map +1 -1
  133. package/models/components/conversationevents.d.ts +17 -8
  134. package/models/components/conversationevents.d.ts.map +1 -1
  135. package/models/components/conversationevents.js +19 -8
  136. package/models/components/conversationevents.js.map +1 -1
  137. package/models/components/conversationhistory.d.ts +4 -4
  138. package/models/components/conversationhistory.d.ts.map +1 -1
  139. package/models/components/conversationhistory.js +8 -8
  140. package/models/components/conversationhistory.js.map +1 -1
  141. package/models/components/documentout.d.ts +61 -0
  142. package/models/components/documentout.d.ts.map +1 -0
  143. package/models/components/documentout.js +121 -0
  144. package/models/components/documentout.js.map +1 -0
  145. package/models/components/documenttextcontent.d.ts +29 -0
  146. package/models/components/documenttextcontent.d.ts.map +1 -0
  147. package/models/components/documenttextcontent.js +59 -0
  148. package/models/components/documenttextcontent.js.map +1 -0
  149. package/models/components/documentupdatein.d.ts +29 -0
  150. package/models/components/documentupdatein.d.ts.map +1 -0
  151. package/models/components/documentupdatein.js +59 -0
  152. package/models/components/documentupdatein.js.map +1 -0
  153. package/models/components/entitytype.d.ts +29 -0
  154. package/models/components/entitytype.d.ts.map +1 -0
  155. package/models/components/entitytype.js +62 -0
  156. package/models/components/entitytype.js.map +1 -0
  157. package/models/components/file.d.ts +31 -0
  158. package/models/components/file.d.ts.map +1 -0
  159. package/models/components/file.js +72 -0
  160. package/models/components/file.js.map +1 -0
  161. package/models/components/fileschema.d.ts +4 -0
  162. package/models/components/fileschema.d.ts.map +1 -1
  163. package/models/components/fileschema.js +4 -0
  164. package/models/components/fileschema.js.map +1 -1
  165. package/models/components/ftmodelcard.d.ts +23 -0
  166. package/models/components/ftmodelcard.d.ts.map +1 -1
  167. package/models/components/ftmodelcard.js +19 -1
  168. package/models/components/ftmodelcard.js.map +1 -1
  169. package/models/components/index.d.ts +31 -0
  170. package/models/components/index.d.ts.map +1 -1
  171. package/models/components/index.js +31 -0
  172. package/models/components/index.js.map +1 -1
  173. package/models/components/inputentries.d.ts +2 -2
  174. package/models/components/inputentries.d.ts.map +1 -1
  175. package/models/components/inputentries.js +4 -4
  176. package/models/components/inputentries.js.map +1 -1
  177. package/models/components/libraryin.d.ts +33 -0
  178. package/models/components/libraryin.d.ts.map +1 -0
  179. package/models/components/libraryin.js +72 -0
  180. package/models/components/libraryin.js.map +1 -0
  181. package/models/components/libraryinupdate.d.ts +31 -0
  182. package/models/components/libraryinupdate.d.ts.map +1 -0
  183. package/models/components/libraryinupdate.js +61 -0
  184. package/models/components/libraryinupdate.js.map +1 -0
  185. package/models/components/libraryout.d.ts +59 -0
  186. package/models/components/libraryout.d.ts.map +1 -0
  187. package/models/components/libraryout.js +120 -0
  188. package/models/components/libraryout.js.map +1 -0
  189. package/models/components/listdocumentout.d.ts +33 -0
  190. package/models/components/listdocumentout.d.ts.map +1 -0
  191. package/models/components/listdocumentout.js +63 -0
  192. package/models/components/listdocumentout.js.map +1 -0
  193. package/models/components/listlibraryout.d.ts +30 -0
  194. package/models/components/listlibraryout.d.ts.map +1 -0
  195. package/models/components/listlibraryout.js +60 -0
  196. package/models/components/listlibraryout.js.map +1 -0
  197. package/models/components/listsharingout.d.ts +30 -0
  198. package/models/components/listsharingout.d.ts.map +1 -0
  199. package/models/components/listsharingout.js +60 -0
  200. package/models/components/listsharingout.js.map +1 -0
  201. package/models/components/messageinputentry.d.ts +10 -8
  202. package/models/components/messageinputentry.d.ts.map +1 -1
  203. package/models/components/messageinputentry.js +15 -13
  204. package/models/components/messageinputentry.js.map +1 -1
  205. package/models/components/paginationinfo.d.ts +37 -0
  206. package/models/components/paginationinfo.d.ts.map +1 -0
  207. package/models/components/paginationinfo.js +84 -0
  208. package/models/components/paginationinfo.js.map +1 -0
  209. package/models/components/processingstatusout.d.ts +31 -0
  210. package/models/components/processingstatusout.d.ts.map +1 -0
  211. package/models/components/processingstatusout.js +72 -0
  212. package/models/components/processingstatusout.js.map +1 -0
  213. package/models/components/retrievefileout.d.ts +4 -0
  214. package/models/components/retrievefileout.d.ts.map +1 -1
  215. package/models/components/retrievefileout.js +4 -0
  216. package/models/components/retrievefileout.js.map +1 -1
  217. package/models/components/shareenum.d.ts +22 -0
  218. package/models/components/shareenum.d.ts.map +1 -0
  219. package/models/components/shareenum.js +58 -0
  220. package/models/components/shareenum.js.map +1 -0
  221. package/models/components/sharingdelete.d.ts +40 -0
  222. package/models/components/sharingdelete.d.ts.map +1 -0
  223. package/models/components/sharingdelete.js +77 -0
  224. package/models/components/sharingdelete.js.map +1 -0
  225. package/models/components/sharingin.d.ts +43 -0
  226. package/models/components/sharingin.d.ts.map +1 -0
  227. package/models/components/sharingin.js +80 -0
  228. package/models/components/sharingin.js.map +1 -0
  229. package/models/components/sharingout.d.ts +39 -0
  230. package/models/components/sharingout.d.ts.map +1 -0
  231. package/models/components/sharingout.js +86 -0
  232. package/models/components/sharingout.js.map +1 -0
  233. package/models/components/ssetypes.d.ts +3 -0
  234. package/models/components/ssetypes.d.ts.map +1 -1
  235. package/models/components/ssetypes.js +1 -0
  236. package/models/components/ssetypes.js.map +1 -1
  237. package/models/components/thinkchunk.d.ts +82 -0
  238. package/models/components/thinkchunk.d.ts.map +1 -0
  239. package/models/components/thinkchunk.js +106 -0
  240. package/models/components/thinkchunk.js.map +1 -0
  241. package/models/components/timestampgranularity.d.ts +25 -0
  242. package/models/components/timestampgranularity.d.ts.map +1 -0
  243. package/models/components/timestampgranularity.js +49 -0
  244. package/models/components/timestampgranularity.js.map +1 -0
  245. package/models/components/toolcall.d.ts +23 -0
  246. package/models/components/toolcall.d.ts.map +1 -1
  247. package/models/components/toolcall.js +26 -1
  248. package/models/components/toolcall.js.map +1 -1
  249. package/models/components/toolexecutiondeltaevent.d.ts +63 -0
  250. package/models/components/toolexecutiondeltaevent.d.ts.map +1 -0
  251. package/models/components/toolexecutiondeltaevent.js +100 -0
  252. package/models/components/toolexecutiondeltaevent.js.map +1 -0
  253. package/models/components/toolexecutionentry.d.ts +2 -0
  254. package/models/components/toolexecutionentry.d.ts.map +1 -1
  255. package/models/components/toolexecutionentry.js +2 -0
  256. package/models/components/toolexecutionentry.js.map +1 -1
  257. package/models/components/toolexecutionstartedevent.d.ts +2 -0
  258. package/models/components/toolexecutionstartedevent.d.ts.map +1 -1
  259. package/models/components/toolexecutionstartedevent.js +2 -0
  260. package/models/components/toolexecutionstartedevent.js.map +1 -1
  261. package/models/components/toolreferencechunk.d.ts +4 -2
  262. package/models/components/toolreferencechunk.d.ts.map +1 -1
  263. package/models/components/toolreferencechunk.js +4 -2
  264. package/models/components/toolreferencechunk.js.map +1 -1
  265. package/models/components/transcriptionresponse.d.ts +43 -0
  266. package/models/components/transcriptionresponse.d.ts.map +1 -0
  267. package/models/components/transcriptionresponse.js +78 -0
  268. package/models/components/transcriptionresponse.js.map +1 -0
  269. package/models/components/transcriptionsegmentchunk.d.ts +62 -0
  270. package/models/components/transcriptionsegmentchunk.d.ts.map +1 -0
  271. package/models/components/transcriptionsegmentchunk.js +92 -0
  272. package/models/components/transcriptionsegmentchunk.js.map +1 -0
  273. package/models/components/transcriptionstreamdone.d.ts +68 -0
  274. package/models/components/transcriptionstreamdone.d.ts.map +1 -0
  275. package/models/components/transcriptionstreamdone.js +98 -0
  276. package/models/components/transcriptionstreamdone.js.map +1 -0
  277. package/models/components/transcriptionstreamevents.d.ts +89 -0
  278. package/models/components/transcriptionstreamevents.d.ts.map +1 -0
  279. package/models/components/transcriptionstreamevents.js +138 -0
  280. package/models/components/transcriptionstreamevents.js.map +1 -0
  281. package/models/components/transcriptionstreameventtypes.d.ts +34 -0
  282. package/models/components/transcriptionstreameventtypes.d.ts.map +1 -0
  283. package/models/components/transcriptionstreameventtypes.js +52 -0
  284. package/models/components/transcriptionstreameventtypes.js.map +1 -0
  285. package/models/components/transcriptionstreamlanguage.d.ts +58 -0
  286. package/models/components/transcriptionstreamlanguage.d.ts.map +1 -0
  287. package/models/components/transcriptionstreamlanguage.js +93 -0
  288. package/models/components/transcriptionstreamlanguage.js.map +1 -0
  289. package/models/components/transcriptionstreamsegmentdelta.d.ts +62 -0
  290. package/models/components/transcriptionstreamsegmentdelta.d.ts.map +1 -0
  291. package/models/components/transcriptionstreamsegmentdelta.js +92 -0
  292. package/models/components/transcriptionstreamsegmentdelta.js.map +1 -0
  293. package/models/components/transcriptionstreamtextdelta.d.ts +58 -0
  294. package/models/components/transcriptionstreamtextdelta.d.ts.map +1 -0
  295. package/models/components/transcriptionstreamtextdelta.js +88 -0
  296. package/models/components/transcriptionstreamtextdelta.js.map +1 -0
  297. package/models/components/uploadfileout.d.ts +4 -0
  298. package/models/components/uploadfileout.d.ts.map +1 -1
  299. package/models/components/uploadfileout.js +4 -0
  300. package/models/components/uploadfileout.js.map +1 -1
  301. package/models/components/usageinfo.d.ts +9 -3
  302. package/models/components/usageinfo.d.ts.map +1 -1
  303. package/models/components/usageinfo.js +22 -13
  304. package/models/components/usageinfo.js.map +1 -1
  305. package/models/operations/filesapiroutesuploadfile.d.ts +2 -29
  306. package/models/operations/filesapiroutesuploadfile.d.ts.map +1 -1
  307. package/models/operations/filesapiroutesuploadfile.js +3 -43
  308. package/models/operations/filesapiroutesuploadfile.js.map +1 -1
  309. package/models/operations/index.d.ts +16 -0
  310. package/models/operations/index.d.ts.map +1 -1
  311. package/models/operations/index.js +16 -0
  312. package/models/operations/index.js.map +1 -1
  313. package/models/operations/jobsapiroutesbatchgetbatchjobs.d.ts +2 -0
  314. package/models/operations/jobsapiroutesbatchgetbatchjobs.d.ts.map +1 -1
  315. package/models/operations/jobsapiroutesbatchgetbatchjobs.js +4 -0
  316. package/models/operations/jobsapiroutesbatchgetbatchjobs.js.map +1 -1
  317. package/models/operations/librariesdeletev1.d.ts +29 -0
  318. package/models/operations/librariesdeletev1.d.ts.map +1 -0
  319. package/models/operations/librariesdeletev1.js +68 -0
  320. package/models/operations/librariesdeletev1.js.map +1 -0
  321. package/models/operations/librariesdocumentsdeletev1.d.ts +31 -0
  322. package/models/operations/librariesdocumentsdeletev1.d.ts.map +1 -0
  323. package/models/operations/librariesdocumentsdeletev1.js +72 -0
  324. package/models/operations/librariesdocumentsdeletev1.js.map +1 -0
  325. package/models/operations/librariesdocumentsgetextractedtextsignedurlv1.d.ts +31 -0
  326. package/models/operations/librariesdocumentsgetextractedtextsignedurlv1.d.ts.map +1 -0
  327. package/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js +72 -0
  328. package/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js.map +1 -0
  329. package/models/operations/librariesdocumentsgetsignedurlv1.d.ts +31 -0
  330. package/models/operations/librariesdocumentsgetsignedurlv1.d.ts.map +1 -0
  331. package/models/operations/librariesdocumentsgetsignedurlv1.js +72 -0
  332. package/models/operations/librariesdocumentsgetsignedurlv1.js.map +1 -0
  333. package/models/operations/librariesdocumentsgetstatusv1.d.ts +31 -0
  334. package/models/operations/librariesdocumentsgetstatusv1.d.ts.map +1 -0
  335. package/models/operations/librariesdocumentsgetstatusv1.js +72 -0
  336. package/models/operations/librariesdocumentsgetstatusv1.js.map +1 -0
  337. package/models/operations/librariesdocumentsgettextcontentv1.d.ts +31 -0
  338. package/models/operations/librariesdocumentsgettextcontentv1.d.ts.map +1 -0
  339. package/models/operations/librariesdocumentsgettextcontentv1.js +72 -0
  340. package/models/operations/librariesdocumentsgettextcontentv1.js.map +1 -0
  341. package/models/operations/librariesdocumentsgetv1.d.ts +31 -0
  342. package/models/operations/librariesdocumentsgetv1.d.ts.map +1 -0
  343. package/models/operations/librariesdocumentsgetv1.js +72 -0
  344. package/models/operations/librariesdocumentsgetv1.js.map +1 -0
  345. package/models/operations/librariesdocumentslistv1.d.ts +39 -0
  346. package/models/operations/librariesdocumentslistv1.d.ts.map +1 -0
  347. package/models/operations/librariesdocumentslistv1.js +84 -0
  348. package/models/operations/librariesdocumentslistv1.js.map +1 -0
  349. package/models/operations/librariesdocumentsreprocessv1.d.ts +31 -0
  350. package/models/operations/librariesdocumentsreprocessv1.d.ts.map +1 -0
  351. package/models/operations/librariesdocumentsreprocessv1.js +72 -0
  352. package/models/operations/librariesdocumentsreprocessv1.js.map +1 -0
  353. package/models/operations/librariesdocumentsupdatev1.d.ts +34 -0
  354. package/models/operations/librariesdocumentsupdatev1.d.ts.map +1 -0
  355. package/models/operations/librariesdocumentsupdatev1.js +77 -0
  356. package/models/operations/librariesdocumentsupdatev1.js.map +1 -0
  357. package/models/operations/librariesdocumentsuploadv1.d.ts +70 -0
  358. package/models/operations/librariesdocumentsuploadv1.d.ts.map +1 -0
  359. package/models/operations/librariesdocumentsuploadv1.js +101 -0
  360. package/models/operations/librariesdocumentsuploadv1.js.map +1 -0
  361. package/models/operations/librariesgetv1.d.ts +29 -0
  362. package/models/operations/librariesgetv1.d.ts.map +1 -0
  363. package/models/operations/librariesgetv1.js +68 -0
  364. package/models/operations/librariesgetv1.js.map +1 -0
  365. package/models/operations/librariessharecreatev1.d.ts +32 -0
  366. package/models/operations/librariessharecreatev1.d.ts.map +1 -0
  367. package/models/operations/librariessharecreatev1.js +73 -0
  368. package/models/operations/librariessharecreatev1.js.map +1 -0
  369. package/models/operations/librariessharedeletev1.d.ts +32 -0
  370. package/models/operations/librariessharedeletev1.d.ts.map +1 -0
  371. package/models/operations/librariessharedeletev1.js +73 -0
  372. package/models/operations/librariessharedeletev1.js.map +1 -0
  373. package/models/operations/librariessharelistv1.d.ts +29 -0
  374. package/models/operations/librariessharelistv1.d.ts.map +1 -0
  375. package/models/operations/librariessharelistv1.js +68 -0
  376. package/models/operations/librariessharelistv1.js.map +1 -0
  377. package/models/operations/librariesupdatev1.d.ts +32 -0
  378. package/models/operations/librariesupdatev1.d.ts.map +1 -0
  379. package/models/operations/librariesupdatev1.js +73 -0
  380. package/models/operations/librariesupdatev1.js.map +1 -0
  381. package/package.json +1 -1
  382. package/sdk/accesses.d.ts +27 -0
  383. package/sdk/accesses.d.ts.map +1 -0
  384. package/sdk/accesses.js +42 -0
  385. package/sdk/accesses.js.map +1 -0
  386. package/sdk/audio.d.ts +7 -0
  387. package/sdk/audio.d.ts.map +1 -0
  388. package/sdk/audio.js +15 -0
  389. package/sdk/audio.js.map +1 -0
  390. package/sdk/beta.d.ts +3 -0
  391. package/sdk/beta.d.ts.map +1 -1
  392. package/sdk/beta.js +4 -0
  393. package/sdk/beta.js.map +1 -1
  394. package/sdk/documents.d.ts +76 -0
  395. package/sdk/documents.d.ts.map +1 -0
  396. package/sdk/documents.js +112 -0
  397. package/sdk/documents.js.map +1 -0
  398. package/sdk/libraries.d.ts +47 -0
  399. package/sdk/libraries.d.ts.map +1 -0
  400. package/sdk/libraries.js +70 -0
  401. package/sdk/libraries.js.map +1 -0
  402. package/sdk/sdk.d.ts +3 -0
  403. package/sdk/sdk.d.ts.map +1 -1
  404. package/sdk/sdk.js +4 -0
  405. package/sdk/sdk.js.map +1 -1
  406. package/sdk/transcriptions.d.ts +14 -0
  407. package/sdk/transcriptions.d.ts.map +1 -0
  408. package/sdk/transcriptions.js +26 -0
  409. package/sdk/transcriptions.js.map +1 -0
  410. package/src/funcs/audioTranscriptionsComplete.ts +193 -0
  411. package/src/funcs/audioTranscriptionsStream.ts +207 -0
  412. package/src/funcs/batchJobsList.ts +1 -0
  413. package/src/funcs/betaLibrariesAccessesDelete.ts +172 -0
  414. package/src/funcs/betaLibrariesAccessesList.ts +171 -0
  415. package/src/funcs/betaLibrariesAccessesUpdateOrCreate.ts +172 -0
  416. package/src/funcs/betaLibrariesCreate.ts +163 -0
  417. package/src/funcs/betaLibrariesDelete.ts +170 -0
  418. package/src/funcs/betaLibrariesDocumentsDelete.ts +177 -0
  419. package/src/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.ts +179 -0
  420. package/src/funcs/betaLibrariesDocumentsGet.ts +177 -0
  421. package/src/funcs/betaLibrariesDocumentsGetSignedUrl.ts +179 -0
  422. package/src/funcs/betaLibrariesDocumentsList.ts +180 -0
  423. package/src/funcs/betaLibrariesDocumentsReprocess.ts +179 -0
  424. package/src/funcs/betaLibrariesDocumentsStatus.ts +179 -0
  425. package/src/funcs/betaLibrariesDocumentsTextContent.ts +179 -0
  426. package/src/funcs/betaLibrariesDocumentsUpdate.ts +178 -0
  427. package/src/funcs/betaLibrariesDocumentsUpload.ts +193 -0
  428. package/src/funcs/betaLibrariesGet.ts +170 -0
  429. package/src/funcs/betaLibrariesList.ts +136 -0
  430. package/src/funcs/betaLibrariesUpdate.ts +171 -0
  431. package/src/lib/config.ts +2 -2
  432. package/src/models/components/audiochunk.ts +102 -0
  433. package/src/models/components/audiotranscriptionrequest.ts +133 -0
  434. package/src/models/components/audiotranscriptionrequeststream.ts +135 -0
  435. package/src/models/components/basemodelcard.ts +28 -1
  436. package/src/models/components/batchjobin.ts +10 -4
  437. package/src/models/components/batchjobout.ts +10 -4
  438. package/src/models/components/classifierftmodelout.ts +12 -0
  439. package/src/models/components/completionargs.ts +4 -4
  440. package/src/models/components/completionftmodelout.ts +12 -0
  441. package/src/models/components/contentchunk.ts +38 -2
  442. package/src/models/components/conversationevents.ts +54 -24
  443. package/src/models/components/conversationhistory.ts +16 -16
  444. package/src/models/components/documentout.ts +158 -0
  445. package/src/models/components/documenttextcontent.ts +66 -0
  446. package/src/models/components/documentupdatein.ts +66 -0
  447. package/src/models/components/entitytype.ts +55 -0
  448. package/src/models/components/file.ts +73 -0
  449. package/src/models/components/fileschema.ts +8 -0
  450. package/src/models/components/ftmodelcard.ts +28 -1
  451. package/src/models/components/index.ts +31 -0
  452. package/src/models/components/inputentries.ts +8 -8
  453. package/src/models/components/libraryin.ts +79 -0
  454. package/src/models/components/libraryinupdate.ts +68 -0
  455. package/src/models/components/libraryout.ts +153 -0
  456. package/src/models/components/listdocumentout.ts +80 -0
  457. package/src/models/components/listlibraryout.ts +68 -0
  458. package/src/models/components/listsharingout.ts +68 -0
  459. package/src/models/components/messageinputentry.ts +20 -15
  460. package/src/models/components/paginationinfo.ts +95 -0
  461. package/src/models/components/processingstatusout.ts +81 -0
  462. package/src/models/components/retrievefileout.ts +8 -0
  463. package/src/models/components/shareenum.ts +48 -0
  464. package/src/models/components/sharingdelete.ts +94 -0
  465. package/src/models/components/sharingin.ts +103 -0
  466. package/src/models/components/sharingout.ts +99 -0
  467. package/src/models/components/ssetypes.ts +1 -0
  468. package/src/models/components/thinkchunk.ts +162 -0
  469. package/src/models/components/timestampgranularity.ts +32 -0
  470. package/src/models/components/toolcall.ts +50 -0
  471. package/src/models/components/toolexecutiondeltaevent.ts +136 -0
  472. package/src/models/components/toolexecutionentry.ts +4 -0
  473. package/src/models/components/toolexecutionstartedevent.ts +4 -0
  474. package/src/models/components/toolreferencechunk.ts +8 -4
  475. package/src/models/components/transcriptionresponse.ts +112 -0
  476. package/src/models/components/transcriptionsegmentchunk.ts +122 -0
  477. package/src/models/components/transcriptionstreamdone.ts +149 -0
  478. package/src/models/components/transcriptionstreamevents.ts +273 -0
  479. package/src/models/components/transcriptionstreameventtypes.ts +37 -0
  480. package/src/models/components/transcriptionstreamlanguage.ts +128 -0
  481. package/src/models/components/transcriptionstreamsegmentdelta.ts +133 -0
  482. package/src/models/components/transcriptionstreamtextdelta.ts +123 -0
  483. package/src/models/components/uploadfileout.ts +8 -0
  484. package/src/models/components/usageinfo.ts +37 -17
  485. package/src/models/operations/filesapiroutesuploadfile.ts +4 -69
  486. package/src/models/operations/index.ts +16 -0
  487. package/src/models/operations/jobsapiroutesbatchgetbatchjobs.ts +6 -0
  488. package/src/models/operations/librariesdeletev1.ts +75 -0
  489. package/src/models/operations/librariesdocumentsdeletev1.ts +84 -0
  490. package/src/models/operations/librariesdocumentsgetextractedtextsignedurlv1.ts +95 -0
  491. package/src/models/operations/librariesdocumentsgetsignedurlv1.ts +92 -0
  492. package/src/models/operations/librariesdocumentsgetstatusv1.ts +86 -0
  493. package/src/models/operations/librariesdocumentsgettextcontentv1.ts +93 -0
  494. package/src/models/operations/librariesdocumentsgetv1.ts +83 -0
  495. package/src/models/operations/librariesdocumentslistv1.ts +103 -0
  496. package/src/models/operations/librariesdocumentsreprocessv1.ts +86 -0
  497. package/src/models/operations/librariesdocumentsupdatev1.ts +91 -0
  498. package/src/models/operations/librariesdocumentsuploadv1.ts +172 -0
  499. package/src/models/operations/librariesgetv1.ts +75 -0
  500. package/src/models/operations/librariessharecreatev1.ts +84 -0
  501. package/src/models/operations/librariessharedeletev1.ts +84 -0
  502. package/src/models/operations/librariessharelistv1.ts +77 -0
  503. package/src/models/operations/librariesupdatev1.ts +82 -0
  504. package/src/sdk/accesses.ts +64 -0
  505. package/src/sdk/audio.ts +13 -0
  506. package/src/sdk/beta.ts +6 -0
  507. package/src/sdk/documents.ts +190 -0
  508. package/src/sdk/libraries.ts +110 -0
  509. package/src/sdk/sdk.ts +6 -0
  510. package/src/sdk/transcriptions.ts +40 -0
@@ -0,0 +1,809 @@
1
+ # Documents
2
+ (*beta.libraries.documents*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [list](#list) - List document in a given library.
9
+ * [upload](#upload) - Upload a new document.
10
+ * [get](#get) - Retrieve the metadata of a specific document.
11
+ * [update](#update) - Update the metadata of a specific document.
12
+ * [delete](#delete) - Delete a document.
13
+ * [textContent](#textcontent) - Retrieve the text content of a specific document.
14
+ * [status](#status) - Retrieve the processing status of a specific document.
15
+ * [getSignedUrl](#getsignedurl) - Retrieve the signed URL of a specific document.
16
+ * [extractedTextSignedUrl](#extractedtextsignedurl) - Retrieve the signed URL of text extracted from a given document.
17
+ * [reprocess](#reprocess) - Reprocess a document.
18
+
19
+ ## list
20
+
21
+ Given a library, lists the document that have been uploaded to that library.
22
+
23
+ ### Example Usage
24
+
25
+ ```typescript
26
+ import { Mistral } from "@mistralai/mistralai";
27
+
28
+ const mistral = new Mistral({
29
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
30
+ });
31
+
32
+ async function run() {
33
+ const result = await mistral.beta.libraries.documents.list({
34
+ libraryId: "c8a232aa-0b11-4b8a-b005-71e9e705d0e6",
35
+ });
36
+
37
+ // Handle the result
38
+ console.log(result);
39
+ }
40
+
41
+ run();
42
+ ```
43
+
44
+ ### Standalone function
45
+
46
+ The standalone function version of this method:
47
+
48
+ ```typescript
49
+ import { MistralCore } from "@mistralai/mistralai/core.js";
50
+ import { betaLibrariesDocumentsList } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js";
51
+
52
+ // Use `MistralCore` for best tree-shaking performance.
53
+ // You can create one instance of it to use across an application.
54
+ const mistral = new MistralCore({
55
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
56
+ });
57
+
58
+ async function run() {
59
+ const res = await betaLibrariesDocumentsList(mistral, {
60
+ libraryId: "c8a232aa-0b11-4b8a-b005-71e9e705d0e6",
61
+ });
62
+
63
+ if (!res.ok) {
64
+ throw res.error;
65
+ }
66
+
67
+ const { value: result } = res;
68
+
69
+ // Handle the result
70
+ console.log(result);
71
+ }
72
+
73
+ run();
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Parameter | Type | Required | Description |
79
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
80
+ | `request` | [operations.LibrariesDocumentsListV1Request](../../models/operations/librariesdocumentslistv1request.md) | :heavy_check_mark: | The request object to use for the request. |
81
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
82
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
83
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
84
+
85
+ ### Response
86
+
87
+ **Promise\<[components.ListDocumentOut](../../models/components/listdocumentout.md)\>**
88
+
89
+ ### Errors
90
+
91
+ | Error Type | Status Code | Content Type |
92
+ | -------------------------- | -------------------------- | -------------------------- |
93
+ | errors.HTTPValidationError | 422 | application/json |
94
+ | errors.SDKError | 4XX, 5XX | \*/\* |
95
+
96
+ ## upload
97
+
98
+ Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search
99
+
100
+ ### Example Usage
101
+
102
+ ```typescript
103
+ import { Mistral } from "@mistralai/mistralai";
104
+ import { openAsBlob } from "node:fs";
105
+
106
+ const mistral = new Mistral({
107
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
108
+ });
109
+
110
+ async function run() {
111
+ const result = await mistral.beta.libraries.documents.upload({
112
+ libraryId: "6886a454-7910-4a2b-b98a-ab61ec65fc41",
113
+ requestBody: {
114
+ file: await openAsBlob("example.file"),
115
+ },
116
+ });
117
+
118
+ // Handle the result
119
+ console.log(result);
120
+ }
121
+
122
+ run();
123
+ ```
124
+
125
+ ### Standalone function
126
+
127
+ The standalone function version of this method:
128
+
129
+ ```typescript
130
+ import { MistralCore } from "@mistralai/mistralai/core.js";
131
+ import { betaLibrariesDocumentsUpload } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js";
132
+ import { openAsBlob } from "node:fs";
133
+
134
+ // Use `MistralCore` for best tree-shaking performance.
135
+ // You can create one instance of it to use across an application.
136
+ const mistral = new MistralCore({
137
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
138
+ });
139
+
140
+ async function run() {
141
+ const res = await betaLibrariesDocumentsUpload(mistral, {
142
+ libraryId: "6886a454-7910-4a2b-b98a-ab61ec65fc41",
143
+ requestBody: {
144
+ file: await openAsBlob("example.file"),
145
+ },
146
+ });
147
+
148
+ if (!res.ok) {
149
+ throw res.error;
150
+ }
151
+
152
+ const { value: result } = res;
153
+
154
+ // Handle the result
155
+ console.log(result);
156
+ }
157
+
158
+ run();
159
+ ```
160
+
161
+ ### Parameters
162
+
163
+ | Parameter | Type | Required | Description |
164
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
165
+ | `request` | [operations.LibrariesDocumentsUploadV1Request](../../models/operations/librariesdocumentsuploadv1request.md) | :heavy_check_mark: | The request object to use for the request. |
166
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
167
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
168
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
169
+
170
+ ### Response
171
+
172
+ **Promise\<[components.DocumentOut](../../models/components/documentout.md)\>**
173
+
174
+ ### Errors
175
+
176
+ | Error Type | Status Code | Content Type |
177
+ | -------------------------- | -------------------------- | -------------------------- |
178
+ | errors.HTTPValidationError | 422 | application/json |
179
+ | errors.SDKError | 4XX, 5XX | \*/\* |
180
+
181
+ ## get
182
+
183
+ Given a library and a document in this library, you can retrieve the metadata of that document.
184
+
185
+ ### Example Usage
186
+
187
+ ```typescript
188
+ import { Mistral } from "@mistralai/mistralai";
189
+
190
+ const mistral = new Mistral({
191
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
192
+ });
193
+
194
+ async function run() {
195
+ const result = await mistral.beta.libraries.documents.get({
196
+ libraryId: "b888f774-3e7c-4135-a18c-6b985523c4bc",
197
+ documentId: "e50f7622-81da-484b-9c66-1c8a99c6b71b",
198
+ });
199
+
200
+ // Handle the result
201
+ console.log(result);
202
+ }
203
+
204
+ run();
205
+ ```
206
+
207
+ ### Standalone function
208
+
209
+ The standalone function version of this method:
210
+
211
+ ```typescript
212
+ import { MistralCore } from "@mistralai/mistralai/core.js";
213
+ import { betaLibrariesDocumentsGet } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js";
214
+
215
+ // Use `MistralCore` for best tree-shaking performance.
216
+ // You can create one instance of it to use across an application.
217
+ const mistral = new MistralCore({
218
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
219
+ });
220
+
221
+ async function run() {
222
+ const res = await betaLibrariesDocumentsGet(mistral, {
223
+ libraryId: "b888f774-3e7c-4135-a18c-6b985523c4bc",
224
+ documentId: "e50f7622-81da-484b-9c66-1c8a99c6b71b",
225
+ });
226
+
227
+ if (!res.ok) {
228
+ throw res.error;
229
+ }
230
+
231
+ const { value: result } = res;
232
+
233
+ // Handle the result
234
+ console.log(result);
235
+ }
236
+
237
+ run();
238
+ ```
239
+
240
+ ### Parameters
241
+
242
+ | Parameter | Type | Required | Description |
243
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
244
+ | `request` | [operations.LibrariesDocumentsGetV1Request](../../models/operations/librariesdocumentsgetv1request.md) | :heavy_check_mark: | The request object to use for the request. |
245
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
246
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
247
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
248
+
249
+ ### Response
250
+
251
+ **Promise\<[components.DocumentOut](../../models/components/documentout.md)\>**
252
+
253
+ ### Errors
254
+
255
+ | Error Type | Status Code | Content Type |
256
+ | -------------------------- | -------------------------- | -------------------------- |
257
+ | errors.HTTPValidationError | 422 | application/json |
258
+ | errors.SDKError | 4XX, 5XX | \*/\* |
259
+
260
+ ## update
261
+
262
+ Given a library and a document in that library, update the name of that document.
263
+
264
+ ### Example Usage
265
+
266
+ ```typescript
267
+ import { Mistral } from "@mistralai/mistralai";
268
+
269
+ const mistral = new Mistral({
270
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
271
+ });
272
+
273
+ async function run() {
274
+ const result = await mistral.beta.libraries.documents.update({
275
+ libraryId: "d95fa7f0-e743-42ce-b47c-b60cc78135dd",
276
+ documentId: "b85898c1-25a1-4907-a1c5-562af6646dad",
277
+ documentUpdateIn: {},
278
+ });
279
+
280
+ // Handle the result
281
+ console.log(result);
282
+ }
283
+
284
+ run();
285
+ ```
286
+
287
+ ### Standalone function
288
+
289
+ The standalone function version of this method:
290
+
291
+ ```typescript
292
+ import { MistralCore } from "@mistralai/mistralai/core.js";
293
+ import { betaLibrariesDocumentsUpdate } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js";
294
+
295
+ // Use `MistralCore` for best tree-shaking performance.
296
+ // You can create one instance of it to use across an application.
297
+ const mistral = new MistralCore({
298
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
299
+ });
300
+
301
+ async function run() {
302
+ const res = await betaLibrariesDocumentsUpdate(mistral, {
303
+ libraryId: "d95fa7f0-e743-42ce-b47c-b60cc78135dd",
304
+ documentId: "b85898c1-25a1-4907-a1c5-562af6646dad",
305
+ documentUpdateIn: {},
306
+ });
307
+
308
+ if (!res.ok) {
309
+ throw res.error;
310
+ }
311
+
312
+ const { value: result } = res;
313
+
314
+ // Handle the result
315
+ console.log(result);
316
+ }
317
+
318
+ run();
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ | Parameter | Type | Required | Description |
324
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
325
+ | `request` | [operations.LibrariesDocumentsUpdateV1Request](../../models/operations/librariesdocumentsupdatev1request.md) | :heavy_check_mark: | The request object to use for the request. |
326
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
327
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
328
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
329
+
330
+ ### Response
331
+
332
+ **Promise\<[components.DocumentOut](../../models/components/documentout.md)\>**
333
+
334
+ ### Errors
335
+
336
+ | Error Type | Status Code | Content Type |
337
+ | -------------------------- | -------------------------- | -------------------------- |
338
+ | errors.HTTPValidationError | 422 | application/json |
339
+ | errors.SDKError | 4XX, 5XX | \*/\* |
340
+
341
+ ## delete
342
+
343
+ Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index.
344
+
345
+ ### Example Usage
346
+
347
+ ```typescript
348
+ import { Mistral } from "@mistralai/mistralai";
349
+
350
+ const mistral = new Mistral({
351
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
352
+ });
353
+
354
+ async function run() {
355
+ await mistral.beta.libraries.documents.delete({
356
+ libraryId: "8b6fe91a-a0b1-4b3e-ab7b-e83a32f2399e",
357
+ documentId: "7aa10743-a04f-44af-84fe-b54259caa1ba",
358
+ });
359
+
360
+
361
+ }
362
+
363
+ run();
364
+ ```
365
+
366
+ ### Standalone function
367
+
368
+ The standalone function version of this method:
369
+
370
+ ```typescript
371
+ import { MistralCore } from "@mistralai/mistralai/core.js";
372
+ import { betaLibrariesDocumentsDelete } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js";
373
+
374
+ // Use `MistralCore` for best tree-shaking performance.
375
+ // You can create one instance of it to use across an application.
376
+ const mistral = new MistralCore({
377
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
378
+ });
379
+
380
+ async function run() {
381
+ const res = await betaLibrariesDocumentsDelete(mistral, {
382
+ libraryId: "8b6fe91a-a0b1-4b3e-ab7b-e83a32f2399e",
383
+ documentId: "7aa10743-a04f-44af-84fe-b54259caa1ba",
384
+ });
385
+
386
+ if (!res.ok) {
387
+ throw res.error;
388
+ }
389
+
390
+ const { value: result } = res;
391
+
392
+
393
+ }
394
+
395
+ run();
396
+ ```
397
+
398
+ ### Parameters
399
+
400
+ | Parameter | Type | Required | Description |
401
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
402
+ | `request` | [operations.LibrariesDocumentsDeleteV1Request](../../models/operations/librariesdocumentsdeletev1request.md) | :heavy_check_mark: | The request object to use for the request. |
403
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
404
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
405
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
406
+
407
+ ### Response
408
+
409
+ **Promise\<void\>**
410
+
411
+ ### Errors
412
+
413
+ | Error Type | Status Code | Content Type |
414
+ | -------------------------- | -------------------------- | -------------------------- |
415
+ | errors.HTTPValidationError | 422 | application/json |
416
+ | errors.SDKError | 4XX, 5XX | \*/\* |
417
+
418
+ ## textContent
419
+
420
+ Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR.
421
+
422
+ ### Example Usage
423
+
424
+ ```typescript
425
+ import { Mistral } from "@mistralai/mistralai";
426
+
427
+ const mistral = new Mistral({
428
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
429
+ });
430
+
431
+ async function run() {
432
+ const result = await mistral.beta.libraries.documents.textContent({
433
+ libraryId: "ccb1b572-71d2-46fc-bb41-5dbd65167579",
434
+ documentId: "40825d2b-5bb4-4bda-9c77-1302c2bf5ce0",
435
+ });
436
+
437
+ // Handle the result
438
+ console.log(result);
439
+ }
440
+
441
+ run();
442
+ ```
443
+
444
+ ### Standalone function
445
+
446
+ The standalone function version of this method:
447
+
448
+ ```typescript
449
+ import { MistralCore } from "@mistralai/mistralai/core.js";
450
+ import { betaLibrariesDocumentsTextContent } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js";
451
+
452
+ // Use `MistralCore` for best tree-shaking performance.
453
+ // You can create one instance of it to use across an application.
454
+ const mistral = new MistralCore({
455
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
456
+ });
457
+
458
+ async function run() {
459
+ const res = await betaLibrariesDocumentsTextContent(mistral, {
460
+ libraryId: "ccb1b572-71d2-46fc-bb41-5dbd65167579",
461
+ documentId: "40825d2b-5bb4-4bda-9c77-1302c2bf5ce0",
462
+ });
463
+
464
+ if (!res.ok) {
465
+ throw res.error;
466
+ }
467
+
468
+ const { value: result } = res;
469
+
470
+ // Handle the result
471
+ console.log(result);
472
+ }
473
+
474
+ run();
475
+ ```
476
+
477
+ ### Parameters
478
+
479
+ | Parameter | Type | Required | Description |
480
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
481
+ | `request` | [operations.LibrariesDocumentsGetTextContentV1Request](../../models/operations/librariesdocumentsgettextcontentv1request.md) | :heavy_check_mark: | The request object to use for the request. |
482
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
483
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
484
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
485
+
486
+ ### Response
487
+
488
+ **Promise\<[components.DocumentTextContent](../../models/components/documenttextcontent.md)\>**
489
+
490
+ ### Errors
491
+
492
+ | Error Type | Status Code | Content Type |
493
+ | -------------------------- | -------------------------- | -------------------------- |
494
+ | errors.HTTPValidationError | 422 | application/json |
495
+ | errors.SDKError | 4XX, 5XX | \*/\* |
496
+
497
+ ## status
498
+
499
+ Given a library and a document in that library, retrieve the processing status of that document.
500
+
501
+ ### Example Usage
502
+
503
+ ```typescript
504
+ import { Mistral } from "@mistralai/mistralai";
505
+
506
+ const mistral = new Mistral({
507
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
508
+ });
509
+
510
+ async function run() {
511
+ const result = await mistral.beta.libraries.documents.status({
512
+ libraryId: "6dcdb4f8-c706-48d4-b2ae-267b72b23c1e",
513
+ documentId: "276aed56-72ae-4738-84ba-1dd740e0bd1f",
514
+ });
515
+
516
+ // Handle the result
517
+ console.log(result);
518
+ }
519
+
520
+ run();
521
+ ```
522
+
523
+ ### Standalone function
524
+
525
+ The standalone function version of this method:
526
+
527
+ ```typescript
528
+ import { MistralCore } from "@mistralai/mistralai/core.js";
529
+ import { betaLibrariesDocumentsStatus } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js";
530
+
531
+ // Use `MistralCore` for best tree-shaking performance.
532
+ // You can create one instance of it to use across an application.
533
+ const mistral = new MistralCore({
534
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
535
+ });
536
+
537
+ async function run() {
538
+ const res = await betaLibrariesDocumentsStatus(mistral, {
539
+ libraryId: "6dcdb4f8-c706-48d4-b2ae-267b72b23c1e",
540
+ documentId: "276aed56-72ae-4738-84ba-1dd740e0bd1f",
541
+ });
542
+
543
+ if (!res.ok) {
544
+ throw res.error;
545
+ }
546
+
547
+ const { value: result } = res;
548
+
549
+ // Handle the result
550
+ console.log(result);
551
+ }
552
+
553
+ run();
554
+ ```
555
+
556
+ ### Parameters
557
+
558
+ | Parameter | Type | Required | Description |
559
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
560
+ | `request` | [operations.LibrariesDocumentsGetStatusV1Request](../../models/operations/librariesdocumentsgetstatusv1request.md) | :heavy_check_mark: | The request object to use for the request. |
561
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
562
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
563
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
564
+
565
+ ### Response
566
+
567
+ **Promise\<[components.ProcessingStatusOut](../../models/components/processingstatusout.md)\>**
568
+
569
+ ### Errors
570
+
571
+ | Error Type | Status Code | Content Type |
572
+ | -------------------------- | -------------------------- | -------------------------- |
573
+ | errors.HTTPValidationError | 422 | application/json |
574
+ | errors.SDKError | 4XX, 5XX | \*/\* |
575
+
576
+ ## getSignedUrl
577
+
578
+ Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link.
579
+
580
+ ### Example Usage
581
+
582
+ ```typescript
583
+ import { Mistral } from "@mistralai/mistralai";
584
+
585
+ const mistral = new Mistral({
586
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
587
+ });
588
+
589
+ async function run() {
590
+ const result = await mistral.beta.libraries.documents.getSignedUrl({
591
+ libraryId: "2b31dadd-fc87-450c-9c52-e8a2548c3f17",
592
+ documentId: "b148735d-03fc-4319-af9e-00bbfcd5d89f",
593
+ });
594
+
595
+ // Handle the result
596
+ console.log(result);
597
+ }
598
+
599
+ run();
600
+ ```
601
+
602
+ ### Standalone function
603
+
604
+ The standalone function version of this method:
605
+
606
+ ```typescript
607
+ import { MistralCore } from "@mistralai/mistralai/core.js";
608
+ import { betaLibrariesDocumentsGetSignedUrl } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js";
609
+
610
+ // Use `MistralCore` for best tree-shaking performance.
611
+ // You can create one instance of it to use across an application.
612
+ const mistral = new MistralCore({
613
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
614
+ });
615
+
616
+ async function run() {
617
+ const res = await betaLibrariesDocumentsGetSignedUrl(mistral, {
618
+ libraryId: "2b31dadd-fc87-450c-9c52-e8a2548c3f17",
619
+ documentId: "b148735d-03fc-4319-af9e-00bbfcd5d89f",
620
+ });
621
+
622
+ if (!res.ok) {
623
+ throw res.error;
624
+ }
625
+
626
+ const { value: result } = res;
627
+
628
+ // Handle the result
629
+ console.log(result);
630
+ }
631
+
632
+ run();
633
+ ```
634
+
635
+ ### Parameters
636
+
637
+ | Parameter | Type | Required | Description |
638
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
639
+ | `request` | [operations.LibrariesDocumentsGetSignedUrlV1Request](../../models/operations/librariesdocumentsgetsignedurlv1request.md) | :heavy_check_mark: | The request object to use for the request. |
640
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
641
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
642
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
643
+
644
+ ### Response
645
+
646
+ **Promise\<[string](../../models/.md)\>**
647
+
648
+ ### Errors
649
+
650
+ | Error Type | Status Code | Content Type |
651
+ | -------------------------- | -------------------------- | -------------------------- |
652
+ | errors.HTTPValidationError | 422 | application/json |
653
+ | errors.SDKError | 4XX, 5XX | \*/\* |
654
+
655
+ ## extractedTextSignedUrl
656
+
657
+ Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries.
658
+
659
+ ### Example Usage
660
+
661
+ ```typescript
662
+ import { Mistral } from "@mistralai/mistralai";
663
+
664
+ const mistral = new Mistral({
665
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
666
+ });
667
+
668
+ async function run() {
669
+ const result = await mistral.beta.libraries.documents.extractedTextSignedUrl({
670
+ libraryId: "3ed81b4a-207f-4581-aacc-d3f1af7a03bb",
671
+ documentId: "8eeba8e7-77cb-4f1f-96cf-16788d5632fe",
672
+ });
673
+
674
+ // Handle the result
675
+ console.log(result);
676
+ }
677
+
678
+ run();
679
+ ```
680
+
681
+ ### Standalone function
682
+
683
+ The standalone function version of this method:
684
+
685
+ ```typescript
686
+ import { MistralCore } from "@mistralai/mistralai/core.js";
687
+ import { betaLibrariesDocumentsExtractedTextSignedUrl } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js";
688
+
689
+ // Use `MistralCore` for best tree-shaking performance.
690
+ // You can create one instance of it to use across an application.
691
+ const mistral = new MistralCore({
692
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
693
+ });
694
+
695
+ async function run() {
696
+ const res = await betaLibrariesDocumentsExtractedTextSignedUrl(mistral, {
697
+ libraryId: "3ed81b4a-207f-4581-aacc-d3f1af7a03bb",
698
+ documentId: "8eeba8e7-77cb-4f1f-96cf-16788d5632fe",
699
+ });
700
+
701
+ if (!res.ok) {
702
+ throw res.error;
703
+ }
704
+
705
+ const { value: result } = res;
706
+
707
+ // Handle the result
708
+ console.log(result);
709
+ }
710
+
711
+ run();
712
+ ```
713
+
714
+ ### Parameters
715
+
716
+ | Parameter | Type | Required | Description |
717
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
718
+ | `request` | [operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request](../../models/operations/librariesdocumentsgetextractedtextsignedurlv1request.md) | :heavy_check_mark: | The request object to use for the request. |
719
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
720
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
721
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
722
+
723
+ ### Response
724
+
725
+ **Promise\<[string](../../models/.md)\>**
726
+
727
+ ### Errors
728
+
729
+ | Error Type | Status Code | Content Type |
730
+ | -------------------------- | -------------------------- | -------------------------- |
731
+ | errors.HTTPValidationError | 422 | application/json |
732
+ | errors.SDKError | 4XX, 5XX | \*/\* |
733
+
734
+ ## reprocess
735
+
736
+ Given a library and a document in that library, reprocess that document, it will be billed again.
737
+
738
+ ### Example Usage
739
+
740
+ ```typescript
741
+ import { Mistral } from "@mistralai/mistralai";
742
+
743
+ const mistral = new Mistral({
744
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
745
+ });
746
+
747
+ async function run() {
748
+ await mistral.beta.libraries.documents.reprocess({
749
+ libraryId: "3838a038-529e-4160-82a5-29ab80423efb",
750
+ documentId: "7162b7a5-2eb5-4f2e-836c-d24617b1f407",
751
+ });
752
+
753
+
754
+ }
755
+
756
+ run();
757
+ ```
758
+
759
+ ### Standalone function
760
+
761
+ The standalone function version of this method:
762
+
763
+ ```typescript
764
+ import { MistralCore } from "@mistralai/mistralai/core.js";
765
+ import { betaLibrariesDocumentsReprocess } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js";
766
+
767
+ // Use `MistralCore` for best tree-shaking performance.
768
+ // You can create one instance of it to use across an application.
769
+ const mistral = new MistralCore({
770
+ apiKey: process.env["MISTRAL_API_KEY"] ?? "",
771
+ });
772
+
773
+ async function run() {
774
+ const res = await betaLibrariesDocumentsReprocess(mistral, {
775
+ libraryId: "3838a038-529e-4160-82a5-29ab80423efb",
776
+ documentId: "7162b7a5-2eb5-4f2e-836c-d24617b1f407",
777
+ });
778
+
779
+ if (!res.ok) {
780
+ throw res.error;
781
+ }
782
+
783
+ const { value: result } = res;
784
+
785
+
786
+ }
787
+
788
+ run();
789
+ ```
790
+
791
+ ### Parameters
792
+
793
+ | Parameter | Type | Required | Description |
794
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
795
+ | `request` | [operations.LibrariesDocumentsReprocessV1Request](../../models/operations/librariesdocumentsreprocessv1request.md) | :heavy_check_mark: | The request object to use for the request. |
796
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
797
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
798
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
799
+
800
+ ### Response
801
+
802
+ **Promise\<void\>**
803
+
804
+ ### Errors
805
+
806
+ | Error Type | Status Code | Content Type |
807
+ | -------------------------- | -------------------------- | -------------------------- |
808
+ | errors.HTTPValidationError | 422 | application/json |
809
+ | errors.SDKError | 4XX, 5XX | \*/\* |