Interface HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder (4.38.0)

Version 4.38.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public static interface HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConfidenceThreshold()

public abstract 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
Type	Description
float	The confidenceThreshold.

getContextFilterSettings()

public abstract 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
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings	The contextFilterSettings.

getContextFilterSettingsOrBuilder()

public abstract 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;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettingsOrBuilder

getDialogflowQuerySource()

public abstract 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
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource	The dialogflowQuerySource.

getDialogflowQuerySourceOrBuilder()

public abstract 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;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySourceOrBuilder

getDocumentQuerySource()

public abstract 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
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource	The documentQuerySource.

getDocumentQuerySourceOrBuilder()

public abstract 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;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySourceOrBuilder

getKnowledgeBaseQuerySource()

public abstract 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
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource	The knowledgeBaseQuerySource.

getKnowledgeBaseQuerySourceOrBuilder()

public abstract 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;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySourceOrBuilder

getMaxResults()

public abstract 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
Type	Description
int	The maxResults.

getQuerySourceCase()

public abstract HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase getQuerySourceCase()

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase

hasContextFilterSettings()

public abstract 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
Type	Description
boolean	Whether the contextFilterSettings field is set.

hasDialogflowQuerySource()

public abstract boolean hasDialogflowQuerySource()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.

.google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource dialogflow_query_source = 3;

Returns
Type	Description
boolean	Whether the dialogflowQuerySource field is set.

hasDocumentQuerySource()

public abstract 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
Type	Description
boolean	Whether the documentQuerySource field is set.

hasKnowledgeBaseQuerySource()

public abstract 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
Type	Description
boolean	Whether the knowledgeBaseQuerySource field is set.