api doc gpt

API-документ GPT

Это инструмент искусственного интеллекта, который поможет вам найти документацию по API. Он основан на языковой модели GPT-3.5 от OpenAI. Вы можете использовать это либо для прямого подключения к приложению 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

С ГПТ-4

Это также работает с GPT-4. Вам просто нужно передать параметр --model-name=gpt-4 при запуске скрипта.

Как это работает

Это работает путем создания документации по открытому API из вашего приложения fastapi, а затем использования языковой модели GPT-3.5 для анализа документации для вашего API.

 последовательностьдиаграмма
    Пользователь-->>+Процессор: Дайте мне список элементов. мне нужно всего 5 из них
    Процессор-->>+ИИ: ПОДСКАЗКА: Дайте мне список предметов. мне нужно всего 5 из них
    AI -->>+Процессор: CMD: GET /items?filter=5
    Процессор -->>+AI: CMD_RESP: [{"name": "огурец"}, {"name": "сельдерей"}...]
    AI-->>+Процессор: OUT: Продукты — огурец, сельдерей...
    Процессор-->>+Пользователь: Товары: огурец, сельдерей...

Это также поддерживает реакцию. Более подробную информацию можно найти по адресу: https://arxiv.org/abs/2210.03629.

Ограничения

• Размер токена