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

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.

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.



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

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 Number/
  #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
  #     the same Dialogflow project.
  class DialogflowQuerySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
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:



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

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 Number/
  #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
  #     the same Dialogflow project.
  class DialogflowQuerySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

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

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

Returns:



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

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 Number/
  #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
  #     the same Dialogflow project.
  class DialogflowQuerySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
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:



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

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 Number/
  #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
  #     the same Dialogflow project.
  class DialogflowQuerySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

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

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

Returns:



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

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 Number/
  #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
  #     the same Dialogflow project.
  class DialogflowQuerySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
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.



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

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 Number/
  #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
  #     the same Dialogflow project.
  class DialogflowQuerySource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end