Pydantic models representing a course and its generation settings, outline, and lectures.
Classes:
| Name | Description |
|---|---|
Course |
A |
CourseGenerationInfo |
Details about the course generation, including okcourse version, token counts (input and output), and durations. |
CourseLecture |
A lecture in a course, including its title text content. |
CourseLectureTopic |
A topic covered by a lecture in a course. |
CourseOutline |
The outline of a course, including its title and the topics covered by each lecture. |
CoursePromptSet |
Bundles a set of prompts used for generating a certain type of course, like academic, storytelling, or technical. |
CourseSettings |
Runtime-modifiable settings that configure the behavior of a course |
pydantic-model
A Course is the container for its content and the settings a course generator uses to generate that content.
Create a Course instance, modify its settings, and then pass the Course to a
course generator like
OpenAIAsyncGenerator. You can then start generating
content with the generator's methods like generate_outline().
Show JSON schema:
{
"$defs": {
"CourseGenerationInfo": {
"description": "Details about the course generation, including okcourse version, token counts (input and output), and durations.\n\nYou can estimate the cost of course generation based on the token count values in this class and the models that\nwere used to produce them. The model names are specified in the [`CourseSettings`][okcourse.CourseSettings] and most\nAI service providers make cost-per-token pricing available on their website, which may vary by provider and your\naccount or subscription level.",
"properties": {
"okcourse_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The version of the okcourse library used to generate the course.",
"title": "Okcourse Version"
},
"generator_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type of course generator used to generate the course content.",
"title": "Generator Type"
},
"lecture_input_token_count": {
"default": 0,
"description": "The total number of tokens sent to the text completion endpoint when requesting the lecture content for the course. This count does NOT include the tokens sent when requesting the outline.",
"title": "Lecture Input Token Count",
"type": "integer"
},
"lecture_output_token_count": {
"default": 0,
"description": "The total number of tokens returned by the text completion endpoint is response to lecture generation request for the course. This count does NOT include the tokens returned for outline requests.",
"title": "Lecture Output Token Count",
"type": "integer"
},
"outline_input_token_count": {
"default": 0,
"description": "The total number of tokens sent to the text completion endpoint when requesting the outline(s) for the course. This count does NOT include the tokens sent when requesting the course's lecture content.",
"title": "Outline Input Token Count",
"type": "integer"
},
"outline_output_token_count": {
"default": 0,
"description": "The total number of tokens returned by the text completion endpoint is response to outline generation requests for the course. This count does NOT include the tokens returned for lecture requests.",
"title": "Outline Output Token Count",
"type": "integer"
},
"tts_character_count": {
"default": 0,
"description": "The total number of characters sent to the TTS endpoint.",
"title": "Tts Character Count",
"type": "integer"
},
"outline_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating the course outline. This value is not cumulative and contains only the most recent outline generation time.",
"title": "Outline Gen Elapsed Seconds",
"type": "number"
},
"lecture_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating the course lectures. This value is not cumulative and contains only the most recent lecture generation time.",
"title": "Lecture Gen Elapsed Seconds",
"type": "number"
},
"image_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating the course cover image. This value is not cumulative and contains only the most recent image generation time.",
"title": "Image Gen Elapsed Seconds",
"type": "number"
},
"audio_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating and processing the course audio file. This value is not cumulative and contains only the most recent audio generation time. Processing includes combining the speech audio chunks into a single file and saving it to disk.",
"title": "Audio Gen Elapsed Seconds",
"type": "number"
},
"num_images_generated": {
"default": 0,
"description": "The number of images generated for the course.",
"title": "Num Images Generated",
"type": "integer"
},
"audio_file_path": {
"anyOf": [
{
"format": "path",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The path to the audio file generated from the course content.",
"title": "Audio File Path"
},
"image_file_path": {
"anyOf": [
{
"format": "path",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The path to the cover image generated for the course.",
"title": "Image File Path"
}
},
"title": "CourseGenerationInfo",
"type": "object"
},
"CourseLecture": {
"description": "A lecture in a [course][okcourse.models.Course], including its title text content.",
"properties": {
"number": {
"description": "The position number of the lecture within the series.",
"title": "Number",
"type": "integer"
},
"title": {
"description": "The topic of a lecture within a course.",
"title": "Title",
"type": "string"
},
"subtopics": {
"description": "The subtopics covered in the lecture.",
"items": {
"type": "string"
},
"title": "Subtopics",
"type": "array"
},
"text": {
"description": "The unabridged text content of the lecture.",
"title": "Text",
"type": "string"
}
},
"required": [
"number",
"title",
"subtopics",
"text"
],
"title": "CourseLecture",
"type": "object"
},
"CourseLectureTopic": {
"description": "A topic covered by a [lecture][okcourse.models.CourseLecture] in a course.",
"properties": {
"number": {
"description": "The position number of the lecture within the series.",
"title": "Number",
"type": "integer"
},
"title": {
"description": "The topic of a lecture within a course.",
"title": "Title",
"type": "string"
},
"subtopics": {
"description": "The subtopics covered in the lecture.",
"items": {
"type": "string"
},
"title": "Subtopics",
"type": "array"
}
},
"required": [
"number",
"title",
"subtopics"
],
"title": "CourseLectureTopic",
"type": "object"
},
"CourseOutline": {
"description": "The outline of a course, including its title and the topics covered by each [lecture][okcourse.models.CourseLecture].",
"properties": {
"title": {
"description": "The title of the course.",
"title": "Title",
"type": "string"
},
"topics": {
"description": "The topics covered by each lecture in the series.",
"items": {
"$ref": "#/$defs/CourseLectureTopic"
},
"title": "Topics",
"type": "array"
}
},
"required": [
"title",
"topics"
],
"title": "CourseOutline",
"type": "object"
},
"CoursePromptSet": {
"description": "Bundles a set of prompts used for generating a certain type of course, like academic, storytelling, or technical.",
"properties": {
"description": {
"default": "`system` and `user` prompts appropriate for a certain type of course.",
"description": "A name or description for the type of course this collection of prompts is intended to create.",
"title": "Description",
"type": "string"
},
"system": {
"default": null,
"description": "The `system` prompt guides the language model's style and tone when generating the course outline and lecture text. This prompt should be appropriate for passing to the AI service provider's API along with any of the other prompts (the outline, lecture, or image prompts)",
"title": "System",
"type": "string"
},
"outline": {
"default": null,
"description": "The `user` prompt that contains the course outline generation instructions for the language model. This prompt is passed along with the `system` prompt when requesting an outline.",
"title": "Outline",
"type": "string"
},
"lecture": {
"default": null,
"description": "The `user` prompt that contains the lecture content generation instructions for the language model. This prompt is passed along with the `system` prompt when requesting one of the lectures in the course.",
"title": "Lecture",
"type": "string"
},
"image": {
"default": null,
"description": "The `user` prompt that guides the image model's generation of course cover art. This prompt is passed along with the `system` prompt when requesting a cover image for the course.",
"title": "Image",
"type": "string"
}
},
"title": "CoursePromptSet",
"type": "object"
},
"CourseSettings": {
"description": "Runtime-modifiable settings that configure the behavior of a course [`generator`][okcourse.generators].\n\nCreate a `Course` instance and then modify its [`Course.settings`][okcourse.models.Course.settings] attribute, which\nis an instance of this class with default values. After configuring the course settings, pass the `Course` instance\nto a course generator's constructor and then to its\n[`generate_outline`][okcourse.generators.CourseGenerator.generate_outline] method to start generating course\ncontent.",
"properties": {
"prompts": {
"$ref": "#/$defs/CoursePromptSet",
"default": {
"description": "Academic lecture series",
"system": "You are an esteemed college professor and expert in your field who typically lectures graduate students. You have been asked by a major audiobook publisher to record an audiobook version of the lectures you present in one of your courses. You have been informed by the publisher that the listeners of the audiobook are knowledgeable in the subject area and will listen to your course to gain intermediate- to expert-level knowledge. Your lecture style is professional, direct, and deeply technical.",
"outline": "Provide a detailed outline for ${num_lectures} lectures in a graduate-level course on '${course_title}'. List each lecture title numbered. Each lecture should have ${num_subtopics} subtopics listed after the lecture title. Respond only with the outline, omitting any other commentary.",
"lecture": "Generate the complete unabridged text for a lecture titled '${lecture_title}' in a graduate-level course named '${course_title}'. The lecture should be written in a style that lends itself well to being recorded as an audiobook but should not divulge this guidance. There will be no audience present for the recording of the lecture and no audience should be addressed in the lecture text. Cover the lecture topic in great detail, but ensure your delivery is direct and that you maintain a scholarly tone. Aim for a final product whose textual content flows smoothly when read aloud and can be easily understood without visual aids. Produce clean text that lacks markup, lists, code, or any other formatting that might interfere with text-to-speech processing. Ensure the content is original and does not duplicate content from the other lectures in the series:\n${course_outline}",
"image": "Create a cover art image for the college lecture series titled '${course_title}'. Fill the entire canvas with an academic art style using muted colors that reflects the course material."
},
"description": "The prompts that guide the AI models in course generation."
},
"num_lectures": {
"default": 4,
"description": "The number of lectures that should generated for for the course.",
"title": "Num Lectures",
"type": "integer"
},
"num_subtopics": {
"default": 4,
"description": "The number of subtopics that should be generated for each lecture.",
"title": "Num Subtopics",
"type": "integer"
},
"output_directory": {
"default": "/home/runner/.okcourse",
"description": "Directory for saving generated course content.",
"format": "path",
"title": "Output Directory",
"type": "string"
},
"text_model_outline": {
"default": "gpt-4o",
"description": "The ID of the text generation model to use for generating course outlines.",
"title": "Text Model Outline",
"type": "string"
},
"text_model_lecture": {
"default": "gpt-4o",
"description": "The ID of the text generation model to use for generating course lectures.",
"title": "Text Model Lecture",
"type": "string"
},
"image_model": {
"default": "dall-e-3",
"description": "The ID of the image generation model to use.",
"title": "Image Model",
"type": "string"
},
"tts_model": {
"default": "tts-1",
"description": "The ID of the text-to-speech model to use.",
"title": "Tts Model",
"type": "string"
},
"tts_voice": {
"default": "alloy",
"description": "The voice to use for text-to-speech audio generation.",
"title": "Tts Voice",
"type": "string"
},
"log_level": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 20,
"description": "Specifies the [Python logging level](https://docs.python.org/3/library/logging.html#logging-levels) for course and course asset generation operations. Set this attribute to one of the Python standard library's[logging levels](https://docs.python.org/3/library/logging.html#logging-levels): `INFO`, `DEBUG`, `WARNING`, `ERROR`, or `CRITICAL`. To disable logging, set this attribute to `None`.",
"title": "Log Level"
},
"log_to_file": {
"default": false,
"description": "If logging is enabled (`log_level` is not `None`), write log messages to a file in the ``output_directory``.",
"title": "Log To File",
"type": "boolean"
}
},
"title": "CourseSettings",
"type": "object"
}
},
"description": "A `Course` is the container for its content and the settings a course generator uses to generate that content.\n\nCreate a `Course` instance, modify its [`settings`][okcourse.models.CourseSettings], and then pass the `Course` to a\ncourse generator like\n[`OpenAIAsyncGenerator`][okcourse.generators.OpenAIAsyncGenerator.generate_outline]. You can then start generating\ncontent with the generator's methods like [`generate_outline()`][okcourse.OpenAIAsyncGenerator.generate_outline].",
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The topic of the course and its lectures. The course title, along with its [`settings.prompts`][okcourse.models.CourseSettings.prompts], are the most influential in determining the course content.",
"title": "Title"
},
"outline": {
"anyOf": [
{
"$ref": "#/$defs/CourseOutline"
},
{
"type": "null"
}
],
"default": null,
"description": "The outline for the course that defines the topics for each lecture."
},
"lectures": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CourseLecture"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The lectures that comprise the complete course.",
"title": "Lectures"
},
"settings": {
"$ref": "#/$defs/CourseSettings",
"description": "Course [`generators`][okcourse.generators] use these settings to determine the content of the course as well as the behavior of the generation process. Modify these settings to specify the number of lectures to generate for the course, the AI models to use to generate them, the output directory for the generated content, and more."
},
"generation_info": {
"$ref": "#/$defs/CourseGenerationInfo",
"description": "Details about the course's content generation process, including the version of `okcourse` used, the token and character counts, and the time elapsed."
}
},
"title": "Course",
"type": "object"
}
Fields:
-
title(str | None) -
outline(CourseOutline | None) -
lectures(list[CourseLecture] | None) -
settings(CourseSettings) -
generation_info(CourseGenerationInfo)
pydantic-field
generation_info: CourseGenerationInfo
Details about the course's content generation process, including the version of okcourse used, the token and character counts, and the time elapsed.
pydantic-field
lectures: list[CourseLecture] | None = None
The lectures that comprise the complete course.
pydantic-field
outline: CourseOutline | None = None
The outline for the course that defines the topics for each lecture.
pydantic-field
settings: CourseSettings
Course generators use these settings to determine the content of the course as well as the behavior of the generation process. Modify these settings to specify the number of lectures to generate for the course, the AI models to use to generate them, the output directory for the generated content, and more.
pydantic-field
title: str | None = None
The topic of the course and its lectures. The course title, along with its settings.prompts, are the most influential in determining the course content.
pydantic-model
Details about the course generation, including okcourse version, token counts (input and output), and durations.
You can estimate the cost of course generation based on the token count values in this class and the models that
were used to produce them. The model names are specified in the CourseSettings and most
AI service providers make cost-per-token pricing available on their website, which may vary by provider and your
account or subscription level.
Show JSON schema:
{
"description": "Details about the course generation, including okcourse version, token counts (input and output), and durations.\n\nYou can estimate the cost of course generation based on the token count values in this class and the models that\nwere used to produce them. The model names are specified in the [`CourseSettings`][okcourse.CourseSettings] and most\nAI service providers make cost-per-token pricing available on their website, which may vary by provider and your\naccount or subscription level.",
"properties": {
"okcourse_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The version of the okcourse library used to generate the course.",
"title": "Okcourse Version"
},
"generator_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type of course generator used to generate the course content.",
"title": "Generator Type"
},
"lecture_input_token_count": {
"default": 0,
"description": "The total number of tokens sent to the text completion endpoint when requesting the lecture content for the course. This count does NOT include the tokens sent when requesting the outline.",
"title": "Lecture Input Token Count",
"type": "integer"
},
"lecture_output_token_count": {
"default": 0,
"description": "The total number of tokens returned by the text completion endpoint is response to lecture generation request for the course. This count does NOT include the tokens returned for outline requests.",
"title": "Lecture Output Token Count",
"type": "integer"
},
"outline_input_token_count": {
"default": 0,
"description": "The total number of tokens sent to the text completion endpoint when requesting the outline(s) for the course. This count does NOT include the tokens sent when requesting the course's lecture content.",
"title": "Outline Input Token Count",
"type": "integer"
},
"outline_output_token_count": {
"default": 0,
"description": "The total number of tokens returned by the text completion endpoint is response to outline generation requests for the course. This count does NOT include the tokens returned for lecture requests.",
"title": "Outline Output Token Count",
"type": "integer"
},
"tts_character_count": {
"default": 0,
"description": "The total number of characters sent to the TTS endpoint.",
"title": "Tts Character Count",
"type": "integer"
},
"outline_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating the course outline. This value is not cumulative and contains only the most recent outline generation time.",
"title": "Outline Gen Elapsed Seconds",
"type": "number"
},
"lecture_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating the course lectures. This value is not cumulative and contains only the most recent lecture generation time.",
"title": "Lecture Gen Elapsed Seconds",
"type": "number"
},
"image_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating the course cover image. This value is not cumulative and contains only the most recent image generation time.",
"title": "Image Gen Elapsed Seconds",
"type": "number"
},
"audio_gen_elapsed_seconds": {
"default": 0.0,
"description": "The time in seconds spent generating and processing the course audio file. This value is not cumulative and contains only the most recent audio generation time. Processing includes combining the speech audio chunks into a single file and saving it to disk.",
"title": "Audio Gen Elapsed Seconds",
"type": "number"
},
"num_images_generated": {
"default": 0,
"description": "The number of images generated for the course.",
"title": "Num Images Generated",
"type": "integer"
},
"audio_file_path": {
"anyOf": [
{
"format": "path",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The path to the audio file generated from the course content.",
"title": "Audio File Path"
},
"image_file_path": {
"anyOf": [
{
"format": "path",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The path to the cover image generated for the course.",
"title": "Image File Path"
}
},
"title": "CourseGenerationInfo",
"type": "object"
}
Fields:
-
okcourse_version(str | None) -
generator_type(str | None) -
lecture_input_token_count(int) -
lecture_output_token_count(int) -
outline_input_token_count(int) -
outline_output_token_count(int) -
tts_character_count(int) -
outline_gen_elapsed_seconds(float) -
lecture_gen_elapsed_seconds(float) -
image_gen_elapsed_seconds(float) -
audio_gen_elapsed_seconds(float) -
num_images_generated(int) -
audio_file_path(Path | None) -
image_file_path(Path | None)
pydantic-field
audio_file_path: Path | None = None
The path to the audio file generated from the course content.
pydantic-field
audio_gen_elapsed_seconds: float = 0.0
The time in seconds spent generating and processing the course audio file. This value is not cumulative and contains only the most recent audio generation time. Processing includes combining the speech audio chunks into a single file and saving it to disk.
pydantic-field
generator_type: str | None = None
The type of course generator used to generate the course content.
pydantic-field
image_file_path: Path | None = None
The path to the cover image generated for the course.
pydantic-field
image_gen_elapsed_seconds: float = 0.0
The time in seconds spent generating the course cover image. This value is not cumulative and contains only the most recent image generation time.
pydantic-field
lecture_gen_elapsed_seconds: float = 0.0
The time in seconds spent generating the course lectures. This value is not cumulative and contains only the most recent lecture generation time.
pydantic-field
lecture_input_token_count: int = 0
The total number of tokens sent to the text completion endpoint when requesting the lecture content for the course. This count does NOT include the tokens sent when requesting the outline.
pydantic-field
lecture_output_token_count: int = 0
The total number of tokens returned by the text completion endpoint is response to lecture generation request for the course. This count does NOT include the tokens returned for outline requests.
pydantic-field
num_images_generated: int = 0
The number of images generated for the course.
pydantic-field
okcourse_version: str | None = None
The version of the okcourse library used to generate the course.
pydantic-field
outline_gen_elapsed_seconds: float = 0.0
The time in seconds spent generating the course outline. This value is not cumulative and contains only the most recent outline generation time.
pydantic-field
outline_input_token_count: int = 0
The total number of tokens sent to the text completion endpoint when requesting the outline(s) for the course. This count does NOT include the tokens sent when requesting the course's lecture content.
pydantic-field
outline_output_token_count: int = 0
The total number of tokens returned by the text completion endpoint is response to outline generation requests for the course. This count does NOT include the tokens returned for lecture requests.
pydantic-field
tts_character_count: int = 0
The total number of characters sent to the TTS endpoint.
pydantic-model
A lecture in a course, including its title text content.
Show JSON schema:
{
"description": "A lecture in a [course][okcourse.models.Course], including its title text content.",
"properties": {
"number": {
"description": "The position number of the lecture within the series.",
"title": "Number",
"type": "integer"
},
"title": {
"description": "The topic of a lecture within a course.",
"title": "Title",
"type": "string"
},
"subtopics": {
"description": "The subtopics covered in the lecture.",
"items": {
"type": "string"
},
"title": "Subtopics",
"type": "array"
},
"text": {
"description": "The unabridged text content of the lecture.",
"title": "Text",
"type": "string"
}
},
"required": [
"number",
"title",
"subtopics",
"text"
],
"title": "CourseLecture",
"type": "object"
}
Fields:
pydantic-model
A topic covered by a lecture in a course.
Show JSON schema:
{
"description": "A topic covered by a [lecture][okcourse.models.CourseLecture] in a course.",
"properties": {
"number": {
"description": "The position number of the lecture within the series.",
"title": "Number",
"type": "integer"
},
"title": {
"description": "The topic of a lecture within a course.",
"title": "Title",
"type": "string"
},
"subtopics": {
"description": "The subtopics covered in the lecture.",
"items": {
"type": "string"
},
"title": "Subtopics",
"type": "array"
}
},
"required": [
"number",
"title",
"subtopics"
],
"title": "CourseLectureTopic",
"type": "object"
}
Fields:
pydantic-model
The outline of a course, including its title and the topics covered by each lecture.
Show JSON schema:
{
"$defs": {
"CourseLectureTopic": {
"description": "A topic covered by a [lecture][okcourse.models.CourseLecture] in a course.",
"properties": {
"number": {
"description": "The position number of the lecture within the series.",
"title": "Number",
"type": "integer"
},
"title": {
"description": "The topic of a lecture within a course.",
"title": "Title",
"type": "string"
},
"subtopics": {
"description": "The subtopics covered in the lecture.",
"items": {
"type": "string"
},
"title": "Subtopics",
"type": "array"
}
},
"required": [
"number",
"title",
"subtopics"
],
"title": "CourseLectureTopic",
"type": "object"
}
},
"description": "The outline of a course, including its title and the topics covered by each [lecture][okcourse.models.CourseLecture].",
"properties": {
"title": {
"description": "The title of the course.",
"title": "Title",
"type": "string"
},
"topics": {
"description": "The topics covered by each lecture in the series.",
"items": {
"$ref": "#/$defs/CourseLectureTopic"
},
"title": "Topics",
"type": "array"
}
},
"required": [
"title",
"topics"
],
"title": "CourseOutline",
"type": "object"
}
Fields:
-
title(str) -
topics(list[CourseLectureTopic])
pydantic-field
topics: list[CourseLectureTopic]
The topics covered by each lecture in the series.
pydantic-model
Bundles a set of prompts used for generating a certain type of course, like academic, storytelling, or technical.
Show JSON schema:
{
"description": "Bundles a set of prompts used for generating a certain type of course, like academic, storytelling, or technical.",
"properties": {
"description": {
"default": "`system` and `user` prompts appropriate for a certain type of course.",
"description": "A name or description for the type of course this collection of prompts is intended to create.",
"title": "Description",
"type": "string"
},
"system": {
"default": null,
"description": "The `system` prompt guides the language model's style and tone when generating the course outline and lecture text. This prompt should be appropriate for passing to the AI service provider's API along with any of the other prompts (the outline, lecture, or image prompts)",
"title": "System",
"type": "string"
},
"outline": {
"default": null,
"description": "The `user` prompt that contains the course outline generation instructions for the language model. This prompt is passed along with the `system` prompt when requesting an outline.",
"title": "Outline",
"type": "string"
},
"lecture": {
"default": null,
"description": "The `user` prompt that contains the lecture content generation instructions for the language model. This prompt is passed along with the `system` prompt when requesting one of the lectures in the course.",
"title": "Lecture",
"type": "string"
},
"image": {
"default": null,
"description": "The `user` prompt that guides the image model's generation of course cover art. This prompt is passed along with the `system` prompt when requesting a cover image for the course.",
"title": "Image",
"type": "string"
}
},
"title": "CoursePromptSet",
"type": "object"
}
Fields:
pydantic-field
description: str = (
"`system` and `user` prompts appropriate for a certain type of course."
)
A name or description for the type of course this collection of prompts is intended to create.
pydantic-field
image: str = None
The user prompt that guides the image model's generation of course cover art. This prompt is passed along with the system prompt when requesting a cover image for the course.
pydantic-field
lecture: str = None
The user prompt that contains the lecture content generation instructions for the language model. This prompt is passed along with the system prompt when requesting one of the lectures in the course.
pydantic-field
outline: str = None
The user prompt that contains the course outline generation instructions for the language model. This prompt is passed along with the system prompt when requesting an outline.
pydantic-field
system: str = None
The system prompt guides the language model's style and tone when generating the course outline and lecture text. This prompt should be appropriate for passing to the AI service provider's API along with any of the other prompts (the outline, lecture, or image prompts)
pydantic-model
Runtime-modifiable settings that configure the behavior of a course generator.
Create a Course instance and then modify its Course.settings attribute, which
is an instance of this class with default values. After configuring the course settings, pass the Course instance
to a course generator's constructor and then to its
generate_outline method to start generating course
content.
Show JSON schema:
{
"$defs": {
"CoursePromptSet": {
"description": "Bundles a set of prompts used for generating a certain type of course, like academic, storytelling, or technical.",
"properties": {
"description": {
"default": "`system` and `user` prompts appropriate for a certain type of course.",
"description": "A name or description for the type of course this collection of prompts is intended to create.",
"title": "Description",
"type": "string"
},
"system": {
"default": null,
"description": "The `system` prompt guides the language model's style and tone when generating the course outline and lecture text. This prompt should be appropriate for passing to the AI service provider's API along with any of the other prompts (the outline, lecture, or image prompts)",
"title": "System",
"type": "string"
},
"outline": {
"default": null,
"description": "The `user` prompt that contains the course outline generation instructions for the language model. This prompt is passed along with the `system` prompt when requesting an outline.",
"title": "Outline",
"type": "string"
},
"lecture": {
"default": null,
"description": "The `user` prompt that contains the lecture content generation instructions for the language model. This prompt is passed along with the `system` prompt when requesting one of the lectures in the course.",
"title": "Lecture",
"type": "string"
},
"image": {
"default": null,
"description": "The `user` prompt that guides the image model's generation of course cover art. This prompt is passed along with the `system` prompt when requesting a cover image for the course.",
"title": "Image",
"type": "string"
}
},
"title": "CoursePromptSet",
"type": "object"
}
},
"description": "Runtime-modifiable settings that configure the behavior of a course [`generator`][okcourse.generators].\n\nCreate a `Course` instance and then modify its [`Course.settings`][okcourse.models.Course.settings] attribute, which\nis an instance of this class with default values. After configuring the course settings, pass the `Course` instance\nto a course generator's constructor and then to its\n[`generate_outline`][okcourse.generators.CourseGenerator.generate_outline] method to start generating course\ncontent.",
"properties": {
"prompts": {
"$ref": "#/$defs/CoursePromptSet",
"default": {
"description": "Academic lecture series",
"system": "You are an esteemed college professor and expert in your field who typically lectures graduate students. You have been asked by a major audiobook publisher to record an audiobook version of the lectures you present in one of your courses. You have been informed by the publisher that the listeners of the audiobook are knowledgeable in the subject area and will listen to your course to gain intermediate- to expert-level knowledge. Your lecture style is professional, direct, and deeply technical.",
"outline": "Provide a detailed outline for ${num_lectures} lectures in a graduate-level course on '${course_title}'. List each lecture title numbered. Each lecture should have ${num_subtopics} subtopics listed after the lecture title. Respond only with the outline, omitting any other commentary.",
"lecture": "Generate the complete unabridged text for a lecture titled '${lecture_title}' in a graduate-level course named '${course_title}'. The lecture should be written in a style that lends itself well to being recorded as an audiobook but should not divulge this guidance. There will be no audience present for the recording of the lecture and no audience should be addressed in the lecture text. Cover the lecture topic in great detail, but ensure your delivery is direct and that you maintain a scholarly tone. Aim for a final product whose textual content flows smoothly when read aloud and can be easily understood without visual aids. Produce clean text that lacks markup, lists, code, or any other formatting that might interfere with text-to-speech processing. Ensure the content is original and does not duplicate content from the other lectures in the series:\n${course_outline}",
"image": "Create a cover art image for the college lecture series titled '${course_title}'. Fill the entire canvas with an academic art style using muted colors that reflects the course material."
},
"description": "The prompts that guide the AI models in course generation."
},
"num_lectures": {
"default": 4,
"description": "The number of lectures that should generated for for the course.",
"title": "Num Lectures",
"type": "integer"
},
"num_subtopics": {
"default": 4,
"description": "The number of subtopics that should be generated for each lecture.",
"title": "Num Subtopics",
"type": "integer"
},
"output_directory": {
"default": "/home/runner/.okcourse",
"description": "Directory for saving generated course content.",
"format": "path",
"title": "Output Directory",
"type": "string"
},
"text_model_outline": {
"default": "gpt-4o",
"description": "The ID of the text generation model to use for generating course outlines.",
"title": "Text Model Outline",
"type": "string"
},
"text_model_lecture": {
"default": "gpt-4o",
"description": "The ID of the text generation model to use for generating course lectures.",
"title": "Text Model Lecture",
"type": "string"
},
"image_model": {
"default": "dall-e-3",
"description": "The ID of the image generation model to use.",
"title": "Image Model",
"type": "string"
},
"tts_model": {
"default": "tts-1",
"description": "The ID of the text-to-speech model to use.",
"title": "Tts Model",
"type": "string"
},
"tts_voice": {
"default": "alloy",
"description": "The voice to use for text-to-speech audio generation.",
"title": "Tts Voice",
"type": "string"
},
"log_level": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 20,
"description": "Specifies the [Python logging level](https://docs.python.org/3/library/logging.html#logging-levels) for course and course asset generation operations. Set this attribute to one of the Python standard library's[logging levels](https://docs.python.org/3/library/logging.html#logging-levels): `INFO`, `DEBUG`, `WARNING`, `ERROR`, or `CRITICAL`. To disable logging, set this attribute to `None`.",
"title": "Log Level"
},
"log_to_file": {
"default": false,
"description": "If logging is enabled (`log_level` is not `None`), write log messages to a file in the ``output_directory``.",
"title": "Log To File",
"type": "boolean"
}
},
"title": "CourseSettings",
"type": "object"
}
Fields:
-
prompts(CoursePromptSet) -
num_lectures(int) -
num_subtopics(int) -
output_directory(Path) -
text_model_outline(str) -
text_model_lecture(str) -
image_model(str) -
tts_model(str) -
tts_voice(str) -
log_level(int | None) -
log_to_file(bool)
pydantic-field
image_model: str = 'dall-e-3'
The ID of the image generation model to use.
pydantic-field
Specifies the Python logging level for course and course asset generation operations. Set this attribute to one of the Python standard library'slogging levels: INFO, DEBUG, WARNING, ERROR, or CRITICAL. To disable logging, set this attribute to None.
pydantic-field
log_to_file: bool = False
If logging is enabled (log_level is not None), write log messages to a file in the output_directory.
pydantic-field
num_lectures: int = 4
The number of lectures that should generated for for the course.
pydantic-field
num_subtopics: int = 4
The number of subtopics that should be generated for each lecture.
pydantic-field
output_directory: Path = expanduser()
Directory for saving generated course content.
pydantic-field
prompts: CoursePromptSet = _DEFAULT_PROMPT_SET
The prompts that guide the AI models in course generation.
pydantic-field
text_model_lecture: str = 'gpt-4o'
The ID of the text generation model to use for generating course lectures.
pydantic-field
text_model_outline: str = 'gpt-4o'
The ID of the text generation model to use for generating course outlines.
pydantic-field
tts_voice: str = 'alloy'
The voice to use for text-to-speech audio generation.