@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20230928 → 0.0.20231016

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=v1beta
-// Revision: 20230928
+// Revision: 20231016
 
 /// <reference types="gapi.client" />
 
@@ -104,11 +104,6 @@ declare namespace gapi.client {
             functionName?:
                 string;
         }
-        interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
-            /** TargetSites created. */
-            targetSites?:
-                GoogleCloudDiscoveryengineV1alphaTargetSite[];
-        }
         interface GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata {
             /** Operation create time. */
             createTime?:
@@ -921,9 +916,11 @@ declare namespace gapi.client {
         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_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set
+             * to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT
+             * (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) 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;
@@ -939,7 +936,8 @@ declare namespace gapi.client {
              * RecommendResponse.RecommendationResult.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.
+             * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to
+             * true, the `filter` field is interpreted according to the new, attribute-based syntax.
              */
             params?:
                 { [P in string]: any };
@@ -1055,7 +1053,7 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDiscoveryengineV1betaSearchRequest {
-            /** Boost specification to boost certain documents. */
+            /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
             boostSpec?:
                 GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
             /**
@@ -1079,7 +1077,10 @@ declare namespace gapi.client {
                 GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
             /**
              * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If
-             * this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+             * this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI
+             * Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look
+             * like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see
+             * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
              */
             filter?:
                 string;
@@ -1094,7 +1095,8 @@ declare namespace gapi.client {
                 number;
             /**
              * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is
-             * case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+             * case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT`
+             * is returned.
              */
             orderBy?:
                 string;
@@ -4190,9 +4192,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:
+                    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/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: GoogleCloudDiscoveryengineV1betaRecommendRequest): Request<GoogleCloudDiscoveryengineV1betaRecommendResponse>;
+            /** 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:
+                    GoogleCloudDiscoveryengineV1betaSearchRequest;
+            }): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
+            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: GoogleCloudDiscoveryengineV1betaSearchRequest): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
+        }
         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-v1beta",
-  "version": "0.0.20230928",
+  "version": "0.0.20231016",
   "description": "TypeScript typings for Discovery Engine API v1beta",
   "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: 20230928
+// Revision: 20231016
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -843,6 +843,197 @@ 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,
+            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",