Text Entities Extractor API

Text Entities Extractor API

Unlock the hidden treasures within the unstructured text with our Text Entities Extractor API. Harness the power of AI to effortlessly extract user-defined entities, from specific values like prices and dates to semantic answers like main topics or customer requests. With endless possibilities, your imagination is the only limit. Get ready to dive into a world of precise information retrieval with our powerful and customizable text parser.

About the API: 

Unleash the power of language with our Text Entities Extractor API. This cutting-edge solution combines the might of AI with advanced parsing techniques to extract custom user-defined entities from unstructured text. Say goodbye to manual extraction and embrace the efficiency and accuracy of automated text analysis.

Our API empowers you to extract a wide range of information from textual data. Whether you need to identify exact values such as prices, dates, names, emails, or phone numbers, or seek semantic answers like the main topic, diagnosis, or customer's request, our robust system has got you covered. The versatility of our API knows no bounds, making it an indispensable tool across various industries and applications.

How does it work? Our AI-powered text parser employs state-of-the-art natural language processing algorithms to comprehend and dissect unstructured text. Through advanced machine learning models, it swiftly identifies and extracts the entities that matter most to you. With remarkable precision and speed, you can now automate and streamline your data extraction processes, saving valuable time and resources.

What sets our Text Entities Extractor API apart is its flexibility and adaptability. We understand that every business has unique requirements, and thus, we empower you to define your own entities. Whether it's extracting customer feedback sentiment, analyzing product reviews, or monitoring social media mentions, our API can be easily tailored to suit your specific needs. The possibilities are truly endless, limited only by your imagination and use case.

Seamless integration is at the heart of our API's design. With comprehensive documentation and developer-friendly resources, you can effortlessly integrate our solution into your existing applications and workflows. Whether you're building a chatbot, conducting market research, or enhancing data analytics, our API provides the building blocks for success.

Data privacy and security are paramount to us. We ensure that your textual data remains confidential and secure throughout the extraction process. With robust encryption measures and industry-standard security protocols, you can trust that your sensitive information is in safe hands.

Experience the power of our Text Entities Extractor API and unlock the hidden insights within your unstructured text. Embrace automation, accuracy, and efficiency as you extract valuable entities, transforming raw data into actionable intelligence. Take your data analysis to new heights with our advanced AI-driven solution and gain a competitive edge in the fast-paced world of information extraction.

 

What this API receives and what your API provides (input/output)?

 

Pass the text that you want to extract the entities from. 

 

What are the most common uses cases of this API?

  1. Customer Support Automation: Integrate the Text Entities Extractor API into your customer support system to automatically extract and categorize customer requests. Identify key information such as product names, issue descriptions, and contact details, enabling efficient routing and quicker resolution of support tickets.

  2. Market Research and Sentiment Analysis: Analyze large volumes of unstructured text, such as social media posts, customer reviews, and survey responses, to extract valuable insights. Use the API to identify sentiment, extract product mentions, and categorize feedback, enabling you to make data-driven decisions and improve your products or services.

  3. Fraud Detection and Compliance: Employ the Text Entities Extractor API to analyze text data, such as financial transactions or insurance claims, to identify potential fraud indicators. Extract relevant entities like suspicious names, addresses, or descriptions, enabling proactive fraud detection and compliance with regulatory requirements.

  4. Content Classification and Tagging: Enhance content management systems or recommendation engines by automatically extracting entities from articles, blog posts, or documents. Categorize content based on topics, identify key features, or tag articles with relevant keywords, facilitating efficient content organization and personalized recommendations.

  5. E-commerce Product Catalog Enrichment: Streamline the process of building and maintaining an e-commerce product catalog by utilizing the API to extract entities like product names, descriptions, prices, and attributes from unstructured data sources. Automate catalog creation, update product information, and improve searchability and filtering options for a seamless shopping experience.

 

Are there any limitations to your plans?

Besides the number of API calls, there is no other limitation

API Documentation

Endpoints


Input Text

  • Text to extract entities from.
  • Up to 50,000 characters long.

example: "The quick brown fox jumps over the lazy dog."

Input Entities:

  • An array of custom query entities to extract from the text, up to 12 entities per request.
  • Each entity entry is described by a JSON with 3-4 key-value pairs:
    • "description": a free text description of the entity, up to 100 characters long.
    • "type": desired entity value output format, any of: "string", "float", "integer" or "boolean".
    • "var_name": a descriptive entity variable name to be used in the output results, up to 40 characters long. It must start with a letter, followed by letters, digits, or underscores.
    • (optional) "valid_values": an array of valid extracted entity values - use it to limit the extracted entity value to one of pre-defined possible values. Up to 20 values, up to 40 characters each.

example: [{"description: "number of animals mentioned in text", "type": "integer", "var_name": num_of_animals"}]



                                                                            
POST https://zylalabs.com/api/2210/text+entities+extractor+api/2057/get+entities
                                                                            
                                                                        

Get Entities - Endpoint Features
Object Description
Request Body [Required] Json
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"results":{"first_name":"John","last_name":"Doe","age":32,"state":"CA"},"stats":{"n_text_characters":94,"n_entities":4,"n_tokens_used":369}}
                                                                                                                                                                                                                    
                                                                                                    

Get Entities - CODE SNIPPETS


curl --location --request POST 'https://zylalabs.com/api/2210/text+entities+extractor+api/2057/get+entities' --header 'Authorization: Bearer YOUR_API_KEY' 
--data-raw '{
    "text": "John Doe is 32 years old, lives in California, and works as a professional fictional character",
    "entities": [
        {
            "var_name": "first_name",
            "type": "string",
            "description": "first name of the person"
        },
        {
            "var_name": "last_name",
            "type": "string",
            "description": "last name of the person"
        },
        {
            "var_name": "age",
            "type": "integer",
            "description": "age of the person in years"
        },
        {
            "var_name": "state",
            "type": "string",
            "description": "US state of residence, format: 2 letters abbreviation"
        }
    ]
}'

    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Text Entities Extractor API REST API, simply include your bearer token in the Authorization header.

Headers

Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.

🚀 Enterprise
Starts at
$ 10,000/Year

  • Custom Volume
  • Dedicated account manager
  • Service-level agreement (SLA)

Customer favorite features

  • ✔︎ Only Pay for Successful Requests
  • ✔︎ Free 7-Day Trial
  • ✔︎ Multi-Language Support
  • ✔︎ One API Key, All APIs.
  • ✔︎ Intuitive Dashboard
  • ✔︎ Comprehensive Error Handling
  • ✔︎ Developer-Friendly Docs
  • ✔︎ Postman Integration
  • ✔︎ Secure HTTPS Connections
  • ✔︎ Reliable Uptime

The API can handle input texts that are up to 50,000 characters long, allowing you to process substantial amounts of unstructured text data.

You can extract up to 12 custom query entities per API request. Each entity is defined by a JSON object with a description, type, variable name, and an optional list of valid values.

The "description" field allows you to provide a free-text description of the entity you want to extract. This description helps clarify the nature and purpose of the entity for better understanding and organization.

The API supports four types of entity value output formats: "string," "float," "integer," and "boolean." You can choose the appropriate format based on the nature of the entity you want to extract.

Yes, you can include the "valid_values" field in the entity JSON object to specify an array of pre-defined values. This feature ensures that the extracted entity value matches one of the specified valid values.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.

The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.

Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]

Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.

API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.

Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.

To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.

To check how many API calls you have left for the current month, look at the ‘X-Zyla-API-Calls-Monthly-Remaining’ header. For example, if your plan allows 1000 requests per month and you've used 100, this header will show 900.

To see the maximum number of API requests your plan allows, check the ‘X-Zyla-RateLimit-Limit’ header. For instance, if your plan includes 1000 requests per month, this header will display 1000.

The ‘X-Zyla-RateLimit-Reset’ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3600, it means 3600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

To let you experience our APIs without any commitment, we offer a 7-day free trial that allows you to make API calls at no cost during this period. Please note that you can only use this trial once, so make sure to use it with the API that interests you the most. Most of our APIs provide a free trial, but some may not support it.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it’s important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.

When you subscribe to an API trial, you can make only 25% of the calls allowed by that plan. For example, if the API plan offers 1000 calls, you can make only 250 during the trial. To access the full number of calls offered by the plan, you will need to subscribe to the full plan.

 Service Level
100%
 Response Time
697ms

Category:

NLP

Related APIs