Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Dialogflow V2 Client - Class KnowledgeAssistBehavior (2.4.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class KnowledgeAssistBehavior.

Configured behaviors for Knowedge Assist.

Generated from protobuf message google.cloud.dialogflow.v2.KnowledgeAssistDebugInfo.KnowledgeAssistBehavior

Namespace

Google \ Cloud \ Dialogflow \ V2 \ KnowledgeAssistDebugInfo

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ answer_generation_rewriter_on`	`bool` Whether data store agent rewriter was turned off for the request.
`↳ end_user_metadata_included`	`bool` Whether end_user_metadata is included in the data store agent call.
`↳ return_query_only`	`bool` Whether customers configured to return query only in the conversation profile.
`↳ use_pubsub_delivery`	`bool` Whether customers configured to use pubsub to deliver.
`↳ disable_sync_delivery`	`bool` Whether customers configured to disable the synchronous delivery of Knowedge Assist response.
`↳ previous_queries_included`	`bool` Whether previously suggested queries are included in the query generation process.
`↳ use_translated_message`	`bool` Translated message is included in query generation process.
`↳ use_custom_safety_filter_level`	`bool` Safety filter is adjusted by user.
`↳ conversation_transcript_has_mixed_languages`	`bool` Conversation transcript has mixed languages.
`↳ query_generation_agent_language_mismatch`	`bool` Whether the agent language from the translation generator mismatches the end-user language.
`↳ query_generation_end_user_language_mismatch`	`bool` Whether the end-user language from the translation generator mismatches the end-user language.
`↳ third_party_connector_allowed`	`bool` This field indicates whether third party connectors are enabled for the project
`↳ multiple_queries_generated`	`bool` Indicates that the query generation model generated multiple queries.
`↳ query_contained_search_context`	`bool` Indicates that the generated query contains search context.
`↳ invalid_items_query_suggestion_skipped`	`bool` Indicates that invalid items were skipped when parsing the LLM response.
`↳ primary_query_redacted_and_replaced`	`bool` True if the primary suggested query was redacted and replaced by an additional query.
`↳ appended_search_context_count`	`int` The number of search contexts appended to the query.

getAnswerGenerationRewriterOn

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

Returns
Type	Description
`bool`

setAnswerGenerationRewriterOn

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEndUserMetadataIncluded

Whether end_user_metadata is included in the data store agent call.

Returns
Type	Description
`bool`

setEndUserMetadataIncluded

Whether end_user_metadata is included in the data store agent call.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getReturnQueryOnly

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

Returns
Type	Description
`bool`

setReturnQueryOnly

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getUsePubsubDelivery

Whether customers configured to use pubsub to deliver.

Returns
Type	Description
`bool`

setUsePubsubDelivery

Whether customers configured to use pubsub to deliver.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDisableSyncDelivery

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

Returns
Type	Description
`bool`

setDisableSyncDelivery

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPreviousQueriesIncluded

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

Returns
Type	Description
`bool`

setPreviousQueriesIncluded

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getUseTranslatedMessage

Translated message is included in query generation process.

Returns
Type	Description
`bool`

setUseTranslatedMessage

Translated message is included in query generation process.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getUseCustomSafetyFilterLevel

Safety filter is adjusted by user.

Returns
Type	Description
`bool`

setUseCustomSafetyFilterLevel

Safety filter is adjusted by user.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getConversationTranscriptHasMixedLanguages

Conversation transcript has mixed languages.

Returns
Type	Description
`bool`

setConversationTranscriptHasMixedLanguages

Conversation transcript has mixed languages.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getQueryGenerationAgentLanguageMismatch

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

Returns
Type	Description
`bool`

setQueryGenerationAgentLanguageMismatch

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getQueryGenerationEndUserLanguageMismatch

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

Returns
Type	Description
`bool`

setQueryGenerationEndUserLanguageMismatch

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getThirdPartyConnectorAllowed

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

Returns
Type	Description
`bool`

setThirdPartyConnectorAllowed

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getMultipleQueriesGenerated

Indicates that the query generation model generated multiple queries.

Returns
Type	Description
`bool`

setMultipleQueriesGenerated

Indicates that the query generation model generated multiple queries.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getQueryContainedSearchContext

Indicates that the generated query contains search context.

Returns
Type	Description
`bool`

setQueryContainedSearchContext

Indicates that the generated query contains search context.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getInvalidItemsQuerySuggestionSkipped

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

Returns
Type	Description
`bool`

setInvalidItemsQuerySuggestionSkipped

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPrimaryQueryRedactedAndReplaced

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

Returns
Type	Description
`bool`

setPrimaryQueryRedactedAndReplaced

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getAppendedSearchContextCount

The number of search contexts appended to the query.

Returns
Type	Description
`int`

setAppendedSearchContextCount

The number of search contexts appended to the query.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`