AI Text Entity Recognition API

About

This Utility API uses AI to identify and categorize entities (categories) within any textual content.

This API can detect entities like public figures, landmarks, restaurants, or stadiums and categorizes them into groups such as locations or people. This API is useful for information extraction, content analysis, and data structuring, offering a streamlined solution for identifying and categorizing entities within text for improved data organization and analysis.

The atoms cost is subjected to change depending on the size of the input file and the provider selected. The list of providers and the atoms cost for each provider is given below:

Provider (requested_service)	Atoms
Azure	500
Google	500
ApyHub	2000

API Playground

ApyHub AI

This API endpoint does not have a playground. You can test it with Voiden.

API Documentation

input json: output json

POST

https://api.apyhub.com/ai/text/entity/recognition

Request example

curl --location --request POST 'https://api.apyhub.com/ai/text/entity/recognition' \
--header 'apy-token: {{token}}' \
--header 'Content-Type: application/json' \
--data '{\n    "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful.",\n    "language":"en",\n    "requested_service": "azure",\n    "azure": {\n        "key": "your-azure-key",\n        "endpoint": "your-azure-endpoint"\n    }\n}'

Provider (requested_service)	Atoms
Azure	500
Google	500
ApyHub	2000

Method: POST

Content Type: application/json

Request Body

Attribute	Type	Mandatory	Description
text	String	Yes	Provide the textual content for which you want to perform entity recognition. - The max content size is 125,000 characters.
language	String	Yes (if `azure` is selected in requested_service)	the language supported by `azure`. Check list of supported languages here.
encoding	String	No (use if `google` is selected in requested_service)	Provide the textual content encoding format; it can be `UTF8`, `UTF16`, `UTF32`, default to `UTF8`.
requested_service	String	Yes	Provide the name of service provider. Supported providers are `azure`, `google`, `apyhub`. Defaults to `apyhub`.
azure.key	String	Yes (if `azure` is selected in requested_service)	Input service key provided by azure.
azure.endpoint	String	Yes (if `azure` is selected in requested_service)	Enter the endpoint provided by azure.
google.key	String	Yes (if `google` is selected in requested_service)	Input service key provided by google.

Sample Response

A successful request returns the entity recognition response in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.

HTTP Response Codes

Status Code	Description
200	The request was successful.
400	Invalid input - the file is corrupt or the supported inputs are not provided.
401	Required authentication information is either missing or not valid for the resource.
500	If any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently, we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings and go to “API Keys".

Points to note:

Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
Use the apy-token as the header parameter to pass the token.
Use the Authorization header to send the basic authentication credentials.

Error codes

{
  "error": {
    "code": 105,
    "message": "Invalid URL"
  }
}

To search for a specific error code, enter the code in the search box below.

101 - Missing parameters

This code is returned when mandatory parameters are missing from the request.

102 - Invalid JSON

This code is returned when invalid JSON is passed in the request body.

103 - Invalid input

This code is returned when an invalid input is provided.

104 - Invalid file

This code is returned when there is an issue with a file.

105 - Invalid URL

This code is returned when there is an issue with a URL.

109 - Invalid input format

This code is returned when input is not provided in the required format.

110 - Server error

This code is returned when an unexpected error occurs while processing a request.