Class: Google::Cloud::Retail::V2::ConversationalSearchRequest

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

Request message for ConversationalSearchService.ConversationalSearch method.

Defined Under Namespace

Classes: ConversationalFilteringSpec, SearchParams, UserAnswer, UserLabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#branch ⇒ ::String

Returns Required. The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

Returns:

  • (::String) —

    Required. The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

    Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#conversation_id ⇒ ::String

Returns Optional. 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 ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.

Returns:

  • (::String) —

    Optional. 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 ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#conversational_filtering_spec ⇒ ::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec

Returns Optional. This field specifies all conversational filtering related parameters.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_categories ⇒ ::Array<::String>

Returns Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

Returns:

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

    Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

    To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

    Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#placement ⇒ ::String

Returns Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search or projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config This field is used to identify the serving config name and the set of models that will be used to make the search.

Returns:

  • (::String) —

    Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search or projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config This field is used to identify the serving config name and the set of models that will be used to make the search.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query ⇒ ::String

Returns Optional. Raw search query to be searched for.

If this field is empty, the request is considered a category browsing request.

Returns:

  • (::String) —

    Optional. Raw search query to be searched for.

    If this field is empty, the request is considered a category browsing request.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#safety_settings ⇒ ::Array<::Google::Cloud::Retail::V2::SafetySetting>

Returns Optional. The safety settings to be applied to the generated content.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#search_params ⇒ ::Google::Cloud::Retail::V2::ConversationalSearchRequest::SearchParams

Returns Optional. Search parameters.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_info ⇒ ::Google::Cloud::Retail::V2::UserInfo

Returns Optional. User information.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. The user labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.
  • Each label must be a key-value pair.
  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. The user labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#visitor_id ⇒ ::String

Returns Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This should be the same identifier as UserEvent.visitor_id.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::String) —

    Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

    This should be the same identifier as UserEvent.visitor_id.

    The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 114

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

  # Search parameters.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to restrict search results.
  #
  #     The syntax of the filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] canonical_filter
  #   @return [::String]
  #     Optional. The canonical filter string to restrict search results.
  #
  #     The syntax of the canonical filter string is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}.
  # @!attribute [rw] sort_by
  #   @return [::String]
  #     Optional. The sort string to specify the sorting of search results.
  #
  #     The syntax of the sort string is the same as
  #     [SearchRequest.sort][].
  # @!attribute [rw] boost_spec
  #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
  #     Optional. The boost spec to specify the boosting of search results.
  #
  #     The syntax of the boost spec is the same as
  #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}.
  class SearchParams
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # This field specifies the current user answer during the conversational
  # filtering 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::ConversationalSearchRequest::UserAnswer::SelectedAnswer]
  #     Optional. This field specifies the selected answer during the
  #     conversational search. This should be a subset of
  #     [ConversationalSearchResponse.followup_question.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_value
    #   @return [::Google::Cloud::Retail::V2::ProductAttributeValue]
    #     Optional. 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

  # This field specifies all conversational filtering related parameters
  # addition to conversational retail search.
  # @!attribute [rw] enable_conversational_filtering
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. Please use
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec#conversational_filtering_mode ConversationalFilteringSpec.conversational_filtering_mode}
  #     instead.
  # @!attribute [rw] user_answer
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::UserAnswer]
  #     Optional. This field specifies the current user answer during the
  #     conversational filtering search. It can be either user selected from
  #     suggested answers or user input plain text.
  # @!attribute [rw] conversational_filtering_mode
  #   @return [::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode]
  #     Optional. Mode to control Conversational Filtering.
  #     Defaults to
  #     {::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec::Mode::DISABLED Mode.DISABLED}
  #     if it's unset.
  class ConversationalFilteringSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to control Conversational Filtering mode.
    # A single conversation session including multiple turns supports modes for
    # Conversational Search OR Conversational Filtering without
    # Conversational Search, but not both.
    module Mode
      # Default value.
      MODE_UNSPECIFIED = 0

      # Disables Conversational Filtering when using Conversational Search.
      DISABLED = 1

      # Enables Conversational Filtering when using Conversational Search.
      ENABLED = 2

      # Enables Conversational Filtering without Conversational Search.
      CONVERSATIONAL_FILTER_ONLY = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end