api doc gpt

Document API GPT

Il s'agit d'un outil d'IA qui vous aide à découvrir la documentation de votre API. Il est basé sur le modèle de langage GPT-3.5 d'OpenAI. Vous pouvez l'utiliser soit en vous connectant directement à une application FastApi, soit en transmettant un fichier openapi.json .

Installation

Installer les dépendances

pip install -r requirements.txt

Comment utiliser avec FastApi

1. Exécutez votre application backend

uvicorn main:app --reload

2. Exécutez le script

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

Comment utiliser avec openapi.json

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

Exemple d'exécution

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

Profitez d'interagir avec la documentation de votre API

Avec GPT-4

Cela fonctionne également avec GPT-4. Il vous suffit de passer le paramètre --model-name=gpt-4 lors de l'exécution du script.

Comment ça marche

Cela fonctionne en créant une documentation API ouverte à partir de votre application fastapi, puis en utilisant le modèle de langage GPT-3.5 pour analyser la documentation de votre API.

 diagramme de séquence
    Utilisateur-->>+Processeur : Donnez-moi une liste d'éléments. Je n'en ai besoin que de 5
    Processeur-->>+AI : INVITE : Donnez-moi une liste d'éléments. Je n'en ai besoin que de 5
    AI-->>+Processeur : CMD : GET /items?filter=5
    Processeur-->>+AI : CMD_RESP : [{"name": "concombre"}, {"name": "céleri"}...]
    AI-->>+Processeur : OUT : Les éléments sont du concombre, du céleri...
    Processeur-->>+Utilisateur : Les éléments sont du concombre, du céleri...

Cela prend également en charge la réaction. Plus de détails peuvent être trouvés sur : https://arxiv.org/abs/2210.03629

Contraintes

• Taille du jeton