google-apis-datastore_v1 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c12944d37d3dae0f4ac6ec15fc8e8523fa9ca71c8f6c8ed339e58fd167239a0f
-  data.tar.gz: 8ede35762e72497512a9839638fccbad62f378dba956ef35a238a2c25df03919
+  metadata.gz: 3948fb01c0e464276aa4b17a4344ea876f15d8a10ded3c0536bf4d8ba1d4ec85
+  data.tar.gz: 99caa454d159919e03b173038ee3c015a4f60ef14293f2f706aeaff166dbdb71
 SHA512:
-  metadata.gz: 881375be204138f9f33e3f5620c977f1dda5fb0710f22ab1aaafb13afc06ac29ed2fabe0ec73234b4a41106c0939f94576e7e5f8f7b0d06f941e921be37e03f2
-  data.tar.gz: e028c28a23891b73f5c07d562c96accaeaef298c00b064cc03c7972e512ae5a9b4a9b4e3c3fb0e59a654efd718f214d6683eb5248efeb3f736383be84abb7cc9
+  metadata.gz: 8f3317a8ac15315ad8eddb7d91202631446f5f7ebdf8729ad6c191bc64c68fe59412aad48442d7e053294babc56f2efedc3fede8cbdfbd9b95410967a8f67660
+  data.tar.gz: 70975e6ae0581b75dae441657dc8df94e40cd2aa646b1687e4473b45bc9f481a75afd70de80f75a8c8f28670bd4fd43ab03ca6ca97f977f56807ef11caf83a4f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-datastore_v1
 
+### v0.40.0 (2024-11-03)
+
+* Regenerated from discovery document revision 20241018
+
 ### v0.39.0 (2024-10-20)
 
 * Regenerated from discovery document revision 20241008

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

@@ -94,7 +94,9 @@ module Google
         # @return [Array<Google::Apis::DatastoreV1::Aggregation>]
         attr_accessor :aggregations
       
-        # A query for entities.
+        # A query for entities. The query stages are executed in the following order: 1.
+        # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+        # limit 7. find_nearest
         # Corresponds to the JSON property `nestedQuery`
         # @return [Google::Apis::DatastoreV1::Query]
         attr_accessor :nested_query
@@ -654,6 +656,66 @@ module Google
         end
       end
       
+      # Nearest Neighbors search config. The ordering provided by FindNearest
+      # supersedes the order_by stage. If multiple documents have the same vector
+      # distance, the returned document order is not guaranteed to be stable between
+      # queries.
+      class FindNearest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The Distance Measure to use, required.
+        # Corresponds to the JSON property `distanceMeasure`
+        # @return [String]
+        attr_accessor :distance_measure
+      
+        # Optional. Optional name of the field to output the result of the vector
+        # distance calculation. Must conform to entity property limitations.
+        # Corresponds to the JSON property `distanceResultProperty`
+        # @return [String]
+        attr_accessor :distance_result_property
+      
+        # Optional. Option to specify a threshold for which no less similar documents
+        # will be returned. The behavior of the specified `distance_measure` will affect
+        # the meaning of the distance threshold. Since DOT_PRODUCT distances increase
+        # when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN,
+        # COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE
+        # distance >= distance_threshold
+        # Corresponds to the JSON property `distanceThreshold`
+        # @return [Float]
+        attr_accessor :distance_threshold
+      
+        # Required. The number of nearest neighbors to return. Must be a positive
+        # integer of no more than 100.
+        # Corresponds to the JSON property `limit`
+        # @return [Fixnum]
+        attr_accessor :limit
+      
+        # A message that can hold any of the supported value types and associated
+        # metadata.
+        # Corresponds to the JSON property `queryVector`
+        # @return [Google::Apis::DatastoreV1::Value]
+        attr_accessor :query_vector
+      
+        # A reference to a property relative to the kind expressions.
+        # Corresponds to the JSON property `vectorProperty`
+        # @return [Google::Apis::DatastoreV1::PropertyReference]
+        attr_accessor :vector_property
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @distance_measure = args[:distance_measure] if args.key?(:distance_measure)
+          @distance_result_property = args[:distance_result_property] if args.key?(:distance_result_property)
+          @distance_threshold = args[:distance_threshold] if args.key?(:distance_threshold)
+          @limit = args[:limit] if args.key?(:limit)
+          @query_vector = args[:query_vector] if args.key?(:query_vector)
+          @vector_property = args[:vector_property] if args.key?(:vector_property)
+        end
+      end
+      
       # Metadata common to all Datastore Admin operations.
       class GoogleDatastoreAdminV1CommonMetadata
         include Google::Apis::Core::Hashable
@@ -2237,7 +2299,9 @@ module Google
         end
       end
       
-      # A query for entities.
+      # A query for entities. The query stages are executed in the following order: 1.
+      # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+      # limit 7. find_nearest
       class Query
         include Google::Apis::Core::Hashable
       
@@ -2263,6 +2327,14 @@ module Google
         # @return [Google::Apis::DatastoreV1::Filter]
         attr_accessor :filter
       
+        # Nearest Neighbors search config. The ordering provided by FindNearest
+        # supersedes the order_by stage. If multiple documents have the same vector
+        # distance, the returned document order is not guaranteed to be stable between
+        # queries.
+        # Corresponds to the JSON property `findNearest`
+        # @return [Google::Apis::DatastoreV1::FindNearest]
+        attr_accessor :find_nearest
+      
         # The kinds to query (if empty, returns entities of all kinds). Currently at
         # most 1 kind may be specified.
         # Corresponds to the JSON property `kind`
@@ -2308,6 +2380,7 @@ module Google
           @distinct_on = args[:distinct_on] if args.key?(:distinct_on)
           @end_cursor = args[:end_cursor] if args.key?(:end_cursor)
           @filter = args[:filter] if args.key?(:filter)
+          @find_nearest = args[:find_nearest] if args.key?(:find_nearest)
           @kind = args[:kind] if args.key?(:kind)
           @limit = args[:limit] if args.key?(:limit)
           @offset = args[:offset] if args.key?(:offset)
@@ -2698,7 +2771,9 @@ module Google
         # @return [Google::Apis::DatastoreV1::PropertyMask]
         attr_accessor :property_mask
       
-        # A query for entities.
+        # A query for entities. The query stages are executed in the following order: 1.
+        # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+        # limit 7. find_nearest
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1::Query]
         attr_accessor :query
@@ -2738,7 +2813,9 @@ module Google
         # @return [Google::Apis::DatastoreV1::ExplainMetrics]
         attr_accessor :explain_metrics
       
-        # A query for entities.
+        # A query for entities. The query stages are executed in the following order: 1.
+        # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+        # limit 7. find_nearest
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1::Query]
         attr_accessor :query

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DatastoreV1
       # Version of the google-apis-datastore_v1 gem
-      GEM_VERSION = "0.39.0"
+      GEM_VERSION = "0.40.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20241008"
+      REVISION = "20241018"
     end
   end
 end

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

@@ -148,6 +148,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class FindNearest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleDatastoreAdminV1CommonMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -702,6 +708,20 @@ module Google
         end
       end
       
+      class FindNearest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :distance_measure, as: 'distanceMeasure'
+          property :distance_result_property, as: 'distanceResultProperty'
+          property :distance_threshold, as: 'distanceThreshold'
+          property :limit, as: 'limit'
+          property :query_vector, as: 'queryVector', class: Google::Apis::DatastoreV1::Value, decorator: Google::Apis::DatastoreV1::Value::Representation
+      
+          property :vector_property, as: 'vectorProperty', class: Google::Apis::DatastoreV1::PropertyReference, decorator: Google::Apis::DatastoreV1::PropertyReference::Representation
+      
+        end
+      end
+      
       class GoogleDatastoreAdminV1CommonMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1153,6 +1173,8 @@ module Google
           property :end_cursor, :base64 => true, as: 'endCursor'
           property :filter, as: 'filter', class: Google::Apis::DatastoreV1::Filter, decorator: Google::Apis::DatastoreV1::Filter::Representation
       
+          property :find_nearest, as: 'findNearest', class: Google::Apis::DatastoreV1::FindNearest, decorator: Google::Apis::DatastoreV1::FindNearest::Representation
+      
           collection :kind, as: 'kind', class: Google::Apis::DatastoreV1::KindExpression, decorator: Google::Apis::DatastoreV1::KindExpression::Representation
       
           property :limit, as: 'limit'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-datastore_v1
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-11-03 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-datastore_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1/v0.39.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1/v0.40.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datastore_v1
 post_install_message: 
 rdoc_options: []