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

# \AudioTranscriptionsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**audio_api_v1_transcriptions_post**](AudioTranscriptionsApi.md#audio_api_v1_transcriptions_post) | **POST** /v1/audio/transcriptions | Create Transcription
[**audio_api_v1_transcriptions_post_stream**](AudioTranscriptionsApi.md#audio_api_v1_transcriptions_post_stream) | **POST** /v1/audio/transcriptions#stream | Create Streaming Transcription (SSE)



## audio_api_v1_transcriptions_post

> models::TranscriptionResponse audio_api_v1_transcriptions_post(model, file, file_url, file_id, language, temperature, stream, diarize, context_bias, timestamp_granularities)
Create Transcription

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**model** | **String** | ID of the model to be used. | [required] |
**file** | Option<[**std::path::PathBuf**](Std__path__PathBuf.md)> | 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  ``` |  |
**file_url** | Option<**String**> |  |  |
**file_id** | Option<**String**> |  |  |
**language** | Option<**String**> |  |  |
**temperature** | Option<**f64**> |  |  |
**stream** | Option<**bool**> |  |  |[default to false]
**diarize** | Option<**bool**> |  |  |[default to false]
**context_bias** | Option<[**Vec<String>**](String.md)> |  |  |
**timestamp_granularities** | Option<[**Vec<models::TimestampGranularity>**](Models__TimestampGranularity.md)> | Granularities of timestamps to include in the response. |  |

### Return type

[**models::TranscriptionResponse**](TranscriptionResponse.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)


## audio_api_v1_transcriptions_post_stream

> models::TranscriptionStreamEvents audio_api_v1_transcriptions_post_stream(model, file, file_url, file_id, language, temperature, stream, diarize, context_bias, timestamp_granularities)
Create Streaming Transcription (SSE)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**model** | **String** |  | [required] |
**file** | Option<[**std::path::PathBuf**](Std__path__PathBuf.md)> | 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  ``` |  |
**file_url** | Option<**String**> |  |  |
**file_id** | Option<**String**> |  |  |
**language** | Option<**String**> |  |  |
**temperature** | Option<**f64**> |  |  |
**stream** | Option<**bool**> |  |  |[default to true]
**diarize** | Option<**bool**> |  |  |[default to false]
**context_bias** | Option<[**Vec<String>**](String.md)> |  |  |
**timestamp_granularities** | Option<[**Vec<models::TimestampGranularity>**](Models__TimestampGranularity.md)> | Granularities of timestamps to include in the response. |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: multipart/form-data
- **Accept**: text/event-stream

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