Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::AnalysisRule (v1.3.0)

Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::AnalysisRule.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#active

def active() -> ::Boolean
Returns
  • (::Boolean) — If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.

#active=

def active=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

#analysis_percentage

def analysis_percentage() -> ::Float
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.

#analysis_percentage=

def analysis_percentage=(value) -> ::Float
Parameter
  • value (::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.
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.

#annotator_selector

def annotator_selector() -> ::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector
Returns

#annotator_selector=

def annotator_selector=(value) -> ::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector
Parameter
Returns

#conversation_filter

def conversation_filter() -> ::String
Returns
  • (::String) — Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.

#conversation_filter=

def conversation_filter=(value) -> ::String
Parameter
  • value (::String) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Display Name of the analysis rule.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Display Name of the analysis rule.
Returns
  • (::String) — Display Name of the analysis rule.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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}

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns