@googleapis/discoveryengine 1.1.0 → 2.0.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/CHANGELOG.md +36 -0
- package/build/v1alpha.d.ts +625 -10
- package/build/v1alpha.js +275 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +170 -10
- package/build/v1beta.js +72 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +3 -3
- package/v1alpha.ts +1436 -119
- package/v1beta.ts +351 -12
package/build/v1alpha.d.ts
CHANGED
|
@@ -68,6 +68,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
68
68
|
*/
|
|
69
69
|
export class Discoveryengine {
|
|
70
70
|
context: APIRequestContext;
|
|
71
|
+
locations: Resource$Locations;
|
|
71
72
|
projects: Resource$Projects;
|
|
72
73
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
73
74
|
}
|
|
@@ -192,6 +193,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
192
193
|
*/
|
|
193
194
|
functionName?: string | null;
|
|
194
195
|
}
|
|
196
|
+
/**
|
|
197
|
+
* AdditionalParams message for WidgetService methods for security and privacy enhancement.
|
|
198
|
+
*/
|
|
199
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams {
|
|
200
|
+
/**
|
|
201
|
+
* Token that used for non-human user check.
|
|
202
|
+
*/
|
|
203
|
+
token?: string | null;
|
|
204
|
+
}
|
|
195
205
|
/**
|
|
196
206
|
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
197
207
|
*/
|
|
@@ -230,6 +240,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
230
240
|
*/
|
|
231
241
|
tableId?: string | null;
|
|
232
242
|
}
|
|
243
|
+
/**
|
|
244
|
+
* Request message for CompletionService.CompleteQuery method.
|
|
245
|
+
*/
|
|
246
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
|
|
247
|
+
/**
|
|
248
|
+
* Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`.
|
|
249
|
+
*/
|
|
250
|
+
dataStore?: string | null;
|
|
251
|
+
/**
|
|
252
|
+
* Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
|
|
253
|
+
*/
|
|
254
|
+
includeTailSuggestions?: boolean | null;
|
|
255
|
+
/**
|
|
256
|
+
* Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
|
|
257
|
+
*/
|
|
258
|
+
query?: string | null;
|
|
259
|
+
/**
|
|
260
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
261
|
+
*/
|
|
262
|
+
queryModel?: string | null;
|
|
263
|
+
/**
|
|
264
|
+
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
265
|
+
*/
|
|
266
|
+
userPseudoId?: string | null;
|
|
267
|
+
}
|
|
233
268
|
/**
|
|
234
269
|
* Response message for CompletionService.CompleteQuery method.
|
|
235
270
|
*/
|
|
@@ -250,7 +285,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
250
285
|
/**
|
|
251
286
|
* The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.
|
|
252
287
|
*/
|
|
253
|
-
|
|
288
|
+
completableFieldPaths?: string[] | null;
|
|
254
289
|
/**
|
|
255
290
|
* The suggestion for the query.
|
|
256
291
|
*/
|
|
@@ -336,6 +371,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
336
371
|
* The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
|
|
337
372
|
*/
|
|
338
373
|
conversation?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
|
|
374
|
+
/**
|
|
375
|
+
* Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
|
|
376
|
+
*/
|
|
377
|
+
name?: string | null;
|
|
339
378
|
/**
|
|
340
379
|
* Required. Current user input.
|
|
341
380
|
*/
|
|
@@ -348,6 +387,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
348
387
|
* The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used.
|
|
349
388
|
*/
|
|
350
389
|
servingConfig?: string | null;
|
|
390
|
+
/**
|
|
391
|
+
* A specification for configuring the summary returned in the response.
|
|
392
|
+
*/
|
|
393
|
+
summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
351
394
|
/**
|
|
352
395
|
* The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
|
|
353
396
|
*/
|
|
@@ -778,6 +821,24 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
778
821
|
*/
|
|
779
822
|
schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
780
823
|
}
|
|
824
|
+
/**
|
|
825
|
+
* Request message for WidgetService.LookupWidgetConfig method.
|
|
826
|
+
*/
|
|
827
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest {
|
|
828
|
+
/**
|
|
829
|
+
* Required. The UUID of the Widget Config.
|
|
830
|
+
*/
|
|
831
|
+
widgetConfigId?: string | null;
|
|
832
|
+
}
|
|
833
|
+
/**
|
|
834
|
+
* Response message for WidgetService.LookupWidgetConfig method.
|
|
835
|
+
*/
|
|
836
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse {
|
|
837
|
+
/**
|
|
838
|
+
* The Anonymous Widget Config associated with the UUID.
|
|
839
|
+
*/
|
|
840
|
+
anonymousWidgetConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig;
|
|
841
|
+
}
|
|
781
842
|
/**
|
|
782
843
|
* Media-specific user event information.
|
|
783
844
|
*/
|
|
@@ -996,6 +1057,87 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
996
1057
|
[key: string]: any;
|
|
997
1058
|
} | null;
|
|
998
1059
|
}
|
|
1060
|
+
/**
|
|
1061
|
+
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1062
|
+
*/
|
|
1063
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
1064
|
+
/**
|
|
1065
|
+
* Operation create time.
|
|
1066
|
+
*/
|
|
1067
|
+
createTime?: string | null;
|
|
1068
|
+
/**
|
|
1069
|
+
* Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.
|
|
1070
|
+
*/
|
|
1071
|
+
invalidUris?: string[] | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* Total number of URIs that have yet to be crawled.
|
|
1074
|
+
*/
|
|
1075
|
+
pendingCount?: number | null;
|
|
1076
|
+
/**
|
|
1077
|
+
* Total number of URIs that were rejected due to insufficient indexing resources.
|
|
1078
|
+
*/
|
|
1079
|
+
quotaExceededCount?: number | null;
|
|
1080
|
+
/**
|
|
1081
|
+
* Total number of URIs that have been crawled so far.
|
|
1082
|
+
*/
|
|
1083
|
+
successCount?: number | null;
|
|
1084
|
+
/**
|
|
1085
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1086
|
+
*/
|
|
1087
|
+
updateTime?: string | null;
|
|
1088
|
+
/**
|
|
1089
|
+
* Total number of unique URIs in the request that are not in invalid_uris.
|
|
1090
|
+
*/
|
|
1091
|
+
validUrisCount?: number | null;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* Request message for SiteSearchEngineService.RecrawlUris method.
|
|
1095
|
+
*/
|
|
1096
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest {
|
|
1097
|
+
/**
|
|
1098
|
+
* Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.
|
|
1099
|
+
*/
|
|
1100
|
+
uris?: string[] | null;
|
|
1101
|
+
}
|
|
1102
|
+
/**
|
|
1103
|
+
* Response message for SiteSearchEngineService.RecrawlUris method.
|
|
1104
|
+
*/
|
|
1105
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
|
|
1106
|
+
/**
|
|
1107
|
+
* URIs that were not crawled before the LRO terminated.
|
|
1108
|
+
*/
|
|
1109
|
+
failedUris?: string[] | null;
|
|
1110
|
+
/**
|
|
1111
|
+
* Details for a sample of up to 10 `failed_uris`.
|
|
1112
|
+
*/
|
|
1113
|
+
failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
|
|
1114
|
+
}
|
|
1115
|
+
/**
|
|
1116
|
+
* Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
|
|
1117
|
+
*/
|
|
1118
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
|
|
1119
|
+
/**
|
|
1120
|
+
* List of failure reasons by corpus type (e.g. desktop, mobile).
|
|
1121
|
+
*/
|
|
1122
|
+
failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
|
|
1123
|
+
/**
|
|
1124
|
+
* URI that failed to be crawled.
|
|
1125
|
+
*/
|
|
1126
|
+
uri?: string | null;
|
|
1127
|
+
}
|
|
1128
|
+
/**
|
|
1129
|
+
* Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1130
|
+
*/
|
|
1131
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1132
|
+
/**
|
|
1133
|
+
* DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
|
|
1134
|
+
*/
|
|
1135
|
+
corpusType?: string | null;
|
|
1136
|
+
/**
|
|
1137
|
+
* Reason why the URI was not crawled.
|
|
1138
|
+
*/
|
|
1139
|
+
errorMessage?: string | null;
|
|
1140
|
+
}
|
|
999
1141
|
/**
|
|
1000
1142
|
* Defines a reply message to user.
|
|
1001
1143
|
*/
|
|
@@ -1144,6 +1286,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1144
1286
|
* Whether to turn on safe search. This is only supported for website search.
|
|
1145
1287
|
*/
|
|
1146
1288
|
safeSearch?: boolean | null;
|
|
1289
|
+
/**
|
|
1290
|
+
* Required. The resource name of the Search serving config, such as `projects/x/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.
|
|
1291
|
+
*/
|
|
1292
|
+
servingConfig?: string | null;
|
|
1147
1293
|
/**
|
|
1148
1294
|
* The spell correction specification that specifies the mode under which spell correction takes effect.
|
|
1149
1295
|
*/
|
|
@@ -1215,9 +1361,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1215
1361
|
*/
|
|
1216
1362
|
maxExtractiveSegmentCount?: number | null;
|
|
1217
1363
|
/**
|
|
1218
|
-
*
|
|
1364
|
+
* Return at most `num_next_segments` segments after each selected segments.
|
|
1365
|
+
*/
|
|
1366
|
+
numNextSegments?: number | null;
|
|
1367
|
+
/**
|
|
1368
|
+
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
1219
1369
|
*/
|
|
1220
|
-
|
|
1370
|
+
numPreviousSegments?: number | null;
|
|
1221
1371
|
}
|
|
1222
1372
|
/**
|
|
1223
1373
|
* A specification for configuring snippets in a search response.
|
|
@@ -1253,7 +1403,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1253
1403
|
*/
|
|
1254
1404
|
includeCitations?: boolean | null;
|
|
1255
1405
|
/**
|
|
1256
|
-
* Language code for Summary. Use language tags defined by BCP47.
|
|
1406
|
+
* Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
1257
1407
|
*/
|
|
1258
1408
|
languageCode?: string | null;
|
|
1259
1409
|
/**
|
|
@@ -1388,6 +1538,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1388
1538
|
* Results of facets requested by user.
|
|
1389
1539
|
*/
|
|
1390
1540
|
facets?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[];
|
|
1541
|
+
geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[];
|
|
1391
1542
|
/**
|
|
1392
1543
|
* Guided search result.
|
|
1393
1544
|
*/
|
|
@@ -1451,6 +1602,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1451
1602
|
*/
|
|
1452
1603
|
value?: string | null;
|
|
1453
1604
|
}
|
|
1605
|
+
/**
|
|
1606
|
+
* Debug information specifically related to forward geocoding issues arising from Geolocation Search.
|
|
1607
|
+
*/
|
|
1608
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo {
|
|
1609
|
+
/**
|
|
1610
|
+
* The error produced.
|
|
1611
|
+
*/
|
|
1612
|
+
errorMessage?: string | null;
|
|
1613
|
+
/**
|
|
1614
|
+
* The address from which forward geocoding ingestion produced issues.
|
|
1615
|
+
*/
|
|
1616
|
+
originalAddressQuery?: string | null;
|
|
1617
|
+
}
|
|
1454
1618
|
/**
|
|
1455
1619
|
* Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.
|
|
1456
1620
|
*/
|
|
@@ -1513,6 +1677,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1513
1677
|
* Summary of the top N search result specified by the summary spec.
|
|
1514
1678
|
*/
|
|
1515
1679
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummary {
|
|
1680
|
+
/**
|
|
1681
|
+
* A collection of Safety Attribute categories and their associated confidence scores.
|
|
1682
|
+
*/
|
|
1683
|
+
safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes;
|
|
1516
1684
|
/**
|
|
1517
1685
|
* Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1518
1686
|
*/
|
|
@@ -1522,6 +1690,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1522
1690
|
*/
|
|
1523
1691
|
summaryText?: string | null;
|
|
1524
1692
|
}
|
|
1693
|
+
/**
|
|
1694
|
+
* Safety Attribute categories and their associated confidence scores.
|
|
1695
|
+
*/
|
|
1696
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
|
|
1697
|
+
/**
|
|
1698
|
+
* The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
|
|
1699
|
+
*/
|
|
1700
|
+
categories?: string[] | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
|
|
1703
|
+
*/
|
|
1704
|
+
scores?: number[] | null;
|
|
1705
|
+
}
|
|
1525
1706
|
/**
|
|
1526
1707
|
* Verification information for target sites in advanced site search.
|
|
1527
1708
|
*/
|
|
@@ -1586,10 +1767,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1586
1767
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
1587
1768
|
}
|
|
1588
1769
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
1589
|
-
/**
|
|
1590
|
-
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
1591
|
-
*/
|
|
1592
|
-
totalRequiredQuota?: string | null;
|
|
1593
1770
|
}
|
|
1594
1771
|
/**
|
|
1595
1772
|
* Defines text input.
|
|
@@ -1738,6 +1915,238 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1738
1915
|
*/
|
|
1739
1916
|
userId?: string | null;
|
|
1740
1917
|
}
|
|
1918
|
+
/**
|
|
1919
|
+
* Request message for WidgetService.WidgetCompleteQuery method.
|
|
1920
|
+
*/
|
|
1921
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest {
|
|
1922
|
+
/**
|
|
1923
|
+
* Additional params for security and privacy enhancement.
|
|
1924
|
+
*/
|
|
1925
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
1926
|
+
/**
|
|
1927
|
+
* Required. The CompleteQuery request to perform auto-complete suggestion query.
|
|
1928
|
+
*/
|
|
1929
|
+
completeQueryRequest?: Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest;
|
|
1930
|
+
/**
|
|
1931
|
+
* Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query.
|
|
1932
|
+
*/
|
|
1933
|
+
configId?: string | null;
|
|
1934
|
+
}
|
|
1935
|
+
/**
|
|
1936
|
+
* Response message for WidgetService.WidgetCompleteQuery method.
|
|
1937
|
+
*/
|
|
1938
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse {
|
|
1939
|
+
/**
|
|
1940
|
+
* The token in response.
|
|
1941
|
+
*/
|
|
1942
|
+
uToken?: string | null;
|
|
1943
|
+
/**
|
|
1944
|
+
* Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion.
|
|
1945
|
+
*/
|
|
1946
|
+
widgetQuerySuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion[];
|
|
1947
|
+
}
|
|
1948
|
+
/**
|
|
1949
|
+
* Suggestions as search queries.
|
|
1950
|
+
*/
|
|
1951
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion {
|
|
1952
|
+
/**
|
|
1953
|
+
* The suggestion for the query.
|
|
1954
|
+
*/
|
|
1955
|
+
suggestion?: string | null;
|
|
1956
|
+
}
|
|
1957
|
+
/**
|
|
1958
|
+
* WidgetConfig captures configs at the Widget level.
|
|
1959
|
+
*/
|
|
1960
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig {
|
|
1961
|
+
/**
|
|
1962
|
+
* Allowlisted domains that can load this widget.
|
|
1963
|
+
*/
|
|
1964
|
+
allowlistedDomains?: string[] | null;
|
|
1965
|
+
/**
|
|
1966
|
+
* Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
|
|
1967
|
+
*/
|
|
1968
|
+
allowPublicAccess?: boolean | null;
|
|
1969
|
+
/**
|
|
1970
|
+
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
1971
|
+
*/
|
|
1972
|
+
configId?: string | null;
|
|
1973
|
+
/**
|
|
1974
|
+
* The content search spec that configs the desired behavior of content search.
|
|
1975
|
+
*/
|
|
1976
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1977
|
+
/**
|
|
1978
|
+
* Output only. Timestamp the WidgetConfig was created.
|
|
1979
|
+
*/
|
|
1980
|
+
createTime?: string | null;
|
|
1981
|
+
/**
|
|
1982
|
+
* Output only. The type of the parent data store.
|
|
1983
|
+
*/
|
|
1984
|
+
dataStoreType?: string | null;
|
|
1985
|
+
/**
|
|
1986
|
+
* Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1987
|
+
*/
|
|
1988
|
+
displayName?: string | null;
|
|
1989
|
+
/**
|
|
1990
|
+
* Whether or not to enable autocomplete.
|
|
1991
|
+
*/
|
|
1992
|
+
enableAutocomplete?: boolean | null;
|
|
1993
|
+
/**
|
|
1994
|
+
* Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
|
|
1995
|
+
*/
|
|
1996
|
+
enableConversationalSearch?: boolean | null;
|
|
1997
|
+
/**
|
|
1998
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
1999
|
+
*/
|
|
2000
|
+
enableQualityFeedback?: boolean | null;
|
|
2001
|
+
/**
|
|
2002
|
+
* Whether to show the result score.
|
|
2003
|
+
*/
|
|
2004
|
+
enableResultScore?: boolean | null;
|
|
2005
|
+
/**
|
|
2006
|
+
* Whether to enable safe search.
|
|
2007
|
+
*/
|
|
2008
|
+
enableSafeSearch?: boolean | null;
|
|
2009
|
+
/**
|
|
2010
|
+
* Turn on or off summary for each snippets result.
|
|
2011
|
+
*/
|
|
2012
|
+
enableSnippetResultSummary?: boolean | null;
|
|
2013
|
+
/**
|
|
2014
|
+
* Turn on or off summarization for the search response.
|
|
2015
|
+
*/
|
|
2016
|
+
enableSummarization?: boolean | null;
|
|
2017
|
+
/**
|
|
2018
|
+
* The configuration and appearance of facets in the end user view.
|
|
2019
|
+
*/
|
|
2020
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
2021
|
+
/**
|
|
2022
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
2023
|
+
*/
|
|
2024
|
+
fieldsUiComponentsMap?: {
|
|
2025
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2026
|
+
} | null;
|
|
2027
|
+
/**
|
|
2028
|
+
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2029
|
+
*/
|
|
2030
|
+
llmEnabled?: boolean | null;
|
|
2031
|
+
/**
|
|
2032
|
+
* Output only. Whether the customer accepted data use terms.
|
|
2033
|
+
*/
|
|
2034
|
+
minimumDataTermAccepted?: boolean | null;
|
|
2035
|
+
/**
|
|
2036
|
+
* 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 length limit of 1024 characters.
|
|
2037
|
+
*/
|
|
2038
|
+
name?: string | null;
|
|
2039
|
+
/**
|
|
2040
|
+
* 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.
|
|
2041
|
+
*/
|
|
2042
|
+
resultDisplayType?: string | null;
|
|
2043
|
+
/**
|
|
2044
|
+
* Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
|
|
2045
|
+
*/
|
|
2046
|
+
solutionType?: string | null;
|
|
2047
|
+
/**
|
|
2048
|
+
* Output only. Timestamp the WidgetConfig was updated.
|
|
2049
|
+
*/
|
|
2050
|
+
updateTime?: string | null;
|
|
2051
|
+
}
|
|
2052
|
+
/**
|
|
2053
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
2054
|
+
*/
|
|
2055
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
|
|
2056
|
+
/**
|
|
2057
|
+
* Optional. The field name that end users will see.
|
|
2058
|
+
*/
|
|
2059
|
+
displayName?: string | null;
|
|
2060
|
+
/**
|
|
2061
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2062
|
+
*/
|
|
2063
|
+
field?: string | null;
|
|
2064
|
+
}
|
|
2065
|
+
/**
|
|
2066
|
+
* Facet field that maps to a UI Component.
|
|
2067
|
+
*/
|
|
2068
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
|
|
2069
|
+
/**
|
|
2070
|
+
* The field visibility on different types of devices.
|
|
2071
|
+
*/
|
|
2072
|
+
deviceVisibility?: string[] | null;
|
|
2073
|
+
/**
|
|
2074
|
+
* The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
|
|
2075
|
+
*/
|
|
2076
|
+
displayTemplate?: string | null;
|
|
2077
|
+
/**
|
|
2078
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2079
|
+
*/
|
|
2080
|
+
field?: string | null;
|
|
2081
|
+
}
|
|
2082
|
+
/**
|
|
2083
|
+
* Request message for WidgetService.WidgetConverseConversation method.
|
|
2084
|
+
*/
|
|
2085
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest {
|
|
2086
|
+
/**
|
|
2087
|
+
* Additional params for security and privacy enhancement.
|
|
2088
|
+
*/
|
|
2089
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2090
|
+
/**
|
|
2091
|
+
* Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the user event collection.
|
|
2092
|
+
*/
|
|
2093
|
+
configId?: string | null;
|
|
2094
|
+
/**
|
|
2095
|
+
* The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
|
|
2096
|
+
*/
|
|
2097
|
+
conversationId?: string | null;
|
|
2098
|
+
/**
|
|
2099
|
+
* Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default.
|
|
2100
|
+
*/
|
|
2101
|
+
converseConversationRequest?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
|
|
2102
|
+
}
|
|
2103
|
+
/**
|
|
2104
|
+
* Response message for WidgetService.WidgetConverseConversation method.
|
|
2105
|
+
*/
|
|
2106
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse {
|
|
2107
|
+
/**
|
|
2108
|
+
* The id of the Conversation returned.
|
|
2109
|
+
*/
|
|
2110
|
+
conversationId?: string | null;
|
|
2111
|
+
/**
|
|
2112
|
+
* ConverseConversationResponse returned from ConversationalSearchService.ConverseConversation.
|
|
2113
|
+
*/
|
|
2114
|
+
converseConversationResponse?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse;
|
|
2115
|
+
/**
|
|
2116
|
+
* The token in response.
|
|
2117
|
+
*/
|
|
2118
|
+
uToken?: string | null;
|
|
2119
|
+
}
|
|
2120
|
+
/**
|
|
2121
|
+
* Request message for WidgetService.WidgetSearch method.
|
|
2122
|
+
*/
|
|
2123
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest {
|
|
2124
|
+
/**
|
|
2125
|
+
* Additional params for security and privacy enhancement.
|
|
2126
|
+
*/
|
|
2127
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2128
|
+
/**
|
|
2129
|
+
* Required. The UUID of the Search WidgetConfig. This field is used to identify the search widget configuration, set of models used to make the search.
|
|
2130
|
+
*/
|
|
2131
|
+
configId?: string | null;
|
|
2132
|
+
/**
|
|
2133
|
+
* Required. The search request to perform search.
|
|
2134
|
+
*/
|
|
2135
|
+
searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
2136
|
+
}
|
|
2137
|
+
/**
|
|
2138
|
+
* Response message for WidgetService.WidgetSearch method.
|
|
2139
|
+
*/
|
|
2140
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse {
|
|
2141
|
+
/**
|
|
2142
|
+
* The search response after performing search.
|
|
2143
|
+
*/
|
|
2144
|
+
searchResponse?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse;
|
|
2145
|
+
/**
|
|
2146
|
+
* The token in response.
|
|
2147
|
+
*/
|
|
2148
|
+
uToken?: string | null;
|
|
2149
|
+
}
|
|
1741
2150
|
/**
|
|
1742
2151
|
* Metadata for Create Schema LRO.
|
|
1743
2152
|
*/
|
|
@@ -2175,6 +2584,106 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2175
2584
|
*/
|
|
2176
2585
|
year?: number | null;
|
|
2177
2586
|
}
|
|
2587
|
+
export class Resource$Locations {
|
|
2588
|
+
context: APIRequestContext;
|
|
2589
|
+
constructor(context: APIRequestContext);
|
|
2590
|
+
/**
|
|
2591
|
+
* Gets the Widget Config using the uuid.
|
|
2592
|
+
*
|
|
2593
|
+
* @param params - Parameters for request
|
|
2594
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2595
|
+
* @param callback - Optional callback that handles the response.
|
|
2596
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2597
|
+
*/
|
|
2598
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2599
|
+
lookupWidgetConfig(params?: Params$Resource$Locations$Lookupwidgetconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
|
|
2600
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2601
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>): void;
|
|
2602
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>): void;
|
|
2603
|
+
lookupWidgetConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>): void;
|
|
2604
|
+
/**
|
|
2605
|
+
* Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It supports CompleteQuery with or without JWT token.
|
|
2606
|
+
*
|
|
2607
|
+
* @param params - Parameters for request
|
|
2608
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2609
|
+
* @param callback - Optional callback that handles the response.
|
|
2610
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2611
|
+
*/
|
|
2612
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2613
|
+
widgetCompleteQuery(params?: Params$Resource$Locations$Widgetcompletequery, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
|
|
2614
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2615
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>): void;
|
|
2616
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>): void;
|
|
2617
|
+
widgetCompleteQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>): void;
|
|
2618
|
+
/**
|
|
2619
|
+
* Converse a conversation with Widget.
|
|
2620
|
+
*
|
|
2621
|
+
* @param params - Parameters for request
|
|
2622
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2623
|
+
* @param callback - Optional callback that handles the response.
|
|
2624
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2625
|
+
*/
|
|
2626
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2627
|
+
widgetConverseConversation(params?: Params$Resource$Locations$Widgetconverseconversation, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
|
|
2628
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2629
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>): void;
|
|
2630
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>): void;
|
|
2631
|
+
widgetConverseConversation(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>): void;
|
|
2632
|
+
/**
|
|
2633
|
+
* Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token.
|
|
2634
|
+
*
|
|
2635
|
+
* @param params - Parameters for request
|
|
2636
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2637
|
+
* @param callback - Optional callback that handles the response.
|
|
2638
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2639
|
+
*/
|
|
2640
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2641
|
+
widgetSearch(params?: Params$Resource$Locations$Widgetsearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
|
|
2642
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2643
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>): void;
|
|
2644
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>): void;
|
|
2645
|
+
widgetSearch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>): void;
|
|
2646
|
+
}
|
|
2647
|
+
export interface Params$Resource$Locations$Lookupwidgetconfig extends StandardParameters {
|
|
2648
|
+
/**
|
|
2649
|
+
* Required. The location resource where lookup widget will be performed. Format: `locations/{location\}`
|
|
2650
|
+
*/
|
|
2651
|
+
location?: string;
|
|
2652
|
+
/**
|
|
2653
|
+
* Request body metadata
|
|
2654
|
+
*/
|
|
2655
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest;
|
|
2656
|
+
}
|
|
2657
|
+
export interface Params$Resource$Locations$Widgetcompletequery extends StandardParameters {
|
|
2658
|
+
/**
|
|
2659
|
+
* Required. The location resource where widget complete query will be performed. Format: `locations/{location\}`
|
|
2660
|
+
*/
|
|
2661
|
+
location?: string;
|
|
2662
|
+
/**
|
|
2663
|
+
* Request body metadata
|
|
2664
|
+
*/
|
|
2665
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
|
|
2666
|
+
}
|
|
2667
|
+
export interface Params$Resource$Locations$Widgetconverseconversation extends StandardParameters {
|
|
2668
|
+
/**
|
|
2669
|
+
* Required. The location resource where widget converse conversation will be performed. Format: `locations/{location\}`
|
|
2670
|
+
*/
|
|
2671
|
+
location?: string;
|
|
2672
|
+
/**
|
|
2673
|
+
* Request body metadata
|
|
2674
|
+
*/
|
|
2675
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
|
|
2676
|
+
}
|
|
2677
|
+
export interface Params$Resource$Locations$Widgetsearch extends StandardParameters {
|
|
2678
|
+
/**
|
|
2679
|
+
* Required. The location resource where widget search will be performed. Format: `locations/{location\}`
|
|
2680
|
+
*/
|
|
2681
|
+
location?: string;
|
|
2682
|
+
/**
|
|
2683
|
+
* Request body metadata
|
|
2684
|
+
*/
|
|
2685
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
|
|
2686
|
+
}
|
|
2178
2687
|
export class Resource$Projects {
|
|
2179
2688
|
context: APIRequestContext;
|
|
2180
2689
|
locations: Resource$Projects$Locations;
|
|
@@ -2235,7 +2744,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2235
2744
|
*/
|
|
2236
2745
|
query?: string;
|
|
2237
2746
|
/**
|
|
2238
|
-
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for
|
|
2747
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
2239
2748
|
*/
|
|
2240
2749
|
queryModel?: string;
|
|
2241
2750
|
/**
|
|
@@ -2996,6 +3505,30 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2996
3505
|
operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
|
|
2997
3506
|
targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
|
|
2998
3507
|
constructor(context: APIRequestContext);
|
|
3508
|
+
/**
|
|
3509
|
+
* Request on-demand recrawl for a list of URIs.
|
|
3510
|
+
*
|
|
3511
|
+
* @param params - Parameters for request
|
|
3512
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3513
|
+
* @param callback - Optional callback that handles the response.
|
|
3514
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3515
|
+
*/
|
|
3516
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3517
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
3518
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3519
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3520
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3521
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3522
|
+
}
|
|
3523
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
3524
|
+
/**
|
|
3525
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
3526
|
+
*/
|
|
3527
|
+
siteSearchEngine?: string;
|
|
3528
|
+
/**
|
|
3529
|
+
* Request body metadata
|
|
3530
|
+
*/
|
|
3531
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
2999
3532
|
}
|
|
3000
3533
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations {
|
|
3001
3534
|
context: APIRequestContext;
|
|
@@ -3225,6 +3758,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3225
3758
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
3226
3759
|
context: APIRequestContext;
|
|
3227
3760
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
3761
|
+
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
3228
3762
|
constructor(context: APIRequestContext);
|
|
3229
3763
|
}
|
|
3230
3764
|
export class Resource$Projects$Locations$Collections$Engines$Operations {
|
|
@@ -3283,6 +3817,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3283
3817
|
*/
|
|
3284
3818
|
pageToken?: string;
|
|
3285
3819
|
}
|
|
3820
|
+
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
3821
|
+
context: APIRequestContext;
|
|
3822
|
+
constructor(context: APIRequestContext);
|
|
3823
|
+
/**
|
|
3824
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
3825
|
+
*
|
|
3826
|
+
* @param params - Parameters for request
|
|
3827
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3828
|
+
* @param callback - Optional callback that handles the response.
|
|
3829
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3830
|
+
*/
|
|
3831
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3832
|
+
recommend(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
3833
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3834
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
3835
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
3836
|
+
recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
3837
|
+
/**
|
|
3838
|
+
* Performs a search.
|
|
3839
|
+
*
|
|
3840
|
+
* @param params - Parameters for request
|
|
3841
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3842
|
+
* @param callback - Optional callback that handles the response.
|
|
3843
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3844
|
+
*/
|
|
3845
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3846
|
+
search(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
3847
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3848
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
3849
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
3850
|
+
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
3851
|
+
}
|
|
3852
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
3853
|
+
/**
|
|
3854
|
+
* Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it.
|
|
3855
|
+
*/
|
|
3856
|
+
servingConfig?: string;
|
|
3857
|
+
/**
|
|
3858
|
+
* Request body metadata
|
|
3859
|
+
*/
|
|
3860
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
|
|
3861
|
+
}
|
|
3862
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
|
|
3863
|
+
/**
|
|
3864
|
+
* Required. The resource name of the Search serving config, such as `projects/x/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.
|
|
3865
|
+
*/
|
|
3866
|
+
servingConfig?: string;
|
|
3867
|
+
/**
|
|
3868
|
+
* Request body metadata
|
|
3869
|
+
*/
|
|
3870
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
3871
|
+
}
|
|
3286
3872
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
3287
3873
|
context: APIRequestContext;
|
|
3288
3874
|
constructor(context: APIRequestContext);
|
|
@@ -3347,6 +3933,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3347
3933
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
3348
3934
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
3349
3935
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
3936
|
+
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
3350
3937
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
3351
3938
|
constructor(context: APIRequestContext);
|
|
3352
3939
|
/**
|
|
@@ -3378,7 +3965,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3378
3965
|
*/
|
|
3379
3966
|
query?: string;
|
|
3380
3967
|
/**
|
|
3381
|
-
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for
|
|
3968
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
3382
3969
|
*/
|
|
3383
3970
|
queryModel?: string;
|
|
3384
3971
|
/**
|
|
@@ -4077,6 +4664,34 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4077
4664
|
*/
|
|
4078
4665
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
4079
4666
|
}
|
|
4667
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
4668
|
+
context: APIRequestContext;
|
|
4669
|
+
constructor(context: APIRequestContext);
|
|
4670
|
+
/**
|
|
4671
|
+
* Request on-demand recrawl for a list of URIs.
|
|
4672
|
+
*
|
|
4673
|
+
* @param params - Parameters for request
|
|
4674
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4675
|
+
* @param callback - Optional callback that handles the response.
|
|
4676
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4677
|
+
*/
|
|
4678
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4679
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4680
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4681
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4682
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4683
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4684
|
+
}
|
|
4685
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
4686
|
+
/**
|
|
4687
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
4688
|
+
*/
|
|
4689
|
+
siteSearchEngine?: string;
|
|
4690
|
+
/**
|
|
4691
|
+
* Request body metadata
|
|
4692
|
+
*/
|
|
4693
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
4694
|
+
}
|
|
4080
4695
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
4081
4696
|
context: APIRequestContext;
|
|
4082
4697
|
constructor(context: APIRequestContext);
|