Package com.google.cloud.dialogflow.v2
Class HumanAgentAssistantConfig.SuggestionQueryConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig
- All Implemented Interfaces:
HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
- Enclosing class:
- HumanAgentAssistantConfig
public static final class HumanAgentAssistantConfig.SuggestionQueryConfig
extends com.google.protobuf.GeneratedMessage
implements HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
Config for suggestion query.Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classConfig for suggestion query.static final classSettings that determine how to filter recent conversation context when generating suggestions.static interfacestatic final classDialogflow source setting.static interfacestatic final classDocument source settings.static interfacestatic final classKnowledge base source settings.static interfacestatic enumstatic final classCustom sections to return when requesting a summary of a conversation.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanfloatConfidence threshold of query result.Determines how recent conversation context is filtered when generating suggestions.Determines how recent conversation context is filtered when generating suggestions.intOptional.static final com.google.protobuf.Descriptors.DescriptorQuery from Dialogflow agent.Query from Dialogflow agent.Query from knowledge base document.Query from knowledge base document.Query from knowledgebase.Query from knowledgebase.intMaximum number of results to return.com.google.protobuf.Parser<HumanAgentAssistantConfig.SuggestionQueryConfig>Optional.Optional.intbooleanDetermines how recent conversation context is filtered when generating suggestions.booleanQuery from Dialogflow agent.booleanQuery from knowledge base document.inthashCode()booleanQuery from knowledgebase.booleanOptional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<HumanAgentAssistantConfig.SuggestionQueryConfig>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
KNOWLEDGE_BASE_QUERY_SOURCE_FIELD_NUMBER
public static final int KNOWLEDGE_BASE_QUERY_SOURCE_FIELD_NUMBER- See Also:
-
DOCUMENT_QUERY_SOURCE_FIELD_NUMBER
public static final int DOCUMENT_QUERY_SOURCE_FIELD_NUMBER- See Also:
-
DIALOGFLOW_QUERY_SOURCE_FIELD_NUMBER
public static final int DIALOGFLOW_QUERY_SOURCE_FIELD_NUMBER- See Also:
-
MAX_RESULTS_FIELD_NUMBER
public static final int MAX_RESULTS_FIELD_NUMBER- See Also:
-
CONFIDENCE_THRESHOLD_FIELD_NUMBER
public static final int CONFIDENCE_THRESHOLD_FIELD_NUMBER- See Also:
-
CONTEXT_FILTER_SETTINGS_FIELD_NUMBER
public static final int CONTEXT_FILTER_SETTINGS_FIELD_NUMBER- See Also:
-
SECTIONS_FIELD_NUMBER
public static final int SECTIONS_FIELD_NUMBER- See Also:
-
CONTEXT_SIZE_FIELD_NUMBER
public static final int CONTEXT_SIZE_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getQuerySourceCase
- Specified by:
getQuerySourceCasein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
-
hasKnowledgeBaseQuerySource
public boolean hasKnowledgeBaseQuerySource()Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ.
.google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource knowledge_base_query_source = 1;- Specified by:
hasKnowledgeBaseQuerySourcein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- Whether the knowledgeBaseQuerySource field is set.
-
getKnowledgeBaseQuerySource
public 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;- Specified by:
getKnowledgeBaseQuerySourcein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- The knowledgeBaseQuerySource.
-
getKnowledgeBaseQuerySourceOrBuilder
public 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;- Specified by:
getKnowledgeBaseQuerySourceOrBuilderin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
-
hasDocumentQuerySource
public 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;- Specified by:
hasDocumentQuerySourcein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- Whether the documentQuerySource field is set.
-
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;- Specified by:
getDocumentQuerySourcein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- The documentQuerySource.
-
getDocumentQuerySourceOrBuilder
public 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;- Specified by:
getDocumentQuerySourceOrBuilderin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
-
hasDialogflowQuerySource
public boolean hasDialogflowQuerySource()Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
.google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource dialogflow_query_source = 3;- Specified by:
hasDialogflowQuerySourcein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- Whether the dialogflowQuerySource field is set.
-
getDialogflowQuerySource
public 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;- Specified by:
getDialogflowQuerySourcein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- The dialogflowQuerySource.
-
getDialogflowQuerySourceOrBuilder
public 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;- Specified by:
getDialogflowQuerySourceOrBuilderin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
-
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;- Specified by:
getMaxResultsin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- The maxResults.
-
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 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;- Specified by:
getConfidenceThresholdin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- The confidenceThreshold.
-
hasContextFilterSettings
public 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;- Specified by:
hasContextFilterSettingsin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- Whether the contextFilterSettings field is set.
-
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.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;- Specified by:
getContextFilterSettingsin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- 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.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings context_filter_settings = 7;- Specified by:
getContextFilterSettingsOrBuilderin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
-
hasSections
public boolean hasSections()Optional. The customized sections chosen to return when requesting a summary of a conversation.
.google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasSectionsin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- Whether the sections field is set.
-
getSections
Optional. The customized sections chosen to return when requesting a summary of a conversation.
.google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSectionsin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- The sections.
-
getSectionsOrBuilder
Optional. The customized sections chosen to return when requesting a summary of a conversation.
.google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.Sections sections = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSectionsOrBuilderin interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
-
getContextSize
public int getContextSize()Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST.
int32 context_size = 9 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getContextSizein interfaceHumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder- Returns:
- The contextSize.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static HumanAgentAssistantConfig.SuggestionQueryConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static HumanAgentAssistantConfig.SuggestionQueryConfig.Builder newBuilder(HumanAgentAssistantConfig.SuggestionQueryConfig prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HumanAgentAssistantConfig.SuggestionQueryConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
public com.google.protobuf.Parser<HumanAgentAssistantConfig.SuggestionQueryConfig> getParserForType()- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-