Skip to content

Commit

Permalink
docs: clarified documentation for security settings
Browse files Browse the repository at this point in the history
docs: clarified documentation for session parameters

PiperOrigin-RevId: 374474736
  • Loading branch information
Google APIs authored and Copybara-Service committed May 18, 2021
1 parent f57b0b7 commit c27d046
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
15 changes: 10 additions & 5 deletions google/cloud/dialogflow/cx/v3beta1/security_settings.proto
Expand Up @@ -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;
}

Expand All @@ -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
Expand All @@ -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;
}

Expand Down
5 changes: 4 additions & 1 deletion google/cloud/dialogflow/cx/v3beta1/session.proto
Expand Up @@ -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:
Expand All @@ -397,7 +400,7 @@ message QueryParameters {
// - MapValue type:
// - If parameter's entity type is a composite entity: map
// - Else: depending on parameter value type, could be one of string,
// number, boolean, null, list or map
// number, boolean, null, list or map
// - MapValue value:
// - If parameter's entity type is a composite entity:
// map from composite entity property names to property values
Expand Down

0 comments on commit c27d046

Please sign in to comment.