ballerinax/ai.pinecone Ballerina library

Ballerina Pinecone Vector Store Module

Overview

This module provides APIs for connecting with Pinecone vector database, enabling efficient vector storage, retrieval, and management for AI applications. It implements the Ballerina AI VectorStore interface and supports Dense, Sparse, and Hybrid vector search modes.

Prerequisites

Before using this module in your Ballerina application, you must obtain the necessary configuration to engage with Pinecone:

• Create a Pinecone account
• Create a Pinecone index through the Pinecone Console
• Obtain your API key from the Pinecone Console
• Get your index service URL from the Pinecone Console

Quickstart

To use the ai.pinecone module in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Import the ai.pinecone module along with required AI modules.

import ballerinax/ai.pinecone;

Step 2: Initialize the Vector Store

Here's how to initialize the Pinecone Vector Store:

import ballerina/ai;
import ballerinax/ai.pinecone;

// Basic initialization
ai:VectorStore vectorStore = check new pinecone:VectorStore(
    serviceUrl = "https://your-index-name.svc.region.pinecone.io", 
    apiKey = "your-pinecone-api-key"
);

ai:VectorStore vectorStore = check new pinecone:VectorStore(
    serviceUrl = "https://your-index-name.svc.region.pinecone.io",
    apiKey = "your-pinecone-api-key"
);