Quickstart Guide

With easybits' Extractor, you can:

• Build independent reusable pipelines for each document type you want to extract data from.
• Define a data structure that fits your requirements.
• Upload PDFs or images to test your extraction pipeline.
• Integrate your automation pipelines into existing systems via API.

Step 1: Create a New Pipeline

Click the "Create a Pipeline" button in the top-right corner.

Step 2: Configure Your Pipeline Details

Provide the following information:

• Pipeline Name – A descriptive name to help you organize different pipelines (for example: Traffic Report Pipeline).
• Description – A short explanation of the document type you want to process (for example: Computer-generated traffic report form, completed with handwriting, detailing the traffic situation at the time of the accident).
• Upload a Sample File – Upload a sample document that represents the type of document you want to process with this pipeline.

Click "Map Fields" to move to the next step, defining which data points you want to extract from your sample document.

Step 3: Map the Fields to Be Extracted

Here, you can create an output structure, including nested objects / arrays, to match your desired output format.

For each field you want to extract from the document, specify:

• Field Name – This will be the key name in the JSON output.
• Data Type – Choose the data type for each field from the dropdown menu.
• Description – Briefly explain what data this field should capture (for example: Unique identification number of the customer).
• Example – Provide a sample value in the same format as the mapped field to guide the extraction.

While specifying your desired output format, click the "JSON Example" tab in the top-right corner to see how your added fields will appear in the structured JSON output. This makes it easier to adjust your mapping and get the output format you need.

Step 4: Test Your Pipeline

Navigate to the "Test" tab in the top-right corner of the page. Click "Save & Test Pipeline" to run a test and preview the extracted fields in the defined JSON structure.

Review the extracted data and adjust your mapping as needed by editing the fields on the left side.

Step 5: Get Your API Credentials

Once your pipeline is configured, navigate to the Pipeline Details page. Click the "Pipeline" button in the top-right corner. Select "View Pipeline" to access your connection details:

• API URL – The endpoint where you'll send extraction requests.
• API Key – Your unique authentication token (keep this secure!)

If you need additional help with the integration process, visit our Integration section.