GuardrailsTextInput

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

Bases: GuardrailsInput

Represents a single instance of text in the guardrails input.

Attributes:

TYPE_IMAGE

A constant which can be used with the type property of a GuardrailsInput.

TYPE_TEXT

A constant which can be used with the type property of a GuardrailsInput.

content

Gets the content of this GuardrailsTextInput.

language_code

Gets the language_code of this GuardrailsTextInput.

type

[Required] Gets the type of this GuardrailsInput.

Methods:

__init__(**kwargs)

Initializes a new GuardrailsTextInput 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_IMAGE = 'IMAGE'

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

TYPE_TEXT = 'TEXT'

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

__init__(**kwargs)

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

  • content (str) – The value to assign to the content property of this GuardrailsTextInput.

  • language_code (str) – The value to assign to the language_code property of this GuardrailsTextInput.

property content

Gets the content of this GuardrailsTextInput. The actual input data.

Returns

The content of this GuardrailsTextInput.

Return type

str

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 language_code

Gets the language_code of this GuardrailsTextInput. The language code of the input text. example - en | es | en-US | zh-CN

Returns

The language_code of this GuardrailsTextInput.

Return type

str

property type

[Required] Gets the type of this GuardrailsInput. The type of the input data.

Allowed values for this property are: “TEXT”, “IMAGE”

Returns

The type of this GuardrailsInput.

Return type

str