Participant

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

new Participant(name: string, args: ParticipantArgs, opts?: CustomResourceOptions);
@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,
                project: Optional[str] = None,
                role: Optional[ParticipantRole] = None,
                sip_recording_media_label: Optional[str] = None)
@overload
def Participant(resource_name: str,
                args: ParticipantArgs,
                opts: Optional[ResourceOptions] = 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/v2:Participant
properties: # The arguments to resource properties.
options: # 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.
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.

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

The Participant resource accepts the following input properties:

ConversationId string
DocumentsMetadataFilters Dictionary<string, string>

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

Project string
Role Pulumi.GoogleNative.Dialogflow.V2.ParticipantRole

Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.

SipRecordingMediaLabel string

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

ConversationId string
DocumentsMetadataFilters map[string]string

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

Project string
Role ParticipantRole

Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.

SipRecordingMediaLabel string

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

conversationId String
documentsMetadataFilters Map<String,String>

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

project String
role ParticipantRole

Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.

sipRecordingMediaLabel String

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

conversationId string
documentsMetadataFilters {[key: string]: string}

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

project string
role ParticipantRole

Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.

sipRecordingMediaLabel string

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

conversation_id str
documents_metadata_filters Mapping[str, str]

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

project str
role ParticipantRole

Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.

sip_recording_media_label str

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

conversationId String
documentsMetadataFilters Map<String>

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

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.

sipRecordingMediaLabel String

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

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 str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

ParticipantRole

RoleUnspecified
ROLE_UNSPECIFIED

Participant role not set.

HumanAgent
HUMAN_AGENT

Participant is a human agent.

AutomatedAgent
AUTOMATED_AGENT

Participant is an automated agent, such as a Dialogflow agent.

EndUser
END_USER

Participant is an end user that has called or chatted with Dialogflow services.

ParticipantRoleRoleUnspecified
ROLE_UNSPECIFIED

Participant role not set.

ParticipantRoleHumanAgent
HUMAN_AGENT

Participant is a human agent.

ParticipantRoleAutomatedAgent
AUTOMATED_AGENT

Participant is an automated agent, such as a Dialogflow agent.

ParticipantRoleEndUser
END_USER

Participant is an end user that has called or chatted with Dialogflow services.

RoleUnspecified
ROLE_UNSPECIFIED

Participant role not set.

HumanAgent
HUMAN_AGENT

Participant is a human agent.

AutomatedAgent
AUTOMATED_AGENT

Participant is an automated agent, such as a Dialogflow agent.

EndUser
END_USER

Participant is an end user that has called or chatted with Dialogflow services.

RoleUnspecified
ROLE_UNSPECIFIED

Participant role not set.

HumanAgent
HUMAN_AGENT

Participant is a human agent.

AutomatedAgent
AUTOMATED_AGENT

Participant is an automated agent, such as a Dialogflow agent.

EndUser
END_USER

Participant is an end user that has called or chatted with Dialogflow services.

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.

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

Package Details

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