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 RequestGET https://api.symbl.ai/v1/conversations/{conversationId}/entities
#
Example API call- cURL
- Javascript
#
Response- Custom Entity
- Person Entity
- Organization Entity
- Date Entity
- Number Entity
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 ObjectField | 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. |