Back to home

Documentation

Learn how to use Inolio.

Playground

As a pioneering tool in transforming unstructured data into structured, actionable insights, Inolio has continuously strived to empower users with innovative and user-friendly features. The introduction of the Playground represents a significant leap in this ongoing journey, offering a compelling environment where users can explore the full capabilities of Inolio in a hands-on manner.

Why the Playground?

The Playground serves as an intuitive and interactive user interface specifically designed to familiarize new and existing users with Inolio's powerful data formatting features. It enables users to:

  • Experiment with Inolio without the need to integrate it into their system.
  • Test schemas and data formats before applying them in a production environment.
  • Understand the potential and versatility of Inolio in processing diverse data types.

Capabilities of Inolio

Inolio stands as a versatile platform capable of processing a myriad of text-based content, ranging from books and reports to digital communications like SMS and email, as well as structured languages such as HTML and XML. The central hallmark of Inolio is its ability to interpret user-provided JSON schema—clear and precise instructions that determine how unstructured data should be converted into structured form.

Overview of the Playground

The Playground embodies an environment where users can seamlessly test and validate the process of transforming their data. The Playground is divided into three primary steps: Upload, Define, and Output.

  1. Upload: In this initial phase, users are presented with an input text area where they can conveniently copy and paste the raw text they want to format. This could be a snippet from a document, an email, or any other text source that requires structuring.
  2. Define: The Define step is where users input the JSON schema. The interactive UI within the Playground showcases an advanced editor that facilitates coding the extraction schema by providing features like IntelliSense for smart completions, and error highlighting for immediate feedback. Furthermore, for users seeking a more guided approach, there is an additional simplified UI form that lets them generate parts of the extraction schema automatically.
  3. Output: Upon completing the definition, the Playground processes the input according to the provided schema and presents the result in the Output step. This allows users to review the structured data and verify that it meets their requirements.

Getting Started

Step-by-step Guide

  1. Access the Playground: To start using the Playground, users need to log into their Inolio account and navigate to the Playground section from home screen.

  2. Upload the Input:

  • Users can simply paste the text data into the provided text area.
  • The user can choose which portion of the text to format if not all of it is required.
  1. Define the Schema:
  • Engage with the schema editor to craft the JSON schema necessary for data extraction.
  • Utilize the IntelliSense features to ensure correct syntax and to minimize errors.
  • Alternatively, use the form-based UI to construct the schema if preferred.
  1. Review the Output:
  • After submitting, Inolio will apply the schema to the uploaded text.
  • The structured data will be displayed, showcasing the transformation carried out by Inolio.
  • Users can then review the results and make any necessary adjustments back in the Define Phase.

Tips for an Effective Schema

When creating a JSON schema for Inolio, consider the following best practices

  • Be specific: The more specific the schema is, the more accurate the output will be. For example, if the schema is designed to extract the name of a person, it should be as specific as possible to avoid extracting other names that may be present in the text.
  • Meaningful field names and descriptions: The field names and descriptions should be meaningful and descriptive. This will help users understand the purpose of each field and how it relates to the data.
  • Use the right data type: The data type of each field should be selected carefully. For example, if the field is expected to contain a number, the data type should be set to Number. This will ensure that the output is in the correct format.