vapi_client/models/summary_plan.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 SummaryPlan {
16 /// These are the messages used to generate the summary. @default: ``` [ { \"role\": \"system\", \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\" }, { \"role\": \"user\", \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\" } ]``` You can customize by providing any messages you want. Here are the template variables available: - {{transcript}}: The transcript of the call from `call.artifact.transcript` - {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` - {{endedReason}}: The ended reason of the call from `call.endedReason`
17 #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
18 pub messages: Option<Vec<serde_json::Value>>,
19 /// This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true. Usage: - If you want to disable the summary, set this to false. @default true
20 #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
21 pub enabled: Option<bool>,
22 /// This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty. Usage: - To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond. @default 5 seconds
23 #[serde(rename = "timeoutSeconds", skip_serializing_if = "Option::is_none")]
24 pub timeout_seconds: Option<f64>,
25}
26
27impl SummaryPlan {
28 pub fn new() -> SummaryPlan {
29 SummaryPlan {
30 messages: None,
31 enabled: None,
32 timeout_seconds: None,
33 }
34 }
35}