GenericToolInput

class oci.generative_ai_agent_runtime.models.GenericToolInput(**kwargs)

Bases: oci.generative_ai_agent_runtime.models.tool_input.ToolInput

Represents a generic tool input schema that accepts flexible, freeform JSON parameters. This structure is intended for tools that do not require a fixed input schema.

Attributes

TOOL_INPUT_TYPE_GENERIC_TOOL_INPUT str(object=’’) -> str
input [Required] Gets the input of this GenericToolInput.
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 GenericToolInput 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'
__init__(**kwargs)

Initializes a new GenericToolInput object with values from keyword arguments. The default value of the tool_input_type attribute of this class is GENERIC_TOOL_INPUT and it should not be changed. 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 GenericToolInput.
  • tool_input_type (str) – The value to assign to the tool_input_type property of this GenericToolInput. Allowed values for this property are: “GENERIC_TOOL_INPUT”
  • input (object) – The value to assign to the input property of this GenericToolInput.
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.

input

[Required] Gets the input of this GenericToolInput. A freeform JSON object containing the input parameters to be passed to the tool during execution.

Returns:The input of this GenericToolInput.
Return type:object
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