module documentation

A temporal activity that invokes a LLM model.

Implements mapping of OpenAI datastructures to Pydantic friendly types.

Class ActivityModelInput Input for the invoke_model_activity activity.
Class AgentOutputSchemaInput Data conversion friendly representation of AgentOutputSchema.
Class FunctionToolInput Data conversion friendly representation of a FunctionTool. Contains only the fields which are needed by the model execution to determine what tool to call, not the actual tool invocation, which remains in the workflow context.
Class HandoffInput Data conversion friendly representation of a Handoff. Contains only the fields which are needed by the model execution to determine what to handoff to, not the actual handoff invocation, which remains in the workflow context.
Class HostedMCPToolInput Data conversion friendly representation of a HostedMCPTool. Contains only the fields which are needed by the model execution to determine what tool to call, not the actual tool invocation, which remains in the workflow context.
Class ModelActivity Class wrapper for model invocation activities to allow model customization. By default, we use an OpenAIProvider with retries disabled. Disabling retries in your model of choice is recommended to allow activity retries to define the retry model.
Class ModelTracingInput Conversion friendly representation of ModelTracing.
Type Alias ToolInput Undocumented
ToolInput = (source)

Undocumented

Value
FunctionToolInput | FileSearchTool | WebSearchTool | ImageGenerationTool | CodeInterpreterTool
 | HostedMCPToolInput