Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getSessionEntityType

Retrieves the specified session entity type. This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Using getSessionEntityType

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 getSessionEntityType(args: GetSessionEntityTypeArgs, opts?: InvokeOptions): Promise<GetSessionEntityTypeResult>
function getSessionEntityTypeOutput(args: GetSessionEntityTypeOutputArgs, opts?: InvokeOptions): Output<GetSessionEntityTypeResult>
def get_session_entity_type(entity_type_id: Optional[str] = None,
                            environment_id: Optional[str] = None,
                            location: Optional[str] = None,
                            project: Optional[str] = None,
                            session_id: Optional[str] = None,
                            user_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSessionEntityTypeResult
def get_session_entity_type_output(entity_type_id: Optional[pulumi.Input[str]] = None,
                            environment_id: Optional[pulumi.Input[str]] = None,
                            location: Optional[pulumi.Input[str]] = None,
                            project: Optional[pulumi.Input[str]] = None,
                            session_id: Optional[pulumi.Input[str]] = None,
                            user_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetSessionEntityTypeResult]
func LookupSessionEntityType(ctx *Context, args *LookupSessionEntityTypeArgs, opts ...InvokeOption) (*LookupSessionEntityTypeResult, error)
func LookupSessionEntityTypeOutput(ctx *Context, args *LookupSessionEntityTypeOutputArgs, opts ...InvokeOption) LookupSessionEntityTypeResultOutput

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

public static class GetSessionEntityType 
{
    public static Task<GetSessionEntityTypeResult> InvokeAsync(GetSessionEntityTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetSessionEntityTypeResult> Invoke(GetSessionEntityTypeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSessionEntityTypeResult> getSessionEntityType(GetSessionEntityTypeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:dialogflow/v2beta1:getSessionEntityType
  arguments:
    # arguments dictionary

The following arguments are supported:

EntityTypeId string
EnvironmentId string
Location string
SessionId string
UserId string
Project string
EntityTypeId string
EnvironmentId string
Location string
SessionId string
UserId string
Project string
entityTypeId String
environmentId String
location String
sessionId String
userId String
project String
entityTypeId string
environmentId string
location string
sessionId string
userId string
project string
entityTypeId String
environmentId String
location String
sessionId String
userId String
project String

getSessionEntityType Result

The following output properties are available:

Entities List<Pulumi.GoogleNative.Dialogflow.V2Beta1.Outputs.GoogleCloudDialogflowV2beta1EntityTypeEntityResponse>

The collection of entities associated with this session entity type.

EntityOverrideMode string

Indicates whether the additional data should override or supplement the custom entity type definition.

Name string

The unique identifier of this session entity type. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions//entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

Entities []GoogleCloudDialogflowV2beta1EntityTypeEntityResponse

The collection of entities associated with this session entity type.

EntityOverrideMode string

Indicates whether the additional data should override or supplement the custom entity type definition.

Name string

The unique identifier of this session entity type. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions//entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

entities List<GoogleCloudDialogflowV2beta1EntityTypeEntityResponse>

The collection of entities associated with this session entity type.

entityOverrideMode String

Indicates whether the additional data should override or supplement the custom entity type definition.

name String

The unique identifier of this session entity type. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions//entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

entities GoogleCloudDialogflowV2beta1EntityTypeEntityResponse[]

The collection of entities associated with this session entity type.

entityOverrideMode string

Indicates whether the additional data should override or supplement the custom entity type definition.

name string

The unique identifier of this session entity type. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions//entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

entities Sequence[GoogleCloudDialogflowV2beta1EntityTypeEntityResponse]

The collection of entities associated with this session entity type.

entity_override_mode str

Indicates whether the additional data should override or supplement the custom entity type definition.

name str

The unique identifier of this session entity type. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions//entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

entities List<Property Map>

The collection of entities associated with this session entity type.

entityOverrideMode String

Indicates whether the additional data should override or supplement the custom entity type definition.

name String

The unique identifier of this session entity type. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions//entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

Supporting Types

GoogleCloudDialogflowV2beta1EntityTypeEntityResponse

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 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 []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 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 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 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 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 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 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 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 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 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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0