Class: Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig

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

Overview

Defines the Human Agent Assist to connect to a conversation.

Defined Under Namespace

Classes: ConversationModelConfig, ConversationProcessConfig, MessageAnalysisConfig, SuggestionConfig, SuggestionFeatureConfig, SuggestionQueryConfig, SuggestionTriggerSettings

Instance Attribute Summary collapse

Instance Attribute Details

#end_user_suggestion_config ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig

Returns Configuration for agent assistance of end user participant.

Currently, this feature is not general available, please contact Google to get access.

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 226

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

  # Settings of suggestion trigger.
  # @!attribute [rw] no_smalltalk
  #   @return [::Boolean]
  #     Do not trigger if last utterance is small talk.
  # @!attribute [rw] only_end_user
  #   @return [::Boolean]
  #     Only trigger suggestion if participant role of last utterance is
  #     END_USER.
  class SuggestionTriggerSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion features.
  # @!attribute [rw] suggestion_feature
  #   @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature]
  #     The suggestion feature.
  # @!attribute [rw] enable_event_based_suggestion
  #   @return [::Boolean]
  #     Automatically iterates all participants and tries to compile
  #     suggestions.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST,
  #     KNOWLEDGE_ASSIST.
  # @!attribute [rw] disable_agent_query_logging
  #   @return [::Boolean]
  #     Optional. Disable the logging of search queries sent by human agents. It
  #     can prevent those queries from being stored at answer records.
  #
  #     Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_when_no_answer
  #   @return [::Boolean]
  #     Optional. Enable query suggestion even if we can't find its answer.
  #     By default, queries are suggested only if we find its answer.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] enable_conversation_augmented_query
  #   @return [::Boolean]
  #     Optional. Enable including conversation context during query answer
  #     generation. Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_only
  #   @return [::Boolean]
  #     Optional. Enable query suggestion only.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] suggestion_trigger_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionTriggerSettings]
  #     Settings of suggestion trigger.
  #
  #     Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
  # @!attribute [rw] query_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig]
  #     Configs of query.
  # @!attribute [rw] conversation_model_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig]
  #     Configs of custom conversation model.
  # @!attribute [rw] conversation_process_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationProcessConfig]
  #     Configs for processing conversation.
  class SuggestionFeatureConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Detail human agent assistant config.
  # @!attribute [rw] feature_configs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig>]
  #     Configuration of different suggestion features. One feature can have only
  #     one config.
  # @!attribute [rw] group_suggestion_responses
  #   @return [::Boolean]
  #     If `group_suggestion_responses` is false, and there are multiple
  #     `feature_configs` in `event based suggestion` or
  #     StreamingAnalyzeContent, we will try to deliver suggestions to customers
  #     as soon as we get new suggestion. Different type of suggestions based on
  #     the same context will be in  separate Pub/Sub event or
  #     `StreamingAnalyzeContentResponse`.
  #
  #     If `group_suggestion_responses` set to true. All the suggestions to the
  #     same participant based on the same context will be grouped into a single
  #     Pub/Sub event or StreamingAnalyzeContentResponse.
  # @!attribute [rw] generators
  #   @return [::Array<::String>]
  #     Optional. List of various generator resource names used in the
  #     conversation profile.
  # @!attribute [rw] disable_high_latency_features_sync_delivery
  #   @return [::Boolean]
  #     Optional. When disable_high_latency_features_sync_delivery is true and
  #     using the AnalyzeContent API, we will not deliver the responses from high
  #     latency features in the API response. The
  #     human_agent_assistant_config.notification_config must be configured and
  #     enable_event_based_suggestion must be set to true to receive the
  #     responses from high latency features in Pub/Sub. High latency feature(s):
  #     KNOWLEDGE_ASSIST
  class SuggestionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion query.
  # @!attribute [rw] knowledge_base_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::KnowledgeBaseQuerySource]
  #     Query from knowledgebase. It is used by:
  #     ARTICLE_SUGGESTION, FAQ.
  # @!attribute [rw] document_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DocumentQuerySource]
  #     Query from knowledge base document. It is used by:
  #     SMART_REPLY, SMART_COMPOSE.
  # @!attribute [rw] dialogflow_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource]
  #     Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
  # @!attribute [rw] max_results
  #   @return [::Integer]
  #     Maximum number of results to return. Currently, if unset, defaults to 10.
  #     And the max number is 20.
  # @!attribute [rw] confidence_threshold
  #   @return [::Float]
  #     Confidence threshold of query result.
  #
  #     Agent Assist gives each suggestion a score in the range [0.0, 1.0], based
  #     on the relevance between the suggestion and the current conversation
  #     context. A score of 0.0 has no relevance, while a score of 1.0 has high
  #     relevance. Only suggestions with a score greater than or equal to the
  #     value of this field are included in the results.
  #
  #     For a baseline model (the default), the recommended value is in the range
  #     [0.05, 0.1].
  #
  #     For a custom model, there is no recommended value. Tune this value by
  #     starting from a very low value and slowly increasing until you have
  #     desired results.
  #
  #     If this field is not set, it defaults to 0.0, which means that all
  #     suggestions are returned.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE,
  #     KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.
  # @!attribute [rw] context_filter_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
  #     Determines how recent conversation context is filtered when generating
  #     suggestions. If unspecified, no messages will be dropped.
  # @!attribute [rw] sections
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections]
  #     Optional. The customized sections chosen to return when requesting a
  #     summary of a conversation.
  class SuggestionQueryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Knowledge base source settings.
    #
    # Supported features: ARTICLE_SUGGESTION, FAQ.
    # @!attribute [rw] knowledge_bases
    #   @return [::Array<::String>]
    #     Required. Knowledge bases to query. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<Knowledge Base ID>`. Currently, at most 5 knowledge
    #     bases are supported.
    class KnowledgeBaseQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document source settings.
    #
    # Supported features: SMART_REPLY, SMART_COMPOSE.
    # @!attribute [rw] documents
    #   @return [::Array<::String>]
    #     Required. Knowledge documents to query from. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<KnowledgeBase ID>/documents/<Document ID>`.
    #     Currently, at most 5 documents are supported.
    class DocumentQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Dialogflow source setting.
    #
    # Supported feature: DIALOGFLOW_ASSIST.
    # @!attribute [rw] agent
    #   @return [::String]
    #     Required. The name of a Dialogflow virtual agent used for end user side
    #     intent detection and suggestion. Format: `projects/<Project
    #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
    #     the same Dialogflow project.
    # @!attribute [rw] human_agent_side_config
    #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource::HumanAgentSideConfig]
    #     Optional. The Dialogflow assist configuration for human agent.
    class DialogflowQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The configuration used for human agent side Dialogflow assist
      # suggestion.
      # @!attribute [rw] agent
      #   @return [::String]
      #     Optional. The name of a dialogflow virtual agent used for intent
      #     detection and suggestion triggered by human agent.
      #     Format: `projects/<Project ID>/locations/<Location ID>/agent`.
      class HumanAgentSideConfig
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Settings that determine how to filter recent conversation context when
    # generating suggestions.
    # @!attribute [rw] drop_handoff_messages
    #   @return [::Boolean]
    #     If set to true, the last message from virtual agent (hand off message)
    #     and the message before it (trigger message of hand off) are dropped.
    # @!attribute [rw] drop_virtual_agent_messages
    #   @return [::Boolean]
    #     If set to true, all messages from virtual agent are dropped.
    # @!attribute [rw] drop_ivr_messages
    #   @return [::Boolean]
    #     If set to true, all messages from ivr stage are dropped.
    class ContextFilterSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Custom sections to return when requesting a summary of a conversation.
    # This is only supported when `baseline_model_version` == '2.0'.
    #
    # Supported features: CONVERSATION_SUMMARIZATION,
    # CONVERSATION_SUMMARIZATION_VOICE.
    # @!attribute [rw] section_types
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections::SectionType>]
    #     The selected sections chosen to return when requesting a summary of a
    #     conversation. A duplicate selected section will be treated as a single
    #     selected section. If section types are not provided, the default will
    #     be \\{SITUATION, ACTION, RESULT}.
    class Sections
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Selectable sections to return when requesting a summary of a
      # conversation.
      module SectionType
        # Undefined section type, does not return anything.
        SECTION_TYPE_UNSPECIFIED = 0

        # What the customer needs help with or has question about.
        # Section name: "situation".
        SITUATION = 1

        # What the agent does to help the customer.
        # Section name: "action".
        ACTION = 2

        # Result of the customer service. A single word describing the result
        # of the conversation.
        # Section name: "resolution".
        RESOLUTION = 3

        # Reason for cancellation if the customer requests for a cancellation.
        # "N/A" otherwise.
        # Section name: "reason_for_cancellation".
        REASON_FOR_CANCELLATION = 4

        # "Unsatisfied" or "Satisfied" depending on the customer's feelings at
        # the end of the conversation.
        # Section name: "customer_satisfaction".
        CUSTOMER_SATISFACTION = 5

        # Key entities extracted from the conversation, such as ticket number,
        # order number, dollar amount, etc.
        # Section names are prefixed by "entities/".
        ENTITIES = 6
      end
    end
  end

  # Custom conversation models used in agent assist feature.
  #
  # Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY,
  # CONVERSATION_SUMMARIZATION.
  # @!attribute [rw] model
  #   @return [::String]
  #     Conversation model resource name. Format: `projects/<Project
  #     ID>/conversationModels/<Model ID>`.
  # @!attribute [rw] baseline_model_version
  #   @return [::String]
  #     Version of current baseline model. It will be ignored if
  #     {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig#model model}
  #     is set. Valid versions are:
  #       Article Suggestion baseline model:
  #         - 0.9
  #         - 1.0 (default)
  #       Summarization baseline model:
  #         - 1.0
  class ConversationModelConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config to process conversation.
  # @!attribute [rw] recent_sentences_count
  #   @return [::Integer]
  #     Number of recent non-small-talk sentences to use as context for article
  #     and FAQ suggestion
  class ConversationProcessConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for analyses to run on each conversation message.
  # @!attribute [rw] enable_entity_extraction
  #   @return [::Boolean]
  #     Enable entity extraction in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false.
  #
  #     Currently, this feature is not general available, please contact Google
  #     to get access.
  # @!attribute [rw] enable_sentiment_analysis
  #   @return [::Boolean]
  #     Enable sentiment analysis in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false. Sentiment analysis inspects user input
  #     and identifies the prevailing subjective opinion, especially to determine
  #     a user's attitude as positive, negative, or neutral:
  #     https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#message StreamingAnalyzeContentResponse.message.SentimentAnalysisResult}.
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
  #     If Pub/Sub notification is configured, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
  class MessageAnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#human_agent_suggestion_config ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig

Returns Configuration for agent assistance of human agent participant.

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 226

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

  # Settings of suggestion trigger.
  # @!attribute [rw] no_smalltalk
  #   @return [::Boolean]
  #     Do not trigger if last utterance is small talk.
  # @!attribute [rw] only_end_user
  #   @return [::Boolean]
  #     Only trigger suggestion if participant role of last utterance is
  #     END_USER.
  class SuggestionTriggerSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion features.
  # @!attribute [rw] suggestion_feature
  #   @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature]
  #     The suggestion feature.
  # @!attribute [rw] enable_event_based_suggestion
  #   @return [::Boolean]
  #     Automatically iterates all participants and tries to compile
  #     suggestions.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST,
  #     KNOWLEDGE_ASSIST.
  # @!attribute [rw] disable_agent_query_logging
  #   @return [::Boolean]
  #     Optional. Disable the logging of search queries sent by human agents. It
  #     can prevent those queries from being stored at answer records.
  #
  #     Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_when_no_answer
  #   @return [::Boolean]
  #     Optional. Enable query suggestion even if we can't find its answer.
  #     By default, queries are suggested only if we find its answer.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] enable_conversation_augmented_query
  #   @return [::Boolean]
  #     Optional. Enable including conversation context during query answer
  #     generation. Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_only
  #   @return [::Boolean]
  #     Optional. Enable query suggestion only.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] suggestion_trigger_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionTriggerSettings]
  #     Settings of suggestion trigger.
  #
  #     Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
  # @!attribute [rw] query_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig]
  #     Configs of query.
  # @!attribute [rw] conversation_model_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig]
  #     Configs of custom conversation model.
  # @!attribute [rw] conversation_process_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationProcessConfig]
  #     Configs for processing conversation.
  class SuggestionFeatureConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Detail human agent assistant config.
  # @!attribute [rw] feature_configs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig>]
  #     Configuration of different suggestion features. One feature can have only
  #     one config.
  # @!attribute [rw] group_suggestion_responses
  #   @return [::Boolean]
  #     If `group_suggestion_responses` is false, and there are multiple
  #     `feature_configs` in `event based suggestion` or
  #     StreamingAnalyzeContent, we will try to deliver suggestions to customers
  #     as soon as we get new suggestion. Different type of suggestions based on
  #     the same context will be in  separate Pub/Sub event or
  #     `StreamingAnalyzeContentResponse`.
  #
  #     If `group_suggestion_responses` set to true. All the suggestions to the
  #     same participant based on the same context will be grouped into a single
  #     Pub/Sub event or StreamingAnalyzeContentResponse.
  # @!attribute [rw] generators
  #   @return [::Array<::String>]
  #     Optional. List of various generator resource names used in the
  #     conversation profile.
  # @!attribute [rw] disable_high_latency_features_sync_delivery
  #   @return [::Boolean]
  #     Optional. When disable_high_latency_features_sync_delivery is true and
  #     using the AnalyzeContent API, we will not deliver the responses from high
  #     latency features in the API response. The
  #     human_agent_assistant_config.notification_config must be configured and
  #     enable_event_based_suggestion must be set to true to receive the
  #     responses from high latency features in Pub/Sub. High latency feature(s):
  #     KNOWLEDGE_ASSIST
  class SuggestionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion query.
  # @!attribute [rw] knowledge_base_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::KnowledgeBaseQuerySource]
  #     Query from knowledgebase. It is used by:
  #     ARTICLE_SUGGESTION, FAQ.
  # @!attribute [rw] document_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DocumentQuerySource]
  #     Query from knowledge base document. It is used by:
  #     SMART_REPLY, SMART_COMPOSE.
  # @!attribute [rw] dialogflow_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource]
  #     Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
  # @!attribute [rw] max_results
  #   @return [::Integer]
  #     Maximum number of results to return. Currently, if unset, defaults to 10.
  #     And the max number is 20.
  # @!attribute [rw] confidence_threshold
  #   @return [::Float]
  #     Confidence threshold of query result.
  #
  #     Agent Assist gives each suggestion a score in the range [0.0, 1.0], based
  #     on the relevance between the suggestion and the current conversation
  #     context. A score of 0.0 has no relevance, while a score of 1.0 has high
  #     relevance. Only suggestions with a score greater than or equal to the
  #     value of this field are included in the results.
  #
  #     For a baseline model (the default), the recommended value is in the range
  #     [0.05, 0.1].
  #
  #     For a custom model, there is no recommended value. Tune this value by
  #     starting from a very low value and slowly increasing until you have
  #     desired results.
  #
  #     If this field is not set, it defaults to 0.0, which means that all
  #     suggestions are returned.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE,
  #     KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.
  # @!attribute [rw] context_filter_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
  #     Determines how recent conversation context is filtered when generating
  #     suggestions. If unspecified, no messages will be dropped.
  # @!attribute [rw] sections
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections]
  #     Optional. The customized sections chosen to return when requesting a
  #     summary of a conversation.
  class SuggestionQueryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Knowledge base source settings.
    #
    # Supported features: ARTICLE_SUGGESTION, FAQ.
    # @!attribute [rw] knowledge_bases
    #   @return [::Array<::String>]
    #     Required. Knowledge bases to query. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<Knowledge Base ID>`. Currently, at most 5 knowledge
    #     bases are supported.
    class KnowledgeBaseQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document source settings.
    #
    # Supported features: SMART_REPLY, SMART_COMPOSE.
    # @!attribute [rw] documents
    #   @return [::Array<::String>]
    #     Required. Knowledge documents to query from. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<KnowledgeBase ID>/documents/<Document ID>`.
    #     Currently, at most 5 documents are supported.
    class DocumentQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Dialogflow source setting.
    #
    # Supported feature: DIALOGFLOW_ASSIST.
    # @!attribute [rw] agent
    #   @return [::String]
    #     Required. The name of a Dialogflow virtual agent used for end user side
    #     intent detection and suggestion. Format: `projects/<Project
    #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
    #     the same Dialogflow project.
    # @!attribute [rw] human_agent_side_config
    #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource::HumanAgentSideConfig]
    #     Optional. The Dialogflow assist configuration for human agent.
    class DialogflowQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The configuration used for human agent side Dialogflow assist
      # suggestion.
      # @!attribute [rw] agent
      #   @return [::String]
      #     Optional. The name of a dialogflow virtual agent used for intent
      #     detection and suggestion triggered by human agent.
      #     Format: `projects/<Project ID>/locations/<Location ID>/agent`.
      class HumanAgentSideConfig
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Settings that determine how to filter recent conversation context when
    # generating suggestions.
    # @!attribute [rw] drop_handoff_messages
    #   @return [::Boolean]
    #     If set to true, the last message from virtual agent (hand off message)
    #     and the message before it (trigger message of hand off) are dropped.
    # @!attribute [rw] drop_virtual_agent_messages
    #   @return [::Boolean]
    #     If set to true, all messages from virtual agent are dropped.
    # @!attribute [rw] drop_ivr_messages
    #   @return [::Boolean]
    #     If set to true, all messages from ivr stage are dropped.
    class ContextFilterSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Custom sections to return when requesting a summary of a conversation.
    # This is only supported when `baseline_model_version` == '2.0'.
    #
    # Supported features: CONVERSATION_SUMMARIZATION,
    # CONVERSATION_SUMMARIZATION_VOICE.
    # @!attribute [rw] section_types
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections::SectionType>]
    #     The selected sections chosen to return when requesting a summary of a
    #     conversation. A duplicate selected section will be treated as a single
    #     selected section. If section types are not provided, the default will
    #     be \\{SITUATION, ACTION, RESULT}.
    class Sections
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Selectable sections to return when requesting a summary of a
      # conversation.
      module SectionType
        # Undefined section type, does not return anything.
        SECTION_TYPE_UNSPECIFIED = 0

        # What the customer needs help with or has question about.
        # Section name: "situation".
        SITUATION = 1

        # What the agent does to help the customer.
        # Section name: "action".
        ACTION = 2

        # Result of the customer service. A single word describing the result
        # of the conversation.
        # Section name: "resolution".
        RESOLUTION = 3

        # Reason for cancellation if the customer requests for a cancellation.
        # "N/A" otherwise.
        # Section name: "reason_for_cancellation".
        REASON_FOR_CANCELLATION = 4

        # "Unsatisfied" or "Satisfied" depending on the customer's feelings at
        # the end of the conversation.
        # Section name: "customer_satisfaction".
        CUSTOMER_SATISFACTION = 5

        # Key entities extracted from the conversation, such as ticket number,
        # order number, dollar amount, etc.
        # Section names are prefixed by "entities/".
        ENTITIES = 6
      end
    end
  end

  # Custom conversation models used in agent assist feature.
  #
  # Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY,
  # CONVERSATION_SUMMARIZATION.
  # @!attribute [rw] model
  #   @return [::String]
  #     Conversation model resource name. Format: `projects/<Project
  #     ID>/conversationModels/<Model ID>`.
  # @!attribute [rw] baseline_model_version
  #   @return [::String]
  #     Version of current baseline model. It will be ignored if
  #     {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig#model model}
  #     is set. Valid versions are:
  #       Article Suggestion baseline model:
  #         - 0.9
  #         - 1.0 (default)
  #       Summarization baseline model:
  #         - 1.0
  class ConversationModelConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config to process conversation.
  # @!attribute [rw] recent_sentences_count
  #   @return [::Integer]
  #     Number of recent non-small-talk sentences to use as context for article
  #     and FAQ suggestion
  class ConversationProcessConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for analyses to run on each conversation message.
  # @!attribute [rw] enable_entity_extraction
  #   @return [::Boolean]
  #     Enable entity extraction in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false.
  #
  #     Currently, this feature is not general available, please contact Google
  #     to get access.
  # @!attribute [rw] enable_sentiment_analysis
  #   @return [::Boolean]
  #     Enable sentiment analysis in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false. Sentiment analysis inspects user input
  #     and identifies the prevailing subjective opinion, especially to determine
  #     a user's attitude as positive, negative, or neutral:
  #     https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#message StreamingAnalyzeContentResponse.message.SentimentAnalysisResult}.
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
  #     If Pub/Sub notification is configured, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
  class MessageAnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#message_analysis_config ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::MessageAnalysisConfig

Returns Configuration for message analysis.

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 226

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

  # Settings of suggestion trigger.
  # @!attribute [rw] no_smalltalk
  #   @return [::Boolean]
  #     Do not trigger if last utterance is small talk.
  # @!attribute [rw] only_end_user
  #   @return [::Boolean]
  #     Only trigger suggestion if participant role of last utterance is
  #     END_USER.
  class SuggestionTriggerSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion features.
  # @!attribute [rw] suggestion_feature
  #   @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature]
  #     The suggestion feature.
  # @!attribute [rw] enable_event_based_suggestion
  #   @return [::Boolean]
  #     Automatically iterates all participants and tries to compile
  #     suggestions.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST,
  #     KNOWLEDGE_ASSIST.
  # @!attribute [rw] disable_agent_query_logging
  #   @return [::Boolean]
  #     Optional. Disable the logging of search queries sent by human agents. It
  #     can prevent those queries from being stored at answer records.
  #
  #     Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_when_no_answer
  #   @return [::Boolean]
  #     Optional. Enable query suggestion even if we can't find its answer.
  #     By default, queries are suggested only if we find its answer.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] enable_conversation_augmented_query
  #   @return [::Boolean]
  #     Optional. Enable including conversation context during query answer
  #     generation. Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_only
  #   @return [::Boolean]
  #     Optional. Enable query suggestion only.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] suggestion_trigger_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionTriggerSettings]
  #     Settings of suggestion trigger.
  #
  #     Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
  # @!attribute [rw] query_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig]
  #     Configs of query.
  # @!attribute [rw] conversation_model_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig]
  #     Configs of custom conversation model.
  # @!attribute [rw] conversation_process_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationProcessConfig]
  #     Configs for processing conversation.
  class SuggestionFeatureConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Detail human agent assistant config.
  # @!attribute [rw] feature_configs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig>]
  #     Configuration of different suggestion features. One feature can have only
  #     one config.
  # @!attribute [rw] group_suggestion_responses
  #   @return [::Boolean]
  #     If `group_suggestion_responses` is false, and there are multiple
  #     `feature_configs` in `event based suggestion` or
  #     StreamingAnalyzeContent, we will try to deliver suggestions to customers
  #     as soon as we get new suggestion. Different type of suggestions based on
  #     the same context will be in  separate Pub/Sub event or
  #     `StreamingAnalyzeContentResponse`.
  #
  #     If `group_suggestion_responses` set to true. All the suggestions to the
  #     same participant based on the same context will be grouped into a single
  #     Pub/Sub event or StreamingAnalyzeContentResponse.
  # @!attribute [rw] generators
  #   @return [::Array<::String>]
  #     Optional. List of various generator resource names used in the
  #     conversation profile.
  # @!attribute [rw] disable_high_latency_features_sync_delivery
  #   @return [::Boolean]
  #     Optional. When disable_high_latency_features_sync_delivery is true and
  #     using the AnalyzeContent API, we will not deliver the responses from high
  #     latency features in the API response. The
  #     human_agent_assistant_config.notification_config must be configured and
  #     enable_event_based_suggestion must be set to true to receive the
  #     responses from high latency features in Pub/Sub. High latency feature(s):
  #     KNOWLEDGE_ASSIST
  class SuggestionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion query.
  # @!attribute [rw] knowledge_base_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::KnowledgeBaseQuerySource]
  #     Query from knowledgebase. It is used by:
  #     ARTICLE_SUGGESTION, FAQ.
  # @!attribute [rw] document_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DocumentQuerySource]
  #     Query from knowledge base document. It is used by:
  #     SMART_REPLY, SMART_COMPOSE.
  # @!attribute [rw] dialogflow_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource]
  #     Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
  # @!attribute [rw] max_results
  #   @return [::Integer]
  #     Maximum number of results to return. Currently, if unset, defaults to 10.
  #     And the max number is 20.
  # @!attribute [rw] confidence_threshold
  #   @return [::Float]
  #     Confidence threshold of query result.
  #
  #     Agent Assist gives each suggestion a score in the range [0.0, 1.0], based
  #     on the relevance between the suggestion and the current conversation
  #     context. A score of 0.0 has no relevance, while a score of 1.0 has high
  #     relevance. Only suggestions with a score greater than or equal to the
  #     value of this field are included in the results.
  #
  #     For a baseline model (the default), the recommended value is in the range
  #     [0.05, 0.1].
  #
  #     For a custom model, there is no recommended value. Tune this value by
  #     starting from a very low value and slowly increasing until you have
  #     desired results.
  #
  #     If this field is not set, it defaults to 0.0, which means that all
  #     suggestions are returned.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE,
  #     KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.
  # @!attribute [rw] context_filter_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
  #     Determines how recent conversation context is filtered when generating
  #     suggestions. If unspecified, no messages will be dropped.
  # @!attribute [rw] sections
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections]
  #     Optional. The customized sections chosen to return when requesting a
  #     summary of a conversation.
  class SuggestionQueryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Knowledge base source settings.
    #
    # Supported features: ARTICLE_SUGGESTION, FAQ.
    # @!attribute [rw] knowledge_bases
    #   @return [::Array<::String>]
    #     Required. Knowledge bases to query. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<Knowledge Base ID>`. Currently, at most 5 knowledge
    #     bases are supported.
    class KnowledgeBaseQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document source settings.
    #
    # Supported features: SMART_REPLY, SMART_COMPOSE.
    # @!attribute [rw] documents
    #   @return [::Array<::String>]
    #     Required. Knowledge documents to query from. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<KnowledgeBase ID>/documents/<Document ID>`.
    #     Currently, at most 5 documents are supported.
    class DocumentQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Dialogflow source setting.
    #
    # Supported feature: DIALOGFLOW_ASSIST.
    # @!attribute [rw] agent
    #   @return [::String]
    #     Required. The name of a Dialogflow virtual agent used for end user side
    #     intent detection and suggestion. Format: `projects/<Project
    #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
    #     the same Dialogflow project.
    # @!attribute [rw] human_agent_side_config
    #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource::HumanAgentSideConfig]
    #     Optional. The Dialogflow assist configuration for human agent.
    class DialogflowQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The configuration used for human agent side Dialogflow assist
      # suggestion.
      # @!attribute [rw] agent
      #   @return [::String]
      #     Optional. The name of a dialogflow virtual agent used for intent
      #     detection and suggestion triggered by human agent.
      #     Format: `projects/<Project ID>/locations/<Location ID>/agent`.
      class HumanAgentSideConfig
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Settings that determine how to filter recent conversation context when
    # generating suggestions.
    # @!attribute [rw] drop_handoff_messages
    #   @return [::Boolean]
    #     If set to true, the last message from virtual agent (hand off message)
    #     and the message before it (trigger message of hand off) are dropped.
    # @!attribute [rw] drop_virtual_agent_messages
    #   @return [::Boolean]
    #     If set to true, all messages from virtual agent are dropped.
    # @!attribute [rw] drop_ivr_messages
    #   @return [::Boolean]
    #     If set to true, all messages from ivr stage are dropped.
    class ContextFilterSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Custom sections to return when requesting a summary of a conversation.
    # This is only supported when `baseline_model_version` == '2.0'.
    #
    # Supported features: CONVERSATION_SUMMARIZATION,
    # CONVERSATION_SUMMARIZATION_VOICE.
    # @!attribute [rw] section_types
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections::SectionType>]
    #     The selected sections chosen to return when requesting a summary of a
    #     conversation. A duplicate selected section will be treated as a single
    #     selected section. If section types are not provided, the default will
    #     be \\{SITUATION, ACTION, RESULT}.
    class Sections
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Selectable sections to return when requesting a summary of a
      # conversation.
      module SectionType
        # Undefined section type, does not return anything.
        SECTION_TYPE_UNSPECIFIED = 0

        # What the customer needs help with or has question about.
        # Section name: "situation".
        SITUATION = 1

        # What the agent does to help the customer.
        # Section name: "action".
        ACTION = 2

        # Result of the customer service. A single word describing the result
        # of the conversation.
        # Section name: "resolution".
        RESOLUTION = 3

        # Reason for cancellation if the customer requests for a cancellation.
        # "N/A" otherwise.
        # Section name: "reason_for_cancellation".
        REASON_FOR_CANCELLATION = 4

        # "Unsatisfied" or "Satisfied" depending on the customer's feelings at
        # the end of the conversation.
        # Section name: "customer_satisfaction".
        CUSTOMER_SATISFACTION = 5

        # Key entities extracted from the conversation, such as ticket number,
        # order number, dollar amount, etc.
        # Section names are prefixed by "entities/".
        ENTITIES = 6
      end
    end
  end

  # Custom conversation models used in agent assist feature.
  #
  # Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY,
  # CONVERSATION_SUMMARIZATION.
  # @!attribute [rw] model
  #   @return [::String]
  #     Conversation model resource name. Format: `projects/<Project
  #     ID>/conversationModels/<Model ID>`.
  # @!attribute [rw] baseline_model_version
  #   @return [::String]
  #     Version of current baseline model. It will be ignored if
  #     {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig#model model}
  #     is set. Valid versions are:
  #       Article Suggestion baseline model:
  #         - 0.9
  #         - 1.0 (default)
  #       Summarization baseline model:
  #         - 1.0
  class ConversationModelConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config to process conversation.
  # @!attribute [rw] recent_sentences_count
  #   @return [::Integer]
  #     Number of recent non-small-talk sentences to use as context for article
  #     and FAQ suggestion
  class ConversationProcessConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for analyses to run on each conversation message.
  # @!attribute [rw] enable_entity_extraction
  #   @return [::Boolean]
  #     Enable entity extraction in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false.
  #
  #     Currently, this feature is not general available, please contact Google
  #     to get access.
  # @!attribute [rw] enable_sentiment_analysis
  #   @return [::Boolean]
  #     Enable sentiment analysis in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false. Sentiment analysis inspects user input
  #     and identifies the prevailing subjective opinion, especially to determine
  #     a user's attitude as positive, negative, or neutral:
  #     https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#message StreamingAnalyzeContentResponse.message.SentimentAnalysisResult}.
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
  #     If Pub/Sub notification is configured, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
  class MessageAnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#notification_config ⇒ ::Google::Cloud::Dialogflow::V2::NotificationConfig

Returns Pub/Sub topic on which to publish new agent assistant events.

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 226

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

  # Settings of suggestion trigger.
  # @!attribute [rw] no_smalltalk
  #   @return [::Boolean]
  #     Do not trigger if last utterance is small talk.
  # @!attribute [rw] only_end_user
  #   @return [::Boolean]
  #     Only trigger suggestion if participant role of last utterance is
  #     END_USER.
  class SuggestionTriggerSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion features.
  # @!attribute [rw] suggestion_feature
  #   @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature]
  #     The suggestion feature.
  # @!attribute [rw] enable_event_based_suggestion
  #   @return [::Boolean]
  #     Automatically iterates all participants and tries to compile
  #     suggestions.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST,
  #     KNOWLEDGE_ASSIST.
  # @!attribute [rw] disable_agent_query_logging
  #   @return [::Boolean]
  #     Optional. Disable the logging of search queries sent by human agents. It
  #     can prevent those queries from being stored at answer records.
  #
  #     Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_when_no_answer
  #   @return [::Boolean]
  #     Optional. Enable query suggestion even if we can't find its answer.
  #     By default, queries are suggested only if we find its answer.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] enable_conversation_augmented_query
  #   @return [::Boolean]
  #     Optional. Enable including conversation context during query answer
  #     generation. Supported features: KNOWLEDGE_SEARCH.
  # @!attribute [rw] enable_query_suggestion_only
  #   @return [::Boolean]
  #     Optional. Enable query suggestion only.
  #     Supported features: KNOWLEDGE_ASSIST
  # @!attribute [rw] suggestion_trigger_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionTriggerSettings]
  #     Settings of suggestion trigger.
  #
  #     Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
  # @!attribute [rw] query_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig]
  #     Configs of query.
  # @!attribute [rw] conversation_model_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig]
  #     Configs of custom conversation model.
  # @!attribute [rw] conversation_process_config
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationProcessConfig]
  #     Configs for processing conversation.
  class SuggestionFeatureConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Detail human agent assistant config.
  # @!attribute [rw] feature_configs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig>]
  #     Configuration of different suggestion features. One feature can have only
  #     one config.
  # @!attribute [rw] group_suggestion_responses
  #   @return [::Boolean]
  #     If `group_suggestion_responses` is false, and there are multiple
  #     `feature_configs` in `event based suggestion` or
  #     StreamingAnalyzeContent, we will try to deliver suggestions to customers
  #     as soon as we get new suggestion. Different type of suggestions based on
  #     the same context will be in  separate Pub/Sub event or
  #     `StreamingAnalyzeContentResponse`.
  #
  #     If `group_suggestion_responses` set to true. All the suggestions to the
  #     same participant based on the same context will be grouped into a single
  #     Pub/Sub event or StreamingAnalyzeContentResponse.
  # @!attribute [rw] generators
  #   @return [::Array<::String>]
  #     Optional. List of various generator resource names used in the
  #     conversation profile.
  # @!attribute [rw] disable_high_latency_features_sync_delivery
  #   @return [::Boolean]
  #     Optional. When disable_high_latency_features_sync_delivery is true and
  #     using the AnalyzeContent API, we will not deliver the responses from high
  #     latency features in the API response. The
  #     human_agent_assistant_config.notification_config must be configured and
  #     enable_event_based_suggestion must be set to true to receive the
  #     responses from high latency features in Pub/Sub. High latency feature(s):
  #     KNOWLEDGE_ASSIST
  class SuggestionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config for suggestion query.
  # @!attribute [rw] knowledge_base_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::KnowledgeBaseQuerySource]
  #     Query from knowledgebase. It is used by:
  #     ARTICLE_SUGGESTION, FAQ.
  # @!attribute [rw] document_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DocumentQuerySource]
  #     Query from knowledge base document. It is used by:
  #     SMART_REPLY, SMART_COMPOSE.
  # @!attribute [rw] dialogflow_query_source
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource]
  #     Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
  # @!attribute [rw] max_results
  #   @return [::Integer]
  #     Maximum number of results to return. Currently, if unset, defaults to 10.
  #     And the max number is 20.
  # @!attribute [rw] confidence_threshold
  #   @return [::Float]
  #     Confidence threshold of query result.
  #
  #     Agent Assist gives each suggestion a score in the range [0.0, 1.0], based
  #     on the relevance between the suggestion and the current conversation
  #     context. A score of 0.0 has no relevance, while a score of 1.0 has high
  #     relevance. Only suggestions with a score greater than or equal to the
  #     value of this field are included in the results.
  #
  #     For a baseline model (the default), the recommended value is in the range
  #     [0.05, 0.1].
  #
  #     For a custom model, there is no recommended value. Tune this value by
  #     starting from a very low value and slowly increasing until you have
  #     desired results.
  #
  #     If this field is not set, it defaults to 0.0, which means that all
  #     suggestions are returned.
  #
  #     Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE,
  #     KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.
  # @!attribute [rw] context_filter_settings
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
  #     Determines how recent conversation context is filtered when generating
  #     suggestions. If unspecified, no messages will be dropped.
  # @!attribute [rw] sections
  #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections]
  #     Optional. The customized sections chosen to return when requesting a
  #     summary of a conversation.
  class SuggestionQueryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Knowledge base source settings.
    #
    # Supported features: ARTICLE_SUGGESTION, FAQ.
    # @!attribute [rw] knowledge_bases
    #   @return [::Array<::String>]
    #     Required. Knowledge bases to query. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<Knowledge Base ID>`. Currently, at most 5 knowledge
    #     bases are supported.
    class KnowledgeBaseQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document source settings.
    #
    # Supported features: SMART_REPLY, SMART_COMPOSE.
    # @!attribute [rw] documents
    #   @return [::Array<::String>]
    #     Required. Knowledge documents to query from. Format:
    #     `projects/<Project ID>/locations/<Location
    #     ID>/knowledgeBases/<KnowledgeBase ID>/documents/<Document ID>`.
    #     Currently, at most 5 documents are supported.
    class DocumentQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Dialogflow source setting.
    #
    # Supported feature: DIALOGFLOW_ASSIST.
    # @!attribute [rw] agent
    #   @return [::String]
    #     Required. The name of a Dialogflow virtual agent used for end user side
    #     intent detection and suggestion. Format: `projects/<Project
    #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
    #     the same Dialogflow project.
    # @!attribute [rw] human_agent_side_config
    #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource::HumanAgentSideConfig]
    #     Optional. The Dialogflow assist configuration for human agent.
    class DialogflowQuerySource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The configuration used for human agent side Dialogflow assist
      # suggestion.
      # @!attribute [rw] agent
      #   @return [::String]
      #     Optional. The name of a dialogflow virtual agent used for intent
      #     detection and suggestion triggered by human agent.
      #     Format: `projects/<Project ID>/locations/<Location ID>/agent`.
      class HumanAgentSideConfig
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Settings that determine how to filter recent conversation context when
    # generating suggestions.
    # @!attribute [rw] drop_handoff_messages
    #   @return [::Boolean]
    #     If set to true, the last message from virtual agent (hand off message)
    #     and the message before it (trigger message of hand off) are dropped.
    # @!attribute [rw] drop_virtual_agent_messages
    #   @return [::Boolean]
    #     If set to true, all messages from virtual agent are dropped.
    # @!attribute [rw] drop_ivr_messages
    #   @return [::Boolean]
    #     If set to true, all messages from ivr stage are dropped.
    class ContextFilterSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Custom sections to return when requesting a summary of a conversation.
    # This is only supported when `baseline_model_version` == '2.0'.
    #
    # Supported features: CONVERSATION_SUMMARIZATION,
    # CONVERSATION_SUMMARIZATION_VOICE.
    # @!attribute [rw] section_types
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections::SectionType>]
    #     The selected sections chosen to return when requesting a summary of a
    #     conversation. A duplicate selected section will be treated as a single
    #     selected section. If section types are not provided, the default will
    #     be \\{SITUATION, ACTION, RESULT}.
    class Sections
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Selectable sections to return when requesting a summary of a
      # conversation.
      module SectionType
        # Undefined section type, does not return anything.
        SECTION_TYPE_UNSPECIFIED = 0

        # What the customer needs help with or has question about.
        # Section name: "situation".
        SITUATION = 1

        # What the agent does to help the customer.
        # Section name: "action".
        ACTION = 2

        # Result of the customer service. A single word describing the result
        # of the conversation.
        # Section name: "resolution".
        RESOLUTION = 3

        # Reason for cancellation if the customer requests for a cancellation.
        # "N/A" otherwise.
        # Section name: "reason_for_cancellation".
        REASON_FOR_CANCELLATION = 4

        # "Unsatisfied" or "Satisfied" depending on the customer's feelings at
        # the end of the conversation.
        # Section name: "customer_satisfaction".
        CUSTOMER_SATISFACTION = 5

        # Key entities extracted from the conversation, such as ticket number,
        # order number, dollar amount, etc.
        # Section names are prefixed by "entities/".
        ENTITIES = 6
      end
    end
  end

  # Custom conversation models used in agent assist feature.
  #
  # Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY,
  # CONVERSATION_SUMMARIZATION.
  # @!attribute [rw] model
  #   @return [::String]
  #     Conversation model resource name. Format: `projects/<Project
  #     ID>/conversationModels/<Model ID>`.
  # @!attribute [rw] baseline_model_version
  #   @return [::String]
  #     Version of current baseline model. It will be ignored if
  #     {::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig#model model}
  #     is set. Valid versions are:
  #       Article Suggestion baseline model:
  #         - 0.9
  #         - 1.0 (default)
  #       Summarization baseline model:
  #         - 1.0
  class ConversationModelConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Config to process conversation.
  # @!attribute [rw] recent_sentences_count
  #   @return [::Integer]
  #     Number of recent non-small-talk sentences to use as context for article
  #     and FAQ suggestion
  class ConversationProcessConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for analyses to run on each conversation message.
  # @!attribute [rw] enable_entity_extraction
  #   @return [::Boolean]
  #     Enable entity extraction in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false.
  #
  #     Currently, this feature is not general available, please contact Google
  #     to get access.
  # @!attribute [rw] enable_sentiment_analysis
  #   @return [::Boolean]
  #     Enable sentiment analysis in conversation messages on [agent assist
  #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
  #     If unspecified, defaults to false. Sentiment analysis inspects user input
  #     and identifies the prevailing subjective opinion, especially to determine
  #     a user's attitude as positive, negative, or neutral:
  #     https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#streaming_analyze_content Participants.StreamingAnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse#message StreamingAnalyzeContentResponse.message.SentimentAnalysisResult}.
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
  #     For
  #     {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}
  #     method, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
  #     If Pub/Sub notification is configured, result will be in
  #     {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
  class MessageAnalysisConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end