@google-cloud/discoveryengine 1.0.0 → 1.2.0

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type * as gax from 'google-gax';
-import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
 import { Transform } from 'stream';
 import * as protos from '../../protos/protos';
 /**
@@ -22,6 +22,7 @@ export declare class SearchServiceClient {
     innerApiCalls: {
         [name: string]: Function;
     };
+    locationsClient: LocationsClient;
     pathTemplates: {
         [name: string]: gax.PathTemplate;
     };
@@ -56,8 +57,7 @@ export declare class SearchServiceClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -65,7 +65,7 @@ export declare class SearchServiceClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new SearchServiceClient({fallback: 'rest'}, gax);
+     *     const client = new SearchServiceClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
@@ -125,10 +125,12 @@ export declare class SearchServiceClient {
      *   documents under the default branch.
      * @param {string} request.query
      *   Raw search query.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
+     *   Raw image query.
      * @param {number} request.pageSize
      *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to a reasonable value. The maximum allowed
-     *   value is 100. Values above 100 will be coerced to 100.
+     *   value is 100. Values above 100 are coerced to 100.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      * @param {string} request.pageToken
@@ -149,10 +151,31 @@ export declare class SearchServiceClient {
      *   unset.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @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.
+     * @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.v1.Document|Document} object.
+     *   Leave it unset if ordered by relevance. `order_by` expression is
+     *   case-sensitive.
+     *
+     *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics. The user_agent string in UserInfo will
-     *   be used to deduce device_type for analytics.
+     *   Highly recommended for analytics.
+     *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
+     *   is used to deduce `device_type` for analytics.
+     * @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.v1.SearchRequest.BoostSpec} request.boostSpec
+     *   Boost specification to boost certain documents.
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -165,10 +188,10 @@ export declare class SearchServiceClient {
      *     which enables image searching.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
-     *   query expansion will occur.
+     *   query expansion occurs.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
      *   The spell correction specification that specifies the mode under
-     *   which spell correction will take effect.
+     *   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
@@ -185,11 +208,10 @@ export declare class SearchServiceClient {
      *   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.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
-     *   The content search spec that configs the desired behavior of content
-     *   search.
+     *   A specification for configuring the behavior of content search.
      * @param {boolean} request.safeSearch
      *   Whether to turn on safe search. This is only supported for
-     *   {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
+     *   website search.
      * @param {number[]} request.userLabels
      *   The user labels applied to a resource must meet the following requirements:
      *
@@ -244,10 +266,12 @@ export declare class SearchServiceClient {
      *   documents under the default branch.
      * @param {string} request.query
      *   Raw search query.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
+     *   Raw image query.
      * @param {number} request.pageSize
      *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to a reasonable value. The maximum allowed
-     *   value is 100. Values above 100 will be coerced to 100.
+     *   value is 100. Values above 100 are coerced to 100.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      * @param {string} request.pageToken
@@ -268,10 +292,31 @@ export declare class SearchServiceClient {
      *   unset.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @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.
+     * @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.v1.Document|Document} object.
+     *   Leave it unset if ordered by relevance. `order_by` expression is
+     *   case-sensitive.
+     *
+     *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics. The user_agent string in UserInfo will
-     *   be used to deduce device_type for analytics.
+     *   Highly recommended for analytics.
+     *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
+     *   is used to deduce `device_type` for analytics.
+     * @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.v1.SearchRequest.BoostSpec} request.boostSpec
+     *   Boost specification to boost certain documents.
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -284,10 +329,10 @@ export declare class SearchServiceClient {
      *     which enables image searching.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
-     *   query expansion will occur.
+     *   query expansion occurs.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
      *   The spell correction specification that specifies the mode under
-     *   which spell correction will take effect.
+     *   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
@@ -304,11 +349,10 @@ export declare class SearchServiceClient {
      *   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.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
-     *   The content search spec that configs the desired behavior of content
-     *   search.
+     *   A specification for configuring the behavior of content search.
      * @param {boolean} request.safeSearch
      *   Whether to turn on safe search. This is only supported for
-     *   {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
+     *   website search.
      * @param {number[]} request.userLabels
      *   The user labels applied to a resource must meet the following requirements:
      *
@@ -358,10 +402,12 @@ export declare class SearchServiceClient {
      *   documents under the default branch.
      * @param {string} request.query
      *   Raw search query.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
+     *   Raw image query.
      * @param {number} request.pageSize
      *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to a reasonable value. The maximum allowed
-     *   value is 100. Values above 100 will be coerced to 100.
+     *   value is 100. Values above 100 are coerced to 100.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      * @param {string} request.pageToken
@@ -382,10 +428,31 @@ export declare class SearchServiceClient {
      *   unset.
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @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.
+     * @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.v1.Document|Document} object.
+     *   Leave it unset if ordered by relevance. `order_by` expression is
+     *   case-sensitive.
+     *
+     *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics. The user_agent string in UserInfo will
-     *   be used to deduce device_type for analytics.
+     *   Highly recommended for analytics.
+     *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
+     *   is used to deduce `device_type` for analytics.
+     * @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.v1.SearchRequest.BoostSpec} request.boostSpec
+     *   Boost specification to boost certain documents.
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -398,10 +465,10 @@ export declare class SearchServiceClient {
      *     which enables image searching.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
-     *   query expansion will occur.
+     *   query expansion occurs.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
      *   The spell correction specification that specifies the mode under
-     *   which spell correction will take effect.
+     *   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
@@ -418,11 +485,10 @@ export declare class SearchServiceClient {
      *   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.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
-     *   The content search spec that configs the desired behavior of content
-     *   search.
+     *   A specification for configuring the behavior of content search.
      * @param {boolean} request.safeSearch
      *   Whether to turn on safe search. This is only supported for
-     *   {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
+     *   website search.
      * @param {number[]} request.userLabels
      *   The user labels applied to a resource must meet the following requirements:
      *
@@ -454,6 +520,57 @@ export declare class SearchServiceClient {
      * region_tag:discoveryengine_v1_generated_SearchService_Search_async
      */
     searchAsync(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.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);
+     * ```
+     */
+    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
+     * }
+     * ```
+     */
+    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
      *
@@ -565,6 +682,57 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
      *
@@ -760,6 +928,48 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSchema resource name string.
      *