1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. CxIntent
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

gcp.diagflow.CxIntent

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

    An intent represents a user’s intent to interact with a conversational agent.

    To get more information about Intent, see:

    Example Usage

    Dialogflowcx Intent Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const agent = new gcp.diagflow.CxAgent("agent", {
        displayName: "dialogflowcx-agent",
        location: "global",
        defaultLanguageCode: "en",
        supportedLanguageCodes: [
            "fr",
            "de",
            "es",
        ],
        timeZone: "America/New_York",
        description: "Example description.",
        avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        enableStackdriverLogging: true,
        enableSpellCorrection: true,
        speechToTextSettings: {
            enableSpeechAdaptation: true,
        },
    });
    const basicIntent = new gcp.diagflow.CxIntent("basic_intent", {
        parent: agent.id,
        displayName: "Example",
        priority: 1,
        description: "Intent example",
        trainingPhrases: [{
            parts: [
                {
                    text: "training",
                },
                {
                    text: "phrase",
                },
                {
                    text: "example",
                },
            ],
            repeatCount: 1,
        }],
        parameters: [{
            id: "param1",
            entityType: "projects/-/locations/-/agents/-/entityTypes/sys.date",
        }],
        labels: {
            label1: "value1",
            label2: "value2",
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    agent = gcp.diagflow.CxAgent("agent",
        display_name="dialogflowcx-agent",
        location="global",
        default_language_code="en",
        supported_language_codes=[
            "fr",
            "de",
            "es",
        ],
        time_zone="America/New_York",
        description="Example description.",
        avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        enable_stackdriver_logging=True,
        enable_spell_correction=True,
        speech_to_text_settings=gcp.diagflow.CxAgentSpeechToTextSettingsArgs(
            enable_speech_adaptation=True,
        ))
    basic_intent = gcp.diagflow.CxIntent("basic_intent",
        parent=agent.id,
        display_name="Example",
        priority=1,
        description="Intent example",
        training_phrases=[gcp.diagflow.CxIntentTrainingPhraseArgs(
            parts=[
                gcp.diagflow.CxIntentTrainingPhrasePartArgs(
                    text="training",
                ),
                gcp.diagflow.CxIntentTrainingPhrasePartArgs(
                    text="phrase",
                ),
                gcp.diagflow.CxIntentTrainingPhrasePartArgs(
                    text="example",
                ),
            ],
            repeat_count=1,
        )],
        parameters=[gcp.diagflow.CxIntentParameterArgs(
            id="param1",
            entity_type="projects/-/locations/-/agents/-/entityTypes/sys.date",
        )],
        labels={
            "label1": "value1",
            "label2": "value2",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/diagflow"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		agent, err := diagflow.NewCxAgent(ctx, "agent", &diagflow.CxAgentArgs{
    			DisplayName:         pulumi.String("dialogflowcx-agent"),
    			Location:            pulumi.String("global"),
    			DefaultLanguageCode: pulumi.String("en"),
    			SupportedLanguageCodes: pulumi.StringArray{
    				pulumi.String("fr"),
    				pulumi.String("de"),
    				pulumi.String("es"),
    			},
    			TimeZone:                 pulumi.String("America/New_York"),
    			Description:              pulumi.String("Example description."),
    			AvatarUri:                pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"),
    			EnableStackdriverLogging: pulumi.Bool(true),
    			EnableSpellCorrection:    pulumi.Bool(true),
    			SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
    				EnableSpeechAdaptation: pulumi.Bool(true),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = diagflow.NewCxIntent(ctx, "basic_intent", &diagflow.CxIntentArgs{
    			Parent:      agent.ID(),
    			DisplayName: pulumi.String("Example"),
    			Priority:    pulumi.Int(1),
    			Description: pulumi.String("Intent example"),
    			TrainingPhrases: diagflow.CxIntentTrainingPhraseArray{
    				&diagflow.CxIntentTrainingPhraseArgs{
    					Parts: diagflow.CxIntentTrainingPhrasePartArray{
    						&diagflow.CxIntentTrainingPhrasePartArgs{
    							Text: pulumi.String("training"),
    						},
    						&diagflow.CxIntentTrainingPhrasePartArgs{
    							Text: pulumi.String("phrase"),
    						},
    						&diagflow.CxIntentTrainingPhrasePartArgs{
    							Text: pulumi.String("example"),
    						},
    					},
    					RepeatCount: pulumi.Int(1),
    				},
    			},
    			Parameters: diagflow.CxIntentParameterArray{
    				&diagflow.CxIntentParameterArgs{
    					Id:         pulumi.String("param1"),
    					EntityType: pulumi.String("projects/-/locations/-/agents/-/entityTypes/sys.date"),
    				},
    			},
    			Labels: pulumi.StringMap{
    				"label1": pulumi.String("value1"),
    				"label2": pulumi.String("value2"),
    			},
    		})
    		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 agent = new Gcp.Diagflow.CxAgent("agent", new()
        {
            DisplayName = "dialogflowcx-agent",
            Location = "global",
            DefaultLanguageCode = "en",
            SupportedLanguageCodes = new[]
            {
                "fr",
                "de",
                "es",
            },
            TimeZone = "America/New_York",
            Description = "Example description.",
            AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
            EnableStackdriverLogging = true,
            EnableSpellCorrection = true,
            SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
            {
                EnableSpeechAdaptation = true,
            },
        });
    
        var basicIntent = new Gcp.Diagflow.CxIntent("basic_intent", new()
        {
            Parent = agent.Id,
            DisplayName = "Example",
            Priority = 1,
            Description = "Intent example",
            TrainingPhrases = new[]
            {
                new Gcp.Diagflow.Inputs.CxIntentTrainingPhraseArgs
                {
                    Parts = new[]
                    {
                        new Gcp.Diagflow.Inputs.CxIntentTrainingPhrasePartArgs
                        {
                            Text = "training",
                        },
                        new Gcp.Diagflow.Inputs.CxIntentTrainingPhrasePartArgs
                        {
                            Text = "phrase",
                        },
                        new Gcp.Diagflow.Inputs.CxIntentTrainingPhrasePartArgs
                        {
                            Text = "example",
                        },
                    },
                    RepeatCount = 1,
                },
            },
            Parameters = new[]
            {
                new Gcp.Diagflow.Inputs.CxIntentParameterArgs
                {
                    Id = "param1",
                    EntityType = "projects/-/locations/-/agents/-/entityTypes/sys.date",
                },
            },
            Labels = 
            {
                { "label1", "value1" },
                { "label2", "value2" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.diagflow.CxAgent;
    import com.pulumi.gcp.diagflow.CxAgentArgs;
    import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
    import com.pulumi.gcp.diagflow.CxIntent;
    import com.pulumi.gcp.diagflow.CxIntentArgs;
    import com.pulumi.gcp.diagflow.inputs.CxIntentTrainingPhraseArgs;
    import com.pulumi.gcp.diagflow.inputs.CxIntentParameterArgs;
    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 agent = new CxAgent("agent", CxAgentArgs.builder()        
                .displayName("dialogflowcx-agent")
                .location("global")
                .defaultLanguageCode("en")
                .supportedLanguageCodes(            
                    "fr",
                    "de",
                    "es")
                .timeZone("America/New_York")
                .description("Example description.")
                .avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
                .enableStackdriverLogging(true)
                .enableSpellCorrection(true)
                .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
                    .enableSpeechAdaptation(true)
                    .build())
                .build());
    
            var basicIntent = new CxIntent("basicIntent", CxIntentArgs.builder()        
                .parent(agent.id())
                .displayName("Example")
                .priority(1)
                .description("Intent example")
                .trainingPhrases(CxIntentTrainingPhraseArgs.builder()
                    .parts(                
                        CxIntentTrainingPhrasePartArgs.builder()
                            .text("training")
                            .build(),
                        CxIntentTrainingPhrasePartArgs.builder()
                            .text("phrase")
                            .build(),
                        CxIntentTrainingPhrasePartArgs.builder()
                            .text("example")
                            .build())
                    .repeatCount(1)
                    .build())
                .parameters(CxIntentParameterArgs.builder()
                    .id("param1")
                    .entityType("projects/-/locations/-/agents/-/entityTypes/sys.date")
                    .build())
                .labels(Map.ofEntries(
                    Map.entry("label1", "value1"),
                    Map.entry("label2", "value2")
                ))
                .build());
    
        }
    }
    
    resources:
      agent:
        type: gcp:diagflow:CxAgent
        properties:
          displayName: dialogflowcx-agent
          location: global
          defaultLanguageCode: en
          supportedLanguageCodes:
            - fr
            - de
            - es
          timeZone: America/New_York
          description: Example description.
          avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
          enableStackdriverLogging: true
          enableSpellCorrection: true
          speechToTextSettings:
            enableSpeechAdaptation: true
      basicIntent:
        type: gcp:diagflow:CxIntent
        name: basic_intent
        properties:
          parent: ${agent.id}
          displayName: Example
          priority: 1
          description: Intent example
          trainingPhrases:
            - parts:
                - text: training
                - text: phrase
                - text: example
              repeatCount: 1
          parameters:
            - id: param1
              entityType: projects/-/locations/-/agents/-/entityTypes/sys.date
          labels:
            label1: value1
            label2: value2
    

    Create CxIntent Resource

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

    Constructor syntax

    new CxIntent(name: string, args: CxIntentArgs, opts?: CustomResourceOptions);
    @overload
    def CxIntent(resource_name: str,
                 args: CxIntentArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def CxIntent(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 description: Optional[str] = None,
                 is_default_negative_intent: Optional[bool] = None,
                 is_default_welcome_intent: Optional[bool] = None,
                 is_fallback: Optional[bool] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 language_code: Optional[str] = None,
                 parameters: Optional[Sequence[CxIntentParameterArgs]] = None,
                 parent: Optional[str] = None,
                 priority: Optional[int] = None,
                 training_phrases: Optional[Sequence[CxIntentTrainingPhraseArgs]] = None)
    func NewCxIntent(ctx *Context, name string, args CxIntentArgs, opts ...ResourceOption) (*CxIntent, error)
    public CxIntent(string name, CxIntentArgs args, CustomResourceOptions? opts = null)
    public CxIntent(String name, CxIntentArgs args)
    public CxIntent(String name, CxIntentArgs args, CustomResourceOptions options)
    
    type: gcp:diagflow:CxIntent
    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 CxIntentArgs
    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 CxIntentArgs
    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 CxIntentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CxIntentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CxIntentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var cxIntentResource = new Gcp.Diagflow.CxIntent("cxIntentResource", new()
    {
        DisplayName = "string",
        Description = "string",
        IsDefaultNegativeIntent = false,
        IsDefaultWelcomeIntent = false,
        IsFallback = false,
        Labels = 
        {
            { "string", "string" },
        },
        LanguageCode = "string",
        Parameters = new[]
        {
            new Gcp.Diagflow.Inputs.CxIntentParameterArgs
            {
                EntityType = "string",
                Id = "string",
                IsList = false,
                Redact = false,
            },
        },
        Parent = "string",
        Priority = 0,
        TrainingPhrases = new[]
        {
            new Gcp.Diagflow.Inputs.CxIntentTrainingPhraseArgs
            {
                Parts = new[]
                {
                    new Gcp.Diagflow.Inputs.CxIntentTrainingPhrasePartArgs
                    {
                        Text = "string",
                        ParameterId = "string",
                    },
                },
                Id = "string",
                RepeatCount = 0,
            },
        },
    });
    
    example, err := diagflow.NewCxIntent(ctx, "cxIntentResource", &diagflow.CxIntentArgs{
    	DisplayName:             pulumi.String("string"),
    	Description:             pulumi.String("string"),
    	IsDefaultNegativeIntent: pulumi.Bool(false),
    	IsDefaultWelcomeIntent:  pulumi.Bool(false),
    	IsFallback:              pulumi.Bool(false),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	LanguageCode: pulumi.String("string"),
    	Parameters: diagflow.CxIntentParameterArray{
    		&diagflow.CxIntentParameterArgs{
    			EntityType: pulumi.String("string"),
    			Id:         pulumi.String("string"),
    			IsList:     pulumi.Bool(false),
    			Redact:     pulumi.Bool(false),
    		},
    	},
    	Parent:   pulumi.String("string"),
    	Priority: pulumi.Int(0),
    	TrainingPhrases: diagflow.CxIntentTrainingPhraseArray{
    		&diagflow.CxIntentTrainingPhraseArgs{
    			Parts: diagflow.CxIntentTrainingPhrasePartArray{
    				&diagflow.CxIntentTrainingPhrasePartArgs{
    					Text:        pulumi.String("string"),
    					ParameterId: pulumi.String("string"),
    				},
    			},
    			Id:          pulumi.String("string"),
    			RepeatCount: pulumi.Int(0),
    		},
    	},
    })
    
    var cxIntentResource = new CxIntent("cxIntentResource", CxIntentArgs.builder()        
        .displayName("string")
        .description("string")
        .isDefaultNegativeIntent(false)
        .isDefaultWelcomeIntent(false)
        .isFallback(false)
        .labels(Map.of("string", "string"))
        .languageCode("string")
        .parameters(CxIntentParameterArgs.builder()
            .entityType("string")
            .id("string")
            .isList(false)
            .redact(false)
            .build())
        .parent("string")
        .priority(0)
        .trainingPhrases(CxIntentTrainingPhraseArgs.builder()
            .parts(CxIntentTrainingPhrasePartArgs.builder()
                .text("string")
                .parameterId("string")
                .build())
            .id("string")
            .repeatCount(0)
            .build())
        .build());
    
    cx_intent_resource = gcp.diagflow.CxIntent("cxIntentResource",
        display_name="string",
        description="string",
        is_default_negative_intent=False,
        is_default_welcome_intent=False,
        is_fallback=False,
        labels={
            "string": "string",
        },
        language_code="string",
        parameters=[gcp.diagflow.CxIntentParameterArgs(
            entity_type="string",
            id="string",
            is_list=False,
            redact=False,
        )],
        parent="string",
        priority=0,
        training_phrases=[gcp.diagflow.CxIntentTrainingPhraseArgs(
            parts=[gcp.diagflow.CxIntentTrainingPhrasePartArgs(
                text="string",
                parameter_id="string",
            )],
            id="string",
            repeat_count=0,
        )])
    
    const cxIntentResource = new gcp.diagflow.CxIntent("cxIntentResource", {
        displayName: "string",
        description: "string",
        isDefaultNegativeIntent: false,
        isDefaultWelcomeIntent: false,
        isFallback: false,
        labels: {
            string: "string",
        },
        languageCode: "string",
        parameters: [{
            entityType: "string",
            id: "string",
            isList: false,
            redact: false,
        }],
        parent: "string",
        priority: 0,
        trainingPhrases: [{
            parts: [{
                text: "string",
                parameterId: "string",
            }],
            id: "string",
            repeatCount: 0,
        }],
    });
    
    type: gcp:diagflow:CxIntent
    properties:
        description: string
        displayName: string
        isDefaultNegativeIntent: false
        isDefaultWelcomeIntent: false
        isFallback: false
        labels:
            string: string
        languageCode: string
        parameters:
            - entityType: string
              id: string
              isList: false
              redact: false
        parent: string
        priority: 0
        trainingPhrases:
            - id: string
              parts:
                - parameterId: string
                  text: string
              repeatCount: 0
    

    CxIntent Resource Properties

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

    Inputs

    The CxIntent resource accepts the following input properties:

    DisplayName string
    The human-readable name of the intent, unique within the agent.


    Description string
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    IsDefaultNegativeIntent bool

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    IsDefaultWelcomeIntent bool

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    IsFallback bool
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    Labels Dictionary<string, string>

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    LanguageCode string
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    Parameters List<CxIntentParameter>
    The collection of parameters associated with the intent. Structure is documented below.
    Parent string
    The agent to create an intent for. Format: projects//locations//agents/.
    Priority int
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    TrainingPhrases List<CxIntentTrainingPhrase>
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    DisplayName string
    The human-readable name of the intent, unique within the agent.


    Description string
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    IsDefaultNegativeIntent bool

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    IsDefaultWelcomeIntent bool

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    IsFallback bool
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    Labels map[string]string

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    LanguageCode string
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    Parameters []CxIntentParameterArgs
    The collection of parameters associated with the intent. Structure is documented below.
    Parent string
    The agent to create an intent for. Format: projects//locations//agents/.
    Priority int
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    TrainingPhrases []CxIntentTrainingPhraseArgs
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    displayName String
    The human-readable name of the intent, unique within the agent.


    description String
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    isDefaultNegativeIntent Boolean

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    isDefaultWelcomeIntent Boolean

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    isFallback Boolean
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels Map<String,String>

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    languageCode String
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    parameters List<CxIntentParameter>
    The collection of parameters associated with the intent. Structure is documented below.
    parent String
    The agent to create an intent for. Format: projects//locations//agents/.
    priority Integer
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    trainingPhrases List<CxIntentTrainingPhrase>
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    displayName string
    The human-readable name of the intent, unique within the agent.


    description string
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    isDefaultNegativeIntent boolean

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    isDefaultWelcomeIntent boolean

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    isFallback boolean
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels {[key: string]: string}

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    languageCode string
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    parameters CxIntentParameter[]
    The collection of parameters associated with the intent. Structure is documented below.
    parent string
    The agent to create an intent for. Format: projects//locations//agents/.
    priority number
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    trainingPhrases CxIntentTrainingPhrase[]
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    display_name str
    The human-readable name of the intent, unique within the agent.


    description str
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    is_default_negative_intent bool

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    is_default_welcome_intent bool

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    is_fallback bool
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels Mapping[str, str]

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    language_code str
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    parameters Sequence[CxIntentParameterArgs]
    The collection of parameters associated with the intent. Structure is documented below.
    parent str
    The agent to create an intent for. Format: projects//locations//agents/.
    priority int
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    training_phrases Sequence[CxIntentTrainingPhraseArgs]
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    displayName String
    The human-readable name of the intent, unique within the agent.


    description String
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    isDefaultNegativeIntent Boolean

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    isDefaultWelcomeIntent Boolean

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    isFallback Boolean
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels Map<String>

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    languageCode String
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    parameters List<Property Map>
    The collection of parameters associated with the intent. Structure is documented below.
    parent String
    The agent to create an intent for. Format: projects//locations//agents/.
    priority Number
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    trainingPhrases List<Property Map>
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.

    Outputs

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

    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.

    Look up Existing CxIntent Resource

    Get an existing CxIntent 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?: CxIntentState, opts?: CustomResourceOptions): CxIntent
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            effective_labels: Optional[Mapping[str, str]] = None,
            is_default_negative_intent: Optional[bool] = None,
            is_default_welcome_intent: Optional[bool] = None,
            is_fallback: Optional[bool] = None,
            labels: Optional[Mapping[str, str]] = None,
            language_code: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Sequence[CxIntentParameterArgs]] = None,
            parent: Optional[str] = None,
            priority: Optional[int] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            training_phrases: Optional[Sequence[CxIntentTrainingPhraseArgs]] = None) -> CxIntent
    func GetCxIntent(ctx *Context, name string, id IDInput, state *CxIntentState, opts ...ResourceOption) (*CxIntent, error)
    public static CxIntent Get(string name, Input<string> id, CxIntentState? state, CustomResourceOptions? opts = null)
    public static CxIntent get(String name, Output<String> id, CxIntentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Description string
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    DisplayName string
    The human-readable name of the intent, unique within the agent.


    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    IsDefaultNegativeIntent bool

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    IsDefaultWelcomeIntent bool

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    IsFallback bool
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    Labels Dictionary<string, string>

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    LanguageCode string
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    Name string
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    Parameters List<CxIntentParameter>
    The collection of parameters associated with the intent. Structure is documented below.
    Parent string
    The agent to create an intent for. Format: projects//locations//agents/.
    Priority int
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TrainingPhrases List<CxIntentTrainingPhrase>
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    Description string
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    DisplayName string
    The human-readable name of the intent, unique within the agent.


    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    IsDefaultNegativeIntent bool

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    IsDefaultWelcomeIntent bool

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    IsFallback bool
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    Labels map[string]string

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    LanguageCode string
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    Name string
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    Parameters []CxIntentParameterArgs
    The collection of parameters associated with the intent. Structure is documented below.
    Parent string
    The agent to create an intent for. Format: projects//locations//agents/.
    Priority int
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TrainingPhrases []CxIntentTrainingPhraseArgs
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    description String
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    displayName String
    The human-readable name of the intent, unique within the agent.


    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    isDefaultNegativeIntent Boolean

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    isDefaultWelcomeIntent Boolean

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    isFallback Boolean
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels Map<String,String>

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    languageCode String
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    name String
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    parameters List<CxIntentParameter>
    The collection of parameters associated with the intent. Structure is documented below.
    parent String
    The agent to create an intent for. Format: projects//locations//agents/.
    priority Integer
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    trainingPhrases List<CxIntentTrainingPhrase>
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    description string
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    displayName string
    The human-readable name of the intent, unique within the agent.


    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    isDefaultNegativeIntent boolean

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    isDefaultWelcomeIntent boolean

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    isFallback boolean
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels {[key: string]: string}

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    languageCode string
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    name string
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    parameters CxIntentParameter[]
    The collection of parameters associated with the intent. Structure is documented below.
    parent string
    The agent to create an intent for. Format: projects//locations//agents/.
    priority number
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    trainingPhrases CxIntentTrainingPhrase[]
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    description str
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    display_name str
    The human-readable name of the intent, unique within the agent.


    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    is_default_negative_intent bool

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    is_default_welcome_intent bool

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    is_fallback bool
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels Mapping[str, str]

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    language_code str
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    name str
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    parameters Sequence[CxIntentParameterArgs]
    The collection of parameters associated with the intent. Structure is documented below.
    parent str
    The agent to create an intent for. Format: projects//locations//agents/.
    priority int
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    training_phrases Sequence[CxIntentTrainingPhraseArgs]
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.
    description String
    Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
    displayName String
    The human-readable name of the intent, unique within the agent.


    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    isDefaultNegativeIntent Boolean

    Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_negative_intent = true because they will compete to control a single Default Negative Intent resource in GCP.

    isDefaultWelcomeIntent Boolean

    Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the gcp.diagflow.CxIntent resource does nothing to the underlying GCP resources.

    Avoid having multiple gcp.diagflow.CxIntent resources linked to the same agent with is_default_welcome_intent = true because they will compete to control a single Default Welcome Intent resource in GCP.

    isFallback Boolean
    Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set is_default_negative_intent = true
    labels Map<String>

    The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    languageCode String
    The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
    name String
    The unique identifier of the intent. Format: projects//locations//agents//intents/.
    parameters List<Property Map>
    The collection of parameters associated with the intent. Structure is documented below.
    parent String
    The agent to create an intent for. Format: projects//locations//agents/.
    priority Number
    The priority of this intent. Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    trainingPhrases List<Property Map>
    The collection of training phrases the agent is trained on to identify the intent. Structure is documented below.

    Supporting Types

    CxIntentParameter, CxIntentParameterArgs

    EntityType string
    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.
    Id string
    The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
    IsList bool
    Indicates whether the parameter represents a list of values.
    Redact bool
    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
    EntityType string
    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.
    Id string
    The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
    IsList bool
    Indicates whether the parameter represents a list of values.
    Redact bool
    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
    entityType String
    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.
    id String
    The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
    isList Boolean
    Indicates whether the parameter represents a list of values.
    redact Boolean
    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
    entityType string
    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.
    id string
    The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
    isList boolean
    Indicates whether the parameter represents a list of values.
    redact boolean
    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
    entity_type str
    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.
    id str
    The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
    is_list bool
    Indicates whether the parameter represents a list of values.
    redact bool
    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
    entityType String
    The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.
    id String
    The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
    isList Boolean
    Indicates whether the parameter represents a list of values.
    redact Boolean
    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

    CxIntentTrainingPhrase, CxIntentTrainingPhraseArgs

    Parts List<CxIntentTrainingPhrasePart>
    The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: Part.text is set to a part of the phrase that has no parameters. Part.text is set to a part of the phrase that you want to annotate, and the parameterId field is set. Structure is documented below.
    Id string
    (Output) The unique identifier of the training phrase.
    RepeatCount int
    Indicates how many times this example was added to the intent.
    Parts []CxIntentTrainingPhrasePart
    The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: Part.text is set to a part of the phrase that has no parameters. Part.text is set to a part of the phrase that you want to annotate, and the parameterId field is set. Structure is documented below.
    Id string
    (Output) The unique identifier of the training phrase.
    RepeatCount int
    Indicates how many times this example was added to the intent.
    parts List<CxIntentTrainingPhrasePart>
    The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: Part.text is set to a part of the phrase that has no parameters. Part.text is set to a part of the phrase that you want to annotate, and the parameterId field is set. Structure is documented below.
    id String
    (Output) The unique identifier of the training phrase.
    repeatCount Integer
    Indicates how many times this example was added to the intent.
    parts CxIntentTrainingPhrasePart[]
    The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: Part.text is set to a part of the phrase that has no parameters. Part.text is set to a part of the phrase that you want to annotate, and the parameterId field is set. Structure is documented below.
    id string
    (Output) The unique identifier of the training phrase.
    repeatCount number
    Indicates how many times this example was added to the intent.
    parts Sequence[CxIntentTrainingPhrasePart]
    The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: Part.text is set to a part of the phrase that has no parameters. Part.text is set to a part of the phrase that you want to annotate, and the parameterId field is set. Structure is documented below.
    id str
    (Output) The unique identifier of the training phrase.
    repeat_count int
    Indicates how many times this example was added to the intent.
    parts List<Property Map>
    The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: Part.text is set to a part of the phrase that has no parameters. Part.text is set to a part of the phrase that you want to annotate, and the parameterId field is set. Structure is documented below.
    id String
    (Output) The unique identifier of the training phrase.
    repeatCount Number
    Indicates how many times this example was added to the intent.

    CxIntentTrainingPhrasePart, CxIntentTrainingPhrasePartArgs

    Text string
    The text for this part.
    ParameterId string
    The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
    Text string
    The text for this part.
    ParameterId string
    The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
    text String
    The text for this part.
    parameterId String
    The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
    text string
    The text for this part.
    parameterId string
    The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
    text str
    The text for this part.
    parameter_id str
    The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
    text String
    The text for this part.
    parameterId String
    The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

    Import

    Intent can be imported using any of these accepted formats:

    • {{parent}}/intents/{{name}}

    • {{parent}}/{{name}}

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

    $ pulumi import gcp:diagflow/cxIntent:CxIntent default {{parent}}/intents/{{name}}
    
    $ pulumi import gcp:diagflow/cxIntent:CxIntent default {{parent}}/{{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 Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi