@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/v1alpha.ts
CHANGED
|
@@ -112,6 +112,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
112
112
|
*/
|
|
113
113
|
export class Discoveryengine {
|
|
114
114
|
context: APIRequestContext;
|
|
115
|
+
locations: Resource$Locations;
|
|
115
116
|
projects: Resource$Projects;
|
|
116
117
|
|
|
117
118
|
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
|
|
@@ -120,6 +121,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
120
121
|
google,
|
|
121
122
|
};
|
|
122
123
|
|
|
124
|
+
this.locations = new Resource$Locations(this.context);
|
|
123
125
|
this.projects = new Resource$Projects(this.context);
|
|
124
126
|
}
|
|
125
127
|
}
|
|
@@ -239,6 +241,15 @@ export namespace discoveryengine_v1alpha {
|
|
|
239
241
|
*/
|
|
240
242
|
functionName?: string | null;
|
|
241
243
|
}
|
|
244
|
+
/**
|
|
245
|
+
* AdditionalParams message for WidgetService methods for security and privacy enhancement.
|
|
246
|
+
*/
|
|
247
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams {
|
|
248
|
+
/**
|
|
249
|
+
* Token that used for non-human user check.
|
|
250
|
+
*/
|
|
251
|
+
token?: string | null;
|
|
252
|
+
}
|
|
242
253
|
/**
|
|
243
254
|
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
244
255
|
*/
|
|
@@ -277,6 +288,31 @@ export namespace discoveryengine_v1alpha {
|
|
|
277
288
|
*/
|
|
278
289
|
tableId?: string | null;
|
|
279
290
|
}
|
|
291
|
+
/**
|
|
292
|
+
* Request message for CompletionService.CompleteQuery method.
|
|
293
|
+
*/
|
|
294
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
|
|
295
|
+
/**
|
|
296
|
+
* 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`.
|
|
297
|
+
*/
|
|
298
|
+
dataStore?: string | null;
|
|
299
|
+
/**
|
|
300
|
+
* 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.
|
|
301
|
+
*/
|
|
302
|
+
includeTailSuggestions?: boolean | null;
|
|
303
|
+
/**
|
|
304
|
+
* Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
|
|
305
|
+
*/
|
|
306
|
+
query?: string | null;
|
|
307
|
+
/**
|
|
308
|
+
* 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.
|
|
309
|
+
*/
|
|
310
|
+
queryModel?: string | null;
|
|
311
|
+
/**
|
|
312
|
+
* 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.
|
|
313
|
+
*/
|
|
314
|
+
userPseudoId?: string | null;
|
|
315
|
+
}
|
|
280
316
|
/**
|
|
281
317
|
* Response message for CompletionService.CompleteQuery method.
|
|
282
318
|
*/
|
|
@@ -297,7 +333,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
297
333
|
/**
|
|
298
334
|
* 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.
|
|
299
335
|
*/
|
|
300
|
-
|
|
336
|
+
completableFieldPaths?: string[] | null;
|
|
301
337
|
/**
|
|
302
338
|
* The suggestion for the query.
|
|
303
339
|
*/
|
|
@@ -383,6 +419,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
383
419
|
* 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.
|
|
384
420
|
*/
|
|
385
421
|
conversation?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
|
|
422
|
+
/**
|
|
423
|
+
* 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.
|
|
424
|
+
*/
|
|
425
|
+
name?: string | null;
|
|
386
426
|
/**
|
|
387
427
|
* Required. Current user input.
|
|
388
428
|
*/
|
|
@@ -395,6 +435,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
395
435
|
* 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.
|
|
396
436
|
*/
|
|
397
437
|
servingConfig?: string | null;
|
|
438
|
+
/**
|
|
439
|
+
* A specification for configuring the summary returned in the response.
|
|
440
|
+
*/
|
|
441
|
+
summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
398
442
|
/**
|
|
399
443
|
* 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.
|
|
400
444
|
*/
|
|
@@ -819,6 +863,24 @@ export namespace discoveryengine_v1alpha {
|
|
|
819
863
|
*/
|
|
820
864
|
schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
821
865
|
}
|
|
866
|
+
/**
|
|
867
|
+
* Request message for WidgetService.LookupWidgetConfig method.
|
|
868
|
+
*/
|
|
869
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest {
|
|
870
|
+
/**
|
|
871
|
+
* Required. The UUID of the Widget Config.
|
|
872
|
+
*/
|
|
873
|
+
widgetConfigId?: string | null;
|
|
874
|
+
}
|
|
875
|
+
/**
|
|
876
|
+
* Response message for WidgetService.LookupWidgetConfig method.
|
|
877
|
+
*/
|
|
878
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse {
|
|
879
|
+
/**
|
|
880
|
+
* The Anonymous Widget Config associated with the UUID.
|
|
881
|
+
*/
|
|
882
|
+
anonymousWidgetConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig;
|
|
883
|
+
}
|
|
822
884
|
/**
|
|
823
885
|
* Media-specific user event information.
|
|
824
886
|
*/
|
|
@@ -1031,6 +1093,87 @@ export namespace discoveryengine_v1alpha {
|
|
|
1031
1093
|
*/
|
|
1032
1094
|
metadata?: {[key: string]: any} | null;
|
|
1033
1095
|
}
|
|
1096
|
+
/**
|
|
1097
|
+
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1098
|
+
*/
|
|
1099
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
1100
|
+
/**
|
|
1101
|
+
* Operation create time.
|
|
1102
|
+
*/
|
|
1103
|
+
createTime?: string | null;
|
|
1104
|
+
/**
|
|
1105
|
+
* 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.
|
|
1106
|
+
*/
|
|
1107
|
+
invalidUris?: string[] | null;
|
|
1108
|
+
/**
|
|
1109
|
+
* Total number of URIs that have yet to be crawled.
|
|
1110
|
+
*/
|
|
1111
|
+
pendingCount?: number | null;
|
|
1112
|
+
/**
|
|
1113
|
+
* Total number of URIs that were rejected due to insufficient indexing resources.
|
|
1114
|
+
*/
|
|
1115
|
+
quotaExceededCount?: number | null;
|
|
1116
|
+
/**
|
|
1117
|
+
* Total number of URIs that have been crawled so far.
|
|
1118
|
+
*/
|
|
1119
|
+
successCount?: number | null;
|
|
1120
|
+
/**
|
|
1121
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1122
|
+
*/
|
|
1123
|
+
updateTime?: string | null;
|
|
1124
|
+
/**
|
|
1125
|
+
* Total number of unique URIs in the request that are not in invalid_uris.
|
|
1126
|
+
*/
|
|
1127
|
+
validUrisCount?: number | null;
|
|
1128
|
+
}
|
|
1129
|
+
/**
|
|
1130
|
+
* Request message for SiteSearchEngineService.RecrawlUris method.
|
|
1131
|
+
*/
|
|
1132
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest {
|
|
1133
|
+
/**
|
|
1134
|
+
* 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`.
|
|
1135
|
+
*/
|
|
1136
|
+
uris?: string[] | null;
|
|
1137
|
+
}
|
|
1138
|
+
/**
|
|
1139
|
+
* Response message for SiteSearchEngineService.RecrawlUris method.
|
|
1140
|
+
*/
|
|
1141
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
|
|
1142
|
+
/**
|
|
1143
|
+
* URIs that were not crawled before the LRO terminated.
|
|
1144
|
+
*/
|
|
1145
|
+
failedUris?: string[] | null;
|
|
1146
|
+
/**
|
|
1147
|
+
* Details for a sample of up to 10 `failed_uris`.
|
|
1148
|
+
*/
|
|
1149
|
+
failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
|
|
1150
|
+
}
|
|
1151
|
+
/**
|
|
1152
|
+
* Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
|
|
1153
|
+
*/
|
|
1154
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
|
|
1155
|
+
/**
|
|
1156
|
+
* List of failure reasons by corpus type (e.g. desktop, mobile).
|
|
1157
|
+
*/
|
|
1158
|
+
failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
|
|
1159
|
+
/**
|
|
1160
|
+
* URI that failed to be crawled.
|
|
1161
|
+
*/
|
|
1162
|
+
uri?: string | null;
|
|
1163
|
+
}
|
|
1164
|
+
/**
|
|
1165
|
+
* Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1166
|
+
*/
|
|
1167
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1168
|
+
/**
|
|
1169
|
+
* DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
|
|
1170
|
+
*/
|
|
1171
|
+
corpusType?: string | null;
|
|
1172
|
+
/**
|
|
1173
|
+
* Reason why the URI was not crawled.
|
|
1174
|
+
*/
|
|
1175
|
+
errorMessage?: string | null;
|
|
1176
|
+
}
|
|
1034
1177
|
/**
|
|
1035
1178
|
* Defines a reply message to user.
|
|
1036
1179
|
*/
|
|
@@ -1175,6 +1318,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1175
1318
|
* Whether to turn on safe search. This is only supported for website search.
|
|
1176
1319
|
*/
|
|
1177
1320
|
safeSearch?: boolean | null;
|
|
1321
|
+
/**
|
|
1322
|
+
* 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.
|
|
1323
|
+
*/
|
|
1324
|
+
servingConfig?: string | null;
|
|
1178
1325
|
/**
|
|
1179
1326
|
* The spell correction specification that specifies the mode under which spell correction takes effect.
|
|
1180
1327
|
*/
|
|
@@ -1244,9 +1391,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
1244
1391
|
*/
|
|
1245
1392
|
maxExtractiveSegmentCount?: number | null;
|
|
1246
1393
|
/**
|
|
1247
|
-
*
|
|
1394
|
+
* Return at most `num_next_segments` segments after each selected segments.
|
|
1395
|
+
*/
|
|
1396
|
+
numNextSegments?: number | null;
|
|
1397
|
+
/**
|
|
1398
|
+
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
1248
1399
|
*/
|
|
1249
|
-
|
|
1400
|
+
numPreviousSegments?: number | null;
|
|
1250
1401
|
}
|
|
1251
1402
|
/**
|
|
1252
1403
|
* A specification for configuring snippets in a search response.
|
|
@@ -1282,7 +1433,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1282
1433
|
*/
|
|
1283
1434
|
includeCitations?: boolean | null;
|
|
1284
1435
|
/**
|
|
1285
|
-
* Language code for Summary. Use language tags defined by BCP47.
|
|
1436
|
+
* 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.
|
|
1286
1437
|
*/
|
|
1287
1438
|
languageCode?: string | null;
|
|
1288
1439
|
/**
|
|
@@ -1417,6 +1568,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1417
1568
|
* Results of facets requested by user.
|
|
1418
1569
|
*/
|
|
1419
1570
|
facets?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[];
|
|
1571
|
+
geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[];
|
|
1420
1572
|
/**
|
|
1421
1573
|
* Guided search result.
|
|
1422
1574
|
*/
|
|
@@ -1480,6 +1632,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1480
1632
|
*/
|
|
1481
1633
|
value?: string | null;
|
|
1482
1634
|
}
|
|
1635
|
+
/**
|
|
1636
|
+
* Debug information specifically related to forward geocoding issues arising from Geolocation Search.
|
|
1637
|
+
*/
|
|
1638
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo {
|
|
1639
|
+
/**
|
|
1640
|
+
* The error produced.
|
|
1641
|
+
*/
|
|
1642
|
+
errorMessage?: string | null;
|
|
1643
|
+
/**
|
|
1644
|
+
* The address from which forward geocoding ingestion produced issues.
|
|
1645
|
+
*/
|
|
1646
|
+
originalAddressQuery?: string | null;
|
|
1647
|
+
}
|
|
1483
1648
|
/**
|
|
1484
1649
|
* 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.
|
|
1485
1650
|
*/
|
|
@@ -1542,6 +1707,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1542
1707
|
* Summary of the top N search result specified by the summary spec.
|
|
1543
1708
|
*/
|
|
1544
1709
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummary {
|
|
1710
|
+
/**
|
|
1711
|
+
* A collection of Safety Attribute categories and their associated confidence scores.
|
|
1712
|
+
*/
|
|
1713
|
+
safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes;
|
|
1545
1714
|
/**
|
|
1546
1715
|
* Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1547
1716
|
*/
|
|
@@ -1551,6 +1720,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1551
1720
|
*/
|
|
1552
1721
|
summaryText?: string | null;
|
|
1553
1722
|
}
|
|
1723
|
+
/**
|
|
1724
|
+
* Safety Attribute categories and their associated confidence scores.
|
|
1725
|
+
*/
|
|
1726
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
|
|
1727
|
+
/**
|
|
1728
|
+
* The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
|
|
1729
|
+
*/
|
|
1730
|
+
categories?: string[] | null;
|
|
1731
|
+
/**
|
|
1732
|
+
* The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
|
|
1733
|
+
*/
|
|
1734
|
+
scores?: number[] | null;
|
|
1735
|
+
}
|
|
1554
1736
|
/**
|
|
1555
1737
|
* Verification information for target sites in advanced site search.
|
|
1556
1738
|
*/
|
|
@@ -1614,12 +1796,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1614
1796
|
*/
|
|
1615
1797
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
1616
1798
|
}
|
|
1617
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
1618
|
-
/**
|
|
1619
|
-
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
1620
|
-
*/
|
|
1621
|
-
totalRequiredQuota?: string | null;
|
|
1622
|
-
}
|
|
1799
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {}
|
|
1623
1800
|
/**
|
|
1624
1801
|
* Defines text input.
|
|
1625
1802
|
*/
|
|
@@ -1767,6 +1944,240 @@ export namespace discoveryengine_v1alpha {
|
|
|
1767
1944
|
*/
|
|
1768
1945
|
userId?: string | null;
|
|
1769
1946
|
}
|
|
1947
|
+
/**
|
|
1948
|
+
* Request message for WidgetService.WidgetCompleteQuery method.
|
|
1949
|
+
*/
|
|
1950
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest {
|
|
1951
|
+
/**
|
|
1952
|
+
* Additional params for security and privacy enhancement.
|
|
1953
|
+
*/
|
|
1954
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
1955
|
+
/**
|
|
1956
|
+
* Required. The CompleteQuery request to perform auto-complete suggestion query.
|
|
1957
|
+
*/
|
|
1958
|
+
completeQueryRequest?: Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest;
|
|
1959
|
+
/**
|
|
1960
|
+
* 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.
|
|
1961
|
+
*/
|
|
1962
|
+
configId?: string | null;
|
|
1963
|
+
}
|
|
1964
|
+
/**
|
|
1965
|
+
* Response message for WidgetService.WidgetCompleteQuery method.
|
|
1966
|
+
*/
|
|
1967
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse {
|
|
1968
|
+
/**
|
|
1969
|
+
* The token in response.
|
|
1970
|
+
*/
|
|
1971
|
+
uToken?: string | null;
|
|
1972
|
+
/**
|
|
1973
|
+
* Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion.
|
|
1974
|
+
*/
|
|
1975
|
+
widgetQuerySuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion[];
|
|
1976
|
+
}
|
|
1977
|
+
/**
|
|
1978
|
+
* Suggestions as search queries.
|
|
1979
|
+
*/
|
|
1980
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion {
|
|
1981
|
+
/**
|
|
1982
|
+
* The suggestion for the query.
|
|
1983
|
+
*/
|
|
1984
|
+
suggestion?: string | null;
|
|
1985
|
+
}
|
|
1986
|
+
/**
|
|
1987
|
+
* WidgetConfig captures configs at the Widget level.
|
|
1988
|
+
*/
|
|
1989
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig {
|
|
1990
|
+
/**
|
|
1991
|
+
* Allowlisted domains that can load this widget.
|
|
1992
|
+
*/
|
|
1993
|
+
allowlistedDomains?: string[] | null;
|
|
1994
|
+
/**
|
|
1995
|
+
* 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.
|
|
1996
|
+
*/
|
|
1997
|
+
allowPublicAccess?: boolean | null;
|
|
1998
|
+
/**
|
|
1999
|
+
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
2000
|
+
*/
|
|
2001
|
+
configId?: string | null;
|
|
2002
|
+
/**
|
|
2003
|
+
* The content search spec that configs the desired behavior of content search.
|
|
2004
|
+
*/
|
|
2005
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
2006
|
+
/**
|
|
2007
|
+
* Output only. Timestamp the WidgetConfig was created.
|
|
2008
|
+
*/
|
|
2009
|
+
createTime?: string | null;
|
|
2010
|
+
/**
|
|
2011
|
+
* Output only. The type of the parent data store.
|
|
2012
|
+
*/
|
|
2013
|
+
dataStoreType?: string | null;
|
|
2014
|
+
/**
|
|
2015
|
+
* 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.
|
|
2016
|
+
*/
|
|
2017
|
+
displayName?: string | null;
|
|
2018
|
+
/**
|
|
2019
|
+
* Whether or not to enable autocomplete.
|
|
2020
|
+
*/
|
|
2021
|
+
enableAutocomplete?: boolean | null;
|
|
2022
|
+
/**
|
|
2023
|
+
* Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
|
|
2024
|
+
*/
|
|
2025
|
+
enableConversationalSearch?: boolean | null;
|
|
2026
|
+
/**
|
|
2027
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
2028
|
+
*/
|
|
2029
|
+
enableQualityFeedback?: boolean | null;
|
|
2030
|
+
/**
|
|
2031
|
+
* Whether to show the result score.
|
|
2032
|
+
*/
|
|
2033
|
+
enableResultScore?: boolean | null;
|
|
2034
|
+
/**
|
|
2035
|
+
* Whether to enable safe search.
|
|
2036
|
+
*/
|
|
2037
|
+
enableSafeSearch?: boolean | null;
|
|
2038
|
+
/**
|
|
2039
|
+
* Turn on or off summary for each snippets result.
|
|
2040
|
+
*/
|
|
2041
|
+
enableSnippetResultSummary?: boolean | null;
|
|
2042
|
+
/**
|
|
2043
|
+
* Turn on or off summarization for the search response.
|
|
2044
|
+
*/
|
|
2045
|
+
enableSummarization?: boolean | null;
|
|
2046
|
+
/**
|
|
2047
|
+
* The configuration and appearance of facets in the end user view.
|
|
2048
|
+
*/
|
|
2049
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
2050
|
+
/**
|
|
2051
|
+
* 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.
|
|
2052
|
+
*/
|
|
2053
|
+
fieldsUiComponentsMap?: {
|
|
2054
|
+
[
|
|
2055
|
+
key: string
|
|
2056
|
+
]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2057
|
+
} | null;
|
|
2058
|
+
/**
|
|
2059
|
+
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2060
|
+
*/
|
|
2061
|
+
llmEnabled?: boolean | null;
|
|
2062
|
+
/**
|
|
2063
|
+
* Output only. Whether the customer accepted data use terms.
|
|
2064
|
+
*/
|
|
2065
|
+
minimumDataTermAccepted?: boolean | null;
|
|
2066
|
+
/**
|
|
2067
|
+
* 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.
|
|
2068
|
+
*/
|
|
2069
|
+
name?: string | null;
|
|
2070
|
+
/**
|
|
2071
|
+
* 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.
|
|
2072
|
+
*/
|
|
2073
|
+
resultDisplayType?: string | null;
|
|
2074
|
+
/**
|
|
2075
|
+
* Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
|
|
2076
|
+
*/
|
|
2077
|
+
solutionType?: string | null;
|
|
2078
|
+
/**
|
|
2079
|
+
* Output only. Timestamp the WidgetConfig was updated.
|
|
2080
|
+
*/
|
|
2081
|
+
updateTime?: string | null;
|
|
2082
|
+
}
|
|
2083
|
+
/**
|
|
2084
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
2085
|
+
*/
|
|
2086
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
|
|
2087
|
+
/**
|
|
2088
|
+
* Optional. The field name that end users will see.
|
|
2089
|
+
*/
|
|
2090
|
+
displayName?: string | null;
|
|
2091
|
+
/**
|
|
2092
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2093
|
+
*/
|
|
2094
|
+
field?: string | null;
|
|
2095
|
+
}
|
|
2096
|
+
/**
|
|
2097
|
+
* Facet field that maps to a UI Component.
|
|
2098
|
+
*/
|
|
2099
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
|
|
2100
|
+
/**
|
|
2101
|
+
* The field visibility on different types of devices.
|
|
2102
|
+
*/
|
|
2103
|
+
deviceVisibility?: string[] | null;
|
|
2104
|
+
/**
|
|
2105
|
+
* The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
|
|
2106
|
+
*/
|
|
2107
|
+
displayTemplate?: string | null;
|
|
2108
|
+
/**
|
|
2109
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2110
|
+
*/
|
|
2111
|
+
field?: string | null;
|
|
2112
|
+
}
|
|
2113
|
+
/**
|
|
2114
|
+
* Request message for WidgetService.WidgetConverseConversation method.
|
|
2115
|
+
*/
|
|
2116
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest {
|
|
2117
|
+
/**
|
|
2118
|
+
* Additional params for security and privacy enhancement.
|
|
2119
|
+
*/
|
|
2120
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2121
|
+
/**
|
|
2122
|
+
* 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.
|
|
2123
|
+
*/
|
|
2124
|
+
configId?: string | null;
|
|
2125
|
+
/**
|
|
2126
|
+
* The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
|
|
2127
|
+
*/
|
|
2128
|
+
conversationId?: string | null;
|
|
2129
|
+
/**
|
|
2130
|
+
* Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default.
|
|
2131
|
+
*/
|
|
2132
|
+
converseConversationRequest?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
|
|
2133
|
+
}
|
|
2134
|
+
/**
|
|
2135
|
+
* Response message for WidgetService.WidgetConverseConversation method.
|
|
2136
|
+
*/
|
|
2137
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse {
|
|
2138
|
+
/**
|
|
2139
|
+
* The id of the Conversation returned.
|
|
2140
|
+
*/
|
|
2141
|
+
conversationId?: string | null;
|
|
2142
|
+
/**
|
|
2143
|
+
* ConverseConversationResponse returned from ConversationalSearchService.ConverseConversation.
|
|
2144
|
+
*/
|
|
2145
|
+
converseConversationResponse?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse;
|
|
2146
|
+
/**
|
|
2147
|
+
* The token in response.
|
|
2148
|
+
*/
|
|
2149
|
+
uToken?: string | null;
|
|
2150
|
+
}
|
|
2151
|
+
/**
|
|
2152
|
+
* Request message for WidgetService.WidgetSearch method.
|
|
2153
|
+
*/
|
|
2154
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest {
|
|
2155
|
+
/**
|
|
2156
|
+
* Additional params for security and privacy enhancement.
|
|
2157
|
+
*/
|
|
2158
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2159
|
+
/**
|
|
2160
|
+
* 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.
|
|
2161
|
+
*/
|
|
2162
|
+
configId?: string | null;
|
|
2163
|
+
/**
|
|
2164
|
+
* Required. The search request to perform search.
|
|
2165
|
+
*/
|
|
2166
|
+
searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
2167
|
+
}
|
|
2168
|
+
/**
|
|
2169
|
+
* Response message for WidgetService.WidgetSearch method.
|
|
2170
|
+
*/
|
|
2171
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse {
|
|
2172
|
+
/**
|
|
2173
|
+
* The search response after performing search.
|
|
2174
|
+
*/
|
|
2175
|
+
searchResponse?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse;
|
|
2176
|
+
/**
|
|
2177
|
+
* The token in response.
|
|
2178
|
+
*/
|
|
2179
|
+
uToken?: string | null;
|
|
2180
|
+
}
|
|
1770
2181
|
/**
|
|
1771
2182
|
* Metadata for Create Schema LRO.
|
|
1772
2183
|
*/
|
|
@@ -2194,23 +2605,466 @@ export namespace discoveryengine_v1alpha {
|
|
|
2194
2605
|
year?: number | null;
|
|
2195
2606
|
}
|
|
2196
2607
|
|
|
2197
|
-
export class Resource$
|
|
2608
|
+
export class Resource$Locations {
|
|
2198
2609
|
context: APIRequestContext;
|
|
2199
|
-
locations: Resource$Projects$Locations;
|
|
2200
|
-
operations: Resource$Projects$Operations;
|
|
2201
2610
|
constructor(context: APIRequestContext) {
|
|
2202
2611
|
this.context = context;
|
|
2203
|
-
this.locations = new Resource$Projects$Locations(this.context);
|
|
2204
|
-
this.operations = new Resource$Projects$Operations(this.context);
|
|
2205
2612
|
}
|
|
2206
|
-
}
|
|
2207
2613
|
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2614
|
+
/**
|
|
2615
|
+
* Gets the Widget Config using the uuid.
|
|
2616
|
+
*
|
|
2617
|
+
* @param params - Parameters for request
|
|
2618
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2619
|
+
* @param callback - Optional callback that handles the response.
|
|
2620
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2621
|
+
*/
|
|
2622
|
+
lookupWidgetConfig(
|
|
2623
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2624
|
+
options: StreamMethodOptions
|
|
2625
|
+
): GaxiosPromise<Readable>;
|
|
2626
|
+
lookupWidgetConfig(
|
|
2627
|
+
params?: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2628
|
+
options?: MethodOptions
|
|
2629
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
|
|
2630
|
+
lookupWidgetConfig(
|
|
2631
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2632
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2633
|
+
callback: BodyResponseCallback<Readable>
|
|
2634
|
+
): void;
|
|
2635
|
+
lookupWidgetConfig(
|
|
2636
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2637
|
+
options:
|
|
2638
|
+
| MethodOptions
|
|
2639
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>,
|
|
2640
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2641
|
+
): void;
|
|
2642
|
+
lookupWidgetConfig(
|
|
2643
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2644
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2645
|
+
): void;
|
|
2646
|
+
lookupWidgetConfig(
|
|
2647
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2648
|
+
): void;
|
|
2649
|
+
lookupWidgetConfig(
|
|
2650
|
+
paramsOrCallback?:
|
|
2651
|
+
| Params$Resource$Locations$Lookupwidgetconfig
|
|
2652
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2653
|
+
| BodyResponseCallback<Readable>,
|
|
2654
|
+
optionsOrCallback?:
|
|
2655
|
+
| MethodOptions
|
|
2656
|
+
| StreamMethodOptions
|
|
2657
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2658
|
+
| BodyResponseCallback<Readable>,
|
|
2659
|
+
callback?:
|
|
2660
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2661
|
+
| BodyResponseCallback<Readable>
|
|
2662
|
+
):
|
|
2663
|
+
| void
|
|
2664
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2665
|
+
| GaxiosPromise<Readable> {
|
|
2666
|
+
let params = (paramsOrCallback ||
|
|
2667
|
+
{}) as Params$Resource$Locations$Lookupwidgetconfig;
|
|
2668
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2669
|
+
|
|
2670
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2671
|
+
callback = paramsOrCallback;
|
|
2672
|
+
params = {} as Params$Resource$Locations$Lookupwidgetconfig;
|
|
2673
|
+
options = {};
|
|
2674
|
+
}
|
|
2675
|
+
|
|
2676
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2677
|
+
callback = optionsOrCallback;
|
|
2678
|
+
options = {};
|
|
2679
|
+
}
|
|
2680
|
+
|
|
2681
|
+
const rootUrl =
|
|
2682
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2683
|
+
const parameters = {
|
|
2684
|
+
options: Object.assign(
|
|
2685
|
+
{
|
|
2686
|
+
url: (rootUrl + '/v1alpha/{+location}/lookupWidgetConfig').replace(
|
|
2687
|
+
/([^:]\/)\/+/g,
|
|
2688
|
+
'$1'
|
|
2689
|
+
),
|
|
2690
|
+
method: 'POST',
|
|
2691
|
+
},
|
|
2692
|
+
options
|
|
2693
|
+
),
|
|
2694
|
+
params,
|
|
2695
|
+
requiredParams: ['location'],
|
|
2696
|
+
pathParams: ['location'],
|
|
2697
|
+
context: this.context,
|
|
2698
|
+
};
|
|
2699
|
+
if (callback) {
|
|
2700
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>(
|
|
2701
|
+
parameters,
|
|
2702
|
+
callback as BodyResponseCallback<unknown>
|
|
2703
|
+
);
|
|
2704
|
+
} else {
|
|
2705
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>(
|
|
2706
|
+
parameters
|
|
2707
|
+
);
|
|
2708
|
+
}
|
|
2709
|
+
}
|
|
2710
|
+
|
|
2711
|
+
/**
|
|
2712
|
+
* 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.
|
|
2713
|
+
*
|
|
2714
|
+
* @param params - Parameters for request
|
|
2715
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2716
|
+
* @param callback - Optional callback that handles the response.
|
|
2717
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2718
|
+
*/
|
|
2719
|
+
widgetCompleteQuery(
|
|
2720
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2721
|
+
options: StreamMethodOptions
|
|
2722
|
+
): GaxiosPromise<Readable>;
|
|
2723
|
+
widgetCompleteQuery(
|
|
2724
|
+
params?: Params$Resource$Locations$Widgetcompletequery,
|
|
2725
|
+
options?: MethodOptions
|
|
2726
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
|
|
2727
|
+
widgetCompleteQuery(
|
|
2728
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2729
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2730
|
+
callback: BodyResponseCallback<Readable>
|
|
2731
|
+
): void;
|
|
2732
|
+
widgetCompleteQuery(
|
|
2733
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2734
|
+
options:
|
|
2735
|
+
| MethodOptions
|
|
2736
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>,
|
|
2737
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2738
|
+
): void;
|
|
2739
|
+
widgetCompleteQuery(
|
|
2740
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2741
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2742
|
+
): void;
|
|
2743
|
+
widgetCompleteQuery(
|
|
2744
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2745
|
+
): void;
|
|
2746
|
+
widgetCompleteQuery(
|
|
2747
|
+
paramsOrCallback?:
|
|
2748
|
+
| Params$Resource$Locations$Widgetcompletequery
|
|
2749
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2750
|
+
| BodyResponseCallback<Readable>,
|
|
2751
|
+
optionsOrCallback?:
|
|
2752
|
+
| MethodOptions
|
|
2753
|
+
| StreamMethodOptions
|
|
2754
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2755
|
+
| BodyResponseCallback<Readable>,
|
|
2756
|
+
callback?:
|
|
2757
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2758
|
+
| BodyResponseCallback<Readable>
|
|
2759
|
+
):
|
|
2760
|
+
| void
|
|
2761
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2762
|
+
| GaxiosPromise<Readable> {
|
|
2763
|
+
let params = (paramsOrCallback ||
|
|
2764
|
+
{}) as Params$Resource$Locations$Widgetcompletequery;
|
|
2765
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2766
|
+
|
|
2767
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2768
|
+
callback = paramsOrCallback;
|
|
2769
|
+
params = {} as Params$Resource$Locations$Widgetcompletequery;
|
|
2770
|
+
options = {};
|
|
2771
|
+
}
|
|
2772
|
+
|
|
2773
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2774
|
+
callback = optionsOrCallback;
|
|
2775
|
+
options = {};
|
|
2776
|
+
}
|
|
2777
|
+
|
|
2778
|
+
const rootUrl =
|
|
2779
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2780
|
+
const parameters = {
|
|
2781
|
+
options: Object.assign(
|
|
2782
|
+
{
|
|
2783
|
+
url: (rootUrl + '/v1alpha/{+location}/widgetCompleteQuery').replace(
|
|
2784
|
+
/([^:]\/)\/+/g,
|
|
2785
|
+
'$1'
|
|
2786
|
+
),
|
|
2787
|
+
method: 'POST',
|
|
2788
|
+
},
|
|
2789
|
+
options
|
|
2790
|
+
),
|
|
2791
|
+
params,
|
|
2792
|
+
requiredParams: ['location'],
|
|
2793
|
+
pathParams: ['location'],
|
|
2794
|
+
context: this.context,
|
|
2795
|
+
};
|
|
2796
|
+
if (callback) {
|
|
2797
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>(
|
|
2798
|
+
parameters,
|
|
2799
|
+
callback as BodyResponseCallback<unknown>
|
|
2800
|
+
);
|
|
2801
|
+
} else {
|
|
2802
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>(
|
|
2803
|
+
parameters
|
|
2804
|
+
);
|
|
2805
|
+
}
|
|
2806
|
+
}
|
|
2807
|
+
|
|
2808
|
+
/**
|
|
2809
|
+
* Converse a conversation with Widget.
|
|
2810
|
+
*
|
|
2811
|
+
* @param params - Parameters for request
|
|
2812
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2813
|
+
* @param callback - Optional callback that handles the response.
|
|
2814
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2815
|
+
*/
|
|
2816
|
+
widgetConverseConversation(
|
|
2817
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2818
|
+
options: StreamMethodOptions
|
|
2819
|
+
): GaxiosPromise<Readable>;
|
|
2820
|
+
widgetConverseConversation(
|
|
2821
|
+
params?: Params$Resource$Locations$Widgetconverseconversation,
|
|
2822
|
+
options?: MethodOptions
|
|
2823
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
|
|
2824
|
+
widgetConverseConversation(
|
|
2825
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2826
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2827
|
+
callback: BodyResponseCallback<Readable>
|
|
2828
|
+
): void;
|
|
2829
|
+
widgetConverseConversation(
|
|
2830
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2831
|
+
options:
|
|
2832
|
+
| MethodOptions
|
|
2833
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>,
|
|
2834
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2835
|
+
): void;
|
|
2836
|
+
widgetConverseConversation(
|
|
2837
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2838
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2839
|
+
): void;
|
|
2840
|
+
widgetConverseConversation(
|
|
2841
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2842
|
+
): void;
|
|
2843
|
+
widgetConverseConversation(
|
|
2844
|
+
paramsOrCallback?:
|
|
2845
|
+
| Params$Resource$Locations$Widgetconverseconversation
|
|
2846
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2847
|
+
| BodyResponseCallback<Readable>,
|
|
2848
|
+
optionsOrCallback?:
|
|
2849
|
+
| MethodOptions
|
|
2850
|
+
| StreamMethodOptions
|
|
2851
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2852
|
+
| BodyResponseCallback<Readable>,
|
|
2853
|
+
callback?:
|
|
2854
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2855
|
+
| BodyResponseCallback<Readable>
|
|
2856
|
+
):
|
|
2857
|
+
| void
|
|
2858
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2859
|
+
| GaxiosPromise<Readable> {
|
|
2860
|
+
let params = (paramsOrCallback ||
|
|
2861
|
+
{}) as Params$Resource$Locations$Widgetconverseconversation;
|
|
2862
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2863
|
+
|
|
2864
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2865
|
+
callback = paramsOrCallback;
|
|
2866
|
+
params = {} as Params$Resource$Locations$Widgetconverseconversation;
|
|
2867
|
+
options = {};
|
|
2868
|
+
}
|
|
2869
|
+
|
|
2870
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2871
|
+
callback = optionsOrCallback;
|
|
2872
|
+
options = {};
|
|
2873
|
+
}
|
|
2874
|
+
|
|
2875
|
+
const rootUrl =
|
|
2876
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2877
|
+
const parameters = {
|
|
2878
|
+
options: Object.assign(
|
|
2879
|
+
{
|
|
2880
|
+
url: (
|
|
2881
|
+
rootUrl + '/v1alpha/{+location}/widgetConverseConversation'
|
|
2882
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
2883
|
+
method: 'POST',
|
|
2884
|
+
},
|
|
2885
|
+
options
|
|
2886
|
+
),
|
|
2887
|
+
params,
|
|
2888
|
+
requiredParams: ['location'],
|
|
2889
|
+
pathParams: ['location'],
|
|
2890
|
+
context: this.context,
|
|
2891
|
+
};
|
|
2892
|
+
if (callback) {
|
|
2893
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>(
|
|
2894
|
+
parameters,
|
|
2895
|
+
callback as BodyResponseCallback<unknown>
|
|
2896
|
+
);
|
|
2897
|
+
} else {
|
|
2898
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>(
|
|
2899
|
+
parameters
|
|
2900
|
+
);
|
|
2901
|
+
}
|
|
2902
|
+
}
|
|
2903
|
+
|
|
2904
|
+
/**
|
|
2905
|
+
* 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.
|
|
2906
|
+
*
|
|
2907
|
+
* @param params - Parameters for request
|
|
2908
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2909
|
+
* @param callback - Optional callback that handles the response.
|
|
2910
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2911
|
+
*/
|
|
2912
|
+
widgetSearch(
|
|
2913
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2914
|
+
options: StreamMethodOptions
|
|
2915
|
+
): GaxiosPromise<Readable>;
|
|
2916
|
+
widgetSearch(
|
|
2917
|
+
params?: Params$Resource$Locations$Widgetsearch,
|
|
2918
|
+
options?: MethodOptions
|
|
2919
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
|
|
2920
|
+
widgetSearch(
|
|
2921
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2922
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2923
|
+
callback: BodyResponseCallback<Readable>
|
|
2924
|
+
): void;
|
|
2925
|
+
widgetSearch(
|
|
2926
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2927
|
+
options:
|
|
2928
|
+
| MethodOptions
|
|
2929
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>,
|
|
2930
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2931
|
+
): void;
|
|
2932
|
+
widgetSearch(
|
|
2933
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2934
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2935
|
+
): void;
|
|
2936
|
+
widgetSearch(
|
|
2937
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2938
|
+
): void;
|
|
2939
|
+
widgetSearch(
|
|
2940
|
+
paramsOrCallback?:
|
|
2941
|
+
| Params$Resource$Locations$Widgetsearch
|
|
2942
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2943
|
+
| BodyResponseCallback<Readable>,
|
|
2944
|
+
optionsOrCallback?:
|
|
2945
|
+
| MethodOptions
|
|
2946
|
+
| StreamMethodOptions
|
|
2947
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2948
|
+
| BodyResponseCallback<Readable>,
|
|
2949
|
+
callback?:
|
|
2950
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2951
|
+
| BodyResponseCallback<Readable>
|
|
2952
|
+
):
|
|
2953
|
+
| void
|
|
2954
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2955
|
+
| GaxiosPromise<Readable> {
|
|
2956
|
+
let params = (paramsOrCallback ||
|
|
2957
|
+
{}) as Params$Resource$Locations$Widgetsearch;
|
|
2958
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2959
|
+
|
|
2960
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2961
|
+
callback = paramsOrCallback;
|
|
2962
|
+
params = {} as Params$Resource$Locations$Widgetsearch;
|
|
2963
|
+
options = {};
|
|
2964
|
+
}
|
|
2965
|
+
|
|
2966
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2967
|
+
callback = optionsOrCallback;
|
|
2968
|
+
options = {};
|
|
2969
|
+
}
|
|
2970
|
+
|
|
2971
|
+
const rootUrl =
|
|
2972
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2973
|
+
const parameters = {
|
|
2974
|
+
options: Object.assign(
|
|
2975
|
+
{
|
|
2976
|
+
url: (rootUrl + '/v1alpha/{+location}/widgetSearch').replace(
|
|
2977
|
+
/([^:]\/)\/+/g,
|
|
2978
|
+
'$1'
|
|
2979
|
+
),
|
|
2980
|
+
method: 'POST',
|
|
2981
|
+
},
|
|
2982
|
+
options
|
|
2983
|
+
),
|
|
2984
|
+
params,
|
|
2985
|
+
requiredParams: ['location'],
|
|
2986
|
+
pathParams: ['location'],
|
|
2987
|
+
context: this.context,
|
|
2988
|
+
};
|
|
2989
|
+
if (callback) {
|
|
2990
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>(
|
|
2991
|
+
parameters,
|
|
2992
|
+
callback as BodyResponseCallback<unknown>
|
|
2993
|
+
);
|
|
2994
|
+
} else {
|
|
2995
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>(
|
|
2996
|
+
parameters
|
|
2997
|
+
);
|
|
2998
|
+
}
|
|
2999
|
+
}
|
|
3000
|
+
}
|
|
3001
|
+
|
|
3002
|
+
export interface Params$Resource$Locations$Lookupwidgetconfig
|
|
3003
|
+
extends StandardParameters {
|
|
3004
|
+
/**
|
|
3005
|
+
* Required. The location resource where lookup widget will be performed. Format: `locations/{location\}`
|
|
3006
|
+
*/
|
|
3007
|
+
location?: string;
|
|
3008
|
+
|
|
3009
|
+
/**
|
|
3010
|
+
* Request body metadata
|
|
3011
|
+
*/
|
|
3012
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest;
|
|
3013
|
+
}
|
|
3014
|
+
export interface Params$Resource$Locations$Widgetcompletequery
|
|
3015
|
+
extends StandardParameters {
|
|
3016
|
+
/**
|
|
3017
|
+
* Required. The location resource where widget complete query will be performed. Format: `locations/{location\}`
|
|
3018
|
+
*/
|
|
3019
|
+
location?: string;
|
|
3020
|
+
|
|
3021
|
+
/**
|
|
3022
|
+
* Request body metadata
|
|
3023
|
+
*/
|
|
3024
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
|
|
3025
|
+
}
|
|
3026
|
+
export interface Params$Resource$Locations$Widgetconverseconversation
|
|
3027
|
+
extends StandardParameters {
|
|
3028
|
+
/**
|
|
3029
|
+
* Required. The location resource where widget converse conversation will be performed. Format: `locations/{location\}`
|
|
3030
|
+
*/
|
|
3031
|
+
location?: string;
|
|
3032
|
+
|
|
3033
|
+
/**
|
|
3034
|
+
* Request body metadata
|
|
3035
|
+
*/
|
|
3036
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
|
|
3037
|
+
}
|
|
3038
|
+
export interface Params$Resource$Locations$Widgetsearch
|
|
3039
|
+
extends StandardParameters {
|
|
3040
|
+
/**
|
|
3041
|
+
* Required. The location resource where widget search will be performed. Format: `locations/{location\}`
|
|
3042
|
+
*/
|
|
3043
|
+
location?: string;
|
|
3044
|
+
|
|
3045
|
+
/**
|
|
3046
|
+
* Request body metadata
|
|
3047
|
+
*/
|
|
3048
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
|
|
3049
|
+
}
|
|
3050
|
+
|
|
3051
|
+
export class Resource$Projects {
|
|
3052
|
+
context: APIRequestContext;
|
|
3053
|
+
locations: Resource$Projects$Locations;
|
|
3054
|
+
operations: Resource$Projects$Operations;
|
|
3055
|
+
constructor(context: APIRequestContext) {
|
|
3056
|
+
this.context = context;
|
|
3057
|
+
this.locations = new Resource$Projects$Locations(this.context);
|
|
3058
|
+
this.operations = new Resource$Projects$Operations(this.context);
|
|
3059
|
+
}
|
|
3060
|
+
}
|
|
3061
|
+
|
|
3062
|
+
export class Resource$Projects$Locations {
|
|
3063
|
+
context: APIRequestContext;
|
|
3064
|
+
collections: Resource$Projects$Locations$Collections;
|
|
3065
|
+
dataStores: Resource$Projects$Locations$Datastores;
|
|
3066
|
+
operations: Resource$Projects$Locations$Operations;
|
|
3067
|
+
constructor(context: APIRequestContext) {
|
|
2214
3068
|
this.context = context;
|
|
2215
3069
|
this.collections = new Resource$Projects$Locations$Collections(
|
|
2216
3070
|
this.context
|
|
@@ -2403,7 +3257,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2403
3257
|
*/
|
|
2404
3258
|
query?: string;
|
|
2405
3259
|
/**
|
|
2406
|
-
* 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
|
|
3260
|
+
* 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.
|
|
2407
3261
|
*/
|
|
2408
3262
|
queryModel?: string;
|
|
2409
3263
|
/**
|
|
@@ -5551,6 +6405,115 @@ export namespace discoveryengine_v1alpha {
|
|
|
5551
6405
|
this.context
|
|
5552
6406
|
);
|
|
5553
6407
|
}
|
|
6408
|
+
|
|
6409
|
+
/**
|
|
6410
|
+
* Request on-demand recrawl for a list of URIs.
|
|
6411
|
+
*
|
|
6412
|
+
* @param params - Parameters for request
|
|
6413
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6414
|
+
* @param callback - Optional callback that handles the response.
|
|
6415
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6416
|
+
*/
|
|
6417
|
+
recrawlUris(
|
|
6418
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6419
|
+
options: StreamMethodOptions
|
|
6420
|
+
): GaxiosPromise<Readable>;
|
|
6421
|
+
recrawlUris(
|
|
6422
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6423
|
+
options?: MethodOptions
|
|
6424
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6425
|
+
recrawlUris(
|
|
6426
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6427
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6428
|
+
callback: BodyResponseCallback<Readable>
|
|
6429
|
+
): void;
|
|
6430
|
+
recrawlUris(
|
|
6431
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6432
|
+
options:
|
|
6433
|
+
| MethodOptions
|
|
6434
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
6435
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6436
|
+
): void;
|
|
6437
|
+
recrawlUris(
|
|
6438
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6439
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6440
|
+
): void;
|
|
6441
|
+
recrawlUris(
|
|
6442
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6443
|
+
): void;
|
|
6444
|
+
recrawlUris(
|
|
6445
|
+
paramsOrCallback?:
|
|
6446
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris
|
|
6447
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6448
|
+
| BodyResponseCallback<Readable>,
|
|
6449
|
+
optionsOrCallback?:
|
|
6450
|
+
| MethodOptions
|
|
6451
|
+
| StreamMethodOptions
|
|
6452
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6453
|
+
| BodyResponseCallback<Readable>,
|
|
6454
|
+
callback?:
|
|
6455
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6456
|
+
| BodyResponseCallback<Readable>
|
|
6457
|
+
):
|
|
6458
|
+
| void
|
|
6459
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
6460
|
+
| GaxiosPromise<Readable> {
|
|
6461
|
+
let params = (paramsOrCallback ||
|
|
6462
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris;
|
|
6463
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6464
|
+
|
|
6465
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6466
|
+
callback = paramsOrCallback;
|
|
6467
|
+
params =
|
|
6468
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris;
|
|
6469
|
+
options = {};
|
|
6470
|
+
}
|
|
6471
|
+
|
|
6472
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6473
|
+
callback = optionsOrCallback;
|
|
6474
|
+
options = {};
|
|
6475
|
+
}
|
|
6476
|
+
|
|
6477
|
+
const rootUrl =
|
|
6478
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6479
|
+
const parameters = {
|
|
6480
|
+
options: Object.assign(
|
|
6481
|
+
{
|
|
6482
|
+
url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace(
|
|
6483
|
+
/([^:]\/)\/+/g,
|
|
6484
|
+
'$1'
|
|
6485
|
+
),
|
|
6486
|
+
method: 'POST',
|
|
6487
|
+
},
|
|
6488
|
+
options
|
|
6489
|
+
),
|
|
6490
|
+
params,
|
|
6491
|
+
requiredParams: ['siteSearchEngine'],
|
|
6492
|
+
pathParams: ['siteSearchEngine'],
|
|
6493
|
+
context: this.context,
|
|
6494
|
+
};
|
|
6495
|
+
if (callback) {
|
|
6496
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
6497
|
+
parameters,
|
|
6498
|
+
callback as BodyResponseCallback<unknown>
|
|
6499
|
+
);
|
|
6500
|
+
} else {
|
|
6501
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
6502
|
+
}
|
|
6503
|
+
}
|
|
6504
|
+
}
|
|
6505
|
+
|
|
6506
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris
|
|
6507
|
+
extends StandardParameters {
|
|
6508
|
+
/**
|
|
6509
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
6510
|
+
*/
|
|
6511
|
+
siteSearchEngine?: string;
|
|
6512
|
+
|
|
6513
|
+
/**
|
|
6514
|
+
* Request body metadata
|
|
6515
|
+
*/
|
|
6516
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
5554
6517
|
}
|
|
5555
6518
|
|
|
5556
6519
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations {
|
|
@@ -6452,92 +7415,322 @@ export namespace discoveryengine_v1alpha {
|
|
|
6452
7415
|
/**
|
|
6453
7416
|
* Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
6454
7417
|
*/
|
|
6455
|
-
parent?: string;
|
|
6456
|
-
|
|
7418
|
+
parent?: string;
|
|
7419
|
+
|
|
7420
|
+
/**
|
|
7421
|
+
* Request body metadata
|
|
7422
|
+
*/
|
|
7423
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
7424
|
+
}
|
|
7425
|
+
|
|
7426
|
+
export class Resource$Projects$Locations$Collections$Engines {
|
|
7427
|
+
context: APIRequestContext;
|
|
7428
|
+
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
7429
|
+
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
7430
|
+
constructor(context: APIRequestContext) {
|
|
7431
|
+
this.context = context;
|
|
7432
|
+
this.operations =
|
|
7433
|
+
new Resource$Projects$Locations$Collections$Engines$Operations(
|
|
7434
|
+
this.context
|
|
7435
|
+
);
|
|
7436
|
+
this.servingConfigs =
|
|
7437
|
+
new Resource$Projects$Locations$Collections$Engines$Servingconfigs(
|
|
7438
|
+
this.context
|
|
7439
|
+
);
|
|
7440
|
+
}
|
|
7441
|
+
}
|
|
7442
|
+
|
|
7443
|
+
export class Resource$Projects$Locations$Collections$Engines$Operations {
|
|
7444
|
+
context: APIRequestContext;
|
|
7445
|
+
constructor(context: APIRequestContext) {
|
|
7446
|
+
this.context = context;
|
|
7447
|
+
}
|
|
7448
|
+
|
|
7449
|
+
/**
|
|
7450
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
7451
|
+
*
|
|
7452
|
+
* @param params - Parameters for request
|
|
7453
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7454
|
+
* @param callback - Optional callback that handles the response.
|
|
7455
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7456
|
+
*/
|
|
7457
|
+
get(
|
|
7458
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7459
|
+
options: StreamMethodOptions
|
|
7460
|
+
): GaxiosPromise<Readable>;
|
|
7461
|
+
get(
|
|
7462
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7463
|
+
options?: MethodOptions
|
|
7464
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7465
|
+
get(
|
|
7466
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7467
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7468
|
+
callback: BodyResponseCallback<Readable>
|
|
7469
|
+
): void;
|
|
7470
|
+
get(
|
|
7471
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7472
|
+
options:
|
|
7473
|
+
| MethodOptions
|
|
7474
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
7475
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7476
|
+
): void;
|
|
7477
|
+
get(
|
|
7478
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7479
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7480
|
+
): void;
|
|
7481
|
+
get(
|
|
7482
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7483
|
+
): void;
|
|
7484
|
+
get(
|
|
7485
|
+
paramsOrCallback?:
|
|
7486
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
|
|
7487
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7488
|
+
| BodyResponseCallback<Readable>,
|
|
7489
|
+
optionsOrCallback?:
|
|
7490
|
+
| MethodOptions
|
|
7491
|
+
| StreamMethodOptions
|
|
7492
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7493
|
+
| BodyResponseCallback<Readable>,
|
|
7494
|
+
callback?:
|
|
7495
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7496
|
+
| BodyResponseCallback<Readable>
|
|
7497
|
+
):
|
|
7498
|
+
| void
|
|
7499
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
7500
|
+
| GaxiosPromise<Readable> {
|
|
7501
|
+
let params = (paramsOrCallback ||
|
|
7502
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
|
|
7503
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7504
|
+
|
|
7505
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7506
|
+
callback = paramsOrCallback;
|
|
7507
|
+
params =
|
|
7508
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
|
|
7509
|
+
options = {};
|
|
7510
|
+
}
|
|
7511
|
+
|
|
7512
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7513
|
+
callback = optionsOrCallback;
|
|
7514
|
+
options = {};
|
|
7515
|
+
}
|
|
7516
|
+
|
|
7517
|
+
const rootUrl =
|
|
7518
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7519
|
+
const parameters = {
|
|
7520
|
+
options: Object.assign(
|
|
7521
|
+
{
|
|
7522
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
7523
|
+
method: 'GET',
|
|
7524
|
+
},
|
|
7525
|
+
options
|
|
7526
|
+
),
|
|
7527
|
+
params,
|
|
7528
|
+
requiredParams: ['name'],
|
|
7529
|
+
pathParams: ['name'],
|
|
7530
|
+
context: this.context,
|
|
7531
|
+
};
|
|
7532
|
+
if (callback) {
|
|
7533
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
7534
|
+
parameters,
|
|
7535
|
+
callback as BodyResponseCallback<unknown>
|
|
7536
|
+
);
|
|
7537
|
+
} else {
|
|
7538
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
7539
|
+
}
|
|
7540
|
+
}
|
|
7541
|
+
|
|
7542
|
+
/**
|
|
7543
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
7544
|
+
*
|
|
7545
|
+
* @param params - Parameters for request
|
|
7546
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7547
|
+
* @param callback - Optional callback that handles the response.
|
|
7548
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7549
|
+
*/
|
|
7550
|
+
list(
|
|
7551
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7552
|
+
options: StreamMethodOptions
|
|
7553
|
+
): GaxiosPromise<Readable>;
|
|
7554
|
+
list(
|
|
7555
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7556
|
+
options?: MethodOptions
|
|
7557
|
+
): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
|
|
7558
|
+
list(
|
|
7559
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7560
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7561
|
+
callback: BodyResponseCallback<Readable>
|
|
7562
|
+
): void;
|
|
7563
|
+
list(
|
|
7564
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7565
|
+
options:
|
|
7566
|
+
| MethodOptions
|
|
7567
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>,
|
|
7568
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7569
|
+
): void;
|
|
7570
|
+
list(
|
|
7571
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7572
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7573
|
+
): void;
|
|
7574
|
+
list(
|
|
7575
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7576
|
+
): void;
|
|
7577
|
+
list(
|
|
7578
|
+
paramsOrCallback?:
|
|
7579
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Operations$List
|
|
7580
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7581
|
+
| BodyResponseCallback<Readable>,
|
|
7582
|
+
optionsOrCallback?:
|
|
7583
|
+
| MethodOptions
|
|
7584
|
+
| StreamMethodOptions
|
|
7585
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7586
|
+
| BodyResponseCallback<Readable>,
|
|
7587
|
+
callback?:
|
|
7588
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7589
|
+
| BodyResponseCallback<Readable>
|
|
7590
|
+
):
|
|
7591
|
+
| void
|
|
7592
|
+
| GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
|
|
7593
|
+
| GaxiosPromise<Readable> {
|
|
7594
|
+
let params = (paramsOrCallback ||
|
|
7595
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
|
|
7596
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7597
|
+
|
|
7598
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7599
|
+
callback = paramsOrCallback;
|
|
7600
|
+
params =
|
|
7601
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
|
|
7602
|
+
options = {};
|
|
7603
|
+
}
|
|
7604
|
+
|
|
7605
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7606
|
+
callback = optionsOrCallback;
|
|
7607
|
+
options = {};
|
|
7608
|
+
}
|
|
7609
|
+
|
|
7610
|
+
const rootUrl =
|
|
7611
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7612
|
+
const parameters = {
|
|
7613
|
+
options: Object.assign(
|
|
7614
|
+
{
|
|
7615
|
+
url: (rootUrl + '/v1alpha/{+name}/operations').replace(
|
|
7616
|
+
/([^:]\/)\/+/g,
|
|
7617
|
+
'$1'
|
|
7618
|
+
),
|
|
7619
|
+
method: 'GET',
|
|
7620
|
+
},
|
|
7621
|
+
options
|
|
7622
|
+
),
|
|
7623
|
+
params,
|
|
7624
|
+
requiredParams: ['name'],
|
|
7625
|
+
pathParams: ['name'],
|
|
7626
|
+
context: this.context,
|
|
7627
|
+
};
|
|
7628
|
+
if (callback) {
|
|
7629
|
+
createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
7630
|
+
parameters,
|
|
7631
|
+
callback as BodyResponseCallback<unknown>
|
|
7632
|
+
);
|
|
7633
|
+
} else {
|
|
7634
|
+
return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
7635
|
+
parameters
|
|
7636
|
+
);
|
|
7637
|
+
}
|
|
7638
|
+
}
|
|
7639
|
+
}
|
|
7640
|
+
|
|
7641
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
|
|
7642
|
+
extends StandardParameters {
|
|
7643
|
+
/**
|
|
7644
|
+
* The name of the operation resource.
|
|
7645
|
+
*/
|
|
7646
|
+
name?: string;
|
|
7647
|
+
}
|
|
7648
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List
|
|
7649
|
+
extends StandardParameters {
|
|
7650
|
+
/**
|
|
7651
|
+
* The standard list filter.
|
|
7652
|
+
*/
|
|
7653
|
+
filter?: string;
|
|
7654
|
+
/**
|
|
7655
|
+
* The name of the operation's parent resource.
|
|
7656
|
+
*/
|
|
7657
|
+
name?: string;
|
|
7658
|
+
/**
|
|
7659
|
+
* The standard list page size.
|
|
7660
|
+
*/
|
|
7661
|
+
pageSize?: number;
|
|
6457
7662
|
/**
|
|
6458
|
-
*
|
|
7663
|
+
* The standard list page token.
|
|
6459
7664
|
*/
|
|
6460
|
-
|
|
6461
|
-
}
|
|
6462
|
-
|
|
6463
|
-
export class Resource$Projects$Locations$Collections$Engines {
|
|
6464
|
-
context: APIRequestContext;
|
|
6465
|
-
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
6466
|
-
constructor(context: APIRequestContext) {
|
|
6467
|
-
this.context = context;
|
|
6468
|
-
this.operations =
|
|
6469
|
-
new Resource$Projects$Locations$Collections$Engines$Operations(
|
|
6470
|
-
this.context
|
|
6471
|
-
);
|
|
6472
|
-
}
|
|
7665
|
+
pageToken?: string;
|
|
6473
7666
|
}
|
|
6474
7667
|
|
|
6475
|
-
export class Resource$Projects$Locations$Collections$Engines$
|
|
7668
|
+
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
6476
7669
|
context: APIRequestContext;
|
|
6477
7670
|
constructor(context: APIRequestContext) {
|
|
6478
7671
|
this.context = context;
|
|
6479
7672
|
}
|
|
6480
7673
|
|
|
6481
7674
|
/**
|
|
6482
|
-
*
|
|
7675
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
6483
7676
|
*
|
|
6484
7677
|
* @param params - Parameters for request
|
|
6485
7678
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6486
7679
|
* @param callback - Optional callback that handles the response.
|
|
6487
7680
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6488
7681
|
*/
|
|
6489
|
-
|
|
6490
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7682
|
+
recommend(
|
|
7683
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6491
7684
|
options: StreamMethodOptions
|
|
6492
7685
|
): GaxiosPromise<Readable>;
|
|
6493
|
-
|
|
6494
|
-
params?: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7686
|
+
recommend(
|
|
7687
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6495
7688
|
options?: MethodOptions
|
|
6496
|
-
): GaxiosPromise<Schema$
|
|
6497
|
-
|
|
6498
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7689
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
7690
|
+
recommend(
|
|
7691
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6499
7692
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6500
7693
|
callback: BodyResponseCallback<Readable>
|
|
6501
7694
|
): void;
|
|
6502
|
-
|
|
6503
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7695
|
+
recommend(
|
|
7696
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6504
7697
|
options:
|
|
6505
7698
|
| MethodOptions
|
|
6506
|
-
| BodyResponseCallback<Schema$
|
|
6507
|
-
callback: BodyResponseCallback<Schema$
|
|
7699
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>,
|
|
7700
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6508
7701
|
): void;
|
|
6509
|
-
|
|
6510
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
6511
|
-
callback: BodyResponseCallback<Schema$
|
|
7702
|
+
recommend(
|
|
7703
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
7704
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6512
7705
|
): void;
|
|
6513
|
-
|
|
6514
|
-
callback: BodyResponseCallback<Schema$
|
|
7706
|
+
recommend(
|
|
7707
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6515
7708
|
): void;
|
|
6516
|
-
|
|
7709
|
+
recommend(
|
|
6517
7710
|
paramsOrCallback?:
|
|
6518
|
-
| Params$Resource$Projects$Locations$Collections$Engines$
|
|
6519
|
-
| BodyResponseCallback<Schema$
|
|
7711
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
7712
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6520
7713
|
| BodyResponseCallback<Readable>,
|
|
6521
7714
|
optionsOrCallback?:
|
|
6522
7715
|
| MethodOptions
|
|
6523
7716
|
| StreamMethodOptions
|
|
6524
|
-
| BodyResponseCallback<Schema$
|
|
7717
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6525
7718
|
| BodyResponseCallback<Readable>,
|
|
6526
7719
|
callback?:
|
|
6527
|
-
| BodyResponseCallback<Schema$
|
|
7720
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6528
7721
|
| BodyResponseCallback<Readable>
|
|
6529
7722
|
):
|
|
6530
7723
|
| void
|
|
6531
|
-
| GaxiosPromise<Schema$
|
|
7724
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6532
7725
|
| GaxiosPromise<Readable> {
|
|
6533
7726
|
let params = (paramsOrCallback ||
|
|
6534
|
-
{}) as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7727
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend;
|
|
6535
7728
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6536
7729
|
|
|
6537
7730
|
if (typeof paramsOrCallback === 'function') {
|
|
6538
7731
|
callback = paramsOrCallback;
|
|
6539
7732
|
params =
|
|
6540
|
-
{} as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7733
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend;
|
|
6541
7734
|
options = {};
|
|
6542
7735
|
}
|
|
6543
7736
|
|
|
@@ -6551,86 +7744,91 @@ export namespace discoveryengine_v1alpha {
|
|
|
6551
7744
|
const parameters = {
|
|
6552
7745
|
options: Object.assign(
|
|
6553
7746
|
{
|
|
6554
|
-
url: (rootUrl + '/v1alpha/{+
|
|
6555
|
-
|
|
7747
|
+
url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace(
|
|
7748
|
+
/([^:]\/)\/+/g,
|
|
7749
|
+
'$1'
|
|
7750
|
+
),
|
|
7751
|
+
method: 'POST',
|
|
6556
7752
|
},
|
|
6557
7753
|
options
|
|
6558
7754
|
),
|
|
6559
7755
|
params,
|
|
6560
|
-
requiredParams: ['
|
|
6561
|
-
pathParams: ['
|
|
7756
|
+
requiredParams: ['servingConfig'],
|
|
7757
|
+
pathParams: ['servingConfig'],
|
|
6562
7758
|
context: this.context,
|
|
6563
7759
|
};
|
|
6564
7760
|
if (callback) {
|
|
6565
|
-
createAPIRequest<Schema$
|
|
7761
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
|
|
6566
7762
|
parameters,
|
|
6567
7763
|
callback as BodyResponseCallback<unknown>
|
|
6568
7764
|
);
|
|
6569
7765
|
} else {
|
|
6570
|
-
return createAPIRequest<Schema$
|
|
7766
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
|
|
7767
|
+
parameters
|
|
7768
|
+
);
|
|
6571
7769
|
}
|
|
6572
7770
|
}
|
|
6573
7771
|
|
|
6574
7772
|
/**
|
|
6575
|
-
*
|
|
7773
|
+
* Performs a search.
|
|
6576
7774
|
*
|
|
6577
7775
|
* @param params - Parameters for request
|
|
6578
7776
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6579
7777
|
* @param callback - Optional callback that handles the response.
|
|
6580
7778
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6581
7779
|
*/
|
|
6582
|
-
|
|
6583
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7780
|
+
search(
|
|
7781
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6584
7782
|
options: StreamMethodOptions
|
|
6585
7783
|
): GaxiosPromise<Readable>;
|
|
6586
|
-
|
|
6587
|
-
params?: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7784
|
+
search(
|
|
7785
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6588
7786
|
options?: MethodOptions
|
|
6589
|
-
): GaxiosPromise<Schema$
|
|
6590
|
-
|
|
6591
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7787
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
7788
|
+
search(
|
|
7789
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6592
7790
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6593
7791
|
callback: BodyResponseCallback<Readable>
|
|
6594
7792
|
): void;
|
|
6595
|
-
|
|
6596
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7793
|
+
search(
|
|
7794
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6597
7795
|
options:
|
|
6598
7796
|
| MethodOptions
|
|
6599
|
-
| BodyResponseCallback<Schema$
|
|
6600
|
-
callback: BodyResponseCallback<Schema$
|
|
7797
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>,
|
|
7798
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6601
7799
|
): void;
|
|
6602
|
-
|
|
6603
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
6604
|
-
callback: BodyResponseCallback<Schema$
|
|
7800
|
+
search(
|
|
7801
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
7802
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6605
7803
|
): void;
|
|
6606
|
-
|
|
6607
|
-
callback: BodyResponseCallback<Schema$
|
|
7804
|
+
search(
|
|
7805
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6608
7806
|
): void;
|
|
6609
|
-
|
|
7807
|
+
search(
|
|
6610
7808
|
paramsOrCallback?:
|
|
6611
|
-
| Params$Resource$Projects$Locations$Collections$Engines$
|
|
6612
|
-
| BodyResponseCallback<Schema$
|
|
7809
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search
|
|
7810
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6613
7811
|
| BodyResponseCallback<Readable>,
|
|
6614
7812
|
optionsOrCallback?:
|
|
6615
7813
|
| MethodOptions
|
|
6616
7814
|
| StreamMethodOptions
|
|
6617
|
-
| BodyResponseCallback<Schema$
|
|
7815
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6618
7816
|
| BodyResponseCallback<Readable>,
|
|
6619
7817
|
callback?:
|
|
6620
|
-
| BodyResponseCallback<Schema$
|
|
7818
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6621
7819
|
| BodyResponseCallback<Readable>
|
|
6622
7820
|
):
|
|
6623
7821
|
| void
|
|
6624
|
-
| GaxiosPromise<Schema$
|
|
7822
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6625
7823
|
| GaxiosPromise<Readable> {
|
|
6626
7824
|
let params = (paramsOrCallback ||
|
|
6627
|
-
{}) as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7825
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search;
|
|
6628
7826
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6629
7827
|
|
|
6630
7828
|
if (typeof paramsOrCallback === 'function') {
|
|
6631
7829
|
callback = paramsOrCallback;
|
|
6632
7830
|
params =
|
|
6633
|
-
{} as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7831
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search;
|
|
6634
7832
|
options = {};
|
|
6635
7833
|
}
|
|
6636
7834
|
|
|
@@ -6644,57 +7842,55 @@ export namespace discoveryengine_v1alpha {
|
|
|
6644
7842
|
const parameters = {
|
|
6645
7843
|
options: Object.assign(
|
|
6646
7844
|
{
|
|
6647
|
-
url: (rootUrl + '/v1alpha/{+
|
|
7845
|
+
url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace(
|
|
6648
7846
|
/([^:]\/)\/+/g,
|
|
6649
7847
|
'$1'
|
|
6650
7848
|
),
|
|
6651
|
-
method: '
|
|
7849
|
+
method: 'POST',
|
|
6652
7850
|
},
|
|
6653
7851
|
options
|
|
6654
7852
|
),
|
|
6655
7853
|
params,
|
|
6656
|
-
requiredParams: ['
|
|
6657
|
-
pathParams: ['
|
|
7854
|
+
requiredParams: ['servingConfig'],
|
|
7855
|
+
pathParams: ['servingConfig'],
|
|
6658
7856
|
context: this.context,
|
|
6659
7857
|
};
|
|
6660
7858
|
if (callback) {
|
|
6661
|
-
createAPIRequest<Schema$
|
|
7859
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
|
|
6662
7860
|
parameters,
|
|
6663
7861
|
callback as BodyResponseCallback<unknown>
|
|
6664
7862
|
);
|
|
6665
7863
|
} else {
|
|
6666
|
-
return createAPIRequest<Schema$
|
|
7864
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
|
|
6667
7865
|
parameters
|
|
6668
7866
|
);
|
|
6669
7867
|
}
|
|
6670
7868
|
}
|
|
6671
7869
|
}
|
|
6672
7870
|
|
|
6673
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
6674
|
-
extends StandardParameters {
|
|
6675
|
-
/**
|
|
6676
|
-
* The name of the operation resource.
|
|
6677
|
-
*/
|
|
6678
|
-
name?: string;
|
|
6679
|
-
}
|
|
6680
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List
|
|
7871
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
6681
7872
|
extends StandardParameters {
|
|
6682
7873
|
/**
|
|
6683
|
-
*
|
|
7874
|
+
* 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.
|
|
6684
7875
|
*/
|
|
6685
|
-
|
|
7876
|
+
servingConfig?: string;
|
|
7877
|
+
|
|
6686
7878
|
/**
|
|
6687
|
-
*
|
|
7879
|
+
* Request body metadata
|
|
6688
7880
|
*/
|
|
6689
|
-
|
|
7881
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
|
|
7882
|
+
}
|
|
7883
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search
|
|
7884
|
+
extends StandardParameters {
|
|
6690
7885
|
/**
|
|
6691
|
-
* The
|
|
7886
|
+
* 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.
|
|
6692
7887
|
*/
|
|
6693
|
-
|
|
7888
|
+
servingConfig?: string;
|
|
7889
|
+
|
|
6694
7890
|
/**
|
|
6695
|
-
*
|
|
7891
|
+
* Request body metadata
|
|
6696
7892
|
*/
|
|
6697
|
-
|
|
7893
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
6698
7894
|
}
|
|
6699
7895
|
|
|
6700
7896
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
@@ -6930,6 +8126,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
6930
8126
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
6931
8127
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
6932
8128
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
8129
|
+
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
6933
8130
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
6934
8131
|
constructor(context: APIRequestContext) {
|
|
6935
8132
|
this.context = context;
|
|
@@ -6949,6 +8146,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
6949
8146
|
);
|
|
6950
8147
|
this.servingConfigs =
|
|
6951
8148
|
new Resource$Projects$Locations$Datastores$Servingconfigs(this.context);
|
|
8149
|
+
this.siteSearchEngine =
|
|
8150
|
+
new Resource$Projects$Locations$Datastores$Sitesearchengine(
|
|
8151
|
+
this.context
|
|
8152
|
+
);
|
|
6952
8153
|
this.userEvents = new Resource$Projects$Locations$Datastores$Userevents(
|
|
6953
8154
|
this.context
|
|
6954
8155
|
);
|
|
@@ -7068,7 +8269,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
7068
8269
|
*/
|
|
7069
8270
|
query?: string;
|
|
7070
8271
|
/**
|
|
7071
|
-
* 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
|
|
8272
|
+
* 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.
|
|
7072
8273
|
*/
|
|
7073
8274
|
queryModel?: string;
|
|
7074
8275
|
/**
|
|
@@ -9971,6 +11172,122 @@ export namespace discoveryengine_v1alpha {
|
|
|
9971
11172
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
9972
11173
|
}
|
|
9973
11174
|
|
|
11175
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
11176
|
+
context: APIRequestContext;
|
|
11177
|
+
constructor(context: APIRequestContext) {
|
|
11178
|
+
this.context = context;
|
|
11179
|
+
}
|
|
11180
|
+
|
|
11181
|
+
/**
|
|
11182
|
+
* Request on-demand recrawl for a list of URIs.
|
|
11183
|
+
*
|
|
11184
|
+
* @param params - Parameters for request
|
|
11185
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11186
|
+
* @param callback - Optional callback that handles the response.
|
|
11187
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11188
|
+
*/
|
|
11189
|
+
recrawlUris(
|
|
11190
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11191
|
+
options: StreamMethodOptions
|
|
11192
|
+
): GaxiosPromise<Readable>;
|
|
11193
|
+
recrawlUris(
|
|
11194
|
+
params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11195
|
+
options?: MethodOptions
|
|
11196
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
11197
|
+
recrawlUris(
|
|
11198
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11199
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
11200
|
+
callback: BodyResponseCallback<Readable>
|
|
11201
|
+
): void;
|
|
11202
|
+
recrawlUris(
|
|
11203
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11204
|
+
options:
|
|
11205
|
+
| MethodOptions
|
|
11206
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
11207
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11208
|
+
): void;
|
|
11209
|
+
recrawlUris(
|
|
11210
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11211
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11212
|
+
): void;
|
|
11213
|
+
recrawlUris(
|
|
11214
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11215
|
+
): void;
|
|
11216
|
+
recrawlUris(
|
|
11217
|
+
paramsOrCallback?:
|
|
11218
|
+
| Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris
|
|
11219
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11220
|
+
| BodyResponseCallback<Readable>,
|
|
11221
|
+
optionsOrCallback?:
|
|
11222
|
+
| MethodOptions
|
|
11223
|
+
| StreamMethodOptions
|
|
11224
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11225
|
+
| BodyResponseCallback<Readable>,
|
|
11226
|
+
callback?:
|
|
11227
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11228
|
+
| BodyResponseCallback<Readable>
|
|
11229
|
+
):
|
|
11230
|
+
| void
|
|
11231
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
11232
|
+
| GaxiosPromise<Readable> {
|
|
11233
|
+
let params = (paramsOrCallback ||
|
|
11234
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris;
|
|
11235
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
11236
|
+
|
|
11237
|
+
if (typeof paramsOrCallback === 'function') {
|
|
11238
|
+
callback = paramsOrCallback;
|
|
11239
|
+
params =
|
|
11240
|
+
{} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris;
|
|
11241
|
+
options = {};
|
|
11242
|
+
}
|
|
11243
|
+
|
|
11244
|
+
if (typeof optionsOrCallback === 'function') {
|
|
11245
|
+
callback = optionsOrCallback;
|
|
11246
|
+
options = {};
|
|
11247
|
+
}
|
|
11248
|
+
|
|
11249
|
+
const rootUrl =
|
|
11250
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
11251
|
+
const parameters = {
|
|
11252
|
+
options: Object.assign(
|
|
11253
|
+
{
|
|
11254
|
+
url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace(
|
|
11255
|
+
/([^:]\/)\/+/g,
|
|
11256
|
+
'$1'
|
|
11257
|
+
),
|
|
11258
|
+
method: 'POST',
|
|
11259
|
+
},
|
|
11260
|
+
options
|
|
11261
|
+
),
|
|
11262
|
+
params,
|
|
11263
|
+
requiredParams: ['siteSearchEngine'],
|
|
11264
|
+
pathParams: ['siteSearchEngine'],
|
|
11265
|
+
context: this.context,
|
|
11266
|
+
};
|
|
11267
|
+
if (callback) {
|
|
11268
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
11269
|
+
parameters,
|
|
11270
|
+
callback as BodyResponseCallback<unknown>
|
|
11271
|
+
);
|
|
11272
|
+
} else {
|
|
11273
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
11274
|
+
}
|
|
11275
|
+
}
|
|
11276
|
+
}
|
|
11277
|
+
|
|
11278
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris
|
|
11279
|
+
extends StandardParameters {
|
|
11280
|
+
/**
|
|
11281
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
11282
|
+
*/
|
|
11283
|
+
siteSearchEngine?: string;
|
|
11284
|
+
|
|
11285
|
+
/**
|
|
11286
|
+
* Request body metadata
|
|
11287
|
+
*/
|
|
11288
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
11289
|
+
}
|
|
11290
|
+
|
|
9974
11291
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
9975
11292
|
context: APIRequestContext;
|
|
9976
11293
|
constructor(context: APIRequestContext) {
|