コンテンツにスキップ

RunHandoffOutputItem

このコンテンツはまだ日本語訳がありません。

Extends

Section titled “Extends”
  • RunItemBase

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
new RunHandoffOutputItem(
   rawItem,
   sourceAgent,
   targetAgent): RunHandoffOutputItem;

Parameters

Section titled “Parameters”
Parameter Type Description

rawItem

{ callId: string; id?: string; name: string; output: | { providerData?: Record<string, any>; text: string; type: "text"; } | { data: string; mediaType: string; providerData?: Record<string, any>; type: "image"; }; providerData?: Record<string, any>; status: "in_progress" | "completed" | "incomplete"; type: "function_call_result"; }

‐

rawItem.callId

string

The ID of the tool call. Required to match up the respective tool call result.

rawItem.id?

string

An ID to identify the item. This is optional by default. If a model provider absolutely requires this field, it will be validated on the model level.

rawItem.name

string

The name of the tool that was called

rawItem.output

| { providerData?: Record<string, any>; text: string; type: "text"; } | { data: string; mediaType: string; providerData?: Record<string, any>; type: "image"; }

The output of the tool call.

rawItem.providerData?

Record<string, any>

Additional optional provider specific data. Used for custom functionality or model provider specific fields.

rawItem.status

"in_progress" | "completed" | "incomplete"

The status of the tool call.

rawItem.type

"function_call_result"

‐

sourceAgent

Agent<any, any>

‐

targetAgent

Agent<any, any>

‐

Returns

Section titled “Returns”

RunHandoffOutputItem

Overrides

Section titled “Overrides”
RunItemBase.constructor

Properties

Section titled “Properties”

rawItem

Section titled “rawItem”
rawItem: object;
Name Type Description

callId

string

The ID of the tool call. Required to match up the respective tool call result.

id?

string

An ID to identify the item. This is optional by default. If a model provider absolutely requires this field, it will be validated on the model level.

name

string

The name of the tool that was called

output

| { providerData?: Record<string, any>; text: string; type: "text"; } | { data: string; mediaType: string; providerData?: Record<string, any>; type: "image"; }

The output of the tool call.

providerData?

Record<string, any>

Additional optional provider specific data. Used for custom functionality or model provider specific fields.

status

"in_progress" | "completed" | "incomplete"

The status of the tool call.

type

"function_call_result"

‐

Inherited from

Section titled “Inherited from”
RunItemBase.rawItem

sourceAgent

Section titled “sourceAgent”
sourceAgent: Agent<any, any>;

targetAgent

Section titled “targetAgent”
targetAgent: Agent<any, any>;

type

Section titled “type”
readonly type: "handoff_output_item";

Overrides

Section titled “Overrides”
RunItemBase.type

Methods

Section titled “Methods”

toJSON()

Section titled “toJSON()”
toJSON(): object;

Returns

Section titled “Returns”

object

rawItem
Section titled “rawItem”
rawItem:
  | undefined
  | {
  content: (
     | {
     providerData?: Record<string, any>;
     refusal: string;
     type: "refusal";
   }
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "output_text";
   }
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "input_text";
   }
     | {
     audio:   | string
        | {
        id: string;
      };
     format?: null | string;
     providerData?: Record<string, any>;
     transcript?: null | string;
     type: "audio";
   }
     | {
     image: string;
     providerData?: Record<string, any>;
     type: "image";
  })[];
  id?: string;
  providerData?: Record<string, any>;
  role: "assistant";
  status: "in_progress" | "completed" | "incomplete";
  type?: "message";
}
  | {
  content:   | string
     | (
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "input_text";
   }
     | {
     image:   | string
        | {
        id: string;
      };
     providerData?: Record<string, any>;
     type: "input_image";
   }
     | {
     file:   | string
        | {
        id: string;
      }
        | {
        url: string;
      };
     providerData?: Record<string, any>;
     type: "input_file";
   }
     | {
     audio:   | string
        | {
        id: string;
      };
     format?: null | string;
     providerData?: Record<string, any>;
     transcript?: null | string;
     type: "audio";
   })[];
  id?: string;
  providerData?: Record<string, any>;
  role: "user";
  type?: "message";
}
  | {
  content: string;
  id?: string;
  providerData?: Record<string, any>;
  role: "system";
  type?: "message";
}
  | {
  arguments?: string;
  id?: string;
  name: string;
  output?: string;
  providerData?: Record<string, any>;
  status?: string;
  type: "hosted_tool_call";
}
  | {
  arguments: string;
  callId: string;
  id?: string;
  name: string;
  providerData?: Record<string, any>;
  status?: "in_progress" | "completed" | "incomplete";
  type: "function_call";
}
  | {
  callId: string;
  id?: string;
  name: string;
  output:   | {
     providerData?: Record<string, any>;
     text: string;
     type: "text";
   }
     | {
     data: string;
     mediaType: string;
     providerData?: Record<string, any>;
     type: "image";
   };
  providerData?: Record<string, any>;
  status: "in_progress" | "completed" | "incomplete";
  type: "function_call_result";
}
  | {
  action:   | {
     type: "screenshot";
   }
     | {
     button: "left" | "right" | "wheel" | "back" | "forward";
     type: "click";
     x: number;
     y: number;
   }
     | {
     type: "double_click";
     x: number;
     y: number;
   }
     | {
     scroll_x: number;
     scroll_y: number;
     type: "scroll";
     x: number;
     y: number;
   }
     | {
     text: string;
     type: "type";
   }
     | {
     type: "wait";
   }
     | {
     type: "move";
     x: number;
     y: number;
   }
     | {
     keys: string[];
     type: "keypress";
   }
     | {
     path: object[];
     type: "drag";
   };
  callId: string;
  id?: string;
  providerData?: Record<string, any>;
  status: "in_progress" | "completed" | "incomplete";
  type: "computer_call";
}
  | {
  callId: string;
  id?: string;
  output: {
     data: string;
     providerData?: Record<string, any>;
     type: "computer_screenshot";
  };
  providerData?: Record<string, any>;
  type: "computer_call_result";
}
  | {
  content: object[];
  id?: string;
  providerData?: Record<string, any>;
  type: "reasoning";
}
  | {
  id?: string;
  providerData?: Record<string, any>;
  type: "unknown";
};
Type declaration
Section titled “Type declaration”

undefined

{
  content: (
     | {
     providerData?: Record<string, any>;
     refusal: string;
     type: "refusal";
   }
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "output_text";
   }
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "input_text";
   }
     | {
     audio:   | string
        | {
        id: string;
      };
     format?: null | string;
     providerData?: Record<string, any>;
     transcript?: null | string;
     type: "audio";
   }
     | {
     image: string;
     providerData?: Record<string, any>;
     type: "image";
  })[];
  id?: string;
  providerData?: Record<string, any>;
  role: "assistant";
  status: "in_progress" | "completed" | "incomplete";
  type?: "message";
}
{
  content:   | string
     | (
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "input_text";
   }
     | {
     image:   | string
        | {
        id: string;
      };
     providerData?: Record<string, any>;
     type: "input_image";
   }
     | {
     file:   | string
        | {
        id: string;
      }
        | {
        url: string;
      };
     providerData?: Record<string, any>;
     type: "input_file";
   }
     | {
     audio:   | string
        | {
        id: string;
      };
     format?: null | string;
     providerData?: Record<string, any>;
     transcript?: null | string;
     type: "audio";
   })[];
  id?: string;
  providerData?: Record<string, any>;
  role: "user";
  type?: "message";
}
{
  content: string;
  id?: string;
  providerData?: Record<string, any>;
  role: "system";
  type?: "message";
}
{
  arguments?: string;
  id?: string;
  name: string;
  output?: string;
  providerData?: Record<string, any>;
  status?: string;
  type: "hosted_tool_call";
}
{
  arguments: string;
  callId: string;
  id?: string;
  name: string;
  providerData?: Record<string, any>;
  status?: "in_progress" | "completed" | "incomplete";
  type: "function_call";
}
{
  callId: string;
  id?: string;
  name: string;
  output:   | {
     providerData?: Record<string, any>;
     text: string;
     type: "text";
   }
     | {
     data: string;
     mediaType: string;
     providerData?: Record<string, any>;
     type: "image";
   };
  providerData?: Record<string, any>;
  status: "in_progress" | "completed" | "incomplete";
  type: "function_call_result";
}
{
  action:   | {
     type: "screenshot";
   }
     | {
     button: "left" | "right" | "wheel" | "back" | "forward";
     type: "click";
     x: number;
     y: number;
   }
     | {
     type: "double_click";
     x: number;
     y: number;
   }
     | {
     scroll_x: number;
     scroll_y: number;
     type: "scroll";
     x: number;
     y: number;
   }
     | {
     text: string;
     type: "type";
   }
     | {
     type: "wait";
   }
     | {
     type: "move";
     x: number;
     y: number;
   }
     | {
     keys: string[];
     type: "keypress";
   }
     | {
     path: object[];
     type: "drag";
   };
  callId: string;
  id?: string;
  providerData?: Record<string, any>;
  status: "in_progress" | "completed" | "incomplete";
  type: "computer_call";
}
{
  callId: string;
  id?: string;
  output: {
     data: string;
     providerData?: Record<string, any>;
     type: "computer_screenshot";
  };
  providerData?: Record<string, any>;
  type: "computer_call_result";
}
{
  content: object[];
  id?: string;
  providerData?: Record<string, any>;
  type: "reasoning";
}
{
  id?: string;
  providerData?: Record<string, any>;
  type: "unknown";
}
sourceAgent
Section titled “sourceAgent”
sourceAgent: object;
sourceAgent.name
Section titled “sourceAgent.name”
name: string;
targetAgent
Section titled “targetAgent”
targetAgent: object;
targetAgent.name
Section titled “targetAgent.name”
name: string;
type
Section titled “type”
type: string;

Overrides

Section titled “Overrides”
RunItemBase.toJSON