Structured Data Fields

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:

QUESTION type: Defines specific questions to be answered about the conversation Example: “Did the agent offer the correct promotion?”
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.

POST

configuration

structured-data-fields

curl --request POST \
  --url https://api.sandbox.asapp.com/configuration/v1/structured-data-fields \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}'

{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

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

Response

201

application/json

Structured data field created.

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

Was this page helpful?

Update a redaction entity List structured data fields

curl --request POST \
  --url https://api.sandbox.asapp.com/configuration/v1/structured-data-fields \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}'

{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}

ASAPP APIs

Authorizations

Body

Response