google-apis-retail_v2alpha 0.110.0 → 0.111.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f3b988e1ebc38cf7f58ffc56e996d0ac241b5971ad3ecb11084b5a4ca6dbe783
4
- data.tar.gz: 664ba03cdacf021156845e1780fe87d5f7677dcd61ac2c984724521caca2023e
3
+ metadata.gz: f29b8876dc83d7f24bd51f833280df154c4acf66c3d6e6fadcd21eff28d0fd83
4
+ data.tar.gz: 4b079181b676df8476555244f6cdd6771fee63af307758756e66682d49dd086a
5
5
  SHA512:
6
- metadata.gz: d551b67a4c3e54659ccd295548a774ad2c46edf665d922ff1f919199f7a093b0c6607499bab1b443fc0b0b30599c6b1134a25151653e65b17e5f7a2a7a55ed29
7
- data.tar.gz: ad2a1fed34cbf79a12b82ce8e7ba9dd7505aec6c4d85853d21e57bff0509e13e873db47620368cdf360671997b76f5ac443e5792bc9b0c7124f23f545ad8ad0e
6
+ metadata.gz: f64190008b0b80d93ea6a2d570648da296e3afae4666c902f249661b5e848afa4809d15f97e4323f5e84975990ec6c280ee93163ad5bb262f143b24df1d25bec
7
+ data.tar.gz: cf86755a13f0a069cf1571ec5b2f67bb93fd92d05f8488c958b1ff00ff935a56dbfc7f06d8f4d531b4e357e18dbab45ecf7e31fdbf921929f6f9a965c3122998
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.111.0 (2025-03-16)
4
+
5
+ * Regenerated from discovery document revision 20250314
6
+
3
7
  ### v0.110.0 (2025-03-09)
4
8
 
5
9
  * Regenerated from discovery document revision 20250227
@@ -2774,6 +2774,371 @@ module Google
2774
2774
  end
2775
2775
  end
2776
2776
 
2777
+ # Request message for ConversationalSearchService.ConversationalSearch method.
2778
+ class GoogleCloudRetailV2alphaConversationalSearchRequest
2779
+ include Google::Apis::Core::Hashable
2780
+
2781
+ # Required. The branch resource name, such as `projects/*/locations/global/
2782
+ # catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or
2783
+ # leave this field empty, to search products under the default branch.
2784
+ # Corresponds to the JSON property `branch`
2785
+ # @return [String]
2786
+ attr_accessor :branch
2787
+
2788
+ # Optional. This field specifies the conversation id, which maintains the state
2789
+ # of the conversation between client side and server side. Use the value from
2790
+ # the previous ConversationalSearchResponse.conversation_id. For the initial
2791
+ # request, this should be empty.
2792
+ # Corresponds to the JSON property `conversationId`
2793
+ # @return [String]
2794
+ attr_accessor :conversation_id
2795
+
2796
+ # This field specifies all conversational filtering related parameters addition
2797
+ # to conversational retail search.
2798
+ # Corresponds to the JSON property `conversationalFilteringSpec`
2799
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec]
2800
+ attr_accessor :conversational_filtering_spec
2801
+
2802
+ # Optional. The categories associated with a category page. Must be set for
2803
+ # category navigation queries to achieve good search quality. The format should
2804
+ # be the same as UserEvent.page_categories; To represent full path of category,
2805
+ # use '>' sign to separate different hierarchies. If '>' is part of the category
2806
+ # name, replace it with other character(s). Category pages include special pages
2807
+ # such as sales or promotions. For instance, a special sale page may have the
2808
+ # category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
2809
+ # Corresponds to the JSON property `pageCategories`
2810
+ # @return [Array<String>]
2811
+ attr_accessor :page_categories
2812
+
2813
+ # Optional. Raw search query to be searched for. If this field is empty, the
2814
+ # request is considered a category browsing request.
2815
+ # Corresponds to the JSON property `query`
2816
+ # @return [String]
2817
+ attr_accessor :query
2818
+
2819
+ # Search parameters.
2820
+ # Corresponds to the JSON property `searchParams`
2821
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams]
2822
+ attr_accessor :search_params
2823
+
2824
+ # Information of an end user.
2825
+ # Corresponds to the JSON property `userInfo`
2826
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
2827
+ attr_accessor :user_info
2828
+
2829
+ # Required. A unique identifier for tracking visitors. For example, this could
2830
+ # be implemented with an HTTP cookie, which should be able to uniquely identify
2831
+ # a visitor on a single device. This unique identifier should not change if the
2832
+ # visitor logs in or out of the website. This should be the same identifier as
2833
+ # UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length
2834
+ # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2835
+ # Corresponds to the JSON property `visitorId`
2836
+ # @return [String]
2837
+ attr_accessor :visitor_id
2838
+
2839
+ def initialize(**args)
2840
+ update!(**args)
2841
+ end
2842
+
2843
+ # Update properties of this object
2844
+ def update!(**args)
2845
+ @branch = args[:branch] if args.key?(:branch)
2846
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
2847
+ @conversational_filtering_spec = args[:conversational_filtering_spec] if args.key?(:conversational_filtering_spec)
2848
+ @page_categories = args[:page_categories] if args.key?(:page_categories)
2849
+ @query = args[:query] if args.key?(:query)
2850
+ @search_params = args[:search_params] if args.key?(:search_params)
2851
+ @user_info = args[:user_info] if args.key?(:user_info)
2852
+ @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
2853
+ end
2854
+ end
2855
+
2856
+ # This field specifies all conversational filtering related parameters addition
2857
+ # to conversational retail search.
2858
+ class GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec
2859
+ include Google::Apis::Core::Hashable
2860
+
2861
+ # Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED
2862
+ # if it's unset.
2863
+ # Corresponds to the JSON property `conversationalFilteringMode`
2864
+ # @return [String]
2865
+ attr_accessor :conversational_filtering_mode
2866
+
2867
+ # Optional. This field is deprecated. Please use ConversationalFilteringSpec.
2868
+ # conversational_filtering_mode instead.
2869
+ # Corresponds to the JSON property `enableConversationalFiltering`
2870
+ # @return [Boolean]
2871
+ attr_accessor :enable_conversational_filtering
2872
+ alias_method :enable_conversational_filtering?, :enable_conversational_filtering
2873
+
2874
+ # This field specifies the current user answer during the conversational
2875
+ # filtering search. This can be either user selected from suggested answers or
2876
+ # user input plain text.
2877
+ # Corresponds to the JSON property `userAnswer`
2878
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer]
2879
+ attr_accessor :user_answer
2880
+
2881
+ def initialize(**args)
2882
+ update!(**args)
2883
+ end
2884
+
2885
+ # Update properties of this object
2886
+ def update!(**args)
2887
+ @conversational_filtering_mode = args[:conversational_filtering_mode] if args.key?(:conversational_filtering_mode)
2888
+ @enable_conversational_filtering = args[:enable_conversational_filtering] if args.key?(:enable_conversational_filtering)
2889
+ @user_answer = args[:user_answer] if args.key?(:user_answer)
2890
+ end
2891
+ end
2892
+
2893
+ # Search parameters.
2894
+ class GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams
2895
+ include Google::Apis::Core::Hashable
2896
+
2897
+ # Boost specification to boost certain items.
2898
+ # Corresponds to the JSON property `boostSpec`
2899
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec]
2900
+ attr_accessor :boost_spec
2901
+
2902
+ # Optional. The canonical filter string to restrict search results. The syntax
2903
+ # of the canonical filter string is the same as SearchRequest.canonical_filter.
2904
+ # Corresponds to the JSON property `canonicalFilter`
2905
+ # @return [String]
2906
+ attr_accessor :canonical_filter
2907
+
2908
+ # Optional. The filter string to restrict search results. The syntax of the
2909
+ # filter string is the same as SearchRequest.filter.
2910
+ # Corresponds to the JSON property `filter`
2911
+ # @return [String]
2912
+ attr_accessor :filter
2913
+
2914
+ # Optional. The sort string to specify the sorting of search results. The syntax
2915
+ # of the sort string is the same as SearchRequest.sort.
2916
+ # Corresponds to the JSON property `sortBy`
2917
+ # @return [String]
2918
+ attr_accessor :sort_by
2919
+
2920
+ def initialize(**args)
2921
+ update!(**args)
2922
+ end
2923
+
2924
+ # Update properties of this object
2925
+ def update!(**args)
2926
+ @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
2927
+ @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
2928
+ @filter = args[:filter] if args.key?(:filter)
2929
+ @sort_by = args[:sort_by] if args.key?(:sort_by)
2930
+ end
2931
+ end
2932
+
2933
+ # This field specifies the current user answer during the conversational
2934
+ # filtering search. This can be either user selected from suggested answers or
2935
+ # user input plain text.
2936
+ class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer
2937
+ include Google::Apis::Core::Hashable
2938
+
2939
+ # This field specifies the selected answers during the conversational search.
2940
+ # Corresponds to the JSON property `selectedAnswer`
2941
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer]
2942
+ attr_accessor :selected_answer
2943
+
2944
+ # This field specifies the incremental input text from the user during the
2945
+ # conversational search.
2946
+ # Corresponds to the JSON property `textAnswer`
2947
+ # @return [String]
2948
+ attr_accessor :text_answer
2949
+
2950
+ def initialize(**args)
2951
+ update!(**args)
2952
+ end
2953
+
2954
+ # Update properties of this object
2955
+ def update!(**args)
2956
+ @selected_answer = args[:selected_answer] if args.key?(:selected_answer)
2957
+ @text_answer = args[:text_answer] if args.key?(:text_answer)
2958
+ end
2959
+ end
2960
+
2961
+ # This field specifies the selected answers during the conversational search.
2962
+ class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer
2963
+ include Google::Apis::Core::Hashable
2964
+
2965
+ # Product attribute which structured by an attribute name and value. This
2966
+ # structure is used in conversational search filters and answers. For example,
2967
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
2968
+ # Corresponds to the JSON property `productAttributeValue`
2969
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue]
2970
+ attr_accessor :product_attribute_value
2971
+
2972
+ def initialize(**args)
2973
+ update!(**args)
2974
+ end
2975
+
2976
+ # Update properties of this object
2977
+ def update!(**args)
2978
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
2979
+ end
2980
+ end
2981
+
2982
+ # Response message for ConversationalSearchService.ConversationalSearch method.
2983
+ class GoogleCloudRetailV2alphaConversationalSearchResponse
2984
+ include Google::Apis::Core::Hashable
2985
+
2986
+ # Conversation UUID. This field will be stored in client side storage to
2987
+ # maintain the conversation session with server and will be used for next search
2988
+ # request's ConversationalSearchRequest.conversation_id to restore conversation
2989
+ # state in server.
2990
+ # Corresponds to the JSON property `conversationId`
2991
+ # @return [String]
2992
+ attr_accessor :conversation_id
2993
+
2994
+ # This field specifies all related information that is needed on client side for
2995
+ # UI rendering of conversational filtering search.
2996
+ # Corresponds to the JSON property `conversationalFilteringResult`
2997
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult]
2998
+ attr_accessor :conversational_filtering_result
2999
+
3000
+ # The proposed refined search queries. They can be used to fetch the relevant
3001
+ # search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query
3002
+ # from search response will be populated here.
3003
+ # Corresponds to the JSON property `refinedSearch`
3004
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch>]
3005
+ attr_accessor :refined_search
3006
+
3007
+ # This field is deprecated. Please find the refinded_query from search response
3008
+ # when using CONVERSATIONAL_FILTER_ONLY mode in ConversationalSearchResponse.
3009
+ # refined_search instead. The rephrased query based on the user's query and the
3010
+ # conversation history. It can be used to fetch the relevant search results.
3011
+ # Corresponds to the JSON property `rephrasedQuery`
3012
+ # @return [String]
3013
+ attr_accessor :rephrased_query
3014
+
3015
+ def initialize(**args)
3016
+ update!(**args)
3017
+ end
3018
+
3019
+ # Update properties of this object
3020
+ def update!(**args)
3021
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
3022
+ @conversational_filtering_result = args[:conversational_filtering_result] if args.key?(:conversational_filtering_result)
3023
+ @refined_search = args[:refined_search] if args.key?(:refined_search)
3024
+ @rephrased_query = args[:rephrased_query] if args.key?(:rephrased_query)
3025
+ end
3026
+ end
3027
+
3028
+ # This field specifies all related information that is needed on client side for
3029
+ # UI rendering of conversational filtering search.
3030
+ class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult
3031
+ include Google::Apis::Core::Hashable
3032
+
3033
+ # Additional filter that client side need to apply.
3034
+ # Corresponds to the JSON property `additionalFilter`
3035
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter]
3036
+ attr_accessor :additional_filter
3037
+
3038
+ # The conversational followup question generated for Intent refinement.
3039
+ # Corresponds to the JSON property `followupQuestion`
3040
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion]
3041
+ attr_accessor :followup_question
3042
+
3043
+ def initialize(**args)
3044
+ update!(**args)
3045
+ end
3046
+
3047
+ # Update properties of this object
3048
+ def update!(**args)
3049
+ @additional_filter = args[:additional_filter] if args.key?(:additional_filter)
3050
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
3051
+ end
3052
+ end
3053
+
3054
+ # Additional filter that client side need to apply.
3055
+ class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
3056
+ include Google::Apis::Core::Hashable
3057
+
3058
+ # Product attribute which structured by an attribute name and value. This
3059
+ # structure is used in conversational search filters and answers. For example,
3060
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
3061
+ # Corresponds to the JSON property `productAttributeValue`
3062
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue]
3063
+ attr_accessor :product_attribute_value
3064
+
3065
+ def initialize(**args)
3066
+ update!(**args)
3067
+ end
3068
+
3069
+ # Update properties of this object
3070
+ def update!(**args)
3071
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
3072
+ end
3073
+ end
3074
+
3075
+ # The conversational followup question generated for Intent refinement.
3076
+ class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion
3077
+ include Google::Apis::Core::Hashable
3078
+
3079
+ # The conversational followup question generated for Intent refinement.
3080
+ # Corresponds to the JSON property `followupQuestion`
3081
+ # @return [String]
3082
+ attr_accessor :followup_question
3083
+
3084
+ # The answer options provided to client for the follow-up question.
3085
+ # Corresponds to the JSON property `suggestedAnswers`
3086
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer>]
3087
+ attr_accessor :suggested_answers
3088
+
3089
+ def initialize(**args)
3090
+ update!(**args)
3091
+ end
3092
+
3093
+ # Update properties of this object
3094
+ def update!(**args)
3095
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
3096
+ @suggested_answers = args[:suggested_answers] if args.key?(:suggested_answers)
3097
+ end
3098
+ end
3099
+
3100
+ # Suggested answers to the follow-up question.
3101
+ class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer
3102
+ include Google::Apis::Core::Hashable
3103
+
3104
+ # Product attribute which structured by an attribute name and value. This
3105
+ # structure is used in conversational search filters and answers. For example,
3106
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
3107
+ # Corresponds to the JSON property `productAttributeValue`
3108
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue]
3109
+ attr_accessor :product_attribute_value
3110
+
3111
+ def initialize(**args)
3112
+ update!(**args)
3113
+ end
3114
+
3115
+ # Update properties of this object
3116
+ def update!(**args)
3117
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
3118
+ end
3119
+ end
3120
+
3121
+ # The proposed refined search for intent-refinement/bundled shopping
3122
+ # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query
3123
+ # from search response will be populated here.
3124
+ class GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch
3125
+ include Google::Apis::Core::Hashable
3126
+
3127
+ # The query to be used for search.
3128
+ # Corresponds to the JSON property `query`
3129
+ # @return [String]
3130
+ attr_accessor :query
3131
+
3132
+ def initialize(**args)
3133
+ update!(**args)
3134
+ end
3135
+
3136
+ # Update properties of this object
3137
+ def update!(**args)
3138
+ @query = args[:query] if args.key?(:query)
3139
+ end
3140
+ end
3141
+
2777
3142
  # Common metadata related to the progress of the operations.
2778
3143
  class GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata
2779
3144
  include Google::Apis::Core::Hashable
@@ -7025,6 +7390,13 @@ module Google
7025
7390
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec]
7026
7391
  attr_accessor :personalization_spec
7027
7392
 
7393
+ # Optional. An id corresponding to a place, such as a store id or region id.
7394
+ # When specified, we use the price from the local inventory with the matching
7395
+ # product's LocalInventory.place_id for revenue optimization.
7396
+ # Corresponds to the JSON property `placeId`
7397
+ # @return [String]
7398
+ attr_accessor :place_id
7399
+
7028
7400
  # Raw search query. If this field is empty, the request is considered a category
7029
7401
  # browsing request and returned results are based on filter and page_categories.
7030
7402
  # Corresponds to the JSON property `query`
@@ -7136,6 +7508,7 @@ module Google
7136
7508
  @page_size = args[:page_size] if args.key?(:page_size)
7137
7509
  @page_token = args[:page_token] if args.key?(:page_token)
7138
7510
  @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
7511
+ @place_id = args[:place_id] if args.key?(:place_id)
7139
7512
  @query = args[:query] if args.key?(:query)
7140
7513
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
7141
7514
  @region_code = args[:region_code] if args.key?(:region_code)
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.110.0"
19
+ GEM_VERSION = "0.111.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.16.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250227"
25
+ REVISION = "20250314"
26
26
  end
27
27
  end
28
28
  end
@@ -532,6 +532,72 @@ module Google
532
532
  include Google::Apis::Core::JsonObjectSupport
533
533
  end
534
534
 
535
+ class GoogleCloudRetailV2alphaConversationalSearchRequest
536
+ class Representation < Google::Apis::Core::JsonRepresentation; end
537
+
538
+ include Google::Apis::Core::JsonObjectSupport
539
+ end
540
+
541
+ class GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec
542
+ class Representation < Google::Apis::Core::JsonRepresentation; end
543
+
544
+ include Google::Apis::Core::JsonObjectSupport
545
+ end
546
+
547
+ class GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams
548
+ class Representation < Google::Apis::Core::JsonRepresentation; end
549
+
550
+ include Google::Apis::Core::JsonObjectSupport
551
+ end
552
+
553
+ class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer
554
+ class Representation < Google::Apis::Core::JsonRepresentation; end
555
+
556
+ include Google::Apis::Core::JsonObjectSupport
557
+ end
558
+
559
+ class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer
560
+ class Representation < Google::Apis::Core::JsonRepresentation; end
561
+
562
+ include Google::Apis::Core::JsonObjectSupport
563
+ end
564
+
565
+ class GoogleCloudRetailV2alphaConversationalSearchResponse
566
+ class Representation < Google::Apis::Core::JsonRepresentation; end
567
+
568
+ include Google::Apis::Core::JsonObjectSupport
569
+ end
570
+
571
+ class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult
572
+ class Representation < Google::Apis::Core::JsonRepresentation; end
573
+
574
+ include Google::Apis::Core::JsonObjectSupport
575
+ end
576
+
577
+ class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
578
+ class Representation < Google::Apis::Core::JsonRepresentation; end
579
+
580
+ include Google::Apis::Core::JsonObjectSupport
581
+ end
582
+
583
+ class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion
584
+ class Representation < Google::Apis::Core::JsonRepresentation; end
585
+
586
+ include Google::Apis::Core::JsonObjectSupport
587
+ end
588
+
589
+ class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer
590
+ class Representation < Google::Apis::Core::JsonRepresentation; end
591
+
592
+ include Google::Apis::Core::JsonObjectSupport
593
+ end
594
+
595
+ class GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch
596
+ class Representation < Google::Apis::Core::JsonRepresentation; end
597
+
598
+ include Google::Apis::Core::JsonObjectSupport
599
+ end
600
+
535
601
  class GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata
536
602
  class Representation < Google::Apis::Core::JsonRepresentation; end
537
603
 
@@ -2441,6 +2507,115 @@ module Google
2441
2507
  end
2442
2508
  end
2443
2509
 
2510
+ class GoogleCloudRetailV2alphaConversationalSearchRequest
2511
+ # @private
2512
+ class Representation < Google::Apis::Core::JsonRepresentation
2513
+ property :branch, as: 'branch'
2514
+ property :conversation_id, as: 'conversationId'
2515
+ property :conversational_filtering_spec, as: 'conversationalFilteringSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec::Representation
2516
+
2517
+ collection :page_categories, as: 'pageCategories'
2518
+ property :query, as: 'query'
2519
+ property :search_params, as: 'searchParams', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams::Representation
2520
+
2521
+ property :user_info, as: 'userInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo::Representation
2522
+
2523
+ property :visitor_id, as: 'visitorId'
2524
+ end
2525
+ end
2526
+
2527
+ class GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec
2528
+ # @private
2529
+ class Representation < Google::Apis::Core::JsonRepresentation
2530
+ property :conversational_filtering_mode, as: 'conversationalFilteringMode'
2531
+ property :enable_conversational_filtering, as: 'enableConversationalFiltering'
2532
+ property :user_answer, as: 'userAnswer', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer::Representation
2533
+
2534
+ end
2535
+ end
2536
+
2537
+ class GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams
2538
+ # @private
2539
+ class Representation < Google::Apis::Core::JsonRepresentation
2540
+ property :boost_spec, as: 'boostSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec::Representation
2541
+
2542
+ property :canonical_filter, as: 'canonicalFilter'
2543
+ property :filter, as: 'filter'
2544
+ property :sort_by, as: 'sortBy'
2545
+ end
2546
+ end
2547
+
2548
+ class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer
2549
+ # @private
2550
+ class Representation < Google::Apis::Core::JsonRepresentation
2551
+ property :selected_answer, as: 'selectedAnswer', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer::Representation
2552
+
2553
+ property :text_answer, as: 'textAnswer'
2554
+ end
2555
+ end
2556
+
2557
+ class GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer
2558
+ # @private
2559
+ class Representation < Google::Apis::Core::JsonRepresentation
2560
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue::Representation
2561
+
2562
+ end
2563
+ end
2564
+
2565
+ class GoogleCloudRetailV2alphaConversationalSearchResponse
2566
+ # @private
2567
+ class Representation < Google::Apis::Core::JsonRepresentation
2568
+ property :conversation_id, as: 'conversationId'
2569
+ property :conversational_filtering_result, as: 'conversationalFilteringResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult::Representation
2570
+
2571
+ collection :refined_search, as: 'refinedSearch', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch::Representation
2572
+
2573
+ property :rephrased_query, as: 'rephrasedQuery'
2574
+ end
2575
+ end
2576
+
2577
+ class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult
2578
+ # @private
2579
+ class Representation < Google::Apis::Core::JsonRepresentation
2580
+ property :additional_filter, as: 'additionalFilter', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter::Representation
2581
+
2582
+ property :followup_question, as: 'followupQuestion', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion::Representation
2583
+
2584
+ end
2585
+ end
2586
+
2587
+ class GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
2588
+ # @private
2589
+ class Representation < Google::Apis::Core::JsonRepresentation
2590
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue::Representation
2591
+
2592
+ end
2593
+ end
2594
+
2595
+ class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion
2596
+ # @private
2597
+ class Representation < Google::Apis::Core::JsonRepresentation
2598
+ property :followup_question, as: 'followupQuestion'
2599
+ collection :suggested_answers, as: 'suggestedAnswers', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer::Representation
2600
+
2601
+ end
2602
+ end
2603
+
2604
+ class GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer
2605
+ # @private
2606
+ class Representation < Google::Apis::Core::JsonRepresentation
2607
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductAttributeValue::Representation
2608
+
2609
+ end
2610
+ end
2611
+
2612
+ class GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch
2613
+ # @private
2614
+ class Representation < Google::Apis::Core::JsonRepresentation
2615
+ property :query, as: 'query'
2616
+ end
2617
+ end
2618
+
2444
2619
  class GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata
2445
2620
  # @private
2446
2621
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3527,6 +3702,7 @@ module Google
3527
3702
  property :page_token, as: 'pageToken'
3528
3703
  property :personalization_spec, as: 'personalizationSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec::Representation
3529
3704
 
3705
+ property :place_id, as: 'placeId'
3530
3706
  property :query, as: 'query'
3531
3707
  property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec::Representation
3532
3708
 
@@ -341,11 +341,11 @@ module Google
341
341
  # Required. The query used to generate suggestions. The maximum number of
342
342
  # allowed characters is 255.
343
343
  # @param [String] visitor_id
344
- # Required field. A unique identifier for tracking visitors. For example, this
345
- # could be implemented with an HTTP cookie, which should be able to uniquely
346
- # identify a visitor on a single device. This unique identifier should not
347
- # change if the visitor logs in or out of the website. The field must be a UTF-8
348
- # encoded string with a length limit of 128 characters. Otherwise, an
344
+ # Recommended field. A unique identifier for tracking visitors. For example,
345
+ # this could be implemented with an HTTP cookie, which should be able to
346
+ # uniquely identify a visitor on a single device. This unique identifier should
347
+ # not change if the visitor logs in or out of the website. The field must be a
348
+ # UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
349
349
  # INVALID_ARGUMENT error is returned.
350
350
  # @param [String] fields
351
351
  # Selector specifying which fields to include in a partial response.
@@ -2465,6 +2465,44 @@ module Google
2465
2465
  execute_or_queue_command(command, &block)
2466
2466
  end
2467
2467
 
2468
+ # Performs a conversational search. This feature is only available for users who
2469
+ # have Conversational Search enabled.
2470
+ # @param [String] placement
2471
+ # Required. The resource name of the search engine placement, such as `projects/*
2472
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
2473
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
2474
+ # default_serving_config` This field is used to identify the serving config name
2475
+ # and the set of models that will be used to make the search.
2476
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest] google_cloud_retail_v2alpha_conversational_search_request_object
2477
+ # @param [String] fields
2478
+ # Selector specifying which fields to include in a partial response.
2479
+ # @param [String] quota_user
2480
+ # Available to use for quota purposes for server-side applications. Can be any
2481
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2482
+ # @param [Google::Apis::RequestOptions] options
2483
+ # Request-specific options
2484
+ #
2485
+ # @yield [result, err] Result & error if block supplied
2486
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse] parsed result object
2487
+ # @yieldparam err [StandardError] error object if request failed
2488
+ #
2489
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse]
2490
+ #
2491
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2492
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2493
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2494
+ 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)
2495
+ command = make_simple_command(:post, 'v2alpha/{+placement}:conversationalSearch', options)
2496
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest::Representation
2497
+ command.request_object = google_cloud_retail_v2alpha_conversational_search_request_object
2498
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse::Representation
2499
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
2500
+ command.params['placement'] = placement unless placement.nil?
2501
+ command.query['fields'] = fields unless fields.nil?
2502
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2503
+ execute_or_queue_command(command, &block)
2504
+ end
2505
+
2468
2506
  # Makes a recommendation prediction.
2469
2507
  # @param [String] placement
2470
2508
  # Required. Full resource name of the format: ``placement=projects/*/locations/
@@ -2587,6 +2625,44 @@ module Google
2587
2625
  execute_or_queue_command(command, &block)
2588
2626
  end
2589
2627
 
2628
+ # Performs a conversational search. This feature is only available for users who
2629
+ # have Conversational Search enabled.
2630
+ # @param [String] placement
2631
+ # Required. The resource name of the search engine placement, such as `projects/*
2632
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
2633
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
2634
+ # default_serving_config` This field is used to identify the serving config name
2635
+ # and the set of models that will be used to make the search.
2636
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest] google_cloud_retail_v2alpha_conversational_search_request_object
2637
+ # @param [String] fields
2638
+ # Selector specifying which fields to include in a partial response.
2639
+ # @param [String] quota_user
2640
+ # Available to use for quota purposes for server-side applications. Can be any
2641
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2642
+ # @param [Google::Apis::RequestOptions] options
2643
+ # Request-specific options
2644
+ #
2645
+ # @yield [result, err] Result & error if block supplied
2646
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse] parsed result object
2647
+ # @yieldparam err [StandardError] error object if request failed
2648
+ #
2649
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse]
2650
+ #
2651
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2652
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2653
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2654
+ 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)
2655
+ command = make_simple_command(:post, 'v2alpha/{+placement}:conversationalSearch', options)
2656
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequest::Representation
2657
+ command.request_object = google_cloud_retail_v2alpha_conversational_search_request_object
2658
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse::Representation
2659
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponse
2660
+ command.params['placement'] = placement unless placement.nil?
2661
+ command.query['fields'] = fields unless fields.nil?
2662
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2663
+ execute_or_queue_command(command, &block)
2664
+ end
2665
+
2590
2666
  # Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a
2591
2667
  # Catalog, otherwise a FAILED_PRECONDITION error is returned.
2592
2668
  # @param [String] parent
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.110.0
4
+ version: 0.111.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-03-09 00:00:00.000000000 Z
10
+ date: 2025-03-16 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: google-apis-core
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.110.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.111.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
62
62
  rdoc_options: []
63
63
  require_paths: