jeffepn/microservicesummary

Microservicesummary API Documentation

💻 Microservicio para realizar resúmenes automáticos utilizando Cohere, LangChain y Hugging Face.

Setup Instructions

1. Clonar el Repositorio

git clone <repository-url>
cd <repository-folder>

2. Configurar Variables de Entorno

Crea un archivo .env en la raíz del proyecto con las siguientes variables:

SECRET_KEY="asd"
MONGO_URI="mongodb://root:example@localhost:27017/test_db"
COHERE_API_KEY="your_cohere_api_key"

3. Iniciar la Aplicación con Docker

docker-compose up --build

4. Acceder a la API

• —API Base: https://jeffepn-microservicesummary.hf.space
• —Documentación Swagger: https://jeffepn-microservicesummary.hf.space/docs#

Endpoints

1. Health Check

• —URL: /
• —Method: GET
• —Descripción: Verifica que el servicio esté activo.
• —Respuesta:

{"message": "FastAPI está funcionando correctamente"}

2. Subir Archivo y Procesar Resumen

• —URL: /summary_async/
• —Method: POST
• —Descripción: Recibe un archivo (CSV o JSON) con los datos requeridos, valida las columnas y lanza la generación de resúmenes en segundo plano.
• —Headers: Ninguno.
• —Body: Archivo en formato CSV o JSON.
• —Respuesta:

{
  "dataset_id": "63f8e7b8a4e6a7d2c9bf19a",
  "message": "Procesamiento iniciado en segundo plano."
}

3. Procesar Resumen General

• —URL: /summary_general/
• —Method: POST
• —Descripción: Carga el archivo, genera un ID de proceso y ejecuta la generación de resúmenes en segundo plano.
• —Body:
• —Archivo en formato CSV.
• —Parámetros:
• —cluster_column (string): Nombre de la columna que representa el clúster.
• —comment_column (string): Nombre de la columna que contiene los comentarios.
• —Respuesta:

{
  "process_id": "unique-process-id"
}

5. Consultar Resumen

• —URL: /summaries/{dataset_id}
• —Method: GET
• —Descripción: Recupera el resumen y el estado asociado a un ID de clúster.
• —Path Parameters:
• —dataset_id (string): ID del dataset.
• —Respuesta:

{
  "dataset_id": "0",
  "summary": {
    "status": "completed",
    "summary": "Resumen del clúster 0..."
  }
}

6. Consultar Estado de Resumen

• —URL: /status/{dataset_id}
• —Method: GET
• —Descripción: Verifica el estado de un resumen por ID del dataset.
• —Path Parameters:
• —dataset_id (string): ID del dataset.
• —Respuesta:

{
  "dataset_id": "0",
  "status": "completed"
}

7. Obtener Todos los Resúmenes

• —URL: /summaries/
• —Method: GET
• —Descripción: Obtiene todos los resúmenes almacenados en la base de datos.
• —Respuesta:

{
  "summaries": [
    {
      "dataset_id": "0",
      "summary": "Resumen del clúster 0..."
      "status": "completed",
      "timestamp": "2024-11-22T17:30:43.689028"
    },
    {
      "dataset_id": "1",
      "summary": "Resumen del clúster 1..."
      "status": "completed",
      "timestamp": "2024-11-22T17:30:43.689028"
    }
  ]
}

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference