@google-cloud/discoveryengine 2.0.1 → 2.2.0

package/build/src/v1/control_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/conversational_search_service_client.d.ts

@@ -192,7 +192,7 @@ export declare class ConversationalSearchServiceClient {
      */
     converseConversation(request?: protos.google.cloud.discoveryengine.v1.IConverseConversationRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1.IConverseConversationResponse,
-        (protos.google.cloud.discoveryengine.v1.IConverseConversationRequest | undefined),
+        protos.google.cloud.discoveryengine.v1.IConverseConversationRequest | undefined,
         {} | undefined
     ]>;
     converseConversation(request: protos.google.cloud.discoveryengine.v1.IConverseConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IConverseConversationResponse, protos.google.cloud.discoveryengine.v1.IConverseConversationRequest | null | undefined, {} | null | undefined>): void;
@@ -221,7 +221,7 @@ export declare class ConversationalSearchServiceClient {
      */
     createConversation(request?: protos.google.cloud.discoveryengine.v1.ICreateConversationRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1.IConversation,
-        (protos.google.cloud.discoveryengine.v1.ICreateConversationRequest | undefined),
+        protos.google.cloud.discoveryengine.v1.ICreateConversationRequest | undefined,
         {} | undefined
     ]>;
     createConversation(request: protos.google.cloud.discoveryengine.v1.ICreateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IConversation, protos.google.cloud.discoveryengine.v1.ICreateConversationRequest | null | undefined, {} | null | undefined>): void;
@@ -248,7 +248,7 @@ export declare class ConversationalSearchServiceClient {
      */
     deleteConversation(request?: protos.google.cloud.discoveryengine.v1.IDeleteConversationRequest, options?: CallOptions): Promise<[
         protos.google.protobuf.IEmpty,
-        (protos.google.cloud.discoveryengine.v1.IDeleteConversationRequest | undefined),
+        protos.google.cloud.discoveryengine.v1.IDeleteConversationRequest | undefined,
         {} | undefined
     ]>;
     deleteConversation(request: protos.google.cloud.discoveryengine.v1.IDeleteConversationRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteConversationRequest | null | undefined, {} | null | undefined>): void;
@@ -284,7 +284,7 @@ export declare class ConversationalSearchServiceClient {
      */
     updateConversation(request?: protos.google.cloud.discoveryengine.v1.IUpdateConversationRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1.IConversation,
-        (protos.google.cloud.discoveryengine.v1.IUpdateConversationRequest | undefined),
+        protos.google.cloud.discoveryengine.v1.IUpdateConversationRequest | undefined,
         {} | undefined
     ]>;
     updateConversation(request: protos.google.cloud.discoveryengine.v1.IUpdateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IConversation, protos.google.cloud.discoveryengine.v1.IUpdateConversationRequest | null | undefined, {} | null | undefined>): void;
@@ -308,7 +308,7 @@ export declare class ConversationalSearchServiceClient {
      */
     getConversation(request?: protos.google.cloud.discoveryengine.v1.IGetConversationRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1.IConversation,
-        (protos.google.cloud.discoveryengine.v1.IGetConversationRequest | undefined),
+        protos.google.cloud.discoveryengine.v1.IGetConversationRequest | undefined,
         {} | undefined
     ]>;
     getConversation(request: protos.google.cloud.discoveryengine.v1.IGetConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IConversation, protos.google.cloud.discoveryengine.v1.IGetConversationRequest | null | undefined, {} | null | undefined>): void;
@@ -338,6 +338,8 @@ export declare class ConversationalSearchServiceClient {
      *   Model specification.
      * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.RelatedQuestionsSpec} request.relatedQuestionsSpec
      *   Related questions specification.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.GroundingSpec} [request.groundingSpec]
+     *   Optional. Grounding specification.
      * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.AnswerGenerationSpec} request.answerGenerationSpec
      *   Answer generation specification.
      * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec} request.searchSpec
@@ -385,6 +387,8 @@ export declare class ConversationalSearchServiceClient {
      *   See [Google Cloud
      *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
      *   for more details.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.EndUserSpec} [request.endUserSpec]
+     *   Optional. End user specification.
      * @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.
@@ -524,6 +528,9 @@ export declare class ConversationalSearchServiceClient {
      * @param {string} request.name
      *   Required. The resource name of the Session to get. Format:
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+     * @param {boolean} [request.includeAnswerDetails]
+     *   Optional. If set to true, the full session including all answer details
+     *   will be returned.
      * @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.
@@ -541,49 +548,141 @@ export declare class ConversationalSearchServiceClient {
     getSession(request: protos.google.cloud.discoveryengine.v1.IGetSessionRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.ISession, protos.google.cloud.discoveryengine.v1.IGetSessionRequest | null | undefined, {} | null | undefined>): void;
     getSession(request: protos.google.cloud.discoveryengine.v1.IGetSessionRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.ISession, protos.google.cloud.discoveryengine.v1.IGetSessionRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * Lists all Conversations by their parent
-     * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
+     * Answer query method (streaming).
+     *
+     * It takes one
+     * {@link protos.google.cloud.discoveryengine.v1.AnswerQueryRequest|AnswerQueryRequest}
+     * and returns multiple
+     * {@link protos.google.cloud.discoveryengine.v1.AnswerQueryResponse|AnswerQueryResponse}
+     * messages in a stream.
      *
      * @param {Object} request
      *   The request object that will be sent.
-     * @param {string} request.parent
-     *   Required. The data store resource name. Format:
-     *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
-     * @param {number} request.pageSize
-     *   Maximum number of results to return. If unspecified, defaults
-     *   to 50. Max allowed value is 1000.
-     * @param {string} request.pageToken
-     *   A page token, received from a previous `ListConversations` call.
-     *   Provide this to retrieve the subsequent page.
-     * @param {string} request.filter
-     *   A filter to apply on the list results. The supported features are:
-     *   user_pseudo_id, state.
+     * @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/* /servingConfigs/default_serving_config`.
+     *   This field is used to identify the serving configuration name, set
+     *   of models used to make the search.
+     * @param {google.cloud.discoveryengine.v1.Query} request.query
+     *   Required. Current user query.
+     * @param {string} request.session
+     *   The session resource name. Not required.
      *
-     *   Example:
-     *   "user_pseudo_id = some_id"
-     * @param {string} request.orderBy
-     *   A comma-separated list of fields to order by, sorted in ascending order.
-     *   Use "desc" after a field name for descending.
-     *   Supported fields:
-     *     * `update_time`
-     *     * `create_time`
-     *     * `conversation_name`
+     *   When session field is not set, the API is in sessionless mode.
      *
-     *   Example:
-     *   "update_time desc"
-     *   "create_time"
+     *   We support auto session mode: users can use the wildcard symbol `-` as
+     *   session ID.  A new ID will be automatically generated and assigned.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec} request.safetySpec
+     *   Model specification.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.RelatedQuestionsSpec} request.relatedQuestionsSpec
+     *   Related questions specification.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.GroundingSpec} [request.groundingSpec]
+     *   Optional. Grounding specification.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.AnswerGenerationSpec} request.answerGenerationSpec
+     *   Answer generation specification.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec} request.searchSpec
+     *   Search specification.
+     * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec} request.queryUnderstandingSpec
+     *   Query understanding specification.
+     * @param {boolean} request.asynchronousMode
+     *   Deprecated: This field is deprecated. Streaming Answer API will be
+     *   supported.
+     *
+     *   Asynchronous mode control.
+     *
+     *   If enabled, the response will be returned with answer/session resource
+     *   name without final answer. The API users need to do the polling to get
+     *   the latest status of answer/session by calling
+     *   {@link protos.google.cloud.discoveryengine.v1.ConversationalSearchService.GetAnswer|ConversationalSearchService.GetAnswer}
+     *   or
+     *   {@link protos.google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession|ConversationalSearchService.GetSession}
+     *   method.
+     * @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`.
+     *
+     *   The field must be a UTF-8 encoded string with a length limit of 128
+     *   characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
+     * @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.v1.AnswerQueryRequest.EndUserSpec} [request.endUserSpec]
+     *   Optional. End user specification.
      * @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.v1.Conversation|Conversation}.
-     *   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 `listConversationsAsync()`
-     *   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 }
+     * @returns {Stream}
+     *   An object stream which emits {@link protos.google.cloud.discoveryengine.v1.AnswerQueryResponse|AnswerQueryResponse} on 'data' event.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation }
      *   for more details and examples.
-     */
+     * @example <caption>include:samples/generated/v1/conversational_search_service.stream_answer_query.js</caption>
+     * region_tag:discoveryengine_v1_generated_ConversationalSearchService_StreamAnswerQuery_async
+     */
+    streamAnswerQuery(request?: protos.google.cloud.discoveryengine.v1.IAnswerQueryRequest, options?: CallOptions): gax.CancellableStream;
+    /**
+    * Lists all Conversations by their parent
+    * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. The data store resource name. Format:
+    *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
+    * @param {number} request.pageSize
+    *   Maximum number of results to return. If unspecified, defaults
+    *   to 50. Max allowed value is 1000.
+    * @param {string} request.pageToken
+    *   A page token, received from a previous `ListConversations` call.
+    *   Provide this to retrieve the subsequent page.
+    * @param {string} request.filter
+    *   A filter to apply on the list results. The supported features are:
+    *   user_pseudo_id, state.
+    *
+    *   Example:
+    *   "user_pseudo_id = some_id"
+    * @param {string} request.orderBy
+    *   A comma-separated list of fields to order by, sorted in ascending order.
+    *   Use "desc" after a field name for descending.
+    *   Supported fields:
+    *     * `update_time`
+    *     * `create_time`
+    *     * `conversation_name`
+    *
+    *   Example:
+    *   "update_time desc"
+    *   "create_time"
+    * @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.v1.Conversation|Conversation}.
+    *   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 `listConversationsAsync()`
+    *   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.
+    */
     listConversations(request?: protos.google.cloud.discoveryengine.v1.IListConversationsRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1.IConversation[],
         protos.google.cloud.discoveryengine.v1.IListConversationsRequest | null,
@@ -679,49 +778,54 @@ export declare class ConversationalSearchServiceClient {
      */
     listConversationsAsync(request?: protos.google.cloud.discoveryengine.v1.IListConversationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IConversation>;
     /**
-     * Lists all Sessions by their parent
-     * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.parent
-     *   Required. The data store resource name. Format:
-     *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
-     * @param {number} request.pageSize
-     *   Maximum number of results to return. If unspecified, defaults
-     *   to 50. Max allowed value is 1000.
-     * @param {string} request.pageToken
-     *   A page token, received from a previous `ListSessions` call.
-     *   Provide this to retrieve the subsequent page.
-     * @param {string} request.filter
-     *   A filter to apply on the list results. The supported features are:
-     *   user_pseudo_id, state.
-     *
-     *   Example:
-     *   "user_pseudo_id = some_id"
-     * @param {string} request.orderBy
-     *   A comma-separated list of fields to order by, sorted in ascending order.
-     *   Use "desc" after a field name for descending.
-     *   Supported fields:
-     *     * `update_time`
-     *     * `create_time`
-     *     * `session_name`
-     *
-     *   Example:
-     *   "update_time desc"
-     *   "create_time"
-     * @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.v1.Session|Session}.
-     *   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 `listSessionsAsync()`
-     *   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.
-     */
+    * Lists all Sessions by their parent
+    * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. The data store resource name. Format:
+    *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
+    * @param {number} request.pageSize
+    *   Maximum number of results to return. If unspecified, defaults
+    *   to 50. Max allowed value is 1000.
+    * @param {string} request.pageToken
+    *   A page token, received from a previous `ListSessions` call.
+    *   Provide this to retrieve the subsequent page.
+    * @param {string} request.filter
+    *   A filter to apply on the list results. The supported features are:
+    *   user_pseudo_id, state.
+    *
+    *   Example:
+    *   "user_pseudo_id = some_id"
+    * @param {string} request.orderBy
+    *   A comma-separated list of fields to order by, sorted in ascending order.
+    *   Use "desc" after a field name for descending.
+    *   Supported fields:
+    *
+    *     * `update_time`
+    *     * `create_time`
+    *     * `session_name`
+    *     * `is_pinned`
+    *
+    *   Example:
+    *
+    *   * "update_time desc"
+    *   * "create_time"
+    *   * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+    *      by update_time.
+    * @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.v1.Session|Session}.
+    *   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 `listSessionsAsync()`
+    *   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.
+    */
     listSessions(request?: protos.google.cloud.discoveryengine.v1.IListSessionsRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1.ISession[],
         protos.google.cloud.discoveryengine.v1.IListSessionsRequest | null,
@@ -752,13 +856,18 @@ export declare class ConversationalSearchServiceClient {
      *   A comma-separated list of fields to order by, sorted in ascending order.
      *   Use "desc" after a field name for descending.
      *   Supported fields:
+     *
      *     * `update_time`
      *     * `create_time`
      *     * `session_name`
+     *     * `is_pinned`
      *
      *   Example:
-     *   "update_time desc"
-     *   "create_time"
+     *
+     *   * "update_time desc"
+     *   * "create_time"
+     *   * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+     *      by update_time.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -796,13 +905,18 @@ export declare class ConversationalSearchServiceClient {
      *   A comma-separated list of fields to order by, sorted in ascending order.
      *   Use "desc" after a field name for descending.
      *   Supported fields:
+     *
      *     * `update_time`
      *     * `create_time`
      *     * `session_name`
+     *     * `is_pinned`
      *
      *   Example:
-     *   "update_time desc"
-     *   "create_time"
+     *
+     *   * "update_time desc"
+     *   * "create_time"
+     *   * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+     *      by update_time.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -817,55 +931,55 @@ export declare class ConversationalSearchServiceClient {
      */
     listSessionsAsync(request?: protos.google.cloud.discoveryengine.v1.IListSessionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.ISession>;
     /**
-     * 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.
@@ -1545,6 +1659,57 @@ export declare class ConversationalSearchServiceClient {
      * @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.
      *
@@ -2373,6 +2538,48 @@ export declare class ConversationalSearchServiceClient {
      * @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.
      *