google-cloud-firestore-v1 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/firestore/v1/version.rb +1 -1
- data/lib/google/firestore/v1/document_pb.rb +2 -1
- data/lib/google/firestore/v1/query_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -10
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/firestore/v1/document.rb +1 -1
- data/proto_docs/google/firestore/v1/query.rb +31 -10
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3d41dea0700c74721a8023d9e6490cc5e272a7ca854372eff1980e9b0c90ce3a
|
|
4
|
+
data.tar.gz: f98b796548087d68173c39fe5e8bfbb3975a828690aab4883ef37f842ea22932
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9ba23b97bb3ef42333a48852a61a6ed284a43bbeb07784b0d67d888e532af1ef9e6706411f2918b97598c89a1b3f5c11ccfd0f8a64e8c0516897f566c31e9def
|
|
7
|
+
data.tar.gz: 61feb0cb438b8327cd74947dd0f187a3a340a66efb6c0adea6553f9c87f78dbc6fa8d859644a434bd1faae666a68b47f1b5f7463f487ca4e7e2e586acb7bbe2c
|
|
@@ -4,12 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
require 'google/protobuf'
|
|
6
6
|
|
|
7
|
+
require 'google/api/field_behavior_pb'
|
|
7
8
|
require 'google/protobuf/struct_pb'
|
|
8
9
|
require 'google/protobuf/timestamp_pb'
|
|
9
10
|
require 'google/type/latlng_pb'
|
|
10
11
|
|
|
11
12
|
|
|
12
|
-
descriptor_data = "\n\"google/firestore/v1/document.proto\x12\x13google.firestore.v1\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x18google/type/latlng.proto\"\x80\x02\n\x08\x44ocument\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x39\n\x06\x66ields\x18\x02 \x03(\x0b\x32).google.firestore.v1.Document.FieldsEntry\x12/\n\x0b\x63reate_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x1aI\n\x0b\x46ieldsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.Value:\x02\x38\x01\"\xae\x03\n\x05Value\x12\x30\n\nnull_value\x18\x0b \x01(\x0e\x32\x1a.google.protobuf.NullValueH\x00\x12\x17\n\rboolean_value\x18\x01 \x01(\x08H\x00\x12\x17\n\rinteger_value\x18\x02 \x01(\x03H\x00\x12\x16\n\x0c\x64ouble_value\x18\x03 \x01(\x01H\x00\x12\x35\n\x0ftimestamp_value\x18\n \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x12\x16\n\x0cstring_value\x18\x11 \x01(\tH\x00\x12\x15\n\x0b\x62ytes_value\x18\x12 \x01(\x0cH\x00\x12\x19\n\x0freference_value\x18\x05 \x01(\tH\x00\x12.\n\x0fgeo_point_value\x18\x08 \x01(\x0b\x32\x13.google.type.LatLngH\x00\x12\x36\n\x0b\x61rray_value\x18\t \x01(\x0b\x32\x1f.google.firestore.v1.ArrayValueH\x00\x12\x32\n\tmap_value\x18\x06 \x01(\x0b\x32\x1d.google.firestore.v1.MapValueH\x00\x42\x0c\n\nvalue_type\"8\n\nArrayValue\x12*\n\x06values\x18\x01 \x03(\x0b\x32\x1a.google.firestore.v1.Value\"\x90\x01\n\x08MapValue\x12\x39\n\x06\x66ields\x18\x01 \x03(\x0b\x32).google.firestore.v1.MapValue.FieldsEntry\x1aI\n\x0b\x46ieldsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.Value:\x02\x38\x01\x42\xc5\x01\n\x17\x63om.google.firestore.v1B\rDocumentProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
|
|
13
|
+
descriptor_data = "\n\"google/firestore/v1/document.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x18google/type/latlng.proto\"\x80\x02\n\x08\x44ocument\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x39\n\x06\x66ields\x18\x02 \x03(\x0b\x32).google.firestore.v1.Document.FieldsEntry\x12/\n\x0b\x63reate_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x1aI\n\x0b\x46ieldsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.Value:\x02\x38\x01\"\xae\x03\n\x05Value\x12\x30\n\nnull_value\x18\x0b \x01(\x0e\x32\x1a.google.protobuf.NullValueH\x00\x12\x17\n\rboolean_value\x18\x01 \x01(\x08H\x00\x12\x17\n\rinteger_value\x18\x02 \x01(\x03H\x00\x12\x16\n\x0c\x64ouble_value\x18\x03 \x01(\x01H\x00\x12\x35\n\x0ftimestamp_value\x18\n \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x12\x16\n\x0cstring_value\x18\x11 \x01(\tH\x00\x12\x15\n\x0b\x62ytes_value\x18\x12 \x01(\x0cH\x00\x12\x19\n\x0freference_value\x18\x05 \x01(\tH\x00\x12.\n\x0fgeo_point_value\x18\x08 \x01(\x0b\x32\x13.google.type.LatLngH\x00\x12\x36\n\x0b\x61rray_value\x18\t \x01(\x0b\x32\x1f.google.firestore.v1.ArrayValueH\x00\x12\x32\n\tmap_value\x18\x06 \x01(\x0b\x32\x1d.google.firestore.v1.MapValueH\x00\x42\x0c\n\nvalue_type\"8\n\nArrayValue\x12*\n\x06values\x18\x01 \x03(\x0b\x32\x1a.google.firestore.v1.Value\"\x90\x01\n\x08MapValue\x12\x39\n\x06\x66ields\x18\x01 \x03(\x0b\x32).google.firestore.v1.MapValue.FieldsEntry\x1aI\n\x0b\x46ieldsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.Value:\x02\x38\x01\x42\xc5\x01\n\x17\x63om.google.firestore.v1B\rDocumentProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
|
|
13
14
|
|
|
14
15
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
15
16
|
|
|
@@ -9,7 +9,7 @@ require 'google/firestore/v1/document_pb'
|
|
|
9
9
|
require 'google/protobuf/wrappers_pb'
|
|
10
10
|
|
|
11
11
|
|
|
12
|
-
descriptor_data = "\n\x1fgoogle/firestore/v1/query.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\"google/firestore/v1/document.proto\x1a\x1egoogle/protobuf/wrappers.proto\"\
|
|
12
|
+
descriptor_data = "\n\x1fgoogle/firestore/v1/query.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\"google/firestore/v1/document.proto\x1a\x1egoogle/protobuf/wrappers.proto\"\xf8\x13\n\x0fStructuredQuery\x12?\n\x06select\x18\x01 \x01(\x0b\x32/.google.firestore.v1.StructuredQuery.Projection\x12\x45\n\x04\x66rom\x18\x02 \x03(\x0b\x32\x37.google.firestore.v1.StructuredQuery.CollectionSelector\x12:\n\x05where\x18\x03 \x01(\x0b\x32+.google.firestore.v1.StructuredQuery.Filter\x12<\n\x08order_by\x18\x04 \x03(\x0b\x32*.google.firestore.v1.StructuredQuery.Order\x12-\n\x08start_at\x18\x07 \x01(\x0b\x32\x1b.google.firestore.v1.Cursor\x12+\n\x06\x65nd_at\x18\x08 \x01(\x0b\x32\x1b.google.firestore.v1.Cursor\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12*\n\x05limit\x18\x05 \x01(\x0b\x32\x1b.google.protobuf.Int32Value\x12K\n\x0c\x66ind_nearest\x18\t \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.FindNearestB\x03\xe0\x41\x01\x1a\x44\n\x12\x43ollectionSelector\x12\x15\n\rcollection_id\x18\x02 \x01(\t\x12\x17\n\x0f\x61ll_descendants\x18\x03 \x01(\x08\x1a\xfd\x01\n\x06\x46ilter\x12P\n\x10\x63omposite_filter\x18\x01 \x01(\x0b\x32\x34.google.firestore.v1.StructuredQuery.CompositeFilterH\x00\x12H\n\x0c\x66ield_filter\x18\x02 \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.FieldFilterH\x00\x12H\n\x0cunary_filter\x18\x03 \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.UnaryFilterH\x00\x42\r\n\x0b\x66ilter_type\x1a\xd1\x01\n\x0f\x43ompositeFilter\x12I\n\x02op\x18\x01 \x01(\x0e\x32=.google.firestore.v1.StructuredQuery.CompositeFilter.Operator\x12<\n\x07\x66ilters\x18\x02 \x03(\x0b\x32+.google.firestore.v1.StructuredQuery.Filter\"5\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\x07\n\x03\x41ND\x10\x01\x12\x06\n\x02OR\x10\x02\x1a\x98\x03\n\x0b\x46ieldFilter\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x12\x45\n\x02op\x18\x02 \x01(\x0e\x32\x39.google.firestore.v1.StructuredQuery.FieldFilter.Operator\x12)\n\x05value\x18\x03 \x01(\x0b\x32\x1a.google.firestore.v1.Value\"\xd2\x01\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\r\n\tLESS_THAN\x10\x01\x12\x16\n\x12LESS_THAN_OR_EQUAL\x10\x02\x12\x10\n\x0cGREATER_THAN\x10\x03\x12\x19\n\x15GREATER_THAN_OR_EQUAL\x10\x04\x12\t\n\x05\x45QUAL\x10\x05\x12\r\n\tNOT_EQUAL\x10\x06\x12\x12\n\x0e\x41RRAY_CONTAINS\x10\x07\x12\x06\n\x02IN\x10\x08\x12\x16\n\x12\x41RRAY_CONTAINS_ANY\x10\t\x12\n\n\x06NOT_IN\x10\n\x1a\x8a\x02\n\x0bUnaryFilter\x12\x45\n\x02op\x18\x01 \x01(\x0e\x32\x39.google.firestore.v1.StructuredQuery.UnaryFilter.Operator\x12\x44\n\x05\x66ield\x18\x02 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceH\x00\"^\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\n\n\x06IS_NAN\x10\x02\x12\x0b\n\x07IS_NULL\x10\x03\x12\x0e\n\nIS_NOT_NAN\x10\x04\x12\x0f\n\x0bIS_NOT_NULL\x10\x05\x42\x0e\n\x0coperand_type\x1a\x8e\x01\n\x05Order\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x12\x41\n\tdirection\x18\x02 \x01(\x0e\x32..google.firestore.v1.StructuredQuery.Direction\x1a$\n\x0e\x46ieldReference\x12\x12\n\nfield_path\x18\x02 \x01(\t\x1aQ\n\nProjection\x12\x43\n\x06\x66ields\x18\x02 \x03(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x1a\xea\x03\n\x0b\x46indNearest\x12N\n\x0cvector_field\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceB\x03\xe0\x41\x02\x12\x35\n\x0cquery_vector\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.ValueB\x03\xe0\x41\x02\x12_\n\x10\x64istance_measure\x18\x03 \x01(\x0e\x32@.google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasureB\x03\xe0\x41\x02\x12/\n\x05limit\x18\x04 \x01(\x0b\x32\x1b.google.protobuf.Int32ValueB\x03\xe0\x41\x02\x12\"\n\x15\x64istance_result_field\x18\x05 \x01(\tB\x03\xe0\x41\x01\x12=\n\x12\x64istance_threshold\x18\x06 \x01(\x0b\x32\x1c.google.protobuf.DoubleValueB\x03\xe0\x41\x01\"_\n\x0f\x44istanceMeasure\x12 \n\x1c\x44ISTANCE_MEASURE_UNSPECIFIED\x10\x00\x12\r\n\tEUCLIDEAN\x10\x01\x12\n\n\x06\x43OSINE\x10\x02\x12\x0f\n\x0b\x44OT_PRODUCT\x10\x03\"E\n\tDirection\x12\x19\n\x15\x44IRECTION_UNSPECIFIED\x10\x00\x12\r\n\tASCENDING\x10\x01\x12\x0e\n\nDESCENDING\x10\x02\"\xb8\x05\n\x1aStructuredAggregationQuery\x12@\n\x10structured_query\x18\x01 \x01(\x0b\x32$.google.firestore.v1.StructuredQueryH\x00\x12V\n\x0c\x61ggregations\x18\x03 \x03(\x0b\x32;.google.firestore.v1.StructuredAggregationQuery.AggregationB\x03\xe0\x41\x01\x1a\xf1\x03\n\x0b\x41ggregation\x12R\n\x05\x63ount\x18\x01 \x01(\x0b\x32\x41.google.firestore.v1.StructuredAggregationQuery.Aggregation.CountH\x00\x12N\n\x03sum\x18\x02 \x01(\x0b\x32?.google.firestore.v1.StructuredAggregationQuery.Aggregation.SumH\x00\x12N\n\x03\x61vg\x18\x03 \x01(\x0b\x32?.google.firestore.v1.StructuredAggregationQuery.Aggregation.AvgH\x00\x12\x12\n\x05\x61lias\x18\x07 \x01(\tB\x03\xe0\x41\x01\x1a\x38\n\x05\x43ount\x12/\n\x05up_to\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64ValueB\x03\xe0\x41\x01\x1aI\n\x03Sum\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x1aI\n\x03\x41vg\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceB\n\n\x08operatorB\x0c\n\nquery_type\"D\n\x06\x43ursor\x12*\n\x06values\x18\x01 \x03(\x0b\x32\x1a.google.firestore.v1.Value\x12\x0e\n\x06\x62\x65\x66ore\x18\x02 \x01(\x08\x42\xc2\x01\n\x17\x63om.google.firestore.v1B\nQueryProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
|
|
13
13
|
|
|
14
14
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
15
15
|
|
|
@@ -290,6 +290,13 @@ module Google
|
|
|
290
290
|
# @return [::String]
|
|
291
291
|
# The fully qualified name of the method, for which the options below apply.
|
|
292
292
|
# This is used to find the method to apply the options.
|
|
293
|
+
#
|
|
294
|
+
# Example:
|
|
295
|
+
#
|
|
296
|
+
# publishing:
|
|
297
|
+
# method_settings:
|
|
298
|
+
# - selector: google.storage.control.v2.StorageControl.CreateFolder
|
|
299
|
+
# # method settings for CreateFolder...
|
|
293
300
|
# @!attribute [rw] long_running
|
|
294
301
|
# @return [::Google::Api::MethodSettings::LongRunning]
|
|
295
302
|
# Describes settings to use for long-running operations when generating
|
|
@@ -298,17 +305,14 @@ module Google
|
|
|
298
305
|
#
|
|
299
306
|
# Example of a YAML configuration::
|
|
300
307
|
#
|
|
301
|
-
#
|
|
302
|
-
#
|
|
308
|
+
# publishing:
|
|
309
|
+
# method_settings:
|
|
303
310
|
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
|
304
311
|
# long_running:
|
|
305
|
-
# initial_poll_delay:
|
|
306
|
-
# seconds: 60 # 1 minute
|
|
312
|
+
# initial_poll_delay: 60s # 1 minute
|
|
307
313
|
# poll_delay_multiplier: 1.5
|
|
308
|
-
# max_poll_delay:
|
|
309
|
-
#
|
|
310
|
-
# total_poll_timeout:
|
|
311
|
-
# seconds: 54000 # 90 minutes
|
|
314
|
+
# max_poll_delay: 360s # 6 minutes
|
|
315
|
+
# total_poll_timeout: 54000s # 90 minutes
|
|
312
316
|
# @!attribute [rw] auto_populated_fields
|
|
313
317
|
# @return [::Array<::String>]
|
|
314
318
|
# List of top-level fields of the request message, that should be
|
|
@@ -317,8 +321,8 @@ module Google
|
|
|
317
321
|
#
|
|
318
322
|
# Example of a YAML configuration:
|
|
319
323
|
#
|
|
320
|
-
#
|
|
321
|
-
#
|
|
324
|
+
# publishing:
|
|
325
|
+
# method_settings:
|
|
322
326
|
# - selector: google.example.v1.ExampleService.CreateExample
|
|
323
327
|
# auto_populated_fields:
|
|
324
328
|
# - request_id
|
|
@@ -124,8 +124,13 @@ module Google
|
|
|
124
124
|
# @return [::String]
|
|
125
125
|
# The plural name used in the resource name and permission names, such as
|
|
126
126
|
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
|
127
|
-
# name of 'cloudresourcemanager.googleapis.com/projects.get'.
|
|
128
|
-
#
|
|
127
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
|
|
128
|
+
# to this is for Nested Collections that have stuttering names, as defined
|
|
129
|
+
# in [AIP-122](https://google.aip.dev/122#nested-collections), where the
|
|
130
|
+
# collection ID in the resource name pattern does not necessarily directly
|
|
131
|
+
# match the `plural` value.
|
|
132
|
+
#
|
|
133
|
+
# It is the same concept of the `plural` field in k8s CRD spec
|
|
129
134
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
|
130
135
|
#
|
|
131
136
|
# Note: The plural form is required even for singleton resources. See
|
|
@@ -125,7 +125,7 @@ module Google
|
|
|
125
125
|
# @return [::Google::Cloud::Firestore::V1::ArrayValue]
|
|
126
126
|
# An array value.
|
|
127
127
|
#
|
|
128
|
-
# Cannot directly contain another array value, though can contain
|
|
128
|
+
# Cannot directly contain another array value, though can contain a
|
|
129
129
|
# map which contains another array.
|
|
130
130
|
# @!attribute [rw] map_value
|
|
131
131
|
# @return [::Google::Cloud::Firestore::V1::MapValue]
|
|
@@ -130,7 +130,7 @@ module Google
|
|
|
130
130
|
# * The value must be greater than or equal to zero if specified.
|
|
131
131
|
# @!attribute [rw] find_nearest
|
|
132
132
|
# @return [::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest]
|
|
133
|
-
# Optional. A potential
|
|
133
|
+
# Optional. A potential nearest neighbors search.
|
|
134
134
|
#
|
|
135
135
|
# Applies after all other filters and ordering.
|
|
136
136
|
#
|
|
@@ -369,7 +369,10 @@ module Google
|
|
|
369
369
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
370
370
|
end
|
|
371
371
|
|
|
372
|
-
# Nearest Neighbors search config.
|
|
372
|
+
# Nearest Neighbors search config. The ordering provided by FindNearest
|
|
373
|
+
# supersedes the order_by stage. If multiple documents have the same vector
|
|
374
|
+
# distance, the returned document order is not guaranteed to be stable
|
|
375
|
+
# between queries.
|
|
373
376
|
# @!attribute [rw] vector_field
|
|
374
377
|
# @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference]
|
|
375
378
|
# Required. An indexed vector field to search upon. Only documents which
|
|
@@ -381,11 +384,26 @@ module Google
|
|
|
381
384
|
# no more than 2048 dimensions.
|
|
382
385
|
# @!attribute [rw] distance_measure
|
|
383
386
|
# @return [::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure]
|
|
384
|
-
# Required. The
|
|
387
|
+
# Required. The distance measure to use, required.
|
|
385
388
|
# @!attribute [rw] limit
|
|
386
389
|
# @return [::Google::Protobuf::Int32Value]
|
|
387
390
|
# Required. The number of nearest neighbors to return. Must be a positive
|
|
388
391
|
# integer of no more than 1000.
|
|
392
|
+
# @!attribute [rw] distance_result_field
|
|
393
|
+
# @return [::String]
|
|
394
|
+
# Optional. Optional name of the field to output the result of the vector
|
|
395
|
+
# distance calculation. Must conform to [document field
|
|
396
|
+
# name][google.firestore.v1.Document.fields] limitations.
|
|
397
|
+
# @!attribute [rw] distance_threshold
|
|
398
|
+
# @return [::Google::Protobuf::DoubleValue]
|
|
399
|
+
# Optional. Option to specify a threshold for which no less similar
|
|
400
|
+
# documents will be returned. The behavior of the specified
|
|
401
|
+
# `distance_measure` will affect the meaning of the distance threshold.
|
|
402
|
+
# Since DOT_PRODUCT distances increase when the vectors are more similar,
|
|
403
|
+
# the comparison is inverted.
|
|
404
|
+
#
|
|
405
|
+
# For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold
|
|
406
|
+
# For DOT_PRODUCT: WHERE distance >= distance_threshold
|
|
389
407
|
class FindNearest
|
|
390
408
|
include ::Google::Protobuf::MessageExts
|
|
391
409
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -397,20 +415,23 @@ module Google
|
|
|
397
415
|
|
|
398
416
|
# Measures the EUCLIDEAN distance between the vectors. See
|
|
399
417
|
# [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn
|
|
400
|
-
# more
|
|
418
|
+
# more. The resulting distance decreases the more similar two vectors
|
|
419
|
+
# are.
|
|
401
420
|
EUCLIDEAN = 1
|
|
402
421
|
|
|
403
|
-
#
|
|
404
|
-
# measure similarity that isn't based on the vectors
|
|
405
|
-
# We recommend using DOT_PRODUCT with unit normalized vectors
|
|
406
|
-
# COSINE distance, which is mathematically equivalent with
|
|
407
|
-
# performance. See [Cosine
|
|
422
|
+
# COSINE distance compares vectors based on the angle between them, which
|
|
423
|
+
# allows you to measure similarity that isn't based on the vectors
|
|
424
|
+
# magnitude. We recommend using DOT_PRODUCT with unit normalized vectors
|
|
425
|
+
# instead of COSINE distance, which is mathematically equivalent with
|
|
426
|
+
# better performance. See [Cosine
|
|
408
427
|
# Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn
|
|
409
|
-
# more.
|
|
428
|
+
# more about COSINE similarity and COSINE distance. The resulting
|
|
429
|
+
# COSINE distance decreases the more similar two vectors are.
|
|
410
430
|
COSINE = 2
|
|
411
431
|
|
|
412
432
|
# Similar to cosine but is affected by the magnitude of the vectors. See
|
|
413
433
|
# [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more.
|
|
434
|
+
# The resulting distance increases the more similar two vectors are.
|
|
414
435
|
DOT_PRODUCT = 3
|
|
415
436
|
end
|
|
416
437
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-firestore-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-
|
|
11
|
+
date: 2024-08-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|