SessionEntityType

Creates a session entity type.

Create SessionEntityType Resource

new SessionEntityType(name: string, args: SessionEntityTypeArgs, opts?: CustomResourceOptions);
@overload
def SessionEntityType(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      agent_id: Optional[str] = None,
                      entities: Optional[Sequence[GoogleCloudDialogflowCxV3EntityTypeEntityArgs]] = None,
                      entity_override_mode: Optional[SessionEntityTypeEntityOverrideMode] = None,
                      environment_id: Optional[str] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      project: Optional[str] = None,
                      session_id: Optional[str] = None)
@overload
def SessionEntityType(resource_name: str,
                      args: SessionEntityTypeArgs,
                      opts: Optional[ResourceOptions] = None)
func NewSessionEntityType(ctx *Context, name string, args SessionEntityTypeArgs, opts ...ResourceOption) (*SessionEntityType, error)
public SessionEntityType(string name, SessionEntityTypeArgs args, CustomResourceOptions? opts = null)
public SessionEntityType(String name, SessionEntityTypeArgs args)
public SessionEntityType(String name, SessionEntityTypeArgs args, CustomResourceOptions options)
type: google-native:dialogflow/v3:SessionEntityType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

AgentId string
Entities List<Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3EntityTypeEntityArgs>

The collection of entities to override or supplement the custom entity type.

EntityOverrideMode Pulumi.GoogleNative.Dialogflow.V3.SessionEntityTypeEntityOverrideMode

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

EnvironmentId string
SessionId string
Location string
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.

Project string
AgentId string
Entities []GoogleCloudDialogflowCxV3EntityTypeEntityArgs

The collection of entities to override or supplement the custom entity type.

EntityOverrideMode SessionEntityTypeEntityOverrideMode

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

EnvironmentId string
SessionId string
Location string
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.

Project string
agentId String
entities List<GoogleCloudDialogflowCxV3EntityTypeEntityArgs>

The collection of entities to override or supplement the custom entity type.

entityOverrideMode SessionEntityTypeEntityOverrideMode

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

environmentId String
sessionId String
location String
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.

project String
agentId string
entities GoogleCloudDialogflowCxV3EntityTypeEntityArgs[]

The collection of entities to override or supplement the custom entity type.

entityOverrideMode SessionEntityTypeEntityOverrideMode

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

environmentId string
sessionId string
location string
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.

project string
agent_id str
entities Sequence[GoogleCloudDialogflowCxV3EntityTypeEntityArgs]

The collection of entities to override or supplement the custom entity type.

entity_override_mode SessionEntityTypeEntityOverrideMode

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

environment_id str
session_id str
location str
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.

project str
agentId String
entities List<Property Map>

The collection of entities to override or supplement the custom entity type.

entityOverrideMode "ENTITY_OVERRIDE_MODE_UNSPECIFIED" | "ENTITY_OVERRIDE_MODE_OVERRIDE" | "ENTITY_OVERRIDE_MODE_SUPPLEMENT"

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

environmentId String
sessionId String
location String
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.

project String

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

GoogleCloudDialogflowCxV3EntityTypeEntity

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

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

SessionEntityTypeEntityOverrideMode

EntityOverrideModeUnspecified
ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

EntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDE

The collection of session entities overrides the collection of entities in the corresponding custom entity type.

EntityOverrideModeSupplement
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.

SessionEntityTypeEntityOverrideModeEntityOverrideModeUnspecified
ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

SessionEntityTypeEntityOverrideModeEntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDE

The collection of session entities overrides the collection of entities in the corresponding custom entity type.

SessionEntityTypeEntityOverrideModeEntityOverrideModeSupplement
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.

EntityOverrideModeUnspecified
ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

EntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDE

The collection of session entities overrides the collection of entities in the corresponding custom entity type.

EntityOverrideModeSupplement
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.

EntityOverrideModeUnspecified
ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

EntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDE

The collection of session entities overrides the collection of entities in the corresponding custom entity type.

EntityOverrideModeSupplement
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.

ENTITY_OVERRIDE_MODE_UNSPECIFIED
ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

ENTITY_OVERRIDE_MODE_OVERRIDE
ENTITY_OVERRIDE_MODE_OVERRIDE

The collection of session entities overrides the collection of entities in the corresponding custom entity type.

ENTITY_OVERRIDE_MODE_SUPPLEMENT
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.

"ENTITY_OVERRIDE_MODE_UNSPECIFIED"
ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

"ENTITY_OVERRIDE_MODE_OVERRIDE"
ENTITY_OVERRIDE_MODE_OVERRIDE

The collection of session entities overrides the collection of entities in the corresponding custom entity type.

"ENTITY_OVERRIDE_MODE_SUPPLEMENT"
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0