Skip to content

ToolConfiguration

Source code in docs_src/capo_qconnect/types/tool_configuration.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class ToolConfiguration(TypedDict, closed=True):
    tool_name: "capo_qconnect.types.non_empty_string.NonEmptyString"
    """<p>The name of the tool.</p>"""
    tool_type: "capo_qconnect.types.tool_type.ToolType"
    """<p>The type of the tool.</p>"""
    title: NotRequired[
        "capo_qconnect.types.non_empty_sensitive_string.NonEmptySensitiveString"
    ]
    """<p>The title of the tool configuration.</p>"""
    tool_id: NotRequired["capo_qconnect.types.non_empty_string.NonEmptyString"]
    """<p>The identifier of the tool, for example toolName from Model Context Provider server.</p>"""
    description: NotRequired[
        "capo_qconnect.types.non_empty_sensitive_string.NonEmptySensitiveString"
    ]
    """<p>The description of the tool configuration.</p>"""
    instruction: NotRequired["capo_qconnect.types.tool_instruction.ToolInstruction"]
    """<p>Instructions for using the tool.</p>"""
    override_input_values: NotRequired[
        "capo_qconnect.types.tool_override_input_value_list.ToolOverrideInputValueList"
    ]
    """<p>Override input values for the tool configuration.</p>"""
    output_filters: NotRequired[
        "capo_qconnect.types.tool_output_filter_list.ToolOutputFilterList"
    ]
    """<p>Output filters applies to the tool result.</p>"""
    input_schema: NotRequired["capo_qconnect.types.json_document.JSONDocument"]
    """<p>The input schema for the tool configuration.</p>"""
    output_schema: NotRequired["capo_qconnect.types.json_document.JSONDocument"]
    """<p>The output schema for the tool configuration.</p>"""
    annotations: NotRequired["capo_qconnect.types.annotation.Annotation"]
    """<p>Annotations for the tool configuration.</p>"""
    user_interaction_configuration: NotRequired[
        "capo_qconnect.types.user_interaction_configuration.UserInteractionConfiguration"
    ]
    """<p>Configuration for user interaction with the tool.</p>"""

annotations instance-attribute 

annotations: NotRequired[Annotation]

Annotations for the tool configuration.

description instance-attribute 

description: NotRequired[NonEmptySensitiveString]

The description of the tool configuration.

input_schema instance-attribute 

input_schema: NotRequired[JSONDocument]

The input schema for the tool configuration.

instruction instance-attribute 

instruction: NotRequired[ToolInstruction]

Instructions for using the tool.

output_filters instance-attribute 

output_filters: NotRequired[ToolOutputFilterList]

Output filters applies to the tool result.

output_schema instance-attribute 

output_schema: NotRequired[JSONDocument]

The output schema for the tool configuration.

override_input_values instance-attribute 

override_input_values: NotRequired[ToolOverrideInputValueList]

Override input values for the tool configuration.

title instance-attribute 

title: NotRequired[NonEmptySensitiveString]

The title of the tool configuration.

tool_id instance-attribute 

tool_id: NotRequired[NonEmptyString]

The identifier of the tool, for example toolName from Model Context Provider server.

tool_name instance-attribute 

tool_name: NonEmptyString

The name of the tool.

tool_type instance-attribute 

tool_type: ToolType

The type of the tool.

user_interaction_configuration instance-attribute 

user_interaction_configuration: NotRequired[UserInteractionConfiguration]

Configuration for user interaction with the tool.