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

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

Config for suggestion query.

Defined Under Namespace

Classes: ContextFilterSettings, DialogflowQuerySource, DocumentQuerySource, KnowledgeBaseQuerySource, Sections

Instance Attribute Summary collapse

Instance Attribute Details

#confidence_threshold ⇒ ::Float

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

Returns:

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



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
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 373

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

#context_filter_settings ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings

Returns Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 373

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

#dialogflow_query_source ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource

Returns Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 373

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

#document_query_source ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DocumentQuerySource

Returns Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 373

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

#knowledge_base_query_source ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::KnowledgeBaseQuerySource

Returns Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 373

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

#max_results ⇒ ::Integer

Returns Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20.

Returns:

  • (::Integer) —

    Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20.



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
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 373

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

#sections ⇒ ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::Sections

Returns Optional. The customized sections chosen to return when requesting a summary of a conversation.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb', line 373

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