1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. contactcenterinsights
  5. AutoLabelingRule
Viewing docs for Google Cloud v9.16.0
published on Thursday, Mar 19, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.16.0
published on Thursday, Mar 19, 2026 by Pulumi

    The CCAI Insights project wide auto labeling rule. This rule will be applied to all conversations that match the filter defined in the rule.

    To get more information about AutoLabelingRule, see:

    Example Usage

    Create AutoLabelingRule Resource

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

    Constructor syntax

    new AutoLabelingRule(name: string, args: AutoLabelingRuleArgs, opts?: CustomResourceOptions);
    @overload
    def AutoLabelingRule(resource_name: str,
                         args: AutoLabelingRuleArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AutoLabelingRule(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         location: Optional[str] = None,
                         active: Optional[bool] = None,
                         auto_labeling_rule_id: Optional[str] = None,
                         conditions: Optional[Sequence[AutoLabelingRuleConditionArgs]] = None,
                         description: Optional[str] = None,
                         display_name: Optional[str] = None,
                         label_key: Optional[str] = None,
                         label_key_type: Optional[str] = None,
                         project: Optional[str] = None)
    func NewAutoLabelingRule(ctx *Context, name string, args AutoLabelingRuleArgs, opts ...ResourceOption) (*AutoLabelingRule, error)
    public AutoLabelingRule(string name, AutoLabelingRuleArgs args, CustomResourceOptions? opts = null)
    public AutoLabelingRule(String name, AutoLabelingRuleArgs args)
    public AutoLabelingRule(String name, AutoLabelingRuleArgs args, CustomResourceOptions options)
    
    type: gcp:contactcenterinsights:AutoLabelingRule
    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 AutoLabelingRuleArgs
    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 AutoLabelingRuleArgs
    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 AutoLabelingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AutoLabelingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AutoLabelingRuleArgs
    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 autoLabelingRuleResource = new Gcp.ContactCenterInsights.AutoLabelingRule("autoLabelingRuleResource", new()
    {
        Location = "string",
        Active = false,
        AutoLabelingRuleId = "string",
        Conditions = new[]
        {
            new Gcp.ContactCenterInsights.Inputs.AutoLabelingRuleConditionArgs
            {
                Condition = "string",
                Value = "string",
            },
        },
        Description = "string",
        DisplayName = "string",
        LabelKey = "string",
        LabelKeyType = "string",
        Project = "string",
    });
    
    example, err := contactcenterinsights.NewAutoLabelingRule(ctx, "autoLabelingRuleResource", &contactcenterinsights.AutoLabelingRuleArgs{
    	Location:           pulumi.String("string"),
    	Active:             pulumi.Bool(false),
    	AutoLabelingRuleId: pulumi.String("string"),
    	Conditions: contactcenterinsights.AutoLabelingRuleConditionArray{
    		&contactcenterinsights.AutoLabelingRuleConditionArgs{
    			Condition: pulumi.String("string"),
    			Value:     pulumi.String("string"),
    		},
    	},
    	Description:  pulumi.String("string"),
    	DisplayName:  pulumi.String("string"),
    	LabelKey:     pulumi.String("string"),
    	LabelKeyType: pulumi.String("string"),
    	Project:      pulumi.String("string"),
    })
    
    var autoLabelingRuleResource = new AutoLabelingRule("autoLabelingRuleResource", AutoLabelingRuleArgs.builder()
        .location("string")
        .active(false)
        .autoLabelingRuleId("string")
        .conditions(AutoLabelingRuleConditionArgs.builder()
            .condition("string")
            .value("string")
            .build())
        .description("string")
        .displayName("string")
        .labelKey("string")
        .labelKeyType("string")
        .project("string")
        .build());
    
    auto_labeling_rule_resource = gcp.contactcenterinsights.AutoLabelingRule("autoLabelingRuleResource",
        location="string",
        active=False,
        auto_labeling_rule_id="string",
        conditions=[{
            "condition": "string",
            "value": "string",
        }],
        description="string",
        display_name="string",
        label_key="string",
        label_key_type="string",
        project="string")
    
    const autoLabelingRuleResource = new gcp.contactcenterinsights.AutoLabelingRule("autoLabelingRuleResource", {
        location: "string",
        active: false,
        autoLabelingRuleId: "string",
        conditions: [{
            condition: "string",
            value: "string",
        }],
        description: "string",
        displayName: "string",
        labelKey: "string",
        labelKeyType: "string",
        project: "string",
    });
    
    type: gcp:contactcenterinsights:AutoLabelingRule
    properties:
        active: false
        autoLabelingRuleId: string
        conditions:
            - condition: string
              value: string
        description: string
        displayName: string
        labelKey: string
        labelKeyType: string
        location: string
        project: string
    

    AutoLabelingRule 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 AutoLabelingRule resource accepts the following input properties:

    Location string
    Location of the resource.
    Active bool
    Whether the rule is active.
    AutoLabelingRuleId string
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    Conditions List<AutoLabelingRuleCondition>
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    Description string
    The description of the rule.
    DisplayName string
    Display Name of the auto labeling rule.
    LabelKey string
    The label key.
    LabelKeyType string
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    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
    Whether the rule is active.
    AutoLabelingRuleId string
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    Conditions []AutoLabelingRuleConditionArgs
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    Description string
    The description of the rule.
    DisplayName string
    Display Name of the auto labeling rule.
    LabelKey string
    The label key.
    LabelKeyType string
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    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
    Whether the rule is active.
    autoLabelingRuleId String
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions List<AutoLabelingRuleCondition>
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    description String
    The description of the rule.
    displayName String
    Display Name of the auto labeling rule.
    labelKey String
    The label key.
    labelKeyType String
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    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
    Whether the rule is active.
    autoLabelingRuleId string
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions AutoLabelingRuleCondition[]
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    description string
    The description of the rule.
    displayName string
    Display Name of the auto labeling rule.
    labelKey string
    The label key.
    labelKeyType string
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    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
    Whether the rule is active.
    auto_labeling_rule_id str
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions Sequence[AutoLabelingRuleConditionArgs]
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    description str
    The description of the rule.
    display_name str
    Display Name of the auto labeling rule.
    label_key str
    The label key.
    label_key_type str
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    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
    Whether the rule is active.
    autoLabelingRuleId String
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions List<Property Map>
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    description String
    The description of the rule.
    displayName String
    Display Name of the auto labeling rule.
    labelKey String
    The label key.
    labelKeyType String
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    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 AutoLabelingRule resource produces the following output properties:

    CreateTime string
    The time at which this rule was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    UpdateTime string
    The most recent time at which this rule was updated.
    CreateTime string
    The time at which this rule was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    UpdateTime string
    The most recent time at which this rule was updated.
    createTime String
    The time at which this rule was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    updateTime String
    The most recent time at which this rule was updated.
    createTime string
    The time at which this rule was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    updateTime string
    The most recent time at which this rule was updated.
    create_time str
    The time at which this rule was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    update_time str
    The most recent time at which this rule was updated.
    createTime String
    The time at which this rule was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    updateTime String
    The most recent time at which this rule was updated.

    Look up Existing AutoLabelingRule Resource

    Get an existing AutoLabelingRule 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?: AutoLabelingRuleState, opts?: CustomResourceOptions): AutoLabelingRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            auto_labeling_rule_id: Optional[str] = None,
            conditions: Optional[Sequence[AutoLabelingRuleConditionArgs]] = None,
            create_time: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            label_key: Optional[str] = None,
            label_key_type: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            update_time: Optional[str] = None) -> AutoLabelingRule
    func GetAutoLabelingRule(ctx *Context, name string, id IDInput, state *AutoLabelingRuleState, opts ...ResourceOption) (*AutoLabelingRule, error)
    public static AutoLabelingRule Get(string name, Input<string> id, AutoLabelingRuleState? state, CustomResourceOptions? opts = null)
    public static AutoLabelingRule get(String name, Output<String> id, AutoLabelingRuleState state, CustomResourceOptions options)
    resources:  _:    type: gcp:contactcenterinsights:AutoLabelingRule    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
    Whether the rule is active.
    AutoLabelingRuleId string
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    Conditions List<AutoLabelingRuleCondition>
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    CreateTime string
    The time at which this rule was created.
    Description string
    The description of the rule.
    DisplayName string
    Display Name of the auto labeling rule.
    LabelKey string
    The label key.
    LabelKeyType string
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    Location string
    Location of the resource.
    Name string
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    The most recent time at which this rule was updated.
    Active bool
    Whether the rule is active.
    AutoLabelingRuleId string
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    Conditions []AutoLabelingRuleConditionArgs
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    CreateTime string
    The time at which this rule was created.
    Description string
    The description of the rule.
    DisplayName string
    Display Name of the auto labeling rule.
    LabelKey string
    The label key.
    LabelKeyType string
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    Location string
    Location of the resource.
    Name string
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    The most recent time at which this rule was updated.
    active Boolean
    Whether the rule is active.
    autoLabelingRuleId String
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions List<AutoLabelingRuleCondition>
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    createTime String
    The time at which this rule was created.
    description String
    The description of the rule.
    displayName String
    Display Name of the auto labeling rule.
    labelKey String
    The label key.
    labelKeyType String
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    location String
    Location of the resource.
    name String
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    The most recent time at which this rule was updated.
    active boolean
    Whether the rule is active.
    autoLabelingRuleId string
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions AutoLabelingRuleCondition[]
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    createTime string
    The time at which this rule was created.
    description string
    The description of the rule.
    displayName string
    Display Name of the auto labeling rule.
    labelKey string
    The label key.
    labelKeyType string
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    location string
    Location of the resource.
    name string
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime string
    The most recent time at which this rule was updated.
    active bool
    Whether the rule is active.
    auto_labeling_rule_id str
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions Sequence[AutoLabelingRuleConditionArgs]
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    create_time str
    The time at which this rule was created.
    description str
    The description of the rule.
    display_name str
    Display Name of the auto labeling rule.
    label_key str
    The label key.
    label_key_type str
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    location str
    Location of the resource.
    name str
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    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
    The most recent time at which this rule was updated.
    active Boolean
    Whether the rule is active.
    autoLabelingRuleId String
    A unique ID for the new AutoLabelingRule. This ID will become the final component of the AutoLabelingRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[A-Za-z0-9]{4,64}$.
    conditions List<Property Map>
    Conditions to apply for auto-labeling the label_key. Structure is documented below.
    createTime String
    The time at which this rule was created.
    description String
    The description of the rule.
    displayName String
    Display Name of the auto labeling rule.
    labelKey String
    The label key.
    labelKeyType String
    The type of the label key. Possible values are: LABEL_KEY_TYPE_UNSPECIFIED, LABEL_KEY_TYPE_CUSTOM.
    location String
    Location of the resource.
    name String
    Identifier. The resource name of the auto labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    The most recent time at which this rule was updated.

    Supporting Types

    AutoLabelingRuleCondition, AutoLabelingRuleConditionArgs

    Condition string
    A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
    Value string
    CEL expression to be evaluated as the value.
    Condition string
    A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
    Value string
    CEL expression to be evaluated as the value.
    condition String
    A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
    value String
    CEL expression to be evaluated as the value.
    condition string
    A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
    value string
    CEL expression to be evaluated as the value.
    condition str
    A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
    value str
    CEL expression to be evaluated as the value.
    condition String
    A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.
    value String
    CEL expression to be evaluated as the value.

    Import

    AutoLabelingRule can be imported using any of these accepted formats:

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

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

    $ pulumi import gcp:contactcenterinsights/autoLabelingRule:AutoLabelingRule default projects/{{project}}/locations/{{location}}/autoLabelingRules/{{name}}
    $ pulumi import gcp:contactcenterinsights/autoLabelingRule:AutoLabelingRule default {{project}}/{{location}}/{{name}}
    $ pulumi import gcp:contactcenterinsights/autoLabelingRule:AutoLabelingRule 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
    Viewing docs for Google Cloud v9.16.0
    published on Thursday, Mar 19, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.