Class Story

Story object which contains a prompt and story and can generate a title and an image

Constructors

constructor

Properties

chat content creationPrompt logger openai prompt temperature

Methods

generateImage generateTitle generateStory

Constructors

constructor

  • new Story(openai, storyParams, chatModel?, logger?): Story

  • Parameters

    • openai: OpenAI
    • storyParams: StoryParams
    • chatModel: string = DEFAULT_MODEL
    • logger: ILogger = console

    Returns Story

Properties

Private Readonly chat

chat: ChatAssistant

Readonly content

content: string

Private Readonly creationPrompt

creationPrompt: ChatCompletionMessageParam[]

Private Readonly logger

logger: ILogger = console

Private Readonly openai

openai: OpenAI

Readonly prompt

prompt: string

Readonly temperature

temperature: number

Methods

generateImage

  • generateImage(size?, model?): Promise<string>

  • Parameters

    • size: ImageSize = "1024x1024"
    • model: Model = "dall-e-3"

    Returns Promise<string>

generateTitle

  • generateTitle(): Promise<string>

  • Returns Promise<string>

Static generateStory

  • generateStory(prompt, openai, chatModel?, logger?): Promise<Story>

  • Utility method which allows a Story object to be generated from a prompt with a story

    Parameters

    • prompt: string
    • openai: OpenAI
    • chatModel: string = DEFAULT_MODEL
    • logger: ILogger = console

    Returns Promise<Story>

Settings

Member Visibility

Theme

On This Page

constructorchatcontentcreationPromptloggeropenaiprompttemperaturegenerateImagegenerateTitlegenerateStory