Contact Center AI Insights v1 API - Class AnalysisRule (2.18.0)

public sealed class AnalysisRule : IMessage<AnalysisRule>, IEquatable<AnalysisRule>, IDeepCloneable<AnalysisRule>, IBufferMessage, IMessage

Reference documentation and code samples for the Contact Center AI Insights v1 API class 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.

Inheritance

object > AnalysisRule

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

AnalysisRule()

public AnalysisRule()

AnalysisRule(AnalysisRule)

public AnalysisRule(AnalysisRule other)
Parameter
Name Description
other AnalysisRule

Properties

Active

public bool Active { get; set; }

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

Property Value
Type Description
bool

AnalysisPercentage

public double AnalysisPercentage { get; set; }

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.

Property Value
Type Description
double

AnalysisRuleName

public AnalysisRuleName AnalysisRuleName { get; set; }

AnalysisRuleName-typed view over the Name resource name property.

Property Value
Type Description
AnalysisRuleName

AnnotatorSelector

public AnnotatorSelector AnnotatorSelector { get; set; }

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.

Property Value
Type Description
AnnotatorSelector

ConversationFilter

public string ConversationFilter { get; set; }

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

Property Value
Type Description
string

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Display Name of the analysis rule.

Property Value
Type Description
string

HasDisplayName

public bool HasDisplayName { get; }

Gets whether the "display_name" field is set

Property Value
Type Description
bool

Name

public string Name { get; set; }

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

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp