prompts

Class AsyncContextMessageTemplate

Protocol for an async context-aware prompt function that returns UserContent or Sequence[Message].

An async MessageTemplate with a first parameter named 'ctx' of type Context[DepsT]. Can be converted by the llm.prompt decorator into an AsyncContextPrompt, or by the llm.call decorator into an AsyncContextCall.

Bases:

Protocol[P, DepsT]

Class AsyncContextPrompt

An async context-aware prompt that can be called with a model to generate a response.

Created by decorating an async ContextMessageTemplate with llm.prompt. The decorated async function (with first parameter 'ctx' of type Context[DepsT]) becomes callable with a Model to generate LLM responses asynchronously with context dependencies.

An AsyncContextPrompt is essentially: async ContextMessageTemplate + tools + format. It can be invoked with a model: await prompt(model, ctx, *args, **kwargs).

Bases:

Generic[P, DepsT, FormattableT]

Function call

Generates a response using the provided model asynchronously.

Function stream

Generates a streaming response using the provided model asynchronously.

Class AsyncMessageTemplate

Protocol for an async prompt function that returns UserContent or Sequence[Message].

An async MessageTemplate that can be converted by the llm.prompt decorator into an AsyncPrompt, or by the llm.call decorator into an AsyncCall.

Bases:

Protocol[P]

Class AsyncPrompt

An async prompt that can be called with a model to generate a response.

Created by decorating an async MessageTemplate with llm.prompt. The decorated async function becomes callable with a Model to generate LLM responses asynchronously.

An AsyncPrompt is essentially: async MessageTemplate + tools + format. It can be invoked with a model: await prompt(model, *args, **kwargs).

Bases:

Generic[P, FormattableT]

Function call

Generates a response using the provided model asynchronously.

Function stream

Generates a streaming response using the provided model asynchronously.

Class ContextMessageTemplate

Protocol for a context-aware prompt function that returns UserContent or Sequence[Message].

A MessageTemplate with a first parameter named 'ctx' of type Context[DepsT]. Can be converted by the llm.prompt decorator into a ContextPrompt, or by the llm.call decorator into a ContextCall.

Bases:

Protocol[P, DepsT]

Class ContextPrompt

A context-aware prompt that can be called with a model to generate a response.

Created by decorating a ContextMessageTemplate with llm.prompt. The decorated function (with first parameter 'ctx' of type Context[DepsT]) becomes callable with a Model to generate LLM responses with context dependencies.

A ContextPrompt is essentially: ContextMessageTemplate + tools + format. It can be invoked with a model: prompt(model, ctx, *args, **kwargs).

Bases:

Generic[P, DepsT, FormattableT]

Function call

Generates a response using the provided model.

Function stream

Generates a streaming response using the provided model.

Class MessageTemplate

Protocol for a prompt function that returns UserContent or Sequence[Message].

A MessageTemplate is a raw function that returns prompt content. It can be converted by the llm.prompt decorator into a Prompt (callable with a Model), or by the llm.call decorator into a Call (Prompt + Model).

Bases:

Protocol[P]

Class Prompt

A prompt that can be called with a model to generate a response.

Created by decorating a MessageTemplate with llm.prompt. The decorated function becomes callable with a Model to generate LLM responses.

A Prompt is essentially: MessageTemplate + tools + format. It can be invoked with a model: prompt(model, *args, **kwargs).

Bases:

Generic[P, FormattableT]

Function call

Generates a response using the provided model.

Function stream

Generates a streaming response using the provided model.

Class PromptDecorator

Decorator for converting a MessageTemplate into a Prompt.

Takes a raw prompt function that returns message content and wraps it with tools and format support, creating a Prompt that can be called with a model.

The decorator automatically detects whether the function is async or context-aware and creates the appropriate Prompt variant (Prompt, AsyncPrompt, ContextPrompt, or AsyncContextPrompt).

Bases:

Generic[ToolT, FormattableT]

Function prompt

Decorates a MessageTemplate to create a Prompt callable with a model.

This decorator transforms a raw prompt function (that returns message content) into a Prompt object that can be invoked with a model to generate LLM responses.

The decorator automatically detects the function type:

• If the first parameter is named 'ctx' with type llm.Context[T], creates a ContextPrompt
• If the function is async, creates an AsyncPrompt or AsyncContextPrompt
• Otherwise, creates a regular Prompt