Weaviate

RAG Pipeline Quickstart with Weaviate

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 Weaviate 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)
• An Weaviate account (Create one on Weaviate ↗)

Step 1: Create a Weaviate Cluster

Create Your Database

1. Log in to Weaviate, navigate to Clusters, and click Create cluster.

   

2. Select a cluster type. For this quickstart, we'll use "Free."

   

3. Enter a cluster name, select the cloud region, then click Create.

   

4. Save and securely store your cluster's API key.

   

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 integration.

   

5. Select Weaviate from the list of vector databases.

   

6. Enter the parameters in the form using the Weaviate Parameters table below as a guide, then click Create Weaviate Integration.

   

Weaviate Parameters

Field	Description	Required
Name	A descriptive name to identify the integration within Vectorize.	Yes
Endpoint	The cluster's endpoint.	Yes
API key	The cluster's admin API key.	Yes

Configure the Weaviate integration in your RAG Pipeline

You can think of the Weaviate integration as having two parts to it. The first is authorization with your Weaviate cluster. This part is re-usable across pipelines and allows you to connect to this same application in different pipelines without providing the credentials every time.

The second part is the configuration that's specific to your RAG Pipeline. This is where you specify the name of the table in your Weaviate database. If the table does not already exist, Vectorize will create it for you.

Enter your collection name to complete configuration of your Weaviate integration for your RAG pipeline.

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, open the RAG Sandbox for the pipeline by clicking the RAG Sandbox link on the Pipeline Details page, or the magnifying glass icon on the RAG Pipelines page.

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 Weaviate and Vectorize.