import { Agent, AgentOutputType } from './agent'; import { RunContext } from './runContext'; import { AgentInputItem, JsonObjectSchema, ResolveParsedToolParameters, TextOutput, UnknownContext } from './types'; import { RunItem } from './items'; import { ToolInputParameters } from './tool'; /** * Data passed to the handoff function. */ export type HandoffInputData = { /** * The input history before `Runner.run()` was called. */ inputHistory: string | AgentInputItem[]; /** * The items generated before the agent turn where the handoff was invoked. */ preHandoffItems: RunItem[]; /** * The new items generated during the current agent turn, including the item that triggered the * handoff and the tool output message representing the response from the handoff output. */ newItems: RunItem[]; /** * The context of the handoff. * Note that, since this property was added later on, it's optional to pass from users. */ runContext?: RunContext; }; export type HandoffInputFilter = (input: HandoffInputData) => HandoffInputData; /** * Generates the message that will be given as tool output to the model that requested the handoff. * * @param agent The agent to transfer to * @returns The message that will be given as tool output to the model that requested the handoff */ export declare function getTransferMessage(agent: Agent): string; /** * A handoff is when an agent delegates a task to another agent. * For example, in a customer support scenario you might have a "triage agent" that determines which * agent should handle the user's request, and sub-agents that specialize in different areas like * billing, account management, etc. * * @template TContext The context of the handoff * @template TOutput The output type of the handoff */ type HandoffEnabledPredicate = (args: { runContext: RunContext; agent: Agent; }) => boolean | Promise; type HandoffEnabledOption = boolean | HandoffEnabledPredicate; export type HandoffEnabledFunction = (args: { runContext: RunContext; agent: Agent; }) => Promise; export declare class Handoff { /** * The name of the tool that represents the handoff. */ toolName: string; /** * The description of the tool that represents the handoff. */ toolDescription: string; /** * The JSON schema for the handoff input. Can be empty if the handoff does not take an input */ inputJsonSchema: JsonObjectSchema; /** * Whether the input JSON schema is in strict mode. We **strongly** recommend setting this to * true, as it increases the likelihood of correct JSON input. */ strictJsonSchema: boolean; /** * The function that invokes the handoff. The parameters passed are: * 1. The handoff run context * 2. The arguments from the LLM, as a JSON string. Empty string if inputJsonSchema is empty. * * Must return an agent */ onInvokeHandoff: (context: RunContext, args: string) => Promise> | Agent; /** * The name of the agent that is being handed off to. */ agentName: string; /** * A function that filters the inputs that are passed to the next agent. By default, the new agent * sees the entire conversation history. In some cases, you may want to filter inputs e.g. to * remove older inputs, or remove tools from existing inputs. * * The function will receive the entire conversation hisstory so far, including the input item * that triggered the handoff and a tool call output item representing the handoff tool's output. * * You are free to modify the input history or new items as you see fit. The next agent that runs * will receive `handoffInputData.allItems */ inputFilter?: HandoffInputFilter; /** * The agent that is being handed off to. */ agent: Agent; /** * Returns a function tool definition that can be used to invoke the handoff. */ getHandoffAsFunctionTool(): { type: "function"; name: string; description: string; parameters: JsonObjectSchema; strict: boolean; }; isEnabled: HandoffEnabledFunction; constructor(agent: Agent, onInvokeHandoff: (context: RunContext, args: string) => Promise> | Agent); } /** * A function that runs when the handoff is invoked. */ export type OnHandoffCallback = (context: RunContext, input?: ResolveParsedToolParameters) => Promise | void; /** * Configuration for a handoff. */ export type HandoffConfig = { /** * Optional override for the name of the tool that represents the handoff. */ toolNameOverride?: string; /** * Optional override for the description of the tool that represents the handoff. */ toolDescriptionOverride?: string; /** * A function that runs when the handoff is invoked */ onHandoff?: OnHandoffCallback; /** * The type of the input to the handoff. If provided as a Zod schema, the input will be validated * against this type. Only relevant if you pass a function that takes an input */ inputType?: TInputType; /** * A function that filters the inputs that are passed to the next agent. */ inputFilter?: HandoffInputFilter; /** * Determines whether the handoff should be available to the model for the current run. */ isEnabled?: HandoffEnabledOption; }; /** * Creates a handoff from an agent. Handoffs are automatically created when you pass an agent * into the `handoffs` option of the `Agent` constructor. Alternatively, you can use this function * to create a handoff manually, giving you more control over configuration. * * @template TContext The context of the handoff * @template TOutput The output type of the handoff * @template TInputType The input type of the handoff */ export declare function handoff(agent: Agent, config?: HandoffConfig): Handoff; /** * Returns a handoff for the given agent. If the agent is already wrapped into a handoff, * it will be returned as is. Otherwise, a new handoff instance will be created. * * @template TContext The context of the handoff * @template TOutput The output type of the handoff */ export declare function getHandoff(agent: Agent | Handoff): Handoff; export {};