mistral-rouille 1.1.4

Mistral Rouille is a Rust crate customized from Mistral's official OpenAPI specification. This crate provides a convenient and type-safe interface for interacting with Mistral's API, using the Reqwest crate for HTTP requests. Designed to be easily integrated into your Rust projects, Mistral Rouille offers robust functionality for all Mistral API endpoints, ensuring seamless communication with the configured endpoint.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376

# \DefaultApi

All URIs are relative to *https://api.mistral.ai/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_chat_completion**](DefaultApi.md#create_chat_completion) | **POST** /chat/completions | Create Chat Completions
[**create_embedding**](DefaultApi.md#create_embedding) | **POST** /embeddings | Create Embeddings
[**create_fim_completion**](DefaultApi.md#create_fim_completion) | **POST** /fim/completions | Create FIM Completions
[**files_api_routes_delete_file**](DefaultApi.md#files_api_routes_delete_file) | **DELETE** /files/{file_id} | Delete File
[**files_api_routes_list_files**](DefaultApi.md#files_api_routes_list_files) | **GET** /files | List Files
[**files_api_routes_retrieve_file**](DefaultApi.md#files_api_routes_retrieve_file) | **GET** /files/{file_id} | Retrieve File
[**files_api_routes_upload_file**](DefaultApi.md#files_api_routes_upload_file) | **POST** /files | Upload File
[**jobs_api_routes_fine_tuning_cancel_fine_tuning_job**](DefaultApi.md#jobs_api_routes_fine_tuning_cancel_fine_tuning_job) | **POST** /fine_tuning/jobs/{job_id}/cancel | Cancel Fine Tuning Job
[**jobs_api_routes_fine_tuning_create_fine_tuning_job**](DefaultApi.md#jobs_api_routes_fine_tuning_create_fine_tuning_job) | **POST** /fine_tuning/jobs | Create Fine Tuning Job
[**jobs_api_routes_fine_tuning_get_fine_tuning_job**](DefaultApi.md#jobs_api_routes_fine_tuning_get_fine_tuning_job) | **GET** /fine_tuning/jobs/{job_id} | Get Fine Tuning Job
[**jobs_api_routes_fine_tuning_get_fine_tuning_jobs**](DefaultApi.md#jobs_api_routes_fine_tuning_get_fine_tuning_jobs) | **GET** /fine_tuning/jobs | List Fine Tuning Jobs
[**list_models**](DefaultApi.md#list_models) | **GET** /models | List Available Models



## create_chat_completion

> models::ChatResponse create_chat_completion(chat_request)
Create Chat Completions

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**chat_request** | [**ChatRequest**](ChatRequest.md) |  | [required] |

### Return type

[**models::ChatResponse**](ChatResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_embedding

> models::EmbeddingResponse create_embedding(embedding_request)
Create Embeddings

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**embedding_request** | [**EmbeddingRequest**](EmbeddingRequest.md) |  | [required] |

### Return type

[**models::EmbeddingResponse**](EmbeddingResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_fim_completion

> models::FimCompletionResponse create_fim_completion(fim_completion_request)
Create FIM Completions

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fim_completion_request** | [**FimCompletionRequest**](FimCompletionRequest.md) |  | [required] |

### Return type

[**models::FimCompletionResponse**](FIMCompletionResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## files_api_routes_delete_file

> models::DeleteFileOut files_api_routes_delete_file(file_id)
Delete File

Delete a file.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** |  | [required] |

### Return type

[**models::DeleteFileOut**](DeleteFileOut.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## files_api_routes_list_files

> models::ListFilesOut files_api_routes_list_files()
List Files

Returns a list of files that belong to the user's organization.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ListFilesOut**](ListFilesOut.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## files_api_routes_retrieve_file

> models::RetrieveFileOut files_api_routes_retrieve_file(file_id)
Retrieve File

Returns information about a specific file.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**file_id** | **String** |  | [required] |

### Return type

[**models::RetrieveFileOut**](RetrieveFileOut.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## files_api_routes_upload_file

> models::UploadFileOut files_api_routes_upload_file(purpose, file)
Upload File

Upload a file that can be used across various endpoints.  The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files.  Please contact us if you need to increase these storage limits.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**purpose** | Option<[**serde_json::Value**](serde_json::Value.md)> |  | [required] |
**file** | **std::path::PathBuf** | The File object (not file name) to be uploaded.   To upload a file and specify a custom file name you should format your request as such:   ```   file=@path/to/your/file.jsonl;filename=custom_name.jsonl   ```  Otherwise, you can just keep the original file name:   ```   file=@path/to/your/file.jsonl   ```  | [required] |

### Return type

[**models::UploadFileOut**](UploadFileOut.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: multipart/form-data
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## jobs_api_routes_fine_tuning_cancel_fine_tuning_job

> models::DetailedJobOut jobs_api_routes_fine_tuning_cancel_fine_tuning_job(job_id)
Cancel Fine Tuning Job

Request the cancellation of a fine tuning job.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::DetailedJobOut**](DetailedJobOut.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## jobs_api_routes_fine_tuning_create_fine_tuning_job

> models::FineTuningJobResponse jobs_api_routes_fine_tuning_create_fine_tuning_job(job_in, dry_run)
Create Fine Tuning Job

Create a new fine tuning job, it will be queued for processing.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_in** | [**JobIn**](JobIn.md) |  | [required] |
**dry_run** | Option<**bool**> |  |  |[default to false]

### Return type

[**models::FineTuningJobResponse**](FineTuningJobResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## jobs_api_routes_fine_tuning_get_fine_tuning_job

> models::DetailedJobOut jobs_api_routes_fine_tuning_get_fine_tuning_job(job_id)
Get Fine Tuning Job

Get a fine tuned job details by its UUID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::DetailedJobOut**](DetailedJobOut.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## jobs_api_routes_fine_tuning_get_fine_tuning_jobs

> models::JobsOut jobs_api_routes_fine_tuning_get_fine_tuning_jobs(page, page_size, model, status, created_after, created_by_me, wandb_project, wandb_name, suffix)
List Fine Tuning Jobs

Get a list of fine tuning jobs for your organization and user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | The page number of the results to be returned. |  |[default to 0]
**page_size** | Option<**i32**> | The number of items to return per page. |  |[default to 100]
**model** | Option<**String**> | The model name used for fine-tuning to filter on. When set, the other results are not displayed. |  |
**status** | Option<**String**> | The current job state to filter on. When set, the other results are not displayed. |  |
**created_after** | Option<**String**> |  |  |
**created_by_me** | Option<**bool**> |  |  |[default to false]
**wandb_project** | Option<**String**> |  |  |
**wandb_name** | Option<**String**> |  |  |
**suffix** | Option<**String**> |  |  |

### Return type

[**models::JobsOut**](JobsOut.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_models

> models::ModelList list_models()
List Available Models

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ModelList**](ModelList.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)