@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/build/v1alpha.d.ts
CHANGED
|
@@ -68,6 +68,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
68
68
|
*/
|
|
69
69
|
export class Discoveryengine {
|
|
70
70
|
context: APIRequestContext;
|
|
71
|
+
locations: Resource$Locations;
|
|
71
72
|
projects: Resource$Projects;
|
|
72
73
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
73
74
|
}
|
|
@@ -193,13 +194,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
193
194
|
functionName?: string | null;
|
|
194
195
|
}
|
|
195
196
|
/**
|
|
196
|
-
*
|
|
197
|
+
* AdditionalParams message for WidgetService methods for security and privacy enhancement.
|
|
197
198
|
*/
|
|
198
|
-
export interface Schema$
|
|
199
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams {
|
|
199
200
|
/**
|
|
200
|
-
*
|
|
201
|
+
* Token that used for non-human user check.
|
|
201
202
|
*/
|
|
202
|
-
|
|
203
|
+
token?: string | null;
|
|
203
204
|
}
|
|
204
205
|
/**
|
|
205
206
|
* BigQuery source import data from.
|
|
@@ -230,6 +231,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
230
231
|
*/
|
|
231
232
|
tableId?: string | null;
|
|
232
233
|
}
|
|
234
|
+
/**
|
|
235
|
+
* Request message for CompletionService.CompleteQuery method.
|
|
236
|
+
*/
|
|
237
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
|
|
238
|
+
/**
|
|
239
|
+
* 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`.
|
|
240
|
+
*/
|
|
241
|
+
dataStore?: string | null;
|
|
242
|
+
/**
|
|
243
|
+
* 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.
|
|
244
|
+
*/
|
|
245
|
+
includeTailSuggestions?: boolean | null;
|
|
246
|
+
/**
|
|
247
|
+
* Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
|
|
248
|
+
*/
|
|
249
|
+
query?: string | null;
|
|
250
|
+
/**
|
|
251
|
+
* 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.
|
|
252
|
+
*/
|
|
253
|
+
queryModel?: string | null;
|
|
254
|
+
/**
|
|
255
|
+
* 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.
|
|
256
|
+
*/
|
|
257
|
+
userPseudoId?: string | null;
|
|
258
|
+
}
|
|
233
259
|
/**
|
|
234
260
|
* Response message for CompletionService.CompleteQuery method.
|
|
235
261
|
*/
|
|
@@ -250,7 +276,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
250
276
|
/**
|
|
251
277
|
* The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.
|
|
252
278
|
*/
|
|
253
|
-
|
|
279
|
+
completableFieldPaths?: string[] | null;
|
|
254
280
|
/**
|
|
255
281
|
* The suggestion for the query.
|
|
256
282
|
*/
|
|
@@ -336,6 +362,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
336
362
|
* The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
|
|
337
363
|
*/
|
|
338
364
|
conversation?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
|
|
365
|
+
/**
|
|
366
|
+
* 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.
|
|
367
|
+
*/
|
|
368
|
+
name?: string | null;
|
|
339
369
|
/**
|
|
340
370
|
* Required. Current user input.
|
|
341
371
|
*/
|
|
@@ -348,6 +378,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
348
378
|
* The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used.
|
|
349
379
|
*/
|
|
350
380
|
servingConfig?: string | null;
|
|
381
|
+
/**
|
|
382
|
+
* A specification for configuring the summary returned in the response.
|
|
383
|
+
*/
|
|
384
|
+
summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
351
385
|
/**
|
|
352
386
|
* The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
|
|
353
387
|
*/
|
|
@@ -778,6 +812,24 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
778
812
|
*/
|
|
779
813
|
schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
|
|
780
814
|
}
|
|
815
|
+
/**
|
|
816
|
+
* Request message for WidgetService.LookupWidgetConfig method.
|
|
817
|
+
*/
|
|
818
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest {
|
|
819
|
+
/**
|
|
820
|
+
* Required. The UUID of the Widget Config.
|
|
821
|
+
*/
|
|
822
|
+
widgetConfigId?: string | null;
|
|
823
|
+
}
|
|
824
|
+
/**
|
|
825
|
+
* Response message for WidgetService.LookupWidgetConfig method.
|
|
826
|
+
*/
|
|
827
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse {
|
|
828
|
+
/**
|
|
829
|
+
* The Anonymous Widget Config associated with the UUID.
|
|
830
|
+
*/
|
|
831
|
+
anonymousWidgetConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig;
|
|
832
|
+
}
|
|
781
833
|
/**
|
|
782
834
|
* Media-specific user event information.
|
|
783
835
|
*/
|
|
@@ -928,7 +980,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
928
980
|
*/
|
|
929
981
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest {
|
|
930
982
|
/**
|
|
931
|
-
* 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.
|
|
983
|
+
* 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.
|
|
932
984
|
*/
|
|
933
985
|
filter?: string | null;
|
|
934
986
|
/**
|
|
@@ -936,7 +988,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
936
988
|
*/
|
|
937
989
|
pageSize?: number | null;
|
|
938
990
|
/**
|
|
939
|
-
* 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.
|
|
991
|
+
* 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.
|
|
940
992
|
*/
|
|
941
993
|
params?: {
|
|
942
994
|
[key: string]: any;
|
|
@@ -996,6 +1048,87 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
996
1048
|
[key: string]: any;
|
|
997
1049
|
} | null;
|
|
998
1050
|
}
|
|
1051
|
+
/**
|
|
1052
|
+
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1053
|
+
*/
|
|
1054
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
1055
|
+
/**
|
|
1056
|
+
* Operation create time.
|
|
1057
|
+
*/
|
|
1058
|
+
createTime?: string | null;
|
|
1059
|
+
/**
|
|
1060
|
+
* 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.
|
|
1061
|
+
*/
|
|
1062
|
+
invalidUris?: string[] | null;
|
|
1063
|
+
/**
|
|
1064
|
+
* Total number of URIs that have yet to be crawled.
|
|
1065
|
+
*/
|
|
1066
|
+
pendingCount?: number | null;
|
|
1067
|
+
/**
|
|
1068
|
+
* Total number of URIs that were rejected due to insufficient indexing resources.
|
|
1069
|
+
*/
|
|
1070
|
+
quotaExceededCount?: number | null;
|
|
1071
|
+
/**
|
|
1072
|
+
* Total number of URIs that have been crawled so far.
|
|
1073
|
+
*/
|
|
1074
|
+
successCount?: number | null;
|
|
1075
|
+
/**
|
|
1076
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1077
|
+
*/
|
|
1078
|
+
updateTime?: string | null;
|
|
1079
|
+
/**
|
|
1080
|
+
* Total number of unique URIs in the request that are not in invalid_uris.
|
|
1081
|
+
*/
|
|
1082
|
+
validUrisCount?: number | null;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* Request message for SiteSearchEngineService.RecrawlUris method.
|
|
1086
|
+
*/
|
|
1087
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest {
|
|
1088
|
+
/**
|
|
1089
|
+
* 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`.
|
|
1090
|
+
*/
|
|
1091
|
+
uris?: string[] | null;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* Response message for SiteSearchEngineService.RecrawlUris method.
|
|
1095
|
+
*/
|
|
1096
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
|
|
1097
|
+
/**
|
|
1098
|
+
* URIs that were not crawled before the LRO terminated.
|
|
1099
|
+
*/
|
|
1100
|
+
failedUris?: string[] | null;
|
|
1101
|
+
/**
|
|
1102
|
+
* Details for a sample of up to 10 `failed_uris`.
|
|
1103
|
+
*/
|
|
1104
|
+
failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
|
|
1105
|
+
}
|
|
1106
|
+
/**
|
|
1107
|
+
* Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
|
|
1108
|
+
*/
|
|
1109
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
|
|
1110
|
+
/**
|
|
1111
|
+
* List of failure reasons by corpus type (e.g. desktop, mobile).
|
|
1112
|
+
*/
|
|
1113
|
+
failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
|
|
1114
|
+
/**
|
|
1115
|
+
* URI that failed to be crawled.
|
|
1116
|
+
*/
|
|
1117
|
+
uri?: string | null;
|
|
1118
|
+
}
|
|
1119
|
+
/**
|
|
1120
|
+
* Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.
|
|
1121
|
+
*/
|
|
1122
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
1123
|
+
/**
|
|
1124
|
+
* DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
|
|
1125
|
+
*/
|
|
1126
|
+
corpusType?: string | null;
|
|
1127
|
+
/**
|
|
1128
|
+
* Reason why the URI was not crawled.
|
|
1129
|
+
*/
|
|
1130
|
+
errorMessage?: string | null;
|
|
1131
|
+
}
|
|
999
1132
|
/**
|
|
1000
1133
|
* Defines a reply message to user.
|
|
1001
1134
|
*/
|
|
@@ -1079,7 +1212,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1079
1212
|
*/
|
|
1080
1213
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest {
|
|
1081
1214
|
/**
|
|
1082
|
-
* Boost specification to boost certain documents.
|
|
1215
|
+
* Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
1083
1216
|
*/
|
|
1084
1217
|
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
1085
1218
|
/**
|
|
@@ -1099,7 +1232,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1099
1232
|
*/
|
|
1100
1233
|
facetSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
1101
1234
|
/**
|
|
1102
|
-
* 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.
|
|
1235
|
+
* 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)
|
|
1103
1236
|
*/
|
|
1104
1237
|
filter?: string | null;
|
|
1105
1238
|
/**
|
|
@@ -1111,7 +1244,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1111
1244
|
*/
|
|
1112
1245
|
offset?: number | null;
|
|
1113
1246
|
/**
|
|
1114
|
-
* 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.
|
|
1247
|
+
* 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.
|
|
1115
1248
|
*/
|
|
1116
1249
|
orderBy?: string | null;
|
|
1117
1250
|
/**
|
|
@@ -1144,6 +1277,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1144
1277
|
* Whether to turn on safe search. This is only supported for website search.
|
|
1145
1278
|
*/
|
|
1146
1279
|
safeSearch?: boolean | null;
|
|
1280
|
+
/**
|
|
1281
|
+
* 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.
|
|
1282
|
+
*/
|
|
1283
|
+
servingConfig?: string | null;
|
|
1147
1284
|
/**
|
|
1148
1285
|
* The spell correction specification that specifies the mode under which spell correction takes effect.
|
|
1149
1286
|
*/
|
|
@@ -1215,9 +1352,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1215
1352
|
*/
|
|
1216
1353
|
maxExtractiveSegmentCount?: number | null;
|
|
1217
1354
|
/**
|
|
1218
|
-
*
|
|
1355
|
+
* Return at most `num_next_segments` segments after each selected segments.
|
|
1219
1356
|
*/
|
|
1220
|
-
|
|
1357
|
+
numNextSegments?: number | null;
|
|
1358
|
+
/**
|
|
1359
|
+
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
1360
|
+
*/
|
|
1361
|
+
numPreviousSegments?: number | null;
|
|
1221
1362
|
}
|
|
1222
1363
|
/**
|
|
1223
1364
|
* A specification for configuring snippets in a search response.
|
|
@@ -1253,7 +1394,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1253
1394
|
*/
|
|
1254
1395
|
includeCitations?: boolean | null;
|
|
1255
1396
|
/**
|
|
1256
|
-
* Language code for Summary. Use language tags defined by BCP47.
|
|
1397
|
+
* Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
1257
1398
|
*/
|
|
1258
1399
|
languageCode?: string | null;
|
|
1259
1400
|
/**
|
|
@@ -1388,6 +1529,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1388
1529
|
* Results of facets requested by user.
|
|
1389
1530
|
*/
|
|
1390
1531
|
facets?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[];
|
|
1532
|
+
geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[];
|
|
1391
1533
|
/**
|
|
1392
1534
|
* Guided search result.
|
|
1393
1535
|
*/
|
|
@@ -1451,6 +1593,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1451
1593
|
*/
|
|
1452
1594
|
value?: string | null;
|
|
1453
1595
|
}
|
|
1596
|
+
/**
|
|
1597
|
+
* Debug information specifically related to forward geocoding issues arising from Geolocation Search.
|
|
1598
|
+
*/
|
|
1599
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo {
|
|
1600
|
+
/**
|
|
1601
|
+
* The error produced.
|
|
1602
|
+
*/
|
|
1603
|
+
errorMessage?: string | null;
|
|
1604
|
+
/**
|
|
1605
|
+
* The address from which forward geocoding ingestion produced issues.
|
|
1606
|
+
*/
|
|
1607
|
+
originalAddressQuery?: string | null;
|
|
1608
|
+
}
|
|
1454
1609
|
/**
|
|
1455
1610
|
* Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.
|
|
1456
1611
|
*/
|
|
@@ -1513,6 +1668,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1513
1668
|
* Summary of the top N search result specified by the summary spec.
|
|
1514
1669
|
*/
|
|
1515
1670
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummary {
|
|
1671
|
+
/**
|
|
1672
|
+
* A collection of Safety Attribute categories and their associated confidence scores.
|
|
1673
|
+
*/
|
|
1674
|
+
safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes;
|
|
1516
1675
|
/**
|
|
1517
1676
|
* Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1518
1677
|
*/
|
|
@@ -1522,6 +1681,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1522
1681
|
*/
|
|
1523
1682
|
summaryText?: string | null;
|
|
1524
1683
|
}
|
|
1684
|
+
/**
|
|
1685
|
+
* Safety Attribute categories and their associated confidence scores.
|
|
1686
|
+
*/
|
|
1687
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
|
|
1688
|
+
/**
|
|
1689
|
+
* The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
|
|
1690
|
+
*/
|
|
1691
|
+
categories?: string[] | null;
|
|
1692
|
+
/**
|
|
1693
|
+
* The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
|
|
1694
|
+
*/
|
|
1695
|
+
scores?: number[] | null;
|
|
1696
|
+
}
|
|
1525
1697
|
/**
|
|
1526
1698
|
* Verification information for target sites in advanced site search.
|
|
1527
1699
|
*/
|
|
@@ -1586,10 +1758,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1586
1758
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
1587
1759
|
}
|
|
1588
1760
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
1589
|
-
/**
|
|
1590
|
-
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
1591
|
-
*/
|
|
1592
|
-
totalRequiredQuota?: string | null;
|
|
1593
1761
|
}
|
|
1594
1762
|
/**
|
|
1595
1763
|
* Defines text input.
|
|
@@ -1738,6 +1906,238 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1738
1906
|
*/
|
|
1739
1907
|
userId?: string | null;
|
|
1740
1908
|
}
|
|
1909
|
+
/**
|
|
1910
|
+
* Request message for WidgetService.WidgetCompleteQuery method.
|
|
1911
|
+
*/
|
|
1912
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest {
|
|
1913
|
+
/**
|
|
1914
|
+
* Additional params for security and privacy enhancement.
|
|
1915
|
+
*/
|
|
1916
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
1917
|
+
/**
|
|
1918
|
+
* Required. The CompleteQuery request to perform auto-complete suggestion query.
|
|
1919
|
+
*/
|
|
1920
|
+
completeQueryRequest?: Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest;
|
|
1921
|
+
/**
|
|
1922
|
+
* 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.
|
|
1923
|
+
*/
|
|
1924
|
+
configId?: string | null;
|
|
1925
|
+
}
|
|
1926
|
+
/**
|
|
1927
|
+
* Response message for WidgetService.WidgetCompleteQuery method.
|
|
1928
|
+
*/
|
|
1929
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse {
|
|
1930
|
+
/**
|
|
1931
|
+
* The token in response.
|
|
1932
|
+
*/
|
|
1933
|
+
uToken?: string | null;
|
|
1934
|
+
/**
|
|
1935
|
+
* Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion.
|
|
1936
|
+
*/
|
|
1937
|
+
widgetQuerySuggestions?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion[];
|
|
1938
|
+
}
|
|
1939
|
+
/**
|
|
1940
|
+
* Suggestions as search queries.
|
|
1941
|
+
*/
|
|
1942
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion {
|
|
1943
|
+
/**
|
|
1944
|
+
* The suggestion for the query.
|
|
1945
|
+
*/
|
|
1946
|
+
suggestion?: string | null;
|
|
1947
|
+
}
|
|
1948
|
+
/**
|
|
1949
|
+
* WidgetConfig captures configs at the Widget level.
|
|
1950
|
+
*/
|
|
1951
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig {
|
|
1952
|
+
/**
|
|
1953
|
+
* Allowlisted domains that can load this widget.
|
|
1954
|
+
*/
|
|
1955
|
+
allowlistedDomains?: string[] | null;
|
|
1956
|
+
/**
|
|
1957
|
+
* 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.
|
|
1958
|
+
*/
|
|
1959
|
+
allowPublicAccess?: boolean | null;
|
|
1960
|
+
/**
|
|
1961
|
+
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
1962
|
+
*/
|
|
1963
|
+
configId?: string | null;
|
|
1964
|
+
/**
|
|
1965
|
+
* The content search spec that configs the desired behavior of content search.
|
|
1966
|
+
*/
|
|
1967
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1968
|
+
/**
|
|
1969
|
+
* Output only. Timestamp the WidgetConfig was created.
|
|
1970
|
+
*/
|
|
1971
|
+
createTime?: string | null;
|
|
1972
|
+
/**
|
|
1973
|
+
* Output only. The type of the parent data store.
|
|
1974
|
+
*/
|
|
1975
|
+
dataStoreType?: string | null;
|
|
1976
|
+
/**
|
|
1977
|
+
* 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.
|
|
1978
|
+
*/
|
|
1979
|
+
displayName?: string | null;
|
|
1980
|
+
/**
|
|
1981
|
+
* Whether or not to enable autocomplete.
|
|
1982
|
+
*/
|
|
1983
|
+
enableAutocomplete?: boolean | null;
|
|
1984
|
+
/**
|
|
1985
|
+
* Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
|
|
1986
|
+
*/
|
|
1987
|
+
enableConversationalSearch?: boolean | null;
|
|
1988
|
+
/**
|
|
1989
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
1990
|
+
*/
|
|
1991
|
+
enableQualityFeedback?: boolean | null;
|
|
1992
|
+
/**
|
|
1993
|
+
* Whether to show the result score.
|
|
1994
|
+
*/
|
|
1995
|
+
enableResultScore?: boolean | null;
|
|
1996
|
+
/**
|
|
1997
|
+
* Whether to enable safe search.
|
|
1998
|
+
*/
|
|
1999
|
+
enableSafeSearch?: boolean | null;
|
|
2000
|
+
/**
|
|
2001
|
+
* Turn on or off summary for each snippets result.
|
|
2002
|
+
*/
|
|
2003
|
+
enableSnippetResultSummary?: boolean | null;
|
|
2004
|
+
/**
|
|
2005
|
+
* Turn on or off summarization for the search response.
|
|
2006
|
+
*/
|
|
2007
|
+
enableSummarization?: boolean | null;
|
|
2008
|
+
/**
|
|
2009
|
+
* The configuration and appearance of facets in the end user view.
|
|
2010
|
+
*/
|
|
2011
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
2012
|
+
/**
|
|
2013
|
+
* 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.
|
|
2014
|
+
*/
|
|
2015
|
+
fieldsUiComponentsMap?: {
|
|
2016
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
2017
|
+
} | null;
|
|
2018
|
+
/**
|
|
2019
|
+
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
2020
|
+
*/
|
|
2021
|
+
llmEnabled?: boolean | null;
|
|
2022
|
+
/**
|
|
2023
|
+
* Output only. Whether the customer accepted data use terms.
|
|
2024
|
+
*/
|
|
2025
|
+
minimumDataTermAccepted?: boolean | null;
|
|
2026
|
+
/**
|
|
2027
|
+
* 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.
|
|
2028
|
+
*/
|
|
2029
|
+
name?: string | null;
|
|
2030
|
+
/**
|
|
2031
|
+
* 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.
|
|
2032
|
+
*/
|
|
2033
|
+
resultDisplayType?: string | null;
|
|
2034
|
+
/**
|
|
2035
|
+
* Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
|
|
2036
|
+
*/
|
|
2037
|
+
solutionType?: string | null;
|
|
2038
|
+
/**
|
|
2039
|
+
* Output only. Timestamp the WidgetConfig was updated.
|
|
2040
|
+
*/
|
|
2041
|
+
updateTime?: string | null;
|
|
2042
|
+
}
|
|
2043
|
+
/**
|
|
2044
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
2045
|
+
*/
|
|
2046
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
|
|
2047
|
+
/**
|
|
2048
|
+
* Optional. The field name that end users will see.
|
|
2049
|
+
*/
|
|
2050
|
+
displayName?: string | null;
|
|
2051
|
+
/**
|
|
2052
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2053
|
+
*/
|
|
2054
|
+
field?: string | null;
|
|
2055
|
+
}
|
|
2056
|
+
/**
|
|
2057
|
+
* Facet field that maps to a UI Component.
|
|
2058
|
+
*/
|
|
2059
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
|
|
2060
|
+
/**
|
|
2061
|
+
* The field visibility on different types of devices.
|
|
2062
|
+
*/
|
|
2063
|
+
deviceVisibility?: string[] | null;
|
|
2064
|
+
/**
|
|
2065
|
+
* The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
|
|
2066
|
+
*/
|
|
2067
|
+
displayTemplate?: string | null;
|
|
2068
|
+
/**
|
|
2069
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
2070
|
+
*/
|
|
2071
|
+
field?: string | null;
|
|
2072
|
+
}
|
|
2073
|
+
/**
|
|
2074
|
+
* Request message for WidgetService.WidgetConverseConversation method.
|
|
2075
|
+
*/
|
|
2076
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest {
|
|
2077
|
+
/**
|
|
2078
|
+
* Additional params for security and privacy enhancement.
|
|
2079
|
+
*/
|
|
2080
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2081
|
+
/**
|
|
2082
|
+
* 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.
|
|
2083
|
+
*/
|
|
2084
|
+
configId?: string | null;
|
|
2085
|
+
/**
|
|
2086
|
+
* The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
|
|
2087
|
+
*/
|
|
2088
|
+
conversationId?: string | null;
|
|
2089
|
+
/**
|
|
2090
|
+
* Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default.
|
|
2091
|
+
*/
|
|
2092
|
+
converseConversationRequest?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
|
|
2093
|
+
}
|
|
2094
|
+
/**
|
|
2095
|
+
* Response message for WidgetService.WidgetConverseConversation method.
|
|
2096
|
+
*/
|
|
2097
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse {
|
|
2098
|
+
/**
|
|
2099
|
+
* The id of the Conversation returned.
|
|
2100
|
+
*/
|
|
2101
|
+
conversationId?: string | null;
|
|
2102
|
+
/**
|
|
2103
|
+
* ConverseConversationResponse returned from ConversationalSearchService.ConverseConversation.
|
|
2104
|
+
*/
|
|
2105
|
+
converseConversationResponse?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationResponse;
|
|
2106
|
+
/**
|
|
2107
|
+
* The token in response.
|
|
2108
|
+
*/
|
|
2109
|
+
uToken?: string | null;
|
|
2110
|
+
}
|
|
2111
|
+
/**
|
|
2112
|
+
* Request message for WidgetService.WidgetSearch method.
|
|
2113
|
+
*/
|
|
2114
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest {
|
|
2115
|
+
/**
|
|
2116
|
+
* Additional params for security and privacy enhancement.
|
|
2117
|
+
*/
|
|
2118
|
+
additionalParams?: Schema$GoogleCloudDiscoveryengineV1alphaAdditionalParams;
|
|
2119
|
+
/**
|
|
2120
|
+
* 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.
|
|
2121
|
+
*/
|
|
2122
|
+
configId?: string | null;
|
|
2123
|
+
/**
|
|
2124
|
+
* Required. The search request to perform search.
|
|
2125
|
+
*/
|
|
2126
|
+
searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
2127
|
+
}
|
|
2128
|
+
/**
|
|
2129
|
+
* Response message for WidgetService.WidgetSearch method.
|
|
2130
|
+
*/
|
|
2131
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse {
|
|
2132
|
+
/**
|
|
2133
|
+
* The search response after performing search.
|
|
2134
|
+
*/
|
|
2135
|
+
searchResponse?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse;
|
|
2136
|
+
/**
|
|
2137
|
+
* The token in response.
|
|
2138
|
+
*/
|
|
2139
|
+
uToken?: string | null;
|
|
2140
|
+
}
|
|
1741
2141
|
/**
|
|
1742
2142
|
* Metadata for Create Schema LRO.
|
|
1743
2143
|
*/
|
|
@@ -2175,6 +2575,106 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2175
2575
|
*/
|
|
2176
2576
|
year?: number | null;
|
|
2177
2577
|
}
|
|
2578
|
+
export class Resource$Locations {
|
|
2579
|
+
context: APIRequestContext;
|
|
2580
|
+
constructor(context: APIRequestContext);
|
|
2581
|
+
/**
|
|
2582
|
+
* Gets the Widget Config using the uuid.
|
|
2583
|
+
*
|
|
2584
|
+
* @param params - Parameters for request
|
|
2585
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2586
|
+
* @param callback - Optional callback that handles the response.
|
|
2587
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2588
|
+
*/
|
|
2589
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2590
|
+
lookupWidgetConfig(params?: Params$Resource$Locations$Lookupwidgetconfig, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
|
|
2591
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2592
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>): void;
|
|
2593
|
+
lookupWidgetConfig(params: Params$Resource$Locations$Lookupwidgetconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>): void;
|
|
2594
|
+
lookupWidgetConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>): void;
|
|
2595
|
+
/**
|
|
2596
|
+
* 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.
|
|
2597
|
+
*
|
|
2598
|
+
* @param params - Parameters for request
|
|
2599
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2600
|
+
* @param callback - Optional callback that handles the response.
|
|
2601
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2602
|
+
*/
|
|
2603
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2604
|
+
widgetCompleteQuery(params?: Params$Resource$Locations$Widgetcompletequery, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
|
|
2605
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2606
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>): void;
|
|
2607
|
+
widgetCompleteQuery(params: Params$Resource$Locations$Widgetcompletequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>): void;
|
|
2608
|
+
widgetCompleteQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>): void;
|
|
2609
|
+
/**
|
|
2610
|
+
* Converse a conversation with Widget.
|
|
2611
|
+
*
|
|
2612
|
+
* @param params - Parameters for request
|
|
2613
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2614
|
+
* @param callback - Optional callback that handles the response.
|
|
2615
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2616
|
+
*/
|
|
2617
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2618
|
+
widgetConverseConversation(params?: Params$Resource$Locations$Widgetconverseconversation, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
|
|
2619
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2620
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>): void;
|
|
2621
|
+
widgetConverseConversation(params: Params$Resource$Locations$Widgetconverseconversation, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>): void;
|
|
2622
|
+
widgetConverseConversation(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>): void;
|
|
2623
|
+
/**
|
|
2624
|
+
* 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.
|
|
2625
|
+
*
|
|
2626
|
+
* @param params - Parameters for request
|
|
2627
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2628
|
+
* @param callback - Optional callback that handles the response.
|
|
2629
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2630
|
+
*/
|
|
2631
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2632
|
+
widgetSearch(params?: Params$Resource$Locations$Widgetsearch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
|
|
2633
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2634
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>): void;
|
|
2635
|
+
widgetSearch(params: Params$Resource$Locations$Widgetsearch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>): void;
|
|
2636
|
+
widgetSearch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>): void;
|
|
2637
|
+
}
|
|
2638
|
+
export interface Params$Resource$Locations$Lookupwidgetconfig extends StandardParameters {
|
|
2639
|
+
/**
|
|
2640
|
+
* Required. The location resource where lookup widget will be performed. Format: `locations/{location\}`
|
|
2641
|
+
*/
|
|
2642
|
+
location?: string;
|
|
2643
|
+
/**
|
|
2644
|
+
* Request body metadata
|
|
2645
|
+
*/
|
|
2646
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest;
|
|
2647
|
+
}
|
|
2648
|
+
export interface Params$Resource$Locations$Widgetcompletequery extends StandardParameters {
|
|
2649
|
+
/**
|
|
2650
|
+
* Required. The location resource where widget complete query will be performed. Format: `locations/{location\}`
|
|
2651
|
+
*/
|
|
2652
|
+
location?: string;
|
|
2653
|
+
/**
|
|
2654
|
+
* Request body metadata
|
|
2655
|
+
*/
|
|
2656
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
|
|
2657
|
+
}
|
|
2658
|
+
export interface Params$Resource$Locations$Widgetconverseconversation extends StandardParameters {
|
|
2659
|
+
/**
|
|
2660
|
+
* Required. The location resource where widget converse conversation will be performed. Format: `locations/{location\}`
|
|
2661
|
+
*/
|
|
2662
|
+
location?: string;
|
|
2663
|
+
/**
|
|
2664
|
+
* Request body metadata
|
|
2665
|
+
*/
|
|
2666
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
|
|
2667
|
+
}
|
|
2668
|
+
export interface Params$Resource$Locations$Widgetsearch extends StandardParameters {
|
|
2669
|
+
/**
|
|
2670
|
+
* Required. The location resource where widget search will be performed. Format: `locations/{location\}`
|
|
2671
|
+
*/
|
|
2672
|
+
location?: string;
|
|
2673
|
+
/**
|
|
2674
|
+
* Request body metadata
|
|
2675
|
+
*/
|
|
2676
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
|
|
2677
|
+
}
|
|
2178
2678
|
export class Resource$Projects {
|
|
2179
2679
|
context: APIRequestContext;
|
|
2180
2680
|
locations: Resource$Projects$Locations;
|
|
@@ -2235,7 +2735,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2235
2735
|
*/
|
|
2236
2736
|
query?: string;
|
|
2237
2737
|
/**
|
|
2238
|
-
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for
|
|
2738
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
2239
2739
|
*/
|
|
2240
2740
|
queryModel?: string;
|
|
2241
2741
|
/**
|
|
@@ -2996,6 +3496,30 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2996
3496
|
operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
|
|
2997
3497
|
targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
|
|
2998
3498
|
constructor(context: APIRequestContext);
|
|
3499
|
+
/**
|
|
3500
|
+
* Request on-demand recrawl for a list of URIs.
|
|
3501
|
+
*
|
|
3502
|
+
* @param params - Parameters for request
|
|
3503
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3504
|
+
* @param callback - Optional callback that handles the response.
|
|
3505
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3506
|
+
*/
|
|
3507
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3508
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
3509
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3510
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3511
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3512
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3513
|
+
}
|
|
3514
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
3515
|
+
/**
|
|
3516
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
3517
|
+
*/
|
|
3518
|
+
siteSearchEngine?: string;
|
|
3519
|
+
/**
|
|
3520
|
+
* Request body metadata
|
|
3521
|
+
*/
|
|
3522
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
2999
3523
|
}
|
|
3000
3524
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations {
|
|
3001
3525
|
context: APIRequestContext;
|
|
@@ -3225,6 +3749,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3225
3749
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
3226
3750
|
context: APIRequestContext;
|
|
3227
3751
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
3752
|
+
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
3228
3753
|
constructor(context: APIRequestContext);
|
|
3229
3754
|
}
|
|
3230
3755
|
export class Resource$Projects$Locations$Collections$Engines$Operations {
|
|
@@ -3283,6 +3808,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3283
3808
|
*/
|
|
3284
3809
|
pageToken?: string;
|
|
3285
3810
|
}
|
|
3811
|
+
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
3812
|
+
context: APIRequestContext;
|
|
3813
|
+
constructor(context: APIRequestContext);
|
|
3814
|
+
/**
|
|
3815
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
3816
|
+
*
|
|
3817
|
+
* @param params - Parameters for request
|
|
3818
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3819
|
+
* @param callback - Optional callback that handles the response.
|
|
3820
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3821
|
+
*/
|
|
3822
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3823
|
+
recommend(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
3824
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3825
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
3826
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
3827
|
+
recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
3828
|
+
/**
|
|
3829
|
+
* Performs a search.
|
|
3830
|
+
*
|
|
3831
|
+
* @param params - Parameters for request
|
|
3832
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3833
|
+
* @param callback - Optional callback that handles the response.
|
|
3834
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3835
|
+
*/
|
|
3836
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3837
|
+
search(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
3838
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3839
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
3840
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
3841
|
+
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
3842
|
+
}
|
|
3843
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
3844
|
+
/**
|
|
3845
|
+
* 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.
|
|
3846
|
+
*/
|
|
3847
|
+
servingConfig?: string;
|
|
3848
|
+
/**
|
|
3849
|
+
* Request body metadata
|
|
3850
|
+
*/
|
|
3851
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
|
|
3852
|
+
}
|
|
3853
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
|
|
3854
|
+
/**
|
|
3855
|
+
* 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.
|
|
3856
|
+
*/
|
|
3857
|
+
servingConfig?: string;
|
|
3858
|
+
/**
|
|
3859
|
+
* Request body metadata
|
|
3860
|
+
*/
|
|
3861
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
3862
|
+
}
|
|
3286
3863
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
3287
3864
|
context: APIRequestContext;
|
|
3288
3865
|
constructor(context: APIRequestContext);
|
|
@@ -3347,6 +3924,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3347
3924
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
3348
3925
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
3349
3926
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
3927
|
+
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
3350
3928
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
3351
3929
|
constructor(context: APIRequestContext);
|
|
3352
3930
|
/**
|
|
@@ -3378,7 +3956,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3378
3956
|
*/
|
|
3379
3957
|
query?: string;
|
|
3380
3958
|
/**
|
|
3381
|
-
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for
|
|
3959
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
3382
3960
|
*/
|
|
3383
3961
|
queryModel?: string;
|
|
3384
3962
|
/**
|
|
@@ -4077,6 +4655,34 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4077
4655
|
*/
|
|
4078
4656
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
4079
4657
|
}
|
|
4658
|
+
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
4659
|
+
context: APIRequestContext;
|
|
4660
|
+
constructor(context: APIRequestContext);
|
|
4661
|
+
/**
|
|
4662
|
+
* Request on-demand recrawl for a list of URIs.
|
|
4663
|
+
*
|
|
4664
|
+
* @param params - Parameters for request
|
|
4665
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4666
|
+
* @param callback - Optional callback that handles the response.
|
|
4667
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4668
|
+
*/
|
|
4669
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4670
|
+
recrawlUris(params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4671
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4672
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4673
|
+
recrawlUris(params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4674
|
+
recrawlUris(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4675
|
+
}
|
|
4676
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters {
|
|
4677
|
+
/**
|
|
4678
|
+
* Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`.
|
|
4679
|
+
*/
|
|
4680
|
+
siteSearchEngine?: string;
|
|
4681
|
+
/**
|
|
4682
|
+
* Request body metadata
|
|
4683
|
+
*/
|
|
4684
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
|
|
4685
|
+
}
|
|
4080
4686
|
export class Resource$Projects$Locations$Datastores$Userevents {
|
|
4081
4687
|
context: APIRequestContext;
|
|
4082
4688
|
constructor(context: APIRequestContext);
|