Skip to content

ToolUseResultData

Source code in docs_src/capo_qconnect/types/tool_use_result_data.py
class ToolUseResultData(TypedDict, closed=True):
    tool_use_id: "capo_qconnect.types.non_empty_string.NonEmptyString"
    """<p>The identifier of the tool use instance.</p>"""
    tool_name: "capo_qconnect.types.non_empty_string.NonEmptyString"
    """<p>The name of the tool that was used.</p>"""
    tool_result: "capo_qconnect.types.json_document.JSONDocument"
    """<p>The result of the tool usage.</p>"""
    input_schema: NotRequired["capo_qconnect.types.json_document.JSONDocument"]
    """<p>The input schema for the tool use result.</p>"""

input_schema instance-attribute

input_schema: NotRequired[JSONDocument]

The input schema for the tool use result.

tool_name instance-attribute

tool_name: NonEmptyString

The name of the tool that was used.

tool_result instance-attribute

tool_result: JSONDocument

The result of the tool usage.

tool_use_id instance-attribute

tool_use_id: NonEmptyString

The identifier of the tool use instance.