About this endpoint
What it does
Recognizes entities in a text string and returns a JSON object containing provider-specific results under data. You can submit the text and optionally provide Azure or Google credentials/configuration, then choose which service to use via requested_service or let it default to ApyHub.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| text | String | Yes | Text to analyze for entity recognition. |
| azure | Object | No | Custom credentials for Azure services. See schema for nested fields. |
| azure.key | String | No | Azure subscription key. |
| azure.region | String | No | Azure service region. |
| azure.endpoint | String | No | Azure endpoint URL. |
| azure.account_id | String | No | Azure account ID. |
| azure.access_token | String | No | OAuth access token for Azure service. |
| Object | No | Custom credentials for Google services. See schema for nested fields. | |
| google.google_language | String | No | Target language locale. |
| google.google_credential_json | Object | No | Google service account credential JSON. See schema for nested fields. |
| encoding | String | No | Text encoding. |
| language | String | No | Language code for the input text. |
| requested_service | ENUM | No | Service to use. Allowed values: azure, google, apyhub. Default: apyhub. |
Response
Returns a JSON object with a data object field containing provider-specific result objects for azure, apyhub, and google. The schema defines these as top-level keys inside data, each represented as an object.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Container for provider-specific response objects. |
| data.azure | Object | No | Response object from Microsoft Azure Cognitive Services. |
| data.apyhub | Object | No | Response object from ApyHub language tools. |
| data.google | Object | No | Response object from Google Cloud NLP API. |