RequiredAction¶

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

Bases: object

Represents an action that needs to be performed by the user or client.

Attributes

`REQUIRED_ACTION_TYPE_FUNCTION_CALLING_REQUIRED_ACTION`	A constant which can be used with the required_action_type property of a RequiredAction.
`REQUIRED_ACTION_TYPE_HUMAN_APPROVAL_REQUIRED_ACTION`	A constant which can be used with the required_action_type property of a RequiredAction.
`action_id`	[Required] Gets the action_id of this RequiredAction.
`required_action_type`	[Required] Gets the required_action_type of this RequiredAction.

Methods

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

REQUIRED_ACTION_TYPE_FUNCTION_CALLING_REQUIRED_ACTION = 'FUNCTION_CALLING_REQUIRED_ACTION'¶: A constant which can be used with the required_action_type property of a RequiredAction. This constant has a value of “FUNCTION_CALLING_REQUIRED_ACTION”

REQUIRED_ACTION_TYPE_HUMAN_APPROVAL_REQUIRED_ACTION = 'HUMAN_APPROVAL_REQUIRED_ACTION'¶: A constant which can be used with the required_action_type property of a RequiredAction. This constant has a value of “HUMAN_APPROVAL_REQUIRED_ACTION”

__init__(**kwargs)¶

Initializes a new RequiredAction 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:

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 RequiredAction.
required_action_type (str) – The value to assign to the required_action_type property of this RequiredAction. 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’.

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.

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