@google-cloud/discoveryengine 1.1.0 → 1.2.0

package/build/src/v1alpha/recommendation_service_client.js

@@ -0,0 +1,938 @@
+"use strict";
+// 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.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecommendationServiceClient = void 0;
+const jsonProtos = require("../../protos/protos.json");
+/**
+ * Client JSON configuration object, loaded from
+ * `src/v1alpha/recommendation_service_client_config.json`.
+ * This file defines retry strategy and timeouts for all API methods in this library.
+ */
+const gapicConfig = require("./recommendation_service_client_config.json");
+const version = require('../../../package.json').version;
+/**
+ *  Service for making recommendations.
+ * @class
+ * @memberof v1alpha
+ */
+class RecommendationServiceClient {
+    /**
+     * Construct an instance of RecommendationServiceClient.
+     *
+     * @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://developers.google.com/identity/protocols/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 RecommendationServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts, gaxInstance) {
+        var _a, _b;
+        this._terminated = false;
+        this.descriptors = {
+            page: {},
+            stream: {},
+            longrunning: {},
+            batching: {},
+        };
+        // Ensure that options include all the required fields.
+        const staticMembers = this
+            .constructor;
+        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || staticMembers.servicePath;
+        this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
+        const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
+        const clientConfig = (_a = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _a !== void 0 ? _a : {};
+        const fallback = (_b = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _b !== void 0 ? _b : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
+        opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
+        // Request numeric enum values if REST transport is used.
+        opts.numericEnums = true;
+        // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
+        if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
+            opts['scopes'] = staticMembers.scopes;
+        }
+        // Load google-gax module synchronously if needed
+        if (!gaxInstance) {
+            gaxInstance = require('google-gax');
+        }
+        // Choose either gRPC or proto-over-HTTP implementation of google-gax.
+        this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
+        // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
+        this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
+        // Save options to use in initialize() method.
+        this._opts = opts;
+        // Save the auth object to the client, for use by other methods.
+        this.auth = this._gaxGrpc.auth;
+        // Set useJWTAccessWithScope on the auth object.
+        this.auth.useJWTAccessWithScope = true;
+        // Set defaultServicePath on the auth object.
+        this.auth.defaultServicePath = staticMembers.servicePath;
+        // Set the default scopes in auth client if needed.
+        if (servicePath === staticMembers.servicePath) {
+            this.auth.defaultScopes = staticMembers.scopes;
+        }
+        this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
+        // Determine the client header string.
+        const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
+        if (typeof process !== 'undefined' && 'versions' in process) {
+            clientHeader.push(`gl-node/${process.versions.node}`);
+        }
+        else {
+            clientHeader.push(`gl-web/${this._gaxModule.version}`);
+        }
+        if (!opts.fallback) {
+            clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
+        }
+        else {
+            clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
+        }
+        if (opts.libName && opts.libVersion) {
+            clientHeader.push(`${opts.libName}/${opts.libVersion}`);
+        }
+        // Load the applicable protos.
+        this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
+        // This API contains "path templates"; forward-slash-separated
+        // identifiers to uniquely identify resources within the API.
+        // Create useful helper objects for these.
+        this.pathTemplates = {
+            projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
+            projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
+            projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
+            projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
+            projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
+            projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
+            projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
+        };
+        // Put together the default options sent with requests.
+        this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.RecommendationService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
+        // Set up a dictionary of "inner API calls"; the core implementation
+        // of calling the API is handled in `google-gax`, with this code
+        // merely providing the destination and request information.
+        this.innerApiCalls = {};
+        // Add a warn function to the client constructor so it can be easily tested.
+        this.warn = this._gaxModule.warn;
+    }
+    /**
+     * 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() {
+        // If the client stub promise is already initialized, return immediately.
+        if (this.recommendationServiceStub) {
+            return this.recommendationServiceStub;
+        }
+        // Put together the "service stub" for
+        // google.cloud.discoveryengine.v1alpha.RecommendationService.
+        this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback
+            ? this._protos.lookupService('google.cloud.discoveryengine.v1alpha.RecommendationService')
+            : // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                this._protos.google.cloud.discoveryengine.v1alpha
+                    .RecommendationService, this._opts, this._providedCustomServicePath);
+        // Iterate over each of the methods that the service provides
+        // and create an API call method for each.
+        const recommendationServiceStubMethods = ['recommend'];
+        for (const methodName of recommendationServiceStubMethods) {
+            const callPromise = this.recommendationServiceStub.then(stub => (...args) => {
+                if (this._terminated) {
+                    return Promise.reject('The client has already been closed.');
+                }
+                const func = stub[methodName];
+                return func.apply(stub, args);
+            }, (err) => () => {
+                throw err;
+            });
+            const descriptor = undefined;
+            const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
+            this.innerApiCalls[methodName] = apiCall;
+        }
+        return this.recommendationServiceStub;
+    }
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath() {
+        return 'discoveryengine.googleapis.com';
+    }
+    /**
+     * The DNS address for this API service - same as servicePath(),
+     * exists for compatibility reasons.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint() {
+        return 'discoveryengine.googleapis.com';
+    }
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port() {
+        return 443;
+    }
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes() {
+        return ['https://www.googleapis.com/auth/cloud-platform'];
+    }
+    /**
+     * Return the project ID used by this class.
+     * @returns {Promise} A promise that resolves to string containing the project ID.
+     */
+    getProjectId(callback) {
+        if (callback) {
+            this.auth.getProjectId(callback);
+            return;
+        }
+        return this.auth.getProjectId();
+    }
+    recommend(request, optionsOrCallback, callback) {
+        var _a;
+        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({
+                serving_config: (_a = request.servingConfig) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.recommend(request, options, callback);
+    }
+    /**
+     * 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, options, callback) {
+        return this.locationsClient.getLocation(request, options, callback);
+    }
+    /**
+     * 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, options) {
+        return this.locationsClient.listLocationsAsync(request, options);
+    }
+    // --------------------
+    // -- Path templates --
+    // --------------------
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreBranchDocumentPath(project, location, collection, dataStore, branch, document) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            branch: branch,
+            document: document,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).data_store;
+    }
+    /**
+     * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).branch;
+    }
+    /**
+     * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            conversation: conversation,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
+    }
+    /**
+     * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            schema: schema,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).data_store;
+    }
+    /**
+     * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} serving_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreServingConfigPath(project, location, collection, dataStore, servingConfig) {
+        return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            serving_config: servingConfig,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).data_store;
+    }
+    /**
+     * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the serving_config.
+     */
+    matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} serving_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            engine: engine,
+            serving_config: servingConfig,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).collection;
+    }
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).engine;
+    }
+    /**
+     * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the serving_config.
+     */
+    matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
+    }
+    /**
+     * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreBranchDocumentPath(project, location, dataStore, branch, document) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            branch: branch,
+            document: document,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).data_store;
+    }
+    /**
+     * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).branch;
+    }
+    /**
+     * Parse the document from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
+        return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
+    }
+    /**
+     * Return a fully-qualified projectLocationDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            conversation: conversation,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
+    }
+    /**
+     * Parse the conversation from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
+    }
+    /**
+     * Return a fully-qualified projectLocationDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSchemaPath(project, location, dataStore, schema) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            schema: schema,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).data_store;
+    }
+    /**
+     * Parse the schema from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
+        return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).schema;
+    }
+    /**
+     * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} serving_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreServingConfigPath(project, location, dataStore, servingConfig) {
+        return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            serving_config: servingConfig,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).data_store;
+    }
+    /**
+     * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the serving_config.
+     */
+    matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
+        return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
+    }
+    /**
+     * 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() {
+        if (this.recommendationServiceStub && !this._terminated) {
+            return this.recommendationServiceStub.then(stub => {
+                this._terminated = true;
+                stub.close();
+                this.locationsClient.close();
+            });
+        }
+        return Promise.resolve();
+    }
+}
+exports.RecommendationServiceClient = RecommendationServiceClient;
+//# sourceMappingURL=recommendation_service_client.js.map