Welcome to the world of OP Vault! If you’ve ever found yourself buried under a mountain of knowledge—books, letters, or various documents—you’ll love how OP Vault empowers you to extract insights effortlessly from your custom knowledge base. This guide will walk you through how to set it up and get started!

What Is OP Vault?

OP Vault combines the power of OpenAI and the Pinecone Vector Database to help you upload and query your custom knowledge base effectively. Picture it as a librarian that not only helps you store your books but also retrieves the exact information you need from them!

Key Features of OP Vault

• Upload multiple document types via a simple React frontend.
• Retrieve relevant answers based on the content of uploaded documents.
• View filenames and context snippets that point to answer sources.
• Utilize the fusion of OpenAI and Pinecone for optimal querying.
• Upload entire libraries of books for extensive knowledge extraction.

Manual Dependencies

Before diving into setup, ensure you have the following dependencies installed:

• Node.js: v19
• Go: v1.18.9 darwinarm64
• Poppler for PDF manipulation

Setup Guide

Step 1: Install Manual Dependencies

1. Install Go: Follow the Go installation guide.
2. Install Node.js: Use nvm to install Node.js v19.
3. Install Poppler: For Ubuntu, run sudo apt-get install -y poppler-utils. For Mac, use brew install poppler.

Step 2: Configure API Keys

Now, you’ll need to set up your API keys in the secret folder:

1. Create a file secret/openai_api_key and paste your OpenAI API key into it:

echo your_openai_api_key_here > secret/openai_api_key

2. Create a file secret/pinecone_api_key with your Pinecone API key:

echo your_pinecone_api_key_here > secret/pinecone_api_key

3. Create another file secret/pinecone_api_endpoint and input your Pinecone API endpoint:

echo https://example-50709b5.svc.asia-southeast1-gcp.pinecone.io > secret/pinecone_api_endpoint

Step 3: Running the Development Environment

1. Install JavaScript package dependencies: npm install
2. Run the Go web server (default on port 8100): npm start
3. In another terminal, run webpack to compile the JavaScript code: npm run dev
4. Access the local site at http://localhost:8100.

Code Analogy: The Library System

Let’s liken the OP Vault code to a library system. When you upload documents, it’s like donating books to the library:

• The library only accepts certain types of books (file types). Each book is checked for damage before being put on the shelf (upload size limits).
• Once the books are in, the librarian (the server) catalogs them, making sure to note where each book is located and what it’s about (creating embeddings).
• When a patron (user) asks a question, the librarian quickly searches through the catalog (database), retrieves the correct book(s) and offers a brief synopsis (answer) pointing to the exact page (file/section).

Troubleshooting Tips

• **Connection Issues:** Ensure that your API keys are correctly configured in the secret folder.
• **Document Upload Errors:** Check the file sizes to ensure they do not exceed the set limit (3 MB for individual files). You can adjust this limit in fileupload.go.
• **API Response Delays:** Confirm that your Pinecone database is correctly set up and is active.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

OP Vault is designed to simplify your data retrieval processes while leveraging the insights from advanced AI capabilities. With a straightforward setup and user-friendly interface, you can discover answers from your files like never before.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.