gcp.contactcenterinsights.AnalysisRule
Explore with Pulumi AI
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.
- Analysis
Percentage 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.
- Annotator
Selector AnalysisRule Annotator Selector - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- Conversation
Filter 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.
- Display
Name 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.
- Analysis
Percentage 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.
- Annotator
Selector AnalysisRule Annotator Selector Args - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- Conversation
Filter 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.
- Display
Name 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.
- analysis
Percentage 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.
- annotator
Selector AnalysisRule Annotator Selector - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- conversation
Filter 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.
- display
Name 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.
- analysis
Percentage 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.
- annotator
Selector AnalysisRule Annotator Selector - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- conversation
Filter 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.
- display
Name 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 AnalysisRule Annotator Selector Args - 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.
- analysis
Percentage 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.
- annotator
Selector Property Map - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- conversation
Filter 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.
- display
Name 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:
- Create
Time 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.
- Update
Time string - Output only. The most recent time at which this analysis rule was updated.
- Create
Time 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.
- Update
Time string - Output only. The most recent time at which this analysis rule was updated.
- create
Time 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.
- update
Time String - Output only. The most recent time at which this analysis rule was updated.
- create
Time 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.
- update
Time 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.
- create
Time 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.
- update
Time 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.
- Active bool
- If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
- Analysis
Percentage 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.
- Annotator
Selector AnalysisRule Annotator Selector - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- Conversation
Filter 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.
- Create
Time string - Output only. The time at which this analysis rule was created.
- Display
Name 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.
- Update
Time 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 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.
- Annotator
Selector AnalysisRule Annotator Selector Args - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- Conversation
Filter 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.
- Create
Time string - Output only. The time at which this analysis rule was created.
- Display
Name 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.
- Update
Time 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.
- analysis
Percentage 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.
- annotator
Selector AnalysisRule Annotator Selector - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- conversation
Filter 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.
- create
Time String - Output only. The time at which this analysis rule was created.
- display
Name 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.
- update
Time 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.
- analysis
Percentage 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.
- annotator
Selector AnalysisRule Annotator Selector - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- conversation
Filter 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.
- create
Time string - Output only. The time at which this analysis rule was created.
- display
Name 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.
- update
Time 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 AnalysisRule Annotator Selector Args - 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.
- analysis
Percentage 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.
- annotator
Selector Property Map - Selector of all available annotators and phrase matchers to run. Structure is documented below.
- conversation
Filter 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.
- create
Time String - Output only. The time at which this analysis rule was created.
- display
Name 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.
- update
Time String - Output only. The most recent time at which this analysis rule was updated.
Supporting Types
AnalysisRuleAnnotatorSelector, AnalysisRuleAnnotatorSelectorArgs
- Issue
Models 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.
- Phrase
Matchers 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}
- Qa
Config AnalysisRule Annotator Selector Qa Config - Configuration for the QA feature. Structure is documented below.
- Run
Entity boolAnnotator - Whether to run the entity annotator.
- Run
Intent boolAnnotator - Whether to run the intent annotator.
- Run
Interruption boolAnnotator - Whether to run the interruption annotator.
- Run
Issue boolModel Annotator - Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
- Run
Phrase boolMatcher Annotator - Whether to run the active phrase matcher annotator(s).
- Run
Qa boolAnnotator - Whether to run the QA annotator.
- Run
Sentiment boolAnnotator - Whether to run the sentiment annotator.
- Run
Silence boolAnnotator - Whether to run the silence annotator.
- Run
Summarization boolAnnotator - Whether to run the summarization annotator.
- Summarization
Config AnalysisRule Annotator Selector Summarization Config - Configuration for summarization. Structure is documented below.
- Issue
Models []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.
- Phrase
Matchers []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}
- Qa
Config AnalysisRule Annotator Selector Qa Config - Configuration for the QA feature. Structure is documented below.
- Run
Entity boolAnnotator - Whether to run the entity annotator.
- Run
Intent boolAnnotator - Whether to run the intent annotator.
- Run
Interruption boolAnnotator - Whether to run the interruption annotator.
- Run
Issue boolModel Annotator - Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
- Run
Phrase boolMatcher Annotator - Whether to run the active phrase matcher annotator(s).
- Run
Qa boolAnnotator - Whether to run the QA annotator.
- Run
Sentiment boolAnnotator - Whether to run the sentiment annotator.
- Run
Silence boolAnnotator - Whether to run the silence annotator.
- Run
Summarization boolAnnotator - Whether to run the summarization annotator.
- Summarization
Config AnalysisRule Annotator Selector Summarization Config - Configuration for summarization. Structure is documented below.
- issue
Models 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.
- phrase
Matchers 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}
- qa
Config AnalysisRule Annotator Selector Qa Config - Configuration for the QA feature. Structure is documented below.
- run
Entity BooleanAnnotator - Whether to run the entity annotator.
- run
Intent BooleanAnnotator - Whether to run the intent annotator.
- run
Interruption BooleanAnnotator - Whether to run the interruption annotator.
- run
Issue BooleanModel Annotator - Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
- run
Phrase BooleanMatcher Annotator - Whether to run the active phrase matcher annotator(s).
- run
Qa BooleanAnnotator - Whether to run the QA annotator.
- run
Sentiment BooleanAnnotator - Whether to run the sentiment annotator.
- run
Silence BooleanAnnotator - Whether to run the silence annotator.
- run
Summarization BooleanAnnotator - Whether to run the summarization annotator.
- summarization
Config AnalysisRule Annotator Selector Summarization Config - Configuration for summarization. Structure is documented below.
- issue
Models 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.
- phrase
Matchers 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}
- qa
Config AnalysisRule Annotator Selector Qa Config - Configuration for the QA feature. Structure is documented below.
- run
Entity booleanAnnotator - Whether to run the entity annotator.
- run
Intent booleanAnnotator - Whether to run the intent annotator.
- run
Interruption booleanAnnotator - Whether to run the interruption annotator.
- run
Issue booleanModel Annotator - Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
- run
Phrase booleanMatcher Annotator - Whether to run the active phrase matcher annotator(s).
- run
Qa booleanAnnotator - Whether to run the QA annotator.
- run
Sentiment booleanAnnotator - Whether to run the sentiment annotator.
- run
Silence booleanAnnotator - Whether to run the silence annotator.
- run
Summarization booleanAnnotator - Whether to run the summarization annotator.
- summarization
Config AnalysisRule Annotator Selector Summarization Config - 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 AnalysisRule Annotator Selector Qa Config - Configuration for the QA feature. Structure is documented below.
- run_
entity_ boolannotator - Whether to run the entity annotator.
- run_
intent_ boolannotator - Whether to run the intent annotator.
- run_
interruption_ boolannotator - Whether to run the interruption annotator.
- run_
issue_ boolmodel_ annotator - Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
- run_
phrase_ boolmatcher_ annotator - Whether to run the active phrase matcher annotator(s).
- run_
qa_ boolannotator - Whether to run the QA annotator.
- run_
sentiment_ boolannotator - Whether to run the sentiment annotator.
- run_
silence_ boolannotator - Whether to run the silence annotator.
- run_
summarization_ boolannotator - Whether to run the summarization annotator.
- summarization_
config AnalysisRule Annotator Selector Summarization Config - Configuration for summarization. Structure is documented below.
- issue
Models 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.
- phrase
Matchers 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}
- qa
Config Property Map - Configuration for the QA feature. Structure is documented below.
- run
Entity BooleanAnnotator - Whether to run the entity annotator.
- run
Intent BooleanAnnotator - Whether to run the intent annotator.
- run
Interruption BooleanAnnotator - Whether to run the interruption annotator.
- run
Issue BooleanModel Annotator - Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
- run
Phrase BooleanMatcher Annotator - Whether to run the active phrase matcher annotator(s).
- run
Qa BooleanAnnotator - Whether to run the QA annotator.
- run
Sentiment BooleanAnnotator - Whether to run the sentiment annotator.
- run
Silence BooleanAnnotator - Whether to run the silence annotator.
- run
Summarization BooleanAnnotator - Whether to run the summarization annotator.
- summarization
Config Property Map - Configuration for summarization. Structure is documented below.
AnalysisRuleAnnotatorSelectorQaConfig, AnalysisRuleAnnotatorSelectorQaConfigArgs
- Scorecard
List AnalysisRule Annotator Selector Qa Config Scorecard List - Container for a list of scorecards. Structure is documented below.
- Scorecard
List AnalysisRule Annotator Selector Qa Config Scorecard List - Container for a list of scorecards. Structure is documented below.
- scorecard
List AnalysisRule Annotator Selector Qa Config Scorecard List - Container for a list of scorecards. Structure is documented below.
- scorecard
List AnalysisRule Annotator Selector Qa Config Scorecard List - Container for a list of scorecards. Structure is documented below.
- scorecard_
list AnalysisRule Annotator Selector Qa Config Scorecard List - Container for a list of scorecards. Structure is documented below.
- scorecard
List Property Map - Container for a list of scorecards. Structure is documented below.
AnalysisRuleAnnotatorSelectorQaConfigScorecardList, AnalysisRuleAnnotatorSelectorQaConfigScorecardListArgs
- Qa
Scorecard List<string>Revisions - List of QaScorecardRevisions.
- Qa
Scorecard []stringRevisions - List of QaScorecardRevisions.
- qa
Scorecard List<String>Revisions - List of QaScorecardRevisions.
- qa
Scorecard string[]Revisions - List of QaScorecardRevisions.
- qa_
scorecard_ Sequence[str]revisions - List of QaScorecardRevisions.
- qa
Scorecard List<String>Revisions - List of QaScorecardRevisions.
AnalysisRuleAnnotatorSelectorSummarizationConfig, AnalysisRuleAnnotatorSelectorSummarizationConfigArgs
- Conversation
Profile string - Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
- Summarization
Model 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 string - Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
- Summarization
Model 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 String - Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
- summarization
Model 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 string - Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
- summarization
Model 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
.
- conversation
Profile String - Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
- summarization
Model 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.