Interface PromptConfig<I, O, CustomOptions>

Configuration for a prompt action.

interface PromptConfig {
 config?: TypeOf<CustomOptions>;
 context?: ActionContext;
 description?: string;
 docs?:
 | {
 content: (
 | { media?: undefined; text: string }
 | { media: { contentType?: string; url: string }; text?: undefined }
 )[];
 metadata?: Record<string, any>;
 }[]
 | DocsResolver<TypeOf, any>;
 input?: { jsonSchema?: JSONSchema7; schema?: I };
 maxTurns?: number;
 messages?:
 | string
 | {
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 }[]
 | MessagesResolver<TypeOf, any>;
 metadata?: Record<string, any>;
 model?: ModelArgument<CustomOptions>;
 name: string;
 output?: OutputOptions<O>;
 prompt?:
 | string
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[]
 | PartsResolver<TypeOf, any>;
 returnToolRequests?: boolean;
 system?:
 | string
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[]
 | PartsResolver<TypeOf, any>;
 toolChoice?: ToolChoice;
 tools?: ToolArgument<ZodTypeAny, ZodTypeAny>[];
 use?: ModelMiddleware[];
 variant?: string;
}

Type Parameters

I extends ZodTypeAny = ZodTypeAny
O extends ZodTypeAny = ZodTypeAny
CustomOptions extends ZodTypeAny = ZodTypeAny

Index

Properties

config? context? description? docs? input? maxTurns? messages? metadata? model? name output? prompt? returnToolRequests? system? toolChoice? tools? use? variant?

Properties

`Optional`config

config?: TypeOf<CustomOptions>

`Optional`context

context?: ActionContext

`Optional`description

description?: string

`Optional`docs

docs?:
 | {
 content: (
 | { media?: undefined; text: string }
 | { media: { contentType?: string; url: string }; text?: undefined }
 )[];
 metadata?: Record<string, any>;
 }[]
 | DocsResolver<TypeOf, any>

`Optional`input

input?: { jsonSchema?: JSONSchema7; schema?: I }

`Optional`maxTurns

maxTurns?: number

`Optional`messages

messages?:
 | string
 | {
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 }[]
 | MessagesResolver<TypeOf, any>

`Optional`metadata

metadata?: Record<string, any>

`Optional`model

model?: ModelArgument<CustomOptions>

name

name: string

`Optional`output

output?: OutputOptions<O>

`Optional`prompt

prompt?:
 | string
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[]
 | PartsResolver<TypeOf, any>

`Optional`returnToolRequests

returnToolRequests?: boolean

`Optional`system

system?:
 | string
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[]
 | PartsResolver<TypeOf, any>

`Optional`toolChoice

toolChoice?: ToolChoice

`Optional`tools

tools?: ToolArgument<ZodTypeAny, ZodTypeAny>[]

`Optional`use

use?: ModelMiddleware[]

`Optional`variant

variant?: string

Interface PromptConfig<I, O, CustomOptions>

Type Parameters

Index

Properties

Properties

`Optional`config

`Optional`context

`Optional`description

`Optional`docs

`Optional`input

`Optional`maxTurns

`Optional`messages

`Optional`metadata

`Optional`model

name

`Optional`output

`Optional`prompt

`Optional`returnToolRequests

`Optional`system

`Optional`toolChoice

`Optional`tools

`Optional`use

`Optional`variant

Settings

On This Page

Interface PromptConfig<I, O, CustomOptions>

Type Parameters

Index

Properties

Properties

Optionalconfig

Optionalcontext

Optionaldescription

Optionaldocs

Optionalinput

OptionalmaxTurns

Optionalmessages

Optionalmetadata

Optionalmodel

name

Optionaloutput

Optionalprompt

OptionalreturnToolRequests

Optionalsystem

OptionaltoolChoice

Optionaltools

Optionaluse

Optionalvariant

Settings

On This Page

`Optional`config

`Optional`context

`Optional`description

`Optional`docs

`Optional`input

`Optional`maxTurns

`Optional`messages

`Optional`metadata

`Optional`model

`Optional`output

`Optional`prompt

`Optional`returnToolRequests

`Optional`system

`Optional`toolChoice

`Optional`tools

`Optional`use

`Optional`variant