Método: Crear Marco Teórico a partir de Papers

Descripción

Este método permite generar un marco teórico a partir de papers enviados por el usuario, más la información de su proyecto. A diferencia de otros métodos, este utiliza una solicitud multipart/form-data para aceptar archivos (hasta 15) junto con los datos relacionados al proyecto de investigación. Los archivos son procesados en base a los objetivos y la hipótesis del proyecto.

Endpoint

• Método: POST
• URL: https://edtechapi.com:7002/create_theoretical_framework

Autenticación

• Tipo de Autenticación: Basic Auth
• Credenciales:
  • username: [Tu clave de API]
  • password: [Tu secreto de API]

Formato de Envío

La solicitud debe enviarse como multipart/form-data, con los siguientes campos obligatorios:

Ejemplo de Solicitud (en form-data)

Respuesta

Al recibir correctamente los datos y archivos, el sistema procesará la información y devolverá un identificador de tarea (job_id) para consultar el marco teórico generado más adelante.

Ejemplo de Respuesta (JSON)

{
    "job_id": 6
}

Notas

• Los archivos serán procesados para extraer información relevante que nutra el marco teórico de forma automática y contextual.
• Es necesario conservar el job_id para consultar el contenido generado en el siguiente paso (/get_status_theoretical_framework).
• Asegúrate de que los archivos sean relevantes y estén bien nombrados para mejorar la calidad del resultado.

Método: Obtener Estado del Marco Teórico Automatizado

Descripción

Este método permite verificar el estado de generación del marco teórico solicitado con /create_theoretical_framework. Además de indicar si el proceso está listo, detalla el estado de análisis de cada archivo enviado y proporciona el marco integrado generado si el estado es "ready".

Endpoint

• Método: POST
• URL: https://edtechapi.com:7002/get_status_theoretical_framework

Autenticación

• Tipo de Autenticación: Basic Auth
• Credenciales:
  • username: [Tu clave de API]
  • password: [Tu secreto de API]

Cuerpo de la Solicitud (JSON)

{
    "job_id": 6
}

Respuesta

Si el estado está listo ("ready"), la respuesta incluirá:

• Análisis por archivo (con estatus individual y referencia APA generada si aplica).
• Un campo marco_integrado que contiene el texto completo del marco teórico integrado.

Campos de la Respuesta

Ejemplo de Respuesta (JSON) (contiene como ejemplo un archivo erróneo y otro correcto)

{
    "job_id": 6,
    "status": "ready",
    "files": {
        "0": {
            "file": "archivo_erroneo.pdf",
            "status": "file error",
            "apa": "error"
        },
        "1": {
            "file": "Variabilidad genética del ADN mitocondrial de poblaciones de abejas.pdf",
            "status": "finished",
            "apa": "Salamanca Grosso, G. (2009). Variabilidad genética del ADN mitocondrial..."
        }
    },
    "marco_integrado": "MARCO TEÓRICO\n\nAspectos generales de la ancestría en Apis mellifera..."
}

Consideraciones

• Si algún archivo genera error ("file error"), no detendrá el proceso completo.
• Si los archivos están correctos, el método entregará el nombre del archivo y la cita en APA, incluso mientras el status sea "processing". Esto puede usarse para mostrar que los archivos están siendo procesados, de forma anticipada al usuario, debido a que la espera puede ser larga para este método.
• Los archivos válidos serán utilizados para elaborar automáticamente el marco teórico, con referencias APA integradas.
• Este método puede demorar más, es un método que consume tiempo debido a la gran cantidad de proceso que ocupa.
• Si el status es "processing", se recomienda esperar unos segundos antes de volver a consultar.
• El contenido en marco_integrado es el marco en sí y puede utilizarse directamente en un trabajo de investigación. Se encuentra en formato markdown.