Class: Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec

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

Overview

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

Defined Under Namespace

Classes: UserAnswer

Instance Attribute Summary collapse

Instance Attribute Details

#conversation_id ⇒ ::String

Returns This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

Returns:

  • (::String) —

    This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 811

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

  # This field specifies the current user answer during the conversational
  # search. This can be either user selected from suggested answers or user
  # input plain text.
  # @!attribute [rw] text_answer
  #   @return [::String]
  #     This field specifies the incremental input text from the user during
  #     the conversational search.
  #
  #     Note: The following fields are mutually exclusive: `text_answer`, `selected_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] selected_answer
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec::UserAnswer::SelectedAnswer]
  #     This field specifies the selected attributes during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResult.suggested_answers][].
  #
  #     Note: The following fields are mutually exclusive: `selected_answer`, `text_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class UserAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This field specifies the selected answers during the conversational
    # search.
    # @!attribute [rw] product_attribute_values
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Array<::Google::Cloud::Retail::V2::ProductAttributeValue>]
    #     This field is deprecated and should not be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     This field specifies the selected answer which is a attribute
    #     key-value.
    class SelectedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#followup_conversation_requested ⇒ ::Boolean

Returns This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.

Returns:

  • (::Boolean) —

    This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 811

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

  # This field specifies the current user answer during the conversational
  # search. This can be either user selected from suggested answers or user
  # input plain text.
  # @!attribute [rw] text_answer
  #   @return [::String]
  #     This field specifies the incremental input text from the user during
  #     the conversational search.
  #
  #     Note: The following fields are mutually exclusive: `text_answer`, `selected_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] selected_answer
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec::UserAnswer::SelectedAnswer]
  #     This field specifies the selected attributes during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResult.suggested_answers][].
  #
  #     Note: The following fields are mutually exclusive: `selected_answer`, `text_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class UserAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This field specifies the selected answers during the conversational
    # search.
    # @!attribute [rw] product_attribute_values
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Array<::Google::Cloud::Retail::V2::ProductAttributeValue>]
    #     This field is deprecated and should not be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     This field specifies the selected answer which is a attribute
    #     key-value.
    class SelectedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#user_answer ⇒ ::Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec::UserAnswer

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

Returns:



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 811

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

  # This field specifies the current user answer during the conversational
  # search. This can be either user selected from suggested answers or user
  # input plain text.
  # @!attribute [rw] text_answer
  #   @return [::String]
  #     This field specifies the incremental input text from the user during
  #     the conversational search.
  #
  #     Note: The following fields are mutually exclusive: `text_answer`, `selected_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] selected_answer
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec::UserAnswer::SelectedAnswer]
  #     This field specifies the selected attributes during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResult.suggested_answers][].
  #
  #     Note: The following fields are mutually exclusive: `selected_answer`, `text_answer`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class UserAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # This field specifies the selected answers during the conversational
    # search.
    # @!attribute [rw] product_attribute_values
    #   @deprecated This field is deprecated and may be removed in the next major version update.
    #   @return [::Array<::Google::Cloud::Retail::V2::ProductAttributeValue>]
    #     This field is deprecated and should not be set.
    # @!attribute [rw] product_attribute_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     This field specifies the selected answer which is a attribute
    #     key-value.
    class SelectedAnswer
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end