Easily empower ChatGPT to store and analyze your data using goldretriever
, a powerful command-line tool for creating and hosting retrieval plugins in just a few simple steps.
- Ensure you have Python 3.8 or later.
- Install the tool via pip:
pip install goldretriever
- Run the following command to deploy the plugin:
goldretriever deploy --key <your openai key>
- Store the "Gateway (Http)" URL and the Bearer token provided in the output.
╭──────────────────────── 🎉 Flow is available! ────────────────────────╮
│ │
│ ID retrieval-plugin-<plugin id> │
│ Gateway (Http) https://retrieval-plugin-<plugin id>.wolf.jina.ai │
│ Dashboard https://dashboard.wolf.jina.ai/flow/<plugin id> │
│ │
╰───────────────────────────────────────────────────────────────────────╯
Bearer token: <your bearer token>
- Gather relevant text data files (PDF, TXT, DOCX, PPTX, or MD) in a directory.
- Index the data:
goldretriever index --data my_files
Or, use docarray (v0.21.0)
for text data:
from docarray import Document, DocumentArray
texts = ['Text 1', 'Text 2', 'Text 3']
docs = DocumentArray([Document(text=text) for text in texts])
docs.save_binary('docs.bin')
And then:
goldretriever index --data docs.bin
- Go to OpenAI Plugins.
- Select "Develop your own plugin".
- Enter the "Gateway (Http)" URL and Bearer token from the deployment step.
To tailor the plugin to your needs, change the name and description during deployment:
goldretriever deploy --key <your openai key> --name "Custom Name" --description "Custom description"
If not specified, default values will be used.
Argument | Description | Default Value |
---|---|---|
name | Human-readable name, such as the full company name | Gold Retriever |
description | Description better tailored to the model, such as token context length considerations or keyword usage for improved plugin prompting | Plugin for searching through the user's documents (such as files, emails, and more) to find answers to questions and retrieve relevant information. Use it whenever a user asks something that might be found in their personal information |
List your plugins and their status:
goldretriever list
Output:
Plugin ID: ece735568f | Status: Serving
Delete a plugin:
goldretriever delete <plugin id>
Index data for a specific plugin:
goldretriever index --data my_files --id <plugin_id>
If the plugin ID is not specified, the last created plugin will be indexed.
This project is built upon the open-source chatgpt-retrieval-plugin repository developed by OpenAI.