@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20231003 → 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=v1alpha
-// Revision: 20231003
+// Revision: 20231016
 
 /// <reference types="gapi.client" />
 
@@ -109,11 +109,6 @@ declare namespace gapi.client {
             token?:
                 string;
         }
-        interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
-            /** TargetSites created. */
-            targetSites?:
-                GoogleCloudDiscoveryengineV1alphaTargetSite[];
-        }
         interface GoogleCloudDiscoveryengineV1alphaBigQuerySource {
             /**
              * The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document
@@ -774,9 +769,11 @@ declare namespace gapi.client {
         interface GoogleCloudDiscoveryengineV1alphaRecommendRequest {
             /**
              * 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;
@@ -792,7 +789,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 };
@@ -966,7 +964,7 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDiscoveryengineV1alphaSearchRequest {
-            /** 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?:
                 GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
             /**
@@ -990,7 +988,10 @@ declare namespace gapi.client {
                 GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
             /**
              * 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;
@@ -1005,7 +1006,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20231003",
+  "version": "0.0.20231016",
   "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: 20231003
+// Revision: 20231016
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */