Skip to main content

What is a Conversation Result

Conversation results are information fields collected by the AI agent during the conversation process. These fields track important details like user information, conversation summaries, and satisfaction metrics that can be used for reporting and follow-up actions.

Prerequisites

  • Basic understanding of YAML syntax
  • Access to Flametree agent configuration
  • Understanding of agent workflow concepts

Format

Each field follows this structure:

- field_name: FieldName
kind: FormInfoField
field_description: Description text

Formatting Rules

  • Start each field with a hyphen (-)
  • Use 2-space indentation for properties
  • field_name should use CamelCase
  • kind is always FormInfoField
  • Use single-line descriptions when possible
  • For multi-line descriptions, use the > character

Basic Field Examples

Simple Fields

- field_name: ConversationSummary
kind: FormInfoField
field_description: Running summary of the conversation. Must be updated after every message from user.

- field_name: UserFullName
kind: FormInfoField
field_description: User's name

Multi-line Description

- field_name: UserEmail
kind: FormInfoField
field_description: >
User's contact email. Only fill when
explicitly provided by the user.

Boolean Field

- field_name: IsClientSatisfied
kind: FormInfoField
field_description: True/False flag whether client is satisfied by the conversation

Complete Configuration Example

Here's a comprehensive example showing various types of conversation result fields:

- field_name: ConversationSummary
kind: FormInfoField
field_description: Running summary of the conversation. Must be updated after every message from user.

- field_name: UserFullName
kind: FormInfoField
field_description: User's name

- field_name: UserEmail
kind: FormInfoField
field_description: >
User's contact email

- field_name: UserPhoneNumber
kind: FormInfoField
field_description: >
User's contact phone number

- field_name: TopicForContact
kind: FormInfoField
field_description: When filling out email or phone number, provide details about the topic for the requested communication.

- field_name: UnansweredQuery
kind: FormInfoField
field_description: A user query that cannot be answered using the FAQs.

- field_name: IsClientSatisfied
kind: FormInfoField
field_description: True/False flag whether client is satisfied by the conversation