@google-cloud/discoveryengine 2.0.1 → 2.2.0

package/build/src/v1/project_service_proto_list.json

@@ -24,10 +24,13 @@
     "../../protos/google/cloud/discoveryengine/v1/purge_config.proto",
     "../../protos/google/cloud/discoveryengine/v1/rank_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/recommendation_service.proto",
+    "../../protos/google/cloud/discoveryengine/v1/safety.proto",
     "../../protos/google/cloud/discoveryengine/v1/schema.proto",
     "../../protos/google/cloud/discoveryengine/v1/schema_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/search_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/search_tuning_service.proto",
+    "../../protos/google/cloud/discoveryengine/v1/serving_config.proto",
+    "../../protos/google/cloud/discoveryengine/v1/serving_config_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/session.proto",
     "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
     "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",

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

@@ -126,7 +126,7 @@ export declare class RankServiceClient {
      * @param {string} request.model
      *   The identifier of the model to use. It is one of:
      *
-     *   * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
+     *   * `semantic-ranker-512@latest`: Semantic ranking model with maximum input
      *   token size 512.
      *
      *   It is set to `semantic-ranker-512@latest` by default if unspecified.
@@ -175,55 +175,55 @@ export declare class RankServiceClient {
     rank(request: protos.google.cloud.discoveryengine.v1.IRankRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IRankResponse, protos.google.cloud.discoveryengine.v1.IRankRequest | null | undefined, {} | null | undefined>): void;
     rank(request: protos.google.cloud.discoveryengine.v1.IRankRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IRankResponse, protos.google.cloud.discoveryengine.v1.IRankRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * 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);
-     * ```
-     */
+       * 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
-     * }
-     * ```
-     */
+       * 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 engine resource name string.
@@ -699,6 +699,57 @@ export declare class RankServiceClient {
      * @returns {string} A string representing the schema.
      */
     matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * 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: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
      *
@@ -852,6 +903,57 @@ export declare class RankServiceClient {
      * @returns {string} A string representing the data_store.
      */
     matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
      *
@@ -1005,6 +1107,57 @@ export declare class RankServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
+    /**
+     * 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: string, location: string, collection: string, engine: string, servingConfig: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
      *
@@ -1461,6 +1614,48 @@ export declare class RankServiceClient {
      * @returns {string} A string representing the schema.
      */
     matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * 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: string, location: string, dataStore: string, servingConfig: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSession resource name string.
      *
@@ -1587,6 +1782,48 @@ export declare class RankServiceClient {
      * @returns {string} A string representing the data_store.
      */
     matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
      *