Skip to content

Commit

Permalink
docs: update the doc on diagnostic info (#265)
Browse files Browse the repository at this point in the history
feat: add audio export settings to security settings
docs: update the doc on diagnostic info
PiperOrigin-RevId: 446763565
Source-Link: googleapis/googleapis@2d07d51
Source-Link: googleapis/googleapis-gen@7cf0655
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiN2NmMDY1NWVjMGI3MWE1OTYzMDgxZmU4YzVkYTkwOGZjYzg0MGUzZSJ9
See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
PiperOrigin-RevId: 446890999
Source-Link: googleapis/googleapis@044c518
Source-Link: googleapis/googleapis-gen@770df39
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzcwZGYzOWJkNjg0MDBhODRjMGJiMjU2YzNjMmZiN2Q2NWQ2NDlkNSJ9
  • Loading branch information
gcf-owl-bot[bot] authored May 9, 2022
1 parent e9de543 commit b0da9d7
Show file tree
Hide file tree
Showing 6 changed files with 563 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -617,8 +617,22 @@ message QueryResult {
Match match = 15;

// The free-form diagnostic info. For example, this field could contain
// webhook call latency. The string keys of the Struct's fields map can change
// without notice.
// webhook call latency. The fields of this data can change without notice,
// so you should not write code that depends on its structure.
//
// One of the fields is called "Alternative Matched Intents", which may
// aid with debugging. The following describes these intent results:
//
// - The list is empty if no intent was matched to end-user input.
// - Only intents that are referenced in the currently active flow are
// included.
// - The matched intent is included.
// - Other intents that could have matched end-user input, but did not match
// because they are referenced by intent routes that are out of
// [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),
// are included.
// - Other intents referenced by intent routes in scope that matched end-user
// input, but had a lower confidence score.
google.protobuf.Struct diagnostic_info = 10;

// The sentiment analyss result, which depends on
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,41 @@ message SecuritySettings {
DIALOGFLOW_HISTORY = 1;
}

// Settings for exporting audio.
message AudioExportSettings {
// File format for exported audio file. Currently only in telephony
// recordings.
enum AudioFormat {
// Unspecified. Do not use.
AUDIO_FORMAT_UNSPECIFIED = 0;

// G.711 mu-law PCM with 8kHz sample rate.
MULAW = 1;

// MP3 file format.
MP3 = 2;

// OGG Vorbis.
OGG = 3;
}

// Cloud Storage bucket to export audio record to. You need to grant
// `service-<Conversation Project
// Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Storage Object
// Admin` role in this bucket.
string gcs_bucket = 1;

// Filename pattern for exported audio.
string audio_export_pattern = 2;

// Enable audio redaction if it is true.
bool enable_audio_redaction = 3;

// File format for exported audio file. Currently only in telephony
// recordings.
AudioFormat audio_format = 4;
}

// Settings for exporting conversations to
// [Insights](https://cloud.google.com/contact-center/insights/docs).
message InsightsExportSettings {
Expand Down Expand Up @@ -302,6 +337,21 @@ message SecuritySettings {
// List of types of data to remove when retention settings triggers purge.
repeated PurgeDataType purge_data_types = 8;

// Controls audio export settings for post-conversation analytics when
// ingesting audio to conversations via [Participants.AnalyzeContent][] or
// [Participants.StreamingAnalyzeContent][].
//
// If [retention_strategy][google.cloud.dialogflow.cx.v3beta1.SecuritySettings.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][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent] or [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.StreamingDetectIntent].
AudioExportSettings audio_export_settings = 12;

// Controls conversation exporting settings to Insights after conversation is
// completed.
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -617,8 +617,22 @@ message QueryResult {
Match match = 15;

// The free-form diagnostic info. For example, this field could contain
// webhook call latency. The string keys of the Struct's fields map can change
// without notice.
// webhook call latency. The fields of this data can change without notice,
// so you should not write code that depends on its structure.
//
// One of the fields is called "Alternative Matched Intents", which may
// aid with debugging. The following describes these intent results:
//
// - The list is empty if no intent was matched to end-user input.
// - Only intents that are referenced in the currently active flow are
// included.
// - The matched intent is included.
// - Other intents that could have matched end-user input, but did not match
// because they are referenced by intent routes that are out of
// [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),
// are included.
// - Other intents referenced by intent routes in scope that matched end-user
// input, but had a lower confidence score.
google.protobuf.Struct diagnostic_info = 10;

// The sentiment analyss result, which depends on
Expand Down
125 changes: 125 additions & 0 deletions packages/google-cloud-dialogflow-cx/protos/protos.d.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit b0da9d7

Please sign in to comment.