1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. contactcenterinsights
  5. AnalysisRule
Google Cloud v8.39.0 published on Tuesday, Jul 22, 2025 by Pulumi

gcp.contactcenterinsights.AnalysisRule

Explore with Pulumi AI

gcp logo
Google Cloud v8.39.0 published on Tuesday, Jul 22, 2025 by Pulumi

    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.

    To get more information about AnalysisRule, see:

    Example Usage

    Contact Center Insights Analysis Rule Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const analysisRuleBasic = new gcp.contactcenterinsights.AnalysisRule("analysis_rule_basic", {
        location: "us-central1",
        displayName: "analysis-rule-display-name",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    analysis_rule_basic = gcp.contactcenterinsights.AnalysisRule("analysis_rule_basic",
        location="us-central1",
        display_name="analysis-rule-display-name")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/contactcenterinsights"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := contactcenterinsights.NewAnalysisRule(ctx, "analysis_rule_basic", &contactcenterinsights.AnalysisRuleArgs{
    			Location:    pulumi.String("us-central1"),
    			DisplayName: pulumi.String("analysis-rule-display-name"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var analysisRuleBasic = new Gcp.ContactCenterInsights.AnalysisRule("analysis_rule_basic", new()
        {
            Location = "us-central1",
            DisplayName = "analysis-rule-display-name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.contactcenterinsights.AnalysisRule;
    import com.pulumi.gcp.contactcenterinsights.AnalysisRuleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var analysisRuleBasic = new AnalysisRule("analysisRuleBasic", AnalysisRuleArgs.builder()
                .location("us-central1")
                .displayName("analysis-rule-display-name")
                .build());
    
        }
    }
    
    resources:
      analysisRuleBasic:
        type: gcp:contactcenterinsights:AnalysisRule
        name: analysis_rule_basic
        properties:
          location: us-central1
          displayName: analysis-rule-display-name
    

    Contact Center Insights Analysis Rule Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const analysisRuleFull = new gcp.contactcenterinsights.AnalysisRule("analysis_rule_full", {
        location: "us-central1",
        displayName: "analysis-rule-display-name",
        conversationFilter: "agent_id = \"1\"",
        annotatorSelector: {
            runInterruptionAnnotator: false,
            issueModels: ["projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id"],
            phraseMatchers: ["projects/1111111111111/locations/us-central1/phraseMatchers/123"],
            qaConfig: {
                scorecardList: {
                    qaScorecardRevisions: ["projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id"],
                },
            },
            runEntityAnnotator: false,
            runIntentAnnotator: false,
            runIssueModelAnnotator: false,
            runPhraseMatcherAnnotator: false,
            runQaAnnotator: false,
            runSentimentAnnotator: false,
            runSilenceAnnotator: true,
            runSummarizationAnnotator: false,
            summarizationConfig: {
                summarizationModel: "BASELINE_MODEL",
            },
        },
        analysisPercentage: 0.5,
        active: true,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    analysis_rule_full = gcp.contactcenterinsights.AnalysisRule("analysis_rule_full",
        location="us-central1",
        display_name="analysis-rule-display-name",
        conversation_filter="agent_id = \"1\"",
        annotator_selector={
            "run_interruption_annotator": False,
            "issue_models": ["projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id"],
            "phrase_matchers": ["projects/1111111111111/locations/us-central1/phraseMatchers/123"],
            "qa_config": {
                "scorecard_list": {
                    "qa_scorecard_revisions": ["projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id"],
                },
            },
            "run_entity_annotator": False,
            "run_intent_annotator": False,
            "run_issue_model_annotator": False,
            "run_phrase_matcher_annotator": False,
            "run_qa_annotator": False,
            "run_sentiment_annotator": False,
            "run_silence_annotator": True,
            "run_summarization_annotator": False,
            "summarization_config": {
                "summarization_model": "BASELINE_MODEL",
            },
        },
        analysis_percentage=0.5,
        active=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/contactcenterinsights"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := contactcenterinsights.NewAnalysisRule(ctx, "analysis_rule_full", &contactcenterinsights.AnalysisRuleArgs{
    			Location:           pulumi.String("us-central1"),
    			DisplayName:        pulumi.String("analysis-rule-display-name"),
    			ConversationFilter: pulumi.String("agent_id = \"1\""),
    			AnnotatorSelector: &contactcenterinsights.AnalysisRuleAnnotatorSelectorArgs{
    				RunInterruptionAnnotator: pulumi.Bool(false),
    				IssueModels: pulumi.StringArray{
    					pulumi.String("projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id"),
    				},
    				PhraseMatchers: pulumi.StringArray{
    					pulumi.String("projects/1111111111111/locations/us-central1/phraseMatchers/123"),
    				},
    				QaConfig: &contactcenterinsights.AnalysisRuleAnnotatorSelectorQaConfigArgs{
    					ScorecardList: &contactcenterinsights.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs{
    						QaScorecardRevisions: pulumi.StringArray{
    							pulumi.String("projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id"),
    						},
    					},
    				},
    				RunEntityAnnotator:        pulumi.Bool(false),
    				RunIntentAnnotator:        pulumi.Bool(false),
    				RunIssueModelAnnotator:    pulumi.Bool(false),
    				RunPhraseMatcherAnnotator: pulumi.Bool(false),
    				RunQaAnnotator:            pulumi.Bool(false),
    				RunSentimentAnnotator:     pulumi.Bool(false),
    				RunSilenceAnnotator:       pulumi.Bool(true),
    				RunSummarizationAnnotator: pulumi.Bool(false),
    				SummarizationConfig: &contactcenterinsights.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs{
    					SummarizationModel: pulumi.String("BASELINE_MODEL"),
    				},
    			},
    			AnalysisPercentage: pulumi.Float64(0.5),
    			Active:             pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var analysisRuleFull = new Gcp.ContactCenterInsights.AnalysisRule("analysis_rule_full", new()
        {
            Location = "us-central1",
            DisplayName = "analysis-rule-display-name",
            ConversationFilter = "agent_id = \"1\"",
            AnnotatorSelector = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorArgs
            {
                RunInterruptionAnnotator = false,
                IssueModels = new[]
                {
                    "projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id",
                },
                PhraseMatchers = new[]
                {
                    "projects/1111111111111/locations/us-central1/phraseMatchers/123",
                },
                QaConfig = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorQaConfigArgs
                {
                    ScorecardList = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs
                    {
                        QaScorecardRevisions = new[]
                        {
                            "projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id",
                        },
                    },
                },
                RunEntityAnnotator = false,
                RunIntentAnnotator = false,
                RunIssueModelAnnotator = false,
                RunPhraseMatcherAnnotator = false,
                RunQaAnnotator = false,
                RunSentimentAnnotator = false,
                RunSilenceAnnotator = true,
                RunSummarizationAnnotator = false,
                SummarizationConfig = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs
                {
                    SummarizationModel = "BASELINE_MODEL",
                },
            },
            AnalysisPercentage = 0.5,
            Active = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.contactcenterinsights.AnalysisRule;
    import com.pulumi.gcp.contactcenterinsights.AnalysisRuleArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorQaConfigArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var analysisRuleFull = new AnalysisRule("analysisRuleFull", AnalysisRuleArgs.builder()
                .location("us-central1")
                .displayName("analysis-rule-display-name")
                .conversationFilter("agent_id = \"1\"")
                .annotatorSelector(AnalysisRuleAnnotatorSelectorArgs.builder()
                    .runInterruptionAnnotator(false)
                    .issueModels("projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id")
                    .phraseMatchers("projects/1111111111111/locations/us-central1/phraseMatchers/123")
                    .qaConfig(AnalysisRuleAnnotatorSelectorQaConfigArgs.builder()
                        .scorecardList(AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs.builder()
                            .qaScorecardRevisions("projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id")
                            .build())
                        .build())
                    .runEntityAnnotator(false)
                    .runIntentAnnotator(false)
                    .runIssueModelAnnotator(false)
                    .runPhraseMatcherAnnotator(false)
                    .runQaAnnotator(false)
                    .runSentimentAnnotator(false)
                    .runSilenceAnnotator(true)
                    .runSummarizationAnnotator(false)
                    .summarizationConfig(AnalysisRuleAnnotatorSelectorSummarizationConfigArgs.builder()
                        .summarizationModel("BASELINE_MODEL")
                        .build())
                    .build())
                .analysisPercentage(0.5)
                .active(true)
                .build());
    
        }
    }
    
    resources:
      analysisRuleFull:
        type: gcp:contactcenterinsights:AnalysisRule
        name: analysis_rule_full
        properties:
          location: us-central1
          displayName: analysis-rule-display-name
          conversationFilter: agent_id = "1"
          annotatorSelector:
            runInterruptionAnnotator: false
            issueModels:
              - projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id
            phraseMatchers:
              - projects/1111111111111/locations/us-central1/phraseMatchers/123
            qaConfig:
              scorecardList:
                qaScorecardRevisions:
                  - projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id
            runEntityAnnotator: false
            runIntentAnnotator: false
            runIssueModelAnnotator: false
            runPhraseMatcherAnnotator: false
            runQaAnnotator: false
            runSentimentAnnotator: false
            runSilenceAnnotator: true
            runSummarizationAnnotator: false
            summarizationConfig:
              summarizationModel: BASELINE_MODEL
          analysisPercentage: 0.5
          active: true
    

    Contact Center Insights Analysis Rule Profile

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const analysisRuleProfile = new gcp.contactcenterinsights.AnalysisRule("analysis_rule_profile", {
        location: "us-central1",
        displayName: "analysis-rule-display-name",
        conversationFilter: "agent_id = \"1\"",
        annotatorSelector: {
            runInterruptionAnnotator: false,
            issueModels: ["projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id"],
            phraseMatchers: ["projects/1111111111111/locations/us-central1/phraseMatchers/123"],
            qaConfig: {
                scorecardList: {
                    qaScorecardRevisions: ["projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id"],
                },
            },
            runEntityAnnotator: false,
            runIntentAnnotator: false,
            runIssueModelAnnotator: false,
            runPhraseMatcherAnnotator: false,
            runQaAnnotator: false,
            runSentimentAnnotator: false,
            runSilenceAnnotator: true,
            runSummarizationAnnotator: false,
            summarizationConfig: {
                conversationProfile: "projects/1111111111111/locations/us-central1/conversationProfiles/some_conversation_profile",
            },
        },
        analysisPercentage: 0.5,
        active: true,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    analysis_rule_profile = gcp.contactcenterinsights.AnalysisRule("analysis_rule_profile",
        location="us-central1",
        display_name="analysis-rule-display-name",
        conversation_filter="agent_id = \"1\"",
        annotator_selector={
            "run_interruption_annotator": False,
            "issue_models": ["projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id"],
            "phrase_matchers": ["projects/1111111111111/locations/us-central1/phraseMatchers/123"],
            "qa_config": {
                "scorecard_list": {
                    "qa_scorecard_revisions": ["projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id"],
                },
            },
            "run_entity_annotator": False,
            "run_intent_annotator": False,
            "run_issue_model_annotator": False,
            "run_phrase_matcher_annotator": False,
            "run_qa_annotator": False,
            "run_sentiment_annotator": False,
            "run_silence_annotator": True,
            "run_summarization_annotator": False,
            "summarization_config": {
                "conversation_profile": "projects/1111111111111/locations/us-central1/conversationProfiles/some_conversation_profile",
            },
        },
        analysis_percentage=0.5,
        active=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/contactcenterinsights"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := contactcenterinsights.NewAnalysisRule(ctx, "analysis_rule_profile", &contactcenterinsights.AnalysisRuleArgs{
    			Location:           pulumi.String("us-central1"),
    			DisplayName:        pulumi.String("analysis-rule-display-name"),
    			ConversationFilter: pulumi.String("agent_id = \"1\""),
    			AnnotatorSelector: &contactcenterinsights.AnalysisRuleAnnotatorSelectorArgs{
    				RunInterruptionAnnotator: pulumi.Bool(false),
    				IssueModels: pulumi.StringArray{
    					pulumi.String("projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id"),
    				},
    				PhraseMatchers: pulumi.StringArray{
    					pulumi.String("projects/1111111111111/locations/us-central1/phraseMatchers/123"),
    				},
    				QaConfig: &contactcenterinsights.AnalysisRuleAnnotatorSelectorQaConfigArgs{
    					ScorecardList: &contactcenterinsights.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs{
    						QaScorecardRevisions: pulumi.StringArray{
    							pulumi.String("projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id"),
    						},
    					},
    				},
    				RunEntityAnnotator:        pulumi.Bool(false),
    				RunIntentAnnotator:        pulumi.Bool(false),
    				RunIssueModelAnnotator:    pulumi.Bool(false),
    				RunPhraseMatcherAnnotator: pulumi.Bool(false),
    				RunQaAnnotator:            pulumi.Bool(false),
    				RunSentimentAnnotator:     pulumi.Bool(false),
    				RunSilenceAnnotator:       pulumi.Bool(true),
    				RunSummarizationAnnotator: pulumi.Bool(false),
    				SummarizationConfig: &contactcenterinsights.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs{
    					ConversationProfile: pulumi.String("projects/1111111111111/locations/us-central1/conversationProfiles/some_conversation_profile"),
    				},
    			},
    			AnalysisPercentage: pulumi.Float64(0.5),
    			Active:             pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var analysisRuleProfile = new Gcp.ContactCenterInsights.AnalysisRule("analysis_rule_profile", new()
        {
            Location = "us-central1",
            DisplayName = "analysis-rule-display-name",
            ConversationFilter = "agent_id = \"1\"",
            AnnotatorSelector = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorArgs
            {
                RunInterruptionAnnotator = false,
                IssueModels = new[]
                {
                    "projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id",
                },
                PhraseMatchers = new[]
                {
                    "projects/1111111111111/locations/us-central1/phraseMatchers/123",
                },
                QaConfig = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorQaConfigArgs
                {
                    ScorecardList = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs
                    {
                        QaScorecardRevisions = new[]
                        {
                            "projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id",
                        },
                    },
                },
                RunEntityAnnotator = false,
                RunIntentAnnotator = false,
                RunIssueModelAnnotator = false,
                RunPhraseMatcherAnnotator = false,
                RunQaAnnotator = false,
                RunSentimentAnnotator = false,
                RunSilenceAnnotator = true,
                RunSummarizationAnnotator = false,
                SummarizationConfig = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs
                {
                    ConversationProfile = "projects/1111111111111/locations/us-central1/conversationProfiles/some_conversation_profile",
                },
            },
            AnalysisPercentage = 0.5,
            Active = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.contactcenterinsights.AnalysisRule;
    import com.pulumi.gcp.contactcenterinsights.AnalysisRuleArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorQaConfigArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs;
    import com.pulumi.gcp.contactcenterinsights.inputs.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var analysisRuleProfile = new AnalysisRule("analysisRuleProfile", AnalysisRuleArgs.builder()
                .location("us-central1")
                .displayName("analysis-rule-display-name")
                .conversationFilter("agent_id = \"1\"")
                .annotatorSelector(AnalysisRuleAnnotatorSelectorArgs.builder()
                    .runInterruptionAnnotator(false)
                    .issueModels("projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id")
                    .phraseMatchers("projects/1111111111111/locations/us-central1/phraseMatchers/123")
                    .qaConfig(AnalysisRuleAnnotatorSelectorQaConfigArgs.builder()
                        .scorecardList(AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs.builder()
                            .qaScorecardRevisions("projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id")
                            .build())
                        .build())
                    .runEntityAnnotator(false)
                    .runIntentAnnotator(false)
                    .runIssueModelAnnotator(false)
                    .runPhraseMatcherAnnotator(false)
                    .runQaAnnotator(false)
                    .runSentimentAnnotator(false)
                    .runSilenceAnnotator(true)
                    .runSummarizationAnnotator(false)
                    .summarizationConfig(AnalysisRuleAnnotatorSelectorSummarizationConfigArgs.builder()
                        .conversationProfile("projects/1111111111111/locations/us-central1/conversationProfiles/some_conversation_profile")
                        .build())
                    .build())
                .analysisPercentage(0.5)
                .active(true)
                .build());
    
        }
    }
    
    resources:
      analysisRuleProfile:
        type: gcp:contactcenterinsights:AnalysisRule
        name: analysis_rule_profile
        properties:
          location: us-central1
          displayName: analysis-rule-display-name
          conversationFilter: agent_id = "1"
          annotatorSelector:
            runInterruptionAnnotator: false
            issueModels:
              - projects/1111111111111/locations/us-central1/issueModels/some_issue_model_id
            phraseMatchers:
              - projects/1111111111111/locations/us-central1/phraseMatchers/123
            qaConfig:
              scorecardList:
                qaScorecardRevisions:
                  - projects/1111111111111/locations/us-central1/qaScorecards/*/revisions/some_scorecard_revision_id
            runEntityAnnotator: false
            runIntentAnnotator: false
            runIssueModelAnnotator: false
            runPhraseMatcherAnnotator: false
            runQaAnnotator: false
            runSentimentAnnotator: false
            runSilenceAnnotator: true
            runSummarizationAnnotator: false
            summarizationConfig:
              conversationProfile: projects/1111111111111/locations/us-central1/conversationProfiles/some_conversation_profile
          analysisPercentage: 0.5
          active: true
    

    Create AnalysisRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AnalysisRule(name: string, args: AnalysisRuleArgs, opts?: CustomResourceOptions);
    @overload
    def AnalysisRule(resource_name: str,
                     args: AnalysisRuleArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def AnalysisRule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     location: Optional[str] = None,
                     active: Optional[bool] = None,
                     analysis_percentage: Optional[float] = None,
                     annotator_selector: Optional[AnalysisRuleAnnotatorSelectorArgs] = None,
                     conversation_filter: Optional[str] = None,
                     display_name: Optional[str] = None,
                     project: Optional[str] = None)
    func NewAnalysisRule(ctx *Context, name string, args AnalysisRuleArgs, opts ...ResourceOption) (*AnalysisRule, error)
    public AnalysisRule(string name, AnalysisRuleArgs args, CustomResourceOptions? opts = null)
    public AnalysisRule(String name, AnalysisRuleArgs args)
    public AnalysisRule(String name, AnalysisRuleArgs args, CustomResourceOptions options)
    
    type: gcp:contactcenterinsights:AnalysisRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AnalysisRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AnalysisRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AnalysisRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnalysisRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnalysisRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var analysisRuleResource = new Gcp.ContactCenterInsights.AnalysisRule("analysisRuleResource", new()
    {
        Location = "string",
        Active = false,
        AnalysisPercentage = 0,
        AnnotatorSelector = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorArgs
        {
            IssueModels = new[]
            {
                "string",
            },
            PhraseMatchers = new[]
            {
                "string",
            },
            QaConfig = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorQaConfigArgs
            {
                ScorecardList = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs
                {
                    QaScorecardRevisions = new[]
                    {
                        "string",
                    },
                },
            },
            RunEntityAnnotator = false,
            RunIntentAnnotator = false,
            RunInterruptionAnnotator = false,
            RunIssueModelAnnotator = false,
            RunPhraseMatcherAnnotator = false,
            RunQaAnnotator = false,
            RunSentimentAnnotator = false,
            RunSilenceAnnotator = false,
            RunSummarizationAnnotator = false,
            SummarizationConfig = new Gcp.ContactCenterInsights.Inputs.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs
            {
                ConversationProfile = "string",
                SummarizationModel = "string",
            },
        },
        ConversationFilter = "string",
        DisplayName = "string",
        Project = "string",
    });
    
    example, err := contactcenterinsights.NewAnalysisRule(ctx, "analysisRuleResource", &contactcenterinsights.AnalysisRuleArgs{
    	Location:           pulumi.String("string"),
    	Active:             pulumi.Bool(false),
    	AnalysisPercentage: pulumi.Float64(0),
    	AnnotatorSelector: &contactcenterinsights.AnalysisRuleAnnotatorSelectorArgs{
    		IssueModels: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PhraseMatchers: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		QaConfig: &contactcenterinsights.AnalysisRuleAnnotatorSelectorQaConfigArgs{
    			ScorecardList: &contactcenterinsights.AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs{
    				QaScorecardRevisions: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    			},
    		},
    		RunEntityAnnotator:        pulumi.Bool(false),
    		RunIntentAnnotator:        pulumi.Bool(false),
    		RunInterruptionAnnotator:  pulumi.Bool(false),
    		RunIssueModelAnnotator:    pulumi.Bool(false),
    		RunPhraseMatcherAnnotator: pulumi.Bool(false),
    		RunQaAnnotator:            pulumi.Bool(false),
    		RunSentimentAnnotator:     pulumi.Bool(false),
    		RunSilenceAnnotator:       pulumi.Bool(false),
    		RunSummarizationAnnotator: pulumi.Bool(false),
    		SummarizationConfig: &contactcenterinsights.AnalysisRuleAnnotatorSelectorSummarizationConfigArgs{
    			ConversationProfile: pulumi.String("string"),
    			SummarizationModel:  pulumi.String("string"),
    		},
    	},
    	ConversationFilter: pulumi.String("string"),
    	DisplayName:        pulumi.String("string"),
    	Project:            pulumi.String("string"),
    })
    
    var analysisRuleResource = new AnalysisRule("analysisRuleResource", AnalysisRuleArgs.builder()
        .location("string")
        .active(false)
        .analysisPercentage(0.0)
        .annotatorSelector(AnalysisRuleAnnotatorSelectorArgs.builder()
            .issueModels("string")
            .phraseMatchers("string")
            .qaConfig(AnalysisRuleAnnotatorSelectorQaConfigArgs.builder()
                .scorecardList(AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs.builder()
                    .qaScorecardRevisions("string")
                    .build())
                .build())
            .runEntityAnnotator(false)
            .runIntentAnnotator(false)
            .runInterruptionAnnotator(false)
            .runIssueModelAnnotator(false)
            .runPhraseMatcherAnnotator(false)
            .runQaAnnotator(false)
            .runSentimentAnnotator(false)
            .runSilenceAnnotator(false)
            .runSummarizationAnnotator(false)
            .summarizationConfig(AnalysisRuleAnnotatorSelectorSummarizationConfigArgs.builder()
                .conversationProfile("string")
                .summarizationModel("string")
                .build())
            .build())
        .conversationFilter("string")
        .displayName("string")
        .project("string")
        .build());
    
    analysis_rule_resource = gcp.contactcenterinsights.AnalysisRule("analysisRuleResource",
        location="string",
        active=False,
        analysis_percentage=0,
        annotator_selector={
            "issue_models": ["string"],
            "phrase_matchers": ["string"],
            "qa_config": {
                "scorecard_list": {
                    "qa_scorecard_revisions": ["string"],
                },
            },
            "run_entity_annotator": False,
            "run_intent_annotator": False,
            "run_interruption_annotator": False,
            "run_issue_model_annotator": False,
            "run_phrase_matcher_annotator": False,
            "run_qa_annotator": False,
            "run_sentiment_annotator": False,
            "run_silence_annotator": False,
            "run_summarization_annotator": False,
            "summarization_config": {
                "conversation_profile": "string",
                "summarization_model": "string",
            },
        },
        conversation_filter="string",
        display_name="string",
        project="string")
    
    const analysisRuleResource = new gcp.contactcenterinsights.AnalysisRule("analysisRuleResource", {
        location: "string",
        active: false,
        analysisPercentage: 0,
        annotatorSelector: {
            issueModels: ["string"],
            phraseMatchers: ["string"],
            qaConfig: {
                scorecardList: {
                    qaScorecardRevisions: ["string"],
                },
            },
            runEntityAnnotator: false,
            runIntentAnnotator: false,
            runInterruptionAnnotator: false,
            runIssueModelAnnotator: false,
            runPhraseMatcherAnnotator: false,
            runQaAnnotator: false,
            runSentimentAnnotator: false,
            runSilenceAnnotator: false,
            runSummarizationAnnotator: false,
            summarizationConfig: {
                conversationProfile: "string",
                summarizationModel: "string",
            },
        },
        conversationFilter: "string",
        displayName: "string",
        project: "string",
    });
    
    type: gcp:contactcenterinsights:AnalysisRule
    properties:
        active: false
        analysisPercentage: 0
        annotatorSelector:
            issueModels:
                - string
            phraseMatchers:
                - string
            qaConfig:
                scorecardList:
                    qaScorecardRevisions:
                        - string
            runEntityAnnotator: false
            runIntentAnnotator: false
            runInterruptionAnnotator: false
            runIssueModelAnnotator: false
            runPhraseMatcherAnnotator: false
            runQaAnnotator: false
            runSentimentAnnotator: false
            runSilenceAnnotator: false
            runSummarizationAnnotator: false
            summarizationConfig:
                conversationProfile: string
                summarizationModel: string
        conversationFilter: string
        displayName: string
        location: string
        project: string
    

    AnalysisRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AnalysisRule resource accepts the following input properties:

    Location string
    Location of the resource.
    Active bool
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    AnalysisPercentage double
    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.
    AnnotatorSelector AnalysisRuleAnnotatorSelector
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    ConversationFilter string
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    DisplayName string
    Display Name of the analysis rule.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Location string
    Location of the resource.
    Active bool
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    AnalysisPercentage float64
    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.
    AnnotatorSelector AnalysisRuleAnnotatorSelectorArgs
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    ConversationFilter string
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    DisplayName string
    Display Name of the analysis rule.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Location of the resource.
    active Boolean
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    analysisPercentage Double
    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.
    annotatorSelector AnalysisRuleAnnotatorSelector
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversationFilter String
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    displayName String
    Display Name of the analysis rule.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    Location of the resource.
    active boolean
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    analysisPercentage number
    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.
    annotatorSelector AnalysisRuleAnnotatorSelector
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversationFilter string
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    displayName string
    Display Name of the analysis rule.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location str
    Location of the resource.
    active bool
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    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.
    annotator_selector AnalysisRuleAnnotatorSelectorArgs
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversation_filter str
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    display_name str
    Display Name of the analysis rule.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Location of the resource.
    active Boolean
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    analysisPercentage Number
    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.
    annotatorSelector Property Map
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversationFilter String
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    displayName String
    Display Name of the analysis rule.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AnalysisRule resource produces the following output properties:

    CreateTime string
    Output only. The time at which this analysis rule was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the analysis rule. Randomly generated by Insights.
    UpdateTime string
    Output only. The most recent time at which this analysis rule was updated.
    CreateTime string
    Output only. The time at which this analysis rule was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the analysis rule. Randomly generated by Insights.
    UpdateTime string
    Output only. The most recent time at which this analysis rule was updated.
    createTime String
    Output only. The time at which this analysis rule was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the analysis rule. Randomly generated by Insights.
    updateTime String
    Output only. The most recent time at which this analysis rule was updated.
    createTime string
    Output only. The time at which this analysis rule was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the analysis rule. Randomly generated by Insights.
    updateTime string
    Output only. The most recent time at which this analysis rule was updated.
    create_time str
    Output only. The time at which this analysis rule was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the analysis rule. Randomly generated by Insights.
    update_time str
    Output only. The most recent time at which this analysis rule was updated.
    createTime String
    Output only. The time at which this analysis rule was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the analysis rule. Randomly generated by Insights.
    updateTime String
    Output only. The most recent time at which this analysis rule was updated.

    Look up Existing AnalysisRule Resource

    Get an existing AnalysisRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AnalysisRuleState, opts?: CustomResourceOptions): AnalysisRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            analysis_percentage: Optional[float] = None,
            annotator_selector: Optional[AnalysisRuleAnnotatorSelectorArgs] = None,
            conversation_filter: Optional[str] = None,
            create_time: Optional[str] = None,
            display_name: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            update_time: Optional[str] = None) -> AnalysisRule
    func GetAnalysisRule(ctx *Context, name string, id IDInput, state *AnalysisRuleState, opts ...ResourceOption) (*AnalysisRule, error)
    public static AnalysisRule Get(string name, Input<string> id, AnalysisRuleState? state, CustomResourceOptions? opts = null)
    public static AnalysisRule get(String name, Output<String> id, AnalysisRuleState state, CustomResourceOptions options)
    resources:  _:    type: gcp:contactcenterinsights:AnalysisRule    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Active bool
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    AnalysisPercentage double
    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.
    AnnotatorSelector AnalysisRuleAnnotatorSelector
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    ConversationFilter string
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    CreateTime string
    Output only. The time at which this analysis rule was created.
    DisplayName string
    Display Name of the analysis rule.
    Location string
    Location of the resource.
    Name string
    The resource name of the analysis rule. Randomly generated by Insights.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    Output only. The most recent time at which this analysis rule was updated.
    Active bool
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    AnalysisPercentage float64
    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.
    AnnotatorSelector AnalysisRuleAnnotatorSelectorArgs
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    ConversationFilter string
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    CreateTime string
    Output only. The time at which this analysis rule was created.
    DisplayName string
    Display Name of the analysis rule.
    Location string
    Location of the resource.
    Name string
    The resource name of the analysis rule. Randomly generated by Insights.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    Output only. The most recent time at which this analysis rule was updated.
    active Boolean
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    analysisPercentage Double
    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.
    annotatorSelector AnalysisRuleAnnotatorSelector
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversationFilter String
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    createTime String
    Output only. The time at which this analysis rule was created.
    displayName String
    Display Name of the analysis rule.
    location String
    Location of the resource.
    name String
    The resource name of the analysis rule. Randomly generated by Insights.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    Output only. The most recent time at which this analysis rule was updated.
    active boolean
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    analysisPercentage number
    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.
    annotatorSelector AnalysisRuleAnnotatorSelector
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversationFilter string
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    createTime string
    Output only. The time at which this analysis rule was created.
    displayName string
    Display Name of the analysis rule.
    location string
    Location of the resource.
    name string
    The resource name of the analysis rule. Randomly generated by Insights.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime string
    Output only. The most recent time at which this analysis rule was updated.
    active bool
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    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.
    annotator_selector AnalysisRuleAnnotatorSelectorArgs
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversation_filter str
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    create_time str
    Output only. The time at which this analysis rule was created.
    display_name str
    Display Name of the analysis rule.
    location str
    Location of the resource.
    name str
    The resource name of the analysis rule. Randomly generated by Insights.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    update_time str
    Output only. The most recent time at which this analysis rule was updated.
    active Boolean
    If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
    analysisPercentage Number
    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.
    annotatorSelector Property Map
    Selector of all available annotators and phrase matchers to run. Structure is documented below.
    conversationFilter String
    Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.
    createTime String
    Output only. The time at which this analysis rule was created.
    displayName String
    Display Name of the analysis rule.
    location String
    Location of the resource.
    name String
    The resource name of the analysis rule. Randomly generated by Insights.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    Output only. The most recent time at which this analysis rule was updated.

    Supporting Types

    AnalysisRuleAnnotatorSelector, AnalysisRuleAnnotatorSelectorArgs

    IssueModels List<string>
    The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
    PhraseMatchers List<string>
    The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    QaConfig AnalysisRuleAnnotatorSelectorQaConfig
    Configuration for the QA feature. Structure is documented below.
    RunEntityAnnotator bool
    Whether to run the entity annotator.
    RunIntentAnnotator bool
    Whether to run the intent annotator.
    RunInterruptionAnnotator bool
    Whether to run the interruption annotator.
    RunIssueModelAnnotator bool
    Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
    RunPhraseMatcherAnnotator bool
    Whether to run the active phrase matcher annotator(s).
    RunQaAnnotator bool
    Whether to run the QA annotator.
    RunSentimentAnnotator bool
    Whether to run the sentiment annotator.
    RunSilenceAnnotator bool
    Whether to run the silence annotator.
    RunSummarizationAnnotator bool
    Whether to run the summarization annotator.
    SummarizationConfig AnalysisRuleAnnotatorSelectorSummarizationConfig
    Configuration for summarization. Structure is documented below.
    IssueModels []string
    The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
    PhraseMatchers []string
    The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    QaConfig AnalysisRuleAnnotatorSelectorQaConfig
    Configuration for the QA feature. Structure is documented below.
    RunEntityAnnotator bool
    Whether to run the entity annotator.
    RunIntentAnnotator bool
    Whether to run the intent annotator.
    RunInterruptionAnnotator bool
    Whether to run the interruption annotator.
    RunIssueModelAnnotator bool
    Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
    RunPhraseMatcherAnnotator bool
    Whether to run the active phrase matcher annotator(s).
    RunQaAnnotator bool
    Whether to run the QA annotator.
    RunSentimentAnnotator bool
    Whether to run the sentiment annotator.
    RunSilenceAnnotator bool
    Whether to run the silence annotator.
    RunSummarizationAnnotator bool
    Whether to run the summarization annotator.
    SummarizationConfig AnalysisRuleAnnotatorSelectorSummarizationConfig
    Configuration for summarization. Structure is documented below.
    issueModels List<String>
    The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
    phraseMatchers List<String>
    The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    qaConfig AnalysisRuleAnnotatorSelectorQaConfig
    Configuration for the QA feature. Structure is documented below.
    runEntityAnnotator Boolean
    Whether to run the entity annotator.
    runIntentAnnotator Boolean
    Whether to run the intent annotator.
    runInterruptionAnnotator Boolean
    Whether to run the interruption annotator.
    runIssueModelAnnotator Boolean
    Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
    runPhraseMatcherAnnotator Boolean
    Whether to run the active phrase matcher annotator(s).
    runQaAnnotator Boolean
    Whether to run the QA annotator.
    runSentimentAnnotator Boolean
    Whether to run the sentiment annotator.
    runSilenceAnnotator Boolean
    Whether to run the silence annotator.
    runSummarizationAnnotator Boolean
    Whether to run the summarization annotator.
    summarizationConfig AnalysisRuleAnnotatorSelectorSummarizationConfig
    Configuration for summarization. Structure is documented below.
    issueModels string[]
    The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
    phraseMatchers string[]
    The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    qaConfig AnalysisRuleAnnotatorSelectorQaConfig
    Configuration for the QA feature. Structure is documented below.
    runEntityAnnotator boolean
    Whether to run the entity annotator.
    runIntentAnnotator boolean
    Whether to run the intent annotator.
    runInterruptionAnnotator boolean
    Whether to run the interruption annotator.
    runIssueModelAnnotator boolean
    Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
    runPhraseMatcherAnnotator boolean
    Whether to run the active phrase matcher annotator(s).
    runQaAnnotator boolean
    Whether to run the QA annotator.
    runSentimentAnnotator boolean
    Whether to run the sentiment annotator.
    runSilenceAnnotator boolean
    Whether to run the silence annotator.
    runSummarizationAnnotator boolean
    Whether to run the summarization annotator.
    summarizationConfig AnalysisRuleAnnotatorSelectorSummarizationConfig
    Configuration for summarization. Structure is documented below.
    issue_models Sequence[str]
    The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
    phrase_matchers Sequence[str]
    The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    qa_config AnalysisRuleAnnotatorSelectorQaConfig
    Configuration for the QA feature. Structure is documented below.
    run_entity_annotator bool
    Whether to run the entity annotator.
    run_intent_annotator bool
    Whether to run the intent annotator.
    run_interruption_annotator bool
    Whether to run the interruption annotator.
    run_issue_model_annotator bool
    Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
    run_phrase_matcher_annotator bool
    Whether to run the active phrase matcher annotator(s).
    run_qa_annotator bool
    Whether to run the QA annotator.
    run_sentiment_annotator bool
    Whether to run the sentiment annotator.
    run_silence_annotator bool
    Whether to run the silence annotator.
    run_summarization_annotator bool
    Whether to run the summarization annotator.
    summarization_config AnalysisRuleAnnotatorSelectorSummarizationConfig
    Configuration for summarization. Structure is documented below.
    issueModels List<String>
    The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
    phraseMatchers List<String>
    The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
    qaConfig Property Map
    Configuration for the QA feature. Structure is documented below.
    runEntityAnnotator Boolean
    Whether to run the entity annotator.
    runIntentAnnotator Boolean
    Whether to run the intent annotator.
    runInterruptionAnnotator Boolean
    Whether to run the interruption annotator.
    runIssueModelAnnotator Boolean
    Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
    runPhraseMatcherAnnotator Boolean
    Whether to run the active phrase matcher annotator(s).
    runQaAnnotator Boolean
    Whether to run the QA annotator.
    runSentimentAnnotator Boolean
    Whether to run the sentiment annotator.
    runSilenceAnnotator Boolean
    Whether to run the silence annotator.
    runSummarizationAnnotator Boolean
    Whether to run the summarization annotator.
    summarizationConfig Property Map
    Configuration for summarization. Structure is documented below.

    AnalysisRuleAnnotatorSelectorQaConfig, AnalysisRuleAnnotatorSelectorQaConfigArgs

    ScorecardList AnalysisRuleAnnotatorSelectorQaConfigScorecardList
    Container for a list of scorecards. Structure is documented below.
    ScorecardList AnalysisRuleAnnotatorSelectorQaConfigScorecardList
    Container for a list of scorecards. Structure is documented below.
    scorecardList AnalysisRuleAnnotatorSelectorQaConfigScorecardList
    Container for a list of scorecards. Structure is documented below.
    scorecardList AnalysisRuleAnnotatorSelectorQaConfigScorecardList
    Container for a list of scorecards. Structure is documented below.
    scorecard_list AnalysisRuleAnnotatorSelectorQaConfigScorecardList
    Container for a list of scorecards. Structure is documented below.
    scorecardList Property Map
    Container for a list of scorecards. Structure is documented below.

    AnalysisRuleAnnotatorSelectorQaConfigScorecardList, AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs

    QaScorecardRevisions List<string>
    List of QaScorecardRevisions.
    QaScorecardRevisions []string
    List of QaScorecardRevisions.
    qaScorecardRevisions List<String>
    List of QaScorecardRevisions.
    qaScorecardRevisions string[]
    List of QaScorecardRevisions.
    qa_scorecard_revisions Sequence[str]
    List of QaScorecardRevisions.
    qaScorecardRevisions List<String>
    List of QaScorecardRevisions.

    AnalysisRuleAnnotatorSelectorSummarizationConfig, AnalysisRuleAnnotatorSelectorSummarizationConfigArgs

    ConversationProfile string
    Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
    SummarizationModel string
    Default summarization model to be used. Possible values: SUMMARIZATION_MODEL_UNSPECIFIED BASELINE_MODEL BASELINE_MODEL_V2_0 Possible values are: BASELINE_MODEL, BASELINE_MODEL_V2_0.
    ConversationProfile string
    Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
    SummarizationModel string
    Default summarization model to be used. Possible values: SUMMARIZATION_MODEL_UNSPECIFIED BASELINE_MODEL BASELINE_MODEL_V2_0 Possible values are: BASELINE_MODEL, BASELINE_MODEL_V2_0.
    conversationProfile String
    Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
    summarizationModel String
    Default summarization model to be used. Possible values: SUMMARIZATION_MODEL_UNSPECIFIED BASELINE_MODEL BASELINE_MODEL_V2_0 Possible values are: BASELINE_MODEL, BASELINE_MODEL_V2_0.
    conversationProfile string
    Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
    summarizationModel string
    Default summarization model to be used. Possible values: SUMMARIZATION_MODEL_UNSPECIFIED BASELINE_MODEL BASELINE_MODEL_V2_0 Possible values are: BASELINE_MODEL, BASELINE_MODEL_V2_0.
    conversation_profile str
    Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
    summarization_model str
    Default summarization model to be used. Possible values: SUMMARIZATION_MODEL_UNSPECIFIED BASELINE_MODEL BASELINE_MODEL_V2_0 Possible values are: BASELINE_MODEL, BASELINE_MODEL_V2_0.
    conversationProfile String
    Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
    summarizationModel String
    Default summarization model to be used. Possible values: SUMMARIZATION_MODEL_UNSPECIFIED BASELINE_MODEL BASELINE_MODEL_V2_0 Possible values are: BASELINE_MODEL, BASELINE_MODEL_V2_0.

    Import

    AnalysisRule can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/analysisRules/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

    When using the pulumi import command, AnalysisRule can be imported using one of the formats above. For example:

    $ pulumi import gcp:contactcenterinsights/analysisRule:AnalysisRule default projects/{{project}}/locations/{{location}}/analysisRules/{{name}}
    
    $ pulumi import gcp:contactcenterinsights/analysisRule:AnalysisRule default {{project}}/{{location}}/{{name}}
    
    $ pulumi import gcp:contactcenterinsights/analysisRule:AnalysisRule default {{location}}/{{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.39.0 published on Tuesday, Jul 22, 2025 by Pulumi