feat(firestore): update the api

#### firestore:v1 The following keys were added: - schemas.FindNearest (Total Keys: 7) - schemas.StructuredQuery.properties.findNearest.$ref (Total Keys: 1) #### firestore:v1beta1 The following keys were added: - schemas.FindNearest (Total Keys: 7) - schemas.StructuredQuery.properties.findNearest.$ref (Total Keys: 1)
googleapis · Apr 2, 2024 · 3e1ba17 · 3e1ba17
1 parent fa34310
commit 3e1ba17
Show file tree

Hide file tree

Showing 5 changed files with 331 additions and 3 deletions.
diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html
@@ -1227,6 +1227,37 @@ <h3>Method Details</h3>
             },
           ],
         },
+        &quot;findNearest&quot;: { # Nearest Neighbors search config. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector.
+          &quot;distanceMeasure&quot;: &quot;A String&quot;, # Required. The Distance Measure to use, required.
+          &quot;limit&quot;: 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
+          &quot;queryVector&quot;: { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
+            &quot;arrayValue&quot;: { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+              &quot;values&quot;: [ # Values in the array.
+                # Object with schema name: Value
+              ],
+            },
+            &quot;booleanValue&quot;: True or False, # A boolean value.
+            &quot;bytesValue&quot;: &quot;A String&quot;, # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
+            &quot;doubleValue&quot;: 3.14, # A double value.
+            &quot;geoPointValue&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+              &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+              &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+            },
+            &quot;integerValue&quot;: &quot;A String&quot;, # An integer value.
+            &quot;mapValue&quot;: { # A map value. # A map value.
+              &quot;fields&quot;: { # The map&#x27;s fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
+                &quot;a_key&quot;: # Object with schema name: Value
+              },
+            },
+            &quot;nullValue&quot;: &quot;A String&quot;, # A null value.
+            &quot;referenceValue&quot;: &quot;A String&quot;, # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
+            &quot;stringValue&quot;: &quot;A String&quot;, # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
+            &quot;timestampValue&quot;: &quot;A String&quot;, # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
+          },
+          &quot;vectorField&quot;: { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
+            &quot;fieldPath&quot;: &quot;A String&quot;, # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations.
+          },
+        },
         &quot;from&quot;: [ # The collections to query.
           { # A selection of a collection, such as `messages as m1`.
             &quot;allDescendants&quot;: True or False, # When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.
@@ -1472,6 +1503,37 @@ <h3>Method Details</h3>
         },
       ],
     },
+    &quot;findNearest&quot;: { # Nearest Neighbors search config. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector.
+      &quot;distanceMeasure&quot;: &quot;A String&quot;, # Required. The Distance Measure to use, required.
+      &quot;limit&quot;: 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
+      &quot;queryVector&quot;: { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
+        &quot;arrayValue&quot;: { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+          &quot;values&quot;: [ # Values in the array.
+            # Object with schema name: Value
+          ],
+        },
+        &quot;booleanValue&quot;: True or False, # A boolean value.
+        &quot;bytesValue&quot;: &quot;A String&quot;, # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
+        &quot;doubleValue&quot;: 3.14, # A double value.
+        &quot;geoPointValue&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+          &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+          &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+        },
+        &quot;integerValue&quot;: &quot;A String&quot;, # An integer value.
+        &quot;mapValue&quot;: { # A map value. # A map value.
+          &quot;fields&quot;: { # The map&#x27;s fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
+            &quot;a_key&quot;: # Object with schema name: Value
+          },
+        },
+        &quot;nullValue&quot;: &quot;A String&quot;, # A null value.
+        &quot;referenceValue&quot;: &quot;A String&quot;, # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
+        &quot;stringValue&quot;: &quot;A String&quot;, # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
+        &quot;timestampValue&quot;: &quot;A String&quot;, # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
+      },
+      &quot;vectorField&quot;: { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
+        &quot;fieldPath&quot;: &quot;A String&quot;, # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations.
+      },
+    },
     &quot;from&quot;: [ # The collections to query.
       { # A selection of a collection, such as `messages as m1`.
         &quot;allDescendants&quot;: True or False, # When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.
@@ -1811,6 +1873,37 @@ <h3>Method Details</h3>
           },
         ],
       },
+      &quot;findNearest&quot;: { # Nearest Neighbors search config. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector.
+        &quot;distanceMeasure&quot;: &quot;A String&quot;, # Required. The Distance Measure to use, required.
+        &quot;limit&quot;: 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
+        &quot;queryVector&quot;: { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
+          &quot;arrayValue&quot;: { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+            &quot;values&quot;: [ # Values in the array.
+              # Object with schema name: Value
+            ],
+          },
+          &quot;booleanValue&quot;: True or False, # A boolean value.
+          &quot;bytesValue&quot;: &quot;A String&quot;, # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
+          &quot;doubleValue&quot;: 3.14, # A double value.
+          &quot;geoPointValue&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+            &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+            &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+          },
+          &quot;integerValue&quot;: &quot;A String&quot;, # An integer value.
+          &quot;mapValue&quot;: { # A map value. # A map value.
+            &quot;fields&quot;: { # The map&#x27;s fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
+              &quot;a_key&quot;: # Object with schema name: Value
+            },
+          },
+          &quot;nullValue&quot;: &quot;A String&quot;, # A null value.
+          &quot;referenceValue&quot;: &quot;A String&quot;, # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
+          &quot;stringValue&quot;: &quot;A String&quot;, # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
+          &quot;timestampValue&quot;: &quot;A String&quot;, # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
+        },
+        &quot;vectorField&quot;: { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
+          &quot;fieldPath&quot;: &quot;A String&quot;, # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations.
+        },
+      },
       &quot;from&quot;: [ # The collections to query.
         { # A selection of a collection, such as `messages as m1`.
           &quot;allDescendants&quot;: True or False, # When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.
@@ -2023,6 +2116,37 @@ <h3>Method Details</h3>
         },
       ],
     },
+    &quot;findNearest&quot;: { # Nearest Neighbors search config. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector.
+      &quot;distanceMeasure&quot;: &quot;A String&quot;, # Required. The Distance Measure to use, required.
+      &quot;limit&quot;: 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
+      &quot;queryVector&quot;: { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
+        &quot;arrayValue&quot;: { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array.
+          &quot;values&quot;: [ # Values in the array.
+            # Object with schema name: Value
+          ],
+        },
+        &quot;booleanValue&quot;: True or False, # A boolean value.
+        &quot;bytesValue&quot;: &quot;A String&quot;, # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
+        &quot;doubleValue&quot;: 3.14, # A double value.
+        &quot;geoPointValue&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
+          &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+          &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+        },
+        &quot;integerValue&quot;: &quot;A String&quot;, # An integer value.
+        &quot;mapValue&quot;: { # A map value. # A map value.
+          &quot;fields&quot;: { # The map&#x27;s fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
+            &quot;a_key&quot;: # Object with schema name: Value
+          },
+        },
+        &quot;nullValue&quot;: &quot;A String&quot;, # A null value.
+        &quot;referenceValue&quot;: &quot;A String&quot;, # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
+        &quot;stringValue&quot;: &quot;A String&quot;, # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
+        &quot;timestampValue&quot;: &quot;A String&quot;, # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
+      },
+      &quot;vectorField&quot;: { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
+        &quot;fieldPath&quot;: &quot;A String&quot;, # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations.
+      },
+    },
     &quot;from&quot;: [ # The collections to query.
       { # A selection of a collection, such as `messages as m1`.
         &quot;allDescendants&quot;: True or False, # When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.