Struct StructuredDataPlan

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

Fields

messages: Option<Vec<Value>>

These are the messages used to generate the structured data. @default: [ { \"role\": \"system\", \"content\": \"You are an expert data extractor. You will be given a transcript of a call. Extract structured data per the JSON Schema. DO NOT return anything except the structured data.\\n\\nJson Schema:\\\\n{{schema}}\\n\\nOnly respond with the JSON.\" }, { \"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- {{schema}}: the schema of the structured data from structuredDataPlan.schema- {{endedReason}}: the ended reason of the call from call.endedReason

enabled: Option<bool>

This determines whether structured data is generated and stored in call.analysis.structuredData. Defaults to false. Usage: - If you want to extract structured data, set this to true and provide a schema. @default false

schema: Option<JsonSchema>

This is the schema of the structured data. The output is stored in call.analysis.structuredData. Complete guide on JSON Schema can be found here.

timeout_seconds: Option<f64>

This is how long the request is tried before giving up. When request times out, call.analysis.structuredData will be empty. Usage: - To guarantee the structured data 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 StructuredDataPlan

pub fn new() -> StructuredDataPlan

Trait Implementations

impl Clone for StructuredDataPlan

fn clone(&self) -> StructuredDataPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredDataPlan

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

Formats the value using the given formatter.

impl Default for StructuredDataPlan

fn default() -> StructuredDataPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StructuredDataPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StructuredDataPlan

fn eq(&self, other: &StructuredDataPlan) -> 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 StructuredDataPlan

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 StructuredDataPlan