Genkit JS API reference
    Preparing search index...

    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,
    > {
        ref: { metadata?: Record<string, any>; name: string };
        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

    Index

    Properties

    ref

    Methods

    asTool render stream

    Properties

    ref: { metadata?: Record<string, any>; name: string }

    Prompt reference.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods