Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Participant (v0.19.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Participant.

Represents a conversation participant (human agent, virtual agent, end-user).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#documents_metadata_filters

def documents_metadata_filters() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::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" }

#documents_metadata_filters=

def documents_metadata_filters=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::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" }
Returns
  • (::Google::Protobuf::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" }

#name

def name() -> ::String
Returns
  • (::String) — Optional. The unique identifier of this participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Optional. The unique identifier of this participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.
Returns
  • (::String) — Optional. The unique identifier of this participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

#obfuscated_external_user_id

def obfuscated_external_user_id() -> ::String
Returns
  • (::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][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id] or [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id], 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.

#obfuscated_external_user_id=

def obfuscated_external_user_id=(value) -> ::String
Parameter
  • value (::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][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id] or [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id], 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.
Returns
  • (::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][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id] or [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id], 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.

#role

def role() -> ::Google::Cloud::Dialogflow::V2::Participant::Role
Returns

#role=

def role=(value) -> ::Google::Cloud::Dialogflow::V2::Participant::Role
Parameter
Returns

#sip_recording_media_label

def sip_recording_media_label() -> ::String
Returns
  • (::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.

#sip_recording_media_label=

def sip_recording_media_label=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.