google-apis-retail_v2alpha 0.110.0 → 0.111.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3b988e1ebc38cf7f58ffc56e996d0ac241b5971ad3ecb11084b5a4ca6dbe783
-  data.tar.gz: 664ba03cdacf021156845e1780fe87d5f7677dcd61ac2c984724521caca2023e
+  metadata.gz: f29b8876dc83d7f24bd51f833280df154c4acf66c3d6e6fadcd21eff28d0fd83
+  data.tar.gz: 4b079181b676df8476555244f6cdd6771fee63af307758756e66682d49dd086a
 SHA512:
-  metadata.gz: d551b67a4c3e54659ccd295548a774ad2c46edf665d922ff1f919199f7a093b0c6607499bab1b443fc0b0b30599c6b1134a25151653e65b17e5f7a2a7a55ed29
-  data.tar.gz: ad2a1fed34cbf79a12b82ce8e7ba9dd7505aec6c4d85853d21e57bff0509e13e873db47620368cdf360671997b76f5ac443e5792bc9b0c7124f23f545ad8ad0e
+  metadata.gz: f64190008b0b80d93ea6a2d570648da296e3afae4666c902f249661b5e848afa4809d15f97e4323f5e84975990ec6c280ee93163ad5bb262f143b24df1d25bec
+  data.tar.gz: cf86755a13f0a069cf1571ec5b2f67bb93fd92d05f8488c958b1ff00ff935a56dbfc7f06d8f4d531b4e357e18dbab45ecf7e31fdbf921929f6f9a965c3122998

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.111.0 (2025-03-16)
+
+* Regenerated from discovery document revision 20250314
+
 ### v0.110.0 (2025-03-09)
 
 * Regenerated from discovery document revision 20250227

data/lib/google/apis/retail_v2alpha/classes.rb

@@ -2774,6 +2774,371 @@ module Google
         end
       end
       
+      # Request message for ConversationalSearchService.ConversationalSearch method.
+      class GoogleCloudRetailV2alphaConversationalSearchRequest
+        include Google::Apis::Core::Hashable
+      
+        # 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.
+        # Corresponds to the JSON property `branch`
+        # @return [String]
+        attr_accessor :branch
+      
+        # 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.
+        # Corresponds to the JSON property `conversationId`
+        # @return [String]
+        attr_accessor :conversation_id
+      
+        # This field specifies all conversational filtering related parameters addition
+        # to conversational retail search.
+        # Corresponds to the JSON property `conversationalFilteringSpec`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec]
+        attr_accessor :conversational_filtering_spec
+      
+        # 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"].
+        # Corresponds to the JSON property `pageCategories`
+        # @return [Array<String>]
+        attr_accessor :page_categories
+      
+        # Optional. Raw search query to be searched for. If this field is empty, the
+        # request is considered a category browsing request.
+        # Corresponds to the JSON property `query`
+        # @return [String]
+        attr_accessor :query
+      
+        # Search parameters.
+        # Corresponds to the JSON property `searchParams`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams]
+        attr_accessor :search_params
+      
+        # Information of an end user.
+        # Corresponds to the JSON property `userInfo`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
+        attr_accessor :user_info
+      
+        # 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.
+        # Corresponds to the JSON property `visitorId`
+        # @return [String]
+        attr_accessor :visitor_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @branch = args[:branch] if args.key?(:branch)
+          @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
+          @conversational_filtering_spec = args[:conversational_filtering_spec] if args.key?(:conversational_filtering_spec)
+          @page_categories = args[:page_categories] if args.key?(:page_categories)
+          @query = args[:query] if args.key?(:query)
+          @search_params = args[:search_params] if args.key?(:search_params)
+          @user_info = args[:user_info] if args.key?(:user_info)
+          @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
+        end
+      end
+      
+      # This field specifies all conversational filtering related parameters addition
+      # to conversational retail search.
+      class GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED
+        # if it's unset.
+        # Corresponds to the JSON property `conversationalFilteringMode`
+        # @return [String]
+        attr_accessor :conversational_filtering_mode
+      
+        # Optional. This field is deprecated. Please use ConversationalFilteringSpec.
+        # conversational_filtering_mode instead.
+        # Corresponds to the JSON property `enableConversationalFiltering`
+        # @return [Boolean]
+        attr_accessor :enable_conversational_filtering
+        alias_method :enable_conversational_filtering?, :enable_conversational_filtering
+      
+        # 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.
+        # Corresponds to the JSON property `userAnswer`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer]
+        attr_accessor :user_answer
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @conversational_filtering_mode = args[:conversational_filtering_mode] if args.key?(:conversational_filtering_mode)
+          @enable_conversational_filtering = args[:enable_conversational_filtering] if args.key?(:enable_conversational_filtering)
+          @user_answer = args[:user_answer] if args.key?(:user_answer)
+        end
+      end
+      
+      # Search parameters.
+      class GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams
+        include Google::Apis::Core::Hashable
+      
+        # Boost specification to boost certain items.
+        # Corresponds to the JSON property `boostSpec`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec]
+        attr_accessor :boost_spec
+      
+        # Optional. The canonical filter string to restrict search results. The syntax
+        # of the canonical filter string is the same as SearchRequest.canonical_filter.
+        # Corresponds to the JSON property `canonicalFilter`
+        # @return [String]
+        attr_accessor :canonical_filter
+      
+        # Optional. The filter string to restrict search results. The syntax of the
+        # filter string is the same as SearchRequest.filter.
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # Optional. The sort string to specify the sorting of search results. The syntax
+        # of the sort string is the same as SearchRequest.sort.
+        # Corresponds to the JSON property `sortBy`
+        # @return [String]
+        attr_accessor :sort_by
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
+          @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
+          @filter = args[:filter] if args.key?(:filter)
+          @sort_by = args[:sort_by] if args.key?(:sort_by)
+        end
+      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.
+      class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer
+        include Google::Apis::Core::Hashable
+      
+        # This field specifies the selected answers during the conversational search.
+        # Corresponds to the JSON property `selectedAnswer`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer]
+        attr_accessor :selected_answer
+      
+        # This field specifies the incremental input text from the user during the
+        # conversational search.
+        # Corresponds to the JSON property `textAnswer`
+        # @return [String]
+        attr_accessor :text_answer
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @selected_answer = args[:selected_answer] if args.key?(:selected_answer)
+          @text_answer = args[:text_answer] if args.key?(:text_answer)
+        end
+      end
+      
+      # This field specifies the selected answers during the conversational search.
+      class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer
+        include Google::Apis::Core::Hashable
+      
+        # Product attribute which structured by an attribute name and value. This
+        # structure is used in conversational search filters and answers. For example,
+        # if we have `name=color` and `value=red`, this means that the color is `red`.
+        # Corresponds to the JSON property `productAttributeValue`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue]
+        attr_accessor :product_attribute_value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
+        end
+      end
+      
+      # Response message for ConversationalSearchService.ConversationalSearch method.
+      class GoogleCloudRetailV2alphaConversationalSearchResponse
+        include Google::Apis::Core::Hashable
+      
+        # 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.
+        # Corresponds to the JSON property `conversationId`
+        # @return [String]
+        attr_accessor :conversation_id
+      
+        # This field specifies all related information that is needed on client side for
+        # UI rendering of conversational filtering search.
+        # Corresponds to the JSON property `conversationalFilteringResult`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult]
+        attr_accessor :conversational_filtering_result
+      
+        # 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.
+        # Corresponds to the JSON property `refinedSearch`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch>]
+        attr_accessor :refined_search
+      
+        # This field is deprecated. Please find the refinded_query from search response
+        # when using CONVERSATIONAL_FILTER_ONLY mode in ConversationalSearchResponse.
+        # refined_search instead. The rephrased query based on the user's query and the
+        # conversation history. It can be used to fetch the relevant search results.
+        # Corresponds to the JSON property `rephrasedQuery`
+        # @return [String]
+        attr_accessor :rephrased_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
+          @conversational_filtering_result = args[:conversational_filtering_result] if args.key?(:conversational_filtering_result)
+          @refined_search = args[:refined_search] if args.key?(:refined_search)
+          @rephrased_query = args[:rephrased_query] if args.key?(:rephrased_query)
+        end
+      end
+      
+      # This field specifies all related information that is needed on client side for
+      # UI rendering of conversational filtering search.
+      class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult
+        include Google::Apis::Core::Hashable
+      
+        # Additional filter that client side need to apply.
+        # Corresponds to the JSON property `additionalFilter`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter]
+        attr_accessor :additional_filter
+      
+        # The conversational followup question generated for Intent refinement.
+        # Corresponds to the JSON property `followupQuestion`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion]
+        attr_accessor :followup_question
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @additional_filter = args[:additional_filter] if args.key?(:additional_filter)
+          @followup_question = args[:followup_question] if args.key?(:followup_question)
+        end
+      end
+      
+      # Additional filter that client side need to apply.
+      class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
+        include Google::Apis::Core::Hashable
+      
+        # Product attribute which structured by an attribute name and value. This
+        # structure is used in conversational search filters and answers. For example,
+        # if we have `name=color` and `value=red`, this means that the color is `red`.
+        # Corresponds to the JSON property `productAttributeValue`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue]
+        attr_accessor :product_attribute_value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
+        end
+      end
+      
+      # The conversational followup question generated for Intent refinement.
+      class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion
+        include Google::Apis::Core::Hashable
+      
+        # The conversational followup question generated for Intent refinement.
+        # Corresponds to the JSON property `followupQuestion`
+        # @return [String]
+        attr_accessor :followup_question
+      
+        # The answer options provided to client for the follow-up question.
+        # Corresponds to the JSON property `suggestedAnswers`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer>]
+        attr_accessor :suggested_answers
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @followup_question = args[:followup_question] if args.key?(:followup_question)
+          @suggested_answers = args[:suggested_answers] if args.key?(:suggested_answers)
+        end
+      end
+      
+      # Suggested answers to the follow-up question.
+      class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer
+        include Google::Apis::Core::Hashable
+      
+        # Product attribute which structured by an attribute name and value. This
+        # structure is used in conversational search filters and answers. For example,
+        # if we have `name=color` and `value=red`, this means that the color is `red`.
+        # Corresponds to the JSON property `productAttributeValue`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue]
+        attr_accessor :product_attribute_value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
+        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.
+      class GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch
+        include Google::Apis::Core::Hashable
+      
+        # The query to be used for search.
+        # Corresponds to the JSON property `query`
+        # @return [String]
+        attr_accessor :query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @query = args[:query] if args.key?(:query)
+        end
+      end
+      
       # Common metadata related to the progress of the operations.
       class GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata
         include Google::Apis::Core::Hashable
@@ -7025,6 +7390,13 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec]
         attr_accessor :personalization_spec
       
+        # Optional. An id corresponding to a place, such as a store id or region id.
+        # When specified, we use the price from the local inventory with the matching
+        # product's LocalInventory.place_id for revenue optimization.
+        # Corresponds to the JSON property `placeId`
+        # @return [String]
+        attr_accessor :place_id
+      
         # Raw search query. If this field is empty, the request is considered a category
         # browsing request and returned results are based on filter and page_categories.
         # Corresponds to the JSON property `query`
@@ -7136,6 +7508,7 @@ module Google
           @page_size = args[:page_size] if args.key?(:page_size)
           @page_token = args[:page_token] if args.key?(:page_token)
           @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
+          @place_id = args[:place_id] if args.key?(:place_id)
           @query = args[:query] if args.key?(:query)
           @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
           @region_code = args[:region_code] if args.key?(:region_code)

data/lib/google/apis/retail_v2alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.110.0"
+      GEM_VERSION = "0.111.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.16.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250227"
+      REVISION = "20250314"
     end
   end
 end

data/lib/google/apis/retail_v2alpha/representations.rb

@@ -532,6 +532,72 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaConversationalSearchRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2441,6 +2507,115 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaConversationalSearchRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :branch, as: 'branch'
+          property :conversation_id, as: 'conversationId'
+          property :conversational_filtering_spec, as: 'conversationalFilteringSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec::Representation
+      
+          collection :page_categories, as: 'pageCategories'
+          property :query, as: 'query'
+          property :search_params, as: 'searchParams', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams::Representation
+      
+          property :user_info, as: 'userInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo::Representation
+      
+          property :visitor_id, as: 'visitorId'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :conversational_filtering_mode, as: 'conversationalFilteringMode'
+          property :enable_conversational_filtering, as: 'enableConversationalFiltering'
+          property :user_answer, as: 'userAnswer', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :boost_spec, as: 'boostSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec::Representation
+      
+          property :canonical_filter, as: 'canonicalFilter'
+          property :filter, as: 'filter'
+          property :sort_by, as: 'sortBy'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :selected_answer, as: 'selectedAnswer', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer::Representation
+      
+          property :text_answer, as: 'textAnswer'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :conversation_id, as: 'conversationId'
+          property :conversational_filtering_result, as: 'conversationalFilteringResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult::Representation
+      
+          collection :refined_search, as: 'refinedSearch', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch::Representation
+      
+          property :rephrased_query, as: 'rephrasedQuery'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :additional_filter, as: 'additionalFilter', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter::Representation
+      
+          property :followup_question, as: 'followupQuestion', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :followup_question, as: 'followupQuestion'
+          collection :suggested_answers, as: 'suggestedAnswers', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :query, as: 'query'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3527,6 +3702,7 @@ module Google
           property :page_token, as: 'pageToken'
           property :personalization_spec, as: 'personalizationSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec::Representation
       
+          property :place_id, as: 'placeId'
           property :query, as: 'query'
           property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec::Representation
       

data/lib/google/apis/retail_v2alpha/service.rb

@@ -341,11 +341,11 @@ module Google
         #   Required. The query used to generate suggestions. The maximum number of
         #   allowed characters is 255.
         # @param [String] visitor_id
-        #   Required field. 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. The field must be a UTF-8
-        #   encoded string with a length limit of 128 characters. Otherwise, an
+        #   Recommended field. 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. The field must be a
+        #   UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
         #   INVALID_ARGUMENT error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2465,6 +2465,44 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Performs a conversational search. This feature is only available for users who
+        # have Conversational Search enabled.
+        # @param [String] placement
+        #   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.
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest] google_cloud_retail_v2alpha_conversational_search_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def conversational_project_location_catalog_placement_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+placement}:conversationalSearch', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_conversational_search_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
+          command.params['placement'] = placement unless placement.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Makes a recommendation prediction.
         # @param [String] placement
         #   Required. Full resource name of the format: ``placement=projects/*/locations/
@@ -2587,6 +2625,44 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Performs a conversational search. This feature is only available for users who
+        # have Conversational Search enabled.
+        # @param [String] placement
+        #   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.
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest] google_cloud_retail_v2alpha_conversational_search_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def conversational_project_location_catalog_serving_config_search(placement, google_cloud_retail_v2alpha_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+placement}:conversationalSearch', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_conversational_search_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
+          command.params['placement'] = placement unless placement.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a
         # Catalog, otherwise a FAILED_PRECONDITION error is returned.
         # @param [String] parent

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.110.0
+  version: 0.111.0
 platform: ruby
 authors:
 - Google LLC
 bindir: bin
 cert_chain: []
-date: 2025-03-09 00:00:00.000000000 Z
+date: 2025-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -57,7 +57,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.110.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.111.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 rdoc_options: []
 require_paths: