Google Cloud Retail V2 Client - Class ConversationalFilteringResult (2.5.0)

Reference documentation and code samples for the Google Cloud Retail V2 Client class ConversationalFilteringResult.

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

Generated from protobuf message google.cloud.retail.v2.ConversationalSearchResponse.ConversationalFilteringResult

Namespace

Google \ Cloud \ Retail \ V2 \ ConversationalSearchResponse

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ followup_question FollowupQuestion

The conversational filtering question.

↳ additional_filter ConversationalFilteringResult\AdditionalFilter

This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests.

getFollowupQuestion

The conversational filtering question.

Returns
Type Description
FollowupQuestion|null

hasFollowupQuestion

clearFollowupQuestion

setFollowupQuestion

The conversational filtering question.

Parameter
Name Description
var FollowupQuestion
Returns
Type Description
$this

getAdditionalFilter

This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests.

Returns
Type Description
ConversationalFilteringResult\AdditionalFilter|null

hasAdditionalFilter

clearAdditionalFilter

setAdditionalFilter

This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests.

Parameter
Name Description
var ConversationalFilteringResult\AdditionalFilter
Returns
Type Description
$this