@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230914 → 0.0.20230928

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20230914
+// Revision: 20230928
 
 /// <reference types="gapi.client" />
 
@@ -161,7 +161,7 @@ declare namespace gapi.client {
              * 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.
+             * is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
              */
             queryModel?:
                 string;
@@ -845,6 +845,61 @@ declare namespace gapi.client {
             metadata?:
                 { [P in string]: any };
         }
+        interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
+            /** Operation create time. */
+            createTime?:
+                string;
+            /** 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[];
+            /** Total number of URIs that have yet to be crawled. */
+            pendingCount?:
+                number;
+            /** Total number of URIs that were rejected due to insufficient indexing resources. */
+            quotaExceededCount?:
+                number;
+            /** Total number of URIs that have been crawled so far. */
+            successCount?:
+                number;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?:
+                string;
+            /** Total number of unique URIs in the request that are not in invalid_uris. */
+            validUrisCount?:
+                number;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest {
+            /**
+             * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in
+             * `site_search_engine`.
+             */
+            uris?:
+                string[];
+        }
+        interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
+            /** URIs that were not crawled before the LRO terminated. */
+            failedUris?:
+                string[];
+            /** Details for a sample of up to 10 `failed_uris`. */
+            failureSamples?:
+                GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
+        }
+        interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
+            /** List of failure reasons by corpus type (e.g. desktop, mobile). */
+            failureReasons?:
+                GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
+            /** URI that failed to be crawled. */
+            uri?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
+            /** DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. */
+            corpusType?:
+                string;
+            /** Reason why the URI was not crawled. */
+            errorMessage?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1alphaReply {
             /** References in the reply. */
             references?:
@@ -1246,6 +1301,8 @@ declare namespace gapi.client {
             /** Results of facets requested by user. */
             facets?:
                 GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[];
+            geoSearchDebugInfo?:
+                GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[];
             /** Guided search result. */
             guidedSearchResult?:
                 GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult;
@@ -1290,6 +1347,14 @@ declare namespace gapi.client {
             value?:
                 string;
         }
+        interface GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo {
+            /** The error produced. */
+            errorMessage?:
+                string;
+            /** The address from which forward geocoding ingestion produced issues. */
+            originalAddressQuery?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult {
             /** Suggested follow-up questions. */
             followUpQuestions?:
@@ -1651,6 +1716,12 @@ declare namespace gapi.client {
              */
             name?:
                 string;
+            /**
+             * The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new
+             * enterprise search users.
+             */
+            resultDisplayType?:
+                string;
             /** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
             solutionType?:
                 string;
@@ -4304,6 +4375,87 @@ declare namespace gapi.client {
                 OperationsResource;
         }
         interface SiteSearchEngineResource {
+            /** Request on-demand recrawl for a list of URIs. */
+            recrawlUris(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
+                siteSearchEngine:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
+            }): Request<GoogleLongrunningOperation>;
+            recrawlUris(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
+                siteSearchEngine:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest): Request<GoogleLongrunningOperation>;
             operations:
                 OperationsResource;
             targetSites:
@@ -4666,7 +4818,7 @@ declare namespace gapi.client {
                  * 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.
+                 * * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
                  */
                 queryModel?:
                     string;
@@ -6576,6 +6728,89 @@ declare namespace gapi.client {
             },
             body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
         }
+        interface SiteSearchEngineResource {
+            /** Request on-demand recrawl for a list of URIs. */
+            recrawlUris(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
+                siteSearchEngine:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
+            }): Request<GoogleLongrunningOperation>;
+            recrawlUris(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
+                siteSearchEngine:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest): Request<GoogleLongrunningOperation>;
+        }
         interface UserEventsResource {
             /**
              * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery
@@ -6933,7 +7168,7 @@ declare namespace gapi.client {
                  * 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.
+                 * * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
                  */
                 queryModel?:
                     string;
@@ -6967,6 +7202,8 @@ declare namespace gapi.client {
                 SchemasResource;
             servingConfigs:
                 ServingConfigsResource;
+            siteSearchEngine:
+                SiteSearchEngineResource;
             userEvents:
                 UserEventsResource;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20230914",
+  "version": "0.0.20230928",
   "description": "TypeScript typings for Discovery Engine API v1alpha",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230914
+// Revision: 20230928
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -862,6 +862,14 @@ gapi.load('client', async () => {
             },
             userPseudoId: "Test string",
         });
+        /** Request on-demand recrawl for a list of URIs. */
+        await gapi.client.discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris({
+            siteSearchEngine: "Test string",
+        }, {
+            uris: [
+                "Test string"
+            ],
+        });
         /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
         await gapi.client.discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get({
             name: "Test string",
@@ -1714,6 +1722,14 @@ gapi.load('client', async () => {
             },
             userPseudoId: "Test string",
         });
+        /** Request on-demand recrawl for a list of URIs. */
+        await gapi.client.discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris({
+            siteSearchEngine: "Test string",
+        }, {
+            uris: [
+                "Test string"
+            ],
+        });
         /**
          * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine
          * API JavaScript pixel and Google Tag Manager. Users should not call this method directly.