GuardrailVersion

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

Bases: object

Details of a guardrail version.

Attributes:

STATE_ACTIVE

A constant which can be used with the state property of a GuardrailVersion.

STATE_DEPRECATED

A constant which can be used with the state property of a GuardrailVersion.

STATE_PREVIEW

A constant which can be used with the state property of a GuardrailVersion.

STATE_RETIRED

A constant which can be used with the state property of a GuardrailVersion.

description

[Required] Gets the description of this GuardrailVersion.

guardrail_version

[Required] Gets the guardrail_version of this GuardrailVersion.

state

[Required] Gets the state of this GuardrailVersion.

time_activated

Gets the time_activated of this GuardrailVersion.

time_deprecated

Gets the time_deprecated of this GuardrailVersion.

time_previewed

Gets the time_previewed of this GuardrailVersion.

time_retired

Gets the time_retired of this GuardrailVersion.

Methods:

__init__(**kwargs)

Initializes a new GuardrailVersion object with values from keyword arguments.

STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the state property of a GuardrailVersion. This constant has a value of “ACTIVE”

STATE_DEPRECATED = 'DEPRECATED'

A constant which can be used with the state property of a GuardrailVersion. This constant has a value of “DEPRECATED”

STATE_PREVIEW = 'PREVIEW'

A constant which can be used with the state property of a GuardrailVersion. This constant has a value of “PREVIEW”

STATE_RETIRED = 'RETIRED'

A constant which can be used with the state property of a GuardrailVersion. This constant has a value of “RETIRED”

__init__(**kwargs)

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

Parameters
  • guardrail_version (str) – The value to assign to the guardrail_version property of this GuardrailVersion.

  • state (str) – The value to assign to the state property of this GuardrailVersion. Allowed values for this property are: “ACTIVE”, “PREVIEW”, “DEPRECATED”, “RETIRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_previewed (datetime) – The value to assign to the time_previewed property of this GuardrailVersion.

  • time_activated (datetime) – The value to assign to the time_activated property of this GuardrailVersion.

  • time_deprecated (datetime) – The value to assign to the time_deprecated property of this GuardrailVersion.

  • time_retired (datetime) – The value to assign to the time_retired property of this GuardrailVersion.

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

property description

[Required] Gets the description of this GuardrailVersion. The description of the guardrail version.

Returns

The description of this GuardrailVersion.

Return type

str

property guardrail_version

[Required] Gets the guardrail_version of this GuardrailVersion. The guardrail system version string, e.g., “1.0.0”

Returns

The guardrail_version of this GuardrailVersion.

Return type

str

property state

[Required] Gets the state of this GuardrailVersion. The state of the guardrail version.

Allowed values for this property are: “ACTIVE”, “PREVIEW”, “DEPRECATED”, “RETIRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The state of this GuardrailVersion.

Return type

str

property time_activated

Gets the time_activated of this GuardrailVersion. The activation date of the guardrail version.

Returns

The time_activated of this GuardrailVersion.

Return type

datetime

property time_deprecated

Gets the time_deprecated of this GuardrailVersion. The deprecated date of the guardrail version.

Returns

The time_deprecated of this GuardrailVersion.

Return type

datetime

property time_previewed

Gets the time_previewed of this GuardrailVersion. The preview date of the guardrail version.

Returns

The time_previewed of this GuardrailVersion.

Return type

datetime

property time_retired

Gets the time_retired of this GuardrailVersion. The retired date of the guardrail version.

Returns

The time_retired of this GuardrailVersion.

Return type

datetime