ToolChoiceRequired

class oci.generative_ai_inference.models.ToolChoiceRequired(**kwargs)

Bases: ToolChoice

The model must call one or more tools.

Attributes:

TYPE_AUTO	A constant which can be used with the type property of a ToolChoice.
TYPE_FUNCTION	A constant which can be used with the type property of a ToolChoice.
TYPE_NONE	A constant which can be used with the type property of a ToolChoice.
TYPE_REQUIRED	A constant which can be used with the type property of a ToolChoice.
type	[Required] Gets the type of this ToolChoice.

Methods:

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

A constant which can be used with the type property of a ToolChoice. This constant has a value of “AUTO”

TYPE_FUNCTION = 'FUNCTION'

A constant which can be used with the type property of a ToolChoice. This constant has a value of “FUNCTION”

TYPE_NONE = 'NONE'

A constant which can be used with the type property of a ToolChoice. This constant has a value of “NONE”

TYPE_REQUIRED = 'REQUIRED'

A constant which can be used with the type property of a ToolChoice. This constant has a value of “REQUIRED”

__init__(**kwargs)

Initializes a new ToolChoiceRequired object with values from keyword arguments. The default value of the type attribute of this class is REQUIRED 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 ToolChoiceRequired. Allowed values for this property are: “NONE”, “AUTO”, “REQUIRED”, “FUNCTION”

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.

property 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