Retrieval API Overview

Nimble Labs Beta Feature

Retrieval API Overview

The Retrieval API is designed to streamline the process of generating insights from public web data. With just a few simple steps, you can provide URLs and questions, and receive detailed answers based on the content of those URLs. This API is perfect for quickly generating insights from online data sources, using a powerful pipeline model that makes the process both flexible and efficient.

Key Concept: Pipeline

The Retrieval API revolves around the concept of a Pipeline. A Pipeline is a generative flow where you provide your data sources (URLs, Files, Nimble Online Pipelines) and questions (plain text), and the API processes them to deliver insightful answers.

How It Works

Step 1: Create a New Pipeline

To begin, you’ll create a new pipeline by providing a set of data sources (public URLs) and questions. Each pipeline is tailored to the data you upload, ensuring that the answers provided are based on those specific sources.

• What You Provide:

  • A list of URLs to public data sources

  • A list of questions you want answers to

Once the pipeline is created, the system will generate a unique pipeline_id and a task_exec_id for tracking the generation process.

Step 2: Get Your Pipeline ID and Task Exec ID

Once your pipeline is created, you will receive two key pieces of information:

• Pipeline ID: This is the unique identifier for your entire pipeline.

• Task Exec ID: This tracks the specific generative task, helping you query the answers for your pipeline's data.

Step 3: Query the Results

After your pipeline is generated, you can retrieve the results using different query methods:

• All Pipelines: Retrieve the results of all pipelines you've created.

• Specific Pipeline: Focus on the results of one pipeline using its unique pipeline_id.

• Task Exec ID: Drill down into a specific generative task within a pipeline using the task_exec_id.

This flexibility allows you to monitor both broad and granular insights with ease.

Step 4: Update the Pipeline

If you have new data sources or additional questions, you can update an existing pipeline. This ensures that your insights stay relevant and up-to-date without having to create a new pipeline from scratch. Just add the new URLs or questions to your existing pipeline and continue generating answers.

---

Why Use Answerit API?

• Quick and Simple: Creating and managing pipelines is fast, allowing you to generate insights with just a few API calls.

• Flexible Data Handling: You can easily update existing pipelines with new information, ensuring that your questions and answers remain relevant.

• Granular Control: Track both entire pipelines or specific tasks, giving you the power to analyze results at any level of detail.

AnswerIt API is designed to be both user-friendly and powerful, letting you extract insights from public web data with minimal effort.