Parameter

class oci.generative_ai.models.Parameter(**kwargs)

Bases: object

Defines a configurable parameter supported by a model.

Methods:

__init__(**kwargs)

Initializes a new Parameter object with values from keyword arguments.

Attributes:

default_value

Gets the default_value of this Parameter.

description

Gets the description of this Parameter.

maximum

Gets the maximum of this Parameter.

minimum

Gets the minimum of this Parameter.

name

[Required] Gets the name of this Parameter.

type

Gets the type of this Parameter.

__init__(**kwargs)

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

Parameters
  • name (str) – The value to assign to the name property of this Parameter.

  • type (str) – The value to assign to the type property of this Parameter.

  • minimum (float) – The value to assign to the minimum property of this Parameter.

  • maximum (float) – The value to assign to the maximum property of this Parameter.

  • default_value (str) – The value to assign to the default_value property of this Parameter.

  • description (str) – The value to assign to the description property of this Parameter.

property default_value

Gets the default_value of this Parameter. The default value used when this parameter is not supplied.

Returns

The default_value of this Parameter.

Return type

str

property description

Gets the description of this Parameter. A human-readable description of this parameter.

Returns

The description of this Parameter.

Return type

str

property maximum

Gets the maximum of this Parameter. The maximum allowed value for this parameter. Applicable only when type is FLOAT or INTEGER.

Returns

The maximum of this Parameter.

Return type

float

property minimum

Gets the minimum of this Parameter. The minimum allowed value for this parameter. Applicable only when type is FLOAT or INTEGER.

Returns

The minimum of this Parameter.

Return type

float

property name

[Required] Gets the name of this Parameter. The name of this parameter.

Returns

The name of this Parameter.

Return type

str

property type

Gets the type of this Parameter. The data type of the parameter (e.g., float, integer, string).

Returns

The type of this Parameter.

Return type

str