api doc gpt

API 문서 GPT

이는 API 문서를 검색하는 데 도움이 되는 AI 도구입니다. OpenAI의 GPT-3.5 언어 모델을 기반으로 합니다. FastApi 앱에 직접 연결하거나 openapi.json 파일을 전달하여 이를 사용할 수 있습니다.

설정

종속성 설치

pip install -r requirements.txt

FastApi와 함께 사용하는 방법

1. 백엔드 앱 실행

uvicorn main:app --reload

2. 스크립트 실행

python api_master.py --openai-key < your-openai-key > --target < your-fastapi-app > --base-url < your-base-url > 

openapi.json과 함께 사용하는 방법

python api_master.py --openai-key < your-openai-key > --openapi-json < openapi-json > --base-url < your-base-url > 

실행 예시

python api_master.py --openai-key= < your-openai-key > --openapi-json=./example/openapi.json --base-url= " https://petstore3.swagger.io/api/v3 "

API 문서와 상호 작용하는 것을 즐기십시오

GPT-4 사용

이는 GPT-4에서도 작동합니다. 스크립트를 실행하는 동안 --model-name=gpt-4 매개변수를 전달하면 됩니다.

작동 원리

이는 fastapi 앱에서 개방형 API 문서를 생성한 다음 GPT-3.5 언어 모델을 사용하여 API에 대한 문서를 분석하는 방식으로 작동합니다.

 시퀀스 다이어그램
    사용자->>+처리자: 항목 목록을 알려주세요. 5개만 필요해요
    프로세서-->>+AI: 프롬프트: 항목 목록을 알려주세요. 5개만 필요해요
    AI-->>+프로세서: CMD: GET /items?filter=5
    프로세서-->>+AI: CMD_RESP: [{"name": "오이"}, {"name": "셀러리"}...]
    AI-->>+프로세서: OUT: 항목은 오이, 셀러리...
    프로세서-->>+사용자: 항목은 오이, 셀러리...

이것은 또한 반응을 지원합니다. 자세한 내용은 https://arxiv.org/abs/2210.03629에서 확인할 수 있습니다.

제약

• 토큰 크기