Receive Entities

info

This is a Beta API - Undergoing further development. If you have any suggestions, idea or questions about this API please reach us at devrelations@symbl.ai.

This API provides you with a functionality to extract entities(custom, location, person, date, number, organization,datetime,daterange, etc ) from the conversation.

HTTP Request

GET https://api.symbl.ai/v1/conversations/{conversationId}/entities

Example API call

cURL

curl "https://api.symbl.ai/v1/conversations/{conversationId}/entities" \

-H "x-api-key: <api_token>"

Javascript

const request = require('request');

const your_auth_token = '<your_auth_token>';

request.get({

url: 'https://api.symbl.ai/v1/conversations/{conversationId}/entities',

headers: { 'x-api-key': your_auth_token },

json: true

}, (err, response, body) => {

console.log(body);

});

Response

Custom Entity

{

"type": "custom",

"customType": "Company Executives",

"value": "marketing director",

"text": "marketing director",

"messageRefs": [

{

"id": "5118221462011904",

"text": "The marketing director is out-of-town due to some work.",

"offset": 4

}

]

}

Person Entity

{

"type": "person",

"value": "jamie smith",

"text": "jamie smith",

"messageRefs": [

{

"id": "5979280332816384",

"text": "The name is Jamie Smith.",

"offset": 12

}

]

}

Organization Entity

{

"type": "organization",

"value": "Vodafone",

"text": "Vodafone",

"messageRefs": [

{

"id": "6141473464516608",

"text": "Hello, this is Peter from Vodafone, I help you today.",

"offset": 26

}

]

}

Date Entity

{

"type": "date",

"value": "2020-07-15",

"text": "today",

"messageRefs": [

{

"id": "6141473464516608",

"text": "Hello, this is Peter from Vodafone, I help you today.",

"offset": 47

},

{

"id": "4603163403354112",

"text": "Being a loyal customer at the three types of plan options that I can offer you today.",

"offset": 79

},

{

"id": "5936512994639872",

"text": "Is there anything else I may assist you with today?",

"offset": 45

}

]

}

Number Entity

{

"type": "number",

"value": "two",

"text": "two",

"messageRefs": [

{

"id": "6137109238775808",

"text": "What do you two think of that?",

"offset": 12

}

]

}

Note:

• In Async Text custom entities needs to be passed in API body.

• In Async Audio/Async Video API needs to be passed in Query Parameter.

Response Object

Field	Description
type	Defines the type of entity present.
value	The value of entity.
text	The text string matched by the algorithm
messageRefs	Contains message references like id, text and offset of entity in message.
customType	Optional. Show the custom entity type which was defined.