ToolChoiceFunction¶

class oci.generative_ai_inference.models.ToolChoiceFunction(**kwargs)¶

Bases: oci.generative_ai_inference.models.tool_choice.ToolChoice

The tool choice for a function. The model will generate the parameters for user to call the function.

Attributes

`TYPE_AUTO`	str(object=’’) -> str
`TYPE_FUNCTION`	str(object=’’) -> str
`TYPE_NONE`	str(object=’’) -> str
`TYPE_REQUIRED`	str(object=’’) -> str
`name`	Gets the name of this ToolChoiceFunction.
`type`	[Required] Gets the type of this ToolChoice.

Methods

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

TYPE_AUTO = 'AUTO'¶

TYPE_FUNCTION = 'FUNCTION'¶

TYPE_NONE = 'NONE'¶

TYPE_REQUIRED = 'REQUIRED'¶

__init__(**kwargs)¶

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

Parameters:	type (str) – The value to assign to the type property of this ToolChoiceFunction. Allowed values for this property are: “NONE”, “AUTO”, “REQUIRED”, “FUNCTION” name (str) – The value to assign to the name property of this ToolChoiceFunction.

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.

name¶

Gets the name of this ToolChoiceFunction. The function name.

Returns:	The name of this ToolChoiceFunction.
Return type:	str

type¶

[Required] Gets the type of this ToolChoice. The tool choice.

Allowed values for this property are: “NONE”, “AUTO”, “REQUIRED”, “FUNCTION”

Returns:	The type of this ToolChoice.
Return type:	str