Create a Sync

​

📌 What You’ll Need

• A Postgres database with data you’d like to embed (you can use Supabase for a free account).
• An account with Pinecone (you can sign up for a free account here).
• Postgres credentials including host, database name, port, username, and password.
• A Pinecone API key.

​

🚀 Getting Started

​

Step 1: Access the New Sync Form

​

Step 2: Database Connection Details

1. Host: The address of your database server.
2. Database: The name of your Postgres database.
3. Port: The port number on which your database is running.
4. Username: Your Postgres username.
5. Password: Your Postgres password. (Note: We store this securely using AES256 industry-standard encryption.)

{
  "host": "db.yourhost.supabase.co",
  "database": "postgres",
  "port": 5432,
  "username": "postgres",
  "password": "yourpassword"
}

​

Step 3: Embedding Details

1. Table Name: The database table containing the data to be embedded.
2. Embedding Column Name: The specific column you’d like to use for generating embeddings.
3. Primary Key Column Name: The column that serves as the unique identifier for each row.
4. Updated At Column Name: The column used to determine newly added or updated rows to sync. If a previously embedded row is updated, the new value will be updated in the vector store overriding the previous value.
5. Pinecone Key: Your Pinecone API key. Once logged into Pinecone, go to API Keys in sidebar > + Create API Key.
6. Embedding Model: Choose the embedding model you’d like to use. Options include OpenAI’s text-embedding-ada-002 and HuggingFace sentence-transformers/all-MiniLM-L6-v2.

{
  "table_name": "articles",
  "embedding_column_name": "content",
  "pk_column_name": "id",
  "updated_at_column_name": "updated_at",
  "pinecone_key": "your-pinecone-key",
  "embedding_model": "sentence-transformers/all-MiniLM-L6-v2"
}

​

Step 4: Submit

​

🛠 Troubleshooting