HumanApprovalPerformedAction¶

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

Bases: oci.generative_ai_agent_runtime.models.performed_action.PerformedAction

An action describing user approval to the agent.

Attributes

`CHOSEN_OPTION_APPROVE`	A constant which can be used with the chosen_option property of a HumanApprovalPerformedAction.
`CHOSEN_OPTION_DENY`	A constant which can be used with the chosen_option property of a HumanApprovalPerformedAction.
`PERFORMED_ACTION_TYPE_FUNCTION_CALLING_PERFORMED_ACTION`	str(object=’’) -> str
`PERFORMED_ACTION_TYPE_HUMAN_APPROVAL_PERFORMED_ACTION`	str(object=’’) -> str
`action_id`	[Required] Gets the action_id of this PerformedAction.
`chosen_option`	[Required] Gets the chosen_option of this HumanApprovalPerformedAction.
`performed_action_type`	[Required] Gets the performed_action_type of this PerformedAction.

Methods

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

CHOSEN_OPTION_APPROVE = 'APPROVE'¶: A constant which can be used with the chosen_option property of a HumanApprovalPerformedAction. This constant has a value of “APPROVE”

CHOSEN_OPTION_DENY = 'DENY'¶: A constant which can be used with the chosen_option property of a HumanApprovalPerformedAction. This constant has a value of “DENY”

PERFORMED_ACTION_TYPE_FUNCTION_CALLING_PERFORMED_ACTION = 'FUNCTION_CALLING_PERFORMED_ACTION'¶

PERFORMED_ACTION_TYPE_HUMAN_APPROVAL_PERFORMED_ACTION = 'HUMAN_APPROVAL_PERFORMED_ACTION'¶

__init__(**kwargs)¶

Initializes a new HumanApprovalPerformedAction object with values from keyword arguments. The default value of the performed_action_type attribute of this class is HUMAN_APPROVAL_PERFORMED_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 HumanApprovalPerformedAction.
performed_action_type (str) – The value to assign to the performed_action_type property of this HumanApprovalPerformedAction. Allowed values for this property are: “HUMAN_APPROVAL_PERFORMED_ACTION”, “FUNCTION_CALLING_PERFORMED_ACTION”
chosen_option (str) – The value to assign to the chosen_option property of this HumanApprovalPerformedAction. Allowed values for this property are: “APPROVE”, “DENY”

action_id¶

[Required] Gets the action_id of this PerformedAction. The unique identifier for the action that has been performed.

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

chosen_option¶

[Required] Gets the chosen_option of this HumanApprovalPerformedAction. The chosen approval or denial option to the agent.

Allowed values for this property are: “APPROVE”, “DENY”

Returns:	The chosen_option of this HumanApprovalPerformedAction.
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.

performed_action_type¶

[Required] Gets the performed_action_type of this PerformedAction. Specifies the type of the performed action.

Allowed values for this property are: “HUMAN_APPROVAL_PERFORMED_ACTION”, “FUNCTION_CALLING_PERFORMED_ACTION”

Returns:	The performed_action_type of this PerformedAction.
Return type:	str