Type alias ToolMessage

ToolMessage: BaseMessage & {
    artifact?: any;
    status?: "error" | "success";
    tool_call_id: string;
    type: "tool";
}

Type declaration

  • Optional artifact?: any

    Artifact of the Tool execution which is not meant to be sent to the model.

    Should only be specified if it is different from the message content, e.g. if only a subset of the full tool output is being passed as message content but the full output is needed in other parts of the code.

  • Optional status?: "error" | "success"
  • tool_call_id: string
  • type: "tool"