Class: Google::Cloud::ContactCenterInsights::V1::Settings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/contactcenterinsights/v1/resources.rb

Overview

The CCAI Insights project wide settings. Use these settings to configure the behavior of Insights. View these settings with getsettings and change the settings with updateSettings.

Defined Under Namespace

Classes: AnalysisConfig, PubsubNotificationSettingsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::Settings::AnalysisConfig

Returns Default analysis settings.

Returns:



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#conversation_ttl ⇒ ::Google::Protobuf::Duration

Returns The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.

Returns:

  • (::Google::Protobuf::Duration) —

    The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the settings was created.

Returns:



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#language_code ⇒ ::String

Returns A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here.

Returns:

  • (::String) —

    A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here.



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings.

Returns:

  • (::String) —

    Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pubsub_notification_settings ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic.

Keys are notification triggers. Supported keys are:

  • "all-triggers": Notify each time any of the supported triggers occurs.
  • "create-analysis": Notify each time an analysis is created.
  • "create-conversation": Notify each time a conversation is created.
  • "export-insights-data": Notify each time an export is complete.
  • "ingest-conversations": Notify each time an IngestConversations LRO is complete.
  • "update-conversation": Notify each time a conversation is updated via UpdateConversation.
  • "upload-conversation": Notify when an UploadConversation LRO is complete.

Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic.

    Keys are notification triggers. Supported keys are:

    • "all-triggers": Notify each time any of the supported triggers occurs.
    • "create-analysis": Notify each time an analysis is created.
    • "create-conversation": Notify each time a conversation is created.
    • "export-insights-data": Notify each time an export is complete.
    • "ingest-conversations": Notify each time an IngestConversations LRO is complete.
    • "update-conversation": Notify each time a conversation is updated via UpdateConversation.
    • "upload-conversation": Notify when an UploadConversation LRO is complete.

    Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#redaction_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::RedactionConfig

Returns Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::RedactionConfig) —

    Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform.



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#speech_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::SpeechConfig

Returns Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::SpeechConfig) —

    Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform.



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the settings were last updated.

Returns:



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1092

class Settings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default configuration when creating Analyses in Insights.
  # @!attribute [rw] runtime_integration_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using Dialogflow runtime integration
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] upload_conversation_analysis_percentage
  #   @return [::Float]
  #     Percentage of conversations created using the UploadConversation endpoint
  #     to analyze automatically, between [0, 100].
  # @!attribute [rw] annotator_selector
  #   @return [::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector]
  #     To select the annotators to run and the phrase matchers to use
  #     (if any). If not specified, all annotators will be run.
  class AnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class PubsubNotificationSettingsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end