Create a structured data field

Creates a new structured data field configuration that defines what information should be extracted from conversations.

This endpoint supports creating two types of structured data fields:

1. QUESTION type: Defines specific questions to be answered about the conversation Example: “Did the agent offer the correct promotion?”

2. ENTITY type: Defines entities to be identified and extracted Example: Product names mentioned in the conversation

These fields are used by the Structured Data API (/apis/autosummary/create-structured-data) to automatically extract the configured information from conversations.

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

• Question
• Entity

id

string

required

The id of the structured data field

Example:

"q_promotion_was_offered"

name

string

required

The name of the structured data field

Example:

"Promotion was offered"

categoryId

string

required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active

boolean

required

Indicates if the structured data is active or not.

Example:

false

question

object

required

Show child attributes

question.question

string

required

The question that will be answered using the context of the conversation

Example:

"Did the agent offer the correct promotion?"

segmentIds

string[]

required

The segment ids that the structured data field is associated with

id

string

required

The id of the structured data field

Example:

"q_promotion_was_offered"

name

string

required

The name of the structured data field

Example:

"Promotion was offered"

categoryId

string

required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active

boolean

required

Indicates if the structured data is active or not.

Example:

false

question

object

required

Show child attributes

question.question

string

required

The question that will be answered using the context of the conversation

Example:

"Did the agent offer the correct promotion?"

segmentIds

string[]

required

The segment ids that the structured data field is associated with

id

string

required

The id of the structured data field

Example:

"e_product"

name

string

required

The name of the structured data field

Example:

"Product Name"

categoryId

string

required

The category id assigned

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"ENTITY"

active

boolean

required

Indicates if the structured data is active or not

Example:

false

entity

object

required

Show child attributes

entity.name

string

required

The name of the entity.

Example:

"Product Name"

entity.description

string

required

The description of the entity.

Example:

"Product of the company being discussed in the conversation."

entity.examples

string[]

required

A list of example entities that can be extracted from the conversation.

segmentIds

string[]

required

The segment ids that the structured data field is associated with

Response

201

application/json

Structured data field created.

• Question
• Entity

id

string

required

The id of the structured data field

Example:

"q_promotion_was_offered"

name

string

required

The name of the structured data field

Example:

"Promotion was offered"

categoryId

string

required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active

boolean

required

Indicates if the structured data is active or not.

Example:

false

question

object

required

Show child attributes

question.question

string

required

The question that will be answered using the context of the conversation

Example:

"Did the agent offer the correct promotion?"

segmentIds

string[]

required

The segment ids that the structured data field is associated with

id

string

required

The id of the structured data field

Example:

"q_promotion_was_offered"

name

string

required

The name of the structured data field

Example:

"Promotion was offered"

categoryId

string

required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active

boolean

required

Indicates if the structured data is active or not.

Example:

false

question

object

required

Show child attributes

question.question

string

required

The question that will be answered using the context of the conversation

Example:

"Did the agent offer the correct promotion?"

segmentIds

string[]

required

The segment ids that the structured data field is associated with

id

string

required

The id of the structured data field

Example:

"e_product"

name

string

required

The name of the structured data field

Example:

"Product Name"

categoryId

string

required

The category id assigned

Example:

"OUTCOME"

type

string

required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"ENTITY"

active

boolean

required

Indicates if the structured data is active or not

Example:

false

entity

object

required

Show child attributes

entity.name

string

required

The name of the entity.

Example:

"Product Name"

entity.description

string

required

The description of the entity.

Example:

"Product of the company being discussed in the conversation."

entity.examples

string[]

required

A list of example entities that can be extracted from the conversation.

segmentIds

string[]

required

The segment ids that the structured data field is associated with