chatgpt-retrieval-plugin
The ChatGPT Retrieval Plugin lets you easily find personal or work documents by asking questions in natural language.
File Explorer
Download Latest Version (.zip)- pull_request_template.md
- ai-plugin.json
- logo.png
- openapi.yaml
- example.png
- __init__.py
- analyticdb_datastore.py
- azurecosmosdb_datastore.py
- azuresearch_datastore.py
- chroma_datastore.py
- elasticsearch_datastore.py
- llama_datastore.py
- milvus_datastore.py
- mongodb_atlas_datastore.py
- pgvector_datastore.py
- pinecone_datastore.py
- postgres_datastore.py
- qdrant_datastore.py
- redis_datastore.py
- supabase_datastore.py
- weaviate_datastore.py
- zilliz_datastore.py
- __init__.py
- datastore.py
- factory.py
- flyio.md
- heroku.md
- other-options.md
- removing-unused-dependencies.md
- render-thumbnail.png
- render.md
- plugins.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- setup.md
- ai-plugin.json
- main.py
- ai-plugin.json
- ai-plugin.json
- ai-plugin.json
- docker-compose.yaml
- README.md
- docker-compose.yaml
- docker-compose.yaml
- documents.json
- queries.json
- README.md
- docker-compose.yml
- README.md
- ai-plugin.json
- main.py
- openapi.yaml
- README.md
- semantic-search.ipynb
- search.ipynb
- semantic-search.ipynb
- semantic-search.ipynb
- semantic-search-and-filter.ipynb
- 20230414142107_init_pg_vector.sql
- .gitignore
- config.toml
- seed.sql
- ai-plugin.json
- logo.png
- main.py
- openapi.yaml
- api.py
- models.py
- example.json
- process_json.py
- README.md
- example.jsonl
- process_jsonl.py
- README.md
- example.zip
- process_zip.py
- README.md
- main.py
- chunks.py
- date.py
- extract_metadata.py
- file.py
- openai.py
- pii_detection.py
- test_analyticdb_datastore.py
- test_azurecosmosdb_datastore.py
- test_azuresearch_datastore.py
- test_chroma_datastore.py
- test_elasticsearch_datastore.py
- test_llama_datastore.py
- test_milvus_datastore.py
- test_integration.py
- test_mongodb_datastore.py
- test_postgres_datastore.py
- test_qdrant_datastore.py
- test_redis_datastore.py
- test_supabase_datastore.py
- docker-compose.yml
- test_weaviate_datastore.py
- test_zilliz_datastore.py
- __init__.py
- .dockerignore
- .env.example
- .gitignore
- Dockerfile
- LICENSE
- Makefile
- poetry.lock
- pyproject.toml
- README.md
# Installation Guide
git clone https://github.com/openai/chatgpt-retrieval-plugin
Downloads the entire project code from GitHub to your computer.
cd chatgpt-retrieval-plugin
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Python 3 Python is required to use pip.
pip install poetry
Installs the package published on PyPI directly β no need to clone the source.
Pulled directly from this repo's README.
3. Docker
Easy- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t chatgpt-retrieval-plugin .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 chatgpt-retrieval-plugin
Runs the built image as an actual container.
4. Python
Easypip install poetry
Installs the package published on PyPI directly β no need to clone the source.
poetry env use python3.10
Type this command into your terminal and run it.
poetry shell
Type this command into your terminal and run it.
poetry install
Installs the libraries listed in pyproject.toml.
poetry run start
Type this command into your terminal and run it.
Pulled directly from this repo's README.
5. Make
Medium- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.