Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2beta1
  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/v2beta1.getEntityType

Explore with Pulumi AI

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>
Copy
def get_entity_type(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(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]
Copy
func LookupEntityType(ctx *Context, args *LookupEntityTypeArgs, opts ...InvokeOption) (*LookupEntityTypeResult, error)
func LookupEntityTypeOutput(ctx *Context, args *LookupEntityTypeOutputArgs, opts ...InvokeOption) LookupEntityTypeResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetEntityTypeResult> getEntityType(GetEntityTypeArgs args, InvokeOptions options)
public static Output<GetEntityTypeResult> getEntityType(GetEntityTypeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:dialogflow/v2beta1:getEntityType
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EntityTypeId This property is required. string
Location This property is required. string
LanguageCode string
Project string
EntityTypeId This property is required. string
Location This property is required. string
LanguageCode string
Project string
entityTypeId This property is required. String
location This property is required. String
languageCode String
project String
entityTypeId This property is required. string
location This property is required. string
languageCode string
project string
entity_type_id This property is required. str
location This property is required. str
language_code str
project str
entityTypeId This property is required. String
location This property is required. String
languageCode String
project String

getEntityType Result

The following output properties are available:

AutoExpansionMode string
Optional. Indicates whether the entity type can be automatically expanded.
DisplayName string
The name of the entity type.
EnableFuzzyExtraction bool
Optional. Enables fuzzy entity extraction during classification.
Entities List<Pulumi.GoogleNative.Dialogflow.V2Beta1.Outputs.GoogleCloudDialogflowV2beta1EntityTypeEntityResponse>
Optional. The collection of entity entries associated with the entity type.
Kind string
Indicates the kind of entity type.
Name string
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
AutoExpansionMode string
Optional. Indicates whether the entity type can be automatically expanded.
DisplayName string
The name of the entity type.
EnableFuzzyExtraction bool
Optional. Enables fuzzy entity extraction during classification.
Entities []GoogleCloudDialogflowV2beta1EntityTypeEntityResponse
Optional. The collection of entity entries associated with the entity type.
Kind string
Indicates the kind of entity type.
Name string
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
autoExpansionMode String
Optional. Indicates whether the entity type can be automatically expanded.
displayName String
The name of the entity type.
enableFuzzyExtraction Boolean
Optional. Enables fuzzy entity extraction during classification.
entities List<GoogleCloudDialogflowV2beta1EntityTypeEntityResponse>
Optional. The collection of entity entries associated with the entity type.
kind String
Indicates the kind of entity type.
name String
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
autoExpansionMode string
Optional. Indicates whether the entity type can be automatically expanded.
displayName string
The name of the entity type.
enableFuzzyExtraction boolean
Optional. Enables fuzzy entity extraction during classification.
entities GoogleCloudDialogflowV2beta1EntityTypeEntityResponse[]
Optional. The collection of entity entries associated with the entity type.
kind string
Indicates the kind of entity type.
name string
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
auto_expansion_mode str
Optional. Indicates whether the entity type can be automatically expanded.
display_name str
The name of the entity type.
enable_fuzzy_extraction bool
Optional. Enables fuzzy entity extraction during classification.
entities Sequence[GoogleCloudDialogflowV2beta1EntityTypeEntityResponse]
Optional. The collection of entity entries associated with the entity type.
kind str
Indicates the kind of entity type.
name str
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
autoExpansionMode String
Optional. Indicates whether the entity type can be automatically expanded.
displayName String
The name of the entity type.
enableFuzzyExtraction Boolean
Optional. Enables fuzzy entity extraction during classification.
entities List<Property Map>
Optional. The collection of entity entries associated with the entity type.
kind String
Indicates the kind of entity type.
name String
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - projects//agent/entityTypes/ - projects//locations//agent/entityTypes/

Supporting Types

GoogleCloudDialogflowV2beta1EntityTypeEntityResponse

Synonyms This property is required. 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 This property is required. 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 reference 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 This property is required. []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 This property is required. 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 reference 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 This property is required. 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 This property is required. 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 reference 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 This property is required. 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 This property is required. 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 reference 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 This property is required. 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 This property is required. 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 reference 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 This property is required. 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 This property is required. 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 reference 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).

Package Details

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

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