Class: Google::Cloud::ContactCenterInsights::V1::AnalysisRule

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 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 Attribute Details

#active ⇒ ::Boolean

Returns If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.

Returns:

  • (::Boolean) —

    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#analysis_percentage ⇒ ::Float

Returns 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.

Returns:

  • (::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.



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#annotator_selector ⇒ ::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector

Returns Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.

Returns:



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#conversation_filter ⇒ ::String

Returns Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.

Returns:

  • (::String) —

    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns Output only. The time at which this analysis rule was created.

Returns:



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Display Name of the analysis rule.

Returns:

  • (::String) —

    Display Name of the analysis rule.



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}.

Returns:

  • (::String) —

    Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns Output only. The most recent time at which this analysis rule was updated.

Returns:



1223
1224
1225
1226
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1223

class AnalysisRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end