Skip to main content

​
Getting Started with DataGyro

This guide walks you through the initial steps to get your DataGyro account and first project set up. Once you’ve covered these basics, you can then explore the Search or Evaluate verticals in more detail based on your needs.

​
Setting Up Your Account

  1. Visit app.datagyro.com and click on “Sign Up”
  2. Enter your email address and create a password
  3. Verify your email address
  4. Complete your profile information

​
Creating Your First Project

Once your account is set up, you can create your first project:
  1. From the dashboard, click on “Create New Project”
  2. Enter a name and description for your project
  3. Choose the appropriate settings for your project
  4. Click “Create”
Connecting a data source is a key step for the Search vertical. It allows DataGyro to access and process your data for searching. For the Evaluate vertical, you’ll typically work with datasets in a different manner, as detailed in the Evaluate Introduction.
  1. Navigate to the “Data Sources” section in the DataGyro platform
  2. Click “Add New Data Source”
  3. Select the type of data source you want to connect (PostgreSQL, MySQL, or SQL Dump)
  4. For databases, enter your connection string (e.g., postgresql://username:password@hostname:port/database)
  5. For SQL dumps, upload your SQL file (up to 5GB in size)
  6. Test the connection to ensure it works properly
  7. Save your data source
Remember that data sources are not directly queryable - they provide the foundation for creating collections. Collections are central to the Search vertical. They are the indexed, queryable versions of your connected data sources.
  1. Go to the “Collections” tab
  2. Click “New Collection”
  3. Enter a name for your collection
  4. Select the data source you want to use
  5. Click “Create Collection”
Once created, your collection will begin processing. This typically takes 5-10 minutes for large datasets as our systems sync and process your data. You can monitor the progress in real-time on the Collections tab. For SQL database connections, any changes made to your database will be automatically reflected in your collection, keeping your data always up-to-date. Collections currently have a 1:1 mapping with data sources, with more advanced features coming soon.

​
Next Steps

With your account and project set up, you’re ready to explore DataGyro’s core capabilities. We recommend visiting the introduction page for the vertical you’re most interested in:

Introduction to Search

Learn how to add natural language search to your applications.

Introduction to Evaluate

Discover how to assess your IR system’s performance with TREC-style evaluations.
For details on securing your API access, see the Authentication guide.