PiiDetectionConfig¶

class oci.generative_ai.models.PiiDetectionConfig(**kwargs)¶

Bases: object

The configuration details for personally identifiable information (PII) detection, in prompts and responses.

Methods

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

Attributes

`is_enabled`	[Required] Gets the is_enabled of this PiiDetectionConfig.
`mode`	Gets the mode of this PiiDetectionConfig.
`model_id`	Gets the model_id of this PiiDetectionConfig.

__init__(**kwargs)¶

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

Parameters:	mode (str) – The value to assign to the mode property of this PiiDetectionConfig. model_id (str) – The value to assign to the model_id property of this PiiDetectionConfig. is_enabled (bool) – The value to assign to the is_enabled property of this PiiDetectionConfig.

is_enabled¶

[Required] Gets the is_enabled of this PiiDetectionConfig. Whether to enable the PII detection feature.

Returns:	The is_enabled of this PiiDetectionConfig.
Return type:	bool

mode¶

Gets the mode of this PiiDetectionConfig. The mode of operation for PII detection.

Returns:	The mode of this PiiDetectionConfig.
Return type:	str

model_id¶

Gets the model_id of this PiiDetectionConfig. The OCID of the model used for the feature.

Returns:	The model_id of this PiiDetectionConfig.
Return type:	str