api doc gpt

Documento API GPT

Esta es una herramienta de inteligencia artificial que le ayuda a descubrir la documentación de su API. Se basa en el modelo de lenguaje GPT-3.5 de OpenAI. Puede usar esto conectándose directamente a una aplicación FastApi o pasando un archivo openapi.json .

Configuración

Instalar las dependencias

pip install -r requirements.txt

Cómo utilizar con FastApi

1. Ejecute su aplicación backend

uvicorn main:app --reload

2. Ejecute el script

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

Cómo utilizar con openapi.json

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

Ejemplo de ejecución

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

Disfrute interactuando con la documentación de su API

Con GPT-4

Esto también funciona con GPT-4. Solo necesita pasar el parámetro --model-name=gpt-4 mientras ejecuta el script.

como funciona

Esto funciona creando documentación de API abierta desde su aplicación fastapi y luego usando el modelo de lenguaje GPT-3.5 para analizar la documentación de su API.

 diagrama de secuencia
    Usuario-->>+Procesador: Dame una lista de elementos. solo necesito 5 de ellos
    Procesador-->>+AI: AVISO: Dame una lista de elementos. solo necesito 5 de ellos
    AI-->>+Procesador: CMD: OBTENER /items?filter=5
    Procesador-->>+AI: CMD_RESP: [{"nombre": "pepino"}, {"nombre": "apio"}....]
    AI-->>+Procesador: OUT: Los artículos son pepino, apio...
    Procesador-->>+Usuario: Los elementos son pepino, apio...

Esto también admite reaccionar. Se pueden encontrar más detalles en: https://arxiv.org/abs/2210.03629

Restricciones

• Tamaño de la ficha