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
defactive()->::Boolean
Returns
(::Boolean) — If true, apply this rule to conversations. Otherwise, this rule is
inactive and saved as a draft.
#active=
defactive=(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
defanalysis_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=
defanalysis_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.
(::String) — Filter for the conversations that should apply this analysis
rule. An empty filter means this analysis rule applies to all
conversations.
#conversation_filter=
defconversation_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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::AnalysisRule (v1.6.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.0 (latest)](/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [1.5.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.5.1/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [1.4.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.4.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [1.3.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.3.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [1.2.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.2.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [1.1.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.1.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [1.0.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.0.1/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.22.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.22.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.21.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.21.1/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.20.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.20.1/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.19.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.19.1/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.18.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.18.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.17.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.17.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.16.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.16.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.15.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.15.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.14.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.14.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.13.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.13.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.12.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.12.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.11.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.11.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.10.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.10.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.9.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.9.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.8.2](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.8.2/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.7.2](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.7.2/Google-Cloud-ContactCenterInsights-V1-AnalysisRule)\n- [0.6.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.6.0/Google-Cloud-ContactCenterInsights-V1-AnalysisRule) \nReference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::AnalysisRule.\n\nThe CCAI Insights project wide analysis rule. This rule will be applied to\nall conversations that match the filter defined in the rule. For a\nconversation matches the filter, the annotators specified in the rule will be\nrun. If a conversation matches multiple rules, a union of all the annotators\nwill be run. One project can have multiple analysis rules. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #active\n\n def active() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.\n\n### #active=\n\n def active=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft. \n**Returns**\n\n- (::Boolean) --- If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.\n\n### #analysis_percentage\n\n def analysis_percentage() -\u003e ::Float\n\n**Returns**\n\n- (::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.\n\n### #analysis_percentage=\n\n def analysis_percentage=(value) -\u003e ::Float\n\n**Parameter**\n\n- **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. \n**Returns**\n\n- (::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.\n\n### #annotator_selector\n\n def annotator_selector() -\u003e ::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector\n\n**Returns**\n\n- ([::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector](./Google-Cloud-ContactCenterInsights-V1-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.\n\n### #annotator_selector=\n\n def annotator_selector=(value) -\u003e ::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector\n\n**Parameter**\n\n- **value** ([::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector](./Google-Cloud-ContactCenterInsights-V1-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. \n**Returns**\n\n- ([::Google::Cloud::ContactCenterInsights::V1::AnnotatorSelector](./Google-Cloud-ContactCenterInsights-V1-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.\n\n### #conversation_filter\n\n def conversation_filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.\n\n### #conversation_filter=\n\n def conversation_filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. \n**Returns**\n\n- (::String) --- Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time at which this analysis rule was created.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Display Name of the analysis rule.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Display Name of the analysis rule. \n**Returns**\n\n- (::String) --- Display Name of the analysis rule.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} \n**Returns**\n\n- (::String) --- Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The most recent time at which this analysis rule was updated."]]
