@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20231003 → 0.0.20231016
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +15 -13
- package/package.json +1 -1
- package/tests.ts +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20231016
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -104,11 +104,6 @@ declare namespace gapi.client {
|
|
|
104
104
|
functionName?:
|
|
105
105
|
string;
|
|
106
106
|
}
|
|
107
|
-
interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
|
|
108
|
-
/** TargetSites created. */
|
|
109
|
-
targetSites?:
|
|
110
|
-
GoogleCloudDiscoveryengineV1alphaTargetSite[];
|
|
111
|
-
}
|
|
112
107
|
interface GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata {
|
|
113
108
|
/** Operation create time. */
|
|
114
109
|
createTime?:
|
|
@@ -921,9 +916,11 @@ declare namespace gapi.client {
|
|
|
921
916
|
interface GoogleCloudDiscoveryengineV1betaRecommendRequest {
|
|
922
917
|
/**
|
|
923
918
|
* 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: *
|
|
924
|
-
* `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If
|
|
925
|
-
*
|
|
926
|
-
*
|
|
919
|
+
* `(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
|
|
920
|
+
* 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
|
|
921
|
+
* (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
|
|
922
|
+
* (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead.
|
|
923
|
+
* Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
|
927
924
|
*/
|
|
928
925
|
filter?:
|
|
929
926
|
string;
|
|
@@ -939,7 +936,8 @@ declare namespace gapi.client {
|
|
|
939
936
|
* RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`:
|
|
940
937
|
* 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. *
|
|
941
938
|
* `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` *
|
|
942
|
-
* `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.
|
|
939
|
+
* `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to
|
|
940
|
+
* true, the `filter` field is interpreted according to the new, attribute-based syntax.
|
|
943
941
|
*/
|
|
944
942
|
params?:
|
|
945
943
|
{ [P in string]: any };
|
|
@@ -1055,7 +1053,7 @@ declare namespace gapi.client {
|
|
|
1055
1053
|
string;
|
|
1056
1054
|
}
|
|
1057
1055
|
interface GoogleCloudDiscoveryengineV1betaSearchRequest {
|
|
1058
|
-
/** Boost specification to boost certain documents. */
|
|
1056
|
+
/** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
|
|
1059
1057
|
boostSpec?:
|
|
1060
1058
|
GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
1061
1059
|
/**
|
|
@@ -1079,7 +1077,10 @@ declare namespace gapi.client {
|
|
|
1079
1077
|
GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
1080
1078
|
/**
|
|
1081
1079
|
* 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
|
|
1082
|
-
* this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1080
|
+
* 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
|
|
1081
|
+
* 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
|
|
1082
|
+
* like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see
|
|
1083
|
+
* [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
|
1083
1084
|
*/
|
|
1084
1085
|
filter?:
|
|
1085
1086
|
string;
|
|
@@ -1094,7 +1095,8 @@ declare namespace gapi.client {
|
|
|
1094
1095
|
number;
|
|
1095
1096
|
/**
|
|
1096
1097
|
* 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
|
|
1097
|
-
* case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT`
|
|
1098
|
+
* 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`
|
|
1099
|
+
* is returned.
|
|
1098
1100
|
*/
|
|
1099
1101
|
orderBy?:
|
|
1100
1102
|
string;
|
package/package.json
CHANGED
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20231016
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|