Retool Vectors quickstart

Learn how to store and retrieve data for AI models using Retool's managed vector database.

Vectors is a managed vector database that enables you to store unstructured text from documents and web pages for use with AI models through Retool. Retool abstracts away the complexities of preparing text and automatically generates the required data for AI models to make decisions using your data.

You can include related information from Retool Vectors to provide more context. This allows you to instruct AI models to use your own data when making decisions, such as responding to a customer with context from support articles.

The following guide explains how to add text to Retool Vectors and use it with the Generate text AI Action. To get started, navigate to the Resources tab in your organization and select Retool Vectors.

Vector contents

Each vector you create can contain either document text or URLs, not both.

1. Create a Vector

You can create two types of Vectors:

• Document Vector: Store plain text that you enter manually or extract from uploaded PDF documents.
• URL Vector: Store text fetched from publicly accessible web pages.

The following instructions cover both Vector types. To continue with this guide, create a URL Vector.

Document Vector

To create a Document Vector:

1. Navigate to the Resources settings and click Retool Vectors.
2. Click Add Vector.
3. Specify a name and select Document.
4. Click Create.

URL Vector

To create a URL Vector:

1. Navigate to the Resources settings and click Retool Vectors.
2. Click Add Vector.
3. Specify a name and select Site URLs.
4. Click Create.

2. Add embeddings

Document Vector

Click Add document and select whether to upload a PDF file or add plain text manually. Retool extracts text from PDF documents automatically.

URL Vector

URLs must be publicly accessible

Retool can only crawl URLs that are publicly accessible and linked from other pages that match the base URLs. Pages that can only be accessed directly or require authentication cannot be added.

Click Add URLs to add web pages to the Vector then add a base URL to Links to crawl. You can specify multiple URLs by clicking Add link.

You only need to specify a base URL, such as https://docs.retool.com—Retool crawls the URL and fetches text for any pages at this location. You can exclude web pages by providing a base URL in Link prefix to exclude—any URLs that match are not crawled.

For the purposes of this guide, set the following:

• Links to crawl: https://docs.retool.com
• Link prefix to exclude: https://docs.retool.com/changelog

This instructs Retool Vectors to crawl Retool Docs but exclude changelog content.

3. Use Retool Vectors in AI Actions

You can include context from Retool Vectors in apps and workflows using the Generate text and Generate chat response AI Actions. This step assumes you have created a URL Vector using https://docs.retool.com.

1. Navigate to the Query Library tab and click + New.
2. Set Resource to Retool AI.
3. Select the Generate text action.
4. Enter What is a resource? as the Input.
5. Enable Use Retool Vectors to provide more context to your query and select the URL Vector you created.
6. Click ▶︎ to run the query.

Retool automatically includes relevant context to the AI model from the specified Vector.

Wrap up

You have now created a new vector store using Retool Vectors, added text content, and performed an AI Action with Vector context.