Class: Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AnalysisRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/contactcenterinsights_v1/classes.rb,
lib/google/apis/contactcenterinsights_v1/representations.rb,
lib/google/apis/contactcenterinsights_v1/representations.rb

Overview

The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudContactcenterinsightsV1AnalysisRule

Returns a new instance of GoogleCloudContactcenterinsightsV1AnalysisRule.



212
213
214
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 212

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active ⇒ Boolean Also known as: active?

If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft. Corresponds to the JSON property active

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 168

def active
  @active
end

#analysis_percentage ⇒ Float

Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation. Corresponds to the JSON property analysisPercentage

Returns:

  • (Float) 


177
178
179
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 177

def analysis_percentage
  @analysis_percentage
end

#annotator_selector ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1AnnotatorSelector

Selector of all available annotators and phrase matchers to run. Corresponds to the JSON property annotatorSelector

Returns:



182
183
184
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 182

def annotator_selector
  @annotator_selector
end

#conversation_filter ⇒ String

Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https:// cloud.google.com/contact-center/insights/docs/filtering for details. Corresponds to the JSON property conversationFilter

Returns:

  • (String) 


189
190
191
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 189

def conversation_filter
  @conversation_filter
end

#create_time ⇒ String

Output only. The time at which this analysis rule was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


194
195
196
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 194

def create_time
  @create_time
end

#display_name ⇒ String

Display Name of the analysis rule. Corresponds to the JSON property displayName

Returns:

  • (String) 


199
200
201
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 199

def display_name
  @display_name
end

#name ⇒ String

Identifier. The resource name of the analysis rule. Format: projects/project/ locations/location/analysisRules/analysis_rule Corresponds to the JSON property name

Returns:

  • (String) 


205
206
207
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 205

def name
  @name
end

#update_time ⇒ String

Output only. The most recent time at which this analysis rule was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


210
211
212
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 210

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 217

def update!(**args)
  @active = args[:active] if args.key?(:active)
  @analysis_percentage = args[:analysis_percentage] if args.key?(:analysis_percentage)
  @annotator_selector = args[:annotator_selector] if args.key?(:annotator_selector)
  @conversation_filter = args[:conversation_filter] if args.key?(:conversation_filter)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
end