google-apis-discoveryengine_v1alpha 0.23.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ae48a74fb91e4016f1f14a099b5ab249637a087bb27d5d2cf8ac24bcf7365e0
-  data.tar.gz: 2b44374f6a13ff1b3535ff54ab6bef4efb510105354b98bd68f0f89efbcc58c9
+  metadata.gz: d6c5904082312a22c49253384956c44bbd873547708692d8504a5ec8b6d0a944
+  data.tar.gz: 8369decd22421913d96fa77323163203647b7618353cbf7b77b62d0026e4c5b6
 SHA512:
-  metadata.gz: f6382e55ea8efc6c7c6e061042c23a6aad15e8fbb9bd818788c64fe8d75733e19b65831bb88646a7effe3389024e4e920e456af03199ff343b8d59836aa48fa3
-  data.tar.gz: 8a2a5b4ddbf21154375bec7a712997c6a3ecc7ab5a07354f2a8318810d13fded4c49b540c689f1bca3d649bb682227bd6714216269b4635163b1ddbe3b8c13aa
+  metadata.gz: 2157566b775090673e848a5b9599fad7f51866d7d87c31a5c26c012c3e017f8af830ba9ea8bd5fe5e1ecf1c1b7009dba528d8103c99580299fe9efa570a38460
+  data.tar.gz: bfb04bde6314a2a90a81c8de6cc8f55c0bd7c4362d0891319e921b0e32219d7074d36c212bfaec7baf5aac1994b945e952a83896d1a6589e818e30eef7689270

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.25.0 (2023-10-22)
+
+* Regenerated from discovery document revision 20231016
+
+### v0.24.0 (2023-10-15)
+
+* Regenerated from discovery document revision 20231003
+
 ### v0.23.0 (2023-10-08)
 
 * Regenerated from discovery document revision 20230928

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

@@ -642,25 +642,6 @@ module Google
         end
       end
       
-      # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
-      class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
-        include Google::Apis::Core::Hashable
-      
-        # TargetSites created.
-        # Corresponds to the JSON property `targetSites`
-        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
-        attr_accessor :target_sites
-      
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-          @target_sites = args[:target_sites] if args.key?(:target_sites)
-        end
-      end
-      
       # BigQuery source import data from.
       class GoogleCloudDiscoveryengineV1alphaBigQuerySource
         include Google::Apis::Core::Hashable
@@ -2319,11 +2300,16 @@ module Google
         # characters. Currently, only filter expressions on the `filter_tags` attribute
         # is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags:
         # ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
-        # ANY("Green"))` If your filter blocks all results, the API will return generic
-        # (unfiltered) popular Documents. If you only want results strictly matching the
-        # filters, set `strictFiltering` to True in RecommendRequest.params to receive
-        # empty results instead. Note that the API will never return Documents with `
-        # storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
+        # ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params`
+        # field, then attribute-based expressions are expected instead of the above
+        # described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
+        # categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
+        # OR (categories: ANY("Movie")) If your filter blocks all results, the API will
+        # return generic (unfiltered) popular Documents. If you only want results
+        # strictly matching the filters, set `strictFiltering` to True in
+        # RecommendRequest.params to receive empty results instead. Note that the API
+        # will never return Documents with `storageStatus` of `EXPIRED` or `DELETED`
+        # regardless of filter choices.
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -2348,7 +2334,9 @@ module Google
         # recommendation results. * `diversityLevel`: String. Default empty. If set to
         # be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` *
         # `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-
-        # level control and adjusts recommendation results based on Document category.
+        # level control and adjusts recommendation results based on Document category. *
+        # `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `
+        # filter` field is interpreted according to the new, attribute-based syntax.
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
@@ -2824,7 +2812,14 @@ module Google
         # The filter syntax consists of an expression language for constructing a
         # predicate from one or more fields of the documents being filtered. Filter
         # expression is case-sensitive. If this field is unrecognizable, an `
-        # INVALID_ARGUMENT` is returned.
+        # INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
+        # mapping the LHS filter key to a key property defined in the Vertex AI Search
+        # backend -- this mapping is defined by the customer in their schema. For
+        # example a media customer might have a field 'name' in their schema. In this
+        # case the filter would look like this: filter --> name:'ANY("king kong")' For
+        # more information about filtering including syntax and filter operators, see [
+        # Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
+        # metadata)
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -2844,8 +2839,9 @@ module Google
       
         # The order in which documents are returned. Documents can be ordered by a field
         # in an Document object. Leave it unset if ordered by relevance. `order_by`
-        # expression is case-sensitive. If this field is unrecognizable, an `
-        # INVALID_ARGUMENT` is returned.
+        # expression is case-sensitive. For more information on ordering, see [Ordering](
+        # https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
+        # unrecognizable, an `INVALID_ARGUMENT` is returned.
         # Corresponds to the JSON property `orderBy`
         # @return [String]
         attr_accessor :order_by
@@ -4510,6 +4506,12 @@ module Google
         attr_accessor :llm_enabled
         alias_method :llm_enabled?, :llm_enabled
       
+        # Output only. Whether the customer accepted data use terms.
+        # Corresponds to the JSON property `minimumDataTermAccepted`
+        # @return [Boolean]
+        attr_accessor :minimum_data_term_accepted
+        alias_method :minimum_data_term_accepted?, :minimum_data_term_accepted
+      
         # Immutable. The full resource name of the widget config. Format: `projects/`
         # project`/locations/`location`/collections/`collection_id`/dataStores/`
         # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
@@ -4559,6 +4561,7 @@ module Google
           @facet_field = args[:facet_field] if args.key?(:facet_field)
           @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
           @llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
+          @minimum_data_term_accepted = args[:minimum_data_term_accepted] if args.key?(:minimum_data_term_accepted)
           @name = args[:name] if args.key?(:name)
           @result_display_type = args[:result_display_type] if args.key?(:result_display_type)
           @solution_type = args[:solution_type] if args.key?(:solution_type)

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha gem
-      GEM_VERSION = "0.23.0"
+      GEM_VERSION = "0.25.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230928"
+      REVISION = "20231016"
     end
   end
 end

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

@@ -136,12 +136,6 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
-        class Representation < Google::Apis::Core::JsonRepresentation; end
-      
-        include Google::Apis::Core::JsonObjectSupport
-      end
-      
       class GoogleCloudDiscoveryengineV1alphaBigQuerySource
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1001,14 +995,6 @@ module Google
         end
       end
       
-      class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
-        # @private
-        class Representation < Google::Apis::Core::JsonRepresentation
-          collection :target_sites, as: 'targetSites', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
-      
-        end
-      end
-      
       class GoogleCloudDiscoveryengineV1alphaBigQuerySource
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1977,6 +1963,7 @@ module Google
           hash :fields_ui_components_map, as: 'fieldsUiComponentsMap', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField::Representation
       
           property :llm_enabled, as: 'llmEnabled'
+          property :minimum_data_term_accepted, as: 'minimumDataTermAccepted'
           property :name, as: 'name'
           property :result_display_type, as: 'resultDisplayType'
           property :solution_type, as: 'solutionType'

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

@@ -1703,6 +1703,78 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Makes a recommendation, which requires a contextual user event.
+        # @param [String] serving_config
+        #   Required. Full resource name of the format: `projects/*/locations/global/
+        #   collections/*/dataStores/*/servingConfigs/*` Before you can request
+        #   recommendations from your model, you must create at least one serving config
+        #   for it.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
+        #
+        # @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 recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
+          command.params['servingConfig'] = serving_config unless serving_config.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Performs a search.
+        # @param [String] serving_config
+        #   Required. The resource name of the Search serving config, such as `projects/*/
+        #   locations/global/collections/default_collection/dataStores/default_data_store/
+        #   servingConfigs/default_serving_config`. This field is used to identify the
+        #   serving configuration name, set of models used to make the search.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
+        #
+        # @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 search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+servingConfig}:search', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
+          command.params['servingConfig'] = serving_config unless serving_config.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-08 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,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-discoveryengine_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.23.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.25.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message: 
 rdoc_options: []