Struct SuccessEvaluationPlan

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

Fields

rubric: Option<RubricTrue>

This enforces the rubric of the evaluation. The output is stored in call.analysis.successEvaluation. Options include: - ‘NumericScale’: A scale of 1 to 10. - ‘DescriptiveScale’: A scale of Excellent, Good, Fair, Poor. - ‘Checklist’: A checklist of criteria and their status. - ‘Matrix’: A grid that evaluates multiple criteria across different performance levels. - ‘PercentageScale’: A scale of 0% to 100%. - ‘LikertScale’: A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly Disagree. - ‘AutomaticRubric’: Automatically break down evaluation into several criteria, each with its own score. - ‘PassFail’: A simple ‘true’ if call passed, ‘false’ if not. Default is ‘PassFail’.

messages: Option<Vec<Value>>

These are the messages used to generate the success evaluation. @default: [ { \"role\": \"system\", \"content\": \"You are an expert call evaluator. You will be given a transcript of a call and the system prompt of the AI participant. Determine if the call was successful based on the objectives inferred from the system prompt. DO NOT return anything except the result.\\n\\nRubric:\\\\n{{rubric}}\\n\\nOnly respond with the result.\" }, { \"role\": \"user\", \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n\" }, { \"role\": \"user\", \"content\": \"Here was the system prompt of the call:\\n\\n{{systemPrompt}}\\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- {{rubric}}: the rubric of the success evaluation from successEvaluationPlan.rubric- {{endedReason}}: the ended reason of the call from call.endedReason

enabled: Option<bool>

This determines whether a success evaluation is generated and stored in call.analysis.successEvaluation. Defaults to true. Usage: - If you want to disable the success evaluation, 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.successEvaluation will be empty. Usage: - To guarantee the success evaluation 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 SuccessEvaluationPlan

pub fn new() -> SuccessEvaluationPlan

Trait Implementations

impl Clone for SuccessEvaluationPlan

fn clone(&self) -> SuccessEvaluationPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SuccessEvaluationPlan

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

Formats the value using the given formatter.

impl Default for SuccessEvaluationPlan

fn default() -> SuccessEvaluationPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SuccessEvaluationPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SuccessEvaluationPlan

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

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 SuccessEvaluationPlan