Interface HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder (4.4.0)

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 is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE.

float confidence_threshold = 5;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;

Returns
TypeDescription
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettingsOrBuilder

getDialogflowQuerySource()

public abstract HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource getDialogflowQuerySource()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.

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

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource dialogflow_query_source = 3;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;

Returns
TypeDescription
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySourceOrBuilder

getKnowledgeBaseQuerySource()

public abstract HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource getKnowledgeBaseQuerySource()

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource knowledge_base_query_source = 1;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource knowledge_base_query_source = 1;

Returns
TypeDescription
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
TypeDescription
int

The maxResults.

getQuerySourceCase()

public abstract HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase getQuerySourceCase()
Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource dialogflow_query_source = 3;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;

Returns
TypeDescription
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.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource knowledge_base_query_source = 1;

Returns
TypeDescription
boolean

Whether the knowledgeBaseQuerySource field is set.