Class HumanAgentAssistantConfig.SuggestionQueryConfig.Builder (4.52.0)

public static final class HumanAgentAssistantConfig.SuggestionQueryConfig.Builder extends GeneratedMessageV3.Builder<HumanAgentAssistantConfig.SuggestionQueryConfig.Builder> implements HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder

Config for suggestion query.

Protobuf type google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

build()

public HumanAgentAssistantConfig.SuggestionQueryConfig build()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig

buildPartial()

public HumanAgentAssistantConfig.SuggestionQueryConfig buildPartial()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig

clear()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clear()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

clearConfidenceThreshold()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearConfidenceThreshold()

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, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.

float confidence_threshold = 5;

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

This builder for chaining.

clearContextFilterSettings()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearContextFilterSettings()

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
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

clearDialogflowQuerySource()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearDialogflowQuerySource()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

clearDocumentQuerySource()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearDocumentQuerySource()

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
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

clearKnowledgeBaseQuerySource()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearKnowledgeBaseQuerySource()

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

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

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

clearMaxResults()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearMaxResults()

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
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

clearQuerySource()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearQuerySource()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

clearSections()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearSections()

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

clone()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clone()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

getConfidenceThreshold()

public 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, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.

float confidence_threshold = 5;

Returns
Type Description
float

The confidenceThreshold.

getContextFilterSettings()

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

The contextFilterSettings.

getContextFilterSettingsBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings.Builder getContextFilterSettingsBuilder()

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
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings.Builder

getContextFilterSettingsOrBuilder()

public 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
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettingsOrBuilder

getDefaultInstanceForType()

public HumanAgentAssistantConfig.SuggestionQueryConfig getDefaultInstanceForType()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDialogflowQuerySource()

public HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource getDialogflowQuerySource()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource

The dialogflowQuerySource.

getDialogflowQuerySourceBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource.Builder getDialogflowQuerySourceBuilder()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource.Builder

getDialogflowQuerySourceOrBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySourceOrBuilder getDialogflowQuerySourceOrBuilder()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySourceOrBuilder

getDocumentQuerySource()

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

The documentQuerySource.

getDocumentQuerySourceBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource.Builder getDocumentQuerySourceBuilder()

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
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource.Builder

getDocumentQuerySourceOrBuilder()

public 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
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySourceOrBuilder

getKnowledgeBaseQuerySource()

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

The knowledgeBaseQuerySource.

getKnowledgeBaseQuerySourceBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource.Builder getKnowledgeBaseQuerySourceBuilder()

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

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

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource.Builder

getKnowledgeBaseQuerySourceOrBuilder()

public 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
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySourceOrBuilder

getMaxResults()

public 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 HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase getQuerySourceCase()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase

getSections()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Sections getSections()

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Sections

The sections.

getSectionsBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Sections.Builder getSectionsBuilder()

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Sections.Builder

getSectionsOrBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.SectionsOrBuilder getSectionsOrBuilder()

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.SectionsOrBuilder

hasContextFilterSettings()

public 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
Type Description
boolean

Whether the contextFilterSettings field is set.

hasDialogflowQuerySource()

public boolean hasDialogflowQuerySource()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Returns
Type Description
boolean

Whether the dialogflowQuerySource field is set.

hasDocumentQuerySource()

public 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
Type Description
boolean

Whether the documentQuerySource field is set.

hasKnowledgeBaseQuerySource()

public 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
Type Description
boolean

Whether the knowledgeBaseQuerySource field is set.

hasSections()

public boolean hasSections()

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sections field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeContextFilterSettings(HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeContextFilterSettings(HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings value)

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;

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

mergeDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource value)

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

mergeDocumentQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeDocumentQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource value)

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

mergeFrom(HumanAgentAssistantConfig.SuggestionQueryConfig other)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeFrom(HumanAgentAssistantConfig.SuggestionQueryConfig other)
Parameter
Name Description
other HumanAgentAssistantConfig.SuggestionQueryConfig
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

mergeKnowledgeBaseQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeKnowledgeBaseQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource value)

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

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

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

mergeSections(HumanAgentAssistantConfig.SuggestionQueryConfig.Sections value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeSections(HumanAgentAssistantConfig.SuggestionQueryConfig.Sections value)

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.Sections
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

setConfidenceThreshold(float value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setConfidenceThreshold(float value)

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, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.

float confidence_threshold = 5;

Parameter
Name Description
value float

The confidenceThreshold to set.

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

This builder for chaining.

setContextFilterSettings(HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setContextFilterSettings(HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings value)

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;

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setContextFilterSettings(HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings.Builder builderForValue)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setContextFilterSettings(HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings.Builder builderForValue)

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;

Parameter
Name Description
builderForValue HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings.Builder
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource value)

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource.Builder builderForValue)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource.Builder builderForValue)

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.

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

Parameter
Name Description
builderForValue HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource.Builder
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setDocumentQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setDocumentQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource value)

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setDocumentQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource.Builder builderForValue)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setDocumentQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource.Builder builderForValue)

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource document_query_source = 2;

Parameter
Name Description
builderForValue HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource.Builder
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

setKnowledgeBaseQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setKnowledgeBaseQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource value)

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

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

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setKnowledgeBaseQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource.Builder builderForValue)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setKnowledgeBaseQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource.Builder
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setMaxResults(int value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setMaxResults(int value)

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

int32 max_results = 4;

Parameter
Name Description
value int

The maxResults to set.

Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

setSections(HumanAgentAssistantConfig.SuggestionQueryConfig.Sections value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setSections(HumanAgentAssistantConfig.SuggestionQueryConfig.Sections value)

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value HumanAgentAssistantConfig.SuggestionQueryConfig.Sections
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setSections(HumanAgentAssistantConfig.SuggestionQueryConfig.Sections.Builder builderForValue)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setSections(HumanAgentAssistantConfig.SuggestionQueryConfig.Sections.Builder builderForValue)

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

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue HumanAgentAssistantConfig.SuggestionQueryConfig.Sections.Builder
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides