Skip to main content
Design effective Structured Data, add fields in the AI Console, and retrieve the extracted data. For concepts and examples, see the Structured Data overview.

Principles for writing effective structured data

Even though SD questions are created in a defined way to elicit Yes/No responses, the model also outputs “Not Found” values for information that is genuinely absent from the transcripts.
  • Binary answers: Questions must elicit Yes/No responses unless the data is truly unavailable or the question is inapplicable. (e.g., Did the customer mention an issue with the website?)
  • Neutral language: Avoiding bias and the use of complex phrasing can help better understand the questions. (e.g., Did the agent schedule a follow-up call?)
  • Observable evidence: Questions must be based on verifiable information present in the conversation. (e.g., Did the customer apply for a credit card?)
  • Domain-agnostic framing: Use language applicable to any customer service interaction regardless of industry. (e.g., Was the issue the customer contacted about resolved?)
  • Avoid redundancy: Each question should cover a unique aspect of the conversation. (e.g., Did the customer request to dispute any transaction?)

Best practices

To create high-quality Structured Data, follow these guidelines.

Do

  • Write in plain, simple language
  • Ask one thing at a time
  • Make questions easy to verify from the conversation
  • Keep wording objective

Avoid

  • Vague wording
  • Subjective interpretation
  • Questions with multiple parts
  • Overlapping questions that measure the same concept
  • Assumptions not supported by the interaction
  • Conditional “if then” cases (currently not supported)

Better vs. less effective examples

BetterLess effective
Did the customer ask for a refund?Was the service experience poor?
Did the customer mention a website issue?Did the customer have a valid complaint?
Did the agent schedule a callback?Did the agent do a good job?
The stronger version is always clearer, more observable, and more consistent.

Quick start framework

Use the following framework to create your own Structured Data set.
1

Define your objective

What do you want to measure?Examples: Issue resolution, customer dissatisfaction, refund behavior, cancellation risk, upsell opportunities, repeat contacts.
2

Convert the objective into a clear question

Ask something that can be answered from the conversation itself.
Objective: Track escalation
Question: Did the customer ask to speak to a supervisor or manager?
3

Select the answer type

Choose the format that best fits the field.
  • SD questions: Yes/No for events or behaviors
  • Entities:
    • Text for names or descriptions
    • Date for dates
    • Amount for charges, refunds, or credits
    • String for IDs such as order numbers
4

Review for clarity

Ask:
  • Is the question easy to understand?
  • Can it be answered consistently?
  • Is it different from the other questions?

Before you begin

Before configuring Structured Data, ensure you have access to the CX with the necessary permissions to manage Structured Data settings.

Configure structured data questions / entities

To add new structured data questions or entities, navigate to the Structured Data tab under the AI Summary section in the AI Console sidebar and click the Create button in the top-right corner. Then, follow the steps below to configure your new structured data question or entity.
1

Add the Name of the SD question / entity

The Name should be simple and precise and can be used to identify the question.
This section has a character limit of 150.
2

Add the description for the SD question / entity

Be as clear and descriptive of the question as possible to get the most accurate results.
This section has a character limit of 200.
3

Select the Category of the SD question / entity

Categories are structural groupings designed to logically organize and consolidate Structured Data questions. By sorting questions into distinct buckets, categories streamline data management and improve accessibility.AI Console currently contains the following category buckets:
CategoryDescriptionExample
COMPLAINTSCaptures explicit dissatisfaction or grievance made by the customer regarding the company’s products, services, policies, or the customer service interaction itself.”Did the customer complain about the service?”
DEFAULTCaptures information and procedure that is standard or conversational, without expressing complaint, sentiment, commitment, refusal, or outcome.”Did the customer provide their Social Security Number?”
DENIALSCaptures direct refusals, rejections, or contradictions of a request or claim, either by the agent or the customer.”Did the agent deny the claim on the call?”
OUTCOMECaptures the conclusive state, status, or end result of the issues discussed in the conversation.”Did the customer ask for a live agent?”
PROMISESCaptures follow-ups or a guaranteed indication of intention to take actions vital for compliance.”Was any follow-up action scheduled by the agent?”
SENTIMENTCaptures the emotional state, attitude, or tone of the speaker (positive, negative, or neutral).”Did the customer use offensive or abusive language?”
4

Add Examples for entities

For entities, you can add a variety of examples of the values to be captured by the model for the most accurate results.
This section has a character limit of 1000.
For an entity like Date of Birth or Purchase Date, you can add unique examples of how the customer might provide that information:
  • 11/23/1996
  • May first twenty twenty five
  • July 4th 2k18
5

Add a Segment tag to the SD question / entity (optional)

A Segment is a resource that allows users to control which structured data fields are extracted for different types of conversations.When extracting data from a conversation, the structured data system will:
  • Check which segments’ queries match the conversation’s metadata
  • Only extract the structured data fields associated with matching segments
Learn more about segments and how to use them in the Segments and customization section.
When SD questions are not added to newly created segments, they are automatically added to the Global Segment.
Create Structured Data
Once you’ve configured your entities and questions, they’ll appear in the Structured Data interface where you can edit, delete, or manage their visibility as needed. For more on segments and self-serve configuration, see Segments and customization.

Retrieving structured data

To access and extract Structured Data for your analyses, you can use either of the following methods:
  • User interface: Review the associated SD tags by navigating to the Conversation Explorer, selecting an individual conversation, and clicking the Structured Data tab on the right-hand panel. You can also view extracted structured data under the Historical Data section within the AI Console interface, and download it as a report in either CSV or PDF format.
  • API: Programmatically fetch extracted Structured Data for a conversation using the Retrieve Structured Data API.
  • BI system integration: For automated, large-scale extraction, route Structured Data tags directly into your internal Business Intelligence platforms by configuring a data pipeline to ASAPP’s S3 bucket. Contact your ASAPP account team to enable this feature.
Successfully created Structured Data returns extracted data within 24 hours.

Next steps

Segments and customization

learn how to use Segments to control which SD questions are extracted for different types of conversations