ChatGPT插件：帮助用户轻松地找到个人或工作文件

# ChatGPT Retrieval Plugin Find an example video of a Retrieval Plugin that has access to the UN Annual Reports from 2018 to 2022 [here](https://cdn.openai.com/chat-plugins/retrieval-gh-repo-readme/Retrieval-Final.mp4). ## Introduction The ChatGPT Retrieval Plugin repository provides a flexible solution for semantic search and retrieval of personal or organizational documents using natural language queries. The repository is organized into several directories: | Directory | Description | | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | [`datastore`](/datastore) | Contains the core logic for storing and querying document embeddings using various vector database providers. | | [`docs`](/docs) | Includes documentation for setting up and using each vector database provider, webhooks, and removing unused dependencies. | | [`examples`](/examples) | Provides example configurations, authentication methods, and provider-specific examples. | | [`local_server`](/local_server) | Contains an implementation of the retrieval plugin configured for localhost testing. | | [`models`](/models) | Contains the data models used by the plugin, such as document and metadata models. | | [`scripts`](/scripts) | Offers scripts for processing and uploading documents from different data sources. | | [`server`](/server) | Houses the main FastAPI server implementation. | | [`services`](/services) | Contains utility services for tasks like chunking, metadata extraction, and PII detection. | | [`tests`](/tests) | Includes integration tests for various vector database providers. | | [`.well-known`](/.well-known) | Stores the plugin manifest file and OpenAPI schema, which define the plugin configuration and API specification. | This README provides detailed information on how to set up, develop, and deploy the ChatGPT Retrieval Plugin. ## Table of Contents - [Quickstart](#quickstart) - [About](#about) - [Plugins](#plugins) - [Retrieval Plugin](#retrieval-plugin) - [Memory Feature](#memory-feature) - [Security](#security) - [API Endpoints](#api-endpoints) - [Development](#development) - [Setup](#setup) - [General Environment Variables](#general-environment-variables) - [Choosing a Vector Database](#choosing-a-vector-database) - [Pinecone](#pinecone) - [Elasticsearch](#elasticsearch) - [Weaviate](#weaviate) - [Zilliz](#zilliz) - [Milvus](#milvus) - [Qdrant](#qdrant) - [Redis](#redis) - [Llama Index](#llamaindex) - [Chroma](#chroma) - [Azure Cognitive Search](#azure-cognitive-search) - [Supabase](#supabase) - [Postgres](#postgres) - [AnalyticDB](#analyticdb) - [Running the API Locally](#running-the-api-locally) - [Testing a Localhost Plugin in ChatGPT](#testing-a-localhost-plugin-in-chatgpt) - [Personalization](#personalization) - [Authentication Methods](#authentication-methods) - [Deployment](#deployment) - [Installing a Developer Plugin](#installing-a-developer-plugin) - [Webhooks](#webhooks) - [Scripts](#scripts) - [Limitations](#limitations) - [Contributors](#contributors) - [Future Directions](#future-directions) ## Quickstart Follow these steps to quickly set up and run the ChatGPT Retrieval Plugin: 1. Install Python 3.10, if not already installed. 2. Clone the repository: `git clone https://github.com/openai/chatgpt-retrieval-plugin.git` 3. Navigate to the cloned repository directory: `cd /path/to/chatgpt-retrieval-plugin` 4. Install poetry: `pip install poetry` 5. Create a new virtual environment with Python 3.10: `poetry env use python3.10` 6. Activate the virtual environment: `poetry shell` 7. Install app dependencies: `poetry install` 8. Create a [bearer token](#general-environment-variables) 9. Set the required environment variables: ``` export DATASTORE=<your_datastore> export BEARER_TOKEN=<your_bearer_token> export OPENAI_API_KEY=<your_openai_api_key> # Optional environment variables used when running Azure OpenAI export OPENAI_API_BASE=https://<AzureOpenAIName>.openai.azure.com/ export OPENAI_API_TYPE=azure export OPENAI_EMBEDDINGMODEL_DEPLOYMENTID=<Name of text-embedding-ada-002 model deployment> export OPENAI_METADATA_EXTRACTIONMODEL_DEPLOYMENTID=<Name of deployment of model for metatdata> export OPENAI_COMPLETIONMODEL_DEPLOYMENTID=<Name of general model deployment used for completion> export OPENAI_EMBEDDING_BATCH_SIZE=<Batch size of embedding, for AzureOAI, this value need to be set as 1> # Add the environment variables for your chosen vector DB. # Some of these are optional; read the provider's setup docs in /docs/providers for more information. # Pinecone export PINECONE_API_KEY=<your_pinecone_api_key> export PINECONE_ENVIRONMENT=<your_pinecone_environment> export PINECONE_INDEX=<your_pinecone_index> # Weaviate export WEAVIATE_URL=<your_weaviate_instance_url> export WEAVIATE_API_KEY=<your_api_key_for_WCS> export WEAVIATE_CLASS=<your_optional_weaviate_class> # Zilliz export ZILLIZ_COLLECTION=<your_zilliz_collection> export ZILLIZ_URI=<your_zilliz_uri> export ZILLIZ_USER=<your_zilliz_username> export ZILLIZ_PASSWORD=<your_zilliz_password> # Milvus export MILVUS_COLLECTION=<your_milvus_collection> export MILVUS_HOST=<your_milvus_host> export MILVUS_PORT=<your_milvus_port> export MILVUS_USER=<your_milvus_username> export MILVUS_PASSWORD=<your_milvus_password> # Qdrant export QDRANT_URL=<your_qdrant_url> export QDRANT_PORT=<your_qdrant_port> export QDRANT_GRPC_PORT=<your_qdrant_grpc_port> export QDRANT_API_KEY=<your_qdrant_api_key> export QDRANT_COLLECTION=<your_qdrant_collection> # AnalyticDB export PG_HOST=<your_analyticdb_host> export PG_PORT=<your_analyticdb_port> export PG_USER=<your_analyticdb_username> export PG_PASSWORD=<your_analyticdb_password> export PG_DATABASE=<your_analyticdb_database> export PG_COLLECTION=<your_analyticdb_collection> # Redis export REDIS_HOST=<your_redis_host> export REDIS_PORT=<your_redis_port> export REDIS_PASSWORD=<your_redis_password> export REDIS_INDEX_NAME=<your_redis_index_name> export REDIS_DOC_PREFIX=<your_redis_doc_prefix> export REDIS_DISTANCE_METRIC=<your_redis_distance_metric> export REDIS_INDEX_TYPE=<your_redis_index_type> # Llama export LLAMA_INDEX_TYPE=<gpt_vector_index_type> export LLAMA_INDEX_JSON_PATH=<path_to_saved_index_json_file> export LLAMA_QUERY_KWARGS_JSON_PATH=<path_to_saved_query_kwargs_json_file> export LLAMA_RESPONSE_MODE=<response_mode_for_query> # Chroma export CHROMA_COLLECTION=<your_chroma_collection> export CHROMA_IN_MEMORY=<true_or_false> export CHROMA_PERSISTENCE_DIR=<your_chroma_persistence_directory> export CHROMA_HOST=<your_chroma_host> export CHROMA_PORT=<your_chroma_port> # Azure Cognitive Search export AZURESEARCH_SERVICE=<your_search_service_name> export AZURESEARCH_INDEX=<your_search_index_name> export AZURESEARCH_API_KEY=<your_api_key> (optional, uses key-free managed identity if not set) # Supabase export SUPABASE_URL=<supabase_project_url> export SUPABASE_ANON_KEY=<supabase_project_api_anon_key> # Postgres export PG_HOST=<postgres_host> export PG_PORT=<postgres_port> export PG_USER=<postgres_user> export