google-apis-firestore_v1beta1 0.43.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3d784bd48a32193f19792d628f2b96a6b056bf47e86cbcbef652affddd07663
-  data.tar.gz: 7dc3cb8f119289fe97a0943b5536aebb7c53b26dd37738e27d21739a8d5fbe03
+  metadata.gz: e5c046f95213758ffb4a778fca0c3bf90b2ff783296262c10168271a79f9bf40
+  data.tar.gz: 2d1763d9e8b347595b6ff318183cd15dfbf54a704b3f61a7dfbd0b14c12c050f
 SHA512:
-  metadata.gz: dbd724a02057f76bb7da275e8476a1abe587cdfcf9223e8c795ee88eb291361f2d10b3f4cecf30d85732baad76edec42488ae872f14c65c984b540f73f0d85e2
-  data.tar.gz: 98eadfa34141b870d046df600e62b43014c9c376131c01a67cb8ab4d8494fa899f7402e952a647efccdebdd92920718ac6ca7f3fbc1be20114d0823cb6407199
+  metadata.gz: a7a3841819c0ec32b8e3ff3999394d2e8ec7eba1fc5aa52c8a5f697ceaf7b84597eaebe124b1b5cc344e19333930a4fd6875b00c0cc322cefda5c5291b71e3d4
+  data.tar.gz: 23cc2fb3a6f914948b0993cc25d1f13259da4a36644105de523a234e35f5f7e3d7a06f5f6950f4605116c03d9ee5f6b0387a94cad8c3b00456ad3691cd593a45

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1beta1
 
+### v0.45.0 (2024-12-02)
+
+* Regenerated from discovery document revision 20241018
+* Regenerated using generator version 0.15.1
+
+### v0.44.0 (2024-07-25)
+
+* Regenerated from discovery document revision 20240713
+
 ### v0.43.0 (2024-06-23)
 
 * Regenerated from discovery document revision 20240617

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

@@ -637,10 +637,7 @@ module Google
       # A Document has changed. May be the result of multiple writes, including
       # deletes, that ultimately resulted in a new value for the Document. Multiple
       # DocumentChange messages may be returned for the same logical change, if
-      # multiple targets are affected. For PipelineQueryTargets, `document` will be in
-      # the new pipeline format, For a Listen stream with both QueryTargets and
-      # PipelineQueryTargets present, if a document matches both types of queries,
-      # then a separate DocumentChange messages will be sent out one for each set.
+      # multiple targets are affected.
       class DocumentChange
         include Google::Apis::Core::Hashable
       
@@ -1100,7 +1097,10 @@ module Google
         end
       end
       
-      # Nearest Neighbors search config.
+      # 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
       
@@ -1109,6 +1109,22 @@ module Google
         # @return [String]
         attr_accessor :distance_measure
       
+        # Optional. Optional name of the field to output the result of the vector
+        # distance calculation. Must conform to document field name limitations.
+        # Corresponds to the JSON property `distanceResultField`
+        # @return [String]
+        attr_accessor :distance_result_field
+      
+        # 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 1000.
         # Corresponds to the JSON property `limit`
@@ -1132,6 +1148,8 @@ module Google
         # Update properties of this object
         def update!(**args)
           @distance_measure = args[:distance_measure] if args.key?(:distance_measure)
+          @distance_result_field = args[:distance_result_field] if args.key?(:distance_result_field)
+          @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_field = args[:vector_field] if args.key?(:vector_field)
@@ -1143,7 +1161,7 @@ module Google
       class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
         include Google::Apis::Core::Hashable
       
-        # The ids of the collection groups that are being deleted.
+        # The IDs of the collection groups that are being deleted.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
@@ -1154,7 +1172,7 @@ module Google
         # @return [String]
         attr_accessor :end_time
       
-        # Which namespace ids are being deleted.
+        # Which namespace IDs are being deleted.
         # Corresponds to the JSON property `namespaceIds`
         # @return [Array<String>]
         attr_accessor :namespace_ids
@@ -1909,10 +1927,7 @@ module Google
         # A Document has changed. May be the result of multiple writes, including
         # deletes, that ultimately resulted in a new value for the Document. Multiple
         # DocumentChange messages may be returned for the same logical change, if
-        # multiple targets are affected. For PipelineQueryTargets, `document` will be in
-        # the new pipeline format, For a Listen stream with both QueryTargets and
-        # PipelineQueryTargets present, if a document matches both types of queries,
-        # then a separate DocumentChange messages will be sent out one for each set.
+        # multiple targets are affected.
         # Corresponds to the JSON property `documentChange`
         # @return [Google::Apis::FirestoreV1beta1::DocumentChange]
         attr_accessor :document_change
@@ -2049,7 +2064,8 @@ module Google
         attr_accessor :read_time
       
         # A Firestore query. The query stages are executed in the following order: 1.
-        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
+        # find_nearest
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
         attr_accessor :structured_query
@@ -2187,7 +2203,8 @@ module Google
         attr_accessor :parent
       
         # A Firestore query. The query stages are executed in the following order: 1.
-        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
+        # find_nearest
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
         attr_accessor :structured_query
@@ -2380,7 +2397,8 @@ module Google
         attr_accessor :read_time
       
         # A Firestore query. The query stages are executed in the following order: 1.
-        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
+        # find_nearest
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
         attr_accessor :structured_query
@@ -2516,7 +2534,8 @@ module Google
         attr_accessor :aggregations
       
         # A Firestore query. The query stages are executed in the following order: 1.
-        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
+        # find_nearest
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
         attr_accessor :structured_query
@@ -2533,7 +2552,8 @@ module Google
       end
       
       # A Firestore query. The query stages are executed in the following order: 1.
-      # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
+      # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
+      # find_nearest
       class StructuredQuery
         include Google::Apis::Core::Hashable
       
@@ -2542,7 +2562,10 @@ module Google
         # @return [Google::Apis::FirestoreV1beta1::Cursor]
         attr_accessor :end_at
       
-        # Nearest Neighbors search config.
+        # 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::FirestoreV1beta1::FindNearest]
         attr_accessor :find_nearest

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirestoreV1beta1
       # Version of the google-apis-firestore_v1beta1 gem
-      GEM_VERSION = "0.43.0"
+      GEM_VERSION = "0.45.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.15.0"
+      GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240617"
+      REVISION = "20241018"
     end
   end
 end

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

@@ -864,6 +864,8 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :distance_measure, as: 'distanceMeasure'
+          property :distance_result_field, as: 'distanceResultField'
+          property :distance_threshold, as: 'distanceThreshold'
           property :limit, as: 'limit'
           property :query_vector, as: 'queryVector', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.43.0
+  version: 0.45.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-12-04 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-firestore_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.43.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.45.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Firestore API V1beta1