CohereParameterDefinition¶

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

Bases: object

A definition of tool parameter.

Methods

__init__(**kwargs) Initializes a new CohereParameterDefinition object with values from keyword arguments.

Attributes

`description`	Gets the description of this CohereParameterDefinition.
`is_required`	Gets the is_required of this CohereParameterDefinition.
`type`	[Required] Gets the type of this CohereParameterDefinition.

__init__(**kwargs)¶

Initializes a new CohereParameterDefinition object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:	description (str) – The value to assign to the description property of this CohereParameterDefinition. type (str) – The value to assign to the type property of this CohereParameterDefinition. is_required (bool) – The value to assign to the is_required property of this CohereParameterDefinition.

description¶

Gets the description of this CohereParameterDefinition. The description of the parameter.

Returns:	The description of this CohereParameterDefinition.
Return type:	str

is_required¶

Gets the is_required of this CohereParameterDefinition. Denotes whether the parameter is always present (required) or not. Defaults to not required.

Returns:	The is_required of this CohereParameterDefinition.
Return type:	bool

type¶

[Required] Gets the type of this CohereParameterDefinition. The type of the parameter. Must be a valid Python type.

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