mistral-openapi-client 0.1.0

Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it.
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

# \BetaLibrariesDocumentsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**libraries_documents_delete_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_delete_v1) | **DELETE** /v1/libraries/{library_id}/documents/{document_id} | Delete a document.
[**libraries_documents_get_extracted_text_signed_url_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_get_extracted_text_signed_url_v1) | **GET** /v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url | Retrieve the signed URL of text extracted from a given document.
[**libraries_documents_get_signed_url_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_get_signed_url_v1) | **GET** /v1/libraries/{library_id}/documents/{document_id}/signed-url | Retrieve the signed URL of a specific document.
[**libraries_documents_get_status_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_get_status_v1) | **GET** /v1/libraries/{library_id}/documents/{document_id}/status | Retrieve the processing status of a specific document.
[**libraries_documents_get_text_content_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_get_text_content_v1) | **GET** /v1/libraries/{library_id}/documents/{document_id}/text_content | Retrieve the text content of a specific document.
[**libraries_documents_get_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_get_v1) | **GET** /v1/libraries/{library_id}/documents/{document_id} | Retrieve the metadata of a specific document.
[**libraries_documents_list_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_list_v1) | **GET** /v1/libraries/{library_id}/documents | List documents in a given library.
[**libraries_documents_reprocess_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_reprocess_v1) | **POST** /v1/libraries/{library_id}/documents/{document_id}/reprocess | Reprocess a document.
[**libraries_documents_update_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_update_v1) | **PUT** /v1/libraries/{library_id}/documents/{document_id} | Update the metadata of a specific document.
[**libraries_documents_upload_v1**](BetaLibrariesDocumentsApi.md#libraries_documents_upload_v1) | **POST** /v1/libraries/{library_id}/documents | Upload a new document.



## libraries_documents_delete_v1

> libraries_documents_delete_v1(library_id, document_id)
Delete a document.

Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index.

### Parameters


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

### Return type

 (empty response body)

### Authorization

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

### 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)


## libraries_documents_get_extracted_text_signed_url_v1

> String libraries_documents_get_extracted_text_signed_url_v1(library_id, document_id)
Retrieve the signed URL of text extracted from a given document.

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.

### Parameters


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

### Return type

**String**

### Authorization

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

### 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)


## libraries_documents_get_signed_url_v1

> String libraries_documents_get_signed_url_v1(library_id, document_id)
Retrieve the signed URL of a specific document.

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.

### Parameters


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

### Return type

**String**

### Authorization

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

### 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)


## libraries_documents_get_status_v1

> models::ProcessingStatusOut libraries_documents_get_status_v1(library_id, document_id)
Retrieve the processing status of a specific document.

Given a library and a document in that library, retrieve the processing status of that document.

### Parameters


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

### Return type

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

### Authorization

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

### 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)


## libraries_documents_get_text_content_v1

> models::DocumentTextContent libraries_documents_get_text_content_v1(library_id, document_id)
Retrieve the text content of a specific document.

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.

### Parameters


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

### Return type

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

### Authorization

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

### 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)


## libraries_documents_get_v1

> models::DocumentOut libraries_documents_get_v1(library_id, document_id)
Retrieve the metadata of a specific document.

Given a library and a document in this library, you can retrieve the metadata of that document.

### Parameters


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

### Return type

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

### Authorization

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

### 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)


## libraries_documents_list_v1

> models::ListDocumentOut libraries_documents_list_v1(library_id, search, page_size, page, filters_attributes, sort_by, sort_order)
List documents in a given library.

Given a library, lists the document that have been uploaded to that library.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**library_id** | **uuid::Uuid** |  | [required] |
**search** | Option<**String**> |  |  |
**page_size** | Option<**i32**> |  |  |[default to 100]
**page** | Option<**i32**> |  |  |[default to 0]
**filters_attributes** | Option<**String**> |  |  |
**sort_by** | Option<**String**> |  |  |[default to created_at]
**sort_order** | Option<**String**> |  |  |[default to desc]

### Return type

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

### Authorization

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

### 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)


## libraries_documents_reprocess_v1

> libraries_documents_reprocess_v1(library_id, document_id)
Reprocess a document.

Given a library and a document in that library, reprocess that document, it will be billed again.

### Parameters


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

### Return type

 (empty response body)

### Authorization

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

### 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)


## libraries_documents_update_v1

> models::DocumentOut libraries_documents_update_v1(library_id, document_id, document_update_in)
Update the metadata of a specific document.

Given a library and a document in that library, update the name of that document.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**library_id** | **uuid::Uuid** |  | [required] |
**document_id** | **uuid::Uuid** |  | [required] |
**document_update_in** | [**DocumentUpdateIn**](DocumentUpdateIn.md) |  | [required] |

### Return type

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

### Authorization

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

### 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)


## libraries_documents_upload_v1

> models::DocumentOut libraries_documents_upload_v1(library_id, file)
Upload a new document.

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

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**library_id** | **uuid::Uuid** |  | [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:  ```bash  file=@path/to/your/file.jsonl;filename=custom_name.jsonl  ```  Otherwise, you can just keep the original file name:  ```bash  file=@path/to/your/file.jsonl  ``` | [required] |

### Return type

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

### Authorization

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

### 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)