Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class SuggestionFeatureConfig.
Config for suggestion features.
Generated from protobuf message google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionFeatureConfig
Namespace
Google \ Cloud \ Dialogflow \ V2 \ HumanAgentAssistantConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ suggestion_feature |
Google\Cloud\Dialogflow\V2\SuggestionFeature
The suggestion feature. |
↳ enable_event_based_suggestion |
bool
Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. |
↳ disable_agent_query_logging |
bool
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. |
↳ enable_query_suggestion_when_no_answer |
bool
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 |
↳ enable_conversation_augmented_query |
bool
Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. |
↳ enable_query_suggestion_only |
bool
Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST |
↳ enable_response_debug_info |
bool
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 |
↳ rai_settings |
Google\Cloud\Dialogflow\V2\RaiSettings
Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST |
↳ suggestion_trigger_settings |
SuggestionTriggerSettings
Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION and FAQ will use this field. |
↳ query_config |
SuggestionQueryConfig
Configs of query. |
↳ conversation_model_config |
ConversationModelConfig
Configs of custom conversation model. |
↳ conversation_process_config |
ConversationProcessConfig
Configs for processing conversation. |
getSuggestionFeature
The suggestion feature.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\SuggestionFeature|null |
|
hasSuggestionFeature
clearSuggestionFeature
setSuggestionFeature
The suggestion feature.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\SuggestionFeature
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableEventBasedSuggestion
Automatically iterates all participants and tries to compile suggestions.
Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableEventBasedSuggestion
Automatically iterates all participants and tries to compile suggestions.
Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisableAgentQueryLogging
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableQuerySuggestionWhenNoAnswer
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
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableConversationAugmentedQuery
Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableConversationAugmentedQuery
Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableQuerySuggestionOnly
Optional. Enable query suggestion only.
Supported features: KNOWLEDGE_ASSIST
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableQuerySuggestionOnly
Optional. Enable query suggestion only.
Supported features: KNOWLEDGE_ASSIST
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableResponseDebugInfo
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
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRaiSettings
Optional. Settings for Responsible AI checks.
Supported features: KNOWLEDGE_ASSIST
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\RaiSettings|null |
|
hasRaiSettings
clearRaiSettings
setRaiSettings
Optional. Settings for Responsible AI checks.
Supported features: KNOWLEDGE_ASSIST
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\RaiSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSuggestionTriggerSettings
Settings of suggestion trigger.
Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
| Returns | |
|---|---|
| Type | Description |
SuggestionTriggerSettings|null |
|
hasSuggestionTriggerSettings
clearSuggestionTriggerSettings
setSuggestionTriggerSettings
Settings of suggestion trigger.
Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
| Parameter | |
|---|---|
| Name | Description |
var |
SuggestionTriggerSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryConfig
Configs of query.
| Returns | |
|---|---|
| Type | Description |
SuggestionQueryConfig|null |
|
hasQueryConfig
clearQueryConfig
setQueryConfig
Configs of query.
| Parameter | |
|---|---|
| Name | Description |
var |
SuggestionQueryConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConversationModelConfig
Configs of custom conversation model.
| Returns | |
|---|---|
| Type | Description |
ConversationModelConfig|null |
|
hasConversationModelConfig
clearConversationModelConfig
setConversationModelConfig
Configs of custom conversation model.
| Parameter | |
|---|---|
| Name | Description |
var |
ConversationModelConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConversationProcessConfig
Configs for processing conversation.
| Returns | |
|---|---|
| Type | Description |
ConversationProcessConfig|null |
|
hasConversationProcessConfig
clearConversationProcessConfig
setConversationProcessConfig
Configs for processing conversation.
| Parameter | |
|---|---|
| Name | Description |
var |
ConversationProcessConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|