This is a Beta API - Undergoing further development. If you have any suggestions, idea or questions about this API please reach us at email@example.com.
This API provides you with a functionality to extract entities(custom, location, person, date, number, organization,datetime,daterange, etc ) from the conversation.
In order to detect entities in conversation we have introduced new parameter for the Async API named
detectEntities which is set to
false by default.
For the Async Audio File and the Async Video File endpoints,
detectEntities is a query parameter, e.g.
https://api.symbl.ai/v1/process/audio?detectEntities=true. For the other APIs it's passed in the JSON Request Body.
Before using the Conversation API you must get the authentication token (
AUTH_TOKEN) from our authentication process.
- Custom Entity
- Person Entity
- Organization Entity
- Date Entity
- Number Entity
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.
|Defines the type of entity present.|
|The value of entity.|
|The text string matched by the algorithm.|
|Contains message references like id, text and offset of entity in message.|
|Optional. Show the custom entity type which was defined.|