vapi_client/models/custom_transcriber.rs
1/*
2 * Vapi API
3 *
4 * Voice AI for developers.
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct CustomTranscriber {
16 /// This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.
17 #[serde(rename = "provider")]
18 pub provider: ProviderTrue,
19 /// This is where the transcription request will be sent. Usage: 1. Vapi will initiate a websocket connection with `server.url`. 2. Vapi will send an initial text frame with the sample rate. Format: ``` { \"type\": \"start\", \"encoding\": \"linear16\", // 16-bit raw PCM format \"container\": \"raw\", \"sampleRate\": {{sampleRate}}, \"channels\": 2 // customer is channel 0, assistant is channel 1 } ``` 3. Vapi will send the audio data in 16-bit raw PCM format as binary frames. 4. You can read the messages something like this: ``` ws.on('message', (data, isBinary) => { if (isBinary) { pcmBuffer = Buffer.concat([pcmBuffer, data]); console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`); } else { console.log('Received message:', JSON.parse(data.toString())); } }); ``` 5. You will respond with transcriptions as you have them. Format: ``` { \"type\": \"transcriber-response\", \"transcription\": \"Hello, world!\", \"channel\": \"customer\" | \"assistant\" } ```
20 #[serde(rename = "server")]
21 pub server: models::Server,
22 /// This is the plan for voice provider fallbacks in the event that the primary voice provider fails.
23 #[serde(rename = "fallbackPlan", skip_serializing_if = "Option::is_none")]
24 pub fallback_plan: Option<models::FallbackTranscriberPlan>,
25}
26
27impl CustomTranscriber {
28 pub fn new(provider: ProviderTrue, server: models::Server) -> CustomTranscriber {
29 CustomTranscriber {
30 provider,
31 server,
32 fallback_plan: None,
33 }
34 }
35}
36/// This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.
37#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
38pub enum ProviderTrue {
39 #[serde(rename = "custom-transcriber")]
40 CustomTranscriber,
41}
42
43impl Default for ProviderTrue {
44 fn default() -> ProviderTrue {
45 Self::CustomTranscriber
46 }
47}