@google-cloud/discoveryengine 2.0.1 → 2.2.0

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

@@ -117,286 +117,286 @@ export declare class SearchServiceClient {
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
     /**
-     * Performs a search.
-     *
-     * @param {Object} request
-     *   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.
-     * @param {string} request.branch
-     *   The branch resource name, such as
-     *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
-     *
-     *   Use `default_branch` as the branch ID or leave this field empty, to search
-     *   documents under the default branch.
-     * @param {string} request.query
-     *   Raw search query.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery} request.imageQuery
-     *   Raw image query.
-     * @param {number} request.pageSize
-     *   Maximum number of
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. The
-     *   maximum allowed value depends on the data type. Values above the maximum
-     *   value are coerced to the maximum value.
-     *
-     *   * Websites with basic indexing: Default `10`, Maximum `25`.
-     *   * Websites with advanced indexing: Default `25`, Maximum `50`.
-     *   * Other: Default `50`, Maximum `100`.
-     *
-     *   If this field is negative, an  `INVALID_ARGUMENT` is returned.
-     * @param {string} request.pageToken
-     *   A page token received from a previous
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
-     *   call. Provide this to retrieve the subsequent page.
-     *
-     *   When paginating, all other parameters provided to
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
-     *   must match the call that provided the page token. Otherwise, an
-     *    `INVALID_ARGUMENT`  error is returned.
-     * @param {number} request.offset
-     *   A 0-indexed integer that specifies the current offset (that is, starting
-     *   result location, amongst the
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s deemed by the
-     *   API as relevant) in search results. This field is only considered if
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.page_token|page_token}
-     *   is unset.
-     *
-     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
-     * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
-     * @param {string} request.filter
-     *   The filter syntax consists of an expression language for constructing a
-     *   predicate from one or more fields of the documents being filtered. Filter
-     *   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.v1alpha.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.v1alpha.Document|Document}
-     *   object. Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive.
-     *
-     *   For more information on ordering the website search results, see
-     *   [Order web search
-     *   results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
-     *   For more information on ordering the healthcare search results, see
-     *   [Order healthcare search
-     *   results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
-     *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
-     * @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
-     *   Information about the end user.
-     *   Highly recommended for analytics.
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
-     *   is used to deduce `device_type` for analytics.
-     * @param {string} request.languageCode
-     *   The BCP-47 language code, such as "en-US" or "sr-Latn". For more
-     *   information, see [Standard
-     *   fields](https://cloud.google.com/apis/design/standard_fields). This field
-     *   helps to better interpret the query. If a value isn't specified, the query
-     *   language code is automatically detected, which may not be accurate.
-     * @param {string} request.regionCode
-     *   The Unicode country/region code (CLDR) of a location, such as "US" and
-     *   "419". For more information, see [Standard
-     *   fields](https://cloud.google.com/apis/design/standard_fields). If set,
-     *   then results will be boosted based on the region_code provided.
-     * @param {number[]} request.facetSpecs
-     *   Facet specifications for faceted search. If empty, no facets are returned.
-     *
-     *   A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
-     *   error is returned.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec} request.boostSpec
-     *   Boost specification to boost certain documents.
-     *   For more information on boosting, see
-     *   [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
-     * @param {number[]} request.params
-     *   Additional search parameters.
-     *
-     *   For public website search only, supported values are:
-     *
-     *   * `user_country_code`: string. Default empty. If set to non-empty, results
-     *      are restricted or boosted based on the location provided.
-     *      For 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.
-     *      For example, `search_type: 1`
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
-     *   The query expansion specification that specifies the conditions under which
-     *   query expansion occurs.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
-     *   The spell correction specification that specifies the mode under
-     *   which spell correction takes effect.
-     * @param {string} request.userPseudoId
-     *   A unique identifier for tracking visitors. For example, this could be
-     *   implemented with an HTTP cookie, which should be able to uniquely identify
-     *   a visitor on a single device. This unique identifier should not change if
-     *   the visitor logs in or out of the website.
-     *
-     *   This field should NOT have a fixed value such as `unknown_visitor`.
-     *
-     *   This should be the same identifier as
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
-     *   and
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
-     *
-     *   The field must be a UTF-8 encoded string with a length limit of 128
-     *   characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec} request.contentSearchSpec
-     *   A specification for configuring the behavior of content search.
-     * @param {google.cloud.discoveryengine.v1alpha.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.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
-     *   and the document embedding that is provided in
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
-     *
-     *   If
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
-     *   is not provided, it will use
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config|ServingConfig.EmbeddingConfig.field_path}.
-     * @param {string} request.rankingExpression
-     *   The ranking expression controls the customized ranking on retrieval
-     *   documents. This overrides
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
-     *   The ranking expression is a single function or multiple functions that are
-     *   joined by "+".
-     *
-     *     * ranking_expression = function, { " + ", function };
-     *
-     *   Supported functions:
-     *
-     *     * double * relevance_score
-     *     * double * dotProduct(embedding_field_path)
-     *
-     *   Function variables:
-     *
-     *     * `relevance_score`: pre-defined keywords, used for measure relevance
-     *     between query and document.
-     *     * `embedding_field_path`: the document embedding field
-     *     used with query embedding vector.
-     *     * `dotProduct`: embedding function between embedding_field_path and query
-     *     embedding vector.
-     *
-     *    Example ranking expression:
-     *
-     *      If document has an embedding field doc_embedding, the ranking expression
-     *      could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
-     * @param {boolean} request.safeSearch
-     *   Whether to turn on safe search. This is only supported for
-     *   website search.
-     * @param {number[]} request.userLabels
-     *   The user labels applied to a resource must meet the following requirements:
-     *
-     *   * Each resource can have multiple labels, up to a maximum of 64.
-     *   * Each label must be a key-value pair.
-     *   * Keys have a minimum length of 1 character and a maximum length of 63
-     *     characters and cannot be empty. Values can be empty and have a maximum
-     *     length of 63 characters.
-     *   * Keys and values can contain only lowercase letters, numeric characters,
-     *     underscores, and dashes. All characters must use UTF-8 encoding, and
-     *     international characters are allowed.
-     *   * The key portion of a label must be unique. However, you can use the same
-     *     key with multiple resources.
-     *   * Keys must start with a lowercase letter or international character.
-     *
-     *   See [Google Cloud
-     *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
-     *   for more details.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
-     *   If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
-     *   natural language query understanding will be done.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
-     *   Search as you type configuration. Only supported for the
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
-     *   vertical.
-     * @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
-     *   Custom fine tuning configs.
-     *   If set, it has higher priority than the configs set in
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec|ServingConfig.custom_fine_tuning_spec}.
-     * @param {string} request.session
-     *   The session resource name. Optional.
-     *
-     *   Session allows users to do multi-turn /search API calls or coordination
-     *   between /search API calls and /answer API calls.
-     *
-     *   Example #1 (multi-turn /search API calls):
-     *     1. Call /search API with the auto-session mode (see below).
-     *     2. Call /search API with the session ID generated in the first call.
-     *        Here, the previous search query gets considered in query
-     *        standing. I.e., if the first query is "How did Alphabet do in 2022?"
-     *        and the current query is "How about 2023?", the current query will
-     *        be interpreted as "How did Alphabet do in 2023?".
-     *
-     *   Example #2 (coordination between /search API calls and /answer API calls):
-     *     1. Call /search API with the auto-session mode (see below).
-     *     2. Call /answer API with the session ID generated in the first call.
-     *        Here, the answer generation happens in the context of the search
-     *        results from the first search call.
-     *
-     *   Auto-session mode: when `projects/.../sessions/-` is used, a new session
-     *   gets automatically created. Otherwise, users can use the create-session API
-     *   to create a session manually.
-     *
-     *   Multi-turn Search feature is currently at private GA stage. Please use
-     *   v1alpha or v1beta version instead before we launch this feature to public
-     *   GA. Or ask for allowlisting through Google Support team.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec} request.sessionSpec
-     *   Session specification.
-     *
-     *   Can be used only when `session` is set.
-     * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
-     *   The relevance threshold of the search results.
-     *
-     *   Default to Google defined threshold, leveraging a balance of
-     *   precision and recall to deliver both highly accurate results and
-     *   comprehensive coverage of relevant information.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-     * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult|SearchResult}.
-     *   The client library will perform auto-pagination by default: it will call the API as many
-     *   times as needed and will merge results from all the pages into this array.
-     *   Note that it can affect your quota.
-     *   We recommend using `searchAsync()`
-     *   method described below for async iteration which you can stop as needed.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     */
+    * Performs a search.
+    *
+    * @param {Object} request
+    *   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.
+    * @param {string} request.branch
+    *   The branch resource name, such as
+    *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
+    *
+    *   Use `default_branch` as the branch ID or leave this field empty, to search
+    *   documents under the default branch.
+    * @param {string} request.query
+    *   Raw search query.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery} request.imageQuery
+    *   Raw image query.
+    * @param {number} request.pageSize
+    *   Maximum number of
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. The
+    *   maximum allowed value depends on the data type. Values above the maximum
+    *   value are coerced to the maximum value.
+    *
+    *   * Websites with basic indexing: Default `10`, Maximum `25`.
+    *   * Websites with advanced indexing: Default `25`, Maximum `50`.
+    *   * Other: Default `50`, Maximum `100`.
+    *
+    *   If this field is negative, an  `INVALID_ARGUMENT` is returned.
+    * @param {string} request.pageToken
+    *   A page token received from a previous
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
+    *   call. Provide this to retrieve the subsequent page.
+    *
+    *   When paginating, all other parameters provided to
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
+    *   must match the call that provided the page token. Otherwise, an
+    *    `INVALID_ARGUMENT`  error is returned.
+    * @param {number} request.offset
+    *   A 0-indexed integer that specifies the current offset (that is, starting
+    *   result location, amongst the
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s deemed by the
+    *   API as relevant) in search results. This field is only considered if
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.page_token|page_token}
+    *   is unset.
+    *
+    *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+    * @param {number[]} request.dataStoreSpecs
+    *   Specs defining dataStores to filter on in a search call and configurations
+    *   for those dataStores. This is only considered for engines with multiple
+    *   dataStores use case. For single dataStore within an engine, they should
+    *   use the specs at the top level.
+    * @param {string} request.filter
+    *   The filter syntax consists of an expression language for constructing a
+    *   predicate from one or more fields of the documents being filtered. Filter
+    *   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.v1alpha.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.v1alpha.Document|Document}
+    *   object. Leave it unset if ordered by relevance. `order_by` expression is
+    *   case-sensitive.
+    *
+    *   For more information on ordering the website search results, see
+    *   [Order web search
+    *   results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
+    *   For more information on ordering the healthcare search results, see
+    *   [Order healthcare search
+    *   results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
+    *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+    * @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
+    *   Information about the end user.
+    *   Highly recommended for analytics.
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
+    *   is used to deduce `device_type` for analytics.
+    * @param {string} request.languageCode
+    *   The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+    *   information, see [Standard
+    *   fields](https://cloud.google.com/apis/design/standard_fields). This field
+    *   helps to better interpret the query. If a value isn't specified, the query
+    *   language code is automatically detected, which may not be accurate.
+    * @param {string} request.regionCode
+    *   The Unicode country/region code (CLDR) of a location, such as "US" and
+    *   "419". For more information, see [Standard
+    *   fields](https://cloud.google.com/apis/design/standard_fields). If set,
+    *   then results will be boosted based on the region_code provided.
+    * @param {number[]} request.facetSpecs
+    *   Facet specifications for faceted search. If empty, no facets are returned.
+    *
+    *   A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
+    *   error is returned.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec} request.boostSpec
+    *   Boost specification to boost certain documents.
+    *   For more information on boosting, see
+    *   [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+    * @param {number[]} request.params
+    *   Additional search parameters.
+    *
+    *   For public website search only, supported values are:
+    *
+    *   * `user_country_code`: string. Default empty. If set to non-empty, results
+    *      are restricted or boosted based on the location provided.
+    *      For 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.
+    *      For example, `search_type: 1`
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
+    *   The query expansion specification that specifies the conditions under which
+    *   query expansion occurs.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
+    *   The spell correction specification that specifies the mode under
+    *   which spell correction takes effect.
+    * @param {string} request.userPseudoId
+    *   A unique identifier for tracking visitors. For example, this could be
+    *   implemented with an HTTP cookie, which should be able to uniquely identify
+    *   a visitor on a single device. This unique identifier should not change if
+    *   the visitor logs in or out of the website.
+    *
+    *   This field should NOT have a fixed value such as `unknown_visitor`.
+    *
+    *   This should be the same identifier as
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
+    *   and
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
+    *
+    *   The field must be a UTF-8 encoded string with a length limit of 128
+    *   characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec} request.contentSearchSpec
+    *   A specification for configuring the behavior of content search.
+    * @param {google.cloud.discoveryengine.v1alpha.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.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+    *   and the document embedding that is provided in
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
+    *
+    *   If
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+    *   is not provided, it will use
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config|ServingConfig.EmbeddingConfig.field_path}.
+    * @param {string} request.rankingExpression
+    *   The ranking expression controls the customized ranking on retrieval
+    *   documents. This overrides
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
+    *   The ranking expression is a single function or multiple functions that are
+    *   joined by "+".
+    *
+    *     * ranking_expression = function, { " + ", function };
+    *
+    *   Supported functions:
+    *
+    *     * double * relevance_score
+    *     * double * dotProduct(embedding_field_path)
+    *
+    *   Function variables:
+    *
+    *     * `relevance_score`: pre-defined keywords, used for measure relevance
+    *     between query and document.
+    *     * `embedding_field_path`: the document embedding field
+    *     used with query embedding vector.
+    *     * `dotProduct`: embedding function between embedding_field_path and query
+    *     embedding vector.
+    *
+    *    Example ranking expression:
+    *
+    *      If document has an embedding field doc_embedding, the ranking expression
+    *      could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+    * @param {boolean} request.safeSearch
+    *   Whether to turn on safe search. This is only supported for
+    *   website search.
+    * @param {number[]} request.userLabels
+    *   The user labels applied to a resource must meet the following requirements:
+    *
+    *   * Each resource can have multiple labels, up to a maximum of 64.
+    *   * Each label must be a key-value pair.
+    *   * Keys have a minimum length of 1 character and a maximum length of 63
+    *     characters and cannot be empty. Values can be empty and have a maximum
+    *     length of 63 characters.
+    *   * Keys and values can contain only lowercase letters, numeric characters,
+    *     underscores, and dashes. All characters must use UTF-8 encoding, and
+    *     international characters are allowed.
+    *   * The key portion of a label must be unique. However, you can use the same
+    *     key with multiple resources.
+    *   * Keys must start with a lowercase letter or international character.
+    *
+    *   See [Google Cloud
+    *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+    *   for more details.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
+    *   If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
+    *   natural language query understanding will be done.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
+    *   Search as you type configuration. Only supported for the
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
+    *   vertical.
+    * @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
+    *   Custom fine tuning configs.
+    *   If set, it has higher priority than the configs set in
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec|ServingConfig.custom_fine_tuning_spec}.
+    * @param {string} request.session
+    *   The session resource name. Optional.
+    *
+    *   Session allows users to do multi-turn /search API calls or coordination
+    *   between /search API calls and /answer API calls.
+    *
+    *   Example #1 (multi-turn /search API calls):
+    *     1. Call /search API with the auto-session mode (see below).
+    *     2. Call /search API with the session ID generated in the first call.
+    *        Here, the previous search query gets considered in query
+    *        standing. I.e., if the first query is "How did Alphabet do in 2022?"
+    *        and the current query is "How about 2023?", the current query will
+    *        be interpreted as "How did Alphabet do in 2023?".
+    *
+    *   Example #2 (coordination between /search API calls and /answer API calls):
+    *     1. Call /search API with the auto-session mode (see below).
+    *     2. Call /answer API with the session ID generated in the first call.
+    *        Here, the answer generation happens in the context of the search
+    *        results from the first search call.
+    *
+    *   Auto-session mode: when `projects/.../sessions/-` is used, a new session
+    *   gets automatically created. Otherwise, users can use the create-session API
+    *   to create a session manually.
+    *
+    *   Multi-turn Search feature is currently at private GA stage. Please use
+    *   v1alpha or v1beta version instead before we launch this feature to public
+    *   GA. Or ask for allowlisting through Google Support team.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec} request.sessionSpec
+    *   Session specification.
+    *
+    *   Can be used only when `session` is set.
+    * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+    *   The relevance threshold of the search results.
+    *
+    *   Default to Google defined threshold, leveraging a balance of
+    *   precision and recall to deliver both highly accurate results and
+    *   comprehensive coverage of relevant information.
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult|SearchResult}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `searchAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
     search(request?: protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult[],
         protos.google.cloud.discoveryengine.v1alpha.ISearchRequest | null,
@@ -968,55 +968,55 @@ export declare class SearchServiceClient {
      */
     searchAsync(request?: protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult>;
     /**
-     * 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 aclConfig resource name string.