@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241122 → 0.0.20241204
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/index.d.ts +554 -4
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241204
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -196,6 +196,10 @@ declare namespace gapi.client {
|
|
|
196
196
|
completeTime?: string;
|
|
197
197
|
/** Output only. Answer creation timestamp. */
|
|
198
198
|
createTime?: string;
|
|
199
|
+
/** A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. */
|
|
200
|
+
groundingScore?: number;
|
|
201
|
+
/** Optional. Grounding supports. */
|
|
202
|
+
groundingSupports?: GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport[];
|
|
199
203
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
200
204
|
name?: string;
|
|
201
205
|
/** Query understanding information. */
|
|
@@ -221,6 +225,18 @@ declare namespace gapi.client {
|
|
|
221
225
|
/** ID of the citation source. */
|
|
222
226
|
referenceId?: string;
|
|
223
227
|
}
|
|
228
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport {
|
|
229
|
+
/** Required. End of the claim, exclusive. */
|
|
230
|
+
endIndex?: string;
|
|
231
|
+
/** Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. */
|
|
232
|
+
groundingCheckRequired?: boolean;
|
|
233
|
+
/** A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. */
|
|
234
|
+
groundingScore?: number;
|
|
235
|
+
/** Optional. Citation sources for the claim. */
|
|
236
|
+
sources?: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
237
|
+
/** Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). */
|
|
238
|
+
startIndex?: string;
|
|
239
|
+
}
|
|
224
240
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
|
|
225
241
|
/** Query classification information. */
|
|
226
242
|
queryClassificationInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
@@ -396,6 +412,8 @@ declare namespace gapi.client {
|
|
|
396
412
|
filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
|
|
397
413
|
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
398
414
|
name?: string;
|
|
415
|
+
/** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
|
|
416
|
+
promoteAction?: GoogleCloudDiscoveryengineV1alphaControlPromoteAction;
|
|
399
417
|
/** Defines a redirect-type control. */
|
|
400
418
|
redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
|
|
401
419
|
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
@@ -419,6 +437,12 @@ declare namespace gapi.client {
|
|
|
419
437
|
/** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
420
438
|
filter?: string;
|
|
421
439
|
}
|
|
440
|
+
interface GoogleCloudDiscoveryengineV1alphaControlPromoteAction {
|
|
441
|
+
/** Required. Data store with which this promotion is attached to. */
|
|
442
|
+
dataStore?: string;
|
|
443
|
+
/** Required. Promotion attached to this action. */
|
|
444
|
+
searchLinkPromotion?: GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion;
|
|
445
|
+
}
|
|
422
446
|
interface GoogleCloudDiscoveryengineV1alphaControlRedirectAction {
|
|
423
447
|
/** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
424
448
|
redirectUri?: string;
|
|
@@ -566,6 +590,10 @@ declare namespace gapi.client {
|
|
|
566
590
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
567
591
|
updateTime?: string;
|
|
568
592
|
}
|
|
593
|
+
interface GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest {
|
|
594
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
595
|
+
name?: string;
|
|
596
|
+
}
|
|
569
597
|
interface GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata {
|
|
570
598
|
/** Operation create time. */
|
|
571
599
|
createTime?: string;
|
|
@@ -791,6 +819,10 @@ declare namespace gapi.client {
|
|
|
791
819
|
/** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
792
820
|
searchableOption?: string;
|
|
793
821
|
}
|
|
822
|
+
interface GoogleCloudDiscoveryengineV1alphaGetSessionRequest {
|
|
823
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
824
|
+
name?: string;
|
|
825
|
+
}
|
|
794
826
|
interface GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse {
|
|
795
827
|
/** Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
|
|
796
828
|
documentDataMap?: {[P in string]: {[P in string]: any}};
|
|
@@ -919,6 +951,24 @@ declare namespace gapi.client {
|
|
|
919
951
|
/** List of custom tuning models. */
|
|
920
952
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
921
953
|
}
|
|
954
|
+
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
955
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
956
|
+
filter?: string;
|
|
957
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */
|
|
958
|
+
orderBy?: string;
|
|
959
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
960
|
+
pageSize?: number;
|
|
961
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
962
|
+
pageToken?: string;
|
|
963
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
964
|
+
parent?: string;
|
|
965
|
+
}
|
|
966
|
+
interface GoogleCloudDiscoveryengineV1alphaListSessionsResponse {
|
|
967
|
+
/** Pagination token, if not returned indicates the last page. */
|
|
968
|
+
nextPageToken?: string;
|
|
969
|
+
/** All the Sessions for a given data store. */
|
|
970
|
+
sessions?: GoogleCloudDiscoveryengineV1alphaSession[];
|
|
971
|
+
}
|
|
922
972
|
interface GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig {
|
|
923
973
|
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
924
974
|
mode?: string;
|
|
@@ -1098,6 +1148,18 @@ declare namespace gapi.client {
|
|
|
1098
1148
|
/** The structured representation of the schema. */
|
|
1099
1149
|
structSchema?: {[P in string]: any};
|
|
1100
1150
|
}
|
|
1151
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion {
|
|
1152
|
+
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
1153
|
+
description?: string;
|
|
1154
|
+
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
1155
|
+
enabled?: boolean;
|
|
1156
|
+
/** Optional. The promotion thumbnail image url. */
|
|
1157
|
+
imageUri?: string;
|
|
1158
|
+
/** Required. The title of the promotion. Maximum length: 160 characters. */
|
|
1159
|
+
title?: string;
|
|
1160
|
+
/** Required. The URL for the page the user wants to promote. */
|
|
1161
|
+
uri?: string;
|
|
1162
|
+
}
|
|
1101
1163
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequest {
|
|
1102
1164
|
/** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
1103
1165
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
@@ -1263,6 +1325,8 @@ declare namespace gapi.client {
|
|
|
1263
1325
|
version?: string;
|
|
1264
1326
|
}
|
|
1265
1327
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
1328
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
1329
|
+
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
1266
1330
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
1267
1331
|
dataStore?: string;
|
|
1268
1332
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -1446,6 +1510,12 @@ declare namespace gapi.client {
|
|
|
1446
1510
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1447
1511
|
updateTime?: string;
|
|
1448
1512
|
}
|
|
1513
|
+
interface GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest {
|
|
1514
|
+
/** Required. The Session to update. */
|
|
1515
|
+
session?: GoogleCloudDiscoveryengineV1alphaSession;
|
|
1516
|
+
/** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
|
|
1517
|
+
updateMask?: string;
|
|
1518
|
+
}
|
|
1449
1519
|
interface GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata {
|
|
1450
1520
|
/** Operation create time. */
|
|
1451
1521
|
createTime?: string;
|
|
@@ -1479,6 +1549,10 @@ declare namespace gapi.client {
|
|
|
1479
1549
|
completeTime?: string;
|
|
1480
1550
|
/** Output only. Answer creation timestamp. */
|
|
1481
1551
|
createTime?: string;
|
|
1552
|
+
/** A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. */
|
|
1553
|
+
groundingScore?: number;
|
|
1554
|
+
/** Optional. Grounding supports. */
|
|
1555
|
+
groundingSupports?: GoogleCloudDiscoveryengineV1AnswerGroundingSupport[];
|
|
1482
1556
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
1483
1557
|
name?: string;
|
|
1484
1558
|
/** Query understanding information. */
|
|
@@ -1504,6 +1578,18 @@ declare namespace gapi.client {
|
|
|
1504
1578
|
/** ID of the citation source. */
|
|
1505
1579
|
referenceId?: string;
|
|
1506
1580
|
}
|
|
1581
|
+
interface GoogleCloudDiscoveryengineV1AnswerGroundingSupport {
|
|
1582
|
+
/** Required. End of the claim, exclusive. */
|
|
1583
|
+
endIndex?: string;
|
|
1584
|
+
/** Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. */
|
|
1585
|
+
groundingCheckRequired?: boolean;
|
|
1586
|
+
/** A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. */
|
|
1587
|
+
groundingScore?: number;
|
|
1588
|
+
/** Optional. Citation sources for the claim. */
|
|
1589
|
+
sources?: GoogleCloudDiscoveryengineV1AnswerCitationSource[];
|
|
1590
|
+
/** Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). */
|
|
1591
|
+
startIndex?: string;
|
|
1592
|
+
}
|
|
1507
1593
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequest {
|
|
1508
1594
|
/** Answer generation specification. */
|
|
1509
1595
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec;
|
|
@@ -1879,6 +1965,8 @@ declare namespace gapi.client {
|
|
|
1879
1965
|
filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
|
|
1880
1966
|
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
1881
1967
|
name?: string;
|
|
1968
|
+
/** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
|
|
1969
|
+
promoteAction?: GoogleCloudDiscoveryengineV1betaControlPromoteAction;
|
|
1882
1970
|
/** Defines a redirect-type control. */
|
|
1883
1971
|
redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
|
|
1884
1972
|
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
@@ -1902,6 +1990,12 @@ declare namespace gapi.client {
|
|
|
1902
1990
|
/** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1903
1991
|
filter?: string;
|
|
1904
1992
|
}
|
|
1993
|
+
interface GoogleCloudDiscoveryengineV1betaControlPromoteAction {
|
|
1994
|
+
/** Required. Data store with which this promotion is attached to. */
|
|
1995
|
+
dataStore?: string;
|
|
1996
|
+
/** Required. Promotion attached to this action. */
|
|
1997
|
+
searchLinkPromotion?: GoogleCloudDiscoveryengineV1betaSearchLinkPromotion;
|
|
1998
|
+
}
|
|
1905
1999
|
interface GoogleCloudDiscoveryengineV1betaControlRedirectAction {
|
|
1906
2000
|
/** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
1907
2001
|
redirectUri?: string;
|
|
@@ -2390,6 +2484,18 @@ declare namespace gapi.client {
|
|
|
2390
2484
|
/** The structured representation of the schema. */
|
|
2391
2485
|
structSchema?: {[P in string]: any};
|
|
2392
2486
|
}
|
|
2487
|
+
interface GoogleCloudDiscoveryengineV1betaSearchLinkPromotion {
|
|
2488
|
+
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
2489
|
+
description?: string;
|
|
2490
|
+
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
2491
|
+
enabled?: boolean;
|
|
2492
|
+
/** Optional. The promotion thumbnail image url. */
|
|
2493
|
+
imageUri?: string;
|
|
2494
|
+
/** Required. The title of the promotion. Maximum length: 160 characters. */
|
|
2495
|
+
title?: string;
|
|
2496
|
+
/** Required. The URL for the page the user wants to promote. */
|
|
2497
|
+
uri?: string;
|
|
2498
|
+
}
|
|
2393
2499
|
interface GoogleCloudDiscoveryengineV1betaSearchRequest {
|
|
2394
2500
|
/** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
2395
2501
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
@@ -2553,6 +2659,8 @@ declare namespace gapi.client {
|
|
|
2553
2659
|
version?: string;
|
|
2554
2660
|
}
|
|
2555
2661
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
2662
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
2663
|
+
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
2556
2664
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
2557
2665
|
dataStore?: string;
|
|
2558
2666
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -2948,6 +3056,8 @@ declare namespace gapi.client {
|
|
|
2948
3056
|
filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
|
|
2949
3057
|
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
2950
3058
|
name?: string;
|
|
3059
|
+
/** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
|
|
3060
|
+
promoteAction?: GoogleCloudDiscoveryengineV1ControlPromoteAction;
|
|
2951
3061
|
/** Defines a redirect-type control. */
|
|
2952
3062
|
redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
|
|
2953
3063
|
/** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
@@ -2971,6 +3081,12 @@ declare namespace gapi.client {
|
|
|
2971
3081
|
/** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
2972
3082
|
filter?: string;
|
|
2973
3083
|
}
|
|
3084
|
+
interface GoogleCloudDiscoveryengineV1ControlPromoteAction {
|
|
3085
|
+
/** Required. Data store with which this promotion is attached to. */
|
|
3086
|
+
dataStore?: string;
|
|
3087
|
+
/** Required. Promotion attached to this action. */
|
|
3088
|
+
searchLinkPromotion?: GoogleCloudDiscoveryengineV1SearchLinkPromotion;
|
|
3089
|
+
}
|
|
2974
3090
|
interface GoogleCloudDiscoveryengineV1ControlRedirectAction {
|
|
2975
3091
|
/** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
2976
3092
|
redirectUri?: string;
|
|
@@ -3348,6 +3464,8 @@ declare namespace gapi.client {
|
|
|
3348
3464
|
gcsStagingDir?: string;
|
|
3349
3465
|
/** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
|
|
3350
3466
|
resourceTypes?: string[];
|
|
3467
|
+
/** Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import. */
|
|
3468
|
+
updateFromLatestPredefinedSchema?: boolean;
|
|
3351
3469
|
}
|
|
3352
3470
|
interface GoogleCloudDiscoveryengineV1FirestoreSource {
|
|
3353
3471
|
/** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
|
|
@@ -3800,6 +3918,18 @@ declare namespace gapi.client {
|
|
|
3800
3918
|
/** The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
3801
3919
|
searchQuery?: string;
|
|
3802
3920
|
}
|
|
3921
|
+
interface GoogleCloudDiscoveryengineV1SearchLinkPromotion {
|
|
3922
|
+
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
3923
|
+
description?: string;
|
|
3924
|
+
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
3925
|
+
enabled?: boolean;
|
|
3926
|
+
/** Optional. The promotion thumbnail image url. */
|
|
3927
|
+
imageUri?: string;
|
|
3928
|
+
/** Required. The title of the promotion. Maximum length: 160 characters. */
|
|
3929
|
+
title?: string;
|
|
3930
|
+
/** Required. The URL for the page the user wants to promote. */
|
|
3931
|
+
uri?: string;
|
|
3932
|
+
}
|
|
3803
3933
|
interface GoogleCloudDiscoveryengineV1SearchRequest {
|
|
3804
3934
|
/** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
3805
3935
|
boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
|
|
@@ -3949,6 +4079,8 @@ declare namespace gapi.client {
|
|
|
3949
4079
|
version?: string;
|
|
3950
4080
|
}
|
|
3951
4081
|
interface GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec {
|
|
4082
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
4083
|
+
boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
|
|
3952
4084
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
3953
4085
|
dataStore?: string;
|
|
3954
4086
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -4019,6 +4151,8 @@ declare namespace gapi.client {
|
|
|
4019
4151
|
redirectUri?: string;
|
|
4020
4152
|
/** A list of matched documents. The order represents the ranking. */
|
|
4021
4153
|
results?: GoogleCloudDiscoveryengineV1SearchResponseSearchResult[];
|
|
4154
|
+
/** Promotions for site search. */
|
|
4155
|
+
searchLinkPromotions?: GoogleCloudDiscoveryengineV1SearchLinkPromotion[];
|
|
4022
4156
|
/** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
|
|
4023
4157
|
sessionInfo?: GoogleCloudDiscoveryengineV1SearchResponseSessionInfo;
|
|
4024
4158
|
/** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
|
|
@@ -4118,6 +4252,62 @@ declare namespace gapi.client {
|
|
|
4118
4252
|
/** Summary text with no citation information. */
|
|
4119
4253
|
summary?: string;
|
|
4120
4254
|
}
|
|
4255
|
+
interface GoogleCloudDiscoveryengineV1ServingConfig {
|
|
4256
|
+
/** Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. */
|
|
4257
|
+
boostControlIds?: string[];
|
|
4258
|
+
/** Output only. ServingConfig created timestamp. */
|
|
4259
|
+
createTime?: string;
|
|
4260
|
+
/** Required. The human readable serving 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. */
|
|
4261
|
+
displayName?: string;
|
|
4262
|
+
/** Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4263
|
+
dissociateControlIds?: string[];
|
|
4264
|
+
/** How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
4265
|
+
diversityLevel?: string;
|
|
4266
|
+
/** Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. */
|
|
4267
|
+
filterControlIds?: string[];
|
|
4268
|
+
/** The GenericConfig of the serving configuration. */
|
|
4269
|
+
genericConfig?: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig;
|
|
4270
|
+
/** Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. */
|
|
4271
|
+
ignoreControlIds?: string[];
|
|
4272
|
+
/** The MediaConfig of the serving configuration. */
|
|
4273
|
+
mediaConfig?: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig;
|
|
4274
|
+
/** The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
4275
|
+
modelId?: string;
|
|
4276
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
4277
|
+
name?: string;
|
|
4278
|
+
/** Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4279
|
+
onewaySynonymsControlIds?: string[];
|
|
4280
|
+
/** Condition promote specifications. Maximum number of specifications is 100. */
|
|
4281
|
+
promoteControlIds?: string[];
|
|
4282
|
+
/** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */
|
|
4283
|
+
rankingExpression?: string;
|
|
4284
|
+
/** IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4285
|
+
redirectControlIds?: string[];
|
|
4286
|
+
/** Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4287
|
+
replacementControlIds?: string[];
|
|
4288
|
+
/** Required. Immutable. Specifies the solution type that a serving config can be associated with. */
|
|
4289
|
+
solutionType?: string;
|
|
4290
|
+
/** Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4291
|
+
synonymsControlIds?: string[];
|
|
4292
|
+
/** Output only. ServingConfig updated timestamp. */
|
|
4293
|
+
updateTime?: string;
|
|
4294
|
+
}
|
|
4295
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigGenericConfig {
|
|
4296
|
+
/** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
|
|
4297
|
+
contentSearchSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
4298
|
+
}
|
|
4299
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigMediaConfig {
|
|
4300
|
+
/** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
|
|
4301
|
+
contentFreshnessCutoffDays?: number;
|
|
4302
|
+
/** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
|
|
4303
|
+
contentWatchedPercentageThreshold?: number;
|
|
4304
|
+
/** Specifies the content watched minutes threshold for demotion. */
|
|
4305
|
+
contentWatchedSecondsThreshold?: number;
|
|
4306
|
+
/** Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. */
|
|
4307
|
+
demoteContentWatchedPastDays?: number;
|
|
4308
|
+
/** Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */
|
|
4309
|
+
demotionEventType?: string;
|
|
4310
|
+
}
|
|
4121
4311
|
interface GoogleCloudDiscoveryengineV1Session {
|
|
4122
4312
|
/** Output only. The time the session finished. */
|
|
4123
4313
|
endTime?: string;
|
|
@@ -6054,6 +6244,68 @@ declare namespace gapi.client {
|
|
|
6054
6244
|
},
|
|
6055
6245
|
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
6056
6246
|
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
6247
|
+
/** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
6248
|
+
patch(request: {
|
|
6249
|
+
/** V1 error format. */
|
|
6250
|
+
'$.xgafv'?: string;
|
|
6251
|
+
/** OAuth access token. */
|
|
6252
|
+
access_token?: string;
|
|
6253
|
+
/** Data format for response. */
|
|
6254
|
+
alt?: string;
|
|
6255
|
+
/** JSONP */
|
|
6256
|
+
callback?: string;
|
|
6257
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6258
|
+
fields?: string;
|
|
6259
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6260
|
+
key?: string;
|
|
6261
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6262
|
+
name: string;
|
|
6263
|
+
/** OAuth 2.0 token for the current user. */
|
|
6264
|
+
oauth_token?: string;
|
|
6265
|
+
/** Returns response with indentations and line breaks. */
|
|
6266
|
+
prettyPrint?: boolean;
|
|
6267
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6268
|
+
quotaUser?: string;
|
|
6269
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
6270
|
+
updateMask?: string;
|
|
6271
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6272
|
+
upload_protocol?: string;
|
|
6273
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6274
|
+
uploadType?: string;
|
|
6275
|
+
/** Request body */
|
|
6276
|
+
resource: GoogleCloudDiscoveryengineV1ServingConfig;
|
|
6277
|
+
}): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
6278
|
+
patch(
|
|
6279
|
+
request: {
|
|
6280
|
+
/** V1 error format. */
|
|
6281
|
+
'$.xgafv'?: string;
|
|
6282
|
+
/** OAuth access token. */
|
|
6283
|
+
access_token?: string;
|
|
6284
|
+
/** Data format for response. */
|
|
6285
|
+
alt?: string;
|
|
6286
|
+
/** JSONP */
|
|
6287
|
+
callback?: string;
|
|
6288
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6289
|
+
fields?: string;
|
|
6290
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6291
|
+
key?: string;
|
|
6292
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6293
|
+
name: string;
|
|
6294
|
+
/** OAuth 2.0 token for the current user. */
|
|
6295
|
+
oauth_token?: string;
|
|
6296
|
+
/** Returns response with indentations and line breaks. */
|
|
6297
|
+
prettyPrint?: boolean;
|
|
6298
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6299
|
+
quotaUser?: string;
|
|
6300
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
6301
|
+
updateMask?: string;
|
|
6302
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6303
|
+
upload_protocol?: string;
|
|
6304
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6305
|
+
uploadType?: string;
|
|
6306
|
+
},
|
|
6307
|
+
body: GoogleCloudDiscoveryengineV1ServingConfig
|
|
6308
|
+
): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
6057
6309
|
/** Makes a recommendation, which requires a contextual user event. */
|
|
6058
6310
|
recommend(request: {
|
|
6059
6311
|
/** V1 error format. */
|
|
@@ -6228,6 +6480,64 @@ declare namespace gapi.client {
|
|
|
6228
6480
|
},
|
|
6229
6481
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
6230
6482
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
6483
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
6484
|
+
streamAnswer(request: {
|
|
6485
|
+
/** V1 error format. */
|
|
6486
|
+
'$.xgafv'?: string;
|
|
6487
|
+
/** OAuth access token. */
|
|
6488
|
+
access_token?: string;
|
|
6489
|
+
/** Data format for response. */
|
|
6490
|
+
alt?: string;
|
|
6491
|
+
/** JSONP */
|
|
6492
|
+
callback?: string;
|
|
6493
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6494
|
+
fields?: string;
|
|
6495
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6496
|
+
key?: string;
|
|
6497
|
+
/** OAuth 2.0 token for the current user. */
|
|
6498
|
+
oauth_token?: string;
|
|
6499
|
+
/** Returns response with indentations and line breaks. */
|
|
6500
|
+
prettyPrint?: boolean;
|
|
6501
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6502
|
+
quotaUser?: string;
|
|
6503
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6504
|
+
servingConfig: string;
|
|
6505
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6506
|
+
upload_protocol?: string;
|
|
6507
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6508
|
+
uploadType?: string;
|
|
6509
|
+
/** Request body */
|
|
6510
|
+
resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
6511
|
+
}): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
6512
|
+
streamAnswer(
|
|
6513
|
+
request: {
|
|
6514
|
+
/** V1 error format. */
|
|
6515
|
+
'$.xgafv'?: string;
|
|
6516
|
+
/** OAuth access token. */
|
|
6517
|
+
access_token?: string;
|
|
6518
|
+
/** Data format for response. */
|
|
6519
|
+
alt?: string;
|
|
6520
|
+
/** JSONP */
|
|
6521
|
+
callback?: string;
|
|
6522
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6523
|
+
fields?: string;
|
|
6524
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6525
|
+
key?: string;
|
|
6526
|
+
/** OAuth 2.0 token for the current user. */
|
|
6527
|
+
oauth_token?: string;
|
|
6528
|
+
/** Returns response with indentations and line breaks. */
|
|
6529
|
+
prettyPrint?: boolean;
|
|
6530
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6531
|
+
quotaUser?: string;
|
|
6532
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6533
|
+
servingConfig: string;
|
|
6534
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6535
|
+
upload_protocol?: string;
|
|
6536
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6537
|
+
uploadType?: string;
|
|
6538
|
+
},
|
|
6539
|
+
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
6540
|
+
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
6231
6541
|
}
|
|
6232
6542
|
interface AnswersResource {
|
|
6233
6543
|
/** Gets a Answer. */
|
|
@@ -7260,7 +7570,7 @@ declare namespace gapi.client {
|
|
|
7260
7570
|
key?: string;
|
|
7261
7571
|
/** OAuth 2.0 token for the current user. */
|
|
7262
7572
|
oauth_token?: string;
|
|
7263
|
-
/** Required. The parent
|
|
7573
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
7264
7574
|
parent: string;
|
|
7265
7575
|
/** Returns response with indentations and line breaks. */
|
|
7266
7576
|
prettyPrint?: boolean;
|
|
@@ -8419,6 +8729,68 @@ declare namespace gapi.client {
|
|
|
8419
8729
|
},
|
|
8420
8730
|
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
8421
8731
|
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
8732
|
+
/** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
8733
|
+
patch(request: {
|
|
8734
|
+
/** V1 error format. */
|
|
8735
|
+
'$.xgafv'?: string;
|
|
8736
|
+
/** OAuth access token. */
|
|
8737
|
+
access_token?: string;
|
|
8738
|
+
/** Data format for response. */
|
|
8739
|
+
alt?: string;
|
|
8740
|
+
/** JSONP */
|
|
8741
|
+
callback?: string;
|
|
8742
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8743
|
+
fields?: string;
|
|
8744
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
8745
|
+
key?: string;
|
|
8746
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
8747
|
+
name: string;
|
|
8748
|
+
/** OAuth 2.0 token for the current user. */
|
|
8749
|
+
oauth_token?: string;
|
|
8750
|
+
/** Returns response with indentations and line breaks. */
|
|
8751
|
+
prettyPrint?: boolean;
|
|
8752
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
8753
|
+
quotaUser?: string;
|
|
8754
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
8755
|
+
updateMask?: string;
|
|
8756
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8757
|
+
upload_protocol?: string;
|
|
8758
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8759
|
+
uploadType?: string;
|
|
8760
|
+
/** Request body */
|
|
8761
|
+
resource: GoogleCloudDiscoveryengineV1ServingConfig;
|
|
8762
|
+
}): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
8763
|
+
patch(
|
|
8764
|
+
request: {
|
|
8765
|
+
/** V1 error format. */
|
|
8766
|
+
'$.xgafv'?: string;
|
|
8767
|
+
/** OAuth access token. */
|
|
8768
|
+
access_token?: string;
|
|
8769
|
+
/** Data format for response. */
|
|
8770
|
+
alt?: string;
|
|
8771
|
+
/** JSONP */
|
|
8772
|
+
callback?: string;
|
|
8773
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8774
|
+
fields?: string;
|
|
8775
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
8776
|
+
key?: string;
|
|
8777
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
8778
|
+
name: string;
|
|
8779
|
+
/** OAuth 2.0 token for the current user. */
|
|
8780
|
+
oauth_token?: string;
|
|
8781
|
+
/** Returns response with indentations and line breaks. */
|
|
8782
|
+
prettyPrint?: boolean;
|
|
8783
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
8784
|
+
quotaUser?: string;
|
|
8785
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
8786
|
+
updateMask?: string;
|
|
8787
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8788
|
+
upload_protocol?: string;
|
|
8789
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8790
|
+
uploadType?: string;
|
|
8791
|
+
},
|
|
8792
|
+
body: GoogleCloudDiscoveryengineV1ServingConfig
|
|
8793
|
+
): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
8422
8794
|
/** Makes a recommendation, which requires a contextual user event. */
|
|
8423
8795
|
recommend(request: {
|
|
8424
8796
|
/** V1 error format. */
|
|
@@ -8593,6 +8965,64 @@ declare namespace gapi.client {
|
|
|
8593
8965
|
},
|
|
8594
8966
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
8595
8967
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
8968
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
8969
|
+
streamAnswer(request: {
|
|
8970
|
+
/** V1 error format. */
|
|
8971
|
+
'$.xgafv'?: string;
|
|
8972
|
+
/** OAuth access token. */
|
|
8973
|
+
access_token?: string;
|
|
8974
|
+
/** Data format for response. */
|
|
8975
|
+
alt?: string;
|
|
8976
|
+
/** JSONP */
|
|
8977
|
+
callback?: string;
|
|
8978
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8979
|
+
fields?: string;
|
|
8980
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
8981
|
+
key?: string;
|
|
8982
|
+
/** OAuth 2.0 token for the current user. */
|
|
8983
|
+
oauth_token?: string;
|
|
8984
|
+
/** Returns response with indentations and line breaks. */
|
|
8985
|
+
prettyPrint?: boolean;
|
|
8986
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
8987
|
+
quotaUser?: string;
|
|
8988
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
8989
|
+
servingConfig: string;
|
|
8990
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8991
|
+
upload_protocol?: string;
|
|
8992
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8993
|
+
uploadType?: string;
|
|
8994
|
+
/** Request body */
|
|
8995
|
+
resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
8996
|
+
}): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
8997
|
+
streamAnswer(
|
|
8998
|
+
request: {
|
|
8999
|
+
/** V1 error format. */
|
|
9000
|
+
'$.xgafv'?: string;
|
|
9001
|
+
/** OAuth access token. */
|
|
9002
|
+
access_token?: string;
|
|
9003
|
+
/** Data format for response. */
|
|
9004
|
+
alt?: string;
|
|
9005
|
+
/** JSONP */
|
|
9006
|
+
callback?: string;
|
|
9007
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9008
|
+
fields?: string;
|
|
9009
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9010
|
+
key?: string;
|
|
9011
|
+
/** OAuth 2.0 token for the current user. */
|
|
9012
|
+
oauth_token?: string;
|
|
9013
|
+
/** Returns response with indentations and line breaks. */
|
|
9014
|
+
prettyPrint?: boolean;
|
|
9015
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
9016
|
+
quotaUser?: string;
|
|
9017
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
9018
|
+
servingConfig: string;
|
|
9019
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9020
|
+
upload_protocol?: string;
|
|
9021
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9022
|
+
uploadType?: string;
|
|
9023
|
+
},
|
|
9024
|
+
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
9025
|
+
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
8596
9026
|
}
|
|
8597
9027
|
interface AnswersResource {
|
|
8598
9028
|
/** Gets a Answer. */
|
|
@@ -10604,6 +11034,68 @@ declare namespace gapi.client {
|
|
|
10604
11034
|
},
|
|
10605
11035
|
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
10606
11036
|
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
11037
|
+
/** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
11038
|
+
patch(request: {
|
|
11039
|
+
/** V1 error format. */
|
|
11040
|
+
'$.xgafv'?: string;
|
|
11041
|
+
/** OAuth access token. */
|
|
11042
|
+
access_token?: string;
|
|
11043
|
+
/** Data format for response. */
|
|
11044
|
+
alt?: string;
|
|
11045
|
+
/** JSONP */
|
|
11046
|
+
callback?: string;
|
|
11047
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11048
|
+
fields?: string;
|
|
11049
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
11050
|
+
key?: string;
|
|
11051
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
11052
|
+
name: string;
|
|
11053
|
+
/** OAuth 2.0 token for the current user. */
|
|
11054
|
+
oauth_token?: string;
|
|
11055
|
+
/** Returns response with indentations and line breaks. */
|
|
11056
|
+
prettyPrint?: boolean;
|
|
11057
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11058
|
+
quotaUser?: string;
|
|
11059
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
11060
|
+
updateMask?: string;
|
|
11061
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11062
|
+
upload_protocol?: string;
|
|
11063
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11064
|
+
uploadType?: string;
|
|
11065
|
+
/** Request body */
|
|
11066
|
+
resource: GoogleCloudDiscoveryengineV1ServingConfig;
|
|
11067
|
+
}): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
11068
|
+
patch(
|
|
11069
|
+
request: {
|
|
11070
|
+
/** V1 error format. */
|
|
11071
|
+
'$.xgafv'?: string;
|
|
11072
|
+
/** OAuth access token. */
|
|
11073
|
+
access_token?: string;
|
|
11074
|
+
/** Data format for response. */
|
|
11075
|
+
alt?: string;
|
|
11076
|
+
/** JSONP */
|
|
11077
|
+
callback?: string;
|
|
11078
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11079
|
+
fields?: string;
|
|
11080
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
11081
|
+
key?: string;
|
|
11082
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
11083
|
+
name: string;
|
|
11084
|
+
/** OAuth 2.0 token for the current user. */
|
|
11085
|
+
oauth_token?: string;
|
|
11086
|
+
/** Returns response with indentations and line breaks. */
|
|
11087
|
+
prettyPrint?: boolean;
|
|
11088
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11089
|
+
quotaUser?: string;
|
|
11090
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
11091
|
+
updateMask?: string;
|
|
11092
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11093
|
+
upload_protocol?: string;
|
|
11094
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11095
|
+
uploadType?: string;
|
|
11096
|
+
},
|
|
11097
|
+
body: GoogleCloudDiscoveryengineV1ServingConfig
|
|
11098
|
+
): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
10607
11099
|
/** Makes a recommendation, which requires a contextual user event. */
|
|
10608
11100
|
recommend(request: {
|
|
10609
11101
|
/** V1 error format. */
|
|
@@ -10778,6 +11270,64 @@ declare namespace gapi.client {
|
|
|
10778
11270
|
},
|
|
10779
11271
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
10780
11272
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
11273
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
11274
|
+
streamAnswer(request: {
|
|
11275
|
+
/** V1 error format. */
|
|
11276
|
+
'$.xgafv'?: string;
|
|
11277
|
+
/** OAuth access token. */
|
|
11278
|
+
access_token?: string;
|
|
11279
|
+
/** Data format for response. */
|
|
11280
|
+
alt?: string;
|
|
11281
|
+
/** JSONP */
|
|
11282
|
+
callback?: string;
|
|
11283
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11284
|
+
fields?: string;
|
|
11285
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
11286
|
+
key?: string;
|
|
11287
|
+
/** OAuth 2.0 token for the current user. */
|
|
11288
|
+
oauth_token?: string;
|
|
11289
|
+
/** Returns response with indentations and line breaks. */
|
|
11290
|
+
prettyPrint?: boolean;
|
|
11291
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11292
|
+
quotaUser?: string;
|
|
11293
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11294
|
+
servingConfig: string;
|
|
11295
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11296
|
+
upload_protocol?: string;
|
|
11297
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11298
|
+
uploadType?: string;
|
|
11299
|
+
/** Request body */
|
|
11300
|
+
resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
11301
|
+
}): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
11302
|
+
streamAnswer(
|
|
11303
|
+
request: {
|
|
11304
|
+
/** V1 error format. */
|
|
11305
|
+
'$.xgafv'?: string;
|
|
11306
|
+
/** OAuth access token. */
|
|
11307
|
+
access_token?: string;
|
|
11308
|
+
/** Data format for response. */
|
|
11309
|
+
alt?: string;
|
|
11310
|
+
/** JSONP */
|
|
11311
|
+
callback?: string;
|
|
11312
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11313
|
+
fields?: string;
|
|
11314
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
11315
|
+
key?: string;
|
|
11316
|
+
/** OAuth 2.0 token for the current user. */
|
|
11317
|
+
oauth_token?: string;
|
|
11318
|
+
/** Returns response with indentations and line breaks. */
|
|
11319
|
+
prettyPrint?: boolean;
|
|
11320
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
11321
|
+
quotaUser?: string;
|
|
11322
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11323
|
+
servingConfig: string;
|
|
11324
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11325
|
+
upload_protocol?: string;
|
|
11326
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11327
|
+
uploadType?: string;
|
|
11328
|
+
},
|
|
11329
|
+
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
11330
|
+
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
10781
11331
|
}
|
|
10782
11332
|
interface AnswersResource {
|
|
10783
11333
|
/** Gets a Answer. */
|
|
@@ -11595,7 +12145,7 @@ declare namespace gapi.client {
|
|
|
11595
12145
|
key?: string;
|
|
11596
12146
|
/** OAuth 2.0 token for the current user. */
|
|
11597
12147
|
oauth_token?: string;
|
|
11598
|
-
/** Required. The parent
|
|
12148
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
11599
12149
|
parent: string;
|
|
11600
12150
|
/** Returns response with indentations and line breaks. */
|
|
11601
12151
|
prettyPrint?: boolean;
|
|
@@ -12358,7 +12908,7 @@ declare namespace gapi.client {
|
|
|
12358
12908
|
key?: string;
|
|
12359
12909
|
/** OAuth 2.0 token for the current user. */
|
|
12360
12910
|
oauth_token?: string;
|
|
12361
|
-
/** Required. The parent
|
|
12911
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
12362
12912
|
parent: string;
|
|
12363
12913
|
/** Returns response with indentations and line breaks. */
|
|
12364
12914
|
prettyPrint?: boolean;
|