From 1d2f456397c639896fe63b3c3f2427d42797fbd1 Mon Sep 17 00:00:00 2001 From: TivonB-AI2 Date: Fri, 2 May 2025 22:41:52 -0400 Subject: [PATCH 1/2] doc: Add Pinecone documentation --- .../database/pinecone_db.mdx | 68 +++++++++++++++++++ mint.json | 1 + 2 files changed, 69 insertions(+) create mode 100644 guides/destinations/retl-destinations/database/pinecone_db.mdx diff --git a/guides/destinations/retl-destinations/database/pinecone_db.mdx b/guides/destinations/retl-destinations/database/pinecone_db.mdx new file mode 100644 index 0000000..1544f4c --- /dev/null +++ b/guides/destinations/retl-destinations/database/pinecone_db.mdx @@ -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. + + + + +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. + + + + +## 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. diff --git a/mint.json b/mint.json index 162f1e6..ce63abc 100644 --- a/mint.json +++ b/mint.json @@ -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" From fa751a59636f7f0c959c66a8527928410fa5d281 Mon Sep 17 00:00:00 2001 From: TivonB-AI2 Date: Mon, 12 May 2025 21:59:07 -0400 Subject: [PATCH 2/2] doc: Update --- .../destinations/retl-destinations/database/pinecone_db.mdx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/guides/destinations/retl-destinations/database/pinecone_db.mdx b/guides/destinations/retl-destinations/database/pinecone_db.mdx index 1544f4c..4e03dfa 100644 --- a/guides/destinations/retl-destinations/database/pinecone_db.mdx +++ b/guides/destinations/retl-destinations/database/pinecone_db.mdx @@ -30,10 +30,10 @@ Once you're in the Pinecone console, you'll find the necessary configuration det -2. **Region, Index Name, Model Name, and Namespace:** +2. **Region and Index Name:** - 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. + - The following details, region and index name will be shown on this page. @@ -45,8 +45,6 @@ Now that you have gathered all the necessary details, enter the following inform - **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