Skip to main content

Elastic

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

This quickstart will walk you through creating and scheduling a pipeline that collects data from an Amazon S3 bucket, creates vector embeddings using an OpenAI embedding model, and writes the vectors to your Elastic search index.

Prerequisites​

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

Step 1: Create an Elasticsearch Deployment​

Create and Configure Project​

  1. Navigate to the Elastic Cloud console and click Create project under the Serverless projects section.

    Create Project

  2. Select Elasticsearch for building custom applications with your data, and click Next.

    Choose Elasticsearch

  3. Name your project (e.g., vectorize-quickstart).

  4. Under Configuration, choose Optimized for Vectors.

  5. Click Create project to initialize.

    Configure Project

  6. Once initialization completes, click Continue.

    Launch Project

Generate API Key and Save Connection Details​

  1. Scroll down to the API Key section and click New to create a key.

    Create API Key

  2. Enter a name for your key (e.g., vectorize-quickstart) and optionally set an expiration date.

  3. Click Create API key.

    Setup API Key

  4. Copy the generated API key and save it securely—you won't be able to retrieve it later.

    Copy API Key

  5. Copy your Elasticsearch endpoint URL as well. You'll need this to connect to your deployment.

    Copy Endpoint

Step 2: Create a RAG pipeline​

Set Up Pipeline and Vector Database​

  1. Open the Vectorize Application Console ↗

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

    New RAG Pipeline

  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.

    Name Pipeline

  5. Select Elastic Cloud from the list of vector databases.

    New Vector DB

  6. In the Elastic Cloud configuration screen:

    • Enter a descriptive name for your Elastic Cloud integration.
    • Enter the Host, Port, and your Elastic API Key.

    Configure Elastic

  7. Provide the index name you want to use in Elastic

    • The Index Name can be the same as your pipeline name.

    New AI Platform

Configure AI Platform​

  1. Click on + New AI Platform.

    New AI Platform

  2. Select OpenAI from the AI platform options.

    Select OpenAI

  3. In the OpenAI configuration screen:

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

    Configure OpenAI

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

    Set Embedding Model

Add Source Connector​

  1. Click + Add source connector to add a source connector to your pipeline.

    Add Source Connector

  2. Choose Amazon S3 from the list of source connector options.

    Select Amazon S3

  3. In the Amazon S3 configuration screen:

    • Name your integration. It can be the same as your bucket name, but it doesn't have to be.
    • Enter your Bucket Name exactly as it appears in AWS.
    • Provide the Access Key and Secret Key for your AWS IAM user.

    Configure Integration

  4. Accept the default values for file extensions and other options.

  5. Click Save Configuration.

    S3 Pipeline Configuration

Finalize Pipeline Creation​

  1. After configuring the S3 integration, you should see it listed under Source Connectors.

  2. Click Next: Schedule Pipeline to continue.

    Confirm S3 Integration

  3. Set the schedule type and frequency for the pipeline.

  4. Leave the default values for the pipeline schedule for now.

  5. Click Create RAG Pipeline.

    Creating Pipeline

Monitor Pipeline Creation and Backfilling​

  1. After clicking Create RAG Pipeline, you will see the pipeline creation progress.

  2. The stages include:

    • Creating pipeline
    • Deploying pipeline
    • Starting backfilling process

    Creating Pipeline

  3. Once the pipeline is created and deployed, it will begin the backfilling process.

  4. You can monitor the pipeline status and view the progress of document ingestion and vector creation.

  5. If your S3 bucket is empty, the pipeline will show 0 Documents, 0 Chunks, and 0 Vectors.

    Pipeline Backfilling

Step 3: Upload Files to Your S3 Bucket​

Prepare Sample Data​

  1. Download the friends-scripts.zip file from the following location:

Download: Friends Scripts (ZIP file)

  1. After downloading the friends-scripts.zip file, extract it to a location on your local machine.
  2. On most operating systems, you can do this by right-clicking the zip file and selecting Extract All or Unzip.

Upload Files to S3​

  1. Log into your AWS S3 account and navigate to the Buckets section.

  2. Filter to find your bucket by typing its name in the search bar.

    Find Your Bucket

  3. Click on your bucket name to open the detailed bucket view.

    Open Bucket

  4. Click on the Upload button in the top right corner of the bucket's detail view.

    Click Upload

  5. You can either drag and drop the extracted files from the friends-scripts directory into the upload area, or click on Add files to browse your local machine and select them manually.

    Drag and Drop or Add Files

  6. After adding the files, you should see them listed under the Files and folders section of the upload screen.

    Files Listed for Upload

  7. Once you've confirmed that all the files are listed, click on the Upload button at the bottom of the screen to start the upload process.

    Your files will now be uploaded to your S3 bucket.

Verify Pipeline Processing​

  1. Within a few seconds after the upload is complete, you should see the content of your files start to populate in the RAG pipeline.
  2. The backfilling process will show progress as it reads and processes the documents from your S3 bucket.

Backfilling Progress

  1. Total Documents and Total Chunks will increase as the documents are embedded and processed.

  2. You can track the number of documents being embedded and vectors being written.

  3. After a minute or two of processing, you should see the total number of uploaded documents reflected in the pipeline's statistics.

  4. If you used the Friends Scripts documents as recommened, you will see 228 documents displayed in the Total Documents field.

    Uploaded Documents Processed

Step 4: Play with Your Data 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.

    Open RAG Pipeline Menu

  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.

    Open RAG Sandbox

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 characteristics define the relationship between Ross and Monica?" if you're working with the Friends TV show scripts.

  3. Click Submit to send the question.

    Ask a 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.

    Retrieved Chunks and LLM Response

  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're now able to explore your data using the RAG Sandbox.

Was this page helpful?