Retail v2 API - Class ConversationalSearchResponse (2.15.0) 

public sealed class ConversationalSearchResponse : IMessage<ConversationalSearchResponse>, IEquatable<ConversationalSearchResponse>, IDeepCloneable<ConversationalSearchResponse>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class ConversationalSearchResponse.

Response message for [ConversationalSearchService.ConversationalSearch][google.cloud.retail.v2.ConversationalSearchService.ConversationalSearch] method.

Inheritance

object > ConversationalSearchResponse

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ConversationalSearchResponse()

public ConversationalSearchResponse()

ConversationalSearchResponse(ConversationalSearchResponse)

public ConversationalSearchResponse(ConversationalSearchResponse other)
Parameter
Name Description
other ConversationalSearchResponse

Properties

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 [ConversationalSearchRequest.conversation_id][google.cloud.retail.v2.ConversationalSearchRequest.conversation_id] to restore conversation state in server.

Property Value
Type Description
string

ConversationalFilteringResult

public ConversationalSearchResponse.Types.ConversationalFilteringResult ConversationalFilteringResult { get; set; }

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

Property Value
Type Description
ConversationalSearchResponseTypesConversationalFilteringResult

ConversationalTextResponse

public string ConversationalTextResponse { get; set; }

The conversational answer-based text response generated by the Server.

Property Value
Type Description
string

FollowupQuestion

public ConversationalSearchResponse.Types.FollowupQuestion FollowupQuestion { get; set; }

The conversational followup question generated for Intent refinement.

Property Value
Type Description
ConversationalSearchResponseTypesFollowupQuestion

RefinedSearch

public RepeatedField<ConversationalSearchResponse.Types.RefinedSearch> RefinedSearch { get; }

The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

Property Value
Type Description
RepeatedFieldConversationalSearchResponseTypesRefinedSearch

State

public ConversationalSearchResponse.Types.State State { get; set; }

Output only. The state of the response generation.

Property Value
Type Description
ConversationalSearchResponseTypesState

UserQueryTypes

public RepeatedField<string> UserQueryTypes { get; }

The types Retail classifies the search query as.

Supported values are:

  • "ORDER_SUPPORT"
  • "SIMPLE_PRODUCT_SEARCH"
  • "INTENT_REFINEMENT"
  • "PRODUCT_DETAILS"
  • "PRODUCT_COMPARISON"
  • "DEALS_AND_COUPONS"
  • "STORE_RELEVANT"
  • "BLOCKLISTED"
  • "BEST_PRODUCT"
  • "RETAIL_SUPPORT"
  • "DISABLED"
Property Value
Type Description
RepeatedFieldstring