Skip to content

API REST diseñada para implementar y facilitar el uso de la API de OpenAI en un sistema de chat.

Notifications You must be signed in to change notification settings

Marc0Franc0/OpenAIAssistantAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API REST diseñada para implementar y facilitar el uso de la API de OpenAI en un sistema de chat basado en texto. Permite interactuar con el sistema de chat mediante dos endpoints principales.

Características

  • Consumo de API OpenAI: Integración con la API de OpenAI para procesar y generar respuestas coherentes y contextualizadas utilizando tecnologías avanzadas de NLP (Procesamiento del Lenguaje Natural).

Tecnologías

  • Spring Boot 3.2.4
  • Spring AI 0.8.1
  • Maven

Endpoints

GET /generateText

Este endpoint permite enviar mensajes de texto al sistema de chat para su procesamiento utilizando la API de OpenAI y obtener una respuesta coherente en formato de cadena de texto.

curl http://localhost:8080/api/v1/ai/generateText?message=Hola
  • Response
{"generation":"Texto generado por api"}

GET /generateTextStream

Este endpoint permite enviar mensajes de texto al sistema de chat para su procesamiento utilizando la API de OpenAI y obtener una respuesta coherente en formato de flujo de datos.

curl http://localhost:8080/api/v1/ai/generateTextStream?message=Hola
  • Response
"Texto generado por api"

GET /generateImage

Este endpoint permite solicitar un tipo de imágen para que la API de OpenAi devuelva cinco imágenes de acuerdo a lo solicitado.

curl http://localhost:8080/api/v1/ai/generateImage?message=ejemplo
  • Response
{
  "request": "Ejemplo",
  "imagesUrl": [
    "url1",
    "url2",
    "url3",
    "url4",
    "url5"
    ]
}

POST /generateText/audio

Este endpoint permite enviar un audio al sistema de chat para su procesamiento utilizando la API de OpenAI y obtener una respuesta coherente en formato de cadena de texto.

curl http://localhost:8080/api/v1/ai/generateText/audio
  • Response
{"generation":"Texto generado por api"}

POST /generateTextStream/audio

Este endpoint permite enviar un audio al sistema de chat para su procesamiento utilizando la API de OpenAI y obtener una respuesta coherente en formato de flujo de datos.

curl http://localhost:8080/api/v1/ai/generateTextStream/audio 
  • Response
"Texto generado por api"

Instalación y configuración

Sigue estos pasos para instalar y configurar la API:

  1. Clonar repositorio
git clone https://github.com/Marc0Franc0/OpenAiAssistantApi
  1. Configura la API de OpenAI:
  • Regístrate en OpenAI para obtener una clave API.
  • Dirigite a: OpenAIAssistantAPI/App/src/main/resources/application.yml
  • Configura la clave API en el archivo de configuración: Modifica el valor de ${SPRING_AI_OPENAI_APIKEY} con tu clave API
  1. Seguir pasos para ejecución con Maven

Ejecución con Maven

Para construir y ejecutar la aplicación necesita:

Ejecutar localmente

  1. Instala las dependencias
cd OpenAiAssistantApi
mvn clean install
  1. Inicia la app
cd App
mvn spring-boot:run

Dirigirse a:

About

API REST diseñada para implementar y facilitar el uso de la API de OpenAI en un sistema de chat.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages