Struct SummaryPlan

pub struct SummaryPlan {
    pub messages: Option<Vec<Value>>,
    pub enabled: Option<bool>,
    pub timeout_seconds: Option<f64>,
}

Fields

messages: Option<Vec<Value>>

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

enabled: Option<bool>

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

timeout_seconds: Option<f64>

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

Implementations

impl SummaryPlan

pub fn new() -> SummaryPlan

Trait Implementations

impl Clone for SummaryPlan

fn clone(&self) -> SummaryPlan

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SummaryPlan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SummaryPlan

fn default() -> SummaryPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SummaryPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SummaryPlan

fn eq(&self, other: &SummaryPlan) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SummaryPlan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SummaryPlan