@google-cloud/discoveryengine 1.3.1 → 1.4.0

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

@@ -16,6 +16,8 @@ export declare class SearchServiceClient {
     private _gaxGrpc;
     private _protos;
     private _defaults;
+    private _universeDomain;
+    private _servicePath;
     auth: gax.GoogleAuth;
     descriptors: Descriptors;
     warn: (code: string, message: string, warnType?: string) => void;
@@ -85,15 +87,22 @@ export declare class SearchServiceClient {
     }>;
     /**
      * 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(),
-     * exists for compatibility reasons.
+     * 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.
@@ -114,6 +123,8 @@ export declare class SearchServiceClient {
      *   The request object that will be sent.
      * @param {string} request.servingConfig
      *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
+     *   or
      *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
      *   This field is used to identify the serving configuration name, set
      *   of models used to make the search.
@@ -157,11 +168,35 @@ export declare class SearchServiceClient {
      *   expression is case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     *
+     *   Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+     *   key property defined in the Vertex AI Search backend -- this mapping is
+     *   defined by the customer in their schema. For example a media customer might
+     *   have a field 'name' in their schema. In this case the filter would look
+     *   like this: filter --> name:'ANY("king kong")'
+     *
+     *   For more information about filtering including syntax and filter
+     *   operators, see
+     *   [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+     * @param {string} request.canonicalFilter
+     *   The default filter that is applied when a user performs a search without
+     *   checking any filters on the search page.
+     *
+     *   The filter applied to every search request when quality improvement such as
+     *   query expansion is needed. In the case a query does not have a sufficient
+     *   amount of results this filter will be used to determine whether or not to
+     *   enable the query expansion flow. The original filter will still be used for
+     *   the query expanded search.
+     *   This field is strongly recommended to achieve high search quality.
+     *
+     *   For more information about filter syntax, see
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
      * @param {string} request.orderBy
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
      *   object. Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive.
+     *   case-sensitive. For more information on ordering, see
+     *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
@@ -176,6 +211,8 @@ export declare class SearchServiceClient {
      *   error is returned.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
+     *   For more information on boosting, see
+     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -183,9 +220,17 @@ export declare class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
+     *      Example:
+     *      user_country_code: "au"
+     *
+     *      For available codes see [Country
+     *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
+     *
      *   * `search_type`: double. Default empty. Enables non-webpage searching
-     *     depending on the value. The only valid non-default value is 1,
-     *     which enables image searching.
+     *      depending on the value. The only valid non-default value is 1,
+     *      which enables image searching.
+     *      Example:
+     *      search_type: 1
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -212,15 +257,17 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
      *   Uses the provided embedding to do additional semantic document retrieval.
      *   The retrieval is based on the dot product of
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
-     *   embedding that is provided in
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+     *   and the document embedding that is provided in
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
      *
-     *   If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
-     *   provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
+     *   If
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
-     *   documents. This overrides {@link protos.|ServingConfig.ranking_expression}.
+     *   documents. This overrides
+     *   {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
      *   The ranking expression is a single function or multiple functions that are
      *   joint by "+".
      *     * ranking_expression = function, { " + ", function };
@@ -284,6 +331,8 @@ export declare class SearchServiceClient {
      *   The request object that will be sent.
      * @param {string} request.servingConfig
      *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
+     *   or
      *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
      *   This field is used to identify the serving configuration name, set
      *   of models used to make the search.
@@ -327,11 +376,35 @@ export declare class SearchServiceClient {
      *   expression is case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     *
+     *   Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+     *   key property defined in the Vertex AI Search backend -- this mapping is
+     *   defined by the customer in their schema. For example a media customer might
+     *   have a field 'name' in their schema. In this case the filter would look
+     *   like this: filter --> name:'ANY("king kong")'
+     *
+     *   For more information about filtering including syntax and filter
+     *   operators, see
+     *   [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+     * @param {string} request.canonicalFilter
+     *   The default filter that is applied when a user performs a search without
+     *   checking any filters on the search page.
+     *
+     *   The filter applied to every search request when quality improvement such as
+     *   query expansion is needed. In the case a query does not have a sufficient
+     *   amount of results this filter will be used to determine whether or not to
+     *   enable the query expansion flow. The original filter will still be used for
+     *   the query expanded search.
+     *   This field is strongly recommended to achieve high search quality.
+     *
+     *   For more information about filter syntax, see
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
      * @param {string} request.orderBy
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
      *   object. Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive.
+     *   case-sensitive. For more information on ordering, see
+     *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
@@ -346,6 +419,8 @@ export declare class SearchServiceClient {
      *   error is returned.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
+     *   For more information on boosting, see
+     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -353,9 +428,17 @@ export declare class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
+     *      Example:
+     *      user_country_code: "au"
+     *
+     *      For available codes see [Country
+     *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
+     *
      *   * `search_type`: double. Default empty. Enables non-webpage searching
-     *     depending on the value. The only valid non-default value is 1,
-     *     which enables image searching.
+     *      depending on the value. The only valid non-default value is 1,
+     *      which enables image searching.
+     *      Example:
+     *      search_type: 1
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -382,15 +465,17 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
      *   Uses the provided embedding to do additional semantic document retrieval.
      *   The retrieval is based on the dot product of
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
-     *   embedding that is provided in
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+     *   and the document embedding that is provided in
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
      *
-     *   If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
-     *   provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
+     *   If
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
-     *   documents. This overrides {@link protos.|ServingConfig.ranking_expression}.
+     *   documents. This overrides
+     *   {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
      *   The ranking expression is a single function or multiple functions that are
      *   joint by "+".
      *     * ranking_expression = function, { " + ", function };
@@ -449,6 +534,8 @@ export declare class SearchServiceClient {
      *   The request object that will be sent.
      * @param {string} request.servingConfig
      *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
+     *   or
      *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
      *   This field is used to identify the serving configuration name, set
      *   of models used to make the search.
@@ -492,11 +579,35 @@ export declare class SearchServiceClient {
      *   expression is case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     *
+     *   Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+     *   key property defined in the Vertex AI Search backend -- this mapping is
+     *   defined by the customer in their schema. For example a media customer might
+     *   have a field 'name' in their schema. In this case the filter would look
+     *   like this: filter --> name:'ANY("king kong")'
+     *
+     *   For more information about filtering including syntax and filter
+     *   operators, see
+     *   [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+     * @param {string} request.canonicalFilter
+     *   The default filter that is applied when a user performs a search without
+     *   checking any filters on the search page.
+     *
+     *   The filter applied to every search request when quality improvement such as
+     *   query expansion is needed. In the case a query does not have a sufficient
+     *   amount of results this filter will be used to determine whether or not to
+     *   enable the query expansion flow. The original filter will still be used for
+     *   the query expanded search.
+     *   This field is strongly recommended to achieve high search quality.
+     *
+     *   For more information about filter syntax, see
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
      * @param {string} request.orderBy
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
      *   object. Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive.
+     *   case-sensitive. For more information on ordering, see
+     *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
@@ -511,6 +622,8 @@ export declare class SearchServiceClient {
      *   error is returned.
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
+     *   For more information on boosting, see
+     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -518,9 +631,17 @@ export declare class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
+     *      Example:
+     *      user_country_code: "au"
+     *
+     *      For available codes see [Country
+     *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
+     *
      *   * `search_type`: double. Default empty. Enables non-webpage searching
-     *     depending on the value. The only valid non-default value is 1,
-     *     which enables image searching.
+     *      depending on the value. The only valid non-default value is 1,
+     *      which enables image searching.
+     *      Example:
+     *      search_type: 1
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -547,15 +668,17 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
      *   Uses the provided embedding to do additional semantic document retrieval.
      *   The retrieval is based on the dot product of
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
-     *   embedding that is provided in
-     *   {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+     *   and the document embedding that is provided in
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
      *
-     *   If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
-     *   provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
+     *   If
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+     *   is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
      * @param {string} request.rankingExpression
      *   The ranking expression controls the customized ranking on retrieval
-     *   documents. This overrides {@link protos.|ServingConfig.ranking_expression}.
+     *   documents. This overrides
+     *   {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
      *   The ranking expression is a single function or multiple functions that are
      *   joint by "+".
      *     * ranking_expression = function, { " + ", function };
@@ -658,6 +781,90 @@ export declare class SearchServiceClient {
      * ```
      */
     listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
+    /**
+     * Return a fully-qualified engine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @returns {string} Resource name string.
+     */
+    enginePath(project: string, location: string, collection: string, engine: string): string;
+    /**
+     * Parse the project from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromEngineName(engineName: string): string | number;
+    /**
+     * Parse the location from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromEngineName(engineName: string): string | number;
+    /**
+     * Parse the collection from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromEngineName(engineName: string): string | number;
+    /**
+     * Parse the engine from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromEngineName(engineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
      *
@@ -922,6 +1129,234 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the serving_config.
      */
     matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} target_site
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the target_site.
+     */
+    matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @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 projectLocationDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreBranch resource name string.
      *
@@ -1141,6 +1576,81 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the serving_config.
      */
     matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} target_site
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the target_site.
+     */
+    matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
     /**
      * Terminate the gRPC channel and close the client.
      *