@google-cloud/discoveryengine 3.2.0 → 3.3.0
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/build/protos/google/cloud/discoveryengine/v1/search_service.proto +147 -19
- package/build/protos/protos.d.ts +608 -126
- package/build/protos/protos.js +1 -1
- package/build/protos/protos.json +185 -12
- package/build/src/v1/search_service_client.d.ts +162 -24
- package/build/src/v1/search_service_client.js +114 -17
- package/package.json +1 -1
package/build/protos/protos.json
CHANGED
|
@@ -1219,7 +1219,7 @@
|
|
|
1219
1219
|
"SearchService": {
|
|
1220
1220
|
"options": {
|
|
1221
1221
|
"(google.api.default_host)": "discoveryengine.googleapis.com",
|
|
1222
|
-
"(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform"
|
|
1222
|
+
"(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/discoveryengine.assist.readwrite,https://www.googleapis.com/auth/discoveryengine.readwrite,https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
|
|
1223
1223
|
},
|
|
1224
1224
|
"methods": {
|
|
1225
1225
|
"Search": {
|
|
@@ -1334,6 +1334,13 @@
|
|
|
1334
1334
|
"type": "DataStoreSpec",
|
|
1335
1335
|
"id": 32
|
|
1336
1336
|
},
|
|
1337
|
+
"numResultsPerDataStore": {
|
|
1338
|
+
"type": "int32",
|
|
1339
|
+
"id": 65,
|
|
1340
|
+
"options": {
|
|
1341
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
1342
|
+
}
|
|
1343
|
+
},
|
|
1337
1344
|
"filter": {
|
|
1338
1345
|
"type": "string",
|
|
1339
1346
|
"id": 7
|
|
@@ -1464,6 +1471,27 @@
|
|
|
1464
1471
|
"options": {
|
|
1465
1472
|
"(google.api.field_behavior)": "OPTIONAL"
|
|
1466
1473
|
}
|
|
1474
|
+
},
|
|
1475
|
+
"searchAddonSpec": {
|
|
1476
|
+
"type": "SearchAddonSpec",
|
|
1477
|
+
"id": 62,
|
|
1478
|
+
"options": {
|
|
1479
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
1480
|
+
}
|
|
1481
|
+
},
|
|
1482
|
+
"customRankingParams": {
|
|
1483
|
+
"type": "CustomRankingParams",
|
|
1484
|
+
"id": 64,
|
|
1485
|
+
"options": {
|
|
1486
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
1487
|
+
}
|
|
1488
|
+
},
|
|
1489
|
+
"entity": {
|
|
1490
|
+
"type": "string",
|
|
1491
|
+
"id": 66,
|
|
1492
|
+
"options": {
|
|
1493
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
1494
|
+
}
|
|
1467
1495
|
}
|
|
1468
1496
|
},
|
|
1469
1497
|
"nested": {
|
|
@@ -1512,6 +1540,13 @@
|
|
|
1512
1540
|
"options": {
|
|
1513
1541
|
"(google.api.field_behavior)": "OPTIONAL"
|
|
1514
1542
|
}
|
|
1543
|
+
},
|
|
1544
|
+
"numResults": {
|
|
1545
|
+
"type": "int32",
|
|
1546
|
+
"id": 9,
|
|
1547
|
+
"options": {
|
|
1548
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
1549
|
+
}
|
|
1515
1550
|
}
|
|
1516
1551
|
}
|
|
1517
1552
|
},
|
|
@@ -1896,13 +1931,62 @@
|
|
|
1896
1931
|
}
|
|
1897
1932
|
},
|
|
1898
1933
|
"SearchAsYouTypeSpec": {
|
|
1934
|
+
"oneofs": {
|
|
1935
|
+
"_scoreThreshold": {
|
|
1936
|
+
"oneof": [
|
|
1937
|
+
"scoreThreshold"
|
|
1938
|
+
]
|
|
1939
|
+
}
|
|
1940
|
+
},
|
|
1899
1941
|
"fields": {
|
|
1900
1942
|
"condition": {
|
|
1901
1943
|
"type": "Condition",
|
|
1902
1944
|
"id": 1
|
|
1945
|
+
},
|
|
1946
|
+
"fields": {
|
|
1947
|
+
"rule": "repeated",
|
|
1948
|
+
"type": "Field",
|
|
1949
|
+
"id": 2,
|
|
1950
|
+
"options": {
|
|
1951
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
1952
|
+
}
|
|
1953
|
+
},
|
|
1954
|
+
"scoreThreshold": {
|
|
1955
|
+
"type": "double",
|
|
1956
|
+
"id": 3,
|
|
1957
|
+
"options": {
|
|
1958
|
+
"(google.api.field_behavior)": "OPTIONAL",
|
|
1959
|
+
"proto3_optional": true
|
|
1960
|
+
}
|
|
1903
1961
|
}
|
|
1904
1962
|
},
|
|
1905
1963
|
"nested": {
|
|
1964
|
+
"Field": {
|
|
1965
|
+
"oneofs": {
|
|
1966
|
+
"_weight": {
|
|
1967
|
+
"oneof": [
|
|
1968
|
+
"weight"
|
|
1969
|
+
]
|
|
1970
|
+
}
|
|
1971
|
+
},
|
|
1972
|
+
"fields": {
|
|
1973
|
+
"key": {
|
|
1974
|
+
"type": "string",
|
|
1975
|
+
"id": 1,
|
|
1976
|
+
"options": {
|
|
1977
|
+
"(google.api.field_behavior)": "REQUIRED"
|
|
1978
|
+
}
|
|
1979
|
+
},
|
|
1980
|
+
"weight": {
|
|
1981
|
+
"type": "double",
|
|
1982
|
+
"id": 2,
|
|
1983
|
+
"options": {
|
|
1984
|
+
"(google.api.field_behavior)": "OPTIONAL",
|
|
1985
|
+
"proto3_optional": true
|
|
1986
|
+
}
|
|
1987
|
+
}
|
|
1988
|
+
}
|
|
1989
|
+
},
|
|
1906
1990
|
"Condition": {
|
|
1907
1991
|
"values": {
|
|
1908
1992
|
"CONDITION_UNSPECIFIED": 0,
|
|
@@ -1977,17 +2061,6 @@
|
|
|
1977
2061
|
}
|
|
1978
2062
|
}
|
|
1979
2063
|
},
|
|
1980
|
-
"RelevanceScoreSpec": {
|
|
1981
|
-
"fields": {
|
|
1982
|
-
"returnRelevanceScore": {
|
|
1983
|
-
"type": "bool",
|
|
1984
|
-
"id": 1,
|
|
1985
|
-
"options": {
|
|
1986
|
-
"(google.api.field_behavior)": "OPTIONAL"
|
|
1987
|
-
}
|
|
1988
|
-
}
|
|
1989
|
-
}
|
|
1990
|
-
},
|
|
1991
2064
|
"RelevanceFilterSpec": {
|
|
1992
2065
|
"fields": {
|
|
1993
2066
|
"keywordSearchThreshold": {
|
|
@@ -2028,6 +2101,54 @@
|
|
|
2028
2101
|
}
|
|
2029
2102
|
}
|
|
2030
2103
|
},
|
|
2104
|
+
"RelevanceScoreSpec": {
|
|
2105
|
+
"fields": {
|
|
2106
|
+
"returnRelevanceScore": {
|
|
2107
|
+
"type": "bool",
|
|
2108
|
+
"id": 1,
|
|
2109
|
+
"options": {
|
|
2110
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2111
|
+
}
|
|
2112
|
+
}
|
|
2113
|
+
}
|
|
2114
|
+
},
|
|
2115
|
+
"SearchAddonSpec": {
|
|
2116
|
+
"fields": {
|
|
2117
|
+
"disableSemanticAddOn": {
|
|
2118
|
+
"type": "bool",
|
|
2119
|
+
"id": 1,
|
|
2120
|
+
"options": {
|
|
2121
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2122
|
+
}
|
|
2123
|
+
},
|
|
2124
|
+
"disableKpiPersonalizationAddOn": {
|
|
2125
|
+
"type": "bool",
|
|
2126
|
+
"id": 2,
|
|
2127
|
+
"options": {
|
|
2128
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2129
|
+
}
|
|
2130
|
+
},
|
|
2131
|
+
"disableGenerativeAnswerAddOn": {
|
|
2132
|
+
"type": "bool",
|
|
2133
|
+
"id": 3,
|
|
2134
|
+
"options": {
|
|
2135
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2136
|
+
}
|
|
2137
|
+
}
|
|
2138
|
+
}
|
|
2139
|
+
},
|
|
2140
|
+
"CustomRankingParams": {
|
|
2141
|
+
"fields": {
|
|
2142
|
+
"expressionsToPrecompute": {
|
|
2143
|
+
"rule": "repeated",
|
|
2144
|
+
"type": "string",
|
|
2145
|
+
"id": 1,
|
|
2146
|
+
"options": {
|
|
2147
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2148
|
+
}
|
|
2149
|
+
}
|
|
2150
|
+
}
|
|
2151
|
+
},
|
|
2031
2152
|
"RankingExpressionBackend": {
|
|
2032
2153
|
"valuesOptions": {
|
|
2033
2154
|
"BYOE": {
|
|
@@ -2092,6 +2213,15 @@
|
|
|
2092
2213
|
"type": "Summary",
|
|
2093
2214
|
"id": 9
|
|
2094
2215
|
},
|
|
2216
|
+
"appliedControls": {
|
|
2217
|
+
"rule": "repeated",
|
|
2218
|
+
"type": "string",
|
|
2219
|
+
"id": 10,
|
|
2220
|
+
"options": {
|
|
2221
|
+
"(google.api.field_behavior)": "OPTIONAL",
|
|
2222
|
+
"(google.api.resource_reference).type": "discoveryengine.googleapis.com/Control"
|
|
2223
|
+
}
|
|
2224
|
+
},
|
|
2095
2225
|
"queryExpansionInfo": {
|
|
2096
2226
|
"type": "QueryExpansionInfo",
|
|
2097
2227
|
"id": 14
|
|
@@ -2149,6 +2279,13 @@
|
|
|
2149
2279
|
"options": {
|
|
2150
2280
|
"(google.api.field_behavior)": "OPTIONAL"
|
|
2151
2281
|
}
|
|
2282
|
+
},
|
|
2283
|
+
"retrievalSignals": {
|
|
2284
|
+
"type": "RetrievalSignals",
|
|
2285
|
+
"id": 11,
|
|
2286
|
+
"options": {
|
|
2287
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2288
|
+
}
|
|
2152
2289
|
}
|
|
2153
2290
|
},
|
|
2154
2291
|
"nested": {
|
|
@@ -2261,6 +2398,14 @@
|
|
|
2261
2398
|
"options": {
|
|
2262
2399
|
"(google.api.field_behavior)": "OPTIONAL"
|
|
2263
2400
|
}
|
|
2401
|
+
},
|
|
2402
|
+
"precomputedExpressionValues": {
|
|
2403
|
+
"rule": "repeated",
|
|
2404
|
+
"type": "float",
|
|
2405
|
+
"id": 34,
|
|
2406
|
+
"options": {
|
|
2407
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2408
|
+
}
|
|
2264
2409
|
}
|
|
2265
2410
|
},
|
|
2266
2411
|
"nested": {
|
|
@@ -2283,6 +2428,34 @@
|
|
|
2283
2428
|
}
|
|
2284
2429
|
}
|
|
2285
2430
|
}
|
|
2431
|
+
},
|
|
2432
|
+
"RetrievalSignals": {
|
|
2433
|
+
"fields": {
|
|
2434
|
+
"retrievalSources": {
|
|
2435
|
+
"rule": "repeated",
|
|
2436
|
+
"type": "RetrievalSource",
|
|
2437
|
+
"id": 1,
|
|
2438
|
+
"options": {
|
|
2439
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2440
|
+
}
|
|
2441
|
+
},
|
|
2442
|
+
"semanticRelevanceScore": {
|
|
2443
|
+
"type": "float",
|
|
2444
|
+
"id": 2,
|
|
2445
|
+
"options": {
|
|
2446
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
2447
|
+
}
|
|
2448
|
+
}
|
|
2449
|
+
},
|
|
2450
|
+
"nested": {
|
|
2451
|
+
"RetrievalSource": {
|
|
2452
|
+
"values": {
|
|
2453
|
+
"RETRIEVAL_SOURCE_UNSPECIFIED": 0,
|
|
2454
|
+
"KEYWORD_SEARCH": 1,
|
|
2455
|
+
"SEMANTIC_SEARCH": 2
|
|
2456
|
+
}
|
|
2457
|
+
}
|
|
2458
|
+
}
|
|
2286
2459
|
}
|
|
2287
2460
|
}
|
|
2288
2461
|
},
|
|
@@ -198,6 +198,11 @@ export declare class SearchServiceClient {
|
|
|
198
198
|
* stores. For engines with a single data store, the specs directly under
|
|
199
199
|
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
|
|
200
200
|
* used.
|
|
201
|
+
* @param {number} [request.numResultsPerDataStore]
|
|
202
|
+
* Optional. The maximum number of results to retrieve from each data store.
|
|
203
|
+
* If not specified, it will use the
|
|
204
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
|
|
205
|
+
* if provided, otherwise there is no limit.
|
|
201
206
|
* @param {string} request.filter
|
|
202
207
|
* The filter syntax consists of an expression language for constructing a
|
|
203
208
|
* predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -390,6 +395,15 @@ export declare class SearchServiceClient {
|
|
|
390
395
|
* Google model to determine the keyword-based overlap between the query and
|
|
391
396
|
* the document.
|
|
392
397
|
* * `base_rank`: the default rank of the result
|
|
398
|
+
* * `media_actor_match`: whether the media actor matches the query
|
|
399
|
+
* * `media_director_match`: whether the media director matches the query
|
|
400
|
+
* * `media_genre_match`: whether the media genre matches the query
|
|
401
|
+
* * `media_language_match`: whether the media language matches the query
|
|
402
|
+
* * `media_title_match`: whether the media title matches the query
|
|
403
|
+
* * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
404
|
+
* results
|
|
405
|
+
* * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
406
|
+
* results
|
|
393
407
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
|
394
408
|
* Optional. The backend to use for the ranking expression evaluation.
|
|
395
409
|
* @param {boolean} request.safeSearch
|
|
@@ -454,10 +468,6 @@ export declare class SearchServiceClient {
|
|
|
454
468
|
* Call /answer API with the session ID generated in the first call.
|
|
455
469
|
* Here, the answer generation happens in the context of the search
|
|
456
470
|
* results from the first search call.
|
|
457
|
-
*
|
|
458
|
-
* Multi-turn Search feature is currently at private GA stage. Please use
|
|
459
|
-
* v1alpha or v1beta version instead before we launch this feature to public
|
|
460
|
-
* GA. Or ask for allowlisting through Google Support team.
|
|
461
471
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
|
|
462
472
|
* Session specification.
|
|
463
473
|
*
|
|
@@ -483,6 +493,19 @@ export declare class SearchServiceClient {
|
|
|
483
493
|
* This feature is currently supported only for custom and site search.
|
|
484
494
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
|
485
495
|
* Optional. The specification for returning the relevance score.
|
|
496
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
|
|
497
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
498
|
+
* repricing model.
|
|
499
|
+
* This field is only supported for search requests.
|
|
500
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
|
|
501
|
+
* Optional. Optional configuration for the Custom Ranking feature.
|
|
502
|
+
* @param {string} [request.entity]
|
|
503
|
+
* Optional. The entity for customers that may run multiple different
|
|
504
|
+
* entities, domains, sites or regions, for example, "Google US", "Google
|
|
505
|
+
* Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
506
|
+
* be exactly matched with
|
|
507
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
|
|
508
|
+
* search results boosted by entity.
|
|
486
509
|
* @param {object} [options]
|
|
487
510
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
488
511
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -583,6 +606,11 @@ export declare class SearchServiceClient {
|
|
|
583
606
|
* stores. For engines with a single data store, the specs directly under
|
|
584
607
|
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
|
|
585
608
|
* used.
|
|
609
|
+
* @param {number} [request.numResultsPerDataStore]
|
|
610
|
+
* Optional. The maximum number of results to retrieve from each data store.
|
|
611
|
+
* If not specified, it will use the
|
|
612
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
|
|
613
|
+
* if provided, otherwise there is no limit.
|
|
586
614
|
* @param {string} request.filter
|
|
587
615
|
* The filter syntax consists of an expression language for constructing a
|
|
588
616
|
* predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -775,6 +803,15 @@ export declare class SearchServiceClient {
|
|
|
775
803
|
* Google model to determine the keyword-based overlap between the query and
|
|
776
804
|
* the document.
|
|
777
805
|
* * `base_rank`: the default rank of the result
|
|
806
|
+
* * `media_actor_match`: whether the media actor matches the query
|
|
807
|
+
* * `media_director_match`: whether the media director matches the query
|
|
808
|
+
* * `media_genre_match`: whether the media genre matches the query
|
|
809
|
+
* * `media_language_match`: whether the media language matches the query
|
|
810
|
+
* * `media_title_match`: whether the media title matches the query
|
|
811
|
+
* * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
812
|
+
* results
|
|
813
|
+
* * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
814
|
+
* results
|
|
778
815
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
|
779
816
|
* Optional. The backend to use for the ranking expression evaluation.
|
|
780
817
|
* @param {boolean} request.safeSearch
|
|
@@ -839,10 +876,6 @@ export declare class SearchServiceClient {
|
|
|
839
876
|
* Call /answer API with the session ID generated in the first call.
|
|
840
877
|
* Here, the answer generation happens in the context of the search
|
|
841
878
|
* results from the first search call.
|
|
842
|
-
*
|
|
843
|
-
* Multi-turn Search feature is currently at private GA stage. Please use
|
|
844
|
-
* v1alpha or v1beta version instead before we launch this feature to public
|
|
845
|
-
* GA. Or ask for allowlisting through Google Support team.
|
|
846
879
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
|
|
847
880
|
* Session specification.
|
|
848
881
|
*
|
|
@@ -868,6 +901,19 @@ export declare class SearchServiceClient {
|
|
|
868
901
|
* This feature is currently supported only for custom and site search.
|
|
869
902
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
|
870
903
|
* Optional. The specification for returning the relevance score.
|
|
904
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
|
|
905
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
906
|
+
* repricing model.
|
|
907
|
+
* This field is only supported for search requests.
|
|
908
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
|
|
909
|
+
* Optional. Optional configuration for the Custom Ranking feature.
|
|
910
|
+
* @param {string} [request.entity]
|
|
911
|
+
* Optional. The entity for customers that may run multiple different
|
|
912
|
+
* entities, domains, sites or regions, for example, "Google US", "Google
|
|
913
|
+
* Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
914
|
+
* be exactly matched with
|
|
915
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
|
|
916
|
+
* search results boosted by entity.
|
|
871
917
|
* @param {object} [options]
|
|
872
918
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
873
919
|
* @returns {Stream}
|
|
@@ -963,6 +1009,11 @@ export declare class SearchServiceClient {
|
|
|
963
1009
|
* stores. For engines with a single data store, the specs directly under
|
|
964
1010
|
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
|
|
965
1011
|
* used.
|
|
1012
|
+
* @param {number} [request.numResultsPerDataStore]
|
|
1013
|
+
* Optional. The maximum number of results to retrieve from each data store.
|
|
1014
|
+
* If not specified, it will use the
|
|
1015
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
|
|
1016
|
+
* if provided, otherwise there is no limit.
|
|
966
1017
|
* @param {string} request.filter
|
|
967
1018
|
* The filter syntax consists of an expression language for constructing a
|
|
968
1019
|
* predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -1155,6 +1206,15 @@ export declare class SearchServiceClient {
|
|
|
1155
1206
|
* Google model to determine the keyword-based overlap between the query and
|
|
1156
1207
|
* the document.
|
|
1157
1208
|
* * `base_rank`: the default rank of the result
|
|
1209
|
+
* * `media_actor_match`: whether the media actor matches the query
|
|
1210
|
+
* * `media_director_match`: whether the media director matches the query
|
|
1211
|
+
* * `media_genre_match`: whether the media genre matches the query
|
|
1212
|
+
* * `media_language_match`: whether the media language matches the query
|
|
1213
|
+
* * `media_title_match`: whether the media title matches the query
|
|
1214
|
+
* * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
1215
|
+
* results
|
|
1216
|
+
* * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
1217
|
+
* results
|
|
1158
1218
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
|
1159
1219
|
* Optional. The backend to use for the ranking expression evaluation.
|
|
1160
1220
|
* @param {boolean} request.safeSearch
|
|
@@ -1219,10 +1279,6 @@ export declare class SearchServiceClient {
|
|
|
1219
1279
|
* Call /answer API with the session ID generated in the first call.
|
|
1220
1280
|
* Here, the answer generation happens in the context of the search
|
|
1221
1281
|
* results from the first search call.
|
|
1222
|
-
*
|
|
1223
|
-
* Multi-turn Search feature is currently at private GA stage. Please use
|
|
1224
|
-
* v1alpha or v1beta version instead before we launch this feature to public
|
|
1225
|
-
* GA. Or ask for allowlisting through Google Support team.
|
|
1226
1282
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
|
|
1227
1283
|
* Session specification.
|
|
1228
1284
|
*
|
|
@@ -1248,6 +1304,19 @@ export declare class SearchServiceClient {
|
|
|
1248
1304
|
* This feature is currently supported only for custom and site search.
|
|
1249
1305
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
|
1250
1306
|
* Optional. The specification for returning the relevance score.
|
|
1307
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
|
|
1308
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
1309
|
+
* repricing model.
|
|
1310
|
+
* This field is only supported for search requests.
|
|
1311
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
|
|
1312
|
+
* Optional. Optional configuration for the Custom Ranking feature.
|
|
1313
|
+
* @param {string} [request.entity]
|
|
1314
|
+
* Optional. The entity for customers that may run multiple different
|
|
1315
|
+
* entities, domains, sites or regions, for example, "Google US", "Google
|
|
1316
|
+
* Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
1317
|
+
* be exactly matched with
|
|
1318
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
|
|
1319
|
+
* search results boosted by entity.
|
|
1251
1320
|
* @param {object} [options]
|
|
1252
1321
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1253
1322
|
* @returns {Object}
|
|
@@ -1355,6 +1424,11 @@ export declare class SearchServiceClient {
|
|
|
1355
1424
|
* stores. For engines with a single data store, the specs directly under
|
|
1356
1425
|
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
|
|
1357
1426
|
* used.
|
|
1427
|
+
* @param {number} [request.numResultsPerDataStore]
|
|
1428
|
+
* Optional. The maximum number of results to retrieve from each data store.
|
|
1429
|
+
* If not specified, it will use the
|
|
1430
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
|
|
1431
|
+
* if provided, otherwise there is no limit.
|
|
1358
1432
|
* @param {string} request.filter
|
|
1359
1433
|
* The filter syntax consists of an expression language for constructing a
|
|
1360
1434
|
* predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -1547,6 +1621,15 @@ export declare class SearchServiceClient {
|
|
|
1547
1621
|
* Google model to determine the keyword-based overlap between the query and
|
|
1548
1622
|
* the document.
|
|
1549
1623
|
* * `base_rank`: the default rank of the result
|
|
1624
|
+
* * `media_actor_match`: whether the media actor matches the query
|
|
1625
|
+
* * `media_director_match`: whether the media director matches the query
|
|
1626
|
+
* * `media_genre_match`: whether the media genre matches the query
|
|
1627
|
+
* * `media_language_match`: whether the media language matches the query
|
|
1628
|
+
* * `media_title_match`: whether the media title matches the query
|
|
1629
|
+
* * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
1630
|
+
* results
|
|
1631
|
+
* * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
1632
|
+
* results
|
|
1550
1633
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
|
1551
1634
|
* Optional. The backend to use for the ranking expression evaluation.
|
|
1552
1635
|
* @param {boolean} request.safeSearch
|
|
@@ -1611,10 +1694,6 @@ export declare class SearchServiceClient {
|
|
|
1611
1694
|
* Call /answer API with the session ID generated in the first call.
|
|
1612
1695
|
* Here, the answer generation happens in the context of the search
|
|
1613
1696
|
* results from the first search call.
|
|
1614
|
-
*
|
|
1615
|
-
* Multi-turn Search feature is currently at private GA stage. Please use
|
|
1616
|
-
* v1alpha or v1beta version instead before we launch this feature to public
|
|
1617
|
-
* GA. Or ask for allowlisting through Google Support team.
|
|
1618
1697
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
|
|
1619
1698
|
* Session specification.
|
|
1620
1699
|
*
|
|
@@ -1640,6 +1719,19 @@ export declare class SearchServiceClient {
|
|
|
1640
1719
|
* This feature is currently supported only for custom and site search.
|
|
1641
1720
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
|
1642
1721
|
* Optional. The specification for returning the relevance score.
|
|
1722
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
|
|
1723
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
1724
|
+
* repricing model.
|
|
1725
|
+
* This field is only supported for search requests.
|
|
1726
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
|
|
1727
|
+
* Optional. Optional configuration for the Custom Ranking feature.
|
|
1728
|
+
* @param {string} [request.entity]
|
|
1729
|
+
* Optional. The entity for customers that may run multiple different
|
|
1730
|
+
* entities, domains, sites or regions, for example, "Google US", "Google
|
|
1731
|
+
* Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
1732
|
+
* be exactly matched with
|
|
1733
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
|
|
1734
|
+
* search results boosted by entity.
|
|
1643
1735
|
* @param {object} [options]
|
|
1644
1736
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1645
1737
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -1740,6 +1832,11 @@ export declare class SearchServiceClient {
|
|
|
1740
1832
|
* stores. For engines with a single data store, the specs directly under
|
|
1741
1833
|
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
|
|
1742
1834
|
* used.
|
|
1835
|
+
* @param {number} [request.numResultsPerDataStore]
|
|
1836
|
+
* Optional. The maximum number of results to retrieve from each data store.
|
|
1837
|
+
* If not specified, it will use the
|
|
1838
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
|
|
1839
|
+
* if provided, otherwise there is no limit.
|
|
1743
1840
|
* @param {string} request.filter
|
|
1744
1841
|
* The filter syntax consists of an expression language for constructing a
|
|
1745
1842
|
* predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -1932,6 +2029,15 @@ export declare class SearchServiceClient {
|
|
|
1932
2029
|
* Google model to determine the keyword-based overlap between the query and
|
|
1933
2030
|
* the document.
|
|
1934
2031
|
* * `base_rank`: the default rank of the result
|
|
2032
|
+
* * `media_actor_match`: whether the media actor matches the query
|
|
2033
|
+
* * `media_director_match`: whether the media director matches the query
|
|
2034
|
+
* * `media_genre_match`: whether the media genre matches the query
|
|
2035
|
+
* * `media_language_match`: whether the media language matches the query
|
|
2036
|
+
* * `media_title_match`: whether the media title matches the query
|
|
2037
|
+
* * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
2038
|
+
* results
|
|
2039
|
+
* * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
2040
|
+
* results
|
|
1935
2041
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
|
1936
2042
|
* Optional. The backend to use for the ranking expression evaluation.
|
|
1937
2043
|
* @param {boolean} request.safeSearch
|
|
@@ -1996,10 +2102,6 @@ export declare class SearchServiceClient {
|
|
|
1996
2102
|
* Call /answer API with the session ID generated in the first call.
|
|
1997
2103
|
* Here, the answer generation happens in the context of the search
|
|
1998
2104
|
* results from the first search call.
|
|
1999
|
-
*
|
|
2000
|
-
* Multi-turn Search feature is currently at private GA stage. Please use
|
|
2001
|
-
* v1alpha or v1beta version instead before we launch this feature to public
|
|
2002
|
-
* GA. Or ask for allowlisting through Google Support team.
|
|
2003
2105
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
|
|
2004
2106
|
* Session specification.
|
|
2005
2107
|
*
|
|
@@ -2025,6 +2127,19 @@ export declare class SearchServiceClient {
|
|
|
2025
2127
|
* This feature is currently supported only for custom and site search.
|
|
2026
2128
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
|
2027
2129
|
* Optional. The specification for returning the relevance score.
|
|
2130
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
|
|
2131
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
2132
|
+
* repricing model.
|
|
2133
|
+
* This field is only supported for search requests.
|
|
2134
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
|
|
2135
|
+
* Optional. Optional configuration for the Custom Ranking feature.
|
|
2136
|
+
* @param {string} [request.entity]
|
|
2137
|
+
* Optional. The entity for customers that may run multiple different
|
|
2138
|
+
* entities, domains, sites or regions, for example, "Google US", "Google
|
|
2139
|
+
* Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
2140
|
+
* be exactly matched with
|
|
2141
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
|
|
2142
|
+
* search results boosted by entity.
|
|
2028
2143
|
* @param {object} [options]
|
|
2029
2144
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2030
2145
|
* @returns {Stream}
|
|
@@ -2120,6 +2235,11 @@ export declare class SearchServiceClient {
|
|
|
2120
2235
|
* stores. For engines with a single data store, the specs directly under
|
|
2121
2236
|
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
|
|
2122
2237
|
* used.
|
|
2238
|
+
* @param {number} [request.numResultsPerDataStore]
|
|
2239
|
+
* Optional. The maximum number of results to retrieve from each data store.
|
|
2240
|
+
* If not specified, it will use the
|
|
2241
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
|
|
2242
|
+
* if provided, otherwise there is no limit.
|
|
2123
2243
|
* @param {string} request.filter
|
|
2124
2244
|
* The filter syntax consists of an expression language for constructing a
|
|
2125
2245
|
* predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -2312,6 +2432,15 @@ export declare class SearchServiceClient {
|
|
|
2312
2432
|
* Google model to determine the keyword-based overlap between the query and
|
|
2313
2433
|
* the document.
|
|
2314
2434
|
* * `base_rank`: the default rank of the result
|
|
2435
|
+
* * `media_actor_match`: whether the media actor matches the query
|
|
2436
|
+
* * `media_director_match`: whether the media director matches the query
|
|
2437
|
+
* * `media_genre_match`: whether the media genre matches the query
|
|
2438
|
+
* * `media_language_match`: whether the media language matches the query
|
|
2439
|
+
* * `media_title_match`: whether the media title matches the query
|
|
2440
|
+
* * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
2441
|
+
* results
|
|
2442
|
+
* * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
2443
|
+
* results
|
|
2315
2444
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
|
2316
2445
|
* Optional. The backend to use for the ranking expression evaluation.
|
|
2317
2446
|
* @param {boolean} request.safeSearch
|
|
@@ -2376,10 +2505,6 @@ export declare class SearchServiceClient {
|
|
|
2376
2505
|
* Call /answer API with the session ID generated in the first call.
|
|
2377
2506
|
* Here, the answer generation happens in the context of the search
|
|
2378
2507
|
* results from the first search call.
|
|
2379
|
-
*
|
|
2380
|
-
* Multi-turn Search feature is currently at private GA stage. Please use
|
|
2381
|
-
* v1alpha or v1beta version instead before we launch this feature to public
|
|
2382
|
-
* GA. Or ask for allowlisting through Google Support team.
|
|
2383
2508
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
|
|
2384
2509
|
* Session specification.
|
|
2385
2510
|
*
|
|
@@ -2405,6 +2530,19 @@ export declare class SearchServiceClient {
|
|
|
2405
2530
|
* This feature is currently supported only for custom and site search.
|
|
2406
2531
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
|
2407
2532
|
* Optional. The specification for returning the relevance score.
|
|
2533
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
|
|
2534
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
2535
|
+
* repricing model.
|
|
2536
|
+
* This field is only supported for search requests.
|
|
2537
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
|
|
2538
|
+
* Optional. Optional configuration for the Custom Ranking feature.
|
|
2539
|
+
* @param {string} [request.entity]
|
|
2540
|
+
* Optional. The entity for customers that may run multiple different
|
|
2541
|
+
* entities, domains, sites or regions, for example, "Google US", "Google
|
|
2542
|
+
* Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
2543
|
+
* be exactly matched with
|
|
2544
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
|
|
2545
|
+
* search results boosted by entity.
|
|
2408
2546
|
* @param {object} [options]
|
|
2409
2547
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
2410
2548
|
* @returns {Object}
|