Class: Google::Cloud::Dialogflow::V2::Participant

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/participant.rb

Overview

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

Defined Under Namespace

Modules: Role Classes: DocumentsMetadataFiltersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#documents_metadata_filters ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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"
}



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 93

class Participant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DocumentsMetadataFiltersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of the roles a participant can play in a conversation.
  module Role
    # Participant role not set.
    ROLE_UNSPECIFIED = 0

    # Participant is a human agent.
    HUMAN_AGENT = 1

    # Participant is an automated agent, such as a Dialogflow agent.
    AUTOMATED_AGENT = 2

    # Participant is an end user that has called or chatted with
    # Dialogflow services.
    END_USER = 3
  end
end

#name ⇒ ::String

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 93

class Participant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DocumentsMetadataFiltersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of the roles a participant can play in a conversation.
  module Role
    # Participant role not set.
    ROLE_UNSPECIFIED = 0

    # Participant is a human agent.
    HUMAN_AGENT = 1

    # Participant is an automated agent, such as a Dialogflow agent.
    AUTOMATED_AGENT = 2

    # Participant is an end user that has called or chatted with
    # Dialogflow services.
    END_USER = 3
  end
end

#obfuscated_external_user_id ⇒ ::String

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

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


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 93

class Participant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DocumentsMetadataFiltersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of the roles a participant can play in a conversation.
  module Role
    # Participant role not set.
    ROLE_UNSPECIFIED = 0

    # Participant is a human agent.
    HUMAN_AGENT = 1

    # Participant is an automated agent, such as a Dialogflow agent.
    AUTOMATED_AGENT = 2

    # Participant is an end user that has called or chatted with
    # Dialogflow services.
    END_USER = 3
  end
end

#role ⇒ ::Google::Cloud::Dialogflow::V2::Participant::Role

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

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 93

class Participant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DocumentsMetadataFiltersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of the roles a participant can play in a conversation.
  module Role
    # Participant role not set.
    ROLE_UNSPECIFIED = 0

    # Participant is a human agent.
    HUMAN_AGENT = 1

    # Participant is an automated agent, such as a Dialogflow agent.
    AUTOMATED_AGENT = 2

    # Participant is an end user that has called or chatted with
    # Dialogflow services.
    END_USER = 3
  end
end

#sip_recording_media_label ⇒ ::String

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 93

class Participant
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DocumentsMetadataFiltersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of the roles a participant can play in a conversation.
  module Role
    # Participant role not set.
    ROLE_UNSPECIFIED = 0

    # Participant is a human agent.
    HUMAN_AGENT = 1

    # Participant is an automated agent, such as a Dialogflow agent.
    AUTOMATED_AGENT = 2

    # Participant is an end user that has called or chatted with
    # Dialogflow services.
    END_USER = 3
  end
end