Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3
  6. getSessionEntityType

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.getSessionEntityType

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 session entity type.

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

> 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)
}
Copy
public static CompletableFuture<GetSessionEntityTypeResult> getSessionEntityType(GetSessionEntityTypeArgs args, InvokeOptions options)
public static Output<GetSessionEntityTypeResult> getSessionEntityType(GetSessionEntityTypeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:dialogflow/v3:getSessionEntityType
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AgentId This property is required. string
EntityTypeId This property is required. string
EnvironmentId This property is required. string
Location This property is required. string
SessionId This property is required. string
Project string
AgentId This property is required. string
EntityTypeId This property is required. string
EnvironmentId This property is required. string
Location This property is required. string
SessionId This property is required. string
Project string
agentId This property is required. String
entityTypeId This property is required. String
environmentId This property is required. String
location This property is required. String
sessionId This property is required. String
project String
agentId This property is required. string
entityTypeId This property is required. string
environmentId This property is required. string
location This property is required. string
sessionId This property is required. string
project string
agent_id This property is required. str
entity_type_id This property is required. str
environment_id This property is required. str
location This property is required. str
session_id This property is required. str
project str
agentId This property is required. String
entityTypeId This property is required. String
environmentId This property is required. String
location This property is required. String
sessionId This property is required. String
project String

getSessionEntityType Result

The following output properties are available:

Entities List<Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3EntityTypeEntityResponse>
The collection of entities to override or supplement the custom entity type.
EntityOverrideMode string
Indicates whether the additional data should override or supplement the custom entity type definition.
Name string
The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.
Entities []GoogleCloudDialogflowCxV3EntityTypeEntityResponse
The collection of entities to override or supplement the custom entity type.
EntityOverrideMode string
Indicates whether the additional data should override or supplement the custom entity type definition.
Name string
The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.
entities List<GoogleCloudDialogflowCxV3EntityTypeEntityResponse>
The collection of entities to override or supplement the custom entity type.
entityOverrideMode String
Indicates whether the additional data should override or supplement the custom entity type definition.
name String
The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.
entities GoogleCloudDialogflowCxV3EntityTypeEntityResponse[]
The collection of entities to override or supplement the custom entity type.
entityOverrideMode string
Indicates whether the additional data should override or supplement the custom entity type definition.
name string
The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.
entities Sequence[GoogleCloudDialogflowCxV3EntityTypeEntityResponse]
The collection of entities to override or supplement the custom 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 the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.
entities List<Property Map>
The collection of entities to override or supplement the custom entity type.
entityOverrideMode String
Indicates whether the additional data should override or supplement the custom entity type definition.
name String
The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

Supporting Types

GoogleCloudDialogflowCxV3EntityTypeEntityResponse

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 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 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 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 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 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 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 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 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 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 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 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).

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