Daily Learning · GPT-Aktionen

Daily Learning Plugin

This plugin acts as a personalizd tutor to learn a subject.
POST /courseGenerates a course based on a subject, and user context (user description and objectives)
POST /lessonGenerates the lesson content for the current day
Ursprüngliches API-Schema
{
  "openapi": "3.0.1",
  "info": {
    "title": "Daily Learning Plugin",
    "description": "This plugin acts as a personalizd tutor to learn a subject.",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://lumin8ed.com"
    }
  ],
  "paths": {
    "/course": {
      "post": {
        "operationId": "course",
        "summary": "Generates a course based on a subject, and user context (user description and objectives)",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CourseRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CourseResponse"
                }
              }
            }
          },
          "500": {
            "description": "Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/lesson": {
      "post": {
        "operationId": "lesson",
        "summary": "Generates the lesson content for the current day",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LessonRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LessonResponse"
                }
              }
            }
          },
          "500": {
            "description": "Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CourseRequest": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "description": "The subject of the course"
          },
          "context": {
            "type": "string",
            "description": "Suggestion for chatbot - provide any useful context about the user and what they need from the course that can help generate a customized course outline for the subject. For the best user experience, ask them questions."
          }
        }
      },
      "CourseResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "instructionsForAgent": {
            "type": "string"
          },
          "courseId": {
            "type": "string"
          }
        }
      },
      "LessonRequest": {
        "type": "object",
        "properties": {
          "courseId": {
            "type": "string",
            "description": "The ID of the course to generate the lesson for"
          },
          "feedback": {
            "type": "string",
            "description": "Feedback from the user about the lesson"
          },
          "context": {
            "type": "string",
            "description": "Suggestion for chatbot - provide any useful context about the user and their understanding that you have learned since the previous lesson."
          }
        }
      },
      "LessonResponse": {
        "type": "object",
        "properties": {
          "lessonSubject": {
            "type": "string"
          },
          "lessonContent": {
            "type": "string"
          },
          "suggestionToChatBot": {
            "type": "string"
          },
          "chatBotpassThisObjectInForNextLesson": {
            "type": "object",
            "description": "The chatbot should pass this object in for the next lesson to get the next lesson. The chatbot should not modify this object."
          },
          "message": {
            "type": "string"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}