1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3beta1
  6. SessionEntityType

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

google-native.dialogflow/v3beta1.SessionEntityType

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

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",
});
Copy
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"),
})
Copy
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());
Copy
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")
Copy
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",
});
Copy
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
Copy

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:

AgentId
This property is required.
Changes to this property will trigger replacement.
string
Entities This property is required. List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EntityTypeEntity>
The collection of entities to override or supplement the custom entity type.
EntityOverrideMode This property is required. Pulumi.GoogleNative.Dialogflow.V3Beta1.SessionEntityTypeEntityOverrideMode
Indicates whether the additional data should override or supplement the custom entity type definition.
EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
SessionId
This property is required.
Changes to this property will trigger replacement.
string
Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
AgentId
This property is required.
Changes to this property will trigger replacement.
string
Entities This property is required. []GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs
The collection of entities to override or supplement the custom entity type.
EntityOverrideMode This property is required. SessionEntityTypeEntityOverrideMode
Indicates whether the additional data should override or supplement the custom entity type definition.
EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
SessionId
This property is required.
Changes to this property will trigger replacement.
string
Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
agentId
This property is required.
Changes to this property will trigger replacement.
String
entities This property is required. List<GoogleCloudDialogflowCxV3beta1EntityTypeEntity>
The collection of entities to override or supplement the custom entity type.
entityOverrideMode This property is required. SessionEntityTypeEntityOverrideMode
Indicates whether the additional data should override or supplement the custom entity type definition.
environmentId
This property is required.
Changes to this property will trigger replacement.
String
sessionId
This property is required.
Changes to this property will trigger replacement.
String
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
agentId
This property is required.
Changes to this property will trigger replacement.
string
entities This property is required. GoogleCloudDialogflowCxV3beta1EntityTypeEntity[]
The collection of entities to override or supplement the custom entity type.
entityOverrideMode This property is required. SessionEntityTypeEntityOverrideMode
Indicates whether the additional data should override or supplement the custom entity type definition.
environmentId
This property is required.
Changes to this property will trigger replacement.
string
sessionId
This property is required.
Changes to this property will trigger replacement.
string
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
agent_id
This property is required.
Changes to this property will trigger replacement.
str
entities This property is required. Sequence[GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs]
The collection of entities to override or supplement the custom entity type.
entity_override_mode This property is required. SessionEntityTypeEntityOverrideMode
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.
str
session_id
This property is required.
Changes to this property will trigger replacement.
str
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
agentId
This property is required.
Changes to this property will trigger replacement.
String
entities This property is required. List<Property Map>
The collection of entities to override or supplement the custom entity type.
entityOverrideMode 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.
environmentId
This property is required.
Changes to this property will trigger replacement.
String
sessionId
This property is required.
Changes to this property will trigger replacement.
String
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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

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

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

SessionEntityTypeEntityOverrideMode
, SessionEntityTypeEntityOverrideModeArgs

EntityOverrideModeUnspecified
ENTITY_OVERRIDE_MODE_UNSPECIFIEDNot specified. This value should be never used.
EntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
EntityOverrideModeSupplement
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 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_UNSPECIFIEDNot specified. This value should be never used.
SessionEntityTypeEntityOverrideModeEntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
SessionEntityTypeEntityOverrideModeEntityOverrideModeSupplement
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 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_UNSPECIFIEDNot specified. This value should be never used.
EntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
EntityOverrideModeSupplement
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 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_UNSPECIFIEDNot specified. This value should be never used.
EntityOverrideModeOverride
ENTITY_OVERRIDE_MODE_OVERRIDEThe collection of session entities overrides the collection of entities in the corresponding custom entity type.
EntityOverrideModeSupplement
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 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_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 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_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 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
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