vapi_client/models/
server_message_model_output.rs

1/*
2 * Vapi API
3 *
4 * API for building voice assistants
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use serde::{Deserialize, Serialize};
12use utoipa::ToSchema;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
18pub struct ServerMessageModelOutput {
19    #[serde(rename = "phoneNumber", skip_serializing_if = "Option::is_none")]
20    pub phone_number: Option<models::ServerMessageAssistantRequestPhoneNumber>,
21    /// This is the type of the message. \"model-output\" is sent as the model outputs tokens.
22    #[serde(rename = "type")]
23    pub r#type: Type,
24    /// This is the ISO-8601 formatted timestamp of when the message was sent.
25    #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")]
26    pub timestamp: Option<f64>,
27    /// This is a live version of the `call.artifact`.  This matches what is stored on `call.artifact` after the call.
28    #[serde(rename = "artifact", skip_serializing_if = "Option::is_none")]
29    pub artifact: Option<models::Artifact>,
30    /// This is the assistant that is currently active. This is provided for convenience.  This matches one of the following: - `call.assistant`, - `call.assistantId`, - `call.squad[n].assistant`, - `call.squad[n].assistantId`, - `call.squadId->[n].assistant`, - `call.squadId->[n].assistantId`.
31    #[serde(rename = "assistant", skip_serializing_if = "Option::is_none")]
32    pub assistant: Option<models::CreateAssistantDto>,
33    /// This is the customer associated with the call.  This matches one of the following: - `call.customer`, - `call.customerId`.
34    #[serde(rename = "customer", skip_serializing_if = "Option::is_none")]
35    pub customer: Option<models::CreateCustomerDto>,
36    /// This is the call object.  This matches what was returned in POST /call.  Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.
37    #[serde(rename = "call", skip_serializing_if = "Option::is_none")]
38    pub call: Option<models::Call>,
39    /// This is the output of the model. It can be a token or tool call.
40    #[serde(rename = "output")]
41    pub output: serde_json::Value,
42}
43
44impl ServerMessageModelOutput {
45    pub fn new(r#type: Type, output: serde_json::Value) -> ServerMessageModelOutput {
46        ServerMessageModelOutput {
47            phone_number: None,
48            r#type,
49            timestamp: None,
50            artifact: None,
51            assistant: None,
52            customer: None,
53            call: None,
54            output,
55        }
56    }
57}
58/// This is the type of the message. \"model-output\" is sent as the model outputs tokens.
59#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, ToSchema)]
60pub enum Type {
61    #[serde(rename = "model-output")]
62    ModelOutput,
63}
64
65impl Default for Type {
66    fn default() -> Type {
67        Self::ModelOutput
68    }
69}