Class: Google::Cloud::Retail::V2::ConversationalSearchResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/conversational_search_service.rb

Overview

Response message for ConversationalSearchService.ConversationalSearch method.

Defined Under Namespace

Modules: State Classes: ConversationalFilteringResult, FollowupQuestion, RefinedSearch

Instance Attribute Summary collapse

Instance Attribute Details

#conversation_id ⇒ ::String

Returns 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.

Returns:

  • (::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.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 277

class ConversationalSearchResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The conversational followup question generated for Intent refinement.
  # @!attribute [rw] followup_question
  #   @return [::String]
  #     The conversational followup question generated for Intent refinement.
  # @!attribute [rw] suggested_answers
  #   @return [::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion::SuggestedAnswer>]
  #     The answer options provided to client for the follow-up question.
  class FollowupQuestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Suggested answers to the follow-up question.
    # If it's numerical attribute, only ProductAttributeInterval will be set.
    # If it's textual attribute, only productAttributeValue will be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class SuggestedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The proposed refined search for intent-refinement/bundled shopping
  # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the
  # refined_query from search response will be populated here.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to be used for search.
  class RefinedSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies all related information that is needed on client
  # side for UI rendering of conversational filtering search.
  # @!attribute [rw] followup_question
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion]
  #     The conversational filtering question.
  # @!attribute [rw] additional_filter
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::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
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},  and
  #     use the merged filter in the follow up requests.
  class ConversationalFilteringResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Additional filter that client side need to apply.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class AdditionalFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the response generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Response generation is being streamed.
    STREAMING = 1

    # Response generation has succeeded.
    SUCCEEDED = 2
  end
end

#conversational_filtering_result ⇒ ::Google::Cloud::Retail::V2::ConversationalSearchResponse::ConversationalFilteringResult

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

Returns:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 277

class ConversationalSearchResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The conversational followup question generated for Intent refinement.
  # @!attribute [rw] followup_question
  #   @return [::String]
  #     The conversational followup question generated for Intent refinement.
  # @!attribute [rw] suggested_answers
  #   @return [::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion::SuggestedAnswer>]
  #     The answer options provided to client for the follow-up question.
  class FollowupQuestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Suggested answers to the follow-up question.
    # If it's numerical attribute, only ProductAttributeInterval will be set.
    # If it's textual attribute, only productAttributeValue will be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class SuggestedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The proposed refined search for intent-refinement/bundled shopping
  # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the
  # refined_query from search response will be populated here.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to be used for search.
  class RefinedSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies all related information that is needed on client
  # side for UI rendering of conversational filtering search.
  # @!attribute [rw] followup_question
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion]
  #     The conversational filtering question.
  # @!attribute [rw] additional_filter
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::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
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},  and
  #     use the merged filter in the follow up requests.
  class ConversationalFilteringResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Additional filter that client side need to apply.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class AdditionalFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the response generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Response generation is being streamed.
    STREAMING = 1

    # Response generation has succeeded.
    SUCCEEDED = 2
  end
end

#conversational_text_response ⇒ ::String

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

Returns:

  • (::String) —

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 277

class ConversationalSearchResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The conversational followup question generated for Intent refinement.
  # @!attribute [rw] followup_question
  #   @return [::String]
  #     The conversational followup question generated for Intent refinement.
  # @!attribute [rw] suggested_answers
  #   @return [::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion::SuggestedAnswer>]
  #     The answer options provided to client for the follow-up question.
  class FollowupQuestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Suggested answers to the follow-up question.
    # If it's numerical attribute, only ProductAttributeInterval will be set.
    # If it's textual attribute, only productAttributeValue will be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class SuggestedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The proposed refined search for intent-refinement/bundled shopping
  # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the
  # refined_query from search response will be populated here.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to be used for search.
  class RefinedSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies all related information that is needed on client
  # side for UI rendering of conversational filtering search.
  # @!attribute [rw] followup_question
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion]
  #     The conversational filtering question.
  # @!attribute [rw] additional_filter
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::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
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},  and
  #     use the merged filter in the follow up requests.
  class ConversationalFilteringResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Additional filter that client side need to apply.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class AdditionalFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the response generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Response generation is being streamed.
    STREAMING = 1

    # Response generation has succeeded.
    SUCCEEDED = 2
  end
end

#followup_question ⇒ ::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion

Returns The conversational followup question generated for Intent refinement.

Returns:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 277

class ConversationalSearchResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The conversational followup question generated for Intent refinement.
  # @!attribute [rw] followup_question
  #   @return [::String]
  #     The conversational followup question generated for Intent refinement.
  # @!attribute [rw] suggested_answers
  #   @return [::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion::SuggestedAnswer>]
  #     The answer options provided to client for the follow-up question.
  class FollowupQuestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Suggested answers to the follow-up question.
    # If it's numerical attribute, only ProductAttributeInterval will be set.
    # If it's textual attribute, only productAttributeValue will be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class SuggestedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The proposed refined search for intent-refinement/bundled shopping
  # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the
  # refined_query from search response will be populated here.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to be used for search.
  class RefinedSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies all related information that is needed on client
  # side for UI rendering of conversational filtering search.
  # @!attribute [rw] followup_question
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion]
  #     The conversational filtering question.
  # @!attribute [rw] additional_filter
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::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
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},  and
  #     use the merged filter in the follow up requests.
  class ConversationalFilteringResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Additional filter that client side need to apply.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class AdditionalFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the response generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Response generation is being streamed.
    STREAMING = 1

    # Response generation has succeeded.
    SUCCEEDED = 2
  end
end

#refined_search ⇒ ::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::RefinedSearch>

Returns 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.

Returns:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 277

class ConversationalSearchResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The conversational followup question generated for Intent refinement.
  # @!attribute [rw] followup_question
  #   @return [::String]
  #     The conversational followup question generated for Intent refinement.
  # @!attribute [rw] suggested_answers
  #   @return [::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion::SuggestedAnswer>]
  #     The answer options provided to client for the follow-up question.
  class FollowupQuestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Suggested answers to the follow-up question.
    # If it's numerical attribute, only ProductAttributeInterval will be set.
    # If it's textual attribute, only productAttributeValue will be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class SuggestedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The proposed refined search for intent-refinement/bundled shopping
  # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the
  # refined_query from search response will be populated here.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to be used for search.
  class RefinedSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies all related information that is needed on client
  # side for UI rendering of conversational filtering search.
  # @!attribute [rw] followup_question
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion]
  #     The conversational filtering question.
  # @!attribute [rw] additional_filter
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::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
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},  and
  #     use the merged filter in the follow up requests.
  class ConversationalFilteringResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Additional filter that client side need to apply.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class AdditionalFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the response generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Response generation is being streamed.
    STREAMING = 1

    # Response generation has succeeded.
    SUCCEEDED = 2
  end
end

#state ⇒ ::Google::Cloud::Retail::V2::ConversationalSearchResponse::State (readonly)

Returns Output only. The state of the response generation.

Returns:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 277

class ConversationalSearchResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The conversational followup question generated for Intent refinement.
  # @!attribute [rw] followup_question
  #   @return [::String]
  #     The conversational followup question generated for Intent refinement.
  # @!attribute [rw] suggested_answers
  #   @return [::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion::SuggestedAnswer>]
  #     The answer options provided to client for the follow-up question.
  class FollowupQuestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Suggested answers to the follow-up question.
    # If it's numerical attribute, only ProductAttributeInterval will be set.
    # If it's textual attribute, only productAttributeValue will be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class SuggestedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The proposed refined search for intent-refinement/bundled shopping
  # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the
  # refined_query from search response will be populated here.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to be used for search.
  class RefinedSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies all related information that is needed on client
  # side for UI rendering of conversational filtering search.
  # @!attribute [rw] followup_question
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion]
  #     The conversational filtering question.
  # @!attribute [rw] additional_filter
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::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
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},  and
  #     use the merged filter in the follow up requests.
  class ConversationalFilteringResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Additional filter that client side need to apply.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class AdditionalFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the response generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Response generation is being streamed.
    STREAMING = 1

    # Response generation has succeeded.
    SUCCEEDED = 2
  end
end

#user_query_types ⇒ ::Array<::String>

Returns 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".

Returns:

  • (::Array<::String>) —

    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"


277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 277

class ConversationalSearchResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The conversational followup question generated for Intent refinement.
  # @!attribute [rw] followup_question
  #   @return [::String]
  #     The conversational followup question generated for Intent refinement.
  # @!attribute [rw] suggested_answers
  #   @return [::Array<::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion::SuggestedAnswer>]
  #     The answer options provided to client for the follow-up question.
  class FollowupQuestion
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Suggested answers to the follow-up question.
    # If it's numerical attribute, only ProductAttributeInterval will be set.
    # If it's textual attribute, only productAttributeValue will be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class SuggestedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The proposed refined search for intent-refinement/bundled shopping
  # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the
  # refined_query from search response will be populated here.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to be used for search.
  class RefinedSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies all related information that is needed on client
  # side for UI rendering of conversational filtering search.
  # @!attribute [rw] followup_question
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::FollowupQuestion]
  #     The conversational filtering question.
  # @!attribute [rw] additional_filter
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchResponse::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
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},  and
  #     use the merged filter in the follow up requests.
  class ConversationalFilteringResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Additional filter that client side need to apply.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Product attribute value, including an attribute key and an
    #     attribute value. Other types can be added here in the future.
    class AdditionalFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The state of the response generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Response generation is being streamed.
    STREAMING = 1

    # Response generation has succeeded.
    SUCCEEDED = 2
  end
end