Learn how to customize the data extracted with Structured Data.
structured data fields
to expand the types of data you can extract.segments
to customize which sets of structured data are extracted for a defined type of conversation.structured-data-field
. You would have an initial set of structured data fields set up for you by ASAPP, but you can also query and create custom structured data fields yourself.
To create a custom structured data field, you need to create a new structured-data-field
object with the following fields:
id
: Your unique identifier for the structured data field. Must begin with q_
or e_
.name
: The name of the structured data field.categoryId
: The category of the structured data field. Must be either OUTCOME or CUSTOM.type
: The type of the structured data field. Must be either QUESTION or ENTITY.question
: The question that will be answered using the context of the conversation.active
: Whether the structured data field is active.200
and the newly created structured-data-field
object in the response body.
segment
object with the following fields:
id
: Your unique identifier for the segment.name
: The name of the segment.query
: The query that defines which conversations are included in the segment.structuredDataFieldIds
: The list of structured data field ids that are included in the segment.raw
that uses a SQL-like syntax with a focused set of operators for clear and precise matching.
The query language supports these key elements:
Logical Operators
AND
, OR
, NOT
- Combine conditions()
for grouping and precedencefield = 'value'
field IN ['value1', 'value2']
Field | Description |
---|---|
lob_id | Line of business identifier |
lob_name | Line of business name |
group_id | Group identifier |
group_name | Group name |
agent_routing_code | Agent’s routing attribute |
campaign | Activities related to the issue |
device_type | Client’s device type (TABLET, PHONE, DESKTOP, WATCH, OTHER) |
platform | Client’s platform type (SMS, WEB, IOS, ANDROID, APP, LOCAL, VOICE, VOICE_IOS, VOICE_ANDROID, VOICE_ECHO, VOICE_HOMEPOD, VOICE_GGLHOME, VOICE_WEB, APPLEBIZ, GOOGLEBIZ, GBM, WAB) |
company_segment | Company’s segment(s) that the issue belongs to |
company_subdivision | Company’s subdivision that the issue belongs to |
business_rule | Business rule to use |
entry_type | Way the issue started and created in the system |
operating_system | Operating system used to enter the issue (MAC_OS, LINUX, WINDOWS, ANDROID, IOS, OTHER) |
browser_type | Browser type used |
browser_version | Browser version used |
Field | Description |
---|---|
intent_code | Intent identifier |
intent_name | Intent name |
Match conversations for mobile products AND the iOS platform
Match conversations for up-sell and cross-sell opportunities
Match high-priority complaints
Match billing conversations for wireless and broadband services