Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.dialogflow/v3beta1.SessionEntityType
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a session entity type.
Create SessionEntityType Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SessionEntityType(name: string, args: SessionEntityTypeArgs, opts?: CustomResourceOptions);
@overload
def SessionEntityType(resource_name: str,
args: SessionEntityTypeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SessionEntityType(resource_name: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[str] = None,
entities: Optional[Sequence[GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs]] = None,
entity_override_mode: Optional[SessionEntityTypeEntityOverrideMode] = None,
environment_id: Optional[str] = None,
session_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = 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/v3beta1:SessionEntityType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SessionEntityTypeArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. SessionEntityTypeArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SessionEntityTypeArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. SessionEntityTypeArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var examplesessionEntityTypeResourceResourceFromDialogflowv3beta1 = new GoogleNative.Dialogflow.V3Beta1.SessionEntityType("examplesessionEntityTypeResourceResourceFromDialogflowv3beta1", new()
{
AgentId = "string",
Entities = new[]
{
new GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs
{
Synonyms = new[]
{
"string",
},
Value = "string",
},
},
EntityOverrideMode = GoogleNative.Dialogflow.V3Beta1.SessionEntityTypeEntityOverrideMode.EntityOverrideModeUnspecified,
EnvironmentId = "string",
SessionId = "string",
Location = "string",
Name = "string",
Project = "string",
});
example, err := dialogflowv3beta1.NewSessionEntityType(ctx, "examplesessionEntityTypeResourceResourceFromDialogflowv3beta1", &dialogflowv3beta1.SessionEntityTypeArgs{
AgentId: pulumi.String("string"),
Entities: dialogflow.GoogleCloudDialogflowCxV3beta1EntityTypeEntityArray{
&dialogflow.GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs{
Synonyms: pulumi.StringArray{
pulumi.String("string"),
},
Value: pulumi.String("string"),
},
},
EntityOverrideMode: dialogflowv3beta1.SessionEntityTypeEntityOverrideModeEntityOverrideModeUnspecified,
EnvironmentId: pulumi.String("string"),
SessionId: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
})
var examplesessionEntityTypeResourceResourceFromDialogflowv3beta1 = new SessionEntityType("examplesessionEntityTypeResourceResourceFromDialogflowv3beta1", SessionEntityTypeArgs.builder()
.agentId("string")
.entities(GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs.builder()
.synonyms("string")
.value("string")
.build())
.entityOverrideMode("ENTITY_OVERRIDE_MODE_UNSPECIFIED")
.environmentId("string")
.sessionId("string")
.location("string")
.name("string")
.project("string")
.build());
examplesession_entity_type_resource_resource_from_dialogflowv3beta1 = google_native.dialogflow.v3beta1.SessionEntityType("examplesessionEntityTypeResourceResourceFromDialogflowv3beta1",
agent_id="string",
entities=[{
"synonyms": ["string"],
"value": "string",
}],
entity_override_mode=google_native.dialogflow.v3beta1.SessionEntityTypeEntityOverrideMode.ENTITY_OVERRIDE_MODE_UNSPECIFIED,
environment_id="string",
session_id="string",
location="string",
name="string",
project="string")
const examplesessionEntityTypeResourceResourceFromDialogflowv3beta1 = new google_native.dialogflow.v3beta1.SessionEntityType("examplesessionEntityTypeResourceResourceFromDialogflowv3beta1", {
agentId: "string",
entities: [{
synonyms: ["string"],
value: "string",
}],
entityOverrideMode: google_native.dialogflow.v3beta1.SessionEntityTypeEntityOverrideMode.EntityOverrideModeUnspecified,
environmentId: "string",
sessionId: "string",
location: "string",
name: "string",
project: "string",
});
type: google-native:dialogflow/v3beta1:SessionEntityType
properties:
agentId: string
entities:
- synonyms:
- string
value: string
entityOverrideMode: ENTITY_OVERRIDE_MODE_UNSPECIFIED
environmentId: string
location: string
name: string
project: string
sessionId: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SessionEntityType resource accepts the following input properties:
- Agent
Id This property is required. Changes to this property will trigger replacement.
- Entities
This property is required. List<Pulumi.Google Native. Dialogflow. V3Beta1. Inputs. Google Cloud Dialogflow Cx V3beta1Entity Type Entity> - The collection of entities to override or supplement the custom entity type.
- Entity
Override Mode This property is required. Pulumi.Google Native. Dialogflow. V3Beta1. Session Entity Type Entity Override Mode - Indicates whether the additional data should override or supplement the custom entity type definition.
- Environment
Id This property is required. Changes to this property will trigger replacement.
- Session
Id This property is required. Changes to this property will trigger replacement.
- Location
Changes to this property will trigger replacement.
- Name string
- The unique identifier of the session entity type. Format:
projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. - Project
Changes to this property will trigger replacement.
- Agent
Id This property is required. Changes to this property will trigger replacement.
- Entities
This property is required. []GoogleCloud Dialogflow Cx V3beta1Entity Type Entity Args - The collection of entities to override or supplement the custom entity type.
- Entity
Override Mode This property is required. SessionEntity Type Entity Override Mode - Indicates whether the additional data should override or supplement the custom entity type definition.
- Environment
Id This property is required. Changes to this property will trigger replacement.
- Session
Id This property is required. Changes to this property will trigger replacement.
- Location
Changes to this property will trigger replacement.
- Name string
- The unique identifier of the session entity type. Format:
projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. - Project
Changes to this property will trigger replacement.
- agent
Id This property is required. Changes to this property will trigger replacement.
- entities
This property is required. List<GoogleCloud Dialogflow Cx V3beta1Entity Type Entity> - The collection of entities to override or supplement the custom entity type.
- entity
Override Mode This property is required. SessionEntity Type Entity Override Mode - Indicates whether the additional data should override or supplement the custom entity type definition.
- environment
Id This property is required. Changes to this property will trigger replacement.
- session
Id This property is required. Changes to this property will trigger replacement.
- location
Changes to this property will trigger replacement.
- name String
- The unique identifier of the session entity type. Format:
projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. - project
Changes to this property will trigger replacement.
- agent
Id This property is required. Changes to this property will trigger replacement.
- entities
This property is required. GoogleCloud Dialogflow Cx V3beta1Entity Type Entity[] - The collection of entities to override or supplement the custom entity type.
- entity
Override Mode This property is required. SessionEntity Type Entity Override Mode - Indicates whether the additional data should override or supplement the custom entity type definition.
- environment
Id This property is required. Changes to this property will trigger replacement.
- session
Id This property is required. Changes to this property will trigger replacement.
- location
Changes to this property will trigger replacement.
- name string
- The unique identifier of the session entity type. Format:
projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. - project
Changes to this property will trigger replacement.
- agent_
id This property is required. Changes to this property will trigger replacement.
- entities
This property is required. Sequence[GoogleCloud Dialogflow Cx V3beta1Entity Type Entity Args] - The collection of entities to override or supplement the custom entity type.
- entity_
override_ mode This property is required. SessionEntity Type Entity Override Mode - Indicates whether the additional data should override or supplement the custom entity type definition.
- environment_
id This property is required. Changes to this property will trigger replacement.
- session_
id This property is required. Changes to this property will trigger replacement.
- location
Changes to this property will trigger replacement.
- name str
- The unique identifier of the session entity type. Format:
projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. - project
Changes to this property will trigger replacement.
- agent
Id This property is required. Changes to this property will trigger replacement.
- entities
This property is required. List<Property Map> - The collection of entities to override or supplement the custom entity type.
- entity
Override Mode This property is required. "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.
- environment
Id This property is required. Changes to this property will trigger replacement.
- session
Id This property is required. Changes to this property will trigger replacement.
- location
Changes to this property will trigger replacement.
- name String
- The unique identifier of the session entity type. Format:
projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. - project
Changes to this property will trigger replacement.
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
GoogleCloudDialogflowCxV3beta1EntityTypeEntity, GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs
- 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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_LIST
entity types: * A string that can contain references to other entity types (with or without aliases).
GoogleCloudDialogflowCxV3beta1EntityTypeEntityResponse, GoogleCloudDialogflowCxV3beta1EntityTypeEntityResponseArgs
- 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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
. - 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. ForKIND_LIST
entity types: * A string that can contain references to other entity types (with or without aliases).
SessionEntityTypeEntityOverrideMode, SessionEntityTypeEntityOverrideModeArgs
- Entity
Override Mode Unspecified - ENTITY_OVERRIDE_MODE_UNSPECIFIEDNot specified. This value should be never used.
- Entity
Override Mode Override - ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
- Entity
Override Mode Supplement - ENTITY_OVERRIDE_MODE_SUPPLEMENTThe 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
andUpdateSessionEntityType
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.
- Session
Entity Type Entity Override Mode Entity Override Mode Unspecified - ENTITY_OVERRIDE_MODE_UNSPECIFIEDNot specified. This value should be never used.
- Session
Entity Type Entity Override Mode Entity Override Mode Override - ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
- Session
Entity Type Entity Override Mode Entity Override Mode Supplement - ENTITY_OVERRIDE_MODE_SUPPLEMENTThe 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
andUpdateSessionEntityType
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_UNSPECIFIEDNot specified. This value should be never used.
- Entity
Override Mode Override - ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
- Entity
Override Mode Supplement - ENTITY_OVERRIDE_MODE_SUPPLEMENTThe 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
andUpdateSessionEntityType
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_UNSPECIFIEDNot specified. This value should be never used.
- Entity
Override Mode Override - ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
- Entity
Override Mode Supplement - ENTITY_OVERRIDE_MODE_SUPPLEMENTThe 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
andUpdateSessionEntityType
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_UNSPECIFIEDNot specified. This value should be never used.
- ENTITY_OVERRIDE_MODE_OVERRIDE
- ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
- ENTITY_OVERRIDE_MODE_SUPPLEMENT
- ENTITY_OVERRIDE_MODE_SUPPLEMENTThe 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
andUpdateSessionEntityType
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_UNSPECIFIEDNot specified. This value should be never used.
- "ENTITY_OVERRIDE_MODE_OVERRIDE"
- ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
- "ENTITY_OVERRIDE_MODE_SUPPLEMENT"
- ENTITY_OVERRIDE_MODE_SUPPLEMENTThe 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
andUpdateSessionEntityType
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
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.