Class AnalysisRule (1.23.1)

AnalysisRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
name str
Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this analysis rule was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The most recent time at which this analysis rule was updated.
display_name str
Display Name of the analysis rule. This field is a member of oneof_ _display_name.
conversation_filter str
Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
annotator_selector google.cloud.contact_center_insights_v1.types.AnnotatorSelector
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.
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.
active bool
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.