About this endpoint
What it does
Extracts keywords from the text you provide in the request body. You can optionally include a language hint, custom Azure credentials, and a requested_service value to choose between the Azure and ApyHub keyword-extraction responses.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| text | String | Yes | The input text to analyze for keyword extraction. |
| 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. |
| language | String | No | Language hint for the input text. |
| requested_service | ENUM | No | Which service to use for extraction: azure or apyhub. Default: apyhub. |
Response
Returns a JSON object with a data object field. The data object may contain an azure object and/or an apyhub object, depending on the service used.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | 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. |