About this endpoint
What it does
Extracts keywords from the text you send in the request body. You can also provide an optional language and select whether the extraction should use ApyHub or Azure, with Azure-specific credentials supplied under azure.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| text | String | Yes | The input text to analyze. |
| azure | Object | No | Custom credentials for Azure services. If provided, include any of the nested fields below as needed. |
| 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. |
| language | String | No | Language code for the input text. |
| requested_service | ENUM | No | Which service to use: azure or apyhub. Default: apyhub. |
Response
Returns a JSON object with a data object field. That data object may contain an azure object and/or an apyhub object, depending on which service is used.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Container for the extraction result. |
| data.azure | Object | No | Response object from Microsoft Azure Cognitive Services. |
| data.apyhub | Object | No | Response object from ApyHub language tools. |