Skip to content

doc: Add Pinecone documentation #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions guides/destinations/retl-destinations/database/pinecone_db.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: 'Pinecone'
description: ''
---

## Connect AI Squared to Pinecone

This guide will help you configure the PineconeDB Connector in AI Squared to access and transfer data to your Pinecone database.

### Prerequisites

Before proceeding, ensure you have the required API key, region, index name, model name, and namespace from your Pinecone database.

## Step-by-Step Guide to Connect to your Pinecone Database

## Step 1: Navigate to Pinecone Database

Start by logging into your Pinecone Console.

1. Sign in to your Pinecone account at [Pinecone Console](https://app.pinecone.io/).

## Step 2: Locate Pinecone Configuration Details

Once you're in the Pinecone console, you'll find the necessary configuration details:

1. **API Key:**
- Click the API Keys tab on the left side the Pinecone Console.
- If you haven't created an API key before, click on "Create API key" to generate a new one. Make sure to copy the API Key as they are shown only once.
<Frame>
<img src="https://res.cloudinary.com/dspflukeu/image/upload/v1746239791/Multiwoven/connectors/Pinecone/Pinecone_API_Key_qmdap5.png" />
</Frame>

2. **Region, Index Name, Model Name, and Namespace:**
- Click on the Database tab then Indexes to see your list of Indexes.
- Click on your selected Index.
- The following details, region, index name, model name, and namespace, will be shown on this page.
<Frame>
<img src="https://res.cloudinary.com/dspflukeu/image/upload/v1746239791/Multiwoven/connectors/Pinecone/Pinecone_Index_t2lhyx.png" />
</Frame>

## Step 3: Configure PineconeDB Connector in Your Application

Now that you have gathered all the necessary details, enter the following information in your application:

- **API Key:** The authentication key used to access your Pinecone project securely.
- **Region:** The region where your Pinecone index is hosted.
- **Index Name:** The name of the Pinecone index where your vectors will be stored or queried.
- **Model:** The embedding model used to generate vector representations.
- **Namespace:** A logical grouping within the index to isolate and organize your vectors.

## Step 4: Test the PineconeDB Connection

After configuring the connector in your application:

1. Save the configuration settings.
2. Test the connection to Pinecone from your application to ensure everything is set up correctly.

By following these steps, you’ve successfully set up an Pinecone destination connector in AI Squared. You can now efficiently transfer data to your Pinecone endpoint for storage or further distribution within AI Squared.


### Supported sync modes

| Mode | Supported (Yes/No/Coming soon) |
|-----------------|--------------------------------|
| Incremental sync | YES |
| Full refresh | Coming soon |

This guide will help you seamlessly connect your AI Squared application to Pinecone, enabling you to leverage your database's full potential.
1 change: 1 addition & 0 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@
"guides/destinations/retl-destinations/database/postgresql",
"guides/destinations/retl-destinations/database/maria_db",
"guides/destinations/retl-destinations/database/oracle",
"guides/destinations/retl-destinations/database/pinecone_db",
"guides/destinations/retl-destinations/http/http",
"guides/destinations/retl-destinations/database/ms_sql",
"guides/destinations/retl-destinations/file-storage/amazon_s3"
Expand Down