@google-cloud/vectorsearch 0.1.0 → 0.3.0

package/build/src/index.d.ts

@@ -1,16 +1,18 @@
+import * as v1 from './v1';
 import * as v1beta from './v1beta';
-declare const DataObjectSearchServiceClient: typeof v1beta.DataObjectSearchServiceClient;
-type DataObjectSearchServiceClient = v1beta.DataObjectSearchServiceClient;
-declare const DataObjectServiceClient: typeof v1beta.DataObjectServiceClient;
-type DataObjectServiceClient = v1beta.DataObjectServiceClient;
-declare const VectorSearchServiceClient: typeof v1beta.VectorSearchServiceClient;
-type VectorSearchServiceClient = v1beta.VectorSearchServiceClient;
-export { v1beta, DataObjectSearchServiceClient, DataObjectServiceClient, VectorSearchServiceClient };
+declare const DataObjectSearchServiceClient: typeof v1.DataObjectSearchServiceClient;
+type DataObjectSearchServiceClient = v1.DataObjectSearchServiceClient;
+declare const DataObjectServiceClient: typeof v1.DataObjectServiceClient;
+type DataObjectServiceClient = v1.DataObjectServiceClient;
+declare const VectorSearchServiceClient: typeof v1.VectorSearchServiceClient;
+type VectorSearchServiceClient = v1.VectorSearchServiceClient;
+export { v1, v1beta, DataObjectSearchServiceClient, DataObjectServiceClient, VectorSearchServiceClient };
 declare const _default: {
+    v1: typeof v1;
     v1beta: typeof v1beta;
-    DataObjectSearchServiceClient: typeof v1beta.DataObjectSearchServiceClient;
-    DataObjectServiceClient: typeof v1beta.DataObjectServiceClient;
-    VectorSearchServiceClient: typeof v1beta.VectorSearchServiceClient;
+    DataObjectSearchServiceClient: typeof v1.DataObjectSearchServiceClient;
+    DataObjectServiceClient: typeof v1.DataObjectServiceClient;
+    VectorSearchServiceClient: typeof v1.VectorSearchServiceClient;
 };
 export default _default;
 import * as protos from '../protos/protos';

package/build/src/index.js

@@ -17,16 +17,18 @@
 // ** https://github.com/googleapis/synthtool **
 // ** All changes to this file may be overwritten. **
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.protos = exports.VectorSearchServiceClient = exports.DataObjectServiceClient = exports.DataObjectSearchServiceClient = exports.v1beta = void 0;
+exports.protos = exports.VectorSearchServiceClient = exports.DataObjectServiceClient = exports.DataObjectSearchServiceClient = exports.v1beta = exports.v1 = void 0;
+const v1 = require("./v1");
+exports.v1 = v1;
 const v1beta = require("./v1beta");
 exports.v1beta = v1beta;
-const DataObjectSearchServiceClient = v1beta.DataObjectSearchServiceClient;
+const DataObjectSearchServiceClient = v1.DataObjectSearchServiceClient;
 exports.DataObjectSearchServiceClient = DataObjectSearchServiceClient;
-const DataObjectServiceClient = v1beta.DataObjectServiceClient;
+const DataObjectServiceClient = v1.DataObjectServiceClient;
 exports.DataObjectServiceClient = DataObjectServiceClient;
-const VectorSearchServiceClient = v1beta.VectorSearchServiceClient;
+const VectorSearchServiceClient = v1.VectorSearchServiceClient;
 exports.VectorSearchServiceClient = VectorSearchServiceClient;
-exports.default = { v1beta, DataObjectSearchServiceClient, DataObjectServiceClient, VectorSearchServiceClient };
+exports.default = { v1, v1beta, DataObjectSearchServiceClient, DataObjectServiceClient, VectorSearchServiceClient };
 const protos = require("../protos/protos");
 exports.protos = protos;
 //# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,mCAAmC;AAS3B,wBAAM;AAPd,MAAM,6BAA6B,GAAG,MAAM,CAAC,6BAA6B,CAAC;AAO3D,sEAA6B;AAL7C,MAAM,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC;AAKhB,0DAAuB;AAHtE,MAAM,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAGK,8DAAyB;AACjG,kBAAe,EAAC,MAAM,EAAE,6BAA6B,EAAE,uBAAuB,EAAE,yBAAyB,EAAC,CAAC;AAC3G,2CAA2C;AACnC,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,2BAA2B;AAUnB,gBAAE;AATV,mCAAmC;AASvB,wBAAM;AAPlB,MAAM,6BAA6B,GAAG,EAAE,CAAC,6BAA6B,CAAC;AAOnD,sEAA6B;AALjD,MAAM,uBAAuB,GAAG,EAAE,CAAC,uBAAuB,CAAC;AAKR,0DAAuB;AAH1E,MAAM,yBAAyB,GAAG,EAAE,CAAC,yBAAyB,CAAC;AAGa,8DAAyB;AACrG,kBAAe,EAAC,EAAE,EAAE,MAAM,EAAE,6BAA6B,EAAE,uBAAuB,EAAE,yBAAyB,EAAC,CAAC;AAC/G,2CAA2C;AACnC,wBAAM"}

package/build/src/v1/data_object_search_service_client.d.ts

@@ -0,0 +1,583 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
+import { Transform } from 'stream';
+import * as protos from '../../protos/protos';
+/**
+ *  Service for searching data objects.
+ * @class
+ * @memberof v1
+ */
+export declare class DataObjectSearchServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    private _universeDomain;
+    private _servicePath;
+    private _log;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    locationsClient: LocationsClient;
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    dataObjectSearchServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of DataObjectSearchServiceClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+     *     .p12 key downloaded from the Google Developers Console. If you provide
+     *     a path to a JSON file, the projectId option below is not necessary.
+     *     NOTE: .pem and .p12 require you to specify options.email as well.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - The project ID from the Google
+     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+     *     the environment variable GCLOUD_PROJECT for your project ID. If your
+     *     app is running in an environment which supports
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     HTTP implementation. Load only fallback version and pass it to the constructor:
+     *     ```
+     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+     *     const client = new DataObjectSearchServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
+    /**
+     * Initialize the client.
+     * Performs asynchronous operations (such as authentication) and prepares the client.
+     * This function will be called automatically when any class method is called for the
+     * first time, but if you need to initialize it before calling an actual method,
+     * feel free to call initialize() directly.
+     *
+     * You can await on this method if you want to make sure the client is initialized.
+     *
+     * @returns {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize(): Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port(): number;
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes(): string[];
+    getProjectId(): Promise<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * Aggregates data objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to query.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {google.protobuf.Struct} [request.filter]
+     *   Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
+     *   represented as a google.protobuf.Struct.
+     * @param {google.cloud.vectorsearch.v1.AggregationMethod} request.aggregate
+     *   Required. The aggregation method to apply to the query.
+     * @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 {@link protos.google.cloud.vectorsearch.v1.AggregateDataObjectsResponse|AggregateDataObjectsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/data_object_search_service.aggregate_data_objects.js</caption>
+     * region_tag:vectorsearch_v1_generated_DataObjectSearchService_AggregateDataObjects_async
+     */
+    aggregateDataObjects(request?: protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsResponse,
+        protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsRequest | undefined,
+        {} | undefined
+    ]>;
+    aggregateDataObjects(request: protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsRequest, options: CallOptions, callback: Callback<protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsResponse, protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsRequest | null | undefined, {} | null | undefined>): void;
+    aggregateDataObjects(request: protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsRequest, callback: Callback<protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsResponse, protos.google.cloud.vectorsearch.v1.IAggregateDataObjectsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Batch searches data objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to search.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {number[]} request.searches
+     *   Required. A list of search requests to execute in parallel.
+     * @param {google.cloud.vectorsearch.v1.BatchSearchDataObjectsRequest.CombineResultsOptions} [request.combine]
+     *   Optional. Options for combining the results of the batch search operations.
+     * @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 {@link protos.google.cloud.vectorsearch.v1.BatchSearchDataObjectsResponse|BatchSearchDataObjectsResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/data_object_search_service.batch_search_data_objects.js</caption>
+     * region_tag:vectorsearch_v1_generated_DataObjectSearchService_BatchSearchDataObjects_async
+     */
+    batchSearchDataObjects(request?: protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsResponse,
+        protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsRequest | undefined,
+        {} | undefined
+    ]>;
+    batchSearchDataObjects(request: protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsRequest, options: CallOptions, callback: Callback<protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsResponse, protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsRequest | null | undefined, {} | null | undefined>): void;
+    batchSearchDataObjects(request: protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsRequest, callback: Callback<protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsResponse, protos.google.cloud.vectorsearch.v1.IBatchSearchDataObjectsRequest | null | undefined, {} | null | undefined>): void;
+    /**
+    * Searches data objects.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {google.cloud.vectorsearch.v1.VectorSearch} request.vectorSearch
+    *   A vector search operation.
+    * @param {google.cloud.vectorsearch.v1.SemanticSearch} request.semanticSearch
+    *   A semantic search operation.
+    * @param {google.cloud.vectorsearch.v1.TextSearch} [request.textSearch]
+    *   Optional. A text search operation.
+    * @param {string} request.parent
+    *   Required. The resource name of the Collection for which to search.
+    *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+    * @param {number} [request.pageSize]
+    *   Optional. The standard list page size. Only supported for KNN. If not set,
+    *   up to search_type.top_k results will be returned. The maximum value is
+    *   1000; values above 1000 will be coerced to 1000.
+    * @param {string} [request.pageToken]
+    *   Optional. The standard list page token.
+    *   Typically obtained via
+    *   {@link protos.google.cloud.vectorsearch.v1.SearchDataObjectsResponse.next_page_token|SearchDataObjectsResponse.next_page_token}
+    *   of the previous
+    *   {@link protos.google.cloud.vectorsearch.v1.DataObjectSearchService.SearchDataObjects|DataObjectSearchService.SearchDataObjects}
+    *   call.
+    * @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 Array of {@link protos.google.cloud.vectorsearch.v1.SearchResult|SearchResult}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `searchDataObjectsAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
+    searchDataObjects(request?: protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.ISearchResult[],
+        protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest | null,
+        protos.google.cloud.vectorsearch.v1.ISearchDataObjectsResponse
+    ]>;
+    searchDataObjects(request: protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest, protos.google.cloud.vectorsearch.v1.ISearchDataObjectsResponse | null | undefined, protos.google.cloud.vectorsearch.v1.ISearchResult>): void;
+    searchDataObjects(request: protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest, protos.google.cloud.vectorsearch.v1.ISearchDataObjectsResponse | null | undefined, protos.google.cloud.vectorsearch.v1.ISearchResult>): void;
+    /**
+     * Equivalent to `searchDataObjects`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.cloud.vectorsearch.v1.VectorSearch} request.vectorSearch
+     *   A vector search operation.
+     * @param {google.cloud.vectorsearch.v1.SemanticSearch} request.semanticSearch
+     *   A semantic search operation.
+     * @param {google.cloud.vectorsearch.v1.TextSearch} [request.textSearch]
+     *   Optional. A text search operation.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to search.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size. Only supported for KNN. If not set,
+     *   up to search_type.top_k results will be returned. The maximum value is
+     *   1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1.SearchDataObjectsResponse.next_page_token|SearchDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1.DataObjectSearchService.SearchDataObjects|DataObjectSearchService.SearchDataObjects}
+     *   call.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.cloud.vectorsearch.v1.SearchResult|SearchResult} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `searchDataObjectsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    searchDataObjectsStream(request?: protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `searchDataObjects`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.cloud.vectorsearch.v1.VectorSearch} request.vectorSearch
+     *   A vector search operation.
+     * @param {google.cloud.vectorsearch.v1.SemanticSearch} request.semanticSearch
+     *   A semantic search operation.
+     * @param {google.cloud.vectorsearch.v1.TextSearch} [request.textSearch]
+     *   Optional. A text search operation.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to search.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size. Only supported for KNN. If not set,
+     *   up to search_type.top_k results will be returned. The maximum value is
+     *   1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1.SearchDataObjectsResponse.next_page_token|SearchDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1.DataObjectSearchService.SearchDataObjects|DataObjectSearchService.SearchDataObjects}
+     *   call.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.cloud.vectorsearch.v1.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/data_object_search_service.search_data_objects.js</caption>
+     * region_tag:vectorsearch_v1_generated_DataObjectSearchService_SearchDataObjects_async
+     */
+    searchDataObjectsAsync(request?: protos.google.cloud.vectorsearch.v1.ISearchDataObjectsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vectorsearch.v1.ISearchResult>;
+    /**
+    * Queries data objects.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. The resource name of the Collection for which to query.
+    *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+    * @param {google.protobuf.Struct} [request.filter]
+    *   Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
+    *   represented as a google.protobuf.Struct.
+    * @param {google.cloud.vectorsearch.v1.OutputFields} [request.outputFields]
+    *   Optional. Mask specifying which fields to return.
+    * @param {number} [request.pageSize]
+    *   Optional. The standard list page size. Default is 100.
+    *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+    * @param {string} [request.pageToken]
+    *   Optional. The standard list page token.
+    *   Typically obtained via
+    *   {@link protos.google.cloud.vectorsearch.v1.QueryDataObjectsResponse.next_page_token|QueryDataObjectsResponse.next_page_token}
+    *   of the previous
+    *   {@link protos.google.cloud.vectorsearch.v1.DataObjectSearchService.QueryDataObjects|DataObjectSearchService.QueryDataObjects}
+    *   call.
+    * @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 Array of {@link protos.google.cloud.vectorsearch.v1.DataObject|DataObject}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `queryDataObjectsAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
+    queryDataObjects(request?: protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.IDataObject[],
+        protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest | null,
+        protos.google.cloud.vectorsearch.v1.IQueryDataObjectsResponse
+    ]>;
+    queryDataObjects(request: protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest, protos.google.cloud.vectorsearch.v1.IQueryDataObjectsResponse | null | undefined, protos.google.cloud.vectorsearch.v1.IDataObject>): void;
+    queryDataObjects(request: protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest, protos.google.cloud.vectorsearch.v1.IQueryDataObjectsResponse | null | undefined, protos.google.cloud.vectorsearch.v1.IDataObject>): void;
+    /**
+     * Equivalent to `queryDataObjects`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to query.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {google.protobuf.Struct} [request.filter]
+     *   Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
+     *   represented as a google.protobuf.Struct.
+     * @param {google.cloud.vectorsearch.v1.OutputFields} [request.outputFields]
+     *   Optional. Mask specifying which fields to return.
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size. Default is 100.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1.QueryDataObjectsResponse.next_page_token|QueryDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1.DataObjectSearchService.QueryDataObjects|DataObjectSearchService.QueryDataObjects}
+     *   call.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.cloud.vectorsearch.v1.DataObject|DataObject} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `queryDataObjectsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    queryDataObjectsStream(request?: protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `queryDataObjects`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to query.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {google.protobuf.Struct} [request.filter]
+     *   Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
+     *   represented as a google.protobuf.Struct.
+     * @param {google.cloud.vectorsearch.v1.OutputFields} [request.outputFields]
+     *   Optional. Mask specifying which fields to return.
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size. Default is 100.
+     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1.QueryDataObjectsResponse.next_page_token|QueryDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1.DataObjectSearchService.QueryDataObjects|DataObjectSearchService.QueryDataObjects}
+     *   call.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.cloud.vectorsearch.v1.DataObject|DataObject}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/data_object_search_service.query_data_objects.js</caption>
+     * region_tag:vectorsearch_v1_generated_DataObjectSearchService_QueryDataObjects_async
+     */
+    queryDataObjectsAsync(request?: protos.google.cloud.vectorsearch.v1.IQueryDataObjectsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vectorsearch.v1.IDataObject>;
+    /**
+       * Gets information about a location.
+       *
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   Resource name for the location.
+       * @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 {@link google.cloud.location.Location | Location}.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const [response] = await client.getLocation(request);
+       * ```
+       */
+    getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
+    /**
+       * Lists information about the supported locations for this service. Returns an iterable object.
+       *
+       * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   The resource that owns the locations collection, if applicable.
+       * @param {string} request.filter
+       *   The standard list filter.
+       * @param {number} request.pageSize
+       *   The standard list page size.
+       * @param {string} request.pageToken
+       *   The standard list page token.
+       * @param {object} [options]
+       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+       * @returns {Object}
+       *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+       *   When you iterate the returned iterable, each element will be an object representing
+       *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
+       *   so you can stop the iteration when you don't need more results.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const iterable = client.listLocationsAsync(request);
+       * for await (const response of iterable) {
+       *   // process response
+       * }
+       * ```
+       */
+    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
+    /**
+     * Return a fully-qualified collection resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @returns {string} Resource name string.
+     */
+    collectionPath(project: string, location: string, collection: string): string;
+    /**
+     * Parse the project from Collection resource.
+     *
+     * @param {string} collectionName
+     *   A fully-qualified path representing Collection resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromCollectionName(collectionName: string): string | number;
+    /**
+     * Parse the location from Collection resource.
+     *
+     * @param {string} collectionName
+     *   A fully-qualified path representing Collection resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromCollectionName(collectionName: string): string | number;
+    /**
+     * Parse the collection from Collection resource.
+     *
+     * @param {string} collectionName
+     *   A fully-qualified path representing Collection resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromCollectionName(collectionName: string): string | number;
+    /**
+     * Return a fully-qualified dataObject resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} dataObject
+     * @returns {string} Resource name string.
+     */
+    dataObjectPath(project: string, location: string, collection: string, dataObject: string): string;
+    /**
+     * Parse the project from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Parse the location from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Parse the collection from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Parse the dataObject from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the dataObject.
+     */
+    matchDataObjectFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Return a fully-qualified index resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} index
+     * @returns {string} Resource name string.
+     */
+    indexPath(project: string, location: string, collection: string, index: string): string;
+    /**
+     * Parse the project from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromIndexName(indexName: string): string | number;
+    /**
+     * Parse the location from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromIndexName(indexName: string): string | number;
+    /**
+     * Parse the collection from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromIndexName(indexName: string): string | number;
+    /**
+     * Parse the index from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the index.
+     */
+    matchIndexFromIndexName(indexName: string): string | number;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}