Represents the settings related to security issues, such as
data redaction and data retention. It may take hours for updates
on the settings to propagate to all the related components and
take effect.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
str
Resource name of the settings. Required for the
SecuritySettingsService.UpdateSecuritySettings
method.
SecuritySettingsService.CreateSecuritySettings
populates the name automatically. Format:
projects/.
display_name
str
Required. The human-readable name of the
security settings, unique within the location.
str DLP __ inspect template
name. Use this template to define inspect base settings.
The DLP Inspect Templates Reader role is needed on the
Dialogflow service identity service account (has the form
service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com)
for your agent's project.
If empty, we use the default DLP inspect config.
The template name will have one of the following formats:
projects/
OR
organizations/
Note: inspect_template must be located in the same
region as the SecuritySettings.
deidentify_template
str DLP __ deidentify
template name. Use this template to define de-identification
configuration for the content.
The DLP De-identify Templates Reader role is needed on
the Dialogflow service identity service account (has the
form
service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com)
for your agent's project.
If empty, Dialogflow replaces sensitive info with
[redacted] text.
The template name will have one of the following formats:
projects/
OR
organizations/
Note: deidentify_template must be located in the same
region as the SecuritySettings.
retention_window_days
int
Retains the data for the specified number of
days. User must set a value lower than
Dialogflow's default 365d TTL (30 days for Agent
Assist traffic), higher value will be ignored
and use default. Setting a value higher than
that has no effect. A missing value or setting
to 0 also means we use default TTL.
When data retention configuration is changed, it
only applies to the data created after the
change; the TTL of existing data created before
the change stays intact.
This field is a member of oneof_ data_retention.
google.cloud.dialogflowcx_v3.types.SecuritySettings.AudioExportSettings
Controls audio export settings for post-conversation
analytics when ingesting audio to conversations via
[Participants.AnalyzeContent][] or
[Participants.StreamingAnalyzeContent][].
If
retention_strategy
is set to REMOVE_AFTER_CONVERSATION or
[audio_export_settings.gcs_bucket][] is empty, audio export
is disabled.
If audio export is enabled, audio is recorded and saved to
[audio_export_settings.gcs_bucket][], subject to retention
policy of [audio_export_settings.gcs_bucket][].
This setting won't effect audio input for implicit sessions
via
Sessions.DetectIntent
or
Sessions.StreamingDetectIntent.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class SecuritySettings (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3.types.SecuritySettings)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3.types.SecuritySettings) \n\n SecuritySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents the settings related to security issues, such as\ndata redaction and data retention. It may take hours for updates\non the settings to propagate to all the related components and\ntake effect.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### AudioExportSettings\n\n AudioExportSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSettings for exporting audio.\n\n### InsightsExportSettings\n\n InsightsExportSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSettings for exporting conversations to\n`Insights \u003chttps://cloud.google.com/contact-center/insights/docs\u003e`__.\n\n### PurgeDataType\n\n PurgeDataType(value)\n\nType of data we purge after retention settings triggers\npurge.\n\n### RedactionScope\n\n RedactionScope(value)\n\nDefines what types of data to redact.\n\n### RedactionStrategy\n\n RedactionStrategy(value)\n\nDefines how we redact data.\n\n### RetentionStrategy\n\n RetentionStrategy(value)\n\nDefines how long we retain persisted data that contains\nsensitive info."]]
