- Resource: SecuritySettings
- RedactionStrategy
- RedactionScope
- PurgeDataType
- AudioExportSettings
- AudioFormat
- InsightsExportSettings
- Methods
Resource: SecuritySettings
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.
JSON representation |
---|
{ "name": string, "displayName": string, "redactionStrategy": enum ( |
Fields | |
---|---|
name |
Resource name of the settings. Required for the |
displayName |
Required. The human-readable name of the security settings, unique within the location. |
redactionStrategy |
Strategy that defines how we do redaction. |
redactionScope |
Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging. |
inspectTemplate |
DLP inspect template name. Use this template to define inspect base settings. The If empty, we use the default DLP inspect config. The template name will have one of the following formats: Note: |
deidentifyTemplate |
DLP deidentify template name. Use this template to define de-identification configuration for the content. The If empty, Dialogflow replaces sensitive info with The template name will have one of the following formats: Note: |
purgeDataTypes[] |
List of types of data to remove when retention settings triggers purge. |
audioExportSettings |
Controls audio export settings for post-conversation analytics when ingesting audio to conversations via [Participants.AnalyzeContent][] or [Participants.StreamingAnalyzeContent][]. If If audio export is enabled, audio is recorded and saved to [audioExportSettings.gcs_bucket][], subject to retention policy of [audioExportSettings.gcs_bucket][]. This setting won't effect audio input for implicit sessions via |
insightsExportSettings |
Controls conversation exporting settings to Insights after conversation is completed. If |
Union field data_retention . Specifies how data is retained. Note that even if the data is purged due to retention policy, we may still hold it in backup storage for a few days without allowing direct readings. data_retention can be only one of the following: |
|
retentionWindowDays |
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. |
RedactionStrategy
Defines how we redact data.
Enums | |
---|---|
REDACTION_STRATEGY_UNSPECIFIED |
Do not redact. |
REDACT_WITH_SERVICE |
Call redaction service to clean up the data to be persisted. |
RedactionScope
Defines what types of data to redact.
Enums | |
---|---|
REDACTION_SCOPE_UNSPECIFIED |
Don't redact any kind of data. |
REDACT_DISK_STORAGE |
On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk. |
PurgeDataType
Type of data we purge after retention settings triggers purge.
Enums | |
---|---|
PURGE_DATA_TYPE_UNSPECIFIED |
Unspecified. Do not use. |
DIALOGFLOW_HISTORY |
Dialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow. |
AudioExportSettings
Settings for exporting audio.
JSON representation |
---|
{
"gcsBucket": string,
"audioExportPattern": string,
"enableAudioRedaction": boolean,
"audioFormat": enum ( |
Fields | |
---|---|
gcsBucket |
Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy. |
audioExportPattern |
Filename pattern for exported audio. |
enableAudioRedaction |
Enable audio redaction if it is true. |
audioFormat |
File format for exported audio file. Currently only in telephony recordings. |
AudioFormat
File format for exported audio file. Currently only in telephony recordings.
Enums | |
---|---|
AUDIO_FORMAT_UNSPECIFIED |
Unspecified. Do not use. |
MULAW |
G.711 mu-law PCM with 8kHz sample rate. |
MP3 |
MP3 file format. |
OGG |
OGG Vorbis. |
InsightsExportSettings
Settings for exporting conversations to Insights.
JSON representation |
---|
{ "enableInsightsExport": boolean } |
Fields | |
---|---|
enableInsightsExport |
If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers. |
Methods |
|
---|---|
|
Create security settings in the specified location. |
|
Deletes the specified SecuritySettings . |
|
Retrieves the specified SecuritySettings . |
|
Returns the list of all security settings in the specified location. |
|
Updates the specified SecuritySettings . |