This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
Creates a new participant in a conversation. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
Create Participant Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Participant(name: string, args: ParticipantArgs, opts?: CustomResourceOptions);@overload
def Participant(resource_name: str,
args: ParticipantArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Participant(resource_name: str,
opts: Optional[ResourceOptions] = None,
conversation_id: Optional[str] = None,
documents_metadata_filters: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
name: Optional[str] = None,
obfuscated_external_user_id: Optional[str] = None,
project: Optional[str] = None,
role: Optional[ParticipantRole] = None)func NewParticipant(ctx *Context, name string, args ParticipantArgs, opts ...ResourceOption) (*Participant, error)public Participant(string name, ParticipantArgs args, CustomResourceOptions? opts = null)
public Participant(String name, ParticipantArgs args)
public Participant(String name, ParticipantArgs args, CustomResourceOptions options)
type: google-native:dialogflow/v2beta1:Participant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_dialogflow_v2beta1_participant" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ParticipantArgs
- 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 ParticipantArgs
- 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 ParticipantArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ParticipantArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ParticipantArgs
- 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 google_nativeParticipantResource = new GoogleNative.Dialogflow.V2Beta1.Participant("google-nativeParticipantResource", new()
{
ConversationId = "string",
DocumentsMetadataFilters =
{
{ "string", "string" },
},
Location = "string",
Name = "string",
ObfuscatedExternalUserId = "string",
Project = "string",
Role = GoogleNative.Dialogflow.V2Beta1.ParticipantRole.RoleUnspecified,
});
example, err := dialogflowv2beta1.NewParticipant(ctx, "google-nativeParticipantResource", &dialogflowv2beta1.ParticipantArgs{
ConversationId: pulumi.String("string"),
DocumentsMetadataFilters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
ObfuscatedExternalUserId: pulumi.String("string"),
Project: pulumi.String("string"),
Role: dialogflowv2beta1.ParticipantRoleRoleUnspecified,
})
resource "google-native_dialogflow_v2beta1_participant" "google-nativeParticipantResource" {
lifecycle {
create_before_destroy = true
}
conversation_id = "string"
documents_metadata_filters = {
"string" = "string"
}
location = "string"
name = "string"
obfuscated_external_user_id = "string"
project = "string"
role = "ROLE_UNSPECIFIED"
}
var google_nativeParticipantResource = new com.pulumi.googlenative.dialogflow_v2beta1.Participant("google-nativeParticipantResource", com.pulumi.googlenative.dialogflow_v2beta1.ParticipantArgs.builder()
.conversationId("string")
.documentsMetadataFilters(Map.of("string", "string"))
.location("string")
.name("string")
.obfuscatedExternalUserId("string")
.project("string")
.role(com.pulumi.googlenative.dialogflow_v2beta1.enums.ParticipantRole.RoleUnspecified)
.build());
google_native_participant_resource = google_native.dialogflow.v2beta1.Participant("google-nativeParticipantResource",
conversation_id="string",
documents_metadata_filters={
"string": "string",
},
location="string",
name="string",
obfuscated_external_user_id="string",
project="string",
role=google_native.dialogflow.v2beta1.ParticipantRole.ROLE_UNSPECIFIED)
const google_nativeParticipantResource = new google_native.dialogflow.v2beta1.Participant("google-nativeParticipantResource", {
conversationId: "string",
documentsMetadataFilters: {
string: "string",
},
location: "string",
name: "string",
obfuscatedExternalUserId: "string",
project: "string",
role: google_native.dialogflow.v2beta1.ParticipantRole.RoleUnspecified,
});
type: google-native:dialogflow/v2beta1:Participant
properties:
conversationId: string
documentsMetadataFilters:
string: string
location: string
name: string
obfuscatedExternalUserId: string
project: string
role: ROLE_UNSPECIFIED
Participant 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 Participant resource accepts the following input properties:
- Conversation
Id string - Documents
Metadata Dictionary<string, string>Filters - Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } - Location string
- Name string
- Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/. - Obfuscated
External stringUser Id - Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters.
- Project string
- Role
Pulumi.
Google Native. Dialogflow. V2Beta1. Participant Role - Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- Conversation
Id string - Documents
Metadata map[string]stringFilters - Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } - Location string
- Name string
- Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/. - Obfuscated
External stringUser Id - Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters.
- Project string
- Role
Participant
Role - Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- conversation_
id string - documents_
metadata_ map(string)filters - Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } - location string
- name string
- Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/. - obfuscated_
external_ stringuser_ id - Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters.
- project string
- role "ROLE_UNSPECIFIED" | "HUMAN_AGENT" | "AUTOMATED_AGENT" | "END_USER"
- Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- conversation
Id String - documents
Metadata Map<String,String>Filters - Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } - location String
- name String
- Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/. - obfuscated
External StringUser Id - Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters.
- project String
- role
Participant
Role - Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- conversation
Id string - documents
Metadata {[key: string]: string}Filters - Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } - location string
- name string
- Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/. - obfuscated
External stringUser Id - Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters.
- project string
- role
Participant
Role - Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- conversation_
id str - documents_
metadata_ Mapping[str, str]filters - Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } - location str
- name str
- Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/. - obfuscated_
external_ struser_ id - Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters.
- project str
- role
Participant
Role - Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
- conversation
Id String - documents
Metadata Map<String>Filters - Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } - location String
- name String
- Optional. The unique identifier of this participant. Format:
projects//locations//conversations//participants/. - obfuscated
External StringUser Id - Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters.
- project String
- role "ROLE_UNSPECIFIED" | "HUMAN_AGENT" | "AUTOMATED_AGENT" | "END_USER"
- Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
Outputs
All input properties are implicitly available as output properties. Additionally, the Participant 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 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.
Look up Existing Participant Resource
Get an existing Participant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Participant@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Participantfunc GetParticipant(ctx *Context, name string, id IDInput, state *ParticipantState, opts ...ResourceOption) (*Participant, error)public static Participant Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Participant get(String name, Output<String> id, CustomResourceOptions options)resources: existingParticipant: type: google-native:dialogflow/v2beta1:Participant get: id: ${id}import {
to = google-native_dialogflow_v2beta1_participant.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ParticipantState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
ParticipantRole, ParticipantRoleArgs
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.| Name | Value | Description |
|---|---|---|
| Role | ROLE_UNSPECIFIED | Participant role not set. |
| Human | HUMAN_AGENT | Participant is a human agent. |
| Automated | AUTOMATED_AGENT | Participant is an automated agent, such as a Dialogflow agent. |
| End | END_USER | Participant is an end user that has called or chatted with Dialogflow services. |
| Name | Value | Description |
|---|---|---|
| Participant | ROLE_UNSPECIFIED | Participant role not set. |
| Participant | HUMAN_AGENT | Participant is a human agent. |
| Participant | AUTOMATED_AGENT | Participant is an automated agent, such as a Dialogflow agent. |
| Participant | END_USER | Participant is an end user that has called or chatted with Dialogflow services. |
| Value | Description |
|---|---|
ROLE_UNSPECIFIED | Participant role not set. |
HUMAN_AGENT | Participant is a human agent. |
AUTOMATED_AGENT | Participant is an automated agent, such as a Dialogflow agent. |
END_USER | Participant is an end user that has called or chatted with Dialogflow services. |
| Name | Value | Description |
|---|---|---|
| Role | ROLE_UNSPECIFIED | Participant role not set. |
| Human | HUMAN_AGENT | Participant is a human agent. |
| Automated | AUTOMATED_AGENT | Participant is an automated agent, such as a Dialogflow agent. |
| End | END_USER | Participant is an end user that has called or chatted with Dialogflow services. |
| Name | Value | Description |
|---|---|---|
| Role | ROLE_UNSPECIFIED | Participant role not set. |
| Human | HUMAN_AGENT | Participant is a human agent. |
| Automated | AUTOMATED_AGENT | Participant is an automated agent, such as a Dialogflow agent. |
| End | END_USER | Participant is an end user that has called or chatted with Dialogflow services. |
| Name | Value | Description |
|---|---|---|
| ROLE_UNSPECIFIED | ROLE_UNSPECIFIED | Participant role not set. |
| HUMAN_AGENT | HUMAN_AGENT | Participant is a human agent. |
| AUTOMATED_AGENT | AUTOMATED_AGENT | Participant is an automated agent, such as a Dialogflow agent. |
| END_USER | END_USER | Participant is an end user that has called or chatted with Dialogflow services. |
| Value | Description |
|---|---|
ROLE_UNSPECIFIED | Participant role not set. |
HUMAN_AGENT | Participant is a human agent. |
AUTOMATED_AGENT | Participant is an automated agent, such as a Dialogflow agent. |
END_USER | Participant is an end user that has called or chatted with Dialogflow services. |
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi