From f57b0b7bd24e5bd5bf49c9e6452b12de31d11070 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Tue, 18 May 2021 12:04:14 -0700 Subject: [PATCH] docs: clarified documentation for security settings docs: clarified documentation for session parameters PiperOrigin-RevId: 374473298 --- .../dialogflow/cx/v3/security_settings.proto | 15 ++++++++++----- google/cloud/dialogflow/cx/v3/session.proto | 3 +++ 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/google/cloud/dialogflow/cx/v3/security_settings.proto b/google/cloud/dialogflow/cx/v3/security_settings.proto index a5154bdd245d4..2d01bd5e4b6ec 100644 --- a/google/cloud/dialogflow/cx/v3/security_settings.proto +++ b/google/cloud/dialogflow/cx/v3/security_settings.proto @@ -198,8 +198,8 @@ message SecuritySettings { // Unspecified. Do not use. PURGE_DATA_TYPE_UNSPECIFIED = 0; - // Dialogflow history. This does not include Stackdriver log, which is - // owned by the user not Dialogflow. + // Dialogflow history. This does not include Cloud logging, which is + // owned by the user - not Dialogflow. DIALOGFLOW_HISTORY = 1; } @@ -215,8 +215,9 @@ message SecuritySettings { // Strategy that defines how we do redaction. RedactionStrategy redaction_strategy = 3; - // Defines on what data we apply redaction. Note that we don't - // redact data to which we don't have access, e.g., Stackdriver logs. + // Defines the data for which Dialogflow applies redaction. Dialogflow does + // not redact data that it does not have access to – for example, Cloud + // logging. RedactionScope redaction_scope = 4; // DLP inspect template name. Use this template to define inspect base @@ -233,11 +234,15 @@ message SecuritySettings { // purged due to retention policy, we may still hold it in backup storage for // a few days without allowing direct readings. oneof data_retention { - // Retains the data for the specified number of days. + // Retains data in interaction logging for the specified number of days. + // This does not apply to Cloud logging, which is owned by the user - not + // Dialogflow. // User must Set a value lower than Dialogflow's default 30d TTL. Setting a // value higher than that has no effect. // A missing value or setting to 0 also means we use Dialogflow's default // TTL. + // Note: Interaction logging is a limited access feature. Talk to your + // Google representative to check availability for you. int32 retention_window_days = 6; } diff --git a/google/cloud/dialogflow/cx/v3/session.proto b/google/cloud/dialogflow/cx/v3/session.proto index a31d8c8e5bd62..195261761bad3 100644 --- a/google/cloud/dialogflow/cx/v3/session.proto +++ b/google/cloud/dialogflow/cx/v3/session.proto @@ -388,6 +388,9 @@ message QueryParameters { // parameter from the session, clients should explicitly set the parameter // value to null. // + // You can reference the session parameters in the agent with the following + // format: $session.params.parameter-id. + // // Depending on your protocol or client library language, this is a // map, associative array, symbol table, dictionary, or JSON object // composed of a collection of (MapKey, MapValue) pairs: