Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2
  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
pulumi/pulumi-google-native

google-native.dialogflow/v2.SessionEntityType

Explore with Pulumi AI

google-native logo

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

    Creates a session entity type. If the specified session entity type already exists, overrides the 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. Auto-naming is currently not supported for this resource.

    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,
                      entities: Optional[Sequence[GoogleCloudDialogflowV2EntityTypeEntityArgs]] = None,
                      entity_override_mode: Optional[SessionEntityTypeEntityOverrideMode] = None,
                      environment_id: Optional[str] = None,
                      name: Optional[str] = None,
                      session_id: Optional[str] = None,
                      user_id: Optional[str] = None,
                      location: 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/v2:SessionEntityType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sessionEntityTypeResource = new GoogleNative.Dialogflow.V2.SessionEntityType("sessionEntityTypeResource", new()
{
    Entities = new[]
    {
        new GoogleNative.Dialogflow.V2.Inputs.GoogleCloudDialogflowV2EntityTypeEntityArgs
        {
            Synonyms = new[]
            {
                "string",
            },
            Value = "string",
        },
    },
    EntityOverrideMode = GoogleNative.Dialogflow.V2.SessionEntityTypeEntityOverrideMode.EntityOverrideModeUnspecified,
    EnvironmentId = "string",
    Name = "string",
    SessionId = "string",
    UserId = "string",
    Location = "string",
    Project = "string",
});

    example, err := dialogflow.NewSessionEntityType(ctx, "sessionEntityTypeResource", &dialogflow.SessionEntityTypeArgs{
Entities: dialogflow.GoogleCloudDialogflowV2EntityTypeEntityArray{
&dialogflow.GoogleCloudDialogflowV2EntityTypeEntityArgs{
Synonyms: pulumi.StringArray{
pulumi.String("string"),
},
Value: pulumi.String("string"),
},
},
EntityOverrideMode: dialogflow.SessionEntityTypeEntityOverrideModeEntityOverrideModeUnspecified,
EnvironmentId: pulumi.String("string"),
Name: pulumi.String("string"),
SessionId: pulumi.String("string"),
UserId: pulumi.String("string"),
Location: pulumi.String("string"),
Project: pulumi.String("string"),
})

    var sessionEntityTypeResource = new SessionEntityType("sessionEntityTypeResource", SessionEntityTypeArgs.builder()
    .entities(GoogleCloudDialogflowV2EntityTypeEntityArgs.builder()
        .synonyms("string")
        .value("string")
        .build())
    .entityOverrideMode("ENTITY_OVERRIDE_MODE_UNSPECIFIED")
    .environmentId("string")
    .name("string")
    .sessionId("string")
    .userId("string")
    .location("string")
    .project("string")
    .build());

    session_entity_type_resource = google_native.dialogflow.v2.SessionEntityType("sessionEntityTypeResource",
    entities=[google_native.dialogflow.v2.GoogleCloudDialogflowV2EntityTypeEntityArgs(
        synonyms=["string"],
        value="string",
    )],
    entity_override_mode=google_native.dialogflow.v2.SessionEntityTypeEntityOverrideMode.ENTITY_OVERRIDE_MODE_UNSPECIFIED,
    environment_id="string",
    name="string",
    session_id="string",
    user_id="string",
    location="string",
    project="string")

    const sessionEntityTypeResource = new google_native.dialogflow.v2.SessionEntityType("sessionEntityTypeResource", {
    entities: [{
        synonyms: ["string"],
        value: "string",
    }],
    entityOverrideMode: google_native.dialogflow.v2.SessionEntityTypeEntityOverrideMode.EntityOverrideModeUnspecified,
    environmentId: "string",
    name: "string",
    sessionId: "string",
    userId: "string",
    location: "string",
    project: "string",
});

    type: google-native:dialogflow/v2:SessionEntityType
properties:
    entities:
        - synonyms:
            - string
          value: string
    entityOverrideMode: ENTITY_OVERRIDE_MODE_UNSPECIFIED
    environmentId: string
    location: string
    name: string
    project: string
    sessionId: string
    userId: 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

    The SessionEntityType resource accepts the following input properties:

    Entities List<Pulumi.GoogleNative.Dialogflow.V2.Inputs.GoogleCloudDialogflowV2EntityTypeEntity>
    The collection of entities associated with this session entity type.
    EntityOverrideMode Pulumi.GoogleNative.Dialogflow.V2.SessionEntityTypeEntityOverrideMode
    Indicates whether the additional data should override or supplement the custom entity type definition.
    EnvironmentId string
    Name string
    The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. 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.
    SessionId string
    UserId string
    Location string
    Project string
    Entities []GoogleCloudDialogflowV2EntityTypeEntityArgs
    The collection of entities associated with this session entity type.
    EntityOverrideMode SessionEntityTypeEntityOverrideMode
    Indicates whether the additional data should override or supplement the custom entity type definition.
    EnvironmentId string
    Name string
    The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. 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.
    SessionId string
    UserId string
    Location string
    Project string
    entities List<GoogleCloudDialogflowV2EntityTypeEntity>
    The collection of entities associated with this session entity type.
    entityOverrideMode SessionEntityTypeEntityOverrideMode
    Indicates whether the additional data should override or supplement the custom entity type definition.
    environmentId String
    name String
    The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. 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.
    sessionId String
    userId String
    location String
    project String
    entities GoogleCloudDialogflowV2EntityTypeEntity[]
    The collection of entities associated with this session entity type.
    entityOverrideMode SessionEntityTypeEntityOverrideMode
    Indicates whether the additional data should override or supplement the custom entity type definition.
    environmentId string
    name string
    The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. 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.
    sessionId string
    userId string
    location string
    project string
    entities Sequence[GoogleCloudDialogflowV2EntityTypeEntityArgs]
    The collection of entities associated with this session entity type.
    entity_override_mode SessionEntityTypeEntityOverrideMode
    Indicates whether the additional data should override or supplement the custom entity type definition.
    environment_id str
    name str
    The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. 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.
    session_id str
    user_id str
    location str
    project str
    entities List<Property Map>
    The collection of entities associated with this session 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
    name String
    The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. 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.
    sessionId String
    userId String
    location String
    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

    GoogleCloudDialogflowV2EntityTypeEntity, GoogleCloudDialogflowV2EntityTypeEntityArgs

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

    GoogleCloudDialogflowV2EntityTypeEntityResponse, GoogleCloudDialogflowV2EntityTypeEntityResponseArgs

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

    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-native logo

    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