SingleStore Quickstart

Approximate time to complete: 5-10 minutes, excluding prerequisites

This quickstart will walk you through creating and scheduling a pipeline that uses a web crawler to ingest data from the Vectorize documentation, creates vector embeddings using an OpenAI embedding model, and writes the vectors to a SingleStore vector database.

Before you begin

Before starting, ensure you have access to the credentials, connection parameters, and API keys as appropriate for the following:

• A Vectorize account (Create one free here ↗ )
• An OpenAI API Key (How to article)
• A SingleStore account (Create one on SingleStore ↗ )

Step 1: Create a SingleStore Deployment

SingleStore offers two types of workspaces. Starter Workspaces are best for small-scale or experimental projects, while Standard Workspaces are designed for applications that need higher resources, scalability, and support for production environments.

When you create your SingleStore account, a Starter Workspace and a database will be created and deployed for you. You can use these for this quickstart, or can create a Standard Workpace to work with instead.

If you're using a Starter Workspace:

1. The Starter Workspace and database are automatically created when you create your SingleStore account.

   

2. Select the workspace, then click Access.

   

3. Save the username, then click the 3 dots and select Reset Password. Copy and securely save the password.

   

4. Go to the Overview tab, then click Connect and select Your App.

   

5. Save the host and the port from the connection string. You'll use these when you create your RAG pipeline in Vectorize.

   

If you're using a Standard Workspace:

1. Navigate to the SingleStore Cloud Portal and click + New Deployment.

   

2. Name your Workspace Group, select your cloud provider and region, and click Next.

   

3. Name the Workspace, optionally adjust the size and settings, then click Create Workspace.

   

4. If you're on SingleStore's free trial, a database containing MarTech data will be automatically added to the workspace you just created. You can ignore this for the purpose of the Vectorize quickstart. If you'd like to remove it, click on the 3 dots, then click Drop Database.

   

5. Click + Create Database.

   

6. Name your database, make sure it's attaching to the correct workspace, then click + Create Database.

   

7. Go to your workspace, then click Access.

   

8. Copy and save the username. Click Reset Password to set the password, then securely save the password.

   

9. Go to Workspaces, click the 3 dots, then click Connect Directly.

   

10. Save the host and the port from the connection string. You'll use these when you create your RAG pipeline in Vectorize.

    

Step 2: Create a RAG Pipeline on Vectorize

Create a New RAG Pipeline

1. Open the Vectorize Application Console ↗

2. From the dashboard, click on + New RAG Pipeline under the "RAG Pipelines" section.

   

3. Enter a name for your pipeline. For example, you can name it quickstart-pipeline.

4. Click on + New Vector DB to create a new vector database.

   

5. Select Singlestore from the list of vector databases.

   

6. In the Singlestore configuration screen, enter the parameters in the form using the SingleStore Parameters table below as a guide, then click Create SingleStore Integration.

   

   SingleStore Parameters

   Field	Description	Required
   Name	A descriptive name to identify the integration within Vectorize.	Yes
   Host	The host URL from your workspace's connection string.	Yes
   Port	The port from your workspace's connection string.	Yes
   Database	The name of your database.	Yes
   Username	The username to access your database.	Yes
   Password	The password you'll use to access this database.	Yes

Configure AI Platform

1. Click on + New AI Platform.

   

2. Select OpenAI from the AI platform options.

   

3. In the OpenAI configuration screen:

   • Enter a descriptive name for your OpenAI integration.
   • Enter your OpenAI API Key.

   

4. Leave the default values for embedding model, chunk size, and chunk overlap for the quickstart.

   

Add Source Connectors

1. Click on Add Source Connector.

2. Choose the type of source connector you'd like to use. In this example, select Web Crawler.

Configure Web Crawler Integration

1. Name your web crawler source connector, e.g., vectorize-docs.
2. Set Seed URL(s) to https://docs.vectorize.io.

3. Click Create Web Crawler Integration to proceed.

Configure Web Crawler Pipeline

1. Accept all the default values for the web crawler pipeline configuration:
   • Throttle Wait Between Requests: 500 ms
   • Maximum Error Count: 5
   • Maximum URLs: 1000
   • Maximum Depth: 50
   • Reindex Interval: 3600 seconds

2. Click Save Configuration.

Verify Source Connector and Schedule Pipeline

1. Verify that your web crawler connector is visible under Source Connectors.
2. Click Next: Schedule RAG Pipeline to continue.

Schedule RAG Pipeline

1. Accept the default schedule configuration
2. Click Create RAG Pipeline.

Step 3: Monitor and Test Your Pipeline

Monitor Pipeline Creation and Backfilling

1. The system will now create, deploy, and backfill the pipeline.
2. You can monitor the status changes from Creating Pipeline to Deploying Pipeline and Starting Backfilling Process.

3. Once the initial population is complete, the RAG pipeline will begin crawling the Vectorize docs and writing vectors to your Pinecone index.

View RAG Pipeline Status

1. Once the website crawling is complete, your RAG pipeline will switch to the Listening state, where it will stay until more updates are available.

Test Your Pipeline in the RAG Sandbox

1. After your pipeline is running, click on RAG Pipelines toopen the RAG Sandbox for the pipeline.

2. In the RAG Sandbox, you can ask questions about the data ingested by the web crawler.

3. Type a question into the input field (e.g., "What are the key features of Vectorize?"), and click Submit.

4. The system will return the most relevant chunks of information from your indexed data, along with an LLM response.

This completes the RAG pipeline quickstart. Your RAG pipeline is now set up and ready for use with SingleStore and Vectorize.