HumanApprovalRequiredAction¶

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

Bases: oci.generative_ai_agent_runtime.models.required_action.RequiredAction

An object describing human confirmation of tool execution that is required from the user.

Attributes

`OPTIONS_APPROVE`	A constant which can be used with the options property of a HumanApprovalRequiredAction.
`OPTIONS_DENY`	A constant which can be used with the options property of a HumanApprovalRequiredAction.
`REQUIRED_ACTION_TYPE_FUNCTION_CALLING_REQUIRED_ACTION`	str(object=’’) -> str
`REQUIRED_ACTION_TYPE_HUMAN_APPROVAL_REQUIRED_ACTION`	str(object=’’) -> str
`action_id`	[Required] Gets the action_id of this RequiredAction.
`message`	[Required] Gets the message of this HumanApprovalRequiredAction.
`options`	[Required] Gets the options of this HumanApprovalRequiredAction.
`required_action_type`	[Required] Gets the required_action_type of this RequiredAction.

Methods

`__init__`(**kwargs)	Initializes a new HumanApprovalRequiredAction 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.

OPTIONS_APPROVE = 'APPROVE'¶: A constant which can be used with the options property of a HumanApprovalRequiredAction. This constant has a value of “APPROVE”

OPTIONS_DENY = 'DENY'¶: A constant which can be used with the options property of a HumanApprovalRequiredAction. This constant has a value of “DENY”

REQUIRED_ACTION_TYPE_FUNCTION_CALLING_REQUIRED_ACTION = 'FUNCTION_CALLING_REQUIRED_ACTION'¶

REQUIRED_ACTION_TYPE_HUMAN_APPROVAL_REQUIRED_ACTION = 'HUMAN_APPROVAL_REQUIRED_ACTION'¶

__init__(**kwargs)¶

Initializes a new HumanApprovalRequiredAction object with values from keyword arguments. The default value of the required_action_type attribute of this class is HUMAN_APPROVAL_REQUIRED_ACTION and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

action_id (str) – The value to assign to the action_id property of this HumanApprovalRequiredAction.
required_action_type (str) – The value to assign to the required_action_type property of this HumanApprovalRequiredAction. Allowed values for this property are: “HUMAN_APPROVAL_REQUIRED_ACTION”, “FUNCTION_CALLING_REQUIRED_ACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
message (str) – The value to assign to the message property of this HumanApprovalRequiredAction.
options (list[str]) – The value to assign to the options property of this HumanApprovalRequiredAction. Allowed values for items in this list are: “APPROVE”, “DENY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

action_id¶

[Required] Gets the action_id of this RequiredAction. The unique identifier for the action to be performed.

Returns:	The action_id of this RequiredAction.
Return type:	str

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.

message¶

[Required] Gets the message of this HumanApprovalRequiredAction. Message accompanying the human input request asking for approval or denial of a tool execution.

Returns:	The message of this HumanApprovalRequiredAction.
Return type:	str

options¶

[Required] Gets the options of this HumanApprovalRequiredAction. The options presented to the user approving and denying execution of the tool.

Allowed values for items in this list are: “APPROVE”, “DENY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The options of this HumanApprovalRequiredAction.
Return type:	list[str]

required_action_type¶

[Required] Gets the required_action_type of this RequiredAction. Specifies the type of action. Used for determining the action subtype.

Allowed values for this property are: “HUMAN_APPROVAL_REQUIRED_ACTION”, “FUNCTION_CALLING_REQUIRED_ACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The required_action_type of this RequiredAction.
Return type:	str