@googleapis/discoveryengine 1.2.0 → 3.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 +33 -0
- package/build/v1alpha.d.ts +625 -19
- package/build/v1alpha.js +275 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +175 -24
- package/build/v1beta.js +72 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +1441 -133
- package/v1beta.ts +356 -26
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
|
}
|
|
@@ -240,13 +242,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
240
242
|
functionName?: string | null;
|
|
241
243
|
}
|
|
242
244
|
/**
|
|
243
|
-
*
|
|
245
|
+
* AdditionalParams message for WidgetService methods for security and privacy enhancement.
|
|
244
246
|
*/
|
|
245
|
-
export interface Schema$
|
|
247
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams {
|
|
246
248
|
/**
|
|
247
|
-
*
|
|
249
|
+
* Token that used for non-human user check.
|
|
248
250
|
*/
|
|
249
|
-
|
|
251
|
+
token?: string | null;
|
|
250
252
|
}
|
|
251
253
|
/**
|
|
252
254
|
* BigQuery source import data from.
|
|
@@ -277,6 +279,31 @@ export namespace discoveryengine_v1alpha {
|
|
|
277
279
|
*/
|
|
278
280
|
tableId?: string | null;
|
|
279
281
|
}
|
|
282
|
+
/**
|
|
283
|
+
* Request message for CompletionService.CompleteQuery method.
|
|
284
|
+
*/
|
|
285
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
|
|
286
|
+
/**
|
|
287
|
+
* 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`.
|
|
288
|
+
*/
|
|
289
|
+
dataStore?: string | null;
|
|
290
|
+
/**
|
|
291
|
+
* 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.
|
|
292
|
+
*/
|
|
293
|
+
includeTailSuggestions?: boolean | null;
|
|
294
|
+
/**
|
|
295
|
+
* Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
|
|
296
|
+
*/
|
|
297
|
+
query?: string | null;
|
|
298
|
+
/**
|
|
299
|
+
* 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.
|
|
300
|
+
*/
|
|
301
|
+
queryModel?: string | null;
|
|
302
|
+
/**
|
|
303
|
+
* 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.
|
|
304
|
+
*/
|
|
305
|
+
userPseudoId?: string | null;
|
|
306
|
+
}
|
|
280
307
|
/**
|
|
281
308
|
* Response message for CompletionService.CompleteQuery method.
|
|
282
309
|
*/
|
|
@@ -297,7 +324,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
297
324
|
/**
|
|
298
325
|
* 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
326
|
*/
|
|
300
|
-
|
|
327
|
+
completableFieldPaths?: string[] | null;
|
|
301
328
|
/**
|
|
302
329
|
* The suggestion for the query.
|
|
303
330
|
*/
|
|
@@ -383,6 +410,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
383
410
|
* 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
411
|
*/
|
|
385
412
|
conversation?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
|
|
413
|
+
/**
|
|
414
|
+
* 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.
|
|
415
|
+
*/
|
|
416
|
+
name?: string | null;
|
|
386
417
|
/**
|
|
387
418
|
* Required. Current user input.
|
|
388
419
|
*/
|
|
@@ -395,6 +426,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
395
426
|
* 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
427
|
*/
|
|
397
428
|
servingConfig?: string | null;
|
|
429
|
+
/**
|
|
430
|
+
* A specification for configuring the summary returned in the response.
|
|
431
|
+
*/
|
|
432
|
+
summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
398
433
|
/**
|
|
399
434
|
* 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
435
|
*/
|
|
@@ -819,6 +854,24 @@ export namespace discoveryengine_v1alpha {
|
|
|
819
854
|
*/
|
|
820
855
|
schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
821
856
|
}
|
|
857
|
+
/**
|
|
858
|
+
* Request message for WidgetService.LookupWidgetConfig method.
|
|
859
|
+
*/
|
|
860
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest {
|
|
861
|
+
/**
|
|
862
|
+
* Required. The UUID of the Widget Config.
|
|
863
|
+
*/
|
|
864
|
+
widgetConfigId?: string | null;
|
|
865
|
+
}
|
|
866
|
+
/**
|
|
867
|
+
* Response message for WidgetService.LookupWidgetConfig method.
|
|
868
|
+
*/
|
|
869
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse {
|
|
870
|
+
/**
|
|
871
|
+
* The Anonymous Widget Config associated with the UUID.
|
|
872
|
+
*/
|
|
873
|
+
anonymousWidgetConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig;
|
|
874
|
+
}
|
|
822
875
|
/**
|
|
823
876
|
* Media-specific user event information.
|
|
824
877
|
*/
|
|
@@ -969,7 +1022,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
969
1022
|
*/
|
|
970
1023
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest {
|
|
971
1024
|
/**
|
|
972
|
-
* Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
|
1025
|
+
* Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
|
973
1026
|
*/
|
|
974
1027
|
filter?: string | null;
|
|
975
1028
|
/**
|
|
@@ -977,7 +1030,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
977
1030
|
*/
|
|
978
1031
|
pageSize?: number | null;
|
|
979
1032
|
/**
|
|
980
|
-
* Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.
|
|
1033
|
+
* Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
|
|
981
1034
|
*/
|
|
982
1035
|
params?: {[key: string]: any} | null;
|
|
983
1036
|
/**
|
|
@@ -1031,6 +1084,87 @@ export namespace discoveryengine_v1alpha {
|
|
|
1031
1084
|
*/
|
|
1032
1085
|
metadata?: {[key: string]: any} | null;
|
|
1033
1086
|
}
|
|
1087
|
+
/**
|
|
1088
|
+
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1089
|
+
*/
|
|
1090
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
1091
|
+
/**
|
|
1092
|
+
* Operation create time.
|
|
1093
|
+
*/
|
|
1094
|
+
createTime?: string | null;
|
|
1095
|
+
/**
|
|
1096
|
+
* 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.
|
|
1097
|
+
*/
|
|
1098
|
+
invalidUris?: string[] | null;
|
|
1099
|
+
/**
|
|
1100
|
+
* Total number of URIs that have yet to be crawled.
|
|
1101
|
+
*/
|
|
1102
|
+
pendingCount?: number | null;
|
|
1103
|
+
/**
|
|
1104
|
+
* Total number of URIs that were rejected due to insufficient indexing resources.
|
|
1105
|
+
*/
|
|
1106
|
+
quotaExceededCount?: number | null;
|
|
1107
|
+
/**
|
|
1108
|
+
* Total number of URIs that have been crawled so far.
|
|
1109
|
+
*/
|
|
1110
|
+
successCount?: number | null;
|
|
1111
|
+
/**
|
|
1112
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1113
|
+
*/
|
|
1114
|
+
updateTime?: string | null;
|
|
1115
|
+
/**
|
|
1116
|
+
* Total number of unique URIs in the request that are not in invalid_uris.
|
|
1117
|
+
*/
|
|
1118
|
+
validUrisCount?: number | null;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* Request message for SiteSearchEngineService.RecrawlUris method.
|
|
1122
|
+
*/
|
|
1123
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest {
|
|
1124
|
+
/**
|
|
1125
|
+
* 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`.
|
|
1126
|
+
*/
|
|
1127
|
+
uris?: string[] | null;
|
|
1128
|
+
}
|
|
1129
|
+
/**
|
|
1130
|
+
* Response message for SiteSearchEngineService.RecrawlUris method.
|
|
1131
|
+
*/
|
|
1132
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
|
|
1133
|
+
/**
|
|
1134
|
+
* URIs that were not crawled before the LRO terminated.
|
|
1135
|
+
*/
|
|
1136
|
+
failedUris?: string[] | null;
|
|
1137
|
+
/**
|
|
1138
|
+
* Details for a sample of up to 10 `failed_uris`.
|
|
1139
|
+
*/
|
|
1140
|
+
failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
|
|
1141
|
+
}
|
|
1142
|
+
/**
|
|
1143
|
+
* Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
|
|
1144
|
+
*/
|
|
1145
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
|
|
1146
|
+
/**
|
|
1147
|
+
* List of failure reasons by corpus type (e.g. desktop, mobile).
|
|
1148
|
+
*/
|
|
1149
|
+
failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
|
|
1150
|
+
/**
|
|
1151
|
+
* URI that failed to be crawled.
|
|
1152
|
+
*/
|
|
1153
|
+
uri?: string | null;
|
|
1154
|
+
}
|
|
1155
|
+
/**
|
|
1156
|
+
* Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1157
|
+
*/
|
|
1158
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1159
|
+
/**
|
|
1160
|
+
* DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
|
|
1161
|
+
*/
|
|
1162
|
+
corpusType?: string | null;
|
|
1163
|
+
/**
|
|
1164
|
+
* Reason why the URI was not crawled.
|
|
1165
|
+
*/
|
|
1166
|
+
errorMessage?: string | null;
|
|
1167
|
+
}
|
|
1034
1168
|
/**
|
|
1035
1169
|
* Defines a reply message to user.
|
|
1036
1170
|
*/
|
|
@@ -1112,7 +1246,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1112
1246
|
*/
|
|
1113
1247
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest {
|
|
1114
1248
|
/**
|
|
1115
|
-
* Boost specification to boost certain documents.
|
|
1249
|
+
* Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
1116
1250
|
*/
|
|
1117
1251
|
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
1118
1252
|
/**
|
|
@@ -1132,7 +1266,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1132
1266
|
*/
|
|
1133
1267
|
facetSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
1134
1268
|
/**
|
|
1135
|
-
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1269
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
|
1136
1270
|
*/
|
|
1137
1271
|
filter?: string | null;
|
|
1138
1272
|
/**
|
|
@@ -1144,7 +1278,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1144
1278
|
*/
|
|
1145
1279
|
offset?: number | null;
|
|
1146
1280
|
/**
|
|
1147
|
-
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1281
|
+
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1148
1282
|
*/
|
|
1149
1283
|
orderBy?: string | null;
|
|
1150
1284
|
/**
|
|
@@ -1175,6 +1309,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1175
1309
|
* Whether to turn on safe search. This is only supported for website search.
|
|
1176
1310
|
*/
|
|
1177
1311
|
safeSearch?: boolean | null;
|
|
1312
|
+
/**
|
|
1313
|
+
* 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.
|
|
1314
|
+
*/
|
|
1315
|
+
servingConfig?: string | null;
|
|
1178
1316
|
/**
|
|
1179
1317
|
* The spell correction specification that specifies the mode under which spell correction takes effect.
|
|
1180
1318
|
*/
|
|
@@ -1244,9 +1382,13 @@ export namespace discoveryengine_v1alpha {
|
|
|
1244
1382
|
*/
|
|
1245
1383
|
maxExtractiveSegmentCount?: number | null;
|
|
1246
1384
|
/**
|
|
1247
|
-
*
|
|
1385
|
+
* Return at most `num_next_segments` segments after each selected segments.
|
|
1248
1386
|
*/
|
|
1249
|
-
|
|
1387
|
+
numNextSegments?: number | null;
|
|
1388
|
+
/**
|
|
1389
|
+
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
1390
|
+
*/
|
|
1391
|
+
numPreviousSegments?: number | null;
|
|
1250
1392
|
}
|
|
1251
1393
|
/**
|
|
1252
1394
|
* A specification for configuring snippets in a search response.
|
|
@@ -1282,7 +1424,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1282
1424
|
*/
|
|
1283
1425
|
includeCitations?: boolean | null;
|
|
1284
1426
|
/**
|
|
1285
|
-
* Language code for Summary. Use language tags defined by BCP47.
|
|
1427
|
+
* 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
1428
|
*/
|
|
1287
1429
|
languageCode?: string | null;
|
|
1288
1430
|
/**
|
|
@@ -1417,6 +1559,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1417
1559
|
* Results of facets requested by user.
|
|
1418
1560
|
*/
|
|
1419
1561
|
facets?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[];
|
|
1562
|
+
geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[];
|
|
1420
1563
|
/**
|
|
1421
1564
|
* Guided search result.
|
|
1422
1565
|
*/
|
|
@@ -1480,6 +1623,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1480
1623
|
*/
|
|
1481
1624
|
value?: string | null;
|
|
1482
1625
|
}
|
|
1626
|
+
/**
|
|
1627
|
+
* Debug information specifically related to forward geocoding issues arising from Geolocation Search.
|
|
1628
|
+
*/
|
|
1629
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo {
|
|
1630
|
+
/**
|
|
1631
|
+
* The error produced.
|
|
1632
|
+
*/
|
|
1633
|
+
errorMessage?: string | null;
|
|
1634
|
+
/**
|
|
1635
|
+
* The address from which forward geocoding ingestion produced issues.
|
|
1636
|
+
*/
|
|
1637
|
+
originalAddressQuery?: string | null;
|
|
1638
|
+
}
|
|
1483
1639
|
/**
|
|
1484
1640
|
* 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
1641
|
*/
|
|
@@ -1542,6 +1698,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
1542
1698
|
* Summary of the top N search result specified by the summary spec.
|
|
1543
1699
|
*/
|
|
1544
1700
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummary {
|
|
1701
|
+
/**
|
|
1702
|
+
* A collection of Safety Attribute categories and their associated confidence scores.
|
|
1703
|
+
*/
|
|
1704
|
+
safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes;
|
|
1545
1705
|
/**
|
|
1546
1706
|
* Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1547
1707
|
*/
|
|
@@ -1551,6 +1711,19 @@ export namespace discoveryengine_v1alpha {
|
|
|
1551
1711
|
*/
|
|
1552
1712
|
summaryText?: string | null;
|
|
1553
1713
|
}
|
|
1714
|
+
/**
|
|
1715
|
+
* Safety Attribute categories and their associated confidence scores.
|
|
1716
|
+
*/
|
|
1717
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
|
|
1718
|
+
/**
|
|
1719
|
+
* The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
|
|
1720
|
+
*/
|
|
1721
|
+
categories?: string[] | null;
|
|
1722
|
+
/**
|
|
1723
|
+
* The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
|
|
1724
|
+
*/
|
|
1725
|
+
scores?: number[] | null;
|
|
1726
|
+
}
|
|
1554
1727
|
/**
|
|
1555
1728
|
* Verification information for target sites in advanced site search.
|
|
1556
1729
|
*/
|
|
@@ -1614,12 +1787,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
1614
1787
|
*/
|
|
1615
1788
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
1616
1789
|
}
|
|
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
|
-
}
|
|
1790
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {}
|
|
1623
1791
|
/**
|
|
1624
1792
|
* Defines text input.
|
|
1625
1793
|
*/
|
|
@@ -1767,6 +1935,240 @@ export namespace discoveryengine_v1alpha {
|
|
|
1767
1935
|
*/
|
|
1768
1936
|
userId?: string | null;
|
|
1769
1937
|
}
|
|
1938
|
+
/**
|
|
1939
|
+
* Request message for WidgetService.WidgetCompleteQuery method.
|
|
1940
|
+
*/
|
|
1941
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest {
|
|
1942
|
+
/**
|
|
1943
|
+
* Additional params for security and privacy enhancement.
|
|
1944
|
+
*/
|
|
1945
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
1946
|
+
/**
|
|
1947
|
+
* Required. The CompleteQuery request to perform auto-complete suggestion query.
|
|
1948
|
+
*/
|
|
1949
|
+
completeQueryRequest?: Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest;
|
|
1950
|
+
/**
|
|
1951
|
+
* 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.
|
|
1952
|
+
*/
|
|
1953
|
+
configId?: string | null;
|
|
1954
|
+
}
|
|
1955
|
+
/**
|
|
1956
|
+
* Response message for WidgetService.WidgetCompleteQuery method.
|
|
1957
|
+
*/
|
|
1958
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse {
|
|
1959
|
+
/**
|
|
1960
|
+
* The token in response.
|
|
1961
|
+
*/
|
|
1962
|
+
uToken?: string | null;
|
|
1963
|
+
/**
|
|
1964
|
+
* Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion.
|
|
1965
|
+
*/
|
|
1966
|
+
widgetQuerySuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion[];
|
|
1967
|
+
}
|
|
1968
|
+
/**
|
|
1969
|
+
* Suggestions as search queries.
|
|
1970
|
+
*/
|
|
1971
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion {
|
|
1972
|
+
/**
|
|
1973
|
+
* The suggestion for the query.
|
|
1974
|
+
*/
|
|
1975
|
+
suggestion?: string | null;
|
|
1976
|
+
}
|
|
1977
|
+
/**
|
|
1978
|
+
* WidgetConfig captures configs at the Widget level.
|
|
1979
|
+
*/
|
|
1980
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig {
|
|
1981
|
+
/**
|
|
1982
|
+
* Allowlisted domains that can load this widget.
|
|
1983
|
+
*/
|
|
1984
|
+
allowlistedDomains?: string[] | null;
|
|
1985
|
+
/**
|
|
1986
|
+
* 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.
|
|
1987
|
+
*/
|
|
1988
|
+
allowPublicAccess?: boolean | null;
|
|
1989
|
+
/**
|
|
1990
|
+
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
1991
|
+
*/
|
|
1992
|
+
configId?: string | null;
|
|
1993
|
+
/**
|
|
1994
|
+
* The content search spec that configs the desired behavior of content search.
|
|
1995
|
+
*/
|
|
1996
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1997
|
+
/**
|
|
1998
|
+
* Output only. Timestamp the WidgetConfig was created.
|
|
1999
|
+
*/
|
|
2000
|
+
createTime?: string | null;
|
|
2001
|
+
/**
|
|
2002
|
+
* Output only. The type of the parent data store.
|
|
2003
|
+
*/
|
|
2004
|
+
dataStoreType?: string | null;
|
|
2005
|
+
/**
|
|
2006
|
+
* 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.
|
|
2007
|
+
*/
|
|
2008
|
+
displayName?: string | null;
|
|
2009
|
+
/**
|
|
2010
|
+
* Whether or not to enable autocomplete.
|
|
2011
|
+
*/
|
|
2012
|
+
enableAutocomplete?: boolean | null;
|
|
2013
|
+
/**
|
|
2014
|
+
* Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
|
|
2015
|
+
*/
|
|
2016
|
+
enableConversationalSearch?: boolean | null;
|
|
2017
|
+
/**
|
|
2018
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
2019
|
+
*/
|
|
2020
|
+
enableQualityFeedback?: boolean | null;
|
|
2021
|
+
/**
|
|
2022
|
+
* Whether to show the result score.
|
|
2023
|
+
*/
|
|
2024
|
+
enableResultScore?: boolean | null;
|
|
2025
|
+
/**
|
|
2026
|
+
* Whether to enable safe search.
|
|
2027
|
+
*/
|
|
2028
|
+
enableSafeSearch?: boolean | null;
|
|
2029
|
+
/**
|
|
2030
|
+
* Turn on or off summary for each snippets result.
|
|
2031
|
+
*/
|
|
2032
|
+
enableSnippetResultSummary?: boolean | null;
|
|
2033
|
+
/**
|
|
2034
|
+
* Turn on or off summarization for the search response.
|
|
2035
|
+
*/
|
|
2036
|
+
enableSummarization?: boolean | null;
|
|
2037
|
+
/**
|
|
2038
|
+
* The configuration and appearance of facets in the end user view.
|
|
2039
|
+
*/
|
|
2040
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
2041
|
+
/**
|
|
2042
|
+
* 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.
|
|
2043
|
+
*/
|
|
2044
|
+
fieldsUiComponentsMap?: {
|
|
2045
|
+
[
|
|
2046
|
+
key: string
|
|
2047
|
+
]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2048
|
+
} | null;
|
|
2049
|
+
/**
|
|
2050
|
+
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2051
|
+
*/
|
|
2052
|
+
llmEnabled?: boolean | null;
|
|
2053
|
+
/**
|
|
2054
|
+
* Output only. Whether the customer accepted data use terms.
|
|
2055
|
+
*/
|
|
2056
|
+
minimumDataTermAccepted?: boolean | null;
|
|
2057
|
+
/**
|
|
2058
|
+
* 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.
|
|
2059
|
+
*/
|
|
2060
|
+
name?: string | null;
|
|
2061
|
+
/**
|
|
2062
|
+
* 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.
|
|
2063
|
+
*/
|
|
2064
|
+
resultDisplayType?: string | null;
|
|
2065
|
+
/**
|
|
2066
|
+
* Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
|
|
2067
|
+
*/
|
|
2068
|
+
solutionType?: string | null;
|
|
2069
|
+
/**
|
|
2070
|
+
* Output only. Timestamp the WidgetConfig was updated.
|
|
2071
|
+
*/
|
|
2072
|
+
updateTime?: string | null;
|
|
2073
|
+
}
|
|
2074
|
+
/**
|
|
2075
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
2076
|
+
*/
|
|
2077
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
|
|
2078
|
+
/**
|
|
2079
|
+
* Optional. The field name that end users will see.
|
|
2080
|
+
*/
|
|
2081
|
+
displayName?: string | null;
|
|
2082
|
+
/**
|
|
2083
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2084
|
+
*/
|
|
2085
|
+
field?: string | null;
|
|
2086
|
+
}
|
|
2087
|
+
/**
|
|
2088
|
+
* Facet field that maps to a UI Component.
|
|
2089
|
+
*/
|
|
2090
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
|
|
2091
|
+
/**
|
|
2092
|
+
* The field visibility on different types of devices.
|
|
2093
|
+
*/
|
|
2094
|
+
deviceVisibility?: string[] | null;
|
|
2095
|
+
/**
|
|
2096
|
+
* The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
|
|
2097
|
+
*/
|
|
2098
|
+
displayTemplate?: string | null;
|
|
2099
|
+
/**
|
|
2100
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2101
|
+
*/
|
|
2102
|
+
field?: string | null;
|
|
2103
|
+
}
|
|
2104
|
+
/**
|
|
2105
|
+
* Request message for WidgetService.WidgetConverseConversation method.
|
|
2106
|
+
*/
|
|
2107
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest {
|
|
2108
|
+
/**
|
|
2109
|
+
* Additional params for security and privacy enhancement.
|
|
2110
|
+
*/
|
|
2111
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2112
|
+
/**
|
|
2113
|
+
* 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.
|
|
2114
|
+
*/
|
|
2115
|
+
configId?: string | null;
|
|
2116
|
+
/**
|
|
2117
|
+
* The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
|
|
2118
|
+
*/
|
|
2119
|
+
conversationId?: string | null;
|
|
2120
|
+
/**
|
|
2121
|
+
* Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default.
|
|
2122
|
+
*/
|
|
2123
|
+
converseConversationRequest?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
|
|
2124
|
+
}
|
|
2125
|
+
/**
|
|
2126
|
+
* Response message for WidgetService.WidgetConverseConversation method.
|
|
2127
|
+
*/
|
|
2128
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse {
|
|
2129
|
+
/**
|
|
2130
|
+
* The id of the Conversation returned.
|
|
2131
|
+
*/
|
|
2132
|
+
conversationId?: string | null;
|
|
2133
|
+
/**
|
|
2134
|
+
* ConverseConversationResponse returned from ConversationalSearchService.ConverseConversation.
|
|
2135
|
+
*/
|
|
2136
|
+
converseConversationResponse?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse;
|
|
2137
|
+
/**
|
|
2138
|
+
* The token in response.
|
|
2139
|
+
*/
|
|
2140
|
+
uToken?: string | null;
|
|
2141
|
+
}
|
|
2142
|
+
/**
|
|
2143
|
+
* Request message for WidgetService.WidgetSearch method.
|
|
2144
|
+
*/
|
|
2145
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest {
|
|
2146
|
+
/**
|
|
2147
|
+
* Additional params for security and privacy enhancement.
|
|
2148
|
+
*/
|
|
2149
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2150
|
+
/**
|
|
2151
|
+
* 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.
|
|
2152
|
+
*/
|
|
2153
|
+
configId?: string | null;
|
|
2154
|
+
/**
|
|
2155
|
+
* Required. The search request to perform search.
|
|
2156
|
+
*/
|
|
2157
|
+
searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
2158
|
+
}
|
|
2159
|
+
/**
|
|
2160
|
+
* Response message for WidgetService.WidgetSearch method.
|
|
2161
|
+
*/
|
|
2162
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse {
|
|
2163
|
+
/**
|
|
2164
|
+
* The search response after performing search.
|
|
2165
|
+
*/
|
|
2166
|
+
searchResponse?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse;
|
|
2167
|
+
/**
|
|
2168
|
+
* The token in response.
|
|
2169
|
+
*/
|
|
2170
|
+
uToken?: string | null;
|
|
2171
|
+
}
|
|
1770
2172
|
/**
|
|
1771
2173
|
* Metadata for Create Schema LRO.
|
|
1772
2174
|
*/
|
|
@@ -2194,28 +2596,471 @@ export namespace discoveryengine_v1alpha {
|
|
|
2194
2596
|
year?: number | null;
|
|
2195
2597
|
}
|
|
2196
2598
|
|
|
2197
|
-
export class Resource$
|
|
2599
|
+
export class Resource$Locations {
|
|
2198
2600
|
context: APIRequestContext;
|
|
2199
|
-
locations: Resource$Projects$Locations;
|
|
2200
|
-
operations: Resource$Projects$Operations;
|
|
2201
2601
|
constructor(context: APIRequestContext) {
|
|
2202
2602
|
this.context = context;
|
|
2203
|
-
this.locations = new Resource$Projects$Locations(this.context);
|
|
2204
|
-
this.operations = new Resource$Projects$Operations(this.context);
|
|
2205
2603
|
}
|
|
2206
|
-
}
|
|
2207
2604
|
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2605
|
+
/**
|
|
2606
|
+
* Gets the Widget Config using the uuid.
|
|
2607
|
+
*
|
|
2608
|
+
* @param params - Parameters for request
|
|
2609
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2610
|
+
* @param callback - Optional callback that handles the response.
|
|
2611
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2612
|
+
*/
|
|
2613
|
+
lookupWidgetConfig(
|
|
2614
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2615
|
+
options: StreamMethodOptions
|
|
2616
|
+
): GaxiosPromise<Readable>;
|
|
2617
|
+
lookupWidgetConfig(
|
|
2618
|
+
params?: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2619
|
+
options?: MethodOptions
|
|
2620
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
|
|
2621
|
+
lookupWidgetConfig(
|
|
2622
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2623
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2624
|
+
callback: BodyResponseCallback<Readable>
|
|
2625
|
+
): void;
|
|
2626
|
+
lookupWidgetConfig(
|
|
2627
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2628
|
+
options:
|
|
2629
|
+
| MethodOptions
|
|
2630
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>,
|
|
2631
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2632
|
+
): void;
|
|
2633
|
+
lookupWidgetConfig(
|
|
2634
|
+
params: Params$Resource$Locations$Lookupwidgetconfig,
|
|
2635
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2636
|
+
): void;
|
|
2637
|
+
lookupWidgetConfig(
|
|
2638
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2639
|
+
): void;
|
|
2640
|
+
lookupWidgetConfig(
|
|
2641
|
+
paramsOrCallback?:
|
|
2642
|
+
| Params$Resource$Locations$Lookupwidgetconfig
|
|
2643
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2644
|
+
| BodyResponseCallback<Readable>,
|
|
2645
|
+
optionsOrCallback?:
|
|
2646
|
+
| MethodOptions
|
|
2647
|
+
| StreamMethodOptions
|
|
2648
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2649
|
+
| BodyResponseCallback<Readable>,
|
|
2650
|
+
callback?:
|
|
2651
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2652
|
+
| BodyResponseCallback<Readable>
|
|
2653
|
+
):
|
|
2654
|
+
| void
|
|
2655
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>
|
|
2656
|
+
| GaxiosPromise<Readable> {
|
|
2657
|
+
let params = (paramsOrCallback ||
|
|
2658
|
+
{}) as Params$Resource$Locations$Lookupwidgetconfig;
|
|
2659
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2660
|
+
|
|
2661
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2662
|
+
callback = paramsOrCallback;
|
|
2663
|
+
params = {} as Params$Resource$Locations$Lookupwidgetconfig;
|
|
2664
|
+
options = {};
|
|
2665
|
+
}
|
|
2666
|
+
|
|
2667
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2668
|
+
callback = optionsOrCallback;
|
|
2669
|
+
options = {};
|
|
2670
|
+
}
|
|
2671
|
+
|
|
2672
|
+
const rootUrl =
|
|
2673
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2674
|
+
const parameters = {
|
|
2675
|
+
options: Object.assign(
|
|
2676
|
+
{
|
|
2677
|
+
url: (rootUrl + '/v1alpha/{+location}/lookupWidgetConfig').replace(
|
|
2678
|
+
/([^:]\/)\/+/g,
|
|
2679
|
+
'$1'
|
|
2680
|
+
),
|
|
2681
|
+
method: 'POST',
|
|
2682
|
+
},
|
|
2683
|
+
options
|
|
2684
|
+
),
|
|
2685
|
+
params,
|
|
2686
|
+
requiredParams: ['location'],
|
|
2687
|
+
pathParams: ['location'],
|
|
2688
|
+
context: this.context,
|
|
2689
|
+
};
|
|
2690
|
+
if (callback) {
|
|
2691
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>(
|
|
2692
|
+
parameters,
|
|
2693
|
+
callback as BodyResponseCallback<unknown>
|
|
2694
|
+
);
|
|
2695
|
+
} else {
|
|
2696
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>(
|
|
2697
|
+
parameters
|
|
2698
|
+
);
|
|
2699
|
+
}
|
|
2700
|
+
}
|
|
2701
|
+
|
|
2702
|
+
/**
|
|
2703
|
+
* 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.
|
|
2704
|
+
*
|
|
2705
|
+
* @param params - Parameters for request
|
|
2706
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2707
|
+
* @param callback - Optional callback that handles the response.
|
|
2708
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2709
|
+
*/
|
|
2710
|
+
widgetCompleteQuery(
|
|
2711
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2712
|
+
options: StreamMethodOptions
|
|
2713
|
+
): GaxiosPromise<Readable>;
|
|
2714
|
+
widgetCompleteQuery(
|
|
2715
|
+
params?: Params$Resource$Locations$Widgetcompletequery,
|
|
2716
|
+
options?: MethodOptions
|
|
2717
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
|
|
2718
|
+
widgetCompleteQuery(
|
|
2719
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2720
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2721
|
+
callback: BodyResponseCallback<Readable>
|
|
2722
|
+
): void;
|
|
2723
|
+
widgetCompleteQuery(
|
|
2724
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2725
|
+
options:
|
|
2726
|
+
| MethodOptions
|
|
2727
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>,
|
|
2728
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2729
|
+
): void;
|
|
2730
|
+
widgetCompleteQuery(
|
|
2731
|
+
params: Params$Resource$Locations$Widgetcompletequery,
|
|
2732
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2733
|
+
): void;
|
|
2734
|
+
widgetCompleteQuery(
|
|
2735
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2736
|
+
): void;
|
|
2737
|
+
widgetCompleteQuery(
|
|
2738
|
+
paramsOrCallback?:
|
|
2739
|
+
| Params$Resource$Locations$Widgetcompletequery
|
|
2740
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2741
|
+
| BodyResponseCallback<Readable>,
|
|
2742
|
+
optionsOrCallback?:
|
|
2743
|
+
| MethodOptions
|
|
2744
|
+
| StreamMethodOptions
|
|
2745
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2746
|
+
| BodyResponseCallback<Readable>,
|
|
2747
|
+
callback?:
|
|
2748
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2749
|
+
| BodyResponseCallback<Readable>
|
|
2750
|
+
):
|
|
2751
|
+
| void
|
|
2752
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>
|
|
2753
|
+
| GaxiosPromise<Readable> {
|
|
2754
|
+
let params = (paramsOrCallback ||
|
|
2755
|
+
{}) as Params$Resource$Locations$Widgetcompletequery;
|
|
2756
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2757
|
+
|
|
2758
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2759
|
+
callback = paramsOrCallback;
|
|
2760
|
+
params = {} as Params$Resource$Locations$Widgetcompletequery;
|
|
2761
|
+
options = {};
|
|
2762
|
+
}
|
|
2763
|
+
|
|
2764
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2765
|
+
callback = optionsOrCallback;
|
|
2766
|
+
options = {};
|
|
2767
|
+
}
|
|
2768
|
+
|
|
2769
|
+
const rootUrl =
|
|
2770
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2771
|
+
const parameters = {
|
|
2772
|
+
options: Object.assign(
|
|
2773
|
+
{
|
|
2774
|
+
url: (rootUrl + '/v1alpha/{+location}/widgetCompleteQuery').replace(
|
|
2775
|
+
/([^:]\/)\/+/g,
|
|
2776
|
+
'$1'
|
|
2777
|
+
),
|
|
2778
|
+
method: 'POST',
|
|
2779
|
+
},
|
|
2780
|
+
options
|
|
2781
|
+
),
|
|
2782
|
+
params,
|
|
2783
|
+
requiredParams: ['location'],
|
|
2784
|
+
pathParams: ['location'],
|
|
2785
|
+
context: this.context,
|
|
2786
|
+
};
|
|
2787
|
+
if (callback) {
|
|
2788
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>(
|
|
2789
|
+
parameters,
|
|
2790
|
+
callback as BodyResponseCallback<unknown>
|
|
2791
|
+
);
|
|
2792
|
+
} else {
|
|
2793
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>(
|
|
2794
|
+
parameters
|
|
2795
|
+
);
|
|
2796
|
+
}
|
|
2797
|
+
}
|
|
2798
|
+
|
|
2799
|
+
/**
|
|
2800
|
+
* Converse a conversation with Widget.
|
|
2801
|
+
*
|
|
2802
|
+
* @param params - Parameters for request
|
|
2803
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2804
|
+
* @param callback - Optional callback that handles the response.
|
|
2805
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2806
|
+
*/
|
|
2807
|
+
widgetConverseConversation(
|
|
2808
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2809
|
+
options: StreamMethodOptions
|
|
2810
|
+
): GaxiosPromise<Readable>;
|
|
2811
|
+
widgetConverseConversation(
|
|
2812
|
+
params?: Params$Resource$Locations$Widgetconverseconversation,
|
|
2813
|
+
options?: MethodOptions
|
|
2814
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
|
|
2815
|
+
widgetConverseConversation(
|
|
2816
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2817
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2818
|
+
callback: BodyResponseCallback<Readable>
|
|
2819
|
+
): void;
|
|
2820
|
+
widgetConverseConversation(
|
|
2821
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2822
|
+
options:
|
|
2823
|
+
| MethodOptions
|
|
2824
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>,
|
|
2825
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2826
|
+
): void;
|
|
2827
|
+
widgetConverseConversation(
|
|
2828
|
+
params: Params$Resource$Locations$Widgetconverseconversation,
|
|
2829
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2830
|
+
): void;
|
|
2831
|
+
widgetConverseConversation(
|
|
2832
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2833
|
+
): void;
|
|
2834
|
+
widgetConverseConversation(
|
|
2835
|
+
paramsOrCallback?:
|
|
2836
|
+
| Params$Resource$Locations$Widgetconverseconversation
|
|
2837
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2838
|
+
| BodyResponseCallback<Readable>,
|
|
2839
|
+
optionsOrCallback?:
|
|
2840
|
+
| MethodOptions
|
|
2841
|
+
| StreamMethodOptions
|
|
2842
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2843
|
+
| BodyResponseCallback<Readable>,
|
|
2844
|
+
callback?:
|
|
2845
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2846
|
+
| BodyResponseCallback<Readable>
|
|
2847
|
+
):
|
|
2848
|
+
| void
|
|
2849
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>
|
|
2850
|
+
| GaxiosPromise<Readable> {
|
|
2851
|
+
let params = (paramsOrCallback ||
|
|
2852
|
+
{}) as Params$Resource$Locations$Widgetconverseconversation;
|
|
2853
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2854
|
+
|
|
2855
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2856
|
+
callback = paramsOrCallback;
|
|
2857
|
+
params = {} as Params$Resource$Locations$Widgetconverseconversation;
|
|
2858
|
+
options = {};
|
|
2859
|
+
}
|
|
2860
|
+
|
|
2861
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2862
|
+
callback = optionsOrCallback;
|
|
2863
|
+
options = {};
|
|
2864
|
+
}
|
|
2865
|
+
|
|
2866
|
+
const rootUrl =
|
|
2867
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2868
|
+
const parameters = {
|
|
2869
|
+
options: Object.assign(
|
|
2870
|
+
{
|
|
2871
|
+
url: (
|
|
2872
|
+
rootUrl + '/v1alpha/{+location}/widgetConverseConversation'
|
|
2873
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
2874
|
+
method: 'POST',
|
|
2875
|
+
},
|
|
2876
|
+
options
|
|
2877
|
+
),
|
|
2878
|
+
params,
|
|
2879
|
+
requiredParams: ['location'],
|
|
2880
|
+
pathParams: ['location'],
|
|
2881
|
+
context: this.context,
|
|
2882
|
+
};
|
|
2883
|
+
if (callback) {
|
|
2884
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>(
|
|
2885
|
+
parameters,
|
|
2886
|
+
callback as BodyResponseCallback<unknown>
|
|
2887
|
+
);
|
|
2888
|
+
} else {
|
|
2889
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>(
|
|
2890
|
+
parameters
|
|
2891
|
+
);
|
|
2892
|
+
}
|
|
2893
|
+
}
|
|
2894
|
+
|
|
2895
|
+
/**
|
|
2896
|
+
* 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.
|
|
2897
|
+
*
|
|
2898
|
+
* @param params - Parameters for request
|
|
2899
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2900
|
+
* @param callback - Optional callback that handles the response.
|
|
2901
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2902
|
+
*/
|
|
2903
|
+
widgetSearch(
|
|
2904
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2905
|
+
options: StreamMethodOptions
|
|
2906
|
+
): GaxiosPromise<Readable>;
|
|
2907
|
+
widgetSearch(
|
|
2908
|
+
params?: Params$Resource$Locations$Widgetsearch,
|
|
2909
|
+
options?: MethodOptions
|
|
2910
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
|
|
2911
|
+
widgetSearch(
|
|
2912
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2913
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2914
|
+
callback: BodyResponseCallback<Readable>
|
|
2915
|
+
): void;
|
|
2916
|
+
widgetSearch(
|
|
2917
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2918
|
+
options:
|
|
2919
|
+
| MethodOptions
|
|
2920
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>,
|
|
2921
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2922
|
+
): void;
|
|
2923
|
+
widgetSearch(
|
|
2924
|
+
params: Params$Resource$Locations$Widgetsearch,
|
|
2925
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2926
|
+
): void;
|
|
2927
|
+
widgetSearch(
|
|
2928
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2929
|
+
): void;
|
|
2930
|
+
widgetSearch(
|
|
2931
|
+
paramsOrCallback?:
|
|
2932
|
+
| Params$Resource$Locations$Widgetsearch
|
|
2933
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2934
|
+
| BodyResponseCallback<Readable>,
|
|
2935
|
+
optionsOrCallback?:
|
|
2936
|
+
| MethodOptions
|
|
2937
|
+
| StreamMethodOptions
|
|
2938
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2939
|
+
| BodyResponseCallback<Readable>,
|
|
2940
|
+
callback?:
|
|
2941
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2942
|
+
| BodyResponseCallback<Readable>
|
|
2943
|
+
):
|
|
2944
|
+
| void
|
|
2945
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>
|
|
2946
|
+
| GaxiosPromise<Readable> {
|
|
2947
|
+
let params = (paramsOrCallback ||
|
|
2948
|
+
{}) as Params$Resource$Locations$Widgetsearch;
|
|
2949
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2950
|
+
|
|
2951
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2952
|
+
callback = paramsOrCallback;
|
|
2953
|
+
params = {} as Params$Resource$Locations$Widgetsearch;
|
|
2954
|
+
options = {};
|
|
2955
|
+
}
|
|
2956
|
+
|
|
2957
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2958
|
+
callback = optionsOrCallback;
|
|
2959
|
+
options = {};
|
|
2960
|
+
}
|
|
2961
|
+
|
|
2962
|
+
const rootUrl =
|
|
2963
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
2964
|
+
const parameters = {
|
|
2965
|
+
options: Object.assign(
|
|
2966
|
+
{
|
|
2967
|
+
url: (rootUrl + '/v1alpha/{+location}/widgetSearch').replace(
|
|
2968
|
+
/([^:]\/)\/+/g,
|
|
2969
|
+
'$1'
|
|
2970
|
+
),
|
|
2971
|
+
method: 'POST',
|
|
2972
|
+
},
|
|
2973
|
+
options
|
|
2974
|
+
),
|
|
2975
|
+
params,
|
|
2976
|
+
requiredParams: ['location'],
|
|
2977
|
+
pathParams: ['location'],
|
|
2978
|
+
context: this.context,
|
|
2979
|
+
};
|
|
2980
|
+
if (callback) {
|
|
2981
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>(
|
|
2982
|
+
parameters,
|
|
2983
|
+
callback as BodyResponseCallback<unknown>
|
|
2984
|
+
);
|
|
2985
|
+
} else {
|
|
2986
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>(
|
|
2987
|
+
parameters
|
|
2988
|
+
);
|
|
2989
|
+
}
|
|
2990
|
+
}
|
|
2991
|
+
}
|
|
2992
|
+
|
|
2993
|
+
export interface Params$Resource$Locations$Lookupwidgetconfig
|
|
2994
|
+
extends StandardParameters {
|
|
2995
|
+
/**
|
|
2996
|
+
* Required. The location resource where lookup widget will be performed. Format: `locations/{location\}`
|
|
2997
|
+
*/
|
|
2998
|
+
location?: string;
|
|
2999
|
+
|
|
3000
|
+
/**
|
|
3001
|
+
* Request body metadata
|
|
3002
|
+
*/
|
|
3003
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest;
|
|
3004
|
+
}
|
|
3005
|
+
export interface Params$Resource$Locations$Widgetcompletequery
|
|
3006
|
+
extends StandardParameters {
|
|
3007
|
+
/**
|
|
3008
|
+
* Required. The location resource where widget complete query will be performed. Format: `locations/{location\}`
|
|
3009
|
+
*/
|
|
3010
|
+
location?: string;
|
|
3011
|
+
|
|
3012
|
+
/**
|
|
3013
|
+
* Request body metadata
|
|
3014
|
+
*/
|
|
3015
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
|
|
3016
|
+
}
|
|
3017
|
+
export interface Params$Resource$Locations$Widgetconverseconversation
|
|
3018
|
+
extends StandardParameters {
|
|
3019
|
+
/**
|
|
3020
|
+
* Required. The location resource where widget converse conversation will be performed. Format: `locations/{location\}`
|
|
3021
|
+
*/
|
|
3022
|
+
location?: string;
|
|
3023
|
+
|
|
3024
|
+
/**
|
|
3025
|
+
* Request body metadata
|
|
3026
|
+
*/
|
|
3027
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
|
|
3028
|
+
}
|
|
3029
|
+
export interface Params$Resource$Locations$Widgetsearch
|
|
3030
|
+
extends StandardParameters {
|
|
3031
|
+
/**
|
|
3032
|
+
* Required. The location resource where widget search will be performed. Format: `locations/{location\}`
|
|
3033
|
+
*/
|
|
3034
|
+
location?: string;
|
|
3035
|
+
|
|
3036
|
+
/**
|
|
3037
|
+
* Request body metadata
|
|
3038
|
+
*/
|
|
3039
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
|
|
3040
|
+
}
|
|
3041
|
+
|
|
3042
|
+
export class Resource$Projects {
|
|
3043
|
+
context: APIRequestContext;
|
|
3044
|
+
locations: Resource$Projects$Locations;
|
|
3045
|
+
operations: Resource$Projects$Operations;
|
|
3046
|
+
constructor(context: APIRequestContext) {
|
|
3047
|
+
this.context = context;
|
|
3048
|
+
this.locations = new Resource$Projects$Locations(this.context);
|
|
3049
|
+
this.operations = new Resource$Projects$Operations(this.context);
|
|
3050
|
+
}
|
|
3051
|
+
}
|
|
3052
|
+
|
|
3053
|
+
export class Resource$Projects$Locations {
|
|
3054
|
+
context: APIRequestContext;
|
|
3055
|
+
collections: Resource$Projects$Locations$Collections;
|
|
3056
|
+
dataStores: Resource$Projects$Locations$Datastores;
|
|
3057
|
+
operations: Resource$Projects$Locations$Operations;
|
|
3058
|
+
constructor(context: APIRequestContext) {
|
|
3059
|
+
this.context = context;
|
|
3060
|
+
this.collections = new Resource$Projects$Locations$Collections(
|
|
3061
|
+
this.context
|
|
3062
|
+
);
|
|
3063
|
+
this.dataStores = new Resource$Projects$Locations$Datastores(
|
|
2219
3064
|
this.context
|
|
2220
3065
|
);
|
|
2221
3066
|
this.operations = new Resource$Projects$Locations$Operations(
|
|
@@ -2403,7 +3248,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
2403
3248
|
*/
|
|
2404
3249
|
query?: string;
|
|
2405
3250
|
/**
|
|
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
|
|
3251
|
+
* 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
3252
|
*/
|
|
2408
3253
|
queryModel?: string;
|
|
2409
3254
|
/**
|
|
@@ -5551,6 +6396,115 @@ export namespace discoveryengine_v1alpha {
|
|
|
5551
6396
|
this.context
|
|
5552
6397
|
);
|
|
5553
6398
|
}
|
|
6399
|
+
|
|
6400
|
+
/**
|
|
6401
|
+
* Request on-demand recrawl for a list of URIs.
|
|
6402
|
+
*
|
|
6403
|
+
* @param params - Parameters for request
|
|
6404
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6405
|
+
* @param callback - Optional callback that handles the response.
|
|
6406
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6407
|
+
*/
|
|
6408
|
+
recrawlUris(
|
|
6409
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6410
|
+
options: StreamMethodOptions
|
|
6411
|
+
): GaxiosPromise<Readable>;
|
|
6412
|
+
recrawlUris(
|
|
6413
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6414
|
+
options?: MethodOptions
|
|
6415
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6416
|
+
recrawlUris(
|
|
6417
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6418
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6419
|
+
callback: BodyResponseCallback<Readable>
|
|
6420
|
+
): void;
|
|
6421
|
+
recrawlUris(
|
|
6422
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6423
|
+
options:
|
|
6424
|
+
| MethodOptions
|
|
6425
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
6426
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6427
|
+
): void;
|
|
6428
|
+
recrawlUris(
|
|
6429
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris,
|
|
6430
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6431
|
+
): void;
|
|
6432
|
+
recrawlUris(
|
|
6433
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6434
|
+
): void;
|
|
6435
|
+
recrawlUris(
|
|
6436
|
+
paramsOrCallback?:
|
|
6437
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris
|
|
6438
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6439
|
+
| BodyResponseCallback<Readable>,
|
|
6440
|
+
optionsOrCallback?:
|
|
6441
|
+
| MethodOptions
|
|
6442
|
+
| StreamMethodOptions
|
|
6443
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6444
|
+
| BodyResponseCallback<Readable>,
|
|
6445
|
+
callback?:
|
|
6446
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
6447
|
+
| BodyResponseCallback<Readable>
|
|
6448
|
+
):
|
|
6449
|
+
| void
|
|
6450
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
6451
|
+
| GaxiosPromise<Readable> {
|
|
6452
|
+
let params = (paramsOrCallback ||
|
|
6453
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris;
|
|
6454
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6455
|
+
|
|
6456
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6457
|
+
callback = paramsOrCallback;
|
|
6458
|
+
params =
|
|
6459
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris;
|
|
6460
|
+
options = {};
|
|
6461
|
+
}
|
|
6462
|
+
|
|
6463
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6464
|
+
callback = optionsOrCallback;
|
|
6465
|
+
options = {};
|
|
6466
|
+
}
|
|
6467
|
+
|
|
6468
|
+
const rootUrl =
|
|
6469
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6470
|
+
const parameters = {
|
|
6471
|
+
options: Object.assign(
|
|
6472
|
+
{
|
|
6473
|
+
url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace(
|
|
6474
|
+
/([^:]\/)\/+/g,
|
|
6475
|
+
'$1'
|
|
6476
|
+
),
|
|
6477
|
+
method: 'POST',
|
|
6478
|
+
},
|
|
6479
|
+
options
|
|
6480
|
+
),
|
|
6481
|
+
params,
|
|
6482
|
+
requiredParams: ['siteSearchEngine'],
|
|
6483
|
+
pathParams: ['siteSearchEngine'],
|
|
6484
|
+
context: this.context,
|
|
6485
|
+
};
|
|
6486
|
+
if (callback) {
|
|
6487
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
6488
|
+
parameters,
|
|
6489
|
+
callback as BodyResponseCallback<unknown>
|
|
6490
|
+
);
|
|
6491
|
+
} else {
|
|
6492
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
6493
|
+
}
|
|
6494
|
+
}
|
|
6495
|
+
}
|
|
6496
|
+
|
|
6497
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris
|
|
6498
|
+
extends StandardParameters {
|
|
6499
|
+
/**
|
|
6500
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
6501
|
+
*/
|
|
6502
|
+
siteSearchEngine?: string;
|
|
6503
|
+
|
|
6504
|
+
/**
|
|
6505
|
+
* Request body metadata
|
|
6506
|
+
*/
|
|
6507
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
5554
6508
|
}
|
|
5555
6509
|
|
|
5556
6510
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations {
|
|
@@ -6452,92 +7406,322 @@ export namespace discoveryengine_v1alpha {
|
|
|
6452
7406
|
/**
|
|
6453
7407
|
* Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
6454
7408
|
*/
|
|
6455
|
-
parent?: string;
|
|
6456
|
-
|
|
7409
|
+
parent?: string;
|
|
7410
|
+
|
|
7411
|
+
/**
|
|
7412
|
+
* Request body metadata
|
|
7413
|
+
*/
|
|
7414
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
7415
|
+
}
|
|
7416
|
+
|
|
7417
|
+
export class Resource$Projects$Locations$Collections$Engines {
|
|
7418
|
+
context: APIRequestContext;
|
|
7419
|
+
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
7420
|
+
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
7421
|
+
constructor(context: APIRequestContext) {
|
|
7422
|
+
this.context = context;
|
|
7423
|
+
this.operations =
|
|
7424
|
+
new Resource$Projects$Locations$Collections$Engines$Operations(
|
|
7425
|
+
this.context
|
|
7426
|
+
);
|
|
7427
|
+
this.servingConfigs =
|
|
7428
|
+
new Resource$Projects$Locations$Collections$Engines$Servingconfigs(
|
|
7429
|
+
this.context
|
|
7430
|
+
);
|
|
7431
|
+
}
|
|
7432
|
+
}
|
|
7433
|
+
|
|
7434
|
+
export class Resource$Projects$Locations$Collections$Engines$Operations {
|
|
7435
|
+
context: APIRequestContext;
|
|
7436
|
+
constructor(context: APIRequestContext) {
|
|
7437
|
+
this.context = context;
|
|
7438
|
+
}
|
|
7439
|
+
|
|
7440
|
+
/**
|
|
7441
|
+
* 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.
|
|
7442
|
+
*
|
|
7443
|
+
* @param params - Parameters for request
|
|
7444
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7445
|
+
* @param callback - Optional callback that handles the response.
|
|
7446
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7447
|
+
*/
|
|
7448
|
+
get(
|
|
7449
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7450
|
+
options: StreamMethodOptions
|
|
7451
|
+
): GaxiosPromise<Readable>;
|
|
7452
|
+
get(
|
|
7453
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7454
|
+
options?: MethodOptions
|
|
7455
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7456
|
+
get(
|
|
7457
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7458
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7459
|
+
callback: BodyResponseCallback<Readable>
|
|
7460
|
+
): void;
|
|
7461
|
+
get(
|
|
7462
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7463
|
+
options:
|
|
7464
|
+
| MethodOptions
|
|
7465
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
7466
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7467
|
+
): void;
|
|
7468
|
+
get(
|
|
7469
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
|
|
7470
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7471
|
+
): void;
|
|
7472
|
+
get(
|
|
7473
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7474
|
+
): void;
|
|
7475
|
+
get(
|
|
7476
|
+
paramsOrCallback?:
|
|
7477
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
|
|
7478
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7479
|
+
| BodyResponseCallback<Readable>,
|
|
7480
|
+
optionsOrCallback?:
|
|
7481
|
+
| MethodOptions
|
|
7482
|
+
| StreamMethodOptions
|
|
7483
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7484
|
+
| BodyResponseCallback<Readable>,
|
|
7485
|
+
callback?:
|
|
7486
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
7487
|
+
| BodyResponseCallback<Readable>
|
|
7488
|
+
):
|
|
7489
|
+
| void
|
|
7490
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
7491
|
+
| GaxiosPromise<Readable> {
|
|
7492
|
+
let params = (paramsOrCallback ||
|
|
7493
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
|
|
7494
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7495
|
+
|
|
7496
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7497
|
+
callback = paramsOrCallback;
|
|
7498
|
+
params =
|
|
7499
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
|
|
7500
|
+
options = {};
|
|
7501
|
+
}
|
|
7502
|
+
|
|
7503
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7504
|
+
callback = optionsOrCallback;
|
|
7505
|
+
options = {};
|
|
7506
|
+
}
|
|
7507
|
+
|
|
7508
|
+
const rootUrl =
|
|
7509
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7510
|
+
const parameters = {
|
|
7511
|
+
options: Object.assign(
|
|
7512
|
+
{
|
|
7513
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
7514
|
+
method: 'GET',
|
|
7515
|
+
},
|
|
7516
|
+
options
|
|
7517
|
+
),
|
|
7518
|
+
params,
|
|
7519
|
+
requiredParams: ['name'],
|
|
7520
|
+
pathParams: ['name'],
|
|
7521
|
+
context: this.context,
|
|
7522
|
+
};
|
|
7523
|
+
if (callback) {
|
|
7524
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
7525
|
+
parameters,
|
|
7526
|
+
callback as BodyResponseCallback<unknown>
|
|
7527
|
+
);
|
|
7528
|
+
} else {
|
|
7529
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
7530
|
+
}
|
|
7531
|
+
}
|
|
7532
|
+
|
|
7533
|
+
/**
|
|
7534
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
7535
|
+
*
|
|
7536
|
+
* @param params - Parameters for request
|
|
7537
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7538
|
+
* @param callback - Optional callback that handles the response.
|
|
7539
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7540
|
+
*/
|
|
7541
|
+
list(
|
|
7542
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7543
|
+
options: StreamMethodOptions
|
|
7544
|
+
): GaxiosPromise<Readable>;
|
|
7545
|
+
list(
|
|
7546
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7547
|
+
options?: MethodOptions
|
|
7548
|
+
): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
|
|
7549
|
+
list(
|
|
7550
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7551
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7552
|
+
callback: BodyResponseCallback<Readable>
|
|
7553
|
+
): void;
|
|
7554
|
+
list(
|
|
7555
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7556
|
+
options:
|
|
7557
|
+
| MethodOptions
|
|
7558
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>,
|
|
7559
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7560
|
+
): void;
|
|
7561
|
+
list(
|
|
7562
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
|
|
7563
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7564
|
+
): void;
|
|
7565
|
+
list(
|
|
7566
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7567
|
+
): void;
|
|
7568
|
+
list(
|
|
7569
|
+
paramsOrCallback?:
|
|
7570
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Operations$List
|
|
7571
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7572
|
+
| BodyResponseCallback<Readable>,
|
|
7573
|
+
optionsOrCallback?:
|
|
7574
|
+
| MethodOptions
|
|
7575
|
+
| StreamMethodOptions
|
|
7576
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7577
|
+
| BodyResponseCallback<Readable>,
|
|
7578
|
+
callback?:
|
|
7579
|
+
| BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
|
|
7580
|
+
| BodyResponseCallback<Readable>
|
|
7581
|
+
):
|
|
7582
|
+
| void
|
|
7583
|
+
| GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
|
|
7584
|
+
| GaxiosPromise<Readable> {
|
|
7585
|
+
let params = (paramsOrCallback ||
|
|
7586
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
|
|
7587
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7588
|
+
|
|
7589
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7590
|
+
callback = paramsOrCallback;
|
|
7591
|
+
params =
|
|
7592
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
|
|
7593
|
+
options = {};
|
|
7594
|
+
}
|
|
7595
|
+
|
|
7596
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7597
|
+
callback = optionsOrCallback;
|
|
7598
|
+
options = {};
|
|
7599
|
+
}
|
|
7600
|
+
|
|
7601
|
+
const rootUrl =
|
|
7602
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
7603
|
+
const parameters = {
|
|
7604
|
+
options: Object.assign(
|
|
7605
|
+
{
|
|
7606
|
+
url: (rootUrl + '/v1alpha/{+name}/operations').replace(
|
|
7607
|
+
/([^:]\/)\/+/g,
|
|
7608
|
+
'$1'
|
|
7609
|
+
),
|
|
7610
|
+
method: 'GET',
|
|
7611
|
+
},
|
|
7612
|
+
options
|
|
7613
|
+
),
|
|
7614
|
+
params,
|
|
7615
|
+
requiredParams: ['name'],
|
|
7616
|
+
pathParams: ['name'],
|
|
7617
|
+
context: this.context,
|
|
7618
|
+
};
|
|
7619
|
+
if (callback) {
|
|
7620
|
+
createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
7621
|
+
parameters,
|
|
7622
|
+
callback as BodyResponseCallback<unknown>
|
|
7623
|
+
);
|
|
7624
|
+
} else {
|
|
7625
|
+
return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
|
|
7626
|
+
parameters
|
|
7627
|
+
);
|
|
7628
|
+
}
|
|
7629
|
+
}
|
|
7630
|
+
}
|
|
7631
|
+
|
|
7632
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
|
|
7633
|
+
extends StandardParameters {
|
|
7634
|
+
/**
|
|
7635
|
+
* The name of the operation resource.
|
|
7636
|
+
*/
|
|
7637
|
+
name?: string;
|
|
7638
|
+
}
|
|
7639
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List
|
|
7640
|
+
extends StandardParameters {
|
|
7641
|
+
/**
|
|
7642
|
+
* The standard list filter.
|
|
7643
|
+
*/
|
|
7644
|
+
filter?: string;
|
|
7645
|
+
/**
|
|
7646
|
+
* The name of the operation's parent resource.
|
|
7647
|
+
*/
|
|
7648
|
+
name?: string;
|
|
7649
|
+
/**
|
|
7650
|
+
* The standard list page size.
|
|
7651
|
+
*/
|
|
7652
|
+
pageSize?: number;
|
|
6457
7653
|
/**
|
|
6458
|
-
*
|
|
7654
|
+
* The standard list page token.
|
|
6459
7655
|
*/
|
|
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
|
-
}
|
|
7656
|
+
pageToken?: string;
|
|
6473
7657
|
}
|
|
6474
7658
|
|
|
6475
|
-
export class Resource$Projects$Locations$Collections$Engines$
|
|
7659
|
+
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
6476
7660
|
context: APIRequestContext;
|
|
6477
7661
|
constructor(context: APIRequestContext) {
|
|
6478
7662
|
this.context = context;
|
|
6479
7663
|
}
|
|
6480
7664
|
|
|
6481
7665
|
/**
|
|
6482
|
-
*
|
|
7666
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
6483
7667
|
*
|
|
6484
7668
|
* @param params - Parameters for request
|
|
6485
7669
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6486
7670
|
* @param callback - Optional callback that handles the response.
|
|
6487
7671
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6488
7672
|
*/
|
|
6489
|
-
|
|
6490
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7673
|
+
recommend(
|
|
7674
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6491
7675
|
options: StreamMethodOptions
|
|
6492
7676
|
): GaxiosPromise<Readable>;
|
|
6493
|
-
|
|
6494
|
-
params?: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7677
|
+
recommend(
|
|
7678
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6495
7679
|
options?: MethodOptions
|
|
6496
|
-
): GaxiosPromise<Schema$
|
|
6497
|
-
|
|
6498
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7680
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
7681
|
+
recommend(
|
|
7682
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6499
7683
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6500
7684
|
callback: BodyResponseCallback<Readable>
|
|
6501
7685
|
): void;
|
|
6502
|
-
|
|
6503
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7686
|
+
recommend(
|
|
7687
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6504
7688
|
options:
|
|
6505
7689
|
| MethodOptions
|
|
6506
|
-
| BodyResponseCallback<Schema$
|
|
6507
|
-
callback: BodyResponseCallback<Schema$
|
|
7690
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>,
|
|
7691
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6508
7692
|
): void;
|
|
6509
|
-
|
|
6510
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
6511
|
-
callback: BodyResponseCallback<Schema$
|
|
7693
|
+
recommend(
|
|
7694
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
7695
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6512
7696
|
): void;
|
|
6513
|
-
|
|
6514
|
-
callback: BodyResponseCallback<Schema$
|
|
7697
|
+
recommend(
|
|
7698
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6515
7699
|
): void;
|
|
6516
|
-
|
|
7700
|
+
recommend(
|
|
6517
7701
|
paramsOrCallback?:
|
|
6518
|
-
| Params$Resource$Projects$Locations$Collections$Engines$
|
|
6519
|
-
| BodyResponseCallback<Schema$
|
|
7702
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
7703
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6520
7704
|
| BodyResponseCallback<Readable>,
|
|
6521
7705
|
optionsOrCallback?:
|
|
6522
7706
|
| MethodOptions
|
|
6523
7707
|
| StreamMethodOptions
|
|
6524
|
-
| BodyResponseCallback<Schema$
|
|
7708
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6525
7709
|
| BodyResponseCallback<Readable>,
|
|
6526
7710
|
callback?:
|
|
6527
|
-
| BodyResponseCallback<Schema$
|
|
7711
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6528
7712
|
| BodyResponseCallback<Readable>
|
|
6529
7713
|
):
|
|
6530
7714
|
| void
|
|
6531
|
-
| GaxiosPromise<Schema$
|
|
7715
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
|
|
6532
7716
|
| GaxiosPromise<Readable> {
|
|
6533
7717
|
let params = (paramsOrCallback ||
|
|
6534
|
-
{}) as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7718
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend;
|
|
6535
7719
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6536
7720
|
|
|
6537
7721
|
if (typeof paramsOrCallback === 'function') {
|
|
6538
7722
|
callback = paramsOrCallback;
|
|
6539
7723
|
params =
|
|
6540
|
-
{} as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7724
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend;
|
|
6541
7725
|
options = {};
|
|
6542
7726
|
}
|
|
6543
7727
|
|
|
@@ -6551,86 +7735,91 @@ export namespace discoveryengine_v1alpha {
|
|
|
6551
7735
|
const parameters = {
|
|
6552
7736
|
options: Object.assign(
|
|
6553
7737
|
{
|
|
6554
|
-
url: (rootUrl + '/v1alpha/{+
|
|
6555
|
-
|
|
7738
|
+
url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace(
|
|
7739
|
+
/([^:]\/)\/+/g,
|
|
7740
|
+
'$1'
|
|
7741
|
+
),
|
|
7742
|
+
method: 'POST',
|
|
6556
7743
|
},
|
|
6557
7744
|
options
|
|
6558
7745
|
),
|
|
6559
7746
|
params,
|
|
6560
|
-
requiredParams: ['
|
|
6561
|
-
pathParams: ['
|
|
7747
|
+
requiredParams: ['servingConfig'],
|
|
7748
|
+
pathParams: ['servingConfig'],
|
|
6562
7749
|
context: this.context,
|
|
6563
7750
|
};
|
|
6564
7751
|
if (callback) {
|
|
6565
|
-
createAPIRequest<Schema$
|
|
7752
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
|
|
6566
7753
|
parameters,
|
|
6567
7754
|
callback as BodyResponseCallback<unknown>
|
|
6568
7755
|
);
|
|
6569
7756
|
} else {
|
|
6570
|
-
return createAPIRequest<Schema$
|
|
7757
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
|
|
7758
|
+
parameters
|
|
7759
|
+
);
|
|
6571
7760
|
}
|
|
6572
7761
|
}
|
|
6573
7762
|
|
|
6574
7763
|
/**
|
|
6575
|
-
*
|
|
7764
|
+
* Performs a search.
|
|
6576
7765
|
*
|
|
6577
7766
|
* @param params - Parameters for request
|
|
6578
7767
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6579
7768
|
* @param callback - Optional callback that handles the response.
|
|
6580
7769
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6581
7770
|
*/
|
|
6582
|
-
|
|
6583
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7771
|
+
search(
|
|
7772
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6584
7773
|
options: StreamMethodOptions
|
|
6585
7774
|
): GaxiosPromise<Readable>;
|
|
6586
|
-
|
|
6587
|
-
params?: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7775
|
+
search(
|
|
7776
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6588
7777
|
options?: MethodOptions
|
|
6589
|
-
): GaxiosPromise<Schema$
|
|
6590
|
-
|
|
6591
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7778
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
7779
|
+
search(
|
|
7780
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6592
7781
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6593
7782
|
callback: BodyResponseCallback<Readable>
|
|
6594
7783
|
): void;
|
|
6595
|
-
|
|
6596
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
7784
|
+
search(
|
|
7785
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6597
7786
|
options:
|
|
6598
7787
|
| MethodOptions
|
|
6599
|
-
| BodyResponseCallback<Schema$
|
|
6600
|
-
callback: BodyResponseCallback<Schema$
|
|
7788
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>,
|
|
7789
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6601
7790
|
): void;
|
|
6602
|
-
|
|
6603
|
-
params: Params$Resource$Projects$Locations$Collections$Engines$
|
|
6604
|
-
callback: BodyResponseCallback<Schema$
|
|
7791
|
+
search(
|
|
7792
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
7793
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6605
7794
|
): void;
|
|
6606
|
-
|
|
6607
|
-
callback: BodyResponseCallback<Schema$
|
|
7795
|
+
search(
|
|
7796
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6608
7797
|
): void;
|
|
6609
|
-
|
|
7798
|
+
search(
|
|
6610
7799
|
paramsOrCallback?:
|
|
6611
|
-
| Params$Resource$Projects$Locations$Collections$Engines$
|
|
6612
|
-
| BodyResponseCallback<Schema$
|
|
7800
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search
|
|
7801
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6613
7802
|
| BodyResponseCallback<Readable>,
|
|
6614
7803
|
optionsOrCallback?:
|
|
6615
7804
|
| MethodOptions
|
|
6616
7805
|
| StreamMethodOptions
|
|
6617
|
-
| BodyResponseCallback<Schema$
|
|
7806
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6618
7807
|
| BodyResponseCallback<Readable>,
|
|
6619
7808
|
callback?:
|
|
6620
|
-
| BodyResponseCallback<Schema$
|
|
7809
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6621
7810
|
| BodyResponseCallback<Readable>
|
|
6622
7811
|
):
|
|
6623
7812
|
| void
|
|
6624
|
-
| GaxiosPromise<Schema$
|
|
7813
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
|
|
6625
7814
|
| GaxiosPromise<Readable> {
|
|
6626
7815
|
let params = (paramsOrCallback ||
|
|
6627
|
-
{}) as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7816
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search;
|
|
6628
7817
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6629
7818
|
|
|
6630
7819
|
if (typeof paramsOrCallback === 'function') {
|
|
6631
7820
|
callback = paramsOrCallback;
|
|
6632
7821
|
params =
|
|
6633
|
-
{} as Params$Resource$Projects$Locations$Collections$Engines$
|
|
7822
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search;
|
|
6634
7823
|
options = {};
|
|
6635
7824
|
}
|
|
6636
7825
|
|
|
@@ -6644,57 +7833,55 @@ export namespace discoveryengine_v1alpha {
|
|
|
6644
7833
|
const parameters = {
|
|
6645
7834
|
options: Object.assign(
|
|
6646
7835
|
{
|
|
6647
|
-
url: (rootUrl + '/v1alpha/{+
|
|
7836
|
+
url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace(
|
|
6648
7837
|
/([^:]\/)\/+/g,
|
|
6649
7838
|
'$1'
|
|
6650
7839
|
),
|
|
6651
|
-
method: '
|
|
7840
|
+
method: 'POST',
|
|
6652
7841
|
},
|
|
6653
7842
|
options
|
|
6654
7843
|
),
|
|
6655
7844
|
params,
|
|
6656
|
-
requiredParams: ['
|
|
6657
|
-
pathParams: ['
|
|
7845
|
+
requiredParams: ['servingConfig'],
|
|
7846
|
+
pathParams: ['servingConfig'],
|
|
6658
7847
|
context: this.context,
|
|
6659
7848
|
};
|
|
6660
7849
|
if (callback) {
|
|
6661
|
-
createAPIRequest<Schema$
|
|
7850
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
|
|
6662
7851
|
parameters,
|
|
6663
7852
|
callback as BodyResponseCallback<unknown>
|
|
6664
7853
|
);
|
|
6665
7854
|
} else {
|
|
6666
|
-
return createAPIRequest<Schema$
|
|
7855
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
|
|
6667
7856
|
parameters
|
|
6668
7857
|
);
|
|
6669
7858
|
}
|
|
6670
7859
|
}
|
|
6671
7860
|
}
|
|
6672
7861
|
|
|
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
|
|
7862
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
6681
7863
|
extends StandardParameters {
|
|
6682
7864
|
/**
|
|
6683
|
-
*
|
|
7865
|
+
* 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
7866
|
*/
|
|
6685
|
-
|
|
7867
|
+
servingConfig?: string;
|
|
7868
|
+
|
|
6686
7869
|
/**
|
|
6687
|
-
*
|
|
7870
|
+
* Request body metadata
|
|
6688
7871
|
*/
|
|
6689
|
-
|
|
7872
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
|
|
7873
|
+
}
|
|
7874
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search
|
|
7875
|
+
extends StandardParameters {
|
|
6690
7876
|
/**
|
|
6691
|
-
* The
|
|
7877
|
+
* 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
7878
|
*/
|
|
6693
|
-
|
|
7879
|
+
servingConfig?: string;
|
|
7880
|
+
|
|
6694
7881
|
/**
|
|
6695
|
-
*
|
|
7882
|
+
* Request body metadata
|
|
6696
7883
|
*/
|
|
6697
|
-
|
|
7884
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
6698
7885
|
}
|
|
6699
7886
|
|
|
6700
7887
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
@@ -6930,6 +8117,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
6930
8117
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
6931
8118
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
6932
8119
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
8120
|
+
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
6933
8121
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
6934
8122
|
constructor(context: APIRequestContext) {
|
|
6935
8123
|
this.context = context;
|
|
@@ -6949,6 +8137,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
6949
8137
|
);
|
|
6950
8138
|
this.servingConfigs =
|
|
6951
8139
|
new Resource$Projects$Locations$Datastores$Servingconfigs(this.context);
|
|
8140
|
+
this.siteSearchEngine =
|
|
8141
|
+
new Resource$Projects$Locations$Datastores$Sitesearchengine(
|
|
8142
|
+
this.context
|
|
8143
|
+
);
|
|
6952
8144
|
this.userEvents = new Resource$Projects$Locations$Datastores$Userevents(
|
|
6953
8145
|
this.context
|
|
6954
8146
|
);
|
|
@@ -7068,7 +8260,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
7068
8260
|
*/
|
|
7069
8261
|
query?: string;
|
|
7070
8262
|
/**
|
|
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
|
|
8263
|
+
* 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
8264
|
*/
|
|
7073
8265
|
queryModel?: string;
|
|
7074
8266
|
/**
|
|
@@ -9971,6 +11163,122 @@ export namespace discoveryengine_v1alpha {
|
|
|
9971
11163
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
9972
11164
|
}
|
|
9973
11165
|
|
|
11166
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
11167
|
+
context: APIRequestContext;
|
|
11168
|
+
constructor(context: APIRequestContext) {
|
|
11169
|
+
this.context = context;
|
|
11170
|
+
}
|
|
11171
|
+
|
|
11172
|
+
/**
|
|
11173
|
+
* Request on-demand recrawl for a list of URIs.
|
|
11174
|
+
*
|
|
11175
|
+
* @param params - Parameters for request
|
|
11176
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11177
|
+
* @param callback - Optional callback that handles the response.
|
|
11178
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11179
|
+
*/
|
|
11180
|
+
recrawlUris(
|
|
11181
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11182
|
+
options: StreamMethodOptions
|
|
11183
|
+
): GaxiosPromise<Readable>;
|
|
11184
|
+
recrawlUris(
|
|
11185
|
+
params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11186
|
+
options?: MethodOptions
|
|
11187
|
+
): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
11188
|
+
recrawlUris(
|
|
11189
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11190
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
11191
|
+
callback: BodyResponseCallback<Readable>
|
|
11192
|
+
): void;
|
|
11193
|
+
recrawlUris(
|
|
11194
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11195
|
+
options:
|
|
11196
|
+
| MethodOptions
|
|
11197
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
11198
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11199
|
+
): void;
|
|
11200
|
+
recrawlUris(
|
|
11201
|
+
params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris,
|
|
11202
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11203
|
+
): void;
|
|
11204
|
+
recrawlUris(
|
|
11205
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11206
|
+
): void;
|
|
11207
|
+
recrawlUris(
|
|
11208
|
+
paramsOrCallback?:
|
|
11209
|
+
| Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris
|
|
11210
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11211
|
+
| BodyResponseCallback<Readable>,
|
|
11212
|
+
optionsOrCallback?:
|
|
11213
|
+
| MethodOptions
|
|
11214
|
+
| StreamMethodOptions
|
|
11215
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11216
|
+
| BodyResponseCallback<Readable>,
|
|
11217
|
+
callback?:
|
|
11218
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
11219
|
+
| BodyResponseCallback<Readable>
|
|
11220
|
+
):
|
|
11221
|
+
| void
|
|
11222
|
+
| GaxiosPromise<Schema$GoogleLongrunningOperation>
|
|
11223
|
+
| GaxiosPromise<Readable> {
|
|
11224
|
+
let params = (paramsOrCallback ||
|
|
11225
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris;
|
|
11226
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
11227
|
+
|
|
11228
|
+
if (typeof paramsOrCallback === 'function') {
|
|
11229
|
+
callback = paramsOrCallback;
|
|
11230
|
+
params =
|
|
11231
|
+
{} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris;
|
|
11232
|
+
options = {};
|
|
11233
|
+
}
|
|
11234
|
+
|
|
11235
|
+
if (typeof optionsOrCallback === 'function') {
|
|
11236
|
+
callback = optionsOrCallback;
|
|
11237
|
+
options = {};
|
|
11238
|
+
}
|
|
11239
|
+
|
|
11240
|
+
const rootUrl =
|
|
11241
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
11242
|
+
const parameters = {
|
|
11243
|
+
options: Object.assign(
|
|
11244
|
+
{
|
|
11245
|
+
url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace(
|
|
11246
|
+
/([^:]\/)\/+/g,
|
|
11247
|
+
'$1'
|
|
11248
|
+
),
|
|
11249
|
+
method: 'POST',
|
|
11250
|
+
},
|
|
11251
|
+
options
|
|
11252
|
+
),
|
|
11253
|
+
params,
|
|
11254
|
+
requiredParams: ['siteSearchEngine'],
|
|
11255
|
+
pathParams: ['siteSearchEngine'],
|
|
11256
|
+
context: this.context,
|
|
11257
|
+
};
|
|
11258
|
+
if (callback) {
|
|
11259
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
11260
|
+
parameters,
|
|
11261
|
+
callback as BodyResponseCallback<unknown>
|
|
11262
|
+
);
|
|
11263
|
+
} else {
|
|
11264
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
11265
|
+
}
|
|
11266
|
+
}
|
|
11267
|
+
}
|
|
11268
|
+
|
|
11269
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris
|
|
11270
|
+
extends StandardParameters {
|
|
11271
|
+
/**
|
|
11272
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
11273
|
+
*/
|
|
11274
|
+
siteSearchEngine?: string;
|
|
11275
|
+
|
|
11276
|
+
/**
|
|
11277
|
+
* Request body metadata
|
|
11278
|
+
*/
|
|
11279
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
11280
|
+
}
|
|
11281
|
+
|
|
9974
11282
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
9975
11283
|
context: APIRequestContext;
|
|
9976
11284
|
constructor(context: APIRequestContext) {
|