@google-cloud/discoveryengine 2.1.0 → 2.2.0

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;
@@ -640,49 +640,49 @@ export declare class ConversationalSearchServiceClient {
      */
     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.
-     */
+    * 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,
@@ -778,54 +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`
-     *     * `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.
-     */
+    * 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,
@@ -931,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.