@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230925 → 0.0.20231003

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20230925
+// Revision: 20231003
 
 /// <reference types="gapi.client" />
 
@@ -1301,6 +1301,8 @@ declare namespace gapi.client {
             /** Results of facets requested by user. */
             facets?:
                 GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[];
+            geoSearchDebugInfo?:
+                GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[];
             /** Guided search result. */
             guidedSearchResult?:
                 GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult;
@@ -1345,6 +1347,14 @@ declare namespace gapi.client {
             value?:
                 string;
         }
+        interface GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo {
+            /** The error produced. */
+            errorMessage?:
+                string;
+            /** The address from which forward geocoding ingestion produced issues. */
+            originalAddressQuery?:
+                string;
+        }
         interface GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult {
             /** Suggested follow-up questions. */
             followUpQuestions?:
@@ -1699,6 +1709,9 @@ declare namespace gapi.client {
             /** Output only. Whether LLM is enabled in the corresponding data store. */
             llmEnabled?:
                 boolean;
+            /** Output only. Whether the customer accepted data use terms. */
+            minimumDataTermAccepted?:
+                boolean;
             /**
              * Immutable. The full resource name of the widget config. Format:
              * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a
@@ -1706,6 +1719,12 @@ declare namespace gapi.client {
              */
             name?:
                 string;
+            /**
+             * The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new
+             * enterprise search users.
+             */
+            resultDisplayType?:
+                string;
             /** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
             solutionType?:
                 string;
@@ -4930,9 +4949,189 @@ declare namespace gapi.client {
                     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/collections/*‍/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:
+                    GoogleCloudDiscoveryengineV1alphaRecommendRequest;
+            }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
+            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/collections/*‍/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: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
+            /** Performs a search. */
+            search(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. The resource name of the Search serving config, such as
+                 * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
+                 * configuration name, set of models used to make the search.
+                 */
+                servingConfig:
+                    string;
+                /** 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:
+                    GoogleCloudDiscoveryengineV1alphaSearchRequest;
+            }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
+            search(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. The resource name of the Search serving config, such as
+                 * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
+                 * configuration name, set of models used to make the search.
+                 */
+                servingConfig:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
+        }
         interface EnginesResource {
             operations:
                 OperationsResource;
+            servingConfigs:
+                ServingConfigsResource;
         }
         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. */

package/package.json

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

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230925
+// Revision: 20231003
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -1105,6 +1105,198 @@ gapi.load('client', async () => {
             pageSize: 42,
             pageToken: "Test string",
         });
+        /** Makes a recommendation, which requires a contextual user event. */
+        await gapi.client.discoveryengine.projects.locations.collections.engines.servingConfigs.recommend({
+            servingConfig: "Test string",
+        }, {
+            filter: "Test string",
+            pageSize: 42,
+            params: {
+                A: 42
+            },
+            userEvent: {
+                attributes: {
+                    A: {
+                        numbers: [
+                            42
+                        ],
+                        text: [
+                            "Test string"
+                        ],
+                    }
+                },
+                attributionToken: "Test string",
+                completionInfo: {
+                    selectedPosition: 42,
+                    selectedSuggestion: "Test string",
+                },
+                directUserRequest: true,
+                documents: [
+                    {
+                        id: "Test string",
+                        name: "Test string",
+                        promotionIds: [
+                            "Test string"
+                        ],
+                        quantity: 42,
+                        uri: "Test string",
+                    }
+                ],
+                eventTime: "Test string",
+                eventType: "Test string",
+                filter: "Test string",
+                mediaInfo: {
+                    mediaProgressDuration: "Test string",
+                    mediaProgressPercentage: 42,
+                },
+                pageInfo: {
+                    pageCategory: "Test string",
+                    pageviewId: "Test string",
+                    referrerUri: "Test string",
+                    uri: "Test string",
+                },
+                panel: {
+                    displayName: "Test string",
+                    panelId: "Test string",
+                    panelPosition: 42,
+                    totalPanels: 42,
+                },
+                promotionIds: [
+                    "Test string"
+                ],
+                searchInfo: {
+                    offset: 42,
+                    orderBy: "Test string",
+                    searchQuery: "Test string",
+                },
+                sessionId: "Test string",
+                tagIds: [
+                    "Test string"
+                ],
+                transactionInfo: {
+                    cost: 42,
+                    currency: "Test string",
+                    discountValue: 42,
+                    tax: 42,
+                    transactionId: "Test string",
+                    value: 42,
+                },
+                userInfo: {
+                    userAgent: "Test string",
+                    userId: "Test string",
+                },
+                userPseudoId: "Test string",
+            },
+            userLabels: {
+                A: "Test string"
+            },
+            validateOnly: true,
+        });
+        /** Performs a search. */
+        await gapi.client.discoveryengine.projects.locations.collections.engines.servingConfigs.search({
+            servingConfig: "Test string",
+        }, {
+            boostSpec: {
+                conditionBoostSpecs: [
+                    {
+                        boost: 42,
+                        condition: "Test string",
+                    }
+                ],
+            },
+            branch: "Test string",
+            contentSearchSpec: {
+                extractiveContentSpec: {
+                    maxExtractiveAnswerCount: 42,
+                    maxExtractiveSegmentCount: 42,
+                    numNextSegments: 42,
+                    numPreviousSegments: 42,
+                },
+                snippetSpec: {
+                    maxSnippetCount: 42,
+                    referenceOnly: true,
+                    returnSnippet: true,
+                },
+                summarySpec: {
+                    ignoreAdversarialQuery: true,
+                    ignoreNonSummarySeekingQuery: true,
+                    includeCitations: true,
+                    languageCode: "Test string",
+                    summaryResultCount: 42,
+                },
+            },
+            embeddingSpec: {
+                embeddingVectors: [
+                    {
+                        fieldPath: "Test string",
+                        vector: [
+                            42
+                        ],
+                    }
+                ],
+            },
+            facetSpecs: [
+                {
+                    enableDynamicPosition: true,
+                    excludedFilterKeys: [
+                        "Test string"
+                    ],
+                    facetKey: {
+                        caseInsensitive: true,
+                        contains: [
+                            "Test string"
+                        ],
+                        intervals: [
+                            {
+                                exclusiveMaximum: 42,
+                                exclusiveMinimum: 42,
+                                maximum: 42,
+                                minimum: 42,
+                            }
+                        ],
+                        key: "Test string",
+                        orderBy: "Test string",
+                        prefixes: [
+                            "Test string"
+                        ],
+                        restrictedValues: [
+                            "Test string"
+                        ],
+                    },
+                    limit: 42,
+                }
+            ],
+            filter: "Test string",
+            imageQuery: {
+                imageBytes: "Test string",
+            },
+            offset: 42,
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            params: {
+                A: 42
+            },
+            query: "Test string",
+            queryExpansionSpec: {
+                condition: "Test string",
+                pinUnexpandedResults: true,
+            },
+            rankingExpression: "Test string",
+            safeSearch: true,
+            servingConfig: "Test string",
+            spellCorrectionSpec: {
+                mode: "Test string",
+            },
+            userInfo: {
+                userAgent: "Test string",
+                userId: "Test string",
+            },
+            userLabels: {
+                A: "Test string"
+            },
+            userPseudoId: "Test string",
+        });
         /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
         await gapi.client.discoveryengine.projects.locations.collections.operations.get({
             name: "Test string",