Reference documentation and code samples for the Google Cloud Retail V2 Client class ConversationalSearchResponse.
Response message for ConversationalSearchService.ConversationalSearch method.
Generated from protobuf message google.cloud.retail.v2.ConversationalSearchResponse
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ user_query_types
array
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"
↳ conversational_text_response
string
The conversational answer-based text response generated by the Server.
↳ followup_question
ConversationalSearchResponse\FollowupQuestion
The conversational followup question generated for Intent refinement.
↳ conversation_id
string
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 to restore conversation state in server.
↳ refined_search
array< ConversationalSearchResponse\RefinedSearch
>
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.
↳ conversational_filtering_result
ConversationalSearchResponse\ConversationalFilteringResult
This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
↳ state
int
Output only. The state of the response generation.
getUserQueryTypes
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"
setUserQueryTypes
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"
var
string[]
$this
getConversationalTextResponse
The conversational answer-based text response generated by the Server.
string
setConversationalTextResponse
The conversational answer-based text response generated by the Server.
var
string
$this
getFollowupQuestion
The conversational followup question generated for Intent refinement.
hasFollowupQuestion
clearFollowupQuestion
setFollowupQuestion
The conversational followup question generated for Intent refinement.
$this
getConversationId
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 to restore conversation state in server.
string
setConversationId
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 to restore conversation state in server.
var
string
$this
getRefinedSearch
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.
setRefinedSearch
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.
$this
getConversationalFilteringResult
This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
hasConversationalFilteringResult
clearConversationalFilteringResult
setConversationalFilteringResult
This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
$this
getState
Output only. The state of the response generation.
setState
Output only. The state of the response generation.
$this
