FunctionCallingRequiredAction¶

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

Bases: oci.generative_ai_agent_runtime.models.required_action.RequiredAction

Represents an action for submitting function call outputs.

Attributes

`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.
`function_call`	[Required] Gets the function_call of this FunctionCallingRequiredAction.
`required_action_type`	[Required] Gets the required_action_type of this RequiredAction.

Methods

`__init__`(**kwargs)	Initializes a new FunctionCallingRequiredAction 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'¶

REQUIRED_ACTION_TYPE_HUMAN_APPROVAL_REQUIRED_ACTION = 'HUMAN_APPROVAL_REQUIRED_ACTION'¶

__init__(**kwargs)¶

Initializes a new FunctionCallingRequiredAction object with values from keyword arguments. The default value of the required_action_type attribute of this class is FUNCTION_CALLING_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 FunctionCallingRequiredAction.
required_action_type (str) – The value to assign to the required_action_type property of this FunctionCallingRequiredAction. Allowed values for this property are: “HUMAN_APPROVAL_REQUIRED_ACTION”, “FUNCTION_CALLING_REQUIRED_ACTION”
function_call (oci.generative_ai_agent_runtime.models.FunctionCall) – The value to assign to the function_call property of this FunctionCallingRequiredAction.

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

function_call¶

[Required] Gets the function_call of this FunctionCallingRequiredAction.

Returns:	The function_call of this FunctionCallingRequiredAction.
Return type:	oci.generative_ai_agent_runtime.models.FunctionCall

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