Interface IGenerativeAIPromptJob

Represents bounded prompt job ready to be run or streamed.

interface IGenerativeAIPromptJob {
    id: string;
    options: IGenerativeAIPromptOptions;
    prompt: string;
    run: (() => Promise<IGenerativeAIPromptResult>);
    stream: (() => AsyncGenerator<IGenerativeAIPromptResult, any, unknown>);
}

Hierarchy (view full)

IGenerativeAIJob
- IGenerativeAIPromptJob

Index

Properties

id options prompt run stream

Properties

id

id: string

The job ID.

options

options: IGenerativeAIPromptOptions

The options for the prompt.

prompt

prompt: string

The prompt to be processed

run

run: (() => Promise<IGenerativeAIPromptResult>)

Run the prompt job.

Type declaration

- (): Promise<IGenerativeAIPromptResult>
- Returns Promise<IGenerativeAIPromptResult>
  A promise that resolves with the result

stream

stream: (() => AsyncGenerator<IGenerativeAIPromptResult, any, unknown>)

Stream the prompt job.

Type declaration

- (): AsyncGenerator<IGenerativeAIPromptResult, any, unknown>
- Returns AsyncGenerator<IGenerativeAIPromptResult, any, unknown>
  An async generator that yields the result