Struct google_api_proto::google::cloud::dialogflow::v2::Participant

pub struct Participant {
    pub name: String,
    pub role: i32,
    pub sip_recording_media_label: String,
    pub obfuscated_external_user_id: String,
    pub documents_metadata_filters: BTreeMap<String, String>,
}

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

Fields

name: String

Optional. The unique identifier of this participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

role: i32

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

obfuscated_external_user_id: 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][google.cloud.dialogflow.v2.CreateParticipantRequest.participant] or [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant], 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][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

Dialogflow returns an error if you try to add a user id for a non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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.

documents_metadata_filters: BTreeMap<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][google.cloud.dialogflow.v2.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"
}

Implementations

impl Participant

pub fn role(&self) -> Role

Returns the enum value of role, or the default if the field is set to an invalid enum value.

pub fn set_role(&mut self, value: Role)

Sets role to the provided enum value.

Trait Implementations

impl Clone for Participant

fn clone(&self) -> Participant

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Participant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Participant

fn default() -> Self

Returns the “default value” for a type.

impl Message for Participant

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Participant

fn eq(&self, other: &Participant) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Participant