Class HumanAgentAssistantConfig.SuggestionQueryConfig.Builder (4.3.1)

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns Overrides

build()

public HumanAgentAssistantConfig.SuggestionQueryConfig build()
Returns

buildPartial()

public HumanAgentAssistantConfig.SuggestionQueryConfig buildPartial()
Returns

clear()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clear()
Returns 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.

float confidence_threshold = 5;

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

clearDialogflowQuerySource()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearDialogflowQuerySource()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.

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

Returns

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

clearField(Descriptors.FieldDescriptor field)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns 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

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns Overrides

clearQuerySource()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clearQuerySource()
Returns

clone()

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder clone()
Returns 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.

float confidence_threshold = 5;

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

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

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

getDefaultInstanceForType()

public HumanAgentAssistantConfig.SuggestionQueryConfig getDefaultInstanceForType()
Returns

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDialogflowQuerySource()

public 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

getDialogflowQuerySourceBuilder()

public HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource.Builder getDialogflowQuerySourceBuilder()

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.

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

Returns

getDialogflowQuerySourceOrBuilder()

public 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

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

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

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

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

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

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

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

The maxResults.

getQuerySourceCase()

public HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase getQuerySourceCase()
Returns

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
TypeDescription
boolean

Whether the contextFilterSettings field is set.

hasDialogflowQuerySource()

public 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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 Returns

mergeDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource value)

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

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.

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

Parameter Returns

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 Returns

mergeFrom(HumanAgentAssistantConfig.SuggestionQueryConfig other)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeFrom(HumanAgentAssistantConfig.SuggestionQueryConfig other)
Parameter Returns

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns 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 Returns

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HumanAgentAssistantConfig.SuggestionQueryConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns 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.

float confidence_threshold = 5;

Parameter
NameDescription
valuefloat

The confidenceThreshold to set.

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

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 Returns

setDialogflowQuerySource(HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource value)

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

Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.

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

Parameter Returns

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.

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

Parameter Returns

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 Returns

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 Returns

setField(Descriptors.FieldDescriptor field, Object value)

public HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns 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 Returns

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 Returns

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
NameDescription
valueint

The maxResults to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final HumanAgentAssistantConfig.SuggestionQueryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns Overrides