@mistralai/mistralai 1.10.0 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (373) hide show
  1. package/README.md +21 -7
  2. package/_speakeasy/.github/action-inputs-config.json +53 -0
  3. package/_speakeasy/.github/action-security-config.json +88 -0
  4. package/funcs/audioTranscriptionsStream.d.ts +1 -1
  5. package/funcs/audioTranscriptionsStream.js +1 -1
  6. package/funcs/batchJobsGet.d.ts +3 -0
  7. package/funcs/batchJobsGet.d.ts.map +1 -1
  8. package/funcs/batchJobsGet.js +7 -0
  9. package/funcs/batchJobsGet.js.map +1 -1
  10. package/funcs/betaAgentsDelete.d.ts +15 -0
  11. package/funcs/betaAgentsDelete.d.ts.map +1 -0
  12. package/funcs/betaAgentsDelete.js +121 -0
  13. package/funcs/betaAgentsDelete.js.map +1 -0
  14. package/funcs/betaAgentsGet.js +4 -0
  15. package/funcs/betaAgentsGet.js.map +1 -1
  16. package/funcs/betaAgentsList.d.ts.map +1 -1
  17. package/funcs/betaAgentsList.js +8 -2
  18. package/funcs/betaAgentsList.js.map +1 -1
  19. package/funcs/betaConversationsDelete.d.ts +18 -0
  20. package/funcs/betaConversationsDelete.d.ts.map +1 -0
  21. package/funcs/betaConversationsDelete.js +124 -0
  22. package/funcs/betaConversationsDelete.js.map +1 -0
  23. package/funcs/betaConversationsList.d.ts.map +1 -1
  24. package/funcs/betaConversationsList.js +4 -2
  25. package/funcs/betaConversationsList.js.map +1 -1
  26. package/funcs/betaLibrariesDocumentsList.d.ts +1 -1
  27. package/funcs/betaLibrariesDocumentsList.js +2 -1
  28. package/funcs/betaLibrariesDocumentsList.js.map +1 -1
  29. package/funcs/filesList.js +1 -0
  30. package/funcs/filesList.js.map +1 -1
  31. package/funcs/modelsList.d.ts +1 -2
  32. package/funcs/modelsList.d.ts.map +1 -1
  33. package/funcs/modelsList.js +2 -6
  34. package/funcs/modelsList.js.map +1 -1
  35. package/jsr.json +1 -1
  36. package/lib/config.d.ts +2 -2
  37. package/lib/config.js +2 -2
  38. package/models/components/agent.d.ts +12 -0
  39. package/models/components/agent.d.ts.map +1 -1
  40. package/models/components/agent.js +10 -0
  41. package/models/components/agent.js.map +1 -1
  42. package/models/components/agentconversation.d.ts +11 -0
  43. package/models/components/agentconversation.d.ts.map +1 -1
  44. package/models/components/agentconversation.js +6 -0
  45. package/models/components/agentconversation.js.map +1 -1
  46. package/models/components/agentcreationrequest.d.ts +6 -0
  47. package/models/components/agentcreationrequest.d.ts.map +1 -1
  48. package/models/components/agentcreationrequest.js +2 -0
  49. package/models/components/agentcreationrequest.js.map +1 -1
  50. package/models/components/agentscompletionrequest.d.ts +14 -2
  51. package/models/components/agentscompletionrequest.d.ts.map +1 -1
  52. package/models/components/agentscompletionrequest.js +2 -0
  53. package/models/components/agentscompletionrequest.js.map +1 -1
  54. package/models/components/agentscompletionstreamrequest.d.ts +14 -2
  55. package/models/components/agentscompletionstreamrequest.d.ts.map +1 -1
  56. package/models/components/agentscompletionstreamrequest.js +2 -0
  57. package/models/components/agentscompletionstreamrequest.js.map +1 -1
  58. package/models/components/agentupdaterequest.d.ts +8 -0
  59. package/models/components/agentupdaterequest.d.ts.map +1 -1
  60. package/models/components/agentupdaterequest.js +6 -0
  61. package/models/components/agentupdaterequest.js.map +1 -1
  62. package/models/components/audioencoding.d.ts +26 -0
  63. package/models/components/audioencoding.d.ts.map +1 -0
  64. package/models/components/audioencoding.js +72 -0
  65. package/models/components/audioencoding.js.map +1 -0
  66. package/models/components/audioformat.d.ts +32 -0
  67. package/models/components/audioformat.d.ts.map +1 -0
  68. package/models/components/audioformat.js +81 -0
  69. package/models/components/audioformat.js.map +1 -0
  70. package/models/components/audiotranscriptionrequest.d.ts +3 -0
  71. package/models/components/audiotranscriptionrequest.d.ts.map +1 -1
  72. package/models/components/audiotranscriptionrequest.js.map +1 -1
  73. package/models/components/batchjobin.d.ts +20 -2
  74. package/models/components/batchjobin.d.ts.map +1 -1
  75. package/models/components/batchjobin.js +5 -2
  76. package/models/components/batchjobin.js.map +1 -1
  77. package/models/components/batchjobout.d.ts +6 -0
  78. package/models/components/batchjobout.d.ts.map +1 -1
  79. package/models/components/batchjobout.js +2 -0
  80. package/models/components/batchjobout.js.map +1 -1
  81. package/models/components/batchrequest.d.ts +35 -0
  82. package/models/components/batchrequest.d.ts.map +1 -0
  83. package/models/components/batchrequest.js +80 -0
  84. package/models/components/batchrequest.js.map +1 -0
  85. package/models/components/chatcompletionrequest.d.ts +26 -2
  86. package/models/components/chatcompletionrequest.d.ts.map +1 -1
  87. package/models/components/chatcompletionrequest.js +2 -0
  88. package/models/components/chatcompletionrequest.js.map +1 -1
  89. package/models/components/chatcompletionstreamrequest.d.ts +26 -2
  90. package/models/components/chatcompletionstreamrequest.d.ts.map +1 -1
  91. package/models/components/chatcompletionstreamrequest.js +2 -0
  92. package/models/components/chatcompletionstreamrequest.js.map +1 -1
  93. package/models/components/classificationrequest.d.ts +6 -0
  94. package/models/components/classificationrequest.d.ts.map +1 -1
  95. package/models/components/classificationrequest.js +2 -0
  96. package/models/components/classificationrequest.js.map +1 -1
  97. package/models/components/conversationrequest.d.ts +13 -2
  98. package/models/components/conversationrequest.d.ts.map +1 -1
  99. package/models/components/conversationrequest.js +16 -6
  100. package/models/components/conversationrequest.js.map +1 -1
  101. package/models/components/conversationrestartrequest.d.ts +14 -0
  102. package/models/components/conversationrestartrequest.d.ts.map +1 -1
  103. package/models/components/conversationrestartrequest.js +6 -0
  104. package/models/components/conversationrestartrequest.js.map +1 -1
  105. package/models/components/conversationrestartstreamrequest.d.ts +14 -0
  106. package/models/components/conversationrestartstreamrequest.d.ts.map +1 -1
  107. package/models/components/conversationrestartstreamrequest.js +6 -0
  108. package/models/components/conversationrestartstreamrequest.js.map +1 -1
  109. package/models/components/conversationstreamrequest.d.ts +13 -2
  110. package/models/components/conversationstreamrequest.d.ts.map +1 -1
  111. package/models/components/conversationstreamrequest.js +16 -6
  112. package/models/components/conversationstreamrequest.js.map +1 -1
  113. package/models/components/documentout.d.ts +18 -10
  114. package/models/components/documentout.d.ts.map +1 -1
  115. package/models/components/documentout.js +14 -10
  116. package/models/components/documentout.js.map +1 -1
  117. package/models/components/documentupdatein.d.ts +27 -0
  118. package/models/components/documentupdatein.d.ts.map +1 -1
  119. package/models/components/documentupdatein.js +66 -1
  120. package/models/components/documentupdatein.js.map +1 -1
  121. package/models/components/embeddingrequest.d.ts +10 -4
  122. package/models/components/embeddingrequest.d.ts.map +1 -1
  123. package/models/components/embeddingrequest.js +2 -0
  124. package/models/components/embeddingrequest.js.map +1 -1
  125. package/models/components/fimcompletionrequest.d.ts +7 -5
  126. package/models/components/fimcompletionrequest.d.ts.map +1 -1
  127. package/models/components/fimcompletionrequest.js +2 -0
  128. package/models/components/fimcompletionrequest.js.map +1 -1
  129. package/models/components/fimcompletionstreamrequest.d.ts +7 -5
  130. package/models/components/fimcompletionstreamrequest.d.ts.map +1 -1
  131. package/models/components/fimcompletionstreamrequest.js +2 -0
  132. package/models/components/fimcompletionstreamrequest.js.map +1 -1
  133. package/models/components/index.d.ts +5 -0
  134. package/models/components/index.d.ts.map +1 -1
  135. package/models/components/index.js +5 -0
  136. package/models/components/index.js.map +1 -1
  137. package/models/components/libraryout.d.ts +7 -4
  138. package/models/components/libraryout.d.ts.map +1 -1
  139. package/models/components/libraryout.js +6 -6
  140. package/models/components/libraryout.js.map +1 -1
  141. package/models/components/listfilesout.d.ts +2 -2
  142. package/models/components/listfilesout.d.ts.map +1 -1
  143. package/models/components/listfilesout.js +2 -2
  144. package/models/components/listfilesout.js.map +1 -1
  145. package/models/components/modelcapabilities.d.ts +8 -2
  146. package/models/components/modelcapabilities.d.ts.map +1 -1
  147. package/models/components/modelcapabilities.js +12 -6
  148. package/models/components/modelcapabilities.js.map +1 -1
  149. package/models/components/modelconversation.d.ts +9 -0
  150. package/models/components/modelconversation.d.ts.map +1 -1
  151. package/models/components/modelconversation.js +2 -0
  152. package/models/components/modelconversation.js.map +1 -1
  153. package/models/components/ocrpageobject.d.ts +21 -0
  154. package/models/components/ocrpageobject.d.ts.map +1 -1
  155. package/models/components/ocrpageobject.js +9 -0
  156. package/models/components/ocrpageobject.js.map +1 -1
  157. package/models/components/ocrrequest.d.ts +32 -0
  158. package/models/components/ocrrequest.d.ts.map +1 -1
  159. package/models/components/ocrrequest.js +33 -1
  160. package/models/components/ocrrequest.js.map +1 -1
  161. package/models/components/ocrtableobject.d.ts +74 -0
  162. package/models/components/ocrtableobject.d.ts.map +1 -0
  163. package/models/components/ocrtableobject.js +96 -0
  164. package/models/components/ocrtableobject.js.map +1 -0
  165. package/models/components/prediction.d.ts +3 -0
  166. package/models/components/prediction.d.ts.map +1 -1
  167. package/models/components/prediction.js.map +1 -1
  168. package/models/components/requestsource.d.ts +31 -0
  169. package/models/components/requestsource.d.ts.map +1 -0
  170. package/models/components/requestsource.js +61 -0
  171. package/models/components/requestsource.js.map +1 -0
  172. package/models/components/responseformat.d.ts +3 -3
  173. package/models/components/responseformat.d.ts.map +1 -1
  174. package/models/components/responseformats.d.ts +0 -6
  175. package/models/components/responseformats.d.ts.map +1 -1
  176. package/models/components/responseformats.js +0 -3
  177. package/models/components/responseformats.js.map +1 -1
  178. package/models/components/sharingdelete.d.ts +2 -2
  179. package/models/components/sharingdelete.d.ts.map +1 -1
  180. package/models/components/sharingdelete.js +2 -2
  181. package/models/components/sharingdelete.js.map +1 -1
  182. package/models/components/sharingin.d.ts +2 -2
  183. package/models/components/sharingin.d.ts.map +1 -1
  184. package/models/components/sharingin.js +2 -2
  185. package/models/components/sharingin.js.map +1 -1
  186. package/models/components/sharingout.d.ts +2 -2
  187. package/models/components/sharingout.d.ts.map +1 -1
  188. package/models/components/sharingout.js +2 -2
  189. package/models/components/sharingout.js.map +1 -1
  190. package/models/components/toolexecutiondeltaevent.d.ts +23 -2
  191. package/models/components/toolexecutiondeltaevent.d.ts.map +1 -1
  192. package/models/components/toolexecutiondeltaevent.js +26 -3
  193. package/models/components/toolexecutiondeltaevent.js.map +1 -1
  194. package/models/components/toolexecutiondoneevent.d.ts +23 -2
  195. package/models/components/toolexecutiondoneevent.d.ts.map +1 -1
  196. package/models/components/toolexecutiondoneevent.js +26 -3
  197. package/models/components/toolexecutiondoneevent.js.map +1 -1
  198. package/models/components/toolexecutionentry.d.ts +23 -2
  199. package/models/components/toolexecutionentry.d.ts.map +1 -1
  200. package/models/components/toolexecutionentry.js +27 -3
  201. package/models/components/toolexecutionentry.js.map +1 -1
  202. package/models/components/toolexecutionstartedevent.d.ts +23 -2
  203. package/models/components/toolexecutionstartedevent.d.ts.map +1 -1
  204. package/models/components/toolexecutionstartedevent.js +26 -3
  205. package/models/components/toolexecutionstartedevent.js.map +1 -1
  206. package/models/components/toolfilechunk.d.ts +23 -2
  207. package/models/components/toolfilechunk.d.ts.map +1 -1
  208. package/models/components/toolfilechunk.js +26 -3
  209. package/models/components/toolfilechunk.js.map +1 -1
  210. package/models/components/toolreferencechunk.d.ts +23 -2
  211. package/models/components/toolreferencechunk.d.ts.map +1 -1
  212. package/models/components/toolreferencechunk.js +26 -3
  213. package/models/components/toolreferencechunk.js.map +1 -1
  214. package/models/operations/agentsapiv1agentsdelete.d.ts +29 -0
  215. package/models/operations/agentsapiv1agentsdelete.d.ts.map +1 -0
  216. package/models/operations/agentsapiv1agentsdelete.js +78 -0
  217. package/models/operations/agentsapiv1agentsdelete.js.map +1 -0
  218. package/models/operations/agentsapiv1agentsget.d.ts +2 -0
  219. package/models/operations/agentsapiv1agentsget.d.ts.map +1 -1
  220. package/models/operations/agentsapiv1agentsget.js +4 -0
  221. package/models/operations/agentsapiv1agentsget.js.map +1 -1
  222. package/models/operations/agentsapiv1agentslist.d.ts +15 -0
  223. package/models/operations/agentsapiv1agentslist.d.ts.map +1 -1
  224. package/models/operations/agentsapiv1agentslist.js +15 -0
  225. package/models/operations/agentsapiv1agentslist.js.map +1 -1
  226. package/models/operations/agentsapiv1conversationsdelete.d.ts +32 -0
  227. package/models/operations/agentsapiv1conversationsdelete.d.ts.map +1 -0
  228. package/models/operations/agentsapiv1conversationsdelete.js +78 -0
  229. package/models/operations/agentsapiv1conversationsdelete.js.map +1 -0
  230. package/models/operations/agentsapiv1conversationslist.d.ts +6 -0
  231. package/models/operations/agentsapiv1conversationslist.d.ts.map +1 -1
  232. package/models/operations/agentsapiv1conversationslist.js +2 -0
  233. package/models/operations/agentsapiv1conversationslist.js.map +1 -1
  234. package/models/operations/filesapirouteslistfiles.d.ts +2 -0
  235. package/models/operations/filesapirouteslistfiles.d.ts.map +1 -1
  236. package/models/operations/filesapirouteslistfiles.js +4 -0
  237. package/models/operations/filesapirouteslistfiles.js.map +1 -1
  238. package/models/operations/index.d.ts +2 -0
  239. package/models/operations/index.d.ts.map +1 -1
  240. package/models/operations/index.js +2 -0
  241. package/models/operations/index.js.map +1 -1
  242. package/models/operations/jobsapiroutesbatchgetbatchjob.d.ts +2 -0
  243. package/models/operations/jobsapiroutesbatchgetbatchjob.d.ts.map +1 -1
  244. package/models/operations/jobsapiroutesbatchgetbatchjob.js +2 -0
  245. package/models/operations/jobsapiroutesbatchgetbatchjob.js.map +1 -1
  246. package/models/operations/librariesdocumentslistv1.d.ts +2 -0
  247. package/models/operations/librariesdocumentslistv1.d.ts.map +1 -1
  248. package/models/operations/librariesdocumentslistv1.js +4 -0
  249. package/models/operations/librariesdocumentslistv1.js.map +1 -1
  250. package/package.json +1 -1
  251. package/sdk/conversations.d.ts +7 -0
  252. package/sdk/conversations.d.ts.map +1 -1
  253. package/sdk/conversations.js +10 -0
  254. package/sdk/conversations.js.map +1 -1
  255. package/sdk/documents.d.ts +1 -1
  256. package/sdk/documents.js +1 -1
  257. package/sdk/mistralagents.d.ts +4 -0
  258. package/sdk/mistralagents.d.ts.map +1 -1
  259. package/sdk/mistralagents.js +7 -0
  260. package/sdk/mistralagents.js.map +1 -1
  261. package/sdk/mistraljobs.d.ts +3 -0
  262. package/sdk/mistraljobs.d.ts.map +1 -1
  263. package/sdk/mistraljobs.js +3 -0
  264. package/sdk/mistraljobs.js.map +1 -1
  265. package/sdk/transcriptions.d.ts +1 -1
  266. package/sdk/transcriptions.js +1 -1
  267. package/src/funcs/audioTranscriptionsStream.ts +1 -1
  268. package/src/funcs/batchJobsGet.ts +9 -1
  269. package/src/funcs/betaAgentsDelete.ts +174 -0
  270. package/src/funcs/betaAgentsGet.ts +6 -1
  271. package/src/funcs/betaAgentsList.ts +18 -5
  272. package/src/funcs/betaConversationsDelete.ts +179 -0
  273. package/src/funcs/betaConversationsList.ts +14 -5
  274. package/src/funcs/betaLibrariesDocumentsList.ts +2 -1
  275. package/src/funcs/filesList.ts +1 -0
  276. package/src/funcs/modelsList.ts +2 -11
  277. package/src/lib/config.ts +2 -2
  278. package/src/models/components/agent.ts +18 -0
  279. package/src/models/components/agentconversation.ts +13 -0
  280. package/src/models/components/agentcreationrequest.ts +4 -0
  281. package/src/models/components/agentscompletionrequest.ts +12 -2
  282. package/src/models/components/agentscompletionstreamrequest.ts +12 -2
  283. package/src/models/components/agentupdaterequest.ts +10 -0
  284. package/src/models/components/audioencoding.ts +52 -0
  285. package/src/models/components/audioformat.ts +80 -0
  286. package/src/models/components/audiotranscriptionrequest.ts +3 -0
  287. package/src/models/components/batchjobin.ts +29 -4
  288. package/src/models/components/batchjobout.ts +4 -0
  289. package/src/models/components/batchrequest.ts +75 -0
  290. package/src/models/components/chatcompletionrequest.ts +24 -2
  291. package/src/models/components/chatcompletionstreamrequest.ts +24 -2
  292. package/src/models/components/classificationrequest.ts +4 -0
  293. package/src/models/components/conversationrequest.ts +79 -72
  294. package/src/models/components/conversationrestartrequest.ts +16 -0
  295. package/src/models/components/conversationrestartstreamrequest.ts +16 -0
  296. package/src/models/components/conversationstreamrequest.ts +79 -72
  297. package/src/models/components/documentout.ts +28 -20
  298. package/src/models/components/documentupdatein.ts +144 -0
  299. package/src/models/components/embeddingrequest.ts +8 -4
  300. package/src/models/components/fimcompletionrequest.ts +5 -5
  301. package/src/models/components/fimcompletionstreamrequest.ts +5 -5
  302. package/src/models/components/index.ts +5 -0
  303. package/src/models/components/libraryout.ts +13 -10
  304. package/src/models/components/listfilesout.ts +4 -4
  305. package/src/models/components/modelcapabilities.ts +20 -8
  306. package/src/models/components/modelconversation.ts +7 -0
  307. package/src/models/components/ocrpageobject.ts +34 -0
  308. package/src/models/components/ocrrequest.ts +44 -0
  309. package/src/models/components/ocrtableobject.ts +111 -0
  310. package/src/models/components/prediction.ts +3 -0
  311. package/src/models/components/requestsource.ts +34 -0
  312. package/src/models/components/responseformat.ts +3 -3
  313. package/src/models/components/responseformats.ts +0 -6
  314. package/src/models/components/sharingdelete.ts +4 -4
  315. package/src/models/components/sharingin.ts +4 -4
  316. package/src/models/components/sharingout.ts +4 -4
  317. package/src/models/components/toolexecutiondeltaevent.ts +56 -4
  318. package/src/models/components/toolexecutiondoneevent.ts +54 -4
  319. package/src/models/components/toolexecutionentry.ts +44 -4
  320. package/src/models/components/toolexecutionstartedevent.ts +56 -4
  321. package/src/models/components/toolfilechunk.ts +54 -4
  322. package/src/models/components/toolreferencechunk.ts +54 -4
  323. package/src/models/operations/agentsapiv1agentsdelete.ts +77 -0
  324. package/src/models/operations/agentsapiv1agentsget.ts +6 -0
  325. package/src/models/operations/agentsapiv1agentslist.ts +25 -0
  326. package/src/models/operations/agentsapiv1conversationsdelete.ts +83 -0
  327. package/src/models/operations/agentsapiv1conversationslist.ts +4 -0
  328. package/src/models/operations/filesapirouteslistfiles.ts +6 -0
  329. package/src/models/operations/index.ts +2 -0
  330. package/src/models/operations/jobsapiroutesbatchgetbatchjob.ts +4 -0
  331. package/src/models/operations/librariesdocumentslistv1.ts +6 -0
  332. package/src/sdk/conversations.ts +18 -0
  333. package/src/sdk/documents.ts +1 -1
  334. package/src/sdk/mistralagents.ts +15 -0
  335. package/src/sdk/mistraljobs.ts +3 -0
  336. package/src/sdk/transcriptions.ts +1 -1
  337. package/.devcontainer/README.md +0 -35
  338. package/docs/sdks/accesses/README.md +0 -256
  339. package/docs/sdks/agents/README.md +0 -189
  340. package/docs/sdks/audio/README.md +0 -6
  341. package/docs/sdks/batch/README.md +0 -6
  342. package/docs/sdks/beta/README.md +0 -6
  343. package/docs/sdks/chat/README.md +0 -189
  344. package/docs/sdks/classifiers/README.md +0 -355
  345. package/docs/sdks/conversations/README.md +0 -835
  346. package/docs/sdks/documents/README.md +0 -785
  347. package/docs/sdks/embeddings/README.md +0 -92
  348. package/docs/sdks/files/README.md +0 -455
  349. package/docs/sdks/fim/README.md +0 -173
  350. package/docs/sdks/finetuning/README.md +0 -6
  351. package/docs/sdks/jobs/README.md +0 -379
  352. package/docs/sdks/libraries/README.md +0 -380
  353. package/docs/sdks/mistral/README.md +0 -7
  354. package/docs/sdks/mistralagents/README.md +0 -386
  355. package/docs/sdks/mistraljobs/README.md +0 -305
  356. package/docs/sdks/models/README.md +0 -453
  357. package/docs/sdks/ocr/README.md +0 -92
  358. package/docs/sdks/transcriptions/README.md +0 -163
  359. package/examples/README.md +0 -44
  360. package/packages/mistralai-azure/FUNCTIONS.md +0 -111
  361. package/packages/mistralai-azure/LICENSE +0 -201
  362. package/packages/mistralai-azure/README.md +0 -447
  363. package/packages/mistralai-azure/RUNTIMES.md +0 -48
  364. package/packages/mistralai-azure/docs/sdks/chat/README.md +0 -114
  365. package/packages/mistralai-azure/docs/sdks/mistralazure/README.md +0 -9
  366. package/packages/mistralai-gcp/FUNCTIONS.md +0 -112
  367. package/packages/mistralai-gcp/LICENSE +0 -201
  368. package/packages/mistralai-gcp/README.md +0 -455
  369. package/packages/mistralai-gcp/RUNTIMES.md +0 -48
  370. package/packages/mistralai-gcp/docs/sdks/chat/README.md +0 -115
  371. package/packages/mistralai-gcp/docs/sdks/fim/README.md +0 -58
  372. package/packages/mistralai-gcp/docs/sdks/mistralgcp/README.md +0 -9
  373. package/src/extra/README.md +0 -52
@@ -1,173 +0,0 @@
1
- # Fim
2
- (*fim*)
3
-
4
- ## Overview
5
-
6
- Fill-in-the-middle API.
7
-
8
- ### Available Operations
9
-
10
- * [complete](#complete) - Fim Completion
11
- * [stream](#stream) - Stream fim completion
12
-
13
- ## complete
14
-
15
- FIM completion.
16
-
17
- ### Example Usage
18
-
19
- <!-- UsageSnippet language="typescript" operationID="fim_completion_v1_fim_completions_post" method="post" path="/v1/fim/completions" -->
20
- ```typescript
21
- import { Mistral } from "@mistralai/mistralai";
22
-
23
- const mistral = new Mistral({
24
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
25
- });
26
-
27
- async function run() {
28
- const result = await mistral.fim.complete({
29
- model: "codestral-2405",
30
- prompt: "def",
31
- suffix: "return a+b",
32
- });
33
-
34
- console.log(result);
35
- }
36
-
37
- run();
38
- ```
39
-
40
- ### Standalone function
41
-
42
- The standalone function version of this method:
43
-
44
- ```typescript
45
- import { MistralCore } from "@mistralai/mistralai/core.js";
46
- import { fimComplete } from "@mistralai/mistralai/funcs/fimComplete.js";
47
-
48
- // Use `MistralCore` for best tree-shaking performance.
49
- // You can create one instance of it to use across an application.
50
- const mistral = new MistralCore({
51
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
52
- });
53
-
54
- async function run() {
55
- const res = await fimComplete(mistral, {
56
- model: "codestral-2405",
57
- prompt: "def",
58
- suffix: "return a+b",
59
- });
60
- if (res.ok) {
61
- const { value: result } = res;
62
- console.log(result);
63
- } else {
64
- console.log("fimComplete failed:", res.error);
65
- }
66
- }
67
-
68
- run();
69
- ```
70
-
71
- ### Parameters
72
-
73
- | Parameter | Type | Required | Description |
74
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
75
- | `request` | [components.FIMCompletionRequest](../../models/components/fimcompletionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
76
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
77
- | `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. |
78
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
79
-
80
- ### Response
81
-
82
- **Promise\<[components.FIMCompletionResponse](../../models/components/fimcompletionresponse.md)\>**
83
-
84
- ### Errors
85
-
86
- | Error Type | Status Code | Content Type |
87
- | -------------------------- | -------------------------- | -------------------------- |
88
- | errors.HTTPValidationError | 422 | application/json |
89
- | errors.SDKError | 4XX, 5XX | \*/\* |
90
-
91
- ## stream
92
-
93
- Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.
94
-
95
- ### Example Usage
96
-
97
- <!-- UsageSnippet language="typescript" operationID="stream_fim" method="post" path="/v1/fim/completions#stream" -->
98
- ```typescript
99
- import { Mistral } from "@mistralai/mistralai";
100
-
101
- const mistral = new Mistral({
102
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
103
- });
104
-
105
- async function run() {
106
- const result = await mistral.fim.stream({
107
- model: "codestral-2405",
108
- prompt: "def",
109
- suffix: "return a+b",
110
- });
111
-
112
- for await (const event of result) {
113
- // Handle the event
114
- console.log(event);
115
- }
116
- }
117
-
118
- run();
119
- ```
120
-
121
- ### Standalone function
122
-
123
- The standalone function version of this method:
124
-
125
- ```typescript
126
- import { MistralCore } from "@mistralai/mistralai/core.js";
127
- import { fimStream } from "@mistralai/mistralai/funcs/fimStream.js";
128
-
129
- // Use `MistralCore` for best tree-shaking performance.
130
- // You can create one instance of it to use across an application.
131
- const mistral = new MistralCore({
132
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
133
- });
134
-
135
- async function run() {
136
- const res = await fimStream(mistral, {
137
- model: "codestral-2405",
138
- prompt: "def",
139
- suffix: "return a+b",
140
- });
141
- if (res.ok) {
142
- const { value: result } = res;
143
- for await (const event of result) {
144
- // Handle the event
145
- console.log(event);
146
- }
147
- } else {
148
- console.log("fimStream failed:", res.error);
149
- }
150
- }
151
-
152
- run();
153
- ```
154
-
155
- ### Parameters
156
-
157
- | Parameter | Type | Required | Description |
158
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
159
- | `request` | [components.FIMCompletionStreamRequest](../../models/components/fimcompletionstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. |
160
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
161
- | `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. |
162
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
163
-
164
- ### Response
165
-
166
- **Promise\<[EventStream<components.CompletionEvent>](../../models/.md)\>**
167
-
168
- ### Errors
169
-
170
- | Error Type | Status Code | Content Type |
171
- | -------------------------- | -------------------------- | -------------------------- |
172
- | errors.HTTPValidationError | 422 | application/json |
173
- | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -1,6 +0,0 @@
1
- # FineTuning
2
- (*fineTuning*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
@@ -1,379 +0,0 @@
1
- # Jobs
2
- (*fineTuning.jobs*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - Get Fine Tuning Jobs
9
- * [create](#create) - Create Fine Tuning Job
10
- * [get](#get) - Get Fine Tuning Job
11
- * [cancel](#cancel) - Cancel Fine Tuning Job
12
- * [start](#start) - Start Fine Tuning Job
13
-
14
- ## list
15
-
16
- Get a list of fine-tuning jobs for your organization and user.
17
-
18
- ### Example Usage
19
-
20
- <!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_get_fine_tuning_jobs" method="get" path="/v1/fine_tuning/jobs" -->
21
- ```typescript
22
- import { Mistral } from "@mistralai/mistralai";
23
-
24
- const mistral = new Mistral({
25
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
26
- });
27
-
28
- async function run() {
29
- const result = await mistral.fineTuning.jobs.list({});
30
-
31
- console.log(result);
32
- }
33
-
34
- run();
35
- ```
36
-
37
- ### Standalone function
38
-
39
- The standalone function version of this method:
40
-
41
- ```typescript
42
- import { MistralCore } from "@mistralai/mistralai/core.js";
43
- import { fineTuningJobsList } from "@mistralai/mistralai/funcs/fineTuningJobsList.js";
44
-
45
- // Use `MistralCore` for best tree-shaking performance.
46
- // You can create one instance of it to use across an application.
47
- const mistral = new MistralCore({
48
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
49
- });
50
-
51
- async function run() {
52
- const res = await fineTuningJobsList(mistral, {});
53
- if (res.ok) {
54
- const { value: result } = res;
55
- console.log(result);
56
- } else {
57
- console.log("fineTuningJobsList failed:", res.error);
58
- }
59
- }
60
-
61
- run();
62
- ```
63
-
64
- ### Parameters
65
-
66
- | Parameter | Type | Required | Description |
67
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
68
- | `request` | [operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest](../../models/operations/jobsapiroutesfinetuninggetfinetuningjobsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
69
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
70
- | `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. |
71
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
72
-
73
- ### Response
74
-
75
- **Promise\<[components.JobsOut](../../models/components/jobsout.md)\>**
76
-
77
- ### Errors
78
-
79
- | Error Type | Status Code | Content Type |
80
- | --------------- | --------------- | --------------- |
81
- | errors.SDKError | 4XX, 5XX | \*/\* |
82
-
83
- ## create
84
-
85
- Create a new fine-tuning job, it will be queued for processing.
86
-
87
- ### Example Usage
88
-
89
- <!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_create_fine_tuning_job" method="post" path="/v1/fine_tuning/jobs" -->
90
- ```typescript
91
- import { Mistral } from "@mistralai/mistralai";
92
-
93
- const mistral = new Mistral({
94
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
95
- });
96
-
97
- async function run() {
98
- const result = await mistral.fineTuning.jobs.create({
99
- model: "Camaro",
100
- hyperparameters: {
101
- learningRate: 0.0001,
102
- },
103
- });
104
-
105
- console.log(result);
106
- }
107
-
108
- run();
109
- ```
110
-
111
- ### Standalone function
112
-
113
- The standalone function version of this method:
114
-
115
- ```typescript
116
- import { MistralCore } from "@mistralai/mistralai/core.js";
117
- import { fineTuningJobsCreate } from "@mistralai/mistralai/funcs/fineTuningJobsCreate.js";
118
-
119
- // Use `MistralCore` for best tree-shaking performance.
120
- // You can create one instance of it to use across an application.
121
- const mistral = new MistralCore({
122
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
123
- });
124
-
125
- async function run() {
126
- const res = await fineTuningJobsCreate(mistral, {
127
- model: "Camaro",
128
- hyperparameters: {
129
- learningRate: 0.0001,
130
- },
131
- });
132
- if (res.ok) {
133
- const { value: result } = res;
134
- console.log(result);
135
- } else {
136
- console.log("fineTuningJobsCreate failed:", res.error);
137
- }
138
- }
139
-
140
- run();
141
- ```
142
-
143
- ### Parameters
144
-
145
- | Parameter | Type | Required | Description |
146
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
147
- | `request` | [components.JobIn](../../models/components/jobin.md) | :heavy_check_mark: | The request object to use for the request. |
148
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
149
- | `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. |
150
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
151
-
152
- ### Response
153
-
154
- **Promise\<[operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuningcreatefinetuningjobresponse.md)\>**
155
-
156
- ### Errors
157
-
158
- | Error Type | Status Code | Content Type |
159
- | --------------- | --------------- | --------------- |
160
- | errors.SDKError | 4XX, 5XX | \*/\* |
161
-
162
- ## get
163
-
164
- Get a fine-tuned job details by its UUID.
165
-
166
- ### Example Usage
167
-
168
- <!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_get_fine_tuning_job" method="get" path="/v1/fine_tuning/jobs/{job_id}" -->
169
- ```typescript
170
- import { Mistral } from "@mistralai/mistralai";
171
-
172
- const mistral = new Mistral({
173
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
174
- });
175
-
176
- async function run() {
177
- const result = await mistral.fineTuning.jobs.get({
178
- jobId: "c167a961-ffca-4bcf-93ac-6169468dd389",
179
- });
180
-
181
- console.log(result);
182
- }
183
-
184
- run();
185
- ```
186
-
187
- ### Standalone function
188
-
189
- The standalone function version of this method:
190
-
191
- ```typescript
192
- import { MistralCore } from "@mistralai/mistralai/core.js";
193
- import { fineTuningJobsGet } from "@mistralai/mistralai/funcs/fineTuningJobsGet.js";
194
-
195
- // Use `MistralCore` for best tree-shaking performance.
196
- // You can create one instance of it to use across an application.
197
- const mistral = new MistralCore({
198
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
199
- });
200
-
201
- async function run() {
202
- const res = await fineTuningJobsGet(mistral, {
203
- jobId: "c167a961-ffca-4bcf-93ac-6169468dd389",
204
- });
205
- if (res.ok) {
206
- const { value: result } = res;
207
- console.log(result);
208
- } else {
209
- console.log("fineTuningJobsGet failed:", res.error);
210
- }
211
- }
212
-
213
- run();
214
- ```
215
-
216
- ### Parameters
217
-
218
- | Parameter | Type | Required | Description |
219
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
220
- | `request` | [operations.JobsApiRoutesFineTuningGetFineTuningJobRequest](../../models/operations/jobsapiroutesfinetuninggetfinetuningjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
221
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
222
- | `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. |
223
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
224
-
225
- ### Response
226
-
227
- **Promise\<[operations.JobsApiRoutesFineTuningGetFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuninggetfinetuningjobresponse.md)\>**
228
-
229
- ### Errors
230
-
231
- | Error Type | Status Code | Content Type |
232
- | --------------- | --------------- | --------------- |
233
- | errors.SDKError | 4XX, 5XX | \*/\* |
234
-
235
- ## cancel
236
-
237
- Request the cancellation of a fine tuning job.
238
-
239
- ### Example Usage
240
-
241
- <!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_cancel_fine_tuning_job" method="post" path="/v1/fine_tuning/jobs/{job_id}/cancel" -->
242
- ```typescript
243
- import { Mistral } from "@mistralai/mistralai";
244
-
245
- const mistral = new Mistral({
246
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
247
- });
248
-
249
- async function run() {
250
- const result = await mistral.fineTuning.jobs.cancel({
251
- jobId: "6188a2f6-7513-4e0f-89cc-3f8088523a49",
252
- });
253
-
254
- console.log(result);
255
- }
256
-
257
- run();
258
- ```
259
-
260
- ### Standalone function
261
-
262
- The standalone function version of this method:
263
-
264
- ```typescript
265
- import { MistralCore } from "@mistralai/mistralai/core.js";
266
- import { fineTuningJobsCancel } from "@mistralai/mistralai/funcs/fineTuningJobsCancel.js";
267
-
268
- // Use `MistralCore` for best tree-shaking performance.
269
- // You can create one instance of it to use across an application.
270
- const mistral = new MistralCore({
271
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
272
- });
273
-
274
- async function run() {
275
- const res = await fineTuningJobsCancel(mistral, {
276
- jobId: "6188a2f6-7513-4e0f-89cc-3f8088523a49",
277
- });
278
- if (res.ok) {
279
- const { value: result } = res;
280
- console.log(result);
281
- } else {
282
- console.log("fineTuningJobsCancel failed:", res.error);
283
- }
284
- }
285
-
286
- run();
287
- ```
288
-
289
- ### Parameters
290
-
291
- | Parameter | Type | Required | Description |
292
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
293
- | `request` | [operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest](../../models/operations/jobsapiroutesfinetuningcancelfinetuningjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
294
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
295
- | `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. |
296
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
297
-
298
- ### Response
299
-
300
- **Promise\<[operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuningcancelfinetuningjobresponse.md)\>**
301
-
302
- ### Errors
303
-
304
- | Error Type | Status Code | Content Type |
305
- | --------------- | --------------- | --------------- |
306
- | errors.SDKError | 4XX, 5XX | \*/\* |
307
-
308
- ## start
309
-
310
- Request the start of a validated fine tuning job.
311
-
312
- ### Example Usage
313
-
314
- <!-- UsageSnippet language="typescript" operationID="jobs_api_routes_fine_tuning_start_fine_tuning_job" method="post" path="/v1/fine_tuning/jobs/{job_id}/start" -->
315
- ```typescript
316
- import { Mistral } from "@mistralai/mistralai";
317
-
318
- const mistral = new Mistral({
319
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
320
- });
321
-
322
- async function run() {
323
- const result = await mistral.fineTuning.jobs.start({
324
- jobId: "56553e4d-0679-471e-b9ac-59a77d671103",
325
- });
326
-
327
- console.log(result);
328
- }
329
-
330
- run();
331
- ```
332
-
333
- ### Standalone function
334
-
335
- The standalone function version of this method:
336
-
337
- ```typescript
338
- import { MistralCore } from "@mistralai/mistralai/core.js";
339
- import { fineTuningJobsStart } from "@mistralai/mistralai/funcs/fineTuningJobsStart.js";
340
-
341
- // Use `MistralCore` for best tree-shaking performance.
342
- // You can create one instance of it to use across an application.
343
- const mistral = new MistralCore({
344
- apiKey: process.env["MISTRAL_API_KEY"] ?? "",
345
- });
346
-
347
- async function run() {
348
- const res = await fineTuningJobsStart(mistral, {
349
- jobId: "56553e4d-0679-471e-b9ac-59a77d671103",
350
- });
351
- if (res.ok) {
352
- const { value: result } = res;
353
- console.log(result);
354
- } else {
355
- console.log("fineTuningJobsStart failed:", res.error);
356
- }
357
- }
358
-
359
- run();
360
- ```
361
-
362
- ### Parameters
363
-
364
- | Parameter | Type | Required | Description |
365
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
366
- | `request` | [operations.JobsApiRoutesFineTuningStartFineTuningJobRequest](../../models/operations/jobsapiroutesfinetuningstartfinetuningjobrequest.md) | :heavy_check_mark: | The request object to use for the request. |
367
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
368
- | `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. |
369
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
370
-
371
- ### Response
372
-
373
- **Promise\<[operations.JobsApiRoutesFineTuningStartFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuningstartfinetuningjobresponse.md)\>**
374
-
375
- ### Errors
376
-
377
- | Error Type | Status Code | Content Type |
378
- | --------------- | --------------- | --------------- |
379
- | errors.SDKError | 4XX, 5XX | \*/\* |