Weaviate

Data Pipeline Quickstart with Weaviate

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

This quickstart will walk you through creating a pipeline that prepares your data for AI agents. You'll set up a pipeline that transforms content from the Vectorize documentation into structured, searchable context in Weaviate - giving agents the foundation they need to reason over your data, not just retrieve it.

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 data pipeline on Vectorize

Create a New Data 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 data 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 data 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 data 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 Data 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 data pipeline will begin crawling the Vectorize docs and writing vectors to your Weaviate index.

View Data Pipeline Status

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

Step 4: Test Your Pipeline in the RAG Sandbox

Access the RAG Sandbox

1. From the main pipeline overview, click on the RAG Pipelines menu item to view your active pipelines.

2. Find your pipeline in the list of pipelines.
3. Click on the magnifying glass icon under the RAG Sandbox column to open the sandbox for your selected pipeline.

Query Your Data

1. In the sandbox, you can ask questions about the data you've ingested.
2. Type a question related to your dataset in the Question field. For example, "What is Vectorize?" since you're working with the Vectorize documentation.
3. Click Submit to send the question.

Review Results

1. After submitting your question, the sandbox will retrieve relevant chunks from your vector database and display them in the Retrieved Context section.
2. The response from the language model (LLM) will be displayed in the LLM Response section.
   • The Retrieved Context section shows the chunks that were matched with your question.
   • The LLM Response section provides the final output based on the retrieved chunks.

3. You can continue to ask different questions or refine your queries to explore your dataset further.
4. The sandbox allows for dynamic interactions with the data stored in your vector database.

That's it! You've successfully created a data pipeline that transforms your content into structured context, ready for AI agents to reason over and make intelligent decisions.