Class HumanAgentAssistantConfig.SuggestionQueryConfig (4.29.0)

public static final class HumanAgentAssistantConfig.SuggestionQueryConfig extends GeneratedMessageV3 implements HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder

Config for suggestion query.

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

Inheritance

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

Static Fields

CONFIDENCE_THRESHOLD_FIELD_NUMBER

public static final int CONFIDENCE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

CONTEXT_FILTER_SETTINGS_FIELD_NUMBER

public static final int CONTEXT_FILTER_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

DIALOGFLOW_QUERY_SOURCE_FIELD_NUMBER

public static final int DIALOGFLOW_QUERY_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_QUERY_SOURCE_FIELD_NUMBER

public static final int DOCUMENT_QUERY_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

KNOWLEDGE_BASE_QUERY_SOURCE_FIELD_NUMBER

public static final int KNOWLEDGE_BASE_QUERY_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

MAX_RESULTS_FIELD_NUMBER

public static final int MAX_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HumanAgentAssistantConfig.SuggestionQueryConfig getDefaultInstance()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig

getDescriptor()

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

newBuilder()

public static HumanAgentAssistantConfig.SuggestionQueryConfig.Builder newBuilder()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

newBuilder(HumanAgentAssistantConfig.SuggestionQueryConfig prototype)

public static HumanAgentAssistantConfig.SuggestionQueryConfig.Builder newBuilder(HumanAgentAssistantConfig.SuggestionQueryConfig prototype)
Parameter
Name Description
prototype HumanAgentAssistantConfig.SuggestionQueryConfig
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder

parseDelimitedFrom(InputStream input)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HumanAgentAssistantConfig.SuggestionQueryConfig> parser()
Returns
Type Description
Parser<SuggestionQueryConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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.

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.

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.

getParserForType()

public Parser<HumanAgentAssistantConfig.SuggestionQueryConfig> getParserForType()
Returns
Type Description
Parser<SuggestionQueryConfig>
Overrides

getQuerySourceCase()

public HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase getQuerySourceCase()
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HumanAgentAssistantConfig.SuggestionQueryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException