Back to home

Documentation

Learn how to use Inolio.

Extractors

Extractors in Inolio provide a streamlined approach to transforming raw text into structured data. They allow users to set up preconfigured APIs based on a defined JSON schema. Once an extractor is created, it can be easily integrated into production workflows and services without requiring the schema to be redefined for each new request. Users simply supply the input text to be processed by the extractor's API.

Why use extractors?

Extractors offer several advantages:

  • Simplicity: By pre-defining the JSON schema, extractors simplify the data transformation process, eliminating the need to repeatedly specify the schema.

  • Consistency: Extractors ensure that the same schema is used for each request, reducing the risk of errors and inconsistencies.

  • Automation: Extractors can be easily integrated into production workflows and services, allowing for automated data transformation.

How to use extractors

Step 1: Create an extractor

Navigate to the extractor section, click on the "Create Extractor" button, and input the extractor's name and input the JSON schema that will be used for data extraction. This schema will form the basis of the extractor's operation.

Step 2: Copy the extractor's API endpoint

After creating the extractor, you will receive a unique API endpoint. This endpoint represents the specific extractor you configured and will be used to make requests to Inolio.

Step 3: Create an API Key for Authentication

In order to make requests to the extractor's API, you will need to create an API key. Navigate to the Settings > API Keys section and click on the "Create API Key" button. Once created, you will receive a unique API key that will be used to authenticate requests to the extractor's API.

Step 4: Make a request to the extractor's API

To process your input text, make a POST request to the extractor API endpoint. Be sure to include the api-key header for authentication and pass the inputText in the body of the request.

curl -X POST https://inol.io/api/process/<extractor_id> -H "api-key: YOUR_API_KEY" -H "Content-Type: application/json" -d '{"inputText": "The unstructured text you wish to process..."}'

Replace extractor_id with your actual extractor ID and YOUR_API_KEY with the API key generated for authentication.

Additional Tips

  • Test your JSON schema: Before creating an extractor, it is recommended that you test your JSON schema using Inolio's Playground. This will ensure that the schema is valid and will help you identify any errors before creating the extractor.