Autor: Ivo Perich
Contacto: iperich@smartpaper.ai
Versión: 1.0
Fecha de Creación: 21 de noviembre de 2024
A continuación se describen los pasos necesarios para crear un proyecto de investigación mediante la API de EDTECH API, a partir de un formulario inicial. Este proceso consta de 9 pasos:
Este método genera preguntas de investigación iniciales basadas en los parámetros proporcionados. Estas preguntas están alineadas con el tema, la unidad de análisis y el alcance definidos por el usuario.
POSThttps://edtechapi.com:7002/create_research_questionsBasic Authusername: [Tu API key]password: [Tu API secret]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
user_id |
String | Identificador único del usuario. |
place |
String | Ubicación geográfica relevante para la investigación (Ej.: New York). |
topic |
String | Tema central de la investigación (Ej.: COVID spread). |
unit_of_analysis |
String | Unidad de análisis del estudio (Ej.: kids). |
scope |
String | Alcance específico de la investigación (Ej.: public schools). |
discipline |
String | Disciplina académica a la que pertenece la investigación (Ej.: Public Health). |
country |
String | País relacionado con la investigación (Ej.: USA). |
lang |
String | Idioma en el que se generarán las preguntas (eng para inglés). |
{
"user_id": "jdoe_001",
"place": "New York",
"topic": "COVID spread",
"unit_of_analysis": "kids",
"scope": "public schools",
"discipline": "Public Health",
"country": "USA",
"lang": "eng"
}
La respuesta incluirá un form_id que identifica el proceso de generación de preguntas y un preproject_name generado a partir de los parámetros proporcionados.
form_id: ID del formulario ingresado, que identifica el proyecto.job_id: ID del procesopreproject_name: Nombre preliminar del proyecto generado automáticamente a partir de los parámetros clave.{
"form_id": 9,
"job_id":9,
"preproject_name": "New York - COVID spread - kids"
}
form_id obtenido será necesario para los pasos siguientes.preproject_name puede ser útil para organizar o identificar rápidamente proyectos relacionados con la investigación.Este método permite recuperar las preguntas de investigación generadas en el proceso iniciado con el método /create_research_questions. Utilizando el job_id, se puede obtener la lista completa de preguntas generadas, categorizadas por su tipo de investigación.
POSThttps://edtechapi.com:7002/get_research_questionsBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON e incluir el siguiente parámetro:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud generada con el método /create_research_questions. |
{
"job_id": 6
}
La respuesta contendrá el job_id solicitado, el estado de la solicitud, y una lista de preguntas de investigación generadas con su tipo de investigación y su identificador único.
job_id: ID de la solicitud.status: Estado de la solicitud, que puede tener uno de los siguientes valores:
"processing": Las preguntas de investigación están en proceso de generación."ready": Las preguntas de investigación están listas y disponibles.research_questions: Lista de preguntas generadas, disponible solo si el estado es "ready". Cada pregunta incluye:
id: Identificador único de la pregunta.pregunta: Texto de la pregunta de investigación.tipo: Tipo de investigación, que puede ser "Exploratory", "Explicative", "Descriptive", o "Correlational".{
"job_id": 6,
"status": "ready",
"research_questions": [
{
"id": 13,
"question": "What factors contribute to the spread of COVID-19 among children in New York public schools?",
"type": "Exploratory"
},
{
"id": 14,
"question": "How effective are current COVID-19 preventive measures in containing the virus spread in New York public schools?",
"type": "Explicative"
},
{
"id": 15,
"question": "What patterns of COVID-19 transmission can be observed among kids in New York public schools?",
"type": "Descriptive"
},
...
]
}
status es "processing", se recomienda esperar unos segundos e intentar nuevamente.status sea "ready", la lista de preguntas estará disponible en el campo research_questions.id), que será útil para editar o modificar preguntas en futuros pasos, si es necesario.Este método permite modificar o actualizar una pregunta de investigación previamente generada. Se utiliza el campo id obtenido en el método /get_research_questions para identificar y editar la pregunta específica.
POSThttps://edtechapi.com:7002/update_questionBasic Authusername: [Tu API key]password: [Tu API secret]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
question_id |
Integer | Identificador único de la pregunta a editar, campo id obtenido en el método /get_research_questions. |
updated_question |
String | Nueva redacción de la pregunta de investigación. |
{
"question_id": 24,
"updated_question": "What influence do socioeconomic factors have on COVID-19 spread among children in New York public schools?"
}
La respuesta confirmará si la actualización de la pregunta de investigación se realizó correctamente o si ocurrió un error.
status: Indica el resultado de la solicitud, con los siguientes posibles valores:
"success": La actualización de la pregunta fue exitosa."failed": Hubo un error al intentar realizar la actualización.Caso exitoso:
{
"status": "success"
}
Caso de error:
{
"status": "failed"
}
status es "success", la actualización de la pregunta fue realizada con éxito."failed", ocurrió un error en el sistema. Verifique los datos proporcionados y vuelva a intentarlo.question_id proporcionado sea válido y haya sido obtenido previamente mediante el método /get_research_questions.Este método genera un objetivo general de investigación basado en una pregunta específica de investigación. Se utiliza el question_id obtenido en el método /get_research_questions para identificar la pregunta seleccionada.
POSThttps://edtechapi.com:7002/create_general_objectiveBasic Authusername: [Tu API key]password: [Tu API secret]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
question_id |
Integer | Identificador único de la pregunta de investigación seleccionada. |
lang |
String | Idioma en el que se generará el objetivo general (eng para inglés). |
{
"question_id": 50,
"lang": "eng"
}
La respuesta contendrá un job_id que identifica el proceso de generación del objetivo general.
job_id: ID de la solicitud, confirmando que el objetivo general se ha generado correctamente.{
"job_id": 3
}
job_id obtenido en la respuesta será necesario para pasos futuros relacionados con la revisión o generación de documentos asociados al objetivo general.question_id proporcionado sea válido y haya sido obtenido previamente mediante el método /get_research_questions.Este método permite recuperar el objetivo general de investigación generado en el método /create_general_objective. Utilizando el job_id, se puede obtener el objetivo general una vez que el estado esté marcado como "ready".
POSThttps://edtechapi.com:7002/get_general_objectiveBasic Authusername: [Tu API key]password: [Tu API secret]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON e incluir el siguiente parámetro:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud generada en el método /create_general_objective. |
{
"job_id": 3
}
La respuesta contendrá el job_id solicitado, el estado de la solicitud, y el objetivo general generado.
job_id: ID de la solicitud.status: Estado de la solicitud, que puede tener uno de los siguientes valores:
"processing": El objetivo general está en proceso de generación."ready": El objetivo general está listo y disponible.general_objective: Texto del objetivo general generado, disponible solo si el estado es "ready".{
"job_id": 3,
"status": "ready",
"general_objective": "Identify the factors that contributed to the spread of COVID-19 among children in New York public schools over a one-year period, with the goal of providing evidence-based insights for the development of targeted public health interventions aimed at mitigating transmission risks in educational settings."
}
status es "processing", se recomienda esperar unos segundos e intentar nuevamente.status sea "ready", el objetivo general estará disponible en el campo general_objective.Este método permite modificar o actualizar un objetivo general previamente generado. Se utiliza el gen_objective_id para identificar y editar el objetivo específico.
POSThttps://edtechapi.com:7002/update_general_objectiveBasic Authusername: [Tu API key]password: [Tu API secret]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
gen_objective_id |
Integer | job_id del objetivo general a editar, obtenido en el método /create_general_objective. |
updated_gen_objective |
String | Nueva redacción del objetivo general. |
{
"gen_objective_id": 2,
"updated_gen_objective": "Identify the factors that contributed to the spread of COVID-19 among children in New York public schools over a one-year period, with the goal of providing evidence-based insights for the development of targeted public health interventions aimed at mitigating transmission risks in educational settings."
}
La respuesta confirmará si la actualización del objetivo general se realizó correctamente o si ocurrió un error.
status: Indica el resultado de la solicitud, con los siguientes posibles valores:
"success": La actualización del objetivo general fue exitosa."failed": Hubo un error en el sistema al intentar realizar la actualización.Caso exitoso:
{
"status": "success"
}
Caso de error:
{
"status": "failed"
}
status es "success", la actualización del objetivo general fue realizada con éxito."failed", ocurrió un error en el sistema. Verifique los datos proporcionados y vuelva a intentarlo.gen_objective_id proporcionado sea válido y haya sido obtenido previamente mediante el método /get_general_objective.Este método genera objetivos específicos e hipótesis basados en un objetivo general de investigación previamente definido. Se utiliza el gen_objective_id para identificar el objetivo general seleccionado.
POSThttps://edtechapi.com:7002/create_specific_objectives_hypothesesBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
gen_objective_id |
Integer | job_id del objetivo general, obtenido en el método /create_general_objective. |
lang |
String | Idioma en el que se generarán los objetivos específicos e hipótesis (esp o eng). |
{
"gen_objective_id": 2,
"lang": "eng"
}
La respuesta contendrá un job_id que identifica el proceso de generación de los objetivos específicos e hipótesis.
job_id: ID de la solicitud, confirmando que los objetivos específicos e hipótesis se han generado correctamente.{
"job_id": 1
}
job_id obtenido en la respuesta será necesario para recuperar los objetivos específicos e hipótesis generados en pasos posteriores.gen_objective_id sea válido y que el objetivo general haya sido definido previamente mediante el método /create_general_objective.Este método permite recuperar los objetivos específicos e hipótesis generados en el proceso iniciado con el método /create_specific_objectives_hypotheses. Utilizando el job_id, se obtiene una lista de objetivos específicos e hipótesis asociadas al objetivo general de investigación.
POSThttps://edtechapi.com:7002/get_specific_objectives_hypothesesBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud generada con el método /create_specific_objectives_hypotheses. |
{
"job_id": 1
}
La respuesta incluirá el job_id solicitado, el estado de la solicitud, y el contenido de los objetivos específicos e hipótesis generados.
job_id: ID de la solicitud.status: Estado de la solicitud, que puede tener los siguientes valores:
"processing": Los objetivos específicos e hipótesis están en proceso de generación."ready": Los objetivos específicos e hipótesis están listos y disponibles.specific_objectives: Texto que contiene los objetivos específicos generados.hypotheses: Texto que contiene las hipótesis generadas.{
"job_id": 1,
"status": "ready",
"specific_objectives": "1. Analyze the demographic, environmental, and behavioral factors that influenced the transmission dynamics of COVID-19 among children in New York public schools during the specified one-year period.\n\n2. Evaluate the effectiveness of existing public health measures and school policies implemented in New York public schools in reducing COVID-19 transmission among children, using epidemiological data and case studies.\n\n3. Investigate the role of community-level factors, including socioeconomic status and access to healthcare, in the spread of COVID-19 among children in New York public schools, to identify potential areas for targeted intervention.",
"hypotheses": "Hypothesis 1: Demographic factors such as age and household size, environmental factors including classroom ventilation, and behavioral factors such as mask-wearing compliance significantly influenced the transmission dynamics of COVID-19 among children in New York public schools during the specified one-year period.\n\nHypothesis 2: Existing public health measures and school policies, including mask mandates and social distancing protocols, were significantly effective in reducing COVID-19 transmission among children in New York public schools, with variations in effectiveness observed based on community-level factors such as socioeconomic status and access to healthcare."
}
status es "processing", se recomienda esperar unos segundos e intentar nuevamente.status sea "ready", los objetivos específicos estarán disponibles en el campo specific_objectives y las hipótesis en el campo hypotheses.\n\n"Este método permite modificar o actualizar los objetivos específicos generados previamente. Se utiliza el job_id asociado a los objetivos específicos para identificar el conjunto a editar.
POSThttps://edtechapi.com:7002/update_specific_objectivesBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud asociado a los objetivos específicos generados. |
updated_spec_obj |
String | Nueva redacción de los objetivos específicos en el formato deseado. |
{
"job_id": 1,
"updated_spec_obj": "1. Analyze the demographic, environmental, and behavioral factors that influenced the transmission dynamics of COVID-19 among children in New York public schools during the specified one-year period.\n\n2. Evaluate the effectiveness of existing public health measures and school policies implemented in New York public schools in reducing COVID-19 transmission among children, using epidemiological data and case studies.\n\n3. Investigate the role of community-level factors, including socioeconomic status and access to healthcare, in the spread of COVID-19 among children in New York public schools, to identify potential areas for targeted intervention."
}
La respuesta confirmará si la actualización de los objetivos específicos se realizó correctamente o si ocurrió un error.
status: Indica el resultado de la solicitud, con los siguientes posibles valores:
"success": La actualización de los objetivos específicos fue exitosa."failed": Hubo un error en el sistema al intentar realizar la actualización.Caso exitoso:
{
"status": "success"
}
Caso de error:
{
"status": "failed"
}
status es "success", la actualización fue realizada con éxito."failed", ocurrió un error en el sistema. Verifique los datos proporcionados y vuelva a intentarlo.job_id sea válido y haya sido obtenido previamente mediante el método /create_specific_objectives_hypotheses.Este método genera marcos relacionados con el objetivo general de investigación previamente definido y sus derivados previamente obtenidos. Se requiere el form_id y el gen_objective_id para identificar el formulario asociado y el objetivo general.
POSThttps://edtechapi.com:7002/create_frameworksBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
form_id |
Integer | ID del formulario asociado a la creación de marcos teóricos, obtenido en /create_research_questions. |
gen_objective_id |
Integer | Identificador único del objetivo general, obtenido en /create_general_objective. |
lang |
String | Idioma en el que se generarán los marcos teóricos (eng para inglés). |
{
"form_id": 2,
"gen_objective_id": 2,
"lang": "eng"
}
La respuesta contendrá un job_id que identifica el proceso de generación de los marcos teóricos.
job_id: ID de la solicitud, confirmando que los marcos teóricos se han generado correctamente.{
"job_id": 1
}
job_id obtenido en la respuesta será necesario para recuperar los marcos teóricos generados en pasos posteriores.form_id y el gen_objective_id sean válidos y estén asociados correctamente antes de realizar la solicitud.Este método permite recuperar los marcos teóricos generados en el proceso iniciado con el método /create_frameworks. Utilizando el job_id, se obtienen los marcos de referencia, teóricos y metodológicos asociados al objetivo general de investigación.
POSThttps://edtechapi.com:7002/get_frameworksBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud generado con el método /create_frameworks. |
{
"job_id": 1
}
La respuesta contendrá el job_id solicitado y los marcos generados.
job_id: ID de la solicitud.background_framework: Marco de referencia o contexto, describiendo estudios y antecedentes relevantes.theoretical_framework: Marco teórico que explica las perspectivas conceptuales relacionadas con el objetivo de investigación.methodologic_framework: Marco metodológico, que describe los enfoques y métodos diseñados para investigar el tema.{
"job_id": 1,
"background_framework": "The transmission of COVID-19 in educational settings has been a critical area of study since the onset of the pandemic, as schools and universities are environments where close contact is frequent, potentially facilitating the spread of the virus. Numerous studies have been conducted worldwide to assess the extent and nature of COVID-19 transmission in these settings, providing valuable insights into the effectiveness of various mitigation strategies and the impact of reopening educational institutions on community transmission rates.\n\nIn the United States, a study conducted by the Centers for Disease Control and Prevention (CDC) in 2021 analyzed data from K-12 schools across several states. The findings indicated that schools implementing strict mitigation measures, such as mandatory mask-wearing, physical distancing, and regular testing, reported significantly lower transmission rates compared to those with less stringent protocols. For instance, schools with mask mandates had a 37% lower incidence of COVID-19 cases among students and staff compared to schools without such mandates.\n\nIn Europe, a comprehensive study by the European Centre for Disease Prevention and Control (ECDC) in 2020 examined data from 15 countries. The study found that the reopening of schools did not lead to a significant increase in community transmission when appropriate measures were in place. In countries like Denmark and Norway, where schools reopened with robust health protocols, the incidence of COVID-19 remained stable, suggesting that schools were not major drivers of transmission.\n\nIn Asia, research conducted in South Korea provided further evidence of the effectiveness of...",
"theoretical_framework": "Russell M. Viner's perspective on COVID-19 transmission in educational settings focuses on understanding the dynamics of how the virus spreads within schools and other educational environments. He emphasizes the importance of considering the role of children and adolescents...",
"methodologic_framework": "**Expanded Methodological Proposal**\n\n**Introduction:**\nThis methodological proposal presents a detailed plan to investigate the factors contributing to the spread of COVID-19 among children in New York public schools over a one-year period. The study aims to provide evidence-based insights for developing targeted public health interventions. The methodology is designed to align with the general and specific objectives and test the proposed hypotheses..."
}
job_id sea válido y que el proceso de creación haya sido completado antes de hacer la solicitud."not ready", se recomienda intentar nuevamente en unos segundos.