Package com.google.cloud.dialogflow.v2

Interface HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HumanAgentAssistantConfig.SuggestionQueryConfig, HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Enclosing class:
HumanAgentAssistantConfig
public static interface HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasKnowledgeBaseQuerySource

      boolean hasKnowledgeBaseQuerySource()
       Query from knowledgebase. It is used by:
 ARTICLE_SUGGESTION, FAQ.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource knowledge_base_query_source = 1;
      Returns:
      Whether the knowledgeBaseQuerySource field is set.

    • getKnowledgeBaseQuerySource

      HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource getKnowledgeBaseQuerySource()
       Query from knowledgebase. It is used by:
 ARTICLE_SUGGESTION, FAQ.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource knowledge_base_query_source = 1;
      Returns:
      The knowledgeBaseQuerySource.

    • getKnowledgeBaseQuerySourceOrBuilder

      HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySourceOrBuilder getKnowledgeBaseQuerySourceOrBuilder()
       Query from knowledgebase. It is used by:
 ARTICLE_SUGGESTION, FAQ.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource knowledge_base_query_source = 1;

    • hasDocumentQuerySource

      boolean hasDocumentQuerySource()
       Query from knowledge base document. It is used by:
 SMART_REPLY, SMART_COMPOSE.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;
      Returns:
      Whether the documentQuerySource field is set.

    • getDocumentQuerySource

      HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource getDocumentQuerySource()
       Query from knowledge base document. It is used by:
 SMART_REPLY, SMART_COMPOSE.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;
      Returns:
      The documentQuerySource.

    • getDocumentQuerySourceOrBuilder

      HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySourceOrBuilder getDocumentQuerySourceOrBuilder()
       Query from knowledge base document. It is used by:
 SMART_REPLY, SMART_COMPOSE.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;

    • hasDialogflowQuerySource

      boolean hasDialogflowQuerySource()
       Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource dialogflow_query_source = 3;
      Returns:
      Whether the dialogflowQuerySource field is set.

    • getDialogflowQuerySource

      HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource getDialogflowQuerySource()
       Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource dialogflow_query_source = 3;
      Returns:
      The dialogflowQuerySource.

    • getDialogflowQuerySourceOrBuilder

      HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySourceOrBuilder getDialogflowQuerySourceOrBuilder()
       Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource dialogflow_query_source = 3;

    • getMaxResults

      int getMaxResults()
       Maximum number of results to return. Currently, if unset, defaults to 10.
 And the max number is 20.
      int32 max_results = 4;
      Returns:
      The maxResults.

    • getConfidenceThreshold

      float getConfidenceThreshold()
       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.
      float confidence_threshold = 5;
      Returns:
      The confidenceThreshold.

    • hasContextFilterSettings

      boolean hasContextFilterSettings()
       Determines how recent conversation context is filtered when generating
 suggestions. If unspecified, no messages will be dropped.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;
      Returns:
      Whether the contextFilterSettings field is set.

    • getContextFilterSettings

      HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings getContextFilterSettings()
       Determines how recent conversation context is filtered when generating
 suggestions. If unspecified, no messages will be dropped.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;
      Returns:
      The contextFilterSettings.

    • getContextFilterSettingsOrBuilder

      HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettingsOrBuilder getContextFilterSettingsOrBuilder()
       Determines how recent conversation context is filtered when generating
 suggestions. If unspecified, no messages will be dropped.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;

    • hasSections

      boolean hasSections()
       Optional. The customized sections chosen to return when requesting a
 summary of a conversation.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the sections field is set.

    • getSections

      HumanAgentAssistantConfig.SuggestionQueryConfig.Sections getSections()
       Optional. The customized sections chosen to return when requesting a
 summary of a conversation.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The sections.

    • getSectionsOrBuilder

      HumanAgentAssistantConfig.SuggestionQueryConfig.SectionsOrBuilder getSectionsOrBuilder()
       Optional. The customized sections chosen to return when requesting a
 summary of a conversation.
      .google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getContextSize

      int getContextSize()
       Optional. The number of recent messages to include in the context.
 Supported features: KNOWLEDGE_ASSIST.
      int32 context_size = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The contextSize.

    • getQuerySourceCase

      HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase getQuerySourceCase()