API for Identifying Entities in Text - ApyHub

AI Text Entity Recognition API

Artificial Intelligence#entity#recognition#text
ApyHub
ApyHub
verified icon
Starting from 500 atoms
AI tier

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
Azure500
Google500
ApyHub2000

API Playground

This API endpoint does not have a playground yet. Please check back later.

API Documentation

input json: output json
POST
https://api.apyhub.com/ai/text/entity/recognition

Request example

1
curl --location --request POST 'https://api.apyhub.com/ai/text/entity/recognition' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data '{
5
    "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful.",
6
    "language":"en",
7
    "requested_service": "azure",
8
    "azure": {
9
        "key": "your-azure-key",
10
        "endpoint": "your-azure-endpoint"
11
    }
12
}'
Provider (requested_service)Atoms
Azure500
Google500
ApyHub2000
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
textStringYesProvide the textual content for which you want to perform entity recognition.
- The max content size is 125,000 characters.
languageStringYes (if azure is selected in requested_service)the language supported by azure chceck list of supported language link - https://learn.microsoft.com/en-gb/azure/ai-services/language-service/named-entity-recognition/language-support?tabs=ga-api.
encodingStringNo (use if google is selected in requested_service)Provide the textual content encoding format it can be UTF8, UTF16, UTF32 default to UTF8.
requested_serviceStringYesProvide the name of service provider. Supported providers are azure, google, apyhub. Defaults to apyhub.
azure.keyStringYes (if azure is selected in requested_service)Input service key provided by azure.
azure.endpointStringYes (if azure is selected in requested_service)Enter the endpoint provided by azure.
google.keyStringYes (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

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Invalid input - the file is corrupt or the supported inputs are not provided.
401Required authentication information is either missing or not valid for the resource.
500If 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 (on the left side of the navbar) 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

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles