Google Cloud Retail V2 Client - Class ConversationalFilteringSpec (2.5.0)

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

This field specifies all conversational filtering related parameters addition to conversational retail search.

Generated from protobuf message google.cloud.retail.v2.ConversationalSearchRequest.ConversationalFilteringSpec

Namespace

Google \ Cloud \ Retail \ V2 \ ConversationalSearchRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ enable_conversational_filtering bool

Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.

↳ user_answer UserAnswer

Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.

↳ conversational_filtering_mode int

Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.

getEnableConversationalFiltering

Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.

Returns
Type Description
bool

setEnableConversationalFiltering

Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUserAnswer

Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.

Returns
Type Description
UserAnswer|null

hasUserAnswer

clearUserAnswer

setUserAnswer

Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.

Parameter
Name Description
var UserAnswer
Returns
Type Description
$this

getConversationalFilteringMode

Optional. Mode to control Conversational Filtering.

Defaults to Mode.DISABLED if it's unset.

Returns
Type Description
int Enum of type Mode.

setConversationalFilteringMode

Optional. Mode to control Conversational Filtering.

Defaults to Mode.DISABLED if it's unset.

Parameter
Name Description
var int

Enum of type Mode.

Returns
Type Description
$this