Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3
  6. getEntityType

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v3.getEntityType

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Retrieves the specified entity type.

    Using getEntityType

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEntityType(args: GetEntityTypeArgs, opts?: InvokeOptions): Promise<GetEntityTypeResult>
function getEntityTypeOutput(args: GetEntityTypeOutputArgs, opts?: InvokeOptions): Output<GetEntityTypeResult>
    def get_entity_type(agent_id: Optional[str] = None,
                    entity_type_id: Optional[str] = None,
                    language_code: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEntityTypeResult
def get_entity_type_output(agent_id: Optional[pulumi.Input[str]] = None,
                    entity_type_id: Optional[pulumi.Input[str]] = None,
                    language_code: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEntityTypeResult]
    func LookupEntityType(ctx *Context, args *LookupEntityTypeArgs, opts ...InvokeOption) (*LookupEntityTypeResult, error)
func LookupEntityTypeOutput(ctx *Context, args *LookupEntityTypeOutputArgs, opts ...InvokeOption) LookupEntityTypeResultOutput

    > Note: This function is named LookupEntityType in the Go SDK.

    public static class GetEntityType 
{
    public static Task<GetEntityTypeResult> InvokeAsync(GetEntityTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityTypeResult> Invoke(GetEntityTypeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEntityTypeResult> getEntityType(GetEntityTypeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:dialogflow/v3:getEntityType
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgentId string
    EntityTypeId string
    Location string
    LanguageCode string
    Project string
    AgentId string
    EntityTypeId string
    Location string
    LanguageCode string
    Project string
    agentId String
    entityTypeId String
    location String
    languageCode String
    project String
    agentId string
    entityTypeId string
    location string
    languageCode string
    project string
    agentId String
    entityTypeId String
    location String
    languageCode String
    project String

    getEntityType Result

    The following output properties are available:

    AutoExpansionMode string
    Indicates whether the entity type can be automatically expanded.
    DisplayName string
    The human-readable name of the entity type, unique within the agent.
    EnableFuzzyExtraction bool
    Enables fuzzy entity extraction during classification.
    Entities List<Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3EntityTypeEntityResponse>
    The collection of entity entries associated with the entity type.
    ExcludedPhrases List<Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse>
    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.
    Kind string
    Indicates the kind of entity type.
    Name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    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
    Indicates whether the entity type can be automatically expanded.
    DisplayName string
    The human-readable name of the entity type, unique within the agent.
    EnableFuzzyExtraction bool
    Enables fuzzy entity extraction during classification.
    Entities []GoogleCloudDialogflowCxV3EntityTypeEntityResponse
    The collection of entity entries associated with the entity type.
    ExcludedPhrases []GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse
    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.
    Kind string
    Indicates the kind of entity type.
    Name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    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
    Indicates whether the entity type can be automatically expanded.
    displayName String
    The human-readable name of the entity type, unique within the agent.
    enableFuzzyExtraction Boolean
    Enables fuzzy entity extraction during classification.
    entities List<GoogleCloudDialogflowCxV3EntityTypeEntityResponse>
    The collection of entity entries associated with the entity type.
    excludedPhrases List<GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse>
    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.
    kind String
    Indicates the kind of entity type.
    name String
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    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
    Indicates whether the entity type can be automatically expanded.
    displayName string
    The human-readable name of the entity type, unique within the agent.
    enableFuzzyExtraction boolean
    Enables fuzzy entity extraction during classification.
    entities GoogleCloudDialogflowCxV3EntityTypeEntityResponse[]
    The collection of entity entries associated with the entity type.
    excludedPhrases GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse[]
    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.
    kind string
    Indicates the kind of entity type.
    name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    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
    Indicates whether the entity type can be automatically expanded.
    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[GoogleCloudDialogflowCxV3EntityTypeEntityResponse]
    The collection of entity entries associated with the entity type.
    excluded_phrases Sequence[GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse]
    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.
    kind str
    Indicates the kind of entity type.
    name str
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    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
    Indicates whether the entity type can be automatically expanded.
    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.
    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.
    kind String
    Indicates the kind of entity type.
    name String
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    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

    GoogleCloudDialogflowCxV3EntityTypeEntityResponse

    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 primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: * A canonical value to be used in place of synonyms. For KIND_LIST entity types: * A string that can contain references to other entity types (with or without aliases).
    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 primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: * A canonical value to be used in place of synonyms. For KIND_LIST entity types: * A string that can contain references to other entity types (with or without aliases).
    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 primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: * A canonical value to be used in place of synonyms. For KIND_LIST entity types: * A string that can contain references to other entity types (with or without aliases).
    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 primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: * A canonical value to be used in place of synonyms. For KIND_LIST entity types: * A string that can contain references to other entity types (with or without aliases).
    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 primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: * A canonical value to be used in place of synonyms. For KIND_LIST entity types: * A string that can contain references to other entity types (with or without aliases).
    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 primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: * A canonical value to be used in place of synonyms. For KIND_LIST entity types: * A string that can contain references to other entity types (with or without aliases).

    GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse

    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.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native