Pinecone Assistant quickstart
This guide shows you how to set up and use Pinecone Assistant, a service that allows you to upload documents, ask questions, and receive responses that reference your documents.
To get started in your browser, use the Assistant Quickstart colab notebook.
1. Install an SDK
The Pinecone Python SDK and Node.js SDK provide convenient programmatic access to the Assistant API.
2. Get an API key
You need an API key to make calls to your assistant.
Create a new API key in the Pinecone console, or use the widget below to generate a key. If you don’t have a Pinecone account, the widget will sign you up for the free Starter plan.
Your generated API key:
3. Create an assistant
Create an assistant, as in the following example:
4. Upload a file to the assistant
With Pinecone Assistant, you can upload documents, ask questions, and receive responses that reference your documents. This is known as retrieval-augmented generation (RAG).
For this quickstart, download a sample 10-k filing file to your local device.
Next, upload the file to your assistant:
5. Chat with the assistant
With the sample file uploaded, you can now chat with the assistant. Ask the assistant questions about your document. It returns either a JSON object or a text stream.
The following example requests a default response to the message, “Who is the CFO of Netflix?”:
The example above returns a response like the following:
6. Clean up
When you no longer need the example-assistant
, delete the assistant:
Deleting an assistant also deletes all files uploaded to the assistant.
Next steps
- Learn more about Pinecone Assistant
- Learn about additional assistant features
- Evaluate the assistant’s responses
- View a sample app that uses Pinecone Assistant
Was this page helpful?