vapi-client 0.4.2

Unofficial crate for Vapi - Voice AI for developers.
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

/*
 * Vapi API
 *
 * Voice AI for developers.
 *
 * The version of the OpenAPI document: 1.0
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct AssemblyAiTranscriber {
    /// This is the transcription provider that will be used.
    #[serde(rename = "provider")]
    pub provider: ProviderTrue,
    /// This is the language that will be set for the transcription.
    #[serde(rename = "language", skip_serializing_if = "Option::is_none")]
    pub language: Option<LanguageTrue>,
    /// Transcripts below this confidence threshold will be discarded.  @default 0.4
    #[serde(
        rename = "confidenceThreshold",
        skip_serializing_if = "Option::is_none"
    )]
    pub confidence_threshold: Option<f64>,
    /// Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming  @default false
    #[serde(
        rename = "enableUniversalStreamingApi",
        skip_serializing_if = "Option::is_none"
    )]
    pub enable_universal_streaming_api: Option<bool>,
    /// This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.  @default false
    #[serde(rename = "formatTurns", skip_serializing_if = "Option::is_none")]
    pub format_turns: Option<bool>,
    /// The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.  @default 0.7
    #[serde(
        rename = "endOfTurnConfidenceThreshold",
        skip_serializing_if = "Option::is_none"
    )]
    pub end_of_turn_confidence_threshold: Option<f64>,
    /// The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.  @default 160
    #[serde(
        rename = "minEndOfTurnSilenceWhenConfident",
        skip_serializing_if = "Option::is_none"
    )]
    pub min_end_of_turn_silence_when_confident: Option<f64>,
    /// The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.  @default 160
    #[serde(
        rename = "wordFinalizationMaxWaitTime",
        skip_serializing_if = "Option::is_none"
    )]
    pub word_finalization_max_wait_time: Option<f64>,
    /// The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.  @default 400
    #[serde(rename = "maxTurnSilence", skip_serializing_if = "Option::is_none")]
    pub max_turn_silence: Option<f64>,
    /// The WebSocket URL that the transcriber connects to.
    #[serde(rename = "realtimeUrl", skip_serializing_if = "Option::is_none")]
    pub realtime_url: Option<String>,
    /// Add up to 2500 characters of custom vocabulary.
    #[serde(rename = "wordBoost", skip_serializing_if = "Option::is_none")]
    pub word_boost: Option<Vec<String>>,
    /// The duration of the end utterance silence threshold in milliseconds.
    #[serde(
        rename = "endUtteranceSilenceThreshold",
        skip_serializing_if = "Option::is_none"
    )]
    pub end_utterance_silence_threshold: Option<f64>,
    /// Disable partial transcripts. Set to `true` to not receive partial transcripts. Defaults to `false`.
    #[serde(
        rename = "disablePartialTranscripts",
        skip_serializing_if = "Option::is_none"
    )]
    pub disable_partial_transcripts: Option<bool>,
    /// This is the plan for voice provider fallbacks in the event that the primary voice provider fails.
    #[serde(rename = "fallbackPlan", skip_serializing_if = "Option::is_none")]
    pub fallback_plan: Option<models::FallbackTranscriberPlan>,
}

impl AssemblyAiTranscriber {
    pub fn new(provider: ProviderTrue) -> AssemblyAiTranscriber {
        AssemblyAiTranscriber {
            provider,
            language: None,
            confidence_threshold: None,
            enable_universal_streaming_api: None,
            format_turns: None,
            end_of_turn_confidence_threshold: None,
            min_end_of_turn_silence_when_confident: None,
            word_finalization_max_wait_time: None,
            max_turn_silence: None,
            realtime_url: None,
            word_boost: None,
            end_utterance_silence_threshold: None,
            disable_partial_transcripts: None,
            fallback_plan: None,
        }
    }
}
/// This is the transcription provider that will be used.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum ProviderTrue {
    #[serde(rename = "assembly-ai")]
    AssemblyAi,
}

impl Default for ProviderTrue {
    fn default() -> ProviderTrue {
        Self::AssemblyAi
    }
}
/// This is the language that will be set for the transcription.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum LanguageTrue {
    #[serde(rename = "en")]
    En,
}

impl Default for LanguageTrue {
    fn default() -> LanguageTrue {
        Self::En
    }
}