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>.
#role
def role() -> ::Google::Cloud::Dialogflow::V2::Participant::Role
Returns
- (::Google::Cloud::Dialogflow::V2::Participant::Role) — Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
#role=
def role=(value) -> ::Google::Cloud::Dialogflow::V2::Participant::Role
Parameter
- value (::Google::Cloud::Dialogflow::V2::Participant::Role) — Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
Returns
- (::Google::Cloud::Dialogflow::V2::Participant::Role) — 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
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.