Class KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder (4.97.0)

public static final class KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder extends GeneratedMessage.Builder<KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder> implements KnowledgeAssistDebugInfo.KnowledgeAssistBehaviorOrBuilder

Configured behaviors for Knowedge Assist.

Protobuf type google.cloud.dialogflow.v2.KnowledgeAssistDebugInfo.KnowledgeAssistBehavior

Static Methods

getDescriptor()

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

Methods

build()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior build()
Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior

buildPartial()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior buildPartial()
Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior

clear()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clear()
Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder
Overrides

clearAnswerGenerationRewriterOn()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearAnswerGenerationRewriterOn()

Whether data store agent rewriter was turned off for the request.

bool answer_generation_rewriter_on = 1;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearAppendedSearchContextCount()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearAppendedSearchContextCount()

The number of search contexts appended to the query.

int32 appended_search_context_count = 18;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearConversationTranscriptHasMixedLanguages()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearConversationTranscriptHasMixedLanguages()

Conversation transcript has mixed languages.

bool conversation_transcript_has_mixed_languages = 10;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearDisableSyncDelivery()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearDisableSyncDelivery()

Whether customers configured to disable the synchronous delivery of Knowedge Assist response.

bool disable_sync_delivery = 6;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearEndUserMetadataIncluded()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearEndUserMetadataIncluded()

Whether end_user_metadata is included in the data store agent call.

bool end_user_metadata_included = 2;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearInvalidItemsQuerySuggestionSkipped()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearInvalidItemsQuerySuggestionSkipped()

Indicates that invalid items were skipped when parsing the LLM response.

bool invalid_items_query_suggestion_skipped = 16;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearMultipleQueriesGenerated()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearMultipleQueriesGenerated()

Indicates that the query generation model generated multiple queries.

bool multiple_queries_generated = 14;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearPreviousQueriesIncluded()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearPreviousQueriesIncluded()

Whether previously suggested queries are included in the query generation process.

bool previous_queries_included = 7;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearPrimaryQueryRedactedAndReplaced()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearPrimaryQueryRedactedAndReplaced()

True if the primary suggested query was redacted and replaced by an additional query.

bool primary_query_redacted_and_replaced = 17;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearQueryContainedSearchContext()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearQueryContainedSearchContext()

Indicates that the generated query contains search context.

bool query_contained_search_context = 15;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearQueryGenerationAgentLanguageMismatch()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearQueryGenerationAgentLanguageMismatch()

Whether the agent language from the translation generator mismatches the end-user language.

bool query_generation_agent_language_mismatch = 11;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearQueryGenerationEndUserLanguageMismatch()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearQueryGenerationEndUserLanguageMismatch()

Whether the end-user language from the translation generator mismatches the end-user language.

bool query_generation_end_user_language_mismatch = 12;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearReturnQueryOnly()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearReturnQueryOnly()

Whether customers configured to return query only in the conversation profile.

bool return_query_only = 4;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearThirdPartyConnectorAllowed()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearThirdPartyConnectorAllowed()

This field indicates whether third party connectors are enabled for the project

bool third_party_connector_allowed = 13;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearUseCustomSafetyFilterLevel()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearUseCustomSafetyFilterLevel()

Safety filter is adjusted by user.

bool use_custom_safety_filter_level = 9;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearUsePubsubDelivery()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearUsePubsubDelivery()

Whether customers configured to use pubsub to deliver.

bool use_pubsub_delivery = 5;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

clearUseTranslatedMessage()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder clearUseTranslatedMessage()

Translated message is included in query generation process.

bool use_translated_message = 8;

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

getAnswerGenerationRewriterOn()

public boolean getAnswerGenerationRewriterOn()

Whether data store agent rewriter was turned off for the request.

bool answer_generation_rewriter_on = 1;

Returns
Type Description
boolean

The answerGenerationRewriterOn.

getAppendedSearchContextCount()

public int getAppendedSearchContextCount()

The number of search contexts appended to the query.

int32 appended_search_context_count = 18;

Returns
Type Description
int

The appendedSearchContextCount.

getConversationTranscriptHasMixedLanguages()

public boolean getConversationTranscriptHasMixedLanguages()

Conversation transcript has mixed languages.

bool conversation_transcript_has_mixed_languages = 10;

Returns
Type Description
boolean

The conversationTranscriptHasMixedLanguages.

getDefaultInstanceForType()

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior getDefaultInstanceForType()
Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior

getDescriptorForType()

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

getDisableSyncDelivery()

public boolean getDisableSyncDelivery()

Whether customers configured to disable the synchronous delivery of Knowedge Assist response.

bool disable_sync_delivery = 6;

Returns
Type Description
boolean

The disableSyncDelivery.

getEndUserMetadataIncluded()

public boolean getEndUserMetadataIncluded()

Whether end_user_metadata is included in the data store agent call.

bool end_user_metadata_included = 2;

Returns
Type Description
boolean

The endUserMetadataIncluded.

getInvalidItemsQuerySuggestionSkipped()

public boolean getInvalidItemsQuerySuggestionSkipped()

Indicates that invalid items were skipped when parsing the LLM response.

bool invalid_items_query_suggestion_skipped = 16;

Returns
Type Description
boolean

The invalidItemsQuerySuggestionSkipped.

getMultipleQueriesGenerated()

public boolean getMultipleQueriesGenerated()

Indicates that the query generation model generated multiple queries.

bool multiple_queries_generated = 14;

Returns
Type Description
boolean

The multipleQueriesGenerated.

getPreviousQueriesIncluded()

public boolean getPreviousQueriesIncluded()

Whether previously suggested queries are included in the query generation process.

bool previous_queries_included = 7;

Returns
Type Description
boolean

The previousQueriesIncluded.

getPrimaryQueryRedactedAndReplaced()

public boolean getPrimaryQueryRedactedAndReplaced()

True if the primary suggested query was redacted and replaced by an additional query.

bool primary_query_redacted_and_replaced = 17;

Returns
Type Description
boolean

The primaryQueryRedactedAndReplaced.

getQueryContainedSearchContext()

public boolean getQueryContainedSearchContext()

Indicates that the generated query contains search context.

bool query_contained_search_context = 15;

Returns
Type Description
boolean

The queryContainedSearchContext.

getQueryGenerationAgentLanguageMismatch()

public boolean getQueryGenerationAgentLanguageMismatch()

Whether the agent language from the translation generator mismatches the end-user language.

bool query_generation_agent_language_mismatch = 11;

Returns
Type Description
boolean

The queryGenerationAgentLanguageMismatch.

getQueryGenerationEndUserLanguageMismatch()

public boolean getQueryGenerationEndUserLanguageMismatch()

Whether the end-user language from the translation generator mismatches the end-user language.

bool query_generation_end_user_language_mismatch = 12;

Returns
Type Description
boolean

The queryGenerationEndUserLanguageMismatch.

getReturnQueryOnly()

public boolean getReturnQueryOnly()

Whether customers configured to return query only in the conversation profile.

bool return_query_only = 4;

Returns
Type Description
boolean

The returnQueryOnly.

getThirdPartyConnectorAllowed()

public boolean getThirdPartyConnectorAllowed()

This field indicates whether third party connectors are enabled for the project

bool third_party_connector_allowed = 13;

Returns
Type Description
boolean

The thirdPartyConnectorAllowed.

getUseCustomSafetyFilterLevel()

public boolean getUseCustomSafetyFilterLevel()

Safety filter is adjusted by user.

bool use_custom_safety_filter_level = 9;

Returns
Type Description
boolean

The useCustomSafetyFilterLevel.

getUsePubsubDelivery()

public boolean getUsePubsubDelivery()

Whether customers configured to use pubsub to deliver.

bool use_pubsub_delivery = 5;

Returns
Type Description
boolean

The usePubsubDelivery.

getUseTranslatedMessage()

public boolean getUseTranslatedMessage()

Translated message is included in query generation process.

bool use_translated_message = 8;

Returns
Type Description
boolean

The useTranslatedMessage.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(KnowledgeAssistDebugInfo.KnowledgeAssistBehavior other)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder mergeFrom(KnowledgeAssistDebugInfo.KnowledgeAssistBehavior other)
Parameter
Name Description
other KnowledgeAssistDebugInfo.KnowledgeAssistBehavior
Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder
Overrides

setAnswerGenerationRewriterOn(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setAnswerGenerationRewriterOn(boolean value)

Whether data store agent rewriter was turned off for the request.

bool answer_generation_rewriter_on = 1;

Parameter
Name Description
value boolean

The answerGenerationRewriterOn to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setAppendedSearchContextCount(int value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setAppendedSearchContextCount(int value)

The number of search contexts appended to the query.

int32 appended_search_context_count = 18;

Parameter
Name Description
value int

The appendedSearchContextCount to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setConversationTranscriptHasMixedLanguages(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setConversationTranscriptHasMixedLanguages(boolean value)

Conversation transcript has mixed languages.

bool conversation_transcript_has_mixed_languages = 10;

Parameter
Name Description
value boolean

The conversationTranscriptHasMixedLanguages to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setDisableSyncDelivery(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setDisableSyncDelivery(boolean value)

Whether customers configured to disable the synchronous delivery of Knowedge Assist response.

bool disable_sync_delivery = 6;

Parameter
Name Description
value boolean

The disableSyncDelivery to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setEndUserMetadataIncluded(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setEndUserMetadataIncluded(boolean value)

Whether end_user_metadata is included in the data store agent call.

bool end_user_metadata_included = 2;

Parameter
Name Description
value boolean

The endUserMetadataIncluded to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setInvalidItemsQuerySuggestionSkipped(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setInvalidItemsQuerySuggestionSkipped(boolean value)

Indicates that invalid items were skipped when parsing the LLM response.

bool invalid_items_query_suggestion_skipped = 16;

Parameter
Name Description
value boolean

The invalidItemsQuerySuggestionSkipped to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setMultipleQueriesGenerated(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setMultipleQueriesGenerated(boolean value)

Indicates that the query generation model generated multiple queries.

bool multiple_queries_generated = 14;

Parameter
Name Description
value boolean

The multipleQueriesGenerated to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setPreviousQueriesIncluded(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setPreviousQueriesIncluded(boolean value)

Whether previously suggested queries are included in the query generation process.

bool previous_queries_included = 7;

Parameter
Name Description
value boolean

The previousQueriesIncluded to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setPrimaryQueryRedactedAndReplaced(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setPrimaryQueryRedactedAndReplaced(boolean value)

True if the primary suggested query was redacted and replaced by an additional query.

bool primary_query_redacted_and_replaced = 17;

Parameter
Name Description
value boolean

The primaryQueryRedactedAndReplaced to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setQueryContainedSearchContext(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setQueryContainedSearchContext(boolean value)

Indicates that the generated query contains search context.

bool query_contained_search_context = 15;

Parameter
Name Description
value boolean

The queryContainedSearchContext to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setQueryGenerationAgentLanguageMismatch(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setQueryGenerationAgentLanguageMismatch(boolean value)

Whether the agent language from the translation generator mismatches the end-user language.

bool query_generation_agent_language_mismatch = 11;

Parameter
Name Description
value boolean

The queryGenerationAgentLanguageMismatch to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setQueryGenerationEndUserLanguageMismatch(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setQueryGenerationEndUserLanguageMismatch(boolean value)

Whether the end-user language from the translation generator mismatches the end-user language.

bool query_generation_end_user_language_mismatch = 12;

Parameter
Name Description
value boolean

The queryGenerationEndUserLanguageMismatch to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setReturnQueryOnly(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setReturnQueryOnly(boolean value)

Whether customers configured to return query only in the conversation profile.

bool return_query_only = 4;

Parameter
Name Description
value boolean

The returnQueryOnly to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setThirdPartyConnectorAllowed(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setThirdPartyConnectorAllowed(boolean value)

This field indicates whether third party connectors are enabled for the project

bool third_party_connector_allowed = 13;

Parameter
Name Description
value boolean

The thirdPartyConnectorAllowed to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setUseCustomSafetyFilterLevel(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setUseCustomSafetyFilterLevel(boolean value)

Safety filter is adjusted by user.

bool use_custom_safety_filter_level = 9;

Parameter
Name Description
value boolean

The useCustomSafetyFilterLevel to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setUsePubsubDelivery(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setUsePubsubDelivery(boolean value)

Whether customers configured to use pubsub to deliver.

bool use_pubsub_delivery = 5;

Parameter
Name Description
value boolean

The usePubsubDelivery to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.

setUseTranslatedMessage(boolean value)

public KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder setUseTranslatedMessage(boolean value)

Translated message is included in query generation process.

bool use_translated_message = 8;

Parameter
Name Description
value boolean

The useTranslatedMessage to set.

Returns
Type Description
KnowledgeAssistDebugInfo.KnowledgeAssistBehavior.Builder

This builder for chaining.