feat: Vector Search

dev/protos/google/firestore/admin/v1/field.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -49,8 +49,8 @@ message Field {
     // When false, the `Field`'s index configuration is defined explicitly.
     bool uses_ancestor_config = 2;
 
-    // Output only. Specifies the resource name of the `Field` from which this field's
-    // index configuration is set (when `uses_ancestor_config` is true),
+    // Output only. Specifies the resource name of the `Field` from which this
+    // field's index configuration is set (when `uses_ancestor_config` is true),
     // or from which it *would* be set if this field had no index configuration
     // (when `uses_ancestor_config` is false).
     string ancestor_field = 3;
@@ -65,9 +65,12 @@ message Field {
 
   // The TTL (time-to-live) configuration for documents that have this `Field`
   // set.
+  //
   // Storing a timestamp value into a TTL-enabled field will be treated as
-  // the document's absolute expiration time. Using any other data type or
-  // leaving the field absent will disable the TTL for the individual document.
+  // the document's absolute expiration time. Timestamp values in the past
+  // indicate that the document is eligible for immediate expiration. Using any
+  // other data type or leaving the field absent will disable expiration for the
+  // individual document.
   message TtlConfig {
     // The state of applying the TTL configuration to all documents.
     enum State {

dev/protos/google/firestore/admin/v1/firestore_admin.proto

@@ -547,7 +547,7 @@ message ListBackupSchedulesResponse {
 
 // The request for [FirestoreAdmin.DeleteBackupSchedules][].
 message DeleteBackupScheduleRequest {
-  // Required. The name of backup schedule.
+  // Required. The name of the backup schedule.
   //
   // Format
   // `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
@@ -862,4 +862,4 @@ message RestoreDatabaseRequest {
       type: "firestore.googleapis.com/Backup"
     }
   ];
-}
+}

dev/protos/google/firestore/admin/v1/schedule.proto

@@ -77,7 +77,7 @@ message BackupSchedule {
   }
 }
 
-// Represent a recurring schedule that runs at a specific time every day.
+// Represents a recurring schedule that runs at a specific time every day.
 //
 // The time zone is UTC.
 message DailyRecurrence {}

dev/protos/google/longrunning/operations.proto

@@ -19,10 +19,10 @@ package google.longrunning;
 import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/protobuf/any.proto";
+import "google/protobuf/descriptor.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/empty.proto";
 import "google/rpc/status.proto";
-import "google/protobuf/descriptor.proto";
 
 option cc_enable_arenas = true;
 option csharp_namespace = "Google.LongRunning";
@@ -45,12 +45,12 @@ extend google.protobuf.MethodOptions {
 // Manages long-running operations with an API service.
 //
 // When an API method normally takes long time to complete, it can be designed
-// to return [Operation][google.longrunning.Operation] to the client, and the client can use this
-// interface to receive the real response asynchronously by polling the
-// operation resource, or pass the operation resource to another API (such as
-// Google Cloud Pub/Sub API) to receive the response.  Any API service that
-// returns long-running operations should implement the `Operations` interface
-// so developers can have a consistent client experience.
+// to return [Operation][google.longrunning.Operation] to the client, and the
+// client can use this interface to receive the real response asynchronously by
+// polling the operation resource, or pass the operation resource to another API
+// (such as Google Cloud Pub/Sub API) to receive the response.  Any API service
+// that returns long-running operations should implement the `Operations`
+// interface so developers can have a consistent client experience.
 service Operations {
   option (google.api.default_host) = "longrunning.googleapis.com";
 
@@ -100,8 +100,9 @@ service Operations {
   // other methods to check whether the cancellation succeeded or whether the
   // operation completed despite cancellation. On successful cancellation,
   // the operation is not deleted; instead, it becomes an operation with
-  // an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
-  // corresponding to `Code.CANCELLED`.
+  // an [Operation.error][google.longrunning.Operation.error] value with a
+  // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+  // `Code.CANCELLED`.
   rpc CancelOperation(CancelOperationRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       post: "/v1/{name=operations/**}:cancel"
@@ -119,8 +120,7 @@ service Operations {
   // Note that this method is on a best-effort basis.  It may return the latest
   // state before the specified timeout (including immediately), meaning even an
   // immediate response is no guarantee that the operation is done.
-  rpc WaitOperation(WaitOperationRequest) returns (Operation) {
-  }
+  rpc WaitOperation(WaitOperationRequest) returns (Operation) {}
 }
 
 // This resource represents a long-running operation that is the result of a
@@ -161,13 +161,15 @@ message Operation {
   }
 }
 
-// The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
+// The request message for
+// [Operations.GetOperation][google.longrunning.Operations.GetOperation].
 message GetOperationRequest {
   // The name of the operation resource.
   string name = 1;
 }
 
-// The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
+// The request message for
+// [Operations.ListOperations][google.longrunning.Operations.ListOperations].
 message ListOperationsRequest {
   // The name of the operation's parent resource.
   string name = 4;
@@ -182,7 +184,8 @@ message ListOperationsRequest {
   string page_token = 3;
 }
 
-// The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
+// The response message for
+// [Operations.ListOperations][google.longrunning.Operations.ListOperations].
 message ListOperationsResponse {
   // A list of operations that matches the specified filter in the request.
   repeated Operation operations = 1;
@@ -191,19 +194,22 @@ message ListOperationsResponse {
   string next_page_token = 2;
 }
 
-// The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
+// The request message for
+// [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
 message CancelOperationRequest {
   // The name of the operation resource to be cancelled.
   string name = 1;
 }
 
-// The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
+// The request message for
+// [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
 message DeleteOperationRequest {
   // The name of the operation resource to be deleted.
   string name = 1;
 }
 
-// The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].
+// The request message for
+// [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].
 message WaitOperationRequest {
   // The name of the operation resource to wait on.
   string name = 1;

dev/protos/google/rpc/status.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -33,14 +33,12 @@ option objc_class_prefix = "RPC";
 // You can find out more about this error model and how to work with it in the
 // [API Design Guide](https://cloud.google.com/apis/design/errors).
 message Status {
-  // The status code, which should be an enum value of
-  // [google.rpc.Code][google.rpc.Code].
+  // The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
   int32 code = 1;
 
   // A developer-facing error message, which should be in English. Any
   // user-facing error message should be localized and sent in the
-  // [google.rpc.Status.details][google.rpc.Status.details] field, or localized
-  // by the client.
+  // [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
   string message = 2;
 
   // A list of messages that carry the error details.  There is a common set of

dev/src/collection-group.ts

@@ -93,7 +93,7 @@ export class CollectionGroup<
       // Partition queries require explicit ordering by __name__.
       const queryWithDefaultOrder = this.orderBy(FieldPath.documentId());
       const request: api.IPartitionQueryRequest =
-        queryWithDefaultOrder.toProto();
+        queryWithDefaultOrder._toProto();
 
       // Since we are always returning an extra partition (with an empty endBefore
       // cursor), we reduce the desired partition count by one.

dev/src/convert.ts

@@ -20,6 +20,7 @@ import {ApiMapValue, ProtobufJsValue} from './types';
 import {validateObject} from './validate';
 
 import api = google.firestore.v1;
+import {RESERVED_MAP_KEY, RESERVED_MAP_KEY_VECTOR_VALUE} from './map-type';
 
 /*!
  * @module firestore/convert
@@ -112,53 +113,72 @@ function bytesFromJson(bytesValue: string | Uint8Array): Uint8Array {
  * @return The string value for 'valueType'.
  */
 export function detectValueType(proto: ProtobufJsValue): string {
+  let valueType: string | undefined;
+
   if (proto.valueType) {
-    return proto.valueType;
-  }
+    valueType = proto.valueType;
+  } else {
+    const detectedValues: string[] = [];
 
-  const detectedValues: string[] = [];
+    if (proto.stringValue !== undefined) {
+      detectedValues.push('stringValue');
+    }
+    if (proto.booleanValue !== undefined) {
+      detectedValues.push('booleanValue');
+    }
+    if (proto.integerValue !== undefined) {
+      detectedValues.push('integerValue');
+    }
+    if (proto.doubleValue !== undefined) {
+      detectedValues.push('doubleValue');
+    }
+    if (proto.timestampValue !== undefined) {
+      detectedValues.push('timestampValue');
+    }
+    if (proto.referenceValue !== undefined) {
+      detectedValues.push('referenceValue');
+    }
+    if (proto.arrayValue !== undefined) {
+      detectedValues.push('arrayValue');
+    }
+    if (proto.nullValue !== undefined) {
+      detectedValues.push('nullValue');
+    }
+    if (proto.mapValue !== undefined) {
+      detectedValues.push('mapValue');
+    }
+    if (proto.geoPointValue !== undefined) {
+      detectedValues.push('geoPointValue');
+    }
+    if (proto.bytesValue !== undefined) {
+      detectedValues.push('bytesValue');
+    }
 
-  if (proto.stringValue !== undefined) {
-    detectedValues.push('stringValue');
-  }
-  if (proto.booleanValue !== undefined) {
-    detectedValues.push('booleanValue');
-  }
-  if (proto.integerValue !== undefined) {
-    detectedValues.push('integerValue');
-  }
-  if (proto.doubleValue !== undefined) {
-    detectedValues.push('doubleValue');
-  }
-  if (proto.timestampValue !== undefined) {
-    detectedValues.push('timestampValue');
-  }
-  if (proto.referenceValue !== undefined) {
-    detectedValues.push('referenceValue');
-  }
-  if (proto.arrayValue !== undefined) {
-    detectedValues.push('arrayValue');
-  }
-  if (proto.nullValue !== undefined) {
-    detectedValues.push('nullValue');
-  }
-  if (proto.mapValue !== undefined) {
-    detectedValues.push('mapValue');
-  }
-  if (proto.geoPointValue !== undefined) {
-    detectedValues.push('geoPointValue');
-  }
-  if (proto.bytesValue !== undefined) {
-    detectedValues.push('bytesValue');
+    if (detectedValues.length !== 1) {
+      throw new Error(
+        `Unable to infer type value from '${JSON.stringify(proto)}'.`
+      );
+    }
+
+    valueType = detectedValues[0];
   }
 
-  if (detectedValues.length !== 1) {
-    throw new Error(
-      `Unable to infer type value from '${JSON.stringify(proto)}'.`
-    );
+  // Special handling of mapValues used to represent other data types
+  if (valueType === 'mapValue') {
+    const fields = proto.mapValue?.fields;
+    if (fields) {
+      const props = Object.keys(fields);
+      if (
+        props.indexOf(RESERVED_MAP_KEY) !== -1 &&
+        detectValueType(fields[RESERVED_MAP_KEY]) === 'stringValue' &&
+        fields[RESERVED_MAP_KEY].stringValue === RESERVED_MAP_KEY_VECTOR_VALUE
+      ) {
+        valueType = 'vectorValue';
+      }
+    }
   }
 
-  return detectedValues[0];
+  return valueType;
 }
 
 /**
@@ -199,7 +219,8 @@ export function valueFromJson(fieldValue: api.IValue): api.IValue {
         },
       };
     }
-    case 'mapValue': {
+    case 'mapValue':
+    case 'vectorValue': {
       const mapValue: ApiMapValue = {};
       const fields = fieldValue.mapValue!.fields;
       if (fields) {