chatgpt-retrieval-plugin

KO | EN

gitlite — search

#python #hacktoberfest #typescript #llm #golang #machine-learning #deep-learning #linux #docker #java #awesome #vue #openai #mcp

chatgpt-retrieval-plugin

(★ 21,202)

ChatGPT Retrieval Plugin을 사용하면 자연어로 질문하여 개인 문서나 업무용 문서를 쉽게 찾을 수 있습니다.

파일 탐색기

최종 버전 다운로드 (.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
- - README.md
- - ai-plugin.json
  - main.py
  - openapi.yaml
  - README.md
- 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
- __init__.py
.dockerignore
.env.example
.gitignore
Dockerfile
LICENSE
Makefile
poetry.lock
pyproject.toml
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ChatGPT Retrieval Plugin
Retrieval Plugin 백엔드를 사용하여 개인 문서에 액세스할 수 있는 Custom GPT를 구축하세요.
![Example Custom GPT Screenshot](https://raw.githubusercontent.com/openai/chatgpt-retrieval-plugin/main/assets/example.png)
## 소개
ChatGPT Retrieval Plugin 저장소는 자연어 쿼리를 사용하여 개인 또는 조직 문서를 시맨틱 검색하고 검색(retrieval)하기 위한 유연한 솔루션을 제공합니다. 이는 독립형 검색 백엔드이며, [ChatGPT custom GPTs](https://chat.openai.com/gpts/discovery), [chat completions](https://platform.openai.com/docs/guides/text-generation) 또는 [assistants APIs](https://platform.openai.com/docs/assistants/overview)와 함께 사용하는 [function calling](https://platform.openai.com/docs/guides/function-calling), 혹은 [ChatGPT plugins model (deprecated)](https://chat.openai.com/?model=gpt-4-plugins)과 함께 사용할 수 있습니다. ChatGPT와 Assistants API는 모두 업로드된 파일에서의 검색을 기본적으로 지원하므로, 검색 시스템에 대한 더 세밀한 제어(예: 문서 텍스트 청크 길이, 임베딩 모델/크기 등)를 원할 때만 Retrieval Plugin을 백엔드로 사용해야 합니다.
이 저장소는 여러 디렉터리로 구성되어 있습니다:
| 디렉터리 | 설명 |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| [`datastore`](/datastore) | 다양한 벡터 데이터베이스 제공자를 사용하여 문서 임베딩을 저장하고 쿼리하는 핵심 로직을 포함합니다. |
| [`docs`](/docs) | 각 벡터 데이터베이스 제공자 설정 및 사용, 웹훅, 미사용 종속성 제거에 대한 문서를 포함합니다. |
| [`examples`](/examples) | 예제 구성, 인증 방법, 그리고 제공자별 예제를 제공합니다. |
| [`local\_server`](/local\_server) | 로컬호스트 테스트용으로 구성된 Retrieval Plugin 구현을 포함합니다. |
| [`models`](/models) | 문서 및 메타데이터 모델과 같이 플러그인에서 사용하는 데이터 모델을 포함합니다. |
| [`scripts`](/scripts) | 다양한 데이터 소스의 문서를 처리하고 업로드하기 위한 스크립트를 제공합니다. |
| [`server`](/server) | 메인 FastAPI 서버 구현을 담고 있습니다. |
| [`services`](/services) | 청킹, 메타데이터 추출, PII 탐지 등의 작업을 위한 유틸리티 서비스를 포함합니다. |
| [`tests`](/tests) | 다양한 벡터 데이터베이스 제공자를 위한 통합 테스트를 포함합니다. |
| [`.well-known`](/.well-known) | 플러그인 구성과 API 사상을 정의하는 플러그인 매니페스트 파일 및 OpenAPI 스키마를 저장합니다. |
이 README는 ChatGPT Retrieval Plugin(독립형 검색 백엔드)을 설정, 개발 및 배포하는 방법에 대한 자세한 정보를 제공합니다.
## 목차
- [Quickstart](#quickstart)
- [About](#about)
- [Retrieval Plugin](#retrieval-plugin)
- [Retrieval Plugin with custom GPTs](#retrieval-plugin-with-custom-gpts)
- [Retrieval Plugin with function calling](#retrieval-plugin-with-function-calling)
- [Retrieval Plugin with the plugins model (deprecated)](#chatgpt-plugins-model)
- [API Endpoints](#api-endpoints)
- [Memory Feature](#memory-feature)
- [Security](#security)
- [Choosing an Embeddings Model](#choosing-an-embeddings-model)
- [Development](#development)
- [Setup](#setup)
- [General Environment Variables](#general-environment-variables)
- [Choosing a Vector Database](#choosing-a-vector-database)
- [Pinecone](#pinecone)
- [Elasticsearch](#elasticsearch)
- [MongoDB Atlas](#mongodb-atlas)
- [Weaviate](#weaviate)
- [Zilliz](#zilliz)
- [Milvus](#milvus)
- [Qdrant](#qdrant)
- [Redis](#redis)
- [Llama Index](#llamaindex)
- [Chroma](#chroma)
- [Azure Cognitive Search](#azure-cognitive-search)
- [Azure CosmosDB Mongo vCore](#azure-cosmosdb-mongo-vcore)
- [Supabase](#supabase)
- [Postgres](#postgres)
- [AnalyticDB](#analyticdb)
- [Running the API Locally](#running-the-api-locally)
- [Personalization](#personalization)
- [Authentication Methods](#authentication-methods)
- [Deployment](#dep

loyment)
- [Webhooks](#webhooks)
- [Scripts](#scripts)
- [Limitations](#limitations)
- [Contributors](#contributors)
- [Future Directions](#future-directions)
## Quickstart
다음 단계를 따라 ChatGPT Retrieval Plugin을 빠르게 설정하고 실행할 수 있습니다:
1. Python 3.10이 설치되어 있지 않다면 설치합니다.
2. 저장소를 복제합니다: `git clone https://github.com/openai/chatgpt-retrieval-plugin.git`
3. 복제된 저장소 디렉터리로 이동합니다: `cd /path/to/chatgpt-retrieval-plugin`
4. poetry를 설치합니다: `pip install poetry`
5. Python 3.10으로 새로운 가상 환경을 생성합니다: `poetry env use python3.10`
6. 가상 환경을 활성화합니다: `poetry shell`
7. 앱 종속성을 설치합니다: `poetry install`
8. [bearer token](#general-environment-variables)을 생성합니다.
9. 필수 환경 변수를 설정합니다:
```
export DATASTORE=
export BEARER\_TOKEN=
export OPENAI\_API\_KEY=
export EMBEDDING\_DIMENSION=256 # edit this value based on the dimension of the embeddings you want to use
export EMBEDDING\_MODEL=text-embedding-3-large # edit this based on your model preference, e.g. text-embedding-3-small, text-embedding-ada-002
# Optional environment variables used when running Azure OpenAI
export OPENAI\_API\_BASE=https://.openai.azure.com/
export OPENAI\_API\_TYPE=azure
export OPENAI\_EMBEDDINGMODEL\_DEPLOYMENTID=
export OPENAI\_METADATA\_EXTRACTIONMODEL\_DEPLOYMENTID=
export OPENAI\_COMPLETIONMODEL\_DEPLOYMENTID=
export OPENAI\_EMBEDDING\_BATCH\_SIZE=
# 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=
export PINECONE\_ENVIRONMENT=
export PINECONE\_INDEX=
# Weaviate
export WEAVIATE\_URL=
export WEAVIATE\_API\_KEY=
export WEAVIATE\_CLASS=
# Zilliz
export ZILLIZ\_COLLECTION=
export ZILLIZ\_URI=
export ZILLIZ\_USER=
export ZILLIZ\_PASSWORD=
# Milvus
export MILVUS\_COLLECTION=
export MILVUS\_HOST=
export MILVUS\_PORT=
export MILVUS\_USER=
export MILVUS\_PASSWORD=
# Qdrant
export QDRANT\_URL=
export QDRANT\_PORT=
export QDRANT\_GRPC\_PORT=
export QDRANT\_API\_KEY=
export QDRANT\_COLLECTION=
# AnalyticDB
export PG\_HOST=
export PG\_PORT=
export PG\_USER=
export PG\_PASSWORD=
export PG\_DATABASE=
export PG\_COLLECTION=
# Redis
export REDIS\_HOST=
export REDIS\_PORT=
export REDIS\_PASSWORD=
export REDIS\_INDEX\_NAME=
export REDIS\_DOC\_PREFIX=
export REDIS\_DISTANCE\_METRIC=
export REDIS\_INDEX\_TYPE=
# Llama
export LLAMA\_INDEX\_TYPE=
export LLAMA\_INDEX\_JSON\_PATH=
export LLAMA\_QUERY\_KWARGS\_JSON\_PATH=
export LLAMA\_RESPONSE\_MODE=
# Chroma
export CHROMA\_COLLECTION=
export CHROMA\_IN\_MEMORY=
export CHROMA\_PERSISTENCE\_DIR=
export CHROMA\_HOST=
export CHROMA\_PORT=
# Azure Cognitive Search
export AZURESEARCH\_SERVICE=
export AZURESEARCH\_INDEX=
export AZURESEARCH\_API\_KEY= (optional, uses key-free managed identity if not set)
# Azure CosmosDB Mongo vCore
export AZCOSMOS\_API = 
export AZCOSMOS\_CONNSTR = 
export AZCOSMOS\_DATABASE\_NAME = 
export AZCOSMOS\_CONTAINER\_NAME = 
# Supabase
export SUPABASE\_URL=
export SUPABASE\_ANON\_KEY=
# Postgres
export PG\_HOST=
export PG\_PORT=
export PG\_USER=
export PG\_PASSWORD=
export PG\_DB=
# Elasticsearch
export ELASTICSEARCH\_URL= (either specify host or cloud\_id)
export ELASTICSEARCH\_CLOUD\_ID=
export ELASTICSEARCH\_USERNAME=
export ELASTICSEARCH\_PASSWORD=
export ELASTICSEARCH\_API\_KEY=
export ELASTICSEARCH\_INDEX=
export ELASTICSEARCH\_REPLICAS=
export ELASTICSEARCH\_SHARDS=
# MongoDB Atlas
export MONGODB\_URI=
export MONGODB\_DATABASE=
export MONGODB\_COLLECTION=
export MONGODB\_INDEX=
```
10. 로컬에서 API를 실행합니다: `poetry run start`
11. `http://0.0.0.0:8000/docs`에서 API 문서를 확인하고 API 엔드포인트를 테스트합니다(bearer token을 추가해야 합니다).
## About
### Retrieval Plugin
이 도구는 [ChatGPT custom GPTs](https://chat.openai.com/gpts/discovery), [function calling](https://platform.openai.com/d

ocs/guides/function-calling)과 [chat completions](https://platform.openai.com/docs/guides/text-generation), [assistants APIs](https://platform.openai.com/docs/assistants/overview) 또는 [ChatGPT plugins model (deprecated)](https://chat.openai.com/?model=gpt-4-plugins)와 함께 사용할 수 있습니다.
이를 통해 모델은 개인 또는 조직의 문서에 대한 시맨틱 검색 및 검색(retrieval)을 수행하고, 관련 검색 컨텍스트를 바탕으로 답변을 작성할 수 있습니다("검색증강 생성" 또는 "RAG"라고도 함). 사용자는 자연어로 질문하거나 요구 사항을 표현하여 파일, 메모, 이메일 등의 데이터 소스에서 가장 관련성이 높은 문서 스니펫을 얻을 수 있습니다. 기업은 이 플러그인을 사용하여 직원들이 ChatGPT를 통해 내부 문서를 활용할 수 있도록 만들 수 있습니다.
이 플러그인은 OpenAI의 embeddings 모델(`text-embedding-3-large` 256 dimension embeddings 기본값)을 사용하여 문서 청크의 임베딩을 생성한 다음, 백엔드의 벡터 데이터베이스를 사용하여 이를 저장하고 쿼리합니다. 오픈 소스이자 자체 호스팅 솔루션인 이 플러그인을 통해 개발자는 자신만의 Retrieval Plugin을 배포하고 ChatGPT에 등록할 수 있습니다. Retrieval Plugin은 여러 벡터 데이터베이스 제공업체를 지원하므로 개발자는 목록에서 선호하는 업체를 선택할 수 있습니다.
FastAPI 서버는 문서 업서트, 쿼리, 삭제를 위한 플러그인의 엔드포인트를 제공합니다. 사용자는 소스, 날짜, 작성자 또는 기타 기준에 따라 메타데이터 필터를 사용하여 검색 결과를 정밀하게 조정할 수 있습니다. 이 플러그인은 Fly.io, Heroku, Render 또는 Azure Container Apps와 같이 Docker 컨테이너를 지원하는 모든 클라우드 플랫폼에서 호스팅할 수 있습니다. 벡터 데이터베이스를 최신 문서로최신 상태로 유지하기 위해, 플러그인은 업서트 및 삭제 엔드포인트로 들어오는 수신 웹훅을 사용하여 다양한 데이터 소스의 문서를 지속적으로 처리하고 저장할 수 있습니다. [Zapier](https://zapier.com) 또는 [Make](https://www.make.com) 같은 도구를 사용하면 이벤트나 일정에 따라 웹훅을 구성하는 데 도움이 됩니다.

### Custom GPTs를 활용한 Retrieval Plugin
문서의 시맨틱 검색 및 검색을 위해 Retrieval Plugin을 사용할 수 있는 Custom GPT를 만들고, 데이터베이스에 새로운 정보를 다시 저장하려면 먼저 Retrieval Plugin을 배포해야 합니다. 이에 대한 자세한 지침은 [Deployment section](#deployment)을 참조하세요. 앱 URL(예: `https://your-app-url.com`)이 준비되면 다음 단계를 따르세요.

1. `https://chat.openai.com/gpts/editor`의 GPT 생성 페이지로 이동합니다.
2. 표준 생성 흐름에 따라 GPT를 설정합니다.
3. "Configure" 탭으로 이동합니다. 여기에서 이름, 설명, 지침 등의 필드를 수동으로 입력하거나 스마트 생성기의 도움을 받을 수 있습니다.
4. "Actions" 섹션에서 "Create new action"을 클릭합니다.
5. 인증 방법을 선택합니다. Retrieval Plugin은 None, API key (Basic 또는 Bearer), OAuth를 지원합니다. 이러한 방법에 대한 자세한 내용은 [Authentication Methods Section](#authentication-methods)을 참조하세요.
6. OpenAPI 스키마를 가져옵니다. 다음 중 하나를 수행할 수 있습니다:
- 앱에 호스팅된 OpenAPI 스키마(`https://your-app-url.com/.well-known/openapi.yaml`)에서 직접 가져옵니다.
- 쿼리 엔드포인트페이지만 GPT에 노출하려면 [this file](/.well-known/openapi.yaml)의 내용을 복사하여 Schema 입력 영역에 붙여넣습니다. 붙여넣은 OpenAPI 스키마의 `-servers` 섹션 아래에 있는 URL을 변경해야 합니다.
7. 선택적으로 fetch 엔드포인트를 추가할 수도 있습니다. 이는 [`/server/main.py`](/server/main.py) 파일을 편집하여 엔드포인트를 추가하고 선택한 벡터 데이터베이스에 맞게 구현하는 것을 포함합니다. 이 변경을 수행하는 경우, 풀 리퀘스트(pull request)를 열어 프로젝트에 다시 기여해 주시기 바랍니다! OpenAPI 스키마에 fetch 엔드포인트를 추가하면 검색된 결과에서 일부 텍스트가 잘린 경우 모델이 ID를 통해 문서에서 더 많은 콘텐츠를 가져올 수 있게 됩니다. 또한 검색된 결과의 텍스트가 포함된 문자열과 그 이전의 고정된 길이의 컨텍스트를 반환하는 옵션을 전달하는 것도 유용할 수 있습니다.

nd와 검색된 결과 사이.
8. GPT가 벡터 데이터베이스에 정보를 다시 저장할 수 있도록 하려면 Retrieval Plugin의 `/upsert` 엔드포인트에 대한 접근 권한을 부여할 수 있습니다. 이렇게 하려면 [this file](/examples/memory/openapi.yaml)의 내용을 스키마 영역에 복사해 넣으세요. 이를 통해 GPT는 대화 중에 생성하거나 학습한 새로운 정보를 저장할 수 있습니다. 이 기능에 대한 자세한 내용은 [Memory Feature](#memory-feature) 및 [여기 문서](/examples/memory)에서 확인할 수 있습니다.
기억하세요: ChatGPT와 커스텀 GPT는 업로드된 파일에서의 검색을 기본적으로 지원하므로, 검색 시스템에 대해 더 세밀한 제어(예: 자체 호스팅, 임베딩 청크 길이, 임베딩 모델/크기 등)를 원하는 경우에만 Retrieval Plugin을 백엔드로 사용해야 합니다.
### Function Calling을 사용하는 Retrieval Plugin
Retrieval Plugin은 [Chat Completions API](https://platform.openai.com/docs/guides/function-calling)와 [Assistants API](https://platform.openai.com/docs/assistants/overview) 모두에서 function calling과 통합할 수 있습니다. 이를 통해 모델은 대화 컨텍스트를 기반으로 함수(쿼리, 가져오기, 업서트)를 언제 사용할지 스스로 결정할 수 있습니다.
#### Chat Completions에서의 Function Calling
Chat Completions API 호출 시, 함수를 설명하고 모델이 하나 이상의 함수를 호출하기 위한 인자가 포함된 JSON 객체를 생성하도록 할 수 있습니다. 최신 모델(gpt-3.5-turbo-0125 및 gpt-4-turbo-preview)은 함수를 호출해야 하는 시점을 감지하고 함수 시그니처를 준수하는 JSON으로 응답하도록 학습되었습니다.
Retrieval Plugin 엔드포인트에 대한 함수를 정의하고, 최신 모델 중 하나와 함께 Chat Completions API를 사용할 때 이를 툴(tools)로 전달할 수 있습니다. 그러면 모델이 지능적으로 함수를 호출하게 됩니다. Function calling을 사용하여 API에 대한 쿼리를 작성하고, 백엔드의 엔드포인트를 호출하며, 그 응답을 툴 메시지로 모델에 반환하여 대화를 이어갈 수 있습니다. 함수 정의/스키마와 예시는 [여기](/examples/function-calling/)에서 확인할 수 있습니다.
#### Assistants API에서의 Function Calling
OpenAI [Assistants API](https://platform.openai.com/docs/assistants/overview), 구체적으로는 [툴 사용 시의 function calling](https://platform.openai.com/docs/assistants/tools/function-calling)에서 동일한 함수 정의를 사용할 수 있습니다. Assistants API를 사용하면 모델, 툴, 지식을 활용하여 사용자 질문에 응답하는 AI 어시스턴트를 자신의 애플리케이션 내에 구축할 수 있습니다. 함수 정의/스키마와 예시는 [여기](/examples/function-calling/)에서 확인할 수 있습니다. Assistants API는 업로드된 파일에서의 검색을 기본적으로 지원하므로, 검색 시스템에 대한 더 세밀한 제어(예: 임베딩 청크 길이, 임베딩 모델/크기 등)를 원하는 경우에만 function calling과 함께 Retrieval Plugin을 사용해야 합니다.
Chat Completions API와 Assistants API 모두 병렬 function calling(Parallel function calling)을 지원합니다. 즉, 동일한 메시지 안에서 무언가를 쿼리하고 벡터 데이터베이스에 무언가를 다시 저장하는 것과 같은 여러 작업을 동시에 수행할 수 있습니다.
Retrieval Plugin을 사용한 function calling에 대한 자세한 내용은 [여기](/examples/function-calling/)에서 읽어보세요.
### ChatGPT Plugins 모델
(지원 중단됨) ChatGPT를 통해 Retrieval Plugin을 사용하려면 GPT에서 커스텀 액션(Custom Actions)을 사용하는 것을 권장합니다. 지원이 중단된 플러그인 모델을 사용하여 검색 기능을 사용하는 방법에 대한 지침은 [여기](/docs/deprecated/plugins.md)에서 확인할 수 있습니다.
### API 엔드포인트
Retrieval Plugin은 Python으로 API를 구축하기 위한 웹 프레임워크인 FastAPI를 사용하여 만들어졌습니다. FastAPI를 사용하면 API 엔드포인트를 쉽게 개발, 검증 및 문서화할 수 있습니다. FastAPI 문서는 [여기](https://fastapi.tiangolo.com/)에서 확인하세요.
FastAPI를 사용할 때의 이점 중 하나는 Swagger UI를 통한 대화형 API 문서가 자동으로 생성된다는 점입니다. API가 로컬에서 실행 중일 때, `/docs`의 Swagger UI를 사용하여 API 엔드포인트와 상호 작용하고, 그 기능을 테스트하며, 예상되는 요청 및 응답 모델을 확인할 수 있습니다.
이 플러그인은

벡터 데이터베이스에서 문서를 업서트(upsert), 쿼리, 삭제하기 위한 다음과 같은 엔드포인트들을 제공합니다. 모든 요청과 응답은 JSON 형식이며, 인증 헤더로 유효한 bearer 토큰이 필요합니다.
- `/upsert`: 이 엔드포인트를 사용하면 하나 이상의 문서를 업로드하고 그 텍스트와 메타데이터를 벡터 데이터베이스에 저장할 수 있습니다. 문서들은 각각 고유한 ID를 가진 약 200 토큰 크기의 청크로 분할됩니다. 이 엔드포인트는 요청 본문에 문서 목록을 전달받으며, 각 문서에는 `text` 필드와 선택적인 `id`, `metadata` 필드가 포함됩니다. `metadata` 필드에는 `source`, `source\_id`, `url`, `created\_at`, `author`와 같은 선택적 하위 필드들이 포함될 수 있습니다. 엔드포인트는 삽입된 문서들의 ID 목록을 반환합니다(초기에 제공되지 않은 경우 ID가 생성됩니다).
- `/upsert-file`: 이 엔드포인트를 사용하면 단일 파일(PDF, TXT, DOCX, PPTX 또는 MD)을 업로드하고 그 텍스트와 메타데이터를 벡터 데이터베이스에 저장할 수 있습니다. 파일은 일반 텍스트로 변환된 후 각각 고유한 ID를 가진 약 200 토큰 크기의 청크로 분할됩니다. 이 엔드포인트는 삽입된 파일의 생성된 ID가 포함된 목록을 반환합니다.
- `/query`: 이 엔드포인트를 사용하면 하나 이상의 자연어 쿼리와 선택적 메타데이터 필터를 사용하여 벡터 데이터베이스를 쿼리할 수 있습니다. 이 엔드포인트는 요청 본문에 쿼리 목록을 전달받으며, 각 쿼리에는 `query` 및 선택적인 `filter`, `top\_k` 필드가 포함됩니다. `filter` 필드에는 `source`, `source\_id`, `document\_id`, `url`, `created\_at`, `author` 하위 필드 중 일부가 포함되어야 합니다. `top\_k` 필드는 주어진 쿼리에 대해 반환할 결과의 개수를 지정하며, 기본값은 3입니다. 이 엔드포인트는 주어진 쿼리에 대해 가장 관련성이 높은 문서 청크들의 목록과 그 텍스트, 메타데이터, 유사도 점수를 포함하는 객체들의 목록을 반환합니다.
- `/delete`: 이 엔드포인트를 사용하면 ID, 메타데이터 필터 또는 `delete\_all` 플래그를 사용하여 벡터 데이터베이스에서 하나 이상의 문서를 삭제할 수 있습니다. 이 엔드포인트는 요청 본문에서 `ids`, `filter`, `delete\_all` 파라미터 중 적어도 하나를 필요로 합니다. `ids` 파라미터는 삭제할 문서 ID의 목록이어야 하며, 이 ID들에 해당하는 문서의 모든 청크가 삭제됩니다. `filter` 파라미터에는 `source`, `source\_id`, `document\_id`, `url`, `created\_at`, `author` 하위 필드 중 일부가 포함되어야 합니다. `delete\_all` 파라미터는 벡터 데이터베이스의 모든 문서를 삭제할지 여부를 나타내는 불리언 값이어야 합니다. 이 엔드포인트는 삭제 성공 여부를 나타내는 불리언 값을 반환합니다.
요청 및 응답 모델의 상세한 명세와 예시는 앱을 로컬에서 실행한 후 http://0.0.0.0:8000/openapi.json에 접속하거나, [여기](/.well-known/openapi.yaml)의 OpenAPI 스키마에서 확인할 수 있습니다. OpenAPI 스키마에는 `/query` 엔드포인트만 포함되어 있다는 점에 유의하세요. 이는 ChatGPT가 접근해야 하는 유일한 기능이기 때문입니다. 이런 방식으로 ChatGPT는 자연어 쿼리나 필요에 따라 관련 문서를 검색하는 용도로만 플러그인을 사용할 수 있습니다. 그러나 개발자가 ChatGPT에 나중을 위한 기억 기능을 부여하고 싶다면, `/upsert` 엔드포인트를 사용하여 대화 내용의 일부를 벡터 데이터베이스에 저장할 수 있습니다. ChatGPT가 `/upsert` 엔드포인트에 접근할 수 있게 해주는 매니페스트 및 OpenAPI 스키마의 예시는 [여기](/examples/memory)에서 확인할 수 있습니다.
사용자 지정 메타데이터 필드를 추가하려면 [여기](/models/models.py)에서 `DocumentMetadata` 및 `DocumentMetadataFilter` 데이터 모델을 편집하고, [여기](/.well-known/openapi.yaml)에서 OpenAPI 스키마를 업데이트하세요. 앱을 로컬에서 실행하고 http://0.0.0.0:8000/sub/openapi.json에서 찾은 JSON을 복사한 뒤 [Swagger Editor](https://editor.swagger.io/)를 사용하여 YAML 형식으로 변환하면 쉽게 업데이트할 수 있습니다. 또는 `openapi.yaml` 파일을 `openapi.json` 파일로 교체할 수도 있습니다.
### 메모리 기능
Retrieval Plugin의 주목할 만한 특징은 ChatGPT에 메모리 기능을 제공하는 능력입니다. 플러그인의 업서트 엔드포인트를 사용함으로써 ChatGPT는 스니

대화 내용의 일부를 벡터 데이터베이스에 저장하여 나중에 참조할 수 있도록 합니다(사용자가 그렇게 하도록 요청한 경우에만 해당). 이 기능은 ChatGPT가 이전 대화의 정보를 기억하고 검색할 수 있도록 하여 더욱 맥락을 잘 이해하는 채팅 경험을 제공합니다. 메모리 기능과 함께 Retrieval Plugin을 설정하는 방법은 [여기](/examples/memory)에서 확인하세요.

### 보안
Retrieval Plugin을 사용하면 ChatGPT가 콘텐츠의 벡터 데이터베이스를 검색한 후 가장 좋은 결과를 ChatGPT 세션에 추가할 수 있습니다. 즉, 외부로 미치는 영향은 없으며, 주요 고려 사항은 데이터 권한 부여와 프라이버시입니다. 개발자는 자신이 권한을 가지고 있고 사용자의 ChatGPT 세션에 노출되어도 무방한 콘텐츠만 Retrieval Plugin에 추가해야 합니다. 플러그인을 보호하기 위해 다양한 인증 방법 중에서 선택할 수 있습니다(자세한 정보는 [여기](#authentication-methods) 참조).

### Embeddings 모델 선택
ChatGPT Retrieval Plugin은 OpenAI의 embeddings 모델을 사용하여 문서 청크의 embedding을 생성합니다. Retrieval Plugin의 기본 모델은 256 차원의 `text-embedding-3-large`입니다. OpenAI는 최신 embeddings 모델인 `text-embedding-3-small` 및 `text-embedding-3-large`와 구버전 모델인 `text-embedding-ada-002`를 제공합니다.
새로운 모델들은 검색 정확도의 현저한 저하 없이 embedding을 단축할 수 있도록 지원하므로, 검색 정확도, 비용, 속도 간의 균형을 맞출 수 있습니다.

모델 간의 비교는 다음과 같습니다:

| Model | Embedding Size | Average MTEB Score | Cost per 1k Tokens |
| ---------------------- | -------------- | ------------------ | ------------------ |
| text-embedding-3-large | 3072 | 64.6% | $0.00013 |
| text-embedding-3-large | 1024 | 64.1% | $0.00013 |
| text-embedding-3-large | 256 | 62.0% | $0.00013 |
| text-embedding-3-small | 1536 | 62.3% | $0.00002 |
| text-embedding-3-small | 512 | 61.6% | $0.00002 |
| text-embedding-ada-002 | 1536 | 61.0% | $0.0001 |

모델을 선택할 때 고려할 사항:
1. \*\*검색 정확도 대 비용\*\*: `text-embedding-3-large`는 가장 높은 정확도를 제공하지만 비용이 더 높습니다. `text-embedding-3-small`은 경쟁력 있는 정확도를 유지하면서도 비용 효율적입니다. 구버전인 `text-embedding-ada-002` 모델은 가장 낮은 정확도를 가집니다.
2. \*\*Embedding 크기\*\*: 더 큰 embedding은 더 나은 정확도를 제공하지만 더 많은 스토리지를 소비하고 쿼리 속도가 느려질 수 있습니다. 이러한 요소들의 균형을 맞추기 위해 embedding의 크기를 조정할 수 있습니다.

예를 들어, 벡터 데이터베이스가 최대 1024 차원을 지원하는 경우 `text-embedding-3-large`를 사용하고 차원 API 매개변수를 1024로 설정할 수 있습니다. 이렇게 하면 3072 차원에서 embedding이 단축되어, 정확도를 일부 희생하는 대신 스토리지 및 쿼리 비용을 낮출 수 있습니다.

선택한 embeddings 모델과 크기를 변경하려면 다음 환경 변수를 편집하세요:

```
EMBEDDING\_DIMENSION=256 # edit this value based on the dimension of the embeddings you want to use
EMBEDDING\_MODEL="text-embedding-3-large" # edit this value based on the model you want to use e.g. text-embedding-3-small, text-embedding-ada-002
```

## 개발
### 설정
이 앱은 Python 3.10과 종속성 관리를 위해 [poetry](https://python-poetry.org/)를 사용합니다.

컴퓨터에 Python 3.10이 아직 설치되어 있지 않다면 설치하세요. 공식 [Python 웹사이트](https://www.python.org/downloads/)에서 다운로드하거나 시스템에 따라 `brew` 또는 `apt` 같은 패키지 관리자를 통해 설치할 수 있습니다.

GitHub에서 리포지토리를 클론합니다:

```
git clone https://github.com/openai/chatgpt-retrieval-plugin.git
```

클론한 리포지토리 디렉토리로 이동합니다:

```
cd /path/to/chatgpt-retrieval-plugin
```

poetry를 설치합니다:

```
pip install poetry
```

Python 3.10을 사용하는 새로운 가상 환경을 생성합니다:

```
poetry env use python3.10
poetry shell
```

poetry를 사용하여 앱 종속성을 설치합니다:

```
poetry install
```

\*\*참고:\*\* `pyproject.toml`에 종속성을 추가하는 경우, 반드시 `poetry lock`과 `poetry install`을 실행하세요.

#### 일반 환경 변수
API에는 다음 환경 변수가 필요합니다

les to work:
| Name | Required | Description |
| ---------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `DATASTORE` | Yes | 임베딩을 저장하고 쿼리하는 데 사용할 벡터 데이터베이스 제공업체를 지정합니다. `elasticsearch`, `chroma`, `pinecone`, `weaviate`, `zilliz`, `milvus`, `qdrant`, `redis`, `azuresearch`, `supabase`, `postgres`, `analyticdb`, `mongodb-atlas` 중에서 선택할 수 있습니다. |
| `BEARER\_TOKEN` | Yes | API 요청을 인증하는 데 필요한 보안 토큰입니다. [jwt.io](https://jwt.io/)와 같이 선호하는 도구이나 방법을 사용하여 생성할 수 있습니다. |
| `OPENAI\_API\_KEY` | Yes | OpenAI 임베딩 모델 중 하나를 사용하여 임베딩을 생성하는 데 필요한 OpenAI API 키입니다. [OpenAI](https://openai.com/)에서 계정을 생성하여 API 키를 얻을 수 있습니다. |
### Azure OpenAI와 함께 플러그인 사용하기
Azure OpenAI는 리소스 고유의 URL을 사용하며, 모델 이름이 아닌 배포 ID(deployment ID)로 모델을 참조합니다. 따라서 이 경우에는 추가 환경 변수를 설정해야 합니다.
`OPENAI\_API\_BASE`(사용자 고유의 URL) 및 `OPENAI\_API\_TYPE`(azure) 외에도, 업서트 및 쿼리 시 임베딩을 가져오는 데 사용할 모델을 지정하는 `OPENAI\_EMBEDDINGMODEL\_DEPLOYMENTID`도 설정해야 합니다. 이를 위해 `text-embedding-ada-002` 모델을 배포하고 여기에 해당 배포 이름을 사용하는 것을 권장합니다.
데이터 준비 스크립트를 사용하려면 메타데이터 추출에 사용되는 `OPENAI\_METADATA\_EXTRACTIONMODEL\_DEPLOYMENTID`와 PII 처리에 사용되는 `OPENAI\_COMPLETIONMODEL\_DEPLOYMENTID`도 설정해야 합니다.
### 벡터 데이터베이스 선택하기
이 플러그인은 각각 다른 기능, 성능, 가격 책정을 가진 여러 벡터 데이터베이스 제공업체를 지원합니다. 선택하는 데이터베이스에 따라 다른 Dockerfile을 사용하고 다른 환경 변수를 설정해야 합니다. 다음 섹션에서는 각 벡터 데이터베이스 제공업체에 대한 간단한 소개를 제공합니다.
각 벡터 데이터베이스 제공업체 설정 및 사용에 대한 더 자세한 내용은 `/docs/providers//setup.md` 파일의 해당 문서([여기의 폴더들](/docs/providers))를 참조하세요.
#### Pinecone
[Pinecone](https://www.pinecone.io)은 속도, 확장성, 그리고 프로덕션 환경으로의 빠른 배포를 위해 설계된 관리형 벡터 데이터베이스입니다. 하이브리드 검색을 지원하며, 현재 SPLADE 희소 벡터(sparse vector)를 네이티브로 지원하는 유일한 데이터스토어입니다. 자세한 설정 지침은 [`/docs/providers/pinecone/setup.md`](/docs/providers/pinecone/setup.md)를 참조하세요.
#### Weaviate
[Weaviate](https://weaviate.io/)는 수십억 개의 데이터 객체로 원활하게 확장할 수 있도록 구축된 오픈소스 벡터 검색 엔진입니다. 기본적으로 하이브리드 검색을 지원하므로 효율적인 키워드 검색이 필요한 사용자에게 적합합니다. Weaviate는 자체 호스팅 또는 관리형으로 사용할 수 있어 배포의 유연성을 제공합니다. 자세한 설정 지침은 [`/docs/providers/weaviate/setup.md`](/docs/providers/weaviate/setup.md)를 참조하세요.
#### Zilliz
[Zilliz](https://zilliz.com)는 수십억 규모의 데이터를 위해 설계된 관리형 클라우드 네이티브 벡터 데이터베이스입니다. 다양한 인덱싱 알고리즘, 거리 측정법, 스칼라 필터링, 타임 트래블 검색, 스냅샷을 통한 롤백, 전체 RBAC, 99.9% 가동 시간, 스토리지와 연산의 분리, 다국어 SDK 등 광범위한 기능을 제공합니다. 자세한 설정 지침은 [`/docs/providers/zilliz/setup.md`](/docs/providers/zilliz/setup.md)를 참조하세요.
#### Milvus
[Milvus](https://milvus.io/)는 수십억 개의 벡터로 확장되는 오픈소스 클라우드 네이티브 벡터 데이터베이스입니다. Zilliz의 오픈소스 버전이며 다양한 인덱싱 알고리즘, 거리 측정법, 스칼라 필터링, 타임 트래블 검색, 롤백 등 많은 기능을 공유합니다.

스냅샷, 다국어 SDK, 스토리지와 연산의 분리, 그리고 클라우드 확장성을 제공합니다. 자세한 설정 방법은 [`/docs/providers/milvus/setup.md`](/docs/providers/milvus/setup.md)를 참고하세요.
#### Qdrant
[Qdrant](https://qdrant.tech/)는 문서와 벡터 임베딩을 저장할 수 있는 벡터 데이터베이스입니다. 자체 호스팅 및 관리형 [Qdrant Cloud](https://cloud.qdrant.io/) 배포 옵션을 모두 제공하여 다양한 요구사항을 가진 사용자에게 유연성을 제공합니다. 자세한 설정 방법은 [`/docs/providers/qdrant/setup.md`](/docs/providers/qdrant/setup.md)를 참고하세요.
#### Redis
[Redis](https://redis.com/solutions/use-cases/vector-database/)는 일상적인 애플리케이션 및 AI/ML 워크로드를 포함한 다양한 사용 사례에 적합한 실시간 데이터 플랫폼입니다. [Redis Stack docker container](/examples/docker/redis/docker-compose.yml)를 사용하여 Redis 데이터베이스를 생성함으로써 저지연 벡터 엔진으로 사용할 수 있습니다. 호스팅/관리형 솔루션으로는 [Redis Cloud](https://app.redislabs.com/#/)를 사용할 수 있습니다. 자세한 설정 방법은 [`/docs/providers/redis/setup.md`](/docs/providers/redis/setup.md)를 참고하세요.
#### LlamaIndex
[LlamaIndex](https://github.com/jerryjliu/llama\_index)는 LLM과 외부 데이터를 연결하는 중앙 인터페이스입니다.
ChatGPT와 함께 사용할 수 있도록 비구조화 및 구조화된 데이터에 대한 일련의 인메모리 인덱스를 제공합니다.
표준 벡터 데이터베이스와 달리, LlamaIndex는 다양한 사용 사례에 최적화된 광범위한 인덱싱 전략(예: 트리, 키워드 테이블, 지식 그래프)을 지원합니다.
가볍고 사용하기 쉬우며 추가적인 배포가 필요 없습니다.
필요한 것은 몇 가지 환경 변수를 지정하는 것뿐입니다(선택적으로 기존에 저장된 인덱스 json 파일을 지정할 수 있습니다).
쿼리의 메타데이터 필터링은 아직 지원되지 않습니다.
자세한 설정 방법은 [`/docs/providers/llama/setup.md`](/docs/providers/llama/setup.md)를 참고하세요.
#### Chroma
[Chroma](https://trychroma.com)는 시작을 최대한 쉽게 만들도록 설계된 AI 네이티브 오픈소스 임베딩 데이터베이스입니다. Chroma는 인메모리 또는 클라이언트-서버 설정으로 실행됩니다. 메타데이터 및 키워드 필터링을 기본으로 지원합니다. 자세한 설정 방법은 [`/docs/providers/chroma/setup.md`](/docs/providers/chroma/setup.md)를 참고하세요.
#### Azure Cognitive Search
[Azure Cognitive Search](https://azure.microsoft.com/products/search/)는 벡터 검색, 텍스트 검색, 그리고 하이브리드(벡터와 텍스트를 결합하여 두 접근 방식의 장점을 극대화)를 지원하는 완전한 검색 클라우드 서비스입니다. 또한 결과 품질을 더욱 향상시키기 위한 [선택적 L2 재순위화 단계](https://learn.microsoft.com/azure/search/semantic-search-overview)를 제공합니다. 자세한 설정 방법은 [`/docs/providers/azuresearch/setup.md`](/docs/providers/azuresearch/setup.md)를 참고하세요.
#### Azure CosmosDB Mongo vCore
[Azure CosmosDB Mongo vCore](https://learn.microsoft.com/en-us/azure/cosmos-db/mongodb/vcore/)는 임베딩에 대한 벡터 검색을 지원하며, 이를 통해 AI 기반 애플리케이션을 Azure CosmosDB에 저장된 데이터와 원활하게 통합할 수 있습니다. 자세한 설정 방법은 [`/docs/providers/azurecosmosdb/setup.md`](/docs/providers/azurecosmosdb/setup.md)를 참고하세요.
#### Supabase
[Supabase](https://supabase.com/blog/openai-embeddings-postgres-vector)는 Postgres 데이터베이스용 [pgvector](https://github.com/pgvector/pgvector) 확장을 통해 벡터를 쉽고 효율적으로 저장할 수 있는 방법을 제공합니다. [Supabase CLI를 사용](https://github.com/supabase/cli)하여 로컬이나 클라우드에 전체 Supabase 스택을 설정하거나, docker-compose, k8s 및 기타 사용 가능한 옵션을 사용할 수도 있습니다. 호스팅/관리형 솔루션을 원한다면 [Supabase.com](https://supabase.com/)을 이용해 내장된 인증, 스토리지, 자동 API, 실시간(Realtime) 기능과 함께 Postgres의 강력한 기능을 온전히 활용해 보세요. 자세한 설정 방법은 [`/docs/providers/supabase/setup.md`](/docs/providers/supabase/setup.md)를 참고하세요.
#### Postgres
[Postgres](https://www.postgresql.org)는 쉽고 효율적인 방법을 제공합니다.

[pgvector](https://github.com/pgvector/pgvector) 확장을 사용하여 벡터를 저장합니다. pgvector를 사용하려면 pgvector 확장이 활성화된 PostgreSQL 데이터베이스를 설정해야 합니다. 예를 들어 [Docker를 사용](https://www.docker.com/blog/how-to-use-the-postgres-docker-official-image/)하여 로컬에서 실행할 수 있습니다. 호스팅/관리형 솔루션의 경우 [pgvector](https://github.com/pgvector/pgvector#hosted-postgres)를 지원하는 클라우드 공급업체 중 하나를 사용할 수 있습니다. 자세한 설정 지침은 [`/docs/providers/postgres/setup.md`](/docs/providers/postgres/setup.md)를 참조하세요.
#### AnalyticDB
[AnalyticDB](https://www.alibabacloud.com/help/en/analyticdb-for-postgresql/latest/product-introduction-overview)는 문서 및 벡터 임베딩을 저장하도록 설계된 분산 클라우드 네이티브 벡터 데이터베이스입니다. PostgreSQL 구문과 완전히 호환되며 Alibaba Cloud에서 관리합니다. AnalyticDB는 수십억 개의 데이터 벡터를 처리하는 강력한 벡터 연산 엔진을 제공하며, 인덱싱 알고리즘, 정형 및 비정형 데이터 기능, 실시간 업데이트, 거리 측정, 스칼라 필터링 및 시점 검색(time travel search) 같은 기능을 제공합니다. 자세한 설정 지침은 [`/docs/providers/analyticdb/setup.md`](/docs/providers/analyticdb/setup.md)를 참조하세요.
#### Elasticsearch
[Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)는 현재 `dense\_vector` 필드 타입을 통해 벡터 저장을 지원하며, 이를 사용하여 문서 점수를 계산합니다. Elasticsearch 8.0은 이 기능을 바탕으로 빠르고 대략적인 근접 이웃 검색(ANN)을 지원합니다. 이는 훨씬 더 확장 가능한 접근 방식으로, 대규모 데이터셋에서도 벡터 검색이 효율적으로 실행되도록 해줍니다. 자세한 설정 지침은 [`/docs/providers/elasticsearch/setup.md`](/docs/providers/elasticsearch/setup.md)를 참조하세요.
#### Mongodb-Atlas
[MongoDB Atlas](https://www.mongodb.com/docs/atlas/getting-started/) 현재 이 절차는 너비가 2048 차원 이하인 벡터 임베딩을 특징으로 하는 모든 컬렉션에 대해 Atlas Vector Search 인덱스를 생성하는 것을 포함합니다. 이는 Atlas 클러스터의 추가 데이터와 공존하는 다양한 데이터에 적용되며, 프로세스는 Atlas UI 및 Atlas Administration API를 통해 실행됩니다. 자세한 내용은 [`/docs/providers/mongodb\_atlas/setup.md`](/docs/providers/mongodb\_atlas/setup.md)를 참조하세요.
### 로컬에서 API 실행하기
로컬에서 API를 실행하려면 먼저 `export` 명령으로 필수 환경 변수를 설정해야 합니다:
```
export DATASTORE=
export BEARER\_TOKEN=
export OPENAI\_API\_KEY=
```

다음 명령어로 API를 시작하세요:
```
poetry run start
```
터미널에 표시된 URL 뒤에 `docs`를 추가하고 브라우저에서 열어 API 문서에 액세스하고 엔드포인트를 테스트하세요 (예: http://0.0.0.0:8000/docs). 반드시 Bearer 토큰을 입력하고 API 엔드포인트를 테스트해 보세요.
**참고:** `pyproject.toml` 파일에 새로운 의존성을 추가하는 경우, `poetry lock`과 `poetry install`을 실행하여 잠금 파일을 업데이트하고 새로운 의존성을 설치해야 합니다.

### 개인화
다음과 같이 자신만의 사용 사례에 맞게 Retrieval Plugin을 개인화할 수 있습니다:
- **로고 교체**: [logo.png](/.well-known/logo.png)의 이미지를 사용자 자신의 로고로 교체하세요.
- **데이터 모델 수정**: [models.py](/models/models.py)의 `DocumentMetadata` 및 `DocumentMetadataFilter` 데이터 모델을 수정하여 커스텀 메타데이터 필드를 추가하세요. 그에 맞춰 [openapi.yaml](/.well-known/openapi.yaml)의 OpenAPI 스키마를 업데이트하세요. OpenAPI 스키마를 더 쉽게 업데이트하려면, 앱을 로컬에서 실행한 다음 `http://0.0.0.0:8000/sub/openapi.json`으로 이동하여 웹페이지의 내용을 복사하면 됩니다. 그런 다음 [Swagger Editor](https://editor.swagger.io/)로 이동하여 JSON을 붙여넣어 YAML 형식으로 변환하세요. 또한 [.well-known](/.well-known) 폴더 내의 [openapi.yaml](/.well-known/openapi.yaml) 파일을 openapi.json 파일로 교체할 수도 있습니다.
- **플러그인 이름, 설명 및 사용 지침 변경**: 모델의 플러그인 이름, 사용자 대면 설명, 사용 지침을 업데이트하세요. [main.py](/server/main.py 파일의 설명을 수정하거나 [openapi.yaml](/.well-known/openapi.yaml) 파일을 업데이트하면 됩니다. OpenAPI 스키마를 업데이트하려면 이전 단계와 동일한 지침을 따르세요.
- **ChatGPT가 대화 내용을 저장할 수 있도록 설정**: [memory example folder](/examples/memory)의 지침을 참조하세요.

### 인증 방식
플러그인에 대한 요청을 인증하기 위해 다음 네 가지 옵션 중 하나를 선택할 수 있습니다:
1. **인증 없음**: 누구나 자격 증명 없이 플러그인을 추가하고 API를 사용할 수 있습니다. 이 옵션은 민감하지 않거나 이미 공개된 문서만 노출하는 경우에 적합합니다. 데이터에 대한 보안을 제공하지 않습니다. 이 방법을 사용하는 경우, [main.py](/examples/authentication-methods/no-auth/main.py)의 내용을 [실제 main.py 파일](/server/main.py)에 복사하세요. 매니페스트 예시는 [여기](/examples/authentication-methods/no-auth/ai-plugin.json)에 있습니다.
2. **HTTP Bearer**: 플러그인에 대한 요청을 승인하기 위해 헤더에 비밀 토큰을 사용할 수 있습니다. 이 옵션에는 두 가지 변형이 있습니다:
- **사용자 수준** (이 구현의 기본값): ChatGPT에 플러그인을 추가하는 각 사용자는 플러그인을 추가할 때 Bearer 토큰을 제공해야 합니다. [jwt.io](https://jwt.io/)와 같이 선호하는 도구나 방법을 사용하여 이러한 토큰을 생성하고 배포할 수 있습니다. 이 방법은 각 사용자가 공유 액세스 토큰을 입력해야 하므로 더 나은 보안을 제공합니다. 각 사용자마다 고유한 액세스 토큰이 필요한 경우 [main.py](/server/main.py) 파일에서 직접 구현해야 합니다. 매니페스트 예시는 [여기](/examples/authentication-methods/user-http/ai-plugin.json)에 있습니다.
- **서비스 수준**: 누구나 자격 증명 없이 플러그인을 추가하고 API를 사용할 수 있지만, 플러그인을 등록할 때 Bearer 토큰을 추가해야 합니다. 플러그인을 설치할 때 Bearer 토큰을 추가해야 하며, 그 후 호스팅된 매니페스트 파일에 포함해야 하는 토큰을 ChatGPT로부터 받게 됩니다. 이 토큰은 플러그인을 추가하는 모든 사용자를 대신하여 플러그인에 대한 요청을 승인하는 데 ChatGPT에 의해 사용됩니다. 이 방법은 사용자에게 더 편리하지만, 모든 사용자가 동일한 토큰을 공유하고 플러그인을 설치하기 위해 토큰을 추가할 필요가 없으므로 보안성이 떨어질 수 있습니다. 매니페스트 예시는 [여기](/examples/authentication-methods/service-http/ai-plugin.json)에 있습니다.
3. **OAuth**: 사용자가 플러그인을 추가하려면 OAuth 플로우를 거쳐야 합니다. OAuth 공급자를 사용하여 플러그인을 추가하는 사용자를 인증하고 API에 대한 액세스 권한을 부여할 수 있습니다. 이 방법은

신뢰할 수 있는 제3자 제공업체를 통해 사용자가 인증하므로 가장 높은 수준의 보안과 제어 기능을 제공합니다. 그러나 [main.py](/server/main.py) 파일에서 직접 OAuth 플로우를 구현하고 매니페스트 파일에 필요한 매개변수를 제공해야 합니다. 매니페스트 예시는 [여기](/examples/authentication-methods/oauth/ai-plugin.json)에서 확인할 수 있습니다.

사용 사례와 보안 요구 사항에 가장 잘 맞는 인증 방식을 선택하기 전에 각 인증 방식의 장단점을 고려하세요. 기본값(사용자 수준 HTTP)과 다른 방식을 사용하기로 선택한 경우, [여기](/.well-known/ai-plugin.json)의 매니페스트 파일을 업데이트해야 합니다.

## 배포

선호도와 요구 사항에 따라 다양한 클라우드 제공업체에 앱을 배포할 수 있습니다. 하지만 선택한 제공업체와 관계없이 앱 내의 두 파일인 [openapi.yaml](/.well-known/openapi.yaml)과 [ai-plugin.json](/.well-known/ai-plugin.json)을 업데이트해야 합니다. 위에서 설명한 것처럼 이 파일들은 각각 앱의 API 사양과 AI 플러그인 구성을 정의합니다. 두 파일 모두에서 배포된 앱의 주소와 일치하도록 url 필드를 변경해야 합니다.

Render는 두 파일의 url 필드를 자동으로 업데이트해 주는 원클릭 배포 옵션을 제공합니다.

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/render-examples/chatgpt-retrieval-plugin/tree/main)

앱을 배포하기 전에 [pyproject.toml](/pyproject.toml) 파일에서 사용하지 않는 종속성을 제거하여 앱의 크기를 줄이고 성능을 개선하는 것이 좋습니다. 선택한 벡터 데이터베이스 제공업체에 따라 특정 제공업체에 필요하지 않은 패키지를 제거할 수 있습니다. 각 제공업체별로 사용하지 않는 종속성을 제거하는 방법에 대한 자세한 내용은 [`/docs/deployment/removing-unused-dependencies.md`](/docs/deployment/removing-unused-dependencies.md) 파일의 관련 문서를참조하세요.

지침:
- [Fly.io에 배포하기](/docs/deployment/flyio.md)
- [Heroku에 배포하기](/docs/deployment/heroku.md)
- [Render에 배포하기](/docs/deployment/render.md)
- [기타 배포 옵션](/docs/deployment/other-options.md) (Azure Container Apps, Google Cloud Run, AWS Elastic Container Service 등)

앱을 배포한 후에는 [이 스크립트들](/scripts) 중 하나를 사용하거나 `/upsert` 엔드포인트를 호출하여 초기 문서 배치를 업로드하는 것을 고려해 보세요.

## 웹훅

벡터 데이터베이스에 저장된 문서를최신 상태로 유지하려면 [Zapier](https://zapier.com) 또는 [Make](https://www.make.com) 같은 도구를 사용하여 이벤트나 일정에 따라 플러그인 API로 들어오는 수신 웹훅을 구성하는 것이 좋습니다. 예를 이를 통해 메모를 업데이트하거나 이메일을 받을 때 새로운 정보를 동기화할 수 있습니다. 또한 [Zapier Transfer](https://zapier.com/blog/zapier-transfer-guide/)를 사용하여 기존 문서 컬렉션을 일괄 처리하고 벡터 데이터베이스에 업로드할 수 있습니다.

이러한 도구에서 플러그인으로 사용자 정의 필드를 전달해야 하는 경우, `upsert-email`과 같이 데이터스토어의 upsert 함수를 호출하는 추가 Retrieval Plugin API 엔드포인트를 생성하는 것이 좋습니다. 이 사용자 정의 엔드포인트는 웹훅에서 특정 필드를 받아 그에 따라 처리하도록 설계할 수 있습니다.

수신 웹훅을 설정하려면 다음 일반 단계를 따르세요:
- Zapier 또는 Make 같은 웹훅 도구를 선택하고 계정을 만듭니다.
- 해당 도구에서새로운 웹훅 또는 전송(transfer)을 설정하고 이벤트나 일정에 따라 트리거되도록 구성합니다.
- 웹훅의 대상 URL을 지정합니다. 이는 Retrieval Plugin의 API 엔드포인트여야 합니다 (예: `https://your-plugin-url.com/upsert`).
- 필요한 데이터 필드가 포함되도록 웹훅 페이로드를 구성하고 Retrieval Plugin의 API 요구 사항에 맞게 형식을 지정합니다.
- 웹훅이 제대로 작동하는지, 예상대로 Retrieval Plugin에 데이터를 전송하는지 테스트합니다.

웹훅을 설정한 후에는 이전에 누락된 데이터가 확실히 포함되도록 백필(backfill)을 실행하는 것이 좋습니다.

벡터 데이터베이스에 포함됩니다.
Incoming Webhook을 사용하여 데이터를 지속적으로 동기화하려면, 데이터 누락을 방지하기 위해 이러한 설정을 마친 후 백필(backfill)을 실행하는 것을 고려해야 합니다.
Zapier나 Make와 같은 도구를 사용하는 것 외에도, Retrieval Plugin과 데이터를 동기화하기 위한 사용자 정의 통합을 직접 구축할 수 있습니다. 이를 통해 데이터 흐름을 더욱 제어하고 특정 요구 사항에 맞게 통합을 맞춤화할 수 있습니다.
## Scripts
`scripts` 폴더에는 zip 파일, JSON 파일, JSONL 파일 등 다양한 데이터 소스에서 텍스트 문서를 일괄 업서트(upsert)하거나 처리하기 위한 스크립트가 포함되어 있습니다. 이 스크립트들은 문서를 평문(plain text)으로 변환하고 청크(chunk)로 분할한 후, 플러그인의 업서트 유틸리티 함수를 사용하여 문서와 그 메타데이터를 벡터 데이터베이스에 업로드합니다. 각 스크립트 폴더에는 사용 방법과 필요한 매개변수를 설명하는 README 파일이 있습니다. 또한 [`services.pii\_detection`](/services/pii\_detection.py) 모듈을 사용하여 언어 모델로 문서에 개인 식별 정보(PII)가 있는지 선택적으로 검사하고, 감지될 경우 건너뛸 수 있습니다. 이는 민감하거나 사적인 문서가 의도치 않게 벡터 데이터베이스에 업로드되는 것을 방지하는 데 유용할 수 있습니다. 추가로, [`services.extract\_metadata`](/services/extract\_metadata.py) 모듈을 사용하여 언어 모델로 문서 텍스트에서 메타데이터를 선택적으로 추출할 수 있습니다. 이는 문서 메타데이터를 보강하고 싶을 때 유용할 수 있습니다. \*\*참고:\*\* Incoming Webhook을 사용하여 데이터를 지속적으로 동기화하는 경우, 데이터 누락을 방지하기 위해 설정 완료 후 백필(backfill)을 실행하는 것을 고려하세요.
스크립트 목록은 다음과 같습니다:
- [`process\_json`](scripts/process\_json/): 이 스크립트는 JSON 형식의 문서 파일 덤프를 처리하고 일부 메타데이터와 함께 벡터 데이터베이스에 저장합니다. JSON 파일의 형식은 JSON 객체들의 리스트여야 하며, 각 객체는 하나의 문서를 나타냅니다. JSON 객체에는 `text` 필드가 있어야 하며, 선택적으로 메타데이터를 채울 다른 필드들을 포함할 수 있습니다. 사용자 정의 메타데이터를 JSON 문자열로 제공할 수 있으며, PII 검사 및 메타데이터 추출을 위한 플래그를 지정할 수 있습니다.
- [`process\_jsonl`](scripts/process\_jsonl/): 이 스크립트는 JSONL 형식의 문서 파일 덤프를 처리하고 일부 메타데이터와 함께 벡터 데이터베이스에 저장합니다. JSONL 파일의 형식은 줄 바꿈으로 구분된 JSON 파일이며, 각 줄은 문서를 나타내는 유효한 JSON 객체입니다. JSON 객체에는 `text` 필드가 있어야 하며, 선택적으로 메타데이터를 채울 다른 필드들을 포함할 수 있습니다. 사용자 정의 메타데이터를 JSON 문자열로 제공할 수 있으며, PII 검사 및 메타데이터 추출을 위한 플래그를 지정할 수 있습니다.
- [`process\_zip`](scripts/process\_zip/): 이 스크립트는 zip 파일 형태의 문서 파일 덤프를 처리하고 일부 메타데이터와 함께 벡터 데이터베이스에 저장합니다. zip 파일의 형식은 docx, pdf, txt, md, pptx 또는 csv 파일들로 구성된 단일 레벨의 zip 파일 폴더여야 합니다. 사용자 정의 메타데이터를 JSON 문자열로 제공할 수 있으며, PII 검사 및 메타데이터 추출을 위한 플래그를 지정할 수 있습니다.
## Pull Request (PR) Checklist
기여하고 싶으시다면 PR을 제출할 때 아래의 체크리스트를 따라주세요. 변경 사항을 검토하고 병합하는 데 큰 도움이 됩니다! 기여해주셔서 감사합니다!
1. \*\*PR 유형\*\*: 제목의 시작 부분에 대괄호로 `[Bugfix]`, `[Feature]`, `[Enhancement]`, `[Refactor]`, 또는 `[Documentation]`과 같은 레이블을 추가하여 PR 유형을 나타냅니다.
2. \*\*간단한 설명\*\*: 이루어진 변경 사항을 설명하는 간결하고 유익한 PR 설명을 제공합니다.
3. \*\*연결된 이슈\*\*: `Fixes` 또는 `Closes` 키워드 뒤에 관련 이슈 번호를 작성하여 관련 이슈를 언급합니다 (예: Fixes #123, Closes #456).
4. \*\*브랜치\*\*: 변경 사항을 위한 새 브랜치를 생성했으며, 이 브랜치가 `main` 브랜치의 최신 버전을 기반으로 하는지 확인합니다.
5. \*\*코드 변경 사항\*\*: 코드 변경 사항이 최소화되어 있고, 집중되어 있으며, 다루고 있는 이슈나 기능과 관련이 있는지 확인합니다.
6. \*\*커밋 메시지\*\*: 명확하고 간결한 커밋 메시지를 작성합니다.

각 커밋의 목적을 설명하는 메시지.
7. \*\*Tests\*\*: 새로운 코드나 기존 코드 변경 사항에 대해 유닛 테스트 및/또는 통합 테스트를 포함하세요. PR을 제출하기 전에 모든 테스트가 통과하는지 확인하세요.
8. \*\*Documentation\*\*: 변경된 사항을 반영할 수 있도록 관련 문서(예: README, 인라인 주석 또는 외부 문서)를 업데이트하세요.
9. \*\*Review Requested\*\*: 저장소의 다른 기여자나 메인이터 중 최소 한 명에게 리뷰를 요청하세요.
10. \*\*Video Submission\*\* (복잡하거나 규모가 큰 PR의 경우): PR에 중요한 변경 사항, 복잡성 또는 많은 양의 코드 라인이 포함된 경우, PR과 함께 간단한 시연 영상을 제출하세요. 영상은 변경 사항의 목적, 그 이면에 있는 로직, 그리고 이것이 문제를 해결하거나 제안된 기능을 추가하는 방법을 설명해야 합니다. 이는 리뷰어가 기여도를 더 잘 이해하고 리뷰 과정을 가속화하는 데 도움이 됩니다.

## Pull Request Naming Convention
PR 브랜치에 다음 네이밍 규칙을 사용하세요:
```
/-
```
- ``: `bugfix`, `feature`, `enhancement`, `refactor`, 또는 `docs`와 같은 PR의 유형. 여러 유형을 사용하는 것도 괜찮으며 , 로 나타내야 합니다.
- ``: 단어들을 구분하기 위해 하이픈(-)을 사용하여 변경 사항을 간략하게 설명한 내용.
- ``: 변경 사항과 관련된 이슈 번호(해당되는 경우).

예시:
```
feature/advanced-chunking-strategy-123
```

## Limitations
ChatGPT Retrieval Plugin은 시맨틱 검색과 검색(retrieval)을 위한 유연한 솔루션을 제공하도록 설계되었지만, 다음과 같은 몇 가지 제한 사항이 있습니다:
- \*\*Keyword search limitations\*\*: 선택한 OpenAI embeddings 모델이 생성한 임베딩이 정확한 키워드 일치를 포착하는 데 항상 효과적이지는 않을 수 있습니다. 결과적으로, 특정 키워드에 크게 의존하는 쿼리의 경우 플러그인이 가장 관련성이 높은 결과를 반환하지 못할 수 있습니다. Elasticsearch, Pinecone, Weaviate 및 Azure Cognitive Search와 같은 일부 벡터 데이터베이스는 하이브리드 검색을 사용하며 키워드 검색에서 더 나은 성능을 발휘할 수 있습니다.
- \*\*Sensitive data handling\*\*: 플러그인은 민감한 데이터를 자동으로 감지하거나 필터링하지 않습니다. Retrieval Plugin에 콘텐츠를 포함할 수 있는 필수 권한이 있는지, 그리고 해당 콘텐츠가 데이터 개인정보 보호 요건을 준수하는지 확인하는 것은 개발자의 책임입니다.
- \*\*Scalability\*\*: 플러그인의 성능은 선택한 벡터 데이터베이스 제공자와 데이터셋의 크기에 따라 달라질 수 있습니다. 일부 제공자는 다른 제공자보다 더 나은 확장성과 성능을 제공할 수 있습니다.
- \*\*Metadata extraction\*\*: 선택 사항인 메타데이터 추출 기능은 문서 텍스트에서 정보를 추출하기 위해 언어 모델에 의존합니다. 이 과정이 항상 정확한 것은 아니며, 추출된 메타데이터의 품질은 문서의 내용과 구조에 따라 달라질 수 있습니다.
- \*\*PII detection\*\*: 선택 사항인 PII detection 기능은 완벽하지 않으며 개인 식별 정보의 모든 사례를 잡아내지 못할 수 있습니다. 이 기능은 주의해서 사용하고 특정 사용 사례에 대한 효과를 확인하세요.

## Future Directions
ChatGPT Retrieval Plugin은 시맨틱 검색과 검색을 위한 유연한 솔루션을 제공하지만, 추가 개발의 가능성은 항상 열려 있습니다. 새로운 기능이나 개선 사항에 대한 풀 리퀘스트를 제출하여 프로젝트에 기여하도록 장려합니다. 주목할만한 기여에 대해서는 OpenAI 크레딧이 주어질 수 있습니다.

향후 발전 방향에 대한 몇 가지 아이디어는 다음과 같습니다:
- \*\*More vector database providers\*\*: 다른 벡터 데이터베이스 제공자를 ChatGPT Retrieval Plugin과 통합하는 데 관심이 있다면, 언제든지 구현 내용을 제출해 주세요.
- \*\*Additional scripts\*\*: 다양한 데이터 소스에서 문서를 처리하고 업로드하는 데 사용할 수 있는 스크립트 범위를 확장하면 플러그인이 더욱 다재다능해질 것입니다.
- \*\*User Interface\*\*: 문서를 관리하고 플러그인과 상호 작용할 수 있는 사용자 인터페이스를 개발하면 사용자 경험을 향상시킬 수 있습니다.
- \*\*Hybrid search / TF-IDF option\*\*: [datastore's upsert function](/datastore/datastore.py#L18)을 다음 기능으로 강화하기

하이브리드 검색 또는 TF-IDF 인덱싱을 사용하는 옵션은 키워드 기반 쿼리에 대한 플러그인의 성능을 향상시킬 수 있습니다.
- \*\*고급 청킹 전략 및 임베딩 계산\*\*: 문서 제목과 요약 임베딩, 문서 청크와 요약의 가중 평균 수행, 또는 문서의 평균 임베딩 계산과 같은 더 정교한 청킹 전략 및 임베딩 계산을 구현하면 더 나은 검색 결과를 얻을 수 있습니다.
- \*\*사용자 정의 메타데이터\*\*: 사용자가 제목이나 기타 관련 정보와 같은 사용자 정의 메타데이터를 문서 청크에 추가할 수 있도록 허용하면 일부 사용 사례에서 검색된 결과가 향상될 수 있습니다.
- \*\*추가 선택적 서비스\*\*: 문서 요약 또는 임베딩 전 문서 전처리와 같은 더 많은 선택적 서비스를 통합하면 플러그인의 기능과 검색된 결과의 품질을 향상시킬 수 있습니다. 이러한 서비스는 스크립트에서만 사용할 수 있는 것이 아니라 언어 모델을 사용하여 구현되고 플러그인에 직접 통합될 수 있습니다.

우리는 ChatGPT Retrieval Plugin을 개선하고 기능을 확장하는 데 도움이 되는 커뮤니티의 기여를 환영합니다. 기여하고 싶은 아이디어나 기능이 있다면 저장소에 풀 리퀘스트를 제출해 주세요.

## 기여자
ChatGPT Retrieval Plugin과의 다양한 벡터 데이터베이스 제공업체 통합에 대한 코드/문서 기여 및 지원을 해주신 다음 기여자분들께 감사의 말씀을 드립니다.

- [Pinecone](https://www.pinecone.io/)
- [acatav](https://github.com/acatav)
- [gkogan](https://github.com/gkogan)
- [jamescalam](https://github.com/jamescalam)
- [Weaviate](https://www.semi.technology/)
- [byronvoorbach](https://github.com/byronvoorbach)
- [hsm207](https://github.com/hsm207)
- [sebawita](https://github.com/sebawita)
- [Zilliz](https://zilliz.com/)
- [filip-halt](https://github.com/filip-halt)
- [Milvus](https://milvus.io/)
- [filip-halt](https://github.com/filip-halt)
- [Qdrant](https://qdrant.tech/)
- [kacperlukawski](https://github.com/kacperlukawski)
- [Redis](https://redis.io/)
- [spartee](https://github.com/spartee)
- [tylerhutcherson](https://github.com/tylerhutcherson)
- [LlamaIndex](https://github.com/jerryjliu/llama\_index)
- [jerryjliu](https://github.com/jerryjliu)
- [Disiok](https://github.com/Disiok)
- [Supabase](https://supabase.com/)
- [egor-romanov](https://github.com/egor-romanov)
- [Postgres](https://www.postgresql.org/)
- [egor-romanov](https://github.com/egor-romanov)
- [mmmaia](https://github.com/mmmaia)
- [Elasticsearch](https://www.elastic.co/)
- [joemcelroy](https://github.com/joemcelroy)

chatgpt-retrieval-plugin

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

chatgpt-retrieval-plugin

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README