Interface ExecutablePrompt<I, O, CustomOptions>

A prompt that can be executed as a function.

interface ExecutablePrompt<
    I = undefined,
    O extends z.ZodTypeAny = z.ZodTypeAny,
    CustomOptions extends z.ZodTypeAny = z.ZodTypeAny,
> {
    asTool(): Promise<ToolAction<z.ZodTypeAny, z.ZodTypeAny>>;
    render(
        input?: I,
        opts?: PromptGenerateOptions<O, CustomOptions>,
    ): Promise<GenerateOptions<O, CustomOptions>>;
    stream(
        input?: I,
        opts?: PromptGenerateOptions<O, CustomOptions>,
    ): GenerateStreamResponse<z.TypeOf<O>>;
    (
        input?: I,
        opts?: PromptGenerateOptions<O, CustomOptions>,
    ): Promise<GenerateResponse<z.TypeOf<O>>>;
}

Type Parameters

  • ExecutablePrompt(
        input?: I,
        opts?: PromptGenerateOptions<O, CustomOptions>,
    ): Promise<GenerateResponse<z.TypeOf<O>>>

  • Generates a response by rendering the prompt template with given user input and then calling the model.

    Parameters

    • Optionalinput: I

      Prompt inputs.

    • Optionalopts: PromptGenerateOptions<O, CustomOptions>

    Returns Promise<GenerateResponse<z.TypeOf<O>>>

    the model response as a promise of GenerateStreamResponse.

Methods

asTool render stream

Methods

asTool

render

stream

  • stream(
        input?: I,
        opts?: PromptGenerateOptions<O, CustomOptions>,
    ): GenerateStreamResponse<z.TypeOf<O>>

  • Generates a response by rendering the prompt template with given user input and then calling the model.

    Parameters

    • Optionalinput: I

      Prompt inputs.

    • Optionalopts: PromptGenerateOptions<O, CustomOptions>

    Returns GenerateStreamResponse<z.TypeOf<O>>

    the model response as a promise of GenerateStreamResponse.

Settings

Member Visibility

On This Page

Methods