Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2
  6. Participant

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

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 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,
                sip_recording_media_label: Optional[str] = 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.

    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.

    Example

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

    var participantResource = new GoogleNative.Dialogflow.V2.Participant("participantResource", new()
{
    ConversationId = "string",
    DocumentsMetadataFilters = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    ObfuscatedExternalUserId = "string",
    Project = "string",
    Role = GoogleNative.Dialogflow.V2.ParticipantRole.RoleUnspecified,
    SipRecordingMediaLabel = "string",
});

    example, err := dialogflow.NewParticipant(ctx, "participantResource", &dialogflow.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: dialogflow.ParticipantRoleRoleUnspecified,
SipRecordingMediaLabel: pulumi.String("string"),
})

    var participantResource = new Participant("participantResource", ParticipantArgs.builder()        
    .conversationId("string")
    .documentsMetadataFilters(Map.of("string", "string"))
    .location("string")
    .name("string")
    .obfuscatedExternalUserId("string")
    .project("string")
    .role("ROLE_UNSPECIFIED")
    .sipRecordingMediaLabel("string")
    .build());

    participant_resource = google_native.dialogflow.v2.Participant("participantResource",
    conversation_id="string",
    documents_metadata_filters={
        "string": "string",
    },
    location="string",
    name="string",
    obfuscated_external_user_id="string",
    project="string",
    role=google_native.dialogflow.v2.ParticipantRole.ROLE_UNSPECIFIED,
    sip_recording_media_label="string")

    const participantResource = new google_native.dialogflow.v2.Participant("participantResource", {
    conversationId: "string",
    documentsMetadataFilters: {
        string: "string",
    },
    location: "string",
    name: "string",
    obfuscatedExternalUserId: "string",
    project: "string",
    role: google_native.dialogflow.v2.ParticipantRole.RoleUnspecified,
    sipRecordingMediaLabel: "string",
});

    type: google-native:dialogflow/v2:Participant
properties:
    conversationId: string
    documentsMetadataFilters:
        string: string
    location: string
    name: string
    obfuscatedExternalUserId: string
    project: string
    role: ROLE_UNSPECIFIED
    sipRecordingMediaLabel: string

    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/.
    ObfuscatedExternalUserId string
    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 returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. 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.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/.
    ObfuscatedExternalUserId string
    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 returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. 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 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/.
    obfuscatedExternalUserId String
    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 returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. 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 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/.
    obfuscatedExternalUserId string
    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 returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. 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 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/.
    obfuscated_external_user_id str
    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 returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. 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 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/.
    obfuscatedExternalUserId String
    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 returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. 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.
    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, ParticipantRoleArgs

    RoleUnspecified
    ROLE_UNSPECIFIEDParticipant role not set.
    HumanAgent
    HUMAN_AGENTParticipant is a human agent.
    AutomatedAgent
    AUTOMATED_AGENTParticipant is an automated agent, such as a Dialogflow agent.
    EndUser
    END_USERParticipant is an end user that has called or chatted with Dialogflow services.
    ParticipantRoleRoleUnspecified
    ROLE_UNSPECIFIEDParticipant role not set.
    ParticipantRoleHumanAgent
    HUMAN_AGENTParticipant is a human agent.
    ParticipantRoleAutomatedAgent
    AUTOMATED_AGENTParticipant is an automated agent, such as a Dialogflow agent.
    ParticipantRoleEndUser
    END_USERParticipant is an end user that has called or chatted with Dialogflow services.
    RoleUnspecified
    ROLE_UNSPECIFIEDParticipant role not set.
    HumanAgent
    HUMAN_AGENTParticipant is a human agent.
    AutomatedAgent
    AUTOMATED_AGENTParticipant is an automated agent, such as a Dialogflow agent.
    EndUser
    END_USERParticipant is an end user that has called or chatted with Dialogflow services.
    RoleUnspecified
    ROLE_UNSPECIFIEDParticipant role not set.
    HumanAgent
    HUMAN_AGENTParticipant is a human agent.
    AutomatedAgent
    AUTOMATED_AGENTParticipant is an automated agent, such as a Dialogflow agent.
    EndUser
    END_USERParticipant is an end user that has called or chatted with Dialogflow services.
    ROLE_UNSPECIFIED
    ROLE_UNSPECIFIEDParticipant role not set.
    HUMAN_AGENT
    HUMAN_AGENTParticipant is a human agent.
    AUTOMATED_AGENT
    AUTOMATED_AGENTParticipant is an automated agent, such as a Dialogflow agent.
    END_USER
    END_USERParticipant is an end user that has called or chatted with Dialogflow services.
    "ROLE_UNSPECIFIED"
    ROLE_UNSPECIFIEDParticipant role not set.
    "HUMAN_AGENT"
    HUMAN_AGENTParticipant is a human agent.
    "AUTOMATED_AGENT"
    AUTOMATED_AGENTParticipant is an automated agent, such as a Dialogflow agent.
    "END_USER"
    END_USERParticipant 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
    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