Interface HumanAgentAssistantConfig.SuggestionFeatureConfigOrBuilder (4.100.0)

4.100.0 (latest) 4.99.0 4.97.0 4.94.0 4.93.0 4.91.0 4.89.0 4.88.0 4.87.0 4.86.0 4.84.0 4.82.0 4.81.0 4.80.0 4.79.0 4.78.0 4.76.0 4.74.0 4.73.0 4.70.0 4.69.0 4.68.0 4.66.0 4.65.0 4.64.0 4.63.0 4.62.0 4.61.0 4.60.0 4.59.0 4.58.0 4.57.0 4.55.0 4.54.0 4.53.0 4.52.0 4.51.0 4.50.0 4.49.0 4.48.0 4.47.0 4.46.0 4.45.0 4.43.0 4.42.0 4.41.0 4.40.0 4.39.0 4.38.0 4.37.0 4.36.0 4.35.0 4.34.0 4.33.0 4.30.0 4.29.0 4.28.0 4.27.0 4.26.0 4.25.0 4.24.0 4.23.0 4.22.0 4.21.0 4.20.0 4.19.0 4.18.0 4.17.0 4.15.0 4.14.0 4.13.0 4.12.0 4.11.0 4.10.0 4.9.1 4.8.6 4.7.5 4.6.0 4.5.11 4.4.0 4.3.1

public static interface HumanAgentAssistantConfig.SuggestionFeatureConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConversationProcessConfig()

public abstract HumanAgentAssistantConfig.ConversationProcessConfig getConversationProcessConfig()

Configs for processing conversation.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.ConversationProcessConfig conversation_process_config = 8;

Returns
Type	Description
HumanAgentAssistantConfig.ConversationProcessConfig	The conversationProcessConfig.

getConversationProcessConfigOrBuilder()

public abstract HumanAgentAssistantConfig.ConversationProcessConfigOrBuilder getConversationProcessConfigOrBuilder()

Configs for processing conversation.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.ConversationProcessConfig conversation_process_config = 8;

Returns
Type	Description
HumanAgentAssistantConfig.ConversationProcessConfigOrBuilder

getDisableAgentQueryLogging()

public abstract boolean getDisableAgentQueryLogging()

Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records.

Supported features: KNOWLEDGE_SEARCH.

bool disable_agent_query_logging = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The disableAgentQueryLogging.

getDisableQuerySearchContext()

public abstract boolean getDisableQuerySearchContext()

Optional. If true, disable appending available search context to the search query. Supported features: KNOWLEDGE_ASSIST

bool disable_query_search_context = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The disableQuerySearchContext.

getEnableConversationAugmentedQuery()

public abstract boolean getEnableConversationAugmentedQuery()

Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH.

bool enable_conversation_augmented_query = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableConversationAugmentedQuery.

getEnableEventBasedSuggestion()

public abstract boolean getEnableEventBasedSuggestion()

Automatically iterates all participants and tries to compile suggestions.

Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST.

bool enable_event_based_suggestion = 3;

Returns
Type	Description
boolean	The enableEventBasedSuggestion.

getEnableQuerySuggestionOnly()

public abstract boolean getEnableQuerySuggestionOnly()

Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST

bool enable_query_suggestion_only = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableQuerySuggestionOnly.

getEnableQuerySuggestionWhenNoAnswer()

public abstract boolean getEnableQuerySuggestionWhenNoAnswer()

Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST

bool enable_query_suggestion_when_no_answer = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableQuerySuggestionWhenNoAnswer.

getEnableResponseDebugInfo()

public abstract boolean getEnableResponseDebugInfo()

Optional. Enable returning detailed reasons for suggestion results.

For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results.

Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST

bool enable_response_debug_info = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableResponseDebugInfo.

getQueryConfig()

public abstract HumanAgentAssistantConfig.SuggestionQueryConfig getQueryConfig()

Configs of query.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig query_config = 6;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfig	The queryConfig.

getQueryConfigOrBuilder()

public abstract HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder getQueryConfigOrBuilder()

Configs of query.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig query_config = 6;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder

getRaiSettings()

public abstract RaiSettings getRaiSettings()

Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST

.google.cloud.dialogflow.v2beta1.RaiSettings rai_settings = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RaiSettings	The raiSettings.

getRaiSettingsOrBuilder()

public abstract RaiSettingsOrBuilder getRaiSettingsOrBuilder()

Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST

.google.cloud.dialogflow.v2beta1.RaiSettings rai_settings = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RaiSettingsOrBuilder

getSuggestionFeature()

public abstract SuggestionFeature getSuggestionFeature()

The suggestion feature.

.google.cloud.dialogflow.v2beta1.SuggestionFeature suggestion_feature = 5;

Returns
Type	Description
SuggestionFeature	The suggestionFeature.

getSuggestionFeatureOrBuilder()

public abstract SuggestionFeatureOrBuilder getSuggestionFeatureOrBuilder()

The suggestion feature.

.google.cloud.dialogflow.v2beta1.SuggestionFeature suggestion_feature = 5;

Returns
Type	Description
SuggestionFeatureOrBuilder

getSuggestionTriggerEvent()

public abstract TriggerEvent getSuggestionTriggerEvent()

Optional. The trigger event for suggestion. If unspecified, it will be CUSTOMER_MESSAGE. Supported features: KNOWLEDGE_ASSIST For KNOWLEDGE_ASSIST, these four trigger events are supported:

1. TRIGGER_EVENT_UNSPECIFIED
2. END_OF_UTTERANCE
3. CUSTOMER_MESSAGE
4. AGENT_MESSAGE

.google.cloud.dialogflow.v2beta1.TriggerEvent suggestion_trigger_event = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TriggerEvent	The suggestionTriggerEvent.

getSuggestionTriggerEventValue()

public abstract int getSuggestionTriggerEventValue()

Optional. The trigger event for suggestion. If unspecified, it will be CUSTOMER_MESSAGE. Supported features: KNOWLEDGE_ASSIST For KNOWLEDGE_ASSIST, these four trigger events are supported:

1. TRIGGER_EVENT_UNSPECIFIED
2. END_OF_UTTERANCE
3. CUSTOMER_MESSAGE
4. AGENT_MESSAGE

.google.cloud.dialogflow.v2beta1.TriggerEvent suggestion_trigger_event = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for suggestionTriggerEvent.

getSuggestionTriggerSettings()

public abstract HumanAgentAssistantConfig.SuggestionTriggerSettings getSuggestionTriggerSettings()

Settings of suggestion trigger.

Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionTriggerSettings suggestion_trigger_settings = 10;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionTriggerSettings	The suggestionTriggerSettings.

getSuggestionTriggerSettingsOrBuilder()

public abstract HumanAgentAssistantConfig.SuggestionTriggerSettingsOrBuilder getSuggestionTriggerSettingsOrBuilder()

Settings of suggestion trigger.

Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionTriggerSettings suggestion_trigger_settings = 10;

Returns
Type	Description
HumanAgentAssistantConfig.SuggestionTriggerSettingsOrBuilder

hasConversationProcessConfig()

public abstract boolean hasConversationProcessConfig()

Configs for processing conversation.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.ConversationProcessConfig conversation_process_config = 8;

Returns
Type	Description
boolean	Whether the conversationProcessConfig field is set.

hasQueryConfig()

public abstract boolean hasQueryConfig()

Configs of query.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionQueryConfig query_config = 6;

Returns
Type	Description
boolean	Whether the queryConfig field is set.

hasRaiSettings()

public abstract boolean hasRaiSettings()

Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST

.google.cloud.dialogflow.v2beta1.RaiSettings rai_settings = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the raiSettings field is set.

hasSuggestionFeature()

public abstract boolean hasSuggestionFeature()

The suggestion feature.

.google.cloud.dialogflow.v2beta1.SuggestionFeature suggestion_feature = 5;

Returns
Type	Description
boolean	Whether the suggestionFeature field is set.

hasSuggestionTriggerSettings()

public abstract boolean hasSuggestionTriggerSettings()

Settings of suggestion trigger.

Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field.

.google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionTriggerSettings suggestion_trigger_settings = 10;

Returns
Type	Description
boolean	Whether the suggestionTriggerSettings field is set.