@googleapis/discoveryengine 1.2.0 → 2.0.0

package/build/v1beta.d.ts

@@ -417,6 +417,78 @@ export declare namespace discoveryengine_v1beta {
          */
         purgeCount?: string | null;
     }
+    /**
+     * Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
+        /**
+         * Operation create time.
+         */
+        createTime?: string | null;
+        /**
+         * Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.
+         */
+        invalidUris?: string[] | null;
+        /**
+         * Total number of URIs that have yet to be crawled.
+         */
+        pendingCount?: number | null;
+        /**
+         * Total number of URIs that were rejected due to insufficient indexing resources.
+         */
+        quotaExceededCount?: number | null;
+        /**
+         * Total number of URIs that have been crawled so far.
+         */
+        successCount?: number | null;
+        /**
+         * Operation last update time. If the operation is done, this is also the finish time.
+         */
+        updateTime?: string | null;
+        /**
+         * Total number of unique URIs in the request that are not in invalid_uris.
+         */
+        validUrisCount?: number | null;
+    }
+    /**
+     * Response message for SiteSearchEngineService.RecrawlUris method.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
+        /**
+         * URIs that were not crawled before the LRO terminated.
+         */
+        failedUris?: string[] | null;
+        /**
+         * Details for a sample of up to 10 `failed_uris`.
+         */
+        failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
+    }
+    /**
+     * Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
+        /**
+         * List of failure reasons by corpus type (e.g. desktop, mobile).
+         */
+        failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
+        /**
+         * URI that failed to be crawled.
+         */
+        uri?: string | null;
+    }
+    /**
+     * Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
+        /**
+         * DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
+         */
+        corpusType?: string | null;
+        /**
+         * Reason why the URI was not crawled.
+         */
+        errorMessage?: string | null;
+    }
     /**
      * Defines the structure and layout of a type of document data.
      */
@@ -504,10 +576,6 @@ export declare namespace discoveryengine_v1beta {
         quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
     }
     export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
-        /**
-         * This number is an estimation on how much total quota this project needs to successfully complete indexing.
-         */
-        totalRequiredQuota?: string | null;
     }
     /**
      * Metadata for UpdateSchema LRO.
@@ -571,7 +639,7 @@ export declare namespace discoveryengine_v1beta {
         /**
          * The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.
          */
-        completableFieldPath?: string[] | null;
+        completableFieldPaths?: string[] | null;
         /**
          * The suggestion for the query.
          */
@@ -669,6 +737,10 @@ export declare namespace discoveryengine_v1beta {
          * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used.
          */
         servingConfig?: string | null;
+        /**
+         * A specification for configuring the summary returned in the response.
+         */
+        summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec;
         /**
          * 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.
          */
@@ -1448,9 +1520,13 @@ export declare namespace discoveryengine_v1beta {
          */
         maxExtractiveSegmentCount?: number | null;
         /**
-         * Specifies whether to return the confidence score from the extractive segments in each search result. The default value is `false`.
+         * Return at most `num_next_segments` segments after each selected segments.
+         */
+        numNextSegments?: number | null;
+        /**
+         * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
          */
-        returnExtractiveSegmentScore?: boolean | null;
+        numPreviousSegments?: number | null;
     }
     /**
      * A specification for configuring snippets in a search response.
@@ -1486,7 +1562,7 @@ export declare namespace discoveryengine_v1beta {
          */
         includeCitations?: boolean | null;
         /**
-         * Language code for Summary. Use language tags defined by BCP47.
+         * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
          */
         languageCode?: string | null;
         /**
@@ -1621,6 +1697,7 @@ export declare namespace discoveryengine_v1beta {
          * Results of facets requested by user.
          */
         facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[];
+        geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[];
         /**
          * Guided search result.
          */
@@ -1684,6 +1761,19 @@ export declare namespace discoveryengine_v1beta {
          */
         value?: string | null;
     }
+    /**
+     * Debug information specifically related to forward geocoding issues arising from Geolocation Search.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo {
+        /**
+         * The error produced.
+         */
+        errorMessage?: string | null;
+        /**
+         * The address from which forward geocoding ingestion produced issues.
+         */
+        originalAddressQuery?: string | null;
+    }
     /**
      * Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.
      */
@@ -1746,6 +1836,10 @@ export declare namespace discoveryengine_v1beta {
      * Summary of the top N search result specified by the summary spec.
      */
     export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary {
+        /**
+         * A collection of Safety Attribute categories and their associated confidence scores.
+         */
+        safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes;
         /**
          * Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
          */
@@ -1755,6 +1849,19 @@ export declare namespace discoveryengine_v1beta {
          */
         summaryText?: string | null;
     }
+    /**
+     * Safety Attribute categories and their associated confidence scores.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes {
+        /**
+         * The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
+         */
+        categories?: string[] | null;
+        /**
+         * The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
+         */
+        scores?: number[] | null;
+    }
     /**
      * Defines text input.
      */
@@ -2222,7 +2329,7 @@ export declare namespace discoveryengine_v1beta {
          */
         query?: string;
         /**
-         * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
+         * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
          */
         queryModel?: string;
         /**
@@ -3188,6 +3295,7 @@ export declare namespace discoveryengine_v1beta {
     export class Resource$Projects$Locations$Collections$Engines {
         context: APIRequestContext;
         operations: Resource$Projects$Locations$Collections$Engines$Operations;
+        servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
         constructor(context: APIRequestContext);
     }
     export class Resource$Projects$Locations$Collections$Engines$Operations {
@@ -3246,6 +3354,58 @@ export declare namespace discoveryengine_v1beta {
          */
         pageToken?: string;
     }
+    export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
+        context: APIRequestContext;
+        constructor(context: APIRequestContext);
+        /**
+         * Makes a recommendation, which requires a contextual user event.
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions): GaxiosPromise<Readable>;
+        recommend(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
+        recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
+        recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
+        recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
+        /**
+         * Performs a search.
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
+        search(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>;
+        search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
+        search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
+        search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
+    }
+    export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
+        /**
+         * Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it.
+         */
+        servingConfig?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest;
+    }
+    export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
+        /**
+         * Required. The resource name of the Search serving config, such as `projects/x/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.
+         */
+        servingConfig?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
+    }
     export class Resource$Projects$Locations$Collections$Operations {
         context: APIRequestContext;
         constructor(context: APIRequestContext);
@@ -3341,7 +3501,7 @@ export declare namespace discoveryengine_v1beta {
          */
         query?: string;
         /**
-         * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.
+         * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
          */
         queryModel?: string;
         /**

package/build/v1beta.js

@@ -1351,6 +1351,8 @@ var discoveryengine_v1beta;
             this.context = context;
             this.operations =
                 new Resource$Projects$Locations$Collections$Engines$Operations(this.context);
+            this.servingConfigs =
+                new Resource$Projects$Locations$Collections$Engines$Servingconfigs(this.context);
         }
     }
     discoveryengine_v1beta.Resource$Projects$Locations$Collections$Engines = Resource$Projects$Locations$Collections$Engines;
@@ -1424,6 +1426,76 @@ var discoveryengine_v1beta;
         }
     }
     discoveryengine_v1beta.Resource$Projects$Locations$Collections$Engines$Operations = Resource$Projects$Locations$Collections$Engines$Operations;
+    class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
+        constructor(context) {
+            this.context = context;
+        }
+        recommend(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params =
+                    {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'POST',
+                }, options),
+                params,
+                requiredParams: ['servingConfig'],
+                pathParams: ['servingConfig'],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
+        search(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params =
+                    {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/v1beta/{+servingConfig}:search').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'POST',
+                }, options),
+                params,
+                requiredParams: ['servingConfig'],
+                pathParams: ['servingConfig'],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
+    }
+    discoveryengine_v1beta.Resource$Projects$Locations$Collections$Engines$Servingconfigs = Resource$Projects$Locations$Collections$Engines$Servingconfigs;
     class Resource$Projects$Locations$Collections$Operations {
         constructor(context) {
             this.context = context;