@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230814 → 0.0.20230819

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: 20230814
+// Revision: 20230819
 
 /// <reference types="gapi.client" />
 
@@ -104,6 +104,11 @@ declare namespace gapi.client {
             functionName?:
                 string;
         }
+        interface GoogleCloudDiscoveryengineV1alphaAdditionalParams {
+            /** Token that used for non-human user check. */
+            token?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
             /** TargetSites created. */
             targetSites?:
@@ -136,6 +141,39 @@ declare namespace gapi.client {
             tableId?:
                 string;
         }
+        interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
+            /**
+             * Required. The parent data store resource name for which the completion is performed, such as
+             * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`.
+             */
+            dataStore?:
+                string;
+            /**
+             * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query,
+             * those are returned and no tail suggestions are returned.
+             */
+            includeTailSuggestions?:
+                boolean;
+            /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
+            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.
+             */
+            queryModel?:
+                string;
+            /**
+             * 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`. This should be the same
+             * identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
+             * `INVALID_ARGUMENT` error is returned.
+             */
+            userPseudoId?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse {
             /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
             querySuggestions?:
@@ -209,6 +247,14 @@ declare namespace gapi.client {
             /** The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. */
             conversation?:
                 GoogleCloudDiscoveryengineV1alphaConversation;
+            /**
+             * Required. The resource name of the Conversation to get. Format:
+             * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
+             * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a
+             * new conversation inside a ConverseConversation session.
+             */
+            name?:
+                string;
             /** Required. Current user input. */
             query?:
                 GoogleCloudDiscoveryengineV1alphaTextInput;
@@ -589,6 +635,16 @@ declare namespace gapi.client {
             schemas?:
                 GoogleCloudDiscoveryengineV1alphaSchema[];
         }
+        interface GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest {
+            /** Required. The UUID of the Widget Config. */
+            widgetConfigId?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse {
+            /** The Anonymous Widget Config associated with the UUID. */
+            anonymousWidgetConfig?:
+                GoogleCloudDiscoveryengineV1alphaWidgetConfig;
+        }
         interface GoogleCloudDiscoveryengineV1alphaMediaInfo {
             /**
              * The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be
@@ -932,6 +988,13 @@ declare namespace gapi.client {
             /** Whether to turn on safe search. This is only supported for website search. */
             safeSearch?:
                 boolean;
+            /**
+             * Required. The resource name of the Search serving config, such as
+             * `projects/*‍/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;
             /** The spell correction specification that specifies the mode under which spell correction takes effect. */
             spellCorrectionSpec?:
                 GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec;
@@ -1008,6 +1071,12 @@ declare namespace gapi.client {
              */
             maxExtractiveSegmentCount?:
                 number;
+            /** Return at most `num_next_segments` segments after each selected segments. */
+            numNextSegments?:
+                number;
+            /** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
+            numPreviousSegments?:
+                number;
             /** Specifies whether to return the confidence score from the extractive segments in each search result. The default value is `false`. */
             returnExtractiveSegmentScore?:
                 boolean;
@@ -1481,6 +1550,168 @@ declare namespace gapi.client {
             userId?:
                 string;
         }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest {
+            /** Additional params for security and privacy enhancement. */
+            additionalParams?:
+                GoogleCloudDiscoveryengineV1alphaAdditionalParams;
+            /** Required. The CompleteQuery request to perform auto-complete suggestion query. */
+            completeQueryRequest?:
+                GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest;
+            /** Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query. */
+            configId?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse {
+            /** The token in response. */
+            uToken?:
+                string;
+            /** Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion. */
+            widgetQuerySuggestions?:
+                GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion[];
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion {
+            /** The suggestion for the query. */
+            suggestion?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetConfig {
+            /** Allowlisted domains that can load this widget. */
+            allowlistedDomains?:
+                string[];
+            /**
+             * Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted
+             * backend server.
+             */
+            allowPublicAccess?:
+                boolean;
+            /** Output only. Unique obfuscated identifier of a WidgetConfig. */
+            configId?:
+                string;
+            /** The content search spec that configs the desired behavior of content search. */
+            contentSearchSpec?:
+                GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
+            /** Output only. Timestamp the WidgetConfig was created. */
+            createTime?:
+                string;
+            /** Output only. The type of the parent data store. */
+            dataStoreType?:
+                string;
+            /**
+             * Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
+             * INVALID_ARGUMENT error is returned.
+             */
+            displayName?:
+                string;
+            /** Whether or not to enable autocomplete. */
+            enableAutocomplete?:
+                boolean;
+            /** Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). */
+            enableConversationalSearch?:
+                boolean;
+            /** Turn on or off collecting the search result quality feedback from end users. */
+            enableQualityFeedback?:
+                boolean;
+            /** Whether to show the result score. */
+            enableResultScore?:
+                boolean;
+            /** Whether to enable safe search. */
+            enableSafeSearch?:
+                boolean;
+            /** Turn on or off summary for each snippets result. */
+            enableSnippetResultSummary?:
+                boolean;
+            /** Turn on or off summarization for the search response. */
+            enableSummarization?:
+                boolean;
+            /** The configuration and appearance of facets in the end user view. */
+            facetField?:
+                GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
+            /**
+             * The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device
+             * visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+             */
+            fieldsUiComponentsMap?:
+                { [P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField };
+            /** Output only. Whether LLM is enabled in the corresponding data store. */
+            llmEnabled?:
+                boolean;
+            /**
+             * Immutable. The full resource name of the widget config. Format:
+             * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a
+             * length limit of 1024 characters.
+             */
+            name?:
+                string;
+            /** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
+            solutionType?:
+                string;
+            /** Output only. Timestamp the WidgetConfig was updated. */
+            updateTime?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
+            /** Optional. The field name that end users will see. */
+            displayName?:
+                string;
+            /** Required. Registered field name. The format is `field.abc`. */
+            field?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
+            /** The field visibility on different types of devices. */
+            deviceVisibility?:
+                string[];
+            /** The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". */
+            displayTemplate?:
+                string;
+            /** Required. Registered field name. The format is `field.abc`. */
+            field?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest {
+            /** Additional params for security and privacy enhancement. */
+            additionalParams?:
+                GoogleCloudDiscoveryengineV1alphaAdditionalParams;
+            /** Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the user event collection. */
+            configId?:
+                string;
+            /** The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
+            conversationId?:
+                string;
+            /** Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default. */
+            converseConversationRequest?:
+                GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse {
+            /** The id of the Conversation returned. */
+            conversationId?:
+                string;
+            /** ConverseConversationResponse returned from ConversationalSearchService.ConverseConversation. */
+            converseConversationResponse?:
+                GoogleCloudDiscoveryengineV1alphaConverseConversationResponse;
+            /** The token in response. */
+            uToken?:
+                string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest {
+            /** Additional params for security and privacy enhancement. */
+            additionalParams?:
+                GoogleCloudDiscoveryengineV1alphaAdditionalParams;
+            /** Required. The UUID of the Search WidgetConfig. This field is used to identify the search widget configuration, set of models used to make the search. */
+            configId?:
+                string;
+            /** Required. The search request to perform search. */
+            searchRequest?:
+                GoogleCloudDiscoveryengineV1alphaSearchRequest;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse {
+            /** The search response after performing search. */
+            searchResponse?:
+                GoogleCloudDiscoveryengineV1alphaSearchResponse;
+            /** The token in response. */
+            uToken?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
             /** Operation create time. */
             createTime?:
@@ -1780,6 +2011,335 @@ declare namespace gapi.client {
             year?:
                 number;
         }
+        interface LocationsResource {
+            /** Gets the Widget Config using the uuid. */
+            lookupWidgetConfig(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;
+                /** Required. The location resource where lookup widget will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** 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:
+                    GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest;
+            }): Request<GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
+            lookupWidgetConfig(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;
+                /** Required. The location resource where lookup widget will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest): Request<GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
+            /**
+             * Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It
+             * supports CompleteQuery with or without JWT token.
+             */
+            widgetCompleteQuery(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;
+                /** Required. The location resource where widget complete query will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** 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:
+                    GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
+            }): Request<GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
+            widgetCompleteQuery(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;
+                /** Required. The location resource where widget complete query will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest): Request<GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
+            /** Converse a conversation with Widget. */
+            widgetConverseConversation(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;
+                /** Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** 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:
+                    GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
+            }): Request<GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
+            widgetConverseConversation(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;
+                /** Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest): Request<GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
+            /** Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token. */
+            widgetSearch(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;
+                /** Required. The location resource where widget search will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** 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:
+                    GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
+            }): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
+            widgetSearch(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;
+                /** Required. The location resource where widget search will be performed. Format: `locations/{location}` */
+                location:
+                    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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
+        }
         interface DocumentsResource {
             /** Creates a Document. */
             create(request: {
@@ -6594,6 +7154,8 @@ declare namespace gapi.client {
                 OperationsResource;
         }
 
+        const locations: LocationsResource;
+
         const projects: ProjectsResource;
     }
 }

package/package.json

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

package/readme.md

@@ -65,4 +65,24 @@ gapi.auth.authorize(
 After that you can use Discovery Engine API resources: <!-- TODO: make this work for multiple namespaces -->
 
 ```typescript
+
+/*
+Gets the Widget Config using the uuid.
+*/
+await gapi.client.discoveryengine.locations.lookupWidgetConfig({ location: "location",  });
+
+/*
+Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It supports CompleteQuery with or without JWT token.
+*/
+await gapi.client.discoveryengine.locations.widgetCompleteQuery({ location: "location",  });
+
+/*
+Converse a conversation with Widget.
+*/
+await gapi.client.discoveryengine.locations.widgetConverseConversation({ location: "location",  });
+
+/*
+Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token.
+*/
+await gapi.client.discoveryengine.locations.widgetSearch({ location: "location",  });
 ```

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: 20230814
+// Revision: 20230819
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -29,6 +29,208 @@ gapi.load('client', async () => {
     });
 
     async function run() {
+        /** Gets the Widget Config using the uuid. */
+        await gapi.client.discoveryengine.locations.lookupWidgetConfig({
+            location: "Test string",
+        }, {
+            widgetConfigId: "Test string",
+        });
+        /**
+         * Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It
+         * supports CompleteQuery with or without JWT token.
+         */
+        await gapi.client.discoveryengine.locations.widgetCompleteQuery({
+            location: "Test string",
+        }, {
+            additionalParams: {
+                token: "Test string",
+            },
+            completeQueryRequest: {
+                dataStore: "Test string",
+                includeTailSuggestions: true,
+                query: "Test string",
+                queryModel: "Test string",
+                userPseudoId: "Test string",
+            },
+            configId: "Test string",
+        });
+        /** Converse a conversation with Widget. */
+        await gapi.client.discoveryengine.locations.widgetConverseConversation({
+            location: "Test string",
+        }, {
+            additionalParams: {
+                token: "Test string",
+            },
+            configId: "Test string",
+            conversationId: "Test string",
+            converseConversationRequest: {
+                conversation: {
+                    endTime: "Test string",
+                    messages: [
+                        {
+                            createTime: "Test string",
+                            reply: {
+                                references: [
+                                    {
+                                        anchorText: "Test string",
+                                        end: 42,
+                                        start: 42,
+                                        uri: "Test string",
+                                    }
+                                ],
+                                reply: "Test string",
+                                summary: {
+                                    summarySkippedReasons: [
+                                        "Test string"
+                                    ],
+                                    summaryText: "Test string",
+                                },
+                            },
+                            userInput: {
+                                context: {
+                                    activeDocument: "Test string",
+                                    contextDocuments: [
+                                        "Test string"
+                                    ],
+                                },
+                                input: "Test string",
+                            },
+                        }
+                    ],
+                    name: "Test string",
+                    startTime: "Test string",
+                    state: "Test string",
+                    userPseudoId: "Test string",
+                },
+                name: "Test string",
+                query: {
+                    context: {
+                        activeDocument: "Test string",
+                        contextDocuments: [
+                            "Test string"
+                        ],
+                    },
+                    input: "Test string",
+                },
+                safeSearch: true,
+                servingConfig: "Test string",
+                userLabels: {
+                    A: "Test string"
+                },
+            },
+        });
+        /** Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token. */
+        await gapi.client.discoveryengine.locations.widgetSearch({
+            location: "Test string",
+        }, {
+            additionalParams: {
+                token: "Test string",
+            },
+            configId: "Test string",
+            searchRequest: {
+                boostSpec: {
+                    conditionBoostSpecs: [
+                        {
+                            boost: 42,
+                            condition: "Test string",
+                        }
+                    ],
+                },
+                branch: "Test string",
+                contentSearchSpec: {
+                    extractiveContentSpec: {
+                        maxExtractiveAnswerCount: 42,
+                        maxExtractiveSegmentCount: 42,
+                        numNextSegments: 42,
+                        numPreviousSegments: 42,
+                        returnExtractiveSegmentScore: true,
+                    },
+                    snippetSpec: {
+                        maxSnippetCount: 42,
+                        referenceOnly: true,
+                        returnSnippet: true,
+                    },
+                    summarySpec: {
+                        ignoreAdversarialQuery: true,
+                        ignoreNonSummarySeekingQuery: true,
+                        includeCitations: true,
+                        languageCode: "Test string",
+                        summaryResultCount: 42,
+                    },
+                },
+                embeddingSpec: {
+                    embeddingVectors: [
+                        {
+                            fieldPath: "Test string",
+                            vector: [
+                                42
+                            ],
+                        }
+                    ],
+                },
+                facetSpecs: [
+                    {
+                        enableDynamicPosition: true,
+                        excludedFilterKeys: [
+                            "Test string"
+                        ],
+                        facetKey: {
+                            caseInsensitive: true,
+                            contains: [
+                                "Test string"
+                            ],
+                            intervals: [
+                                {
+                                    exclusiveMaximum: 42,
+                                    exclusiveMinimum: 42,
+                                    maximum: 42,
+                                    minimum: 42,
+                                }
+                            ],
+                            key: "Test string",
+                            orderBy: "Test string",
+                            prefixes: [
+                                "Test string"
+                            ],
+                            restrictedValues: [
+                                "Test string"
+                            ],
+                        },
+                        limit: 42,
+                    }
+                ],
+                filter: "Test string",
+                imageQuery: {
+                    imageBytes: "Test string",
+                },
+                offset: 42,
+                orderBy: "Test string",
+                pageSize: 42,
+                pageToken: "Test string",
+                params: {
+                    A: 42
+                },
+                query: "Test string",
+                queryExpansionSpec: {
+                    condition: "Test string",
+                    pinUnexpandedResults: true,
+                },
+                rankingExpression: "Test string",
+                safeSearch: true,
+                servingConfig: "Test string",
+                spellCorrectionSpec: {
+                    mode: "Test string",
+                },
+                userInfo: {
+                    userAgent: "Test string",
+                    userId: "Test string",
+                },
+                userLabels: {
+                    A: "Test string"
+                },
+                userPseudoId: "Test string",
+            },
+        });
         /** Completes the specified user input with keyword suggestions. */
         await gapi.client.discoveryengine.projects.locations.collections.dataStores.completeQuery({
             dataStore: "Test string",
@@ -213,6 +415,7 @@ gapi.load('client', async () => {
                 state: "Test string",
                 userPseudoId: "Test string",
             },
+            name: "Test string",
             query: {
                 context: {
                     activeDocument: "Test string",
@@ -526,6 +729,8 @@ gapi.load('client', async () => {
                 extractiveContentSpec: {
                     maxExtractiveAnswerCount: 42,
                     maxExtractiveSegmentCount: 42,
+                    numNextSegments: 42,
+                    numPreviousSegments: 42,
                     returnExtractiveSegmentScore: true,
                 },
                 snippetSpec: {
@@ -600,6 +805,7 @@ gapi.load('client', async () => {
             },
             rankingExpression: "Test string",
             safeSearch: true,
+            servingConfig: "Test string",
             spellCorrectionSpec: {
                 mode: "Test string",
             },
@@ -1042,6 +1248,7 @@ gapi.load('client', async () => {
                 state: "Test string",
                 userPseudoId: "Test string",
             },
+            name: "Test string",
             query: {
                 context: {
                     activeDocument: "Test string",
@@ -1344,6 +1551,8 @@ gapi.load('client', async () => {
                 extractiveContentSpec: {
                     maxExtractiveAnswerCount: 42,
                     maxExtractiveSegmentCount: 42,
+                    numNextSegments: 42,
+                    numPreviousSegments: 42,
                     returnExtractiveSegmentScore: true,
                 },
                 snippetSpec: {
@@ -1418,6 +1627,7 @@ gapi.load('client', async () => {
             },
             rankingExpression: "Test string",
             safeSearch: true,
+            servingConfig: "Test string",
             spellCorrectionSpec: {
                 mode: "Test string",
             },