/
Root Cause Event Schema 1.0

Root Cause Event Schema 1.0

Overview

This schema represents the processed data from a customer interaction, including summary, intent, and dissatisfaction analysis.

Schema Version

  • Version: v1.0

Root Level Structure

Metadata

Field

Type

Description

Example

Field

Type

Description

Example

schema_version

String

Version of the schema

"v1.0"

statusCode

Integer

HTTP-like status code of processing

200

Summary Object

Field

Type

Description

Example

Field

Type

Description

Example

filename

String

Unique identifier for the audio file

“67c83dba-63f5-42ad-8274-6dbf654d6451.wav”

requestid

String

Unique request identifier

”69e987b4-b66d-4d9b-a876-28faae447832”

company

String

Company name

”ACME Corporation”

organisation

String

Specific organization

”North America”

folder

String

Categorization folder

”Support”

processed

Boolean

Whether the call was processed

true

process_result

String

Result of processing

Complete

Call Summary Sub-Object

Field

Type

Description

Example

Field

Type

Description

Example

classifier

String

Type of classification

”summary”

summary

String

Generated text summary of the call

”The customer contacted the company to update their…[truncated]”

multiple_summary_flag

Integer

Flag for multiple summaries

0

Client Words

Field

Type

Description

Field

Type

Description

clientwords

String

Transcribed text with placeholders

Intent Object

Identical structure to Summary Object, with additional fields:

Call Intent Sub-Object

Field

Type

Description

Example

Field

Type

Description

Example

classifier

String

Type of classification

”intent”

identified_intent

Boolean

Whether an intent was identified

true

reason

String

Explanation of intent

”The customer contacted the company to update their…[truncated]”

dimension_category_id

Null/String

Categorical identifier

null

category_name

String

Main category

”support”

sub_category_name

String

Specific sub-category

”update address”

version

String

Classification version

"vi8"

Dissatisfaction Object

Similar to Intent Object, with:

Call Dissatisfaction Sub-Object

Field

Type

Description

Example

Field

Type

Description

Example

classifier

String

Type of classification

"dissatisfaction"

identified_dissatisfaction

Boolean

Whether dissatisfaction was identified

false

reason

String

Explanation of dissatisfaction

""

dimension_category_id

Null/String

Categorical identifier

null

category_name

String

Main category

"uncategorised"

sub_category_name

String

Specific sub-category

"uncategorised"

version

String

Classification version

"0"

Key Object

Field

Type

Description

Example

Field

Type

Description

Example

requestid

String

Request identifier

"dev-apse2-voiceai-s3-ml-development"

mediafilename

String

Name of media file

"coming soon"

Redaction Placeholders

Placeholders used in transcription:

  • [NUM]: Numeric value

  • [PERSON]: Personal name

  • [CAP]: Capitalized word

  • [DATE]: Date reference

  • [CHAR]: Character sequence

  • [LOC]: Location reference

Processing Flags

  • processed: Indicates complete processing

  • identified_intent: Confirms intent classification

  • identified_dissatisfaction: Confirms dissatisfaction assessment

Related content

Copyright © VoiceAI Pty Ltd 2021, All Rights Reserved