@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20230102

package/index.d.ts

@@ -0,0 +1,1415 @@
+/* Type definitions for non-npm package Discovery Engine API v1beta 0.0 */
+// Project: https://cloud.google.com/discovery-engine/docs
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// IMPORTANT
+// 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=v1beta
+// Revision: 20230102
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Discovery Engine API v1beta */
+    function load(urlOrObject: "https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "discoveryengine", version: "v1beta"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "discoveryengine", version: "v1beta", callback: () => any): void;
+
+    namespace discoveryengine {
+        interface GoogleApiHttpBody {
+            /** The HTTP Content-Type header value specifying the content type of the body. */
+            contentType?: string;
+            /** The HTTP request/response body as raw binary. */
+            data?: string;
+            /** Application specific response metadata. Must be set in the first response for streaming APIs. */
+            extensions?: Array<{ [P in string]: any }>;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
+            /** Operation create time. */
+            createTime?: string;
+            /** Count of entries that encountered errors while processing. */
+            failureCount?: string;
+            /** Count of entries that were processed successfully. */
+            successCount?: string;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse {
+            /** Echoes the destination for the complete errors in the request if set. */
+            errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
+            /** A sample of errors encountered while processing the request. */
+            errorSamples?: GoogleRpcStatus[];
+        }
+        interface GoogleCloudDiscoveryengineV1alphaImportErrorConfig {
+            /**
+             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a
+             * JSON-encoded `google.rpc.Status` message.
+             */
+            gcsPrefix?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata {
+            /** Operation create time. */
+            createTime?: string;
+            /** Count of entries that encountered errors while processing. */
+            failureCount?: string;
+            /** Count of entries that were processed successfully. */
+            successCount?: string;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse {
+            /** Echoes the destination for the complete errors if this field was set in the request. */
+            errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
+            /** A sample of errors encountered while processing the request. */
+            errorSamples?: GoogleRpcStatus[];
+            /** Count of user events imported with complete existing Documents. */
+            joinedEventsCount?: string;
+            /** Count of user events imported, but with Document information not found in the existing Branch. */
+            unjoinedEventsCount?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaBigQuerySource {
+            /**
+             * The schema to use when parsing the data from the source. Supported values for imports: * `user_event` (default): One JSON UserEvent per line. * `document` (default): One JSON
+             * Document per line. Each document must have a valid document.id.
+             */
+            dataSchema?: string;
+            /** Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */
+            datasetId?: string;
+            /**
+             * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud
+             * Storage directory.
+             */
+            gcsStagingDir?: string;
+            /** BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. */
+            partitionDate?: GoogleTypeDate;
+            /** The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
+            projectId?: string;
+            /** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
+            tableId?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaCompletionInfo {
+            /** End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0. */
+            selectedPosition?: number;
+            /** End user selected CompleteQueryResponse.CompletionResult.suggestion. */
+            selectedSuggestion?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaCustomAttribute {
+            /**
+             * The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT
+             * error is returned.
+             */
+            numbers?: number[];
+            /**
+             * The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
+             * returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
+             */
+            text?: string[];
+        }
+        interface GoogleCloudDiscoveryengineV1betaDocument {
+            /** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
+            id?: string;
+            /** The JSON string representation of the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown. */
+            jsonData?: string;
+            /**
+             * Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field
+             * must be a UTF-8 encoded string with a length limit of 1024 characters.
+             */
+            name?: string;
+            /**
+             * The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
+             * length limit of 63 characters.
+             */
+            parentDocumentId?: string;
+            /** Required. The identifier of the schema located in the same data store. */
+            schemaId?: string;
+            /** The structured JSON data for the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown. */
+            structData?: { [P in string]: any };
+        }
+        interface GoogleCloudDiscoveryengineV1betaDocumentInfo {
+            /** Required. The Document resource ID. */
+            id?: string;
+            /** Required. The Document resource full name, of the form: projects//locations//dataStores//branches//documents/ */
+            name?: string;
+            /** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
+            promotionIds?: string[];
+            /**
+             * Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart`
+             * event. Required for events of the following event types: * `add-to-cart` * `purchase`
+             */
+            quantity?: number;
+        }
+        interface GoogleCloudDiscoveryengineV1betaGcsSource {
+            /**
+             * The schema to use when parsing the data from the source. Supported values for imports: * `user_event` (default): One JSON UserEvent per line. * `document` (default): One JSON
+             * Document per line. Each document must have a valid Document.id.
+             */
+            dataSchema?: string;
+            /**
+             * Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a
+             * pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB.
+             */
+            inputUris?: string[];
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
+            /** Operation create time. */
+            createTime?: string;
+            /** Count of entries that encountered errors while processing. */
+            failureCount?: string;
+            /** Count of entries that were processed successfully. */
+            successCount?: string;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequest {
+            /** BigQuery input source. */
+            bigquerySource?: GoogleCloudDiscoveryengineV1betaBigQuerySource;
+            /** The desired location of errors incurred during the Import. */
+            errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
+            /** Cloud Storage location for the input content. */
+            gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
+            /** The Inline source for the input content for documents. */
+            inlineSource?: GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource;
+            /** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
+            reconciliationMode?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource {
+            /** Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */
+            documents?: GoogleCloudDiscoveryengineV1betaDocument[];
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportDocumentsResponse {
+            /** Echoes the destination for the complete errors in the request if set. */
+            errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
+            /** A sample of errors encountered while processing the request. */
+            errorSamples?: GoogleRpcStatus[];
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportErrorConfig {
+            /**
+             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a
+             * JSON-encoded `google.rpc.Status` message.
+             */
+            gcsPrefix?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata {
+            /** Operation create time. */
+            createTime?: string;
+            /** Count of entries that encountered errors while processing. */
+            failureCount?: string;
+            /** Count of entries that were processed successfully. */
+            successCount?: string;
+            /** Operation last update time. If the operation is done, this is also the finish time. */
+            updateTime?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportUserEventsRequest {
+            /** Required. BigQuery input source. */
+            bigquerySource?: GoogleCloudDiscoveryengineV1betaBigQuerySource;
+            /** The desired location of errors incurred during the Import. Cannot be set for inline user event imports. */
+            errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
+            /** Required. Cloud Storage location for the input content. */
+            gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
+            /** Required. The Inline source for the input content for UserEvents. */
+            inlineSource?: GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource;
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource {
+            /** Required. A list of user events to import. Recommended max of 10k items. */
+            userEvents?: GoogleCloudDiscoveryengineV1betaUserEvent[];
+        }
+        interface GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
+            /** Echoes the destination for the complete errors if this field was set in the request. */
+            errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
+            /** A sample of errors encountered while processing the request. */
+            errorSamples?: GoogleRpcStatus[];
+            /** Count of user events imported with complete existing Documents. */
+            joinedEventsCount?: string;
+            /** Count of user events imported, but with Document information not found in the existing Branch. */
+            unjoinedEventsCount?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaListDocumentsResponse {
+            /** The Documents. */
+            documents?: GoogleCloudDiscoveryengineV1betaDocument[];
+            /** A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaMediaInfo {
+            /**
+             * 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
+             * set to 90.
+             */
+            mediaProgressDuration?: string;
+            /**
+             * Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between [0, 1.0] inclusive. If this is not a playback
+             * or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.
+             */
+            mediaProgressPercentage?: number;
+        }
+        interface GoogleCloudDiscoveryengineV1betaPageInfo {
+            /**
+             * The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name,
+             * please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy:
+             * "pageCategory" : "Sales > 2017 Black Friday Deals". Required for `view-category-page` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
+             * returned.
+             */
+            pageCategory?: string;
+            /**
+             * A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple
+             * events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. When using the client
+             * side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
+             */
+            pageviewId?: string;
+            /**
+             * The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some
+             * browser privacy restrictions may cause this field to be empty.
+             */
+            referrerUri?: string;
+            /**
+             * Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in
+             * automatically. Maximum length 5,000 characters.
+             */
+            uri?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaPanelInfo {
+            /** The display name of the panel. */
+            displayName?: string;
+            /** Required. The panel ID. */
+            panelId?: string;
+            /** The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. */
+            panelPosition?: number;
+            /** The total number of panels, including this one, shown to the user. Must be set if panel_position is set. */
+            totalPanels?: number;
+        }
+        interface GoogleCloudDiscoveryengineV1betaRecommendRequest {
+            /**
+             * Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: *
+             * (filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold")) * (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green")) If your filter blocks all results, the
+             * API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive
+             * empty results instead. Note that the API will never return Documents with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
+             */
+            filter?: string;
+            /**
+             * Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed
+             * value is 100. Values above 100 will be coerced to 100.
+             */
+            pageSize?: number;
+            /**
+             * Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in
+             * RecommendResponse.results.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in
+             * RecommendResponse.results.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by
+             * default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`:
+             * String. Default empty. If set to be non-empty, then it needs to be one of: * 'no-diversity' * 'low-diversity' * 'medium-diversity' * 'high-diversity' * 'auto-diversity' This gives
+             * request-level control and adjusts recommendation results based on Document category.
+             */
+            params?: { [P in string]: any };
+            /**
+             * Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to
+             * userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for
+             * different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id
+             * to a random unique ID and leave UserEvent.user_info.user_id unset.
+             */
+            userEvent?: GoogleCloudDiscoveryengineV1betaUserEvent;
+            /**
+             * 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 [Requirements
+             * for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+             */
+            userLabels?: { [P in string]: string };
+            /**
+             * Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be
+             * used for testing the API, or if the model is not ready.
+             */
+            validateOnly?: boolean;
+        }
+        interface GoogleCloudDiscoveryengineV1betaRecommendResponse {
+            /** A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. */
+            attributionToken?: string;
+            /** IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. */
+            missingIds?: string[];
+            /** A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). */
+            results?: GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult[];
+            /** True if RecommendRequest.validate_only was set. */
+            validateOnly?: boolean;
+        }
+        interface GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult {
+            /** Set if `returnDocument` is set to true in RecommendRequest.params. */
+            document?: GoogleCloudDiscoveryengineV1betaDocument;
+            /** Resource ID of the recommended Document. */
+            id?: string;
+            /** Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
+            metadata?: { [P in string]: any };
+        }
+        interface GoogleCloudDiscoveryengineV1betaSearchInfo {
+            /**
+             * An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for
+             * definition. If this field is negative, an INVALID_ARGUMENT is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an
+             * INVALID_ARGUMENT error is returned.
+             */
+            offset?: number;
+            /**
+             * The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000
+             * characters. Otherwise, an INVALID_ARGUMENT error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT
+             * error is returned.
+             */
+            orderBy?: string;
+            /**
+             * The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT
+             * error is returned. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error
+             * is returned.
+             */
+            searchQuery?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaTransactionInfo {
+            /**
+             * All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax -
+             * cost
+             */
+            cost?: number;
+            /** Required. Currency code. Use three-character ISO-4217 code. */
+            currency?: string;
+            /**
+             * The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then
+             * nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless
+             * of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost
+             */
+            discountValue?: number;
+            /** All the taxes associated with the transaction. */
+            tax?: number;
+            /** The transaction ID with a length limit of 128 characters. */
+            transactionId?: string;
+            /** Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. */
+            value?: number;
+        }
+        interface GoogleCloudDiscoveryengineV1betaUserEvent {
+            /**
+             * Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.
+             * If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be
+             * consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving
+             * predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8
+             * encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded
+             * string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is
+             * traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
+             */
+            attributes?: { [P in string]: GoogleCloudDiscoveryengineV1betaCustomAttribute };
+            /**
+             * Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of PredictionService.Predict. This field enables
+             * accurate attribution of recommendation model performance. The value must be one of: * PredictResponse.attribution_token for events that are the result of PredictionService.Predict.
+             * * SearchResponse.attribution_token for events that are the result of SearchService.Search. * CompleteQueryResponse.attribution_token for events that are the result of
+             * SearchService.CompleteQuery. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this
+             * clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording
+             * events on product K's page, log the PredictResponse.attribution_token to this field.
+             */
+            attributionToken?: string;
+            /** CompleteQuery API details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
+            completionInfo?: GoogleCloudDiscoveryengineV1betaCompletionInfo;
+            /**
+             * Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be
+             * set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be
+             * set when using the JavaScript tag in UserEventService.CollectUserEvent.
+             */
+            directUserRequest?: boolean;
+            /**
+             * List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` *
+             * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page
+             * yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.
+             */
+            documents?: GoogleCloudDiscoveryengineV1betaDocumentInfo[];
+            /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
+            eventTime?: string;
+            /**
+             * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel
+             * or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: *
+             * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing
+             * a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.
+             */
+            eventType?: string;
+            /**
+             * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the
+             * associated SearchService.SearchRequest may contain a filter expression in SearchService.SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for
+             * `view-item-list` events that are generated from a PredictionService.PredictRequest, this field may be populated directly from PredictionService.PredictRequest.filter conforming to
+             * https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+             */
+            filter?: string;
+            /** Media-specific info. */
+            mediaInfo?: GoogleCloudDiscoveryengineV1betaMediaInfo;
+            /** Page metadata such as categories and other critical information for certain event types such as `view-category-page`. */
+            pageInfo?: GoogleCloudDiscoveryengineV1betaPageInfo;
+            /** Panel metadata associated with this user event. */
+            panel?: GoogleCloudDiscoveryengineV1betaPanelInfo;
+            /** The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. */
+            promotionIds?: string[];
+            /** Search API details related to the event. This field should be set for `search` event. */
+            searchInfo?: GoogleCloudDiscoveryengineV1betaSearchInfo;
+            /**
+             * A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to
+             * populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add
+             * UserEvent.user_pseudo_id as prefix.
+             */
+            sessionId?: string;
+            /**
+             * A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups
+             * on the customer end.
+             */
+            tagIds?: string[];
+            /** The transaction metadata (if any) associated with this user event. */
+            transactionInfo?: GoogleCloudDiscoveryengineV1betaTransactionInfo;
+            /** Information about the end user. */
+            userInfo?: GoogleCloudDiscoveryengineV1betaUserInfo;
+            /**
+             * Required. 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 log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event
+             * history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
+             * INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client
+             * ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
+             */
+            userPseudoId?: string;
+        }
+        interface GoogleCloudDiscoveryengineV1betaUserInfo {
+            /**
+             * User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters.
+             * Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent
+             * or if direct_user_request is set.
+             */
+            userAgent?: string;
+            /**
+             * Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set
+             * the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded
+             * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+             */
+            userId?: string;
+        }
+        interface GoogleLongrunningListOperationsResponse {
+            /** The standard List next-page token. */
+            nextPageToken?: string;
+            /** A list of operations that matches the specified filter in the request. */
+            operations?: GoogleLongrunningOperation[];
+        }
+        interface GoogleLongrunningOperation {
+            /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
+            done?: boolean;
+            /** The error result of the operation in case of failure or cancellation. */
+            error?: GoogleRpcStatus;
+            /**
+             * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
+             * metadata. Any method that returns a long-running operation should document the metadata type, if any.
+             */
+            metadata?: { [P in string]: any };
+            /**
+             * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
+             * with `operations/{unique_id}`.
+             */
+            name?: string;
+            /**
+             * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
+             * original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
+             * original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+             */
+            response?: { [P in string]: any };
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface GoogleProtobufEmpty {
+        }
+        interface GoogleRpcStatus {
+            /** The status code, which should be an enum value of google.rpc.Code. */
+            code?: number;
+            /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
+            details?: Array<{ [P in string]: any }>;
+            /**
+             * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
+             * client.
+             */
+            message?: string;
+        }
+        interface GoogleTypeDate {
+            /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
+            day?: number;
+            /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
+            month?: number;
+            /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
+            year?: number;
+        }
+        interface DocumentsResource {
+            /** Creates a Document. */
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /**
+                 * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
+                 * of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is
+                 * returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is
+                 * returned.
+                 */
+                documentId?: 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;
+                /** Required. The parent resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. */
+                parent: 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: GoogleCloudDiscoveryengineV1betaDocument;
+            }): Request<GoogleCloudDiscoveryengineV1betaDocument>;
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /**
+                 * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
+                 * of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is
+                 * returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is
+                 * returned.
+                 */
+                documentId?: 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;
+                /** Required. The parent resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. */
+                parent: 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: GoogleCloudDiscoveryengineV1betaDocument): Request<GoogleCloudDiscoveryengineV1betaDocument>;
+            /** Deletes a Document. */
+            delete(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. Full resource name of Document, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does
+                 * not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND
+                 * error is returned.
+                 */
+                name: 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<{}>;
+            /** Gets a Document. */
+            get(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. Full resource name of Document, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does
+                 * not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND
+                 * error is returned.
+                 */
+                name: 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<GoogleCloudDiscoveryengineV1betaDocument>;
+            /**
+             * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully
+             * updated.
+             */
+            import(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;
+                /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. */
+                parent: 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: GoogleCloudDiscoveryengineV1betaImportDocumentsRequest;
+            }): Request<GoogleLongrunningOperation>;
+            import(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;
+                /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. */
+                parent: 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: GoogleCloudDiscoveryengineV1betaImportDocumentsRequest): Request<GoogleLongrunningOperation>;
+            /** Gets a list of Documents. */
+            list(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;
+                /**
+                 * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative,
+                 * an INVALID_ARGUMENT error is returned.
+                 */
+                pageSize?: number;
+                /**
+                 * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating,
+                 * all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
+                 */
+                pageToken?: string;
+                /**
+                 * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to
+                 * list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a
+                 * PERMISSION_DENIED error is returned.
+                 */
+                parent: 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<GoogleCloudDiscoveryengineV1betaListDocumentsResponse>;
+            /** Updates a Document. */
+            patch(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** If set to true, and the Document is not found, a new Document will be created. */
+                allowMissing?: boolean;
+                /** 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;
+                /**
+                 * Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This
+                 * field must be a UTF-8 encoded string with a length limit of 1024 characters.
+                 */
+                name: 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: GoogleCloudDiscoveryengineV1betaDocument;
+            }): Request<GoogleCloudDiscoveryengineV1betaDocument>;
+            patch(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** If set to true, and the Document is not found, a new Document will be created. */
+                allowMissing?: boolean;
+                /** 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;
+                /**
+                 * Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This
+                 * field must be a UTF-8 encoded string with a length limit of 1024 characters.
+                 */
+                name: 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: GoogleCloudDiscoveryengineV1betaDocument): Request<GoogleCloudDiscoveryengineV1betaDocument>;
+        }
+        interface OperationsResource {
+            /** 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. */
+            get(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;
+                /** The name of the operation resource. */
+                name: 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<GoogleLongrunningOperation>;
+            /**
+             * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
+             * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
+             * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
+             * ensure the name binding is the parent resource, without the operations collection id.
+             */
+            list(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;
+                /** The standard list filter. */
+                filter?: 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;
+                /** The name of the operation's parent resource. */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** The standard list page size. */
+                pageSize?: number;
+                /** The standard list page token. */
+                pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+        }
+        interface BranchesResource {
+            documents: DocumentsResource;
+            operations: OperationsResource;
+        }
+        interface OperationsResource {
+            /** 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. */
+            get(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;
+                /** The name of the operation resource. */
+                name: 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<GoogleLongrunningOperation>;
+            /**
+             * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
+             * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
+             * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
+             * ensure the name binding is the parent resource, without the operations collection id.
+             */
+            list(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;
+                /** The standard list filter. */
+                filter?: 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;
+                /** The name of the operation's parent resource. */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** The standard list page size. */
+                pageSize?: number;
+                /** The standard list page token. */
+                pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+        }
+        interface ModelsResource {
+            operations: OperationsResource;
+        }
+        interface OperationsResource {
+            /** 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. */
+            get(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;
+                /** The name of the operation resource. */
+                name: 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<GoogleLongrunningOperation>;
+            /**
+             * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
+             * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
+             * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
+             * ensure the name binding is the parent resource, without the operations collection id.
+             */
+            list(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;
+                /** The standard list filter. */
+                filter?: 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;
+                /** The name of the operation's parent resource. */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** The standard list page size. */
+                pageSize?: number;
+                /** The standard list page token. */
+                pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+        }
+        interface ServingConfigsResource {
+            /** Makes a recommendation, which requires a contextual user event. */
+            recommend(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 format: projects/*‍/locations/global/dataStores/*‍/servingConfigs/* Before you can request recommendations from your model, you must create
+                 * at least one serving config for it.
+                 */
+                servingConfig: 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: GoogleCloudDiscoveryengineV1betaRecommendRequest;
+            }): Request<GoogleCloudDiscoveryengineV1betaRecommendResponse>;
+            recommend(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 format: projects/*‍/locations/global/dataStores/*‍/servingConfigs/* Before you can request recommendations from your model, you must create
+                 * at least one serving config for it.
+                 */
+                servingConfig: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: GoogleCloudDiscoveryengineV1betaRecommendRequest): Request<GoogleCloudDiscoveryengineV1betaRecommendResponse>;
+        }
+        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 3rd 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.
+             */
+            collect(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
+                ets?: 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;
+                /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`. */
+                parent: 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;
+                /**
+                 * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
+                 * only send the domain for 3rd party requests.
+                 */
+                uri?: string;
+                /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
+                userEvent?: string;
+            }): Request<GoogleApiHttpBody>;
+            /**
+             * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
+             * Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
+             */
+            import(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;
+                /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/dataStores/{data_store}` */
+                parent: 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: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest;
+            }): Request<GoogleLongrunningOperation>;
+            import(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;
+                /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/dataStores/{data_store}` */
+                parent: 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: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
+            /** Writes a single user event. */
+            write(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;
+                /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`. */
+                parent: 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: GoogleCloudDiscoveryengineV1betaUserEvent;
+            }): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
+            write(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;
+                /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`. */
+                parent: 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: GoogleCloudDiscoveryengineV1betaUserEvent): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
+        }
+        interface DataStoresResource {
+            branches: BranchesResource;
+            models: ModelsResource;
+            operations: OperationsResource;
+            servingConfigs: ServingConfigsResource;
+            userEvents: UserEventsResource;
+        }
+        interface OperationsResource {
+            /** 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. */
+            get(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;
+                /** The name of the operation resource. */
+                name: 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<GoogleLongrunningOperation>;
+            /**
+             * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
+             * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
+             * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
+             * ensure the name binding is the parent resource, without the operations collection id.
+             */
+            list(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;
+                /** The standard list filter. */
+                filter?: 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;
+                /** The name of the operation's parent resource. */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** The standard list page size. */
+                pageSize?: number;
+                /** The standard list page token. */
+                pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+        }
+        interface LocationsResource {
+            dataStores: DataStoresResource;
+            operations: OperationsResource;
+        }
+        interface OperationsResource {
+            /** 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. */
+            get(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;
+                /** The name of the operation resource. */
+                name: 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<GoogleLongrunningOperation>;
+            /**
+             * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
+             * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
+             * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
+             * ensure the name binding is the parent resource, without the operations collection id.
+             */
+            list(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;
+                /** The standard list filter. */
+                filter?: 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;
+                /** The name of the operation's parent resource. */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** The standard list page size. */
+                pageSize?: number;
+                /** The standard list page token. */
+                pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+        }
+        interface ProjectsResource {
+            locations: LocationsResource;
+            operations: OperationsResource;
+        }
+
+        const projects: ProjectsResource;
+    }
+}