Google Cloud (GCP) Classic

v6.43.0 published on Tuesday, Nov 15, 2022 by Pulumi

CxEntityType

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

To get more information about EntityType, see:

Example Usage

Dialogflowcx Entity Type Full

using System.Collections.Generic;
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 basicEntityType = new Gcp.Diagflow.CxEntityType("basicEntityType", new()
    {
        Parent = agent.Id,
        DisplayName = "MyEntity",
        Kind = "KIND_MAP",
        Entities = new[]
        {
            new Gcp.Diagflow.Inputs.CxEntityTypeEntityArgs
            {
                Value = "value1",
                Synonyms = new[]
                {
                    "synonym1",
                    "synonym2",
                },
            },
            new Gcp.Diagflow.Inputs.CxEntityTypeEntityArgs
            {
                Value = "value2",
                Synonyms = new[]
                {
                    "synonym3",
                    "synonym4",
                },
            },
        },
        EnableFuzzyExtraction = false,
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/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.NewCxEntityType(ctx, "basicEntityType", &diagflow.CxEntityTypeArgs{
			Parent:      agent.ID(),
			DisplayName: pulumi.String("MyEntity"),
			Kind:        pulumi.String("KIND_MAP"),
			Entities: diagflow.CxEntityTypeEntityArray{
				&diagflow.CxEntityTypeEntityArgs{
					Value: pulumi.String("value1"),
					Synonyms: pulumi.StringArray{
						pulumi.String("synonym1"),
						pulumi.String("synonym2"),
					},
				},
				&diagflow.CxEntityTypeEntityArgs{
					Value: pulumi.String("value2"),
					Synonyms: pulumi.StringArray{
						pulumi.String("synonym3"),
						pulumi.String("synonym4"),
					},
				},
			},
			EnableFuzzyExtraction: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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.CxEntityType;
import com.pulumi.gcp.diagflow.CxEntityTypeArgs;
import com.pulumi.gcp.diagflow.inputs.CxEntityTypeEntityArgs;
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 basicEntityType = new CxEntityType("basicEntityType", CxEntityTypeArgs.builder()        
            .parent(agent.id())
            .displayName("MyEntity")
            .kind("KIND_MAP")
            .entities(            
                CxEntityTypeEntityArgs.builder()
                    .value("value1")
                    .synonyms(                    
                        "synonym1",
                        "synonym2")
                    .build(),
                CxEntityTypeEntityArgs.builder()
                    .value("value2")
                    .synonyms(                    
                        "synonym3",
                        "synonym4")
                    .build())
            .enableFuzzyExtraction(false)
            .build());

    }
}
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_entity_type = gcp.diagflow.CxEntityType("basicEntityType",
    parent=agent.id,
    display_name="MyEntity",
    kind="KIND_MAP",
    entities=[
        gcp.diagflow.CxEntityTypeEntityArgs(
            value="value1",
            synonyms=[
                "synonym1",
                "synonym2",
            ],
        ),
        gcp.diagflow.CxEntityTypeEntityArgs(
            value="value2",
            synonyms=[
                "synonym3",
                "synonym4",
            ],
        ),
    ],
    enable_fuzzy_extraction=False)
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 basicEntityType = new gcp.diagflow.CxEntityType("basicEntityType", {
    parent: agent.id,
    displayName: "MyEntity",
    kind: "KIND_MAP",
    entities: [
        {
            value: "value1",
            synonyms: [
                "synonym1",
                "synonym2",
            ],
        },
        {
            value: "value2",
            synonyms: [
                "synonym3",
                "synonym4",
            ],
        },
    ],
    enableFuzzyExtraction: false,
});
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
  basicEntityType:
    type: gcp:diagflow:CxEntityType
    properties:
      parent: ${agent.id}
      displayName: MyEntity
      kind: KIND_MAP
      entities:
        - value: value1
          synonyms:
            - synonym1
            - synonym2
        - value: value2
          synonyms:
            - synonym3
            - synonym4
      enableFuzzyExtraction: false

Create CxEntityType Resource

new CxEntityType(name: string, args: CxEntityTypeArgs, opts?: CustomResourceOptions);
@overload
def CxEntityType(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 auto_expansion_mode: Optional[str] = None,
                 display_name: Optional[str] = None,
                 enable_fuzzy_extraction: Optional[bool] = None,
                 entities: Optional[Sequence[CxEntityTypeEntityArgs]] = None,
                 excluded_phrases: Optional[Sequence[CxEntityTypeExcludedPhraseArgs]] = None,
                 kind: Optional[str] = None,
                 language_code: Optional[str] = None,
                 parent: Optional[str] = None,
                 redact: Optional[bool] = None)
@overload
def CxEntityType(resource_name: str,
                 args: CxEntityTypeArgs,
                 opts: Optional[ResourceOptions] = None)
func NewCxEntityType(ctx *Context, name string, args CxEntityTypeArgs, opts ...ResourceOption) (*CxEntityType, error)
public CxEntityType(string name, CxEntityTypeArgs args, CustomResourceOptions? opts = null)
public CxEntityType(String name, CxEntityTypeArgs args)
public CxEntityType(String name, CxEntityTypeArgs args, CustomResourceOptions options)
type: gcp:diagflow:CxEntityType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CxEntityTypeArgs
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 CxEntityTypeArgs
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 CxEntityTypeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CxEntityTypeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CxEntityTypeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DisplayName string

The human-readable name of the entity type, unique within the agent.

Entities List<CxEntityTypeEntityArgs>

The collection of entity entries associated with the entity type. Structure is documented below.

Kind string

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
AutoExpansionMode string

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
EnableFuzzyExtraction bool

Enables fuzzy entity extraction during classification.

ExcludedPhrases List<CxEntityTypeExcludedPhraseArgs>

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

LanguageCode string

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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.

Parent string

The agent to create a entity type for. Format: projects//locations//agents/.

Redact bool

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

DisplayName string

The human-readable name of the entity type, unique within the agent.

Entities []CxEntityTypeEntityArgs

The collection of entity entries associated with the entity type. Structure is documented below.

Kind string

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
AutoExpansionMode string

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
EnableFuzzyExtraction bool

Enables fuzzy entity extraction during classification.

ExcludedPhrases []CxEntityTypeExcludedPhraseArgs

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

LanguageCode string

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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.

Parent string

The agent to create a entity type for. Format: projects//locations//agents/.

Redact bool

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

displayName String

The human-readable name of the entity type, unique within the agent.

entities List<CxEntityTypeEntityArgs>

The collection of entity entries associated with the entity type. Structure is documented below.

kind String

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
autoExpansionMode String

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
enableFuzzyExtraction Boolean

Enables fuzzy entity extraction during classification.

excludedPhrases List<CxEntityTypeExcludedPhraseArgs>

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

languageCode String

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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.

parent String

The agent to create a entity type for. Format: projects//locations//agents/.

redact Boolean

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

displayName string

The human-readable name of the entity type, unique within the agent.

entities CxEntityTypeEntityArgs[]

The collection of entity entries associated with the entity type. Structure is documented below.

kind string

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
autoExpansionMode string

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
enableFuzzyExtraction boolean

Enables fuzzy entity extraction during classification.

excludedPhrases CxEntityTypeExcludedPhraseArgs[]

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

languageCode string

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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.

parent string

The agent to create a entity type for. Format: projects//locations//agents/.

redact boolean

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

display_name str

The human-readable name of the entity type, unique within the agent.

entities Sequence[CxEntityTypeEntityArgs]

The collection of entity entries associated with the entity type. Structure is documented below.

kind str

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
auto_expansion_mode str

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
enable_fuzzy_extraction bool

Enables fuzzy entity extraction during classification.

excluded_phrases Sequence[CxEntityTypeExcludedPhraseArgs]

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

language_code str

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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.

parent str

The agent to create a entity type for. Format: projects//locations//agents/.

redact bool

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

displayName String

The human-readable name of the entity type, unique within the agent.

entities List<Property Map>

The collection of entity entries associated with the entity type. Structure is documented below.

kind String

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
autoExpansionMode String

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
enableFuzzyExtraction Boolean

Enables fuzzy entity extraction during classification.

excludedPhrases List<Property Map>

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

languageCode String

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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.

parent String

The agent to create a entity type for. Format: projects//locations//agents/.

redact Boolean

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

The unique identifier of the entity type. Format: projects//locations//agents//entityTypes/.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The unique identifier of the entity type. Format: projects//locations//agents//entityTypes/.

id String

The provider-assigned unique ID for this managed resource.

name String

The unique identifier of the entity type. Format: projects//locations//agents//entityTypes/.

id string

The provider-assigned unique ID for this managed resource.

name string

The unique identifier of the entity type. Format: projects//locations//agents//entityTypes/.

id str

The provider-assigned unique ID for this managed resource.

name str

The unique identifier of the entity type. Format: projects//locations//agents//entityTypes/.

id String

The provider-assigned unique ID for this managed resource.

name String

The unique identifier of the entity type. Format: projects//locations//agents//entityTypes/.

Look up Existing CxEntityType Resource

Get an existing CxEntityType 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?: CxEntityTypeState, opts?: CustomResourceOptions): CxEntityType
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_expansion_mode: Optional[str] = None,
        display_name: Optional[str] = None,
        enable_fuzzy_extraction: Optional[bool] = None,
        entities: Optional[Sequence[CxEntityTypeEntityArgs]] = None,
        excluded_phrases: Optional[Sequence[CxEntityTypeExcludedPhraseArgs]] = None,
        kind: Optional[str] = None,
        language_code: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        redact: Optional[bool] = None) -> CxEntityType
func GetCxEntityType(ctx *Context, name string, id IDInput, state *CxEntityTypeState, opts ...ResourceOption) (*CxEntityType, error)
public static CxEntityType Get(string name, Input<string> id, CxEntityTypeState? state, CustomResourceOptions? opts = null)
public static CxEntityType get(String name, Output<String> id, CxEntityTypeState 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:
AutoExpansionMode string

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
DisplayName string

The human-readable name of the entity type, unique within the agent.

EnableFuzzyExtraction bool

Enables fuzzy entity extraction during classification.

Entities List<CxEntityTypeEntityArgs>

The collection of entity entries associated with the entity type. Structure is documented below.

ExcludedPhrases List<CxEntityTypeExcludedPhraseArgs>

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

Kind string

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
LanguageCode string

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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 entity type. Format: projects//locations//agents//entityTypes/.

Parent string

The agent to create a entity type for. Format: projects//locations//agents/.

Redact bool

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

AutoExpansionMode string

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
DisplayName string

The human-readable name of the entity type, unique within the agent.

EnableFuzzyExtraction bool

Enables fuzzy entity extraction during classification.

Entities []CxEntityTypeEntityArgs

The collection of entity entries associated with the entity type. Structure is documented below.

ExcludedPhrases []CxEntityTypeExcludedPhraseArgs

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

Kind string

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
LanguageCode string

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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 entity type. Format: projects//locations//agents//entityTypes/.

Parent string

The agent to create a entity type for. Format: projects//locations//agents/.

Redact bool

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

autoExpansionMode String

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
displayName String

The human-readable name of the entity type, unique within the agent.

enableFuzzyExtraction Boolean

Enables fuzzy entity extraction during classification.

entities List<CxEntityTypeEntityArgs>

The collection of entity entries associated with the entity type. Structure is documented below.

excludedPhrases List<CxEntityTypeExcludedPhraseArgs>

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

kind String

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
languageCode String

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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 entity type. Format: projects//locations//agents//entityTypes/.

parent String

The agent to create a entity type for. Format: projects//locations//agents/.

redact Boolean

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

autoExpansionMode string

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
displayName string

The human-readable name of the entity type, unique within the agent.

enableFuzzyExtraction boolean

Enables fuzzy entity extraction during classification.

entities CxEntityTypeEntityArgs[]

The collection of entity entries associated with the entity type. Structure is documented below.

excludedPhrases CxEntityTypeExcludedPhraseArgs[]

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

kind string

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
languageCode string

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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 entity type. Format: projects//locations//agents//entityTypes/.

parent string

The agent to create a entity type for. Format: projects//locations//agents/.

redact boolean

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

auto_expansion_mode str

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
display_name str

The human-readable name of the entity type, unique within the agent.

enable_fuzzy_extraction bool

Enables fuzzy entity extraction during classification.

entities Sequence[CxEntityTypeEntityArgs]

The collection of entity entries associated with the entity type. Structure is documented below.

excluded_phrases Sequence[CxEntityTypeExcludedPhraseArgs]

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

kind str

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
language_code str

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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 entity type. Format: projects//locations//agents//entityTypes/.

parent str

The agent to create a entity type for. Format: projects//locations//agents/.

redact bool

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

autoExpansionMode String

Represents kinds of entities.

  • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
  • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
displayName String

The human-readable name of the entity type, unique within the agent.

enableFuzzyExtraction Boolean

Enables fuzzy entity extraction during classification.

entities List<Property Map>

The collection of entity entries associated with the entity type. Structure is documented below.

excludedPhrases List<Property Map>

Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

kind String

Indicates whether the entity type can be automatically expanded.

  • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
  • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
  • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
languageCode String

The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value 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 entity type. Format: projects//locations//agents//entityTypes/.

parent String

The agent to create a entity type for. Format: projects//locations//agents/.

redact Boolean

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

Supporting Types

CxEntityTypeEntity

Synonyms List<string>

A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

Value string

The word or phrase to be excluded.

Synonyms []string

A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

Value string

The word or phrase to be excluded.

synonyms List<String>

A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

value String

The word or phrase to be excluded.

synonyms string[]

A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

value string

The word or phrase to be excluded.

synonyms Sequence[str]

A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

value str

The word or phrase to be excluded.

synonyms List<String>

A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

value String

The word or phrase to be excluded.

CxEntityTypeExcludedPhrase

Value string

The word or phrase to be excluded.

Value string

The word or phrase to be excluded.

value String

The word or phrase to be excluded.

value string

The word or phrase to be excluded.

value str

The word or phrase to be excluded.

value String

The word or phrase to be excluded.

Import

EntityType can be imported using any of these accepted formats

 $ pulumi import gcp:diagflow/cxEntityType:CxEntityType default {{parent}}/entityTypes/{{name}}
 $ pulumi import gcp:diagflow/cxEntityType:CxEntityType default {{parent}}/{{name}}

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.