Retail v2 API - Class SearchResponse.Types.ConversationalSearchResult (2.12.0) 

public sealed class SearchResponse.Types.ConversationalSearchResult : IMessage<SearchResponse.Types.ConversationalSearchResult>, IEquatable<SearchResponse.Types.ConversationalSearchResult>, IDeepCloneable<SearchResponse.Types.ConversationalSearchResult>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class SearchResponse.Types.ConversationalSearchResult.

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

Inheritance

object > SearchResponse.Types.ConversationalSearchResult

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ConversationalSearchResult()

public ConversationalSearchResult()

ConversationalSearchResult(ConversationalSearchResult)

public ConversationalSearchResult(SearchResponse.Types.ConversationalSearchResult other)
Parameter
Name Description
other SearchResponseTypesConversationalSearchResult

Properties

AdditionalFilter

public SearchResponse.Types.ConversationalSearchResult.Types.AdditionalFilter AdditionalFilter { get; set; }

This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter], and use the merged filter in the follow up search request.

Property Value
Type Description
SearchResponseTypesConversationalSearchResultTypesAdditionalFilter

AdditionalFilters

[Obsolete]
public RepeatedField<SearchResponse.Types.ConversationalSearchResult.Types.AdditionalFilter> AdditionalFilters { get; }

This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field additional_filter.

Property Value
Type Description
RepeatedFieldSearchResponseTypesConversationalSearchResultTypesAdditionalFilter

ConversationId

public string ConversationId { get; set; }

Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id] to restore conversation state in server.

Property Value
Type Description
string

FollowupQuestion

public string FollowupQuestion { get; set; }

The follow-up question. e.g., What is the color?

Property Value
Type Description
string

RefinedQuery

public string RefinedQuery { get; set; }

The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if [SearchRequest.query][google.cloud.retail.v2.SearchRequest.query] is dress and next [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer] is red color, which does not match any product attribute value filters, the refined query will be dress, red color.

Property Value
Type Description
string

SuggestedAnswers

public RepeatedField<SearchResponse.Types.ConversationalSearchResult.Types.SuggestedAnswer> SuggestedAnswers { get; }

The answer options provided to client for the follow-up question.

Property Value
Type Description
RepeatedFieldSearchResponseTypesConversationalSearchResultTypesSuggestedAnswer