ToolInput¶

class oci.generative_ai_agent_runtime.models.ToolInput(**kwargs)¶

Bases: object

Base object for tool input parameters. The ‘toolInputType’ discriminator determines the specific input structure to be used.

Attributes

`TOOL_INPUT_TYPE_GENERIC_TOOL_INPUT`	A constant which can be used with the tool_input_type property of a ToolInput.
`tool_id`	[Required] Gets the tool_id of this ToolInput.
`tool_input_type`	[Required] Gets the tool_input_type of this ToolInput.

Methods

`__init__`(**kwargs)	Initializes a new ToolInput object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TOOL_INPUT_TYPE_GENERIC_TOOL_INPUT = 'GENERIC_TOOL_INPUT'¶: A constant which can be used with the tool_input_type property of a ToolInput. This constant has a value of “GENERIC_TOOL_INPUT”

__init__(**kwargs)¶

Initializes a new ToolInput object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

GenericToolInput

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:	tool_id (str) – The value to assign to the tool_id property of this ToolInput. tool_input_type (str) – The value to assign to the tool_input_type property of this ToolInput. Allowed values for this property are: “GENERIC_TOOL_INPUT”

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

tool_id¶

[Required] Gets the tool_id of this ToolInput. Unique OCID of the tool.

Returns:	The tool_id of this ToolInput.
Return type:	str

tool_input_type¶

[Required] Gets the tool_input_type of this ToolInput. Specifies the type of tool input (e.g., GENERIC_TOOL_INPUT).

Allowed values for this property are: “GENERIC_TOOL_INPUT”

Returns:	The tool_input_type of this ToolInput.
Return type:	str