@google-cloud/vectorsearch 0.1.0 → 0.2.0

package/build/protos/protos.json

@@ -24,14 +24,16 @@
                     "DataObject": {
                       "options": {
                         "(google.api.resource).type": "vectorsearch.googleapis.com/DataObject",
-                        "(google.api.resource).pattern": "projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}"
+                        "(google.api.resource).pattern": "projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}",
+                        "(google.api.resource).plural": "dataObjects",
+                        "(google.api.resource).singular": "dataObject"
                       },
                       "fields": {
                         "name": {
                           "type": "string",
                           "id": 1,
                           "options": {
-                            "(google.api.field_behavior)": "IMMUTABLE"
+                            "(google.api.field_behavior)": "IDENTIFIER"
                           }
                         },
                         "dataObjectId": {
@@ -251,11 +253,17 @@
                       "fields": {
                         "useIndex": {
                           "type": "IndexHint",
-                          "id": 1
+                          "id": 1,
+                          "options": {
+                            "(google.api.field_behavior)": "OPTIONAL"
+                          }
                         },
                         "useKnn": {
                           "type": "bool",
-                          "id": 2
+                          "id": 2,
+                          "options": {
+                            "(google.api.field_behavior)": "OPTIONAL"
+                          }
                         }
                       },
                       "nested": {
@@ -357,7 +365,7 @@
                           }
                         },
                         "distanceMetric": {
-                          "type": "DistanceMetric",
+                          "type": "google.cloud.vectorsearch.v1beta.DistanceMetric",
                           "id": 11,
                           "options": {
                             "(google.api.field_behavior)": "OPTIONAL"
@@ -416,6 +424,13 @@
                             "(google.api.field_behavior)": "OPTIONAL",
                             "proto3_optional": true
                           }
+                        },
+                        "searchHint": {
+                          "type": "SearchHint",
+                          "id": 7,
+                          "options": {
+                            "(google.api.field_behavior)": "OPTIONAL"
+                          }
                         }
                       }
                     },
@@ -457,6 +472,13 @@
                             "(google.api.field_behavior)": "OPTIONAL",
                             "proto3_optional": true
                           }
+                        },
+                        "filter": {
+                          "type": "google.protobuf.Struct",
+                          "id": 5,
+                          "options": {
+                            "(google.api.field_behavior)": "OPTIONAL"
+                          }
                         }
                       }
                     },
@@ -1371,6 +1393,30 @@
                               }
                             }
                           ]
+                        },
+                        "ExportDataObjects": {
+                          "requestType": "ExportDataObjectsRequest",
+                          "responseType": "google.longrunning.Operation",
+                          "options": {
+                            "(google.api.http).post": "/v1beta/{name=projects/*/locations/*/collections/*}:exportDataObjects",
+                            "(google.api.http).body": "*",
+                            "(google.longrunning.operation_info).response_type": "ExportDataObjectsResponse",
+                            "(google.longrunning.operation_info).metadata_type": "ExportDataObjectsMetadata"
+                          },
+                          "parsedOptions": [
+                            {
+                              "(google.api.http)": {
+                                "post": "/v1beta/{name=projects/*/locations/*/collections/*}:exportDataObjects",
+                                "body": "*"
+                              }
+                            },
+                            {
+                              "(google.longrunning.operation_info)": {
+                                "response_type": "ExportDataObjectsResponse",
+                                "metadata_type": "ExportDataObjectsMetadata"
+                              }
+                            }
+                          ]
                         }
                       }
                     },
@@ -1693,7 +1739,7 @@
                           }
                         },
                         "distanceMetric": {
-                          "type": "DistanceMetric",
+                          "type": "google.cloud.vectorsearch.v1beta.DistanceMetric",
                           "id": 4,
                           "options": {
                             "(google.api.field_behavior)": "OPTIONAL"
@@ -1934,6 +1980,13 @@
                               "options": {
                                 "(google.api.field_behavior)": "REQUIRED"
                               }
+                            },
+                            "outputUri": {
+                              "type": "string",
+                              "id": 3,
+                              "options": {
+                                "(google.api.field_behavior)": "OPTIONAL"
+                              }
                             }
                           }
                         }
@@ -1966,6 +2019,72 @@
                           "id": 1
                         }
                       }
+                    },
+                    "ExportDataObjectsRequest": {
+                      "oneofs": {
+                        "destination": {
+                          "oneof": [
+                            "gcsDestination"
+                          ]
+                        }
+                      },
+                      "fields": {
+                        "gcsDestination": {
+                          "type": "GcsExportDestination",
+                          "id": 2
+                        },
+                        "name": {
+                          "type": "string",
+                          "id": 1,
+                          "options": {
+                            "(google.api.field_behavior)": "REQUIRED",
+                            "(google.api.resource_reference).type": "vectorsearch.googleapis.com/Collection"
+                          }
+                        }
+                      },
+                      "nested": {
+                        "GcsExportDestination": {
+                          "fields": {
+                            "exportUri": {
+                              "type": "string",
+                              "id": 1,
+                              "options": {
+                                "(google.api.field_behavior)": "REQUIRED"
+                              }
+                            },
+                            "format": {
+                              "type": "Format",
+                              "id": 2,
+                              "options": {
+                                "(google.api.field_behavior)": "REQUIRED"
+                              }
+                            }
+                          },
+                          "nested": {
+                            "Format": {
+                              "values": {
+                                "FORMAT_UNSPECIFIED": 0,
+                                "JSON": 1
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "ExportDataObjectsMetadata": {
+                      "fields": {
+                        "createTime": {
+                          "type": "google.protobuf.Timestamp",
+                          "id": 1
+                        },
+                        "finishTime": {
+                          "type": "google.protobuf.Timestamp",
+                          "id": 2
+                        }
+                      }
+                    },
+                    "ExportDataObjectsResponse": {
+                      "fields": {}
                     }
                   }
                 }

package/build/src/v1beta/data_object_search_service_client.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/src/v1beta/data_object_service_client.d.ts

@@ -126,7 +126,7 @@ export declare class DataObjectServiceClient {
      * @param {string} request.dataObjectId
      *   Required. The id of the dataObject to create.
      *   The id must be 1-63 characters long, and comply with
-     *   <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
+     *   [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
      *   Specifically, it must be 1-63 characters long and match the regular
      *   expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
      * @param {google.cloud.vectorsearch.v1beta.DataObject} request.dataObject

package/build/src/v1beta/data_object_service_client.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/src/v1beta/data_object_service_client_config.json

@@ -34,13 +34,13 @@
             "methods": {
                 "CreateDataObject": {
                     "timeout_millis": 60000,
-                    "retry_codes_name": "non_idempotent",
-                    "retry_params_name": "default"
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 },
                 "BatchCreateDataObjects": {
                     "timeout_millis": 300000,
-                    "retry_codes_name": "non_idempotent",
-                    "retry_params_name": "default"
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 },
                 "GetDataObject": {
                     "timeout_millis": 60000,
@@ -49,23 +49,23 @@
                 },
                 "UpdateDataObject": {
                     "timeout_millis": 60000,
-                    "retry_codes_name": "non_idempotent",
-                    "retry_params_name": "default"
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 },
                 "BatchUpdateDataObjects": {
                     "timeout_millis": 60000,
-                    "retry_codes_name": "non_idempotent",
-                    "retry_params_name": "default"
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 },
                 "DeleteDataObject": {
                     "timeout_millis": 60000,
-                    "retry_codes_name": "non_idempotent",
-                    "retry_params_name": "default"
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 },
                 "BatchDeleteDataObjects": {
                     "timeout_millis": 60000,
-                    "retry_codes_name": "non_idempotent",
-                    "retry_params_name": "default"
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 }
             }
         }

package/build/src/v1beta/gapic_metadata.json

@@ -196,6 +196,11 @@
                                 "importDataObjects"
                             ]
                         },
+                        "ExportDataObjects": {
+                            "methods": [
+                                "exportDataObjects"
+                            ]
+                        },
                         "ListCollections": {
                             "methods": [
                                 "listCollections",
@@ -255,6 +260,11 @@
                                 "importDataObjects"
                             ]
                         },
+                        "ExportDataObjects": {
+                            "methods": [
+                                "exportDataObjects"
+                            ]
+                        },
                         "ListCollections": {
                             "methods": [
                                 "listCollections",

package/build/src/v1beta/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/src/v1beta/vector_search_service_client.d.ts

@@ -177,7 +177,7 @@ export declare class VectorSearchServiceClient {
      * @param {string} request.collectionId
      *   Required. ID of the Collection to create.
      *   The id must be 1-63 characters long, and comply with
-     *   <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
+     *   [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
      *   Specifically, it must be 1-63 characters long and match the regular
      *   expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
      * @param {google.cloud.vectorsearch.v1beta.Collection} request.collection
@@ -242,7 +242,8 @@ export declare class VectorSearchServiceClient {
      *   The following fields support update: `display_name`, `description`,
      *   `labels`, `data_schema`, `vector_schema`.
      *   For `data_schema` and `vector_schema`, fields can only be added, not
-     *   modified or deleted.
+     *   deleted, but `vertex_embedding_config` in `vector_schema` can be added or
+     *   removed.
      *   Partial updates for `data_schema` and `vector_schema` are also supported
      *   by using sub-field paths in `update_mask`, e.g.
      *   `data_schema.properties.foo` or `vector_schema.my_vector_field`.
@@ -357,7 +358,7 @@ export declare class VectorSearchServiceClient {
      * @param {string} request.indexId
      *   Required. ID of the Index to create.
      *   The id must be 1-63 characters long, and comply with
-     *   <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
+     *   [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
      *   Specifically, it must be 1-63 characters long and match the regular
      *   expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
      * @param {google.cloud.vectorsearch.v1beta.Index} request.index
@@ -499,6 +500,47 @@ export declare class VectorSearchServiceClient {
      * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ImportDataObjects_async
      */
     checkImportDataObjectsProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1beta.ImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.ImportDataObjectsMetadata>>;
+    /**
+     * Initiates a Long-Running Operation to export DataObjects from a Collection.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest.GcsExportDestination} request.gcsDestination
+     *   The Cloud Storage location where user wants to export Data Objects.
+     * @param {string} request.name
+     *   Required. The resource name of the Collection from which we want to export
+     *   Data Objects. Format:
+     *   `projects/{project}/locations/{location}/collections/{collection}`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/vector_search_service.export_data_objects.js</caption>
+     * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ExportDataObjects_async
+     */
+    exportDataObjects(request?: protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    exportDataObjects(request: protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    exportDataObjects(request: protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.IExportDataObjectsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `exportDataObjects()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/vector_search_service.export_data_objects.js</caption>
+     * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ExportDataObjects_async
+     */
+    checkExportDataObjectsProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1beta.ExportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.ExportDataObjectsMetadata>>;
     /**
     * Lists Collections in a given project and location.
     *

package/build/src/v1beta/vector_search_service_client.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -205,13 +205,16 @@ class VectorSearchServiceClient {
         const deleteIndexMetadata = protoFilesRoot.lookup('.google.cloud.vectorsearch.v1beta.OperationMetadata');
         const importDataObjectsResponse = protoFilesRoot.lookup('.google.cloud.vectorsearch.v1beta.ImportDataObjectsResponse');
         const importDataObjectsMetadata = protoFilesRoot.lookup('.google.cloud.vectorsearch.v1beta.ImportDataObjectsMetadata');
+        const exportDataObjectsResponse = protoFilesRoot.lookup('.google.cloud.vectorsearch.v1beta.ExportDataObjectsResponse');
+        const exportDataObjectsMetadata = protoFilesRoot.lookup('.google.cloud.vectorsearch.v1beta.ExportDataObjectsMetadata');
         this.descriptors.longrunning = {
             createCollection: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createCollectionResponse.decode.bind(createCollectionResponse), createCollectionMetadata.decode.bind(createCollectionMetadata)),
             updateCollection: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateCollectionResponse.decode.bind(updateCollectionResponse), updateCollectionMetadata.decode.bind(updateCollectionMetadata)),
             deleteCollection: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteCollectionResponse.decode.bind(deleteCollectionResponse), deleteCollectionMetadata.decode.bind(deleteCollectionMetadata)),
             createIndex: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createIndexResponse.decode.bind(createIndexResponse), createIndexMetadata.decode.bind(createIndexMetadata)),
             deleteIndex: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteIndexResponse.decode.bind(deleteIndexResponse), deleteIndexMetadata.decode.bind(deleteIndexMetadata)),
-            importDataObjects: new this._gaxModule.LongrunningDescriptor(this.operationsClient, importDataObjectsResponse.decode.bind(importDataObjectsResponse), importDataObjectsMetadata.decode.bind(importDataObjectsMetadata))
+            importDataObjects: new this._gaxModule.LongrunningDescriptor(this.operationsClient, importDataObjectsResponse.decode.bind(importDataObjectsResponse), importDataObjectsMetadata.decode.bind(importDataObjectsMetadata)),
+            exportDataObjects: new this._gaxModule.LongrunningDescriptor(this.operationsClient, exportDataObjectsResponse.decode.bind(exportDataObjectsResponse), exportDataObjectsMetadata.decode.bind(exportDataObjectsMetadata))
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.cloud.vectorsearch.v1beta.VectorSearchService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -246,7 +249,7 @@ class VectorSearchServiceClient {
             this._protos.google.cloud.vectorsearch.v1beta.VectorSearchService, this._opts, this._providedCustomServicePath);
         // Iterate over each of the methods that the service provides
         // and create an API call method for each.
-        const vectorSearchServiceStubMethods = ['listCollections', 'getCollection', 'createCollection', 'updateCollection', 'deleteCollection', 'listIndexes', 'getIndex', 'createIndex', 'deleteIndex', 'importDataObjects'];
+        const vectorSearchServiceStubMethods = ['listCollections', 'getCollection', 'createCollection', 'updateCollection', 'deleteCollection', 'listIndexes', 'getIndex', 'createIndex', 'deleteIndex', 'importDataObjects', 'exportDataObjects'];
         for (const methodName of vectorSearchServiceStubMethods) {
             const callPromise = this.vectorSearchServiceStub.then(stub => (...args) => {
                 if (this._terminated) {
@@ -685,6 +688,54 @@ class VectorSearchServiceClient {
         const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.importDataObjects, this._gaxModule.createDefaultBackoffSettings());
         return decodeOperation;
     }
+    exportDataObjects(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'name': request.name ?? '',
+        });
+        this.initialize().catch(err => { throw err; });
+        const wrappedCallback = callback
+            ? (error, response, rawResponse, _) => {
+                this._log.info('exportDataObjects response %j', rawResponse);
+                callback(error, response, rawResponse, _); // We verified callback above.
+            }
+            : undefined;
+        this._log.info('exportDataObjects request %j', request);
+        return this.innerApiCalls.exportDataObjects(request, options, wrappedCallback)
+            ?.then(([response, rawResponse, _]) => {
+            this._log.info('exportDataObjects response %j', rawResponse);
+            return [response, rawResponse, _];
+        });
+    }
+    /**
+     * Check the status of the long running operation returned by `exportDataObjects()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/vector_search_service.export_data_objects.js</caption>
+     * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ExportDataObjects_async
+     */
+    async checkExportDataObjectsProgress(name) {
+        this._log.info('exportDataObjects long-running');
+        const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
+        const [operation] = await this.operationsClient.getOperation(request);
+        const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.exportDataObjects, this._gaxModule.createDefaultBackoffSettings());
+        return decodeOperation;
+    }
     listCollections(request, optionsOrCallback, callback) {
         request = request || {};
         let options;