@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240512 → 0.0.20240526

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.
Files changed (3) hide show
  1. package/index.d.ts +1066 -84
  2. package/package.json +1 -1
  3. package/readme.md +4 -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=v1beta
12
- // Revision: 20240512
12
+ // Revision: 20240526
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -155,6 +155,8 @@ declare namespace gapi.client {
155
155
  document?: string;
156
156
  /** Page identifier. */
157
157
  pageIdentifier?: string;
158
+ /** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
159
+ structData?: {[P in string]: any};
158
160
  /** Title. */
159
161
  title?: string;
160
162
  /** URI for the document. */
@@ -165,6 +167,8 @@ declare namespace gapi.client {
165
167
  chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
166
168
  /** Document resource name. */
167
169
  document?: string;
170
+ /** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
171
+ structData?: {[P in string]: any};
168
172
  /** Title. */
169
173
  title?: string;
170
174
  /** URI for the document. */
@@ -236,6 +240,68 @@ declare namespace gapi.client {
236
240
  /** TargetSites created. */
237
241
  targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
238
242
  }
243
+ interface GoogleCloudDiscoveryengineV1alphaCondition {
244
+ /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
245
+ activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
246
+ /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
247
+ queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
248
+ }
249
+ interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
250
+ /** Whether the search query needs to exactly match the query term. */
251
+ fullMatch?: boolean;
252
+ /** The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */
253
+ value?: string;
254
+ }
255
+ interface GoogleCloudDiscoveryengineV1alphaConditionTimeRange {
256
+ /** End of time range. Range is inclusive. Must be in the future. */
257
+ endTime?: string;
258
+ /** Start of time range. Range is inclusive. */
259
+ startTime?: string;
260
+ }
261
+ interface GoogleCloudDiscoveryengineV1alphaControl {
262
+ /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
263
+ associatedServingConfigIds?: string[];
264
+ /** Defines a boost-type control */
265
+ boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
266
+ /** Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */
267
+ conditions?: GoogleCloudDiscoveryengineV1alphaCondition[];
268
+ /** Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */
269
+ displayName?: string;
270
+ /** Defines a filter-type control Currently not supported by Recommendation */
271
+ filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
272
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
273
+ name?: string;
274
+ /** Defines a redirect-type control. */
275
+ redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
276
+ /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
277
+ solutionType?: string;
278
+ /** Treats a group of terms as synonyms of one another. */
279
+ synonymsAction?: GoogleCloudDiscoveryengineV1alphaControlSynonymsAction;
280
+ /** Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */
281
+ useCases?: string[];
282
+ }
283
+ interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
284
+ /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
285
+ boost?: number;
286
+ /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
287
+ dataStore?: string;
288
+ /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
289
+ filter?: string;
290
+ }
291
+ interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
292
+ /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
293
+ dataStore?: string;
294
+ /** 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. */
295
+ filter?: string;
296
+ }
297
+ interface GoogleCloudDiscoveryengineV1alphaControlRedirectAction {
298
+ /** 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. */
299
+ redirectUri?: string;
300
+ }
301
+ interface GoogleCloudDiscoveryengineV1alphaControlSynonymsAction {
302
+ /** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
303
+ synonyms?: string[];
304
+ }
239
305
  interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
240
306
  /** Operation create time. */
241
307
  createTime?: string;
@@ -267,6 +333,7 @@ declare namespace gapi.client {
267
333
  displayName?: string;
268
334
  /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
269
335
  modelState?: string;
336
+ /** The version of the model. */
270
337
  modelVersion?: string;
271
338
  /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
272
339
  name?: string;
@@ -386,7 +453,7 @@ declare namespace gapi.client {
386
453
  dataStoreIds?: string[];
387
454
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
388
455
  displayName?: string;
389
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
456
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
390
457
  industryVertical?: string;
391
458
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
392
459
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
@@ -424,7 +491,7 @@ declare namespace gapi.client {
424
491
  dialogflowAgent?: string;
425
492
  }
426
493
  interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
427
- /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
494
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
428
495
  companyName?: string;
429
496
  }
430
497
  interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
@@ -489,6 +556,8 @@ declare namespace gapi.client {
489
556
  recsFilterableOption?: string;
490
557
  /** If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. */
491
558
  retrievableOption?: string;
559
+ /** Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished */
560
+ schemaOrgPaths?: string[];
492
561
  /** 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. */
493
562
  searchableOption?: string;
494
563
  }
@@ -696,7 +765,7 @@ declare namespace gapi.client {
696
765
  userPseudoId?: string;
697
766
  }
698
767
  interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
699
- /** The resource name of the answer to the user query. */
768
+ /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
700
769
  answer?: string;
701
770
  /** The user query. */
702
771
  query?: GoogleCloudDiscoveryengineV1alphaQuery;
@@ -833,7 +902,7 @@ declare namespace gapi.client {
833
902
  safetySpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec;
834
903
  /** Search specification. */
835
904
  searchSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec;
836
- /** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol “-” as session id. A new id will be automatically generated and assigned. */
905
+ /** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
837
906
  session?: string;
838
907
  /** 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
839
908
  userPseudoId?: string;
@@ -843,6 +912,8 @@ declare namespace gapi.client {
843
912
  answerLanguageCode?: string;
844
913
  /** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. */
845
914
  ignoreAdversarialQuery?: boolean;
915
+ /** Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. */
916
+ ignoreLowRelevantContent?: boolean;
846
917
  /** Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. */
847
918
  ignoreNonAnswerSeekingQuery?: boolean;
848
919
  /** Specifies whether to include citation metadata in the answer. The default value is `false`. */
@@ -893,6 +964,8 @@ declare namespace gapi.client {
893
964
  interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams {
894
965
  /** Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
895
966
  boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
967
+ /** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
968
+ dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
896
969
  /** 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. This will be used to filter search results which may affect the Answer response. 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 customers 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) */
897
970
  filter?: string;
898
971
  /** Number of search results to return. The default value is 10. */
@@ -987,6 +1060,8 @@ declare namespace gapi.client {
987
1060
  document?: string;
988
1061
  /** Page identifier. */
989
1062
  pageIdentifier?: string;
1063
+ /** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
1064
+ structData?: {[P in string]: any};
990
1065
  /** Title. */
991
1066
  title?: string;
992
1067
  /** URI for the document. */
@@ -997,6 +1072,8 @@ declare namespace gapi.client {
997
1072
  chunkContents?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
998
1073
  /** Document resource name. */
999
1074
  document?: string;
1075
+ /** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
1076
+ structData?: {[P in string]: any};
1000
1077
  /** Title. */
1001
1078
  title?: string;
1002
1079
  /** URI for the document. */
@@ -1191,6 +1268,68 @@ declare namespace gapi.client {
1191
1268
  /** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
1192
1269
  selectedSuggestion?: string;
1193
1270
  }
1271
+ interface GoogleCloudDiscoveryengineV1betaCondition {
1272
+ /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
1273
+ activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
1274
+ /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
1275
+ queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
1276
+ }
1277
+ interface GoogleCloudDiscoveryengineV1betaConditionQueryTerm {
1278
+ /** Whether the search query needs to exactly match the query term. */
1279
+ fullMatch?: boolean;
1280
+ /** The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */
1281
+ value?: string;
1282
+ }
1283
+ interface GoogleCloudDiscoveryengineV1betaConditionTimeRange {
1284
+ /** End of time range. Range is inclusive. Must be in the future. */
1285
+ endTime?: string;
1286
+ /** Start of time range. Range is inclusive. */
1287
+ startTime?: string;
1288
+ }
1289
+ interface GoogleCloudDiscoveryengineV1betaControl {
1290
+ /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
1291
+ associatedServingConfigIds?: string[];
1292
+ /** Defines a boost-type control */
1293
+ boostAction?: GoogleCloudDiscoveryengineV1betaControlBoostAction;
1294
+ /** Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */
1295
+ conditions?: GoogleCloudDiscoveryengineV1betaCondition[];
1296
+ /** Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */
1297
+ displayName?: string;
1298
+ /** Defines a filter-type control Currently not supported by Recommendation */
1299
+ filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
1300
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
1301
+ name?: string;
1302
+ /** Defines a redirect-type control. */
1303
+ redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
1304
+ /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
1305
+ solutionType?: string;
1306
+ /** Treats a group of terms as synonyms of one another. */
1307
+ synonymsAction?: GoogleCloudDiscoveryengineV1betaControlSynonymsAction;
1308
+ /** Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */
1309
+ useCases?: string[];
1310
+ }
1311
+ interface GoogleCloudDiscoveryengineV1betaControlBoostAction {
1312
+ /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
1313
+ boost?: number;
1314
+ /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
1315
+ dataStore?: string;
1316
+ /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
1317
+ filter?: string;
1318
+ }
1319
+ interface GoogleCloudDiscoveryengineV1betaControlFilterAction {
1320
+ /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
1321
+ dataStore?: string;
1322
+ /** 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. */
1323
+ filter?: string;
1324
+ }
1325
+ interface GoogleCloudDiscoveryengineV1betaControlRedirectAction {
1326
+ /** 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. */
1327
+ redirectUri?: string;
1328
+ }
1329
+ interface GoogleCloudDiscoveryengineV1betaControlSynonymsAction {
1330
+ /** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
1331
+ synonyms?: string[];
1332
+ }
1194
1333
  interface GoogleCloudDiscoveryengineV1betaConversation {
1195
1334
  /** Output only. The time the conversation finished. */
1196
1335
  endTime?: string;
@@ -1290,6 +1429,7 @@ declare namespace gapi.client {
1290
1429
  displayName?: string;
1291
1430
  /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
1292
1431
  modelState?: string;
1432
+ /** The version of the model. */
1293
1433
  modelVersion?: string;
1294
1434
  /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
1295
1435
  name?: string;
@@ -1383,7 +1523,7 @@ declare namespace gapi.client {
1383
1523
  name?: string;
1384
1524
  /** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
1385
1525
  promotionIds?: string[];
1386
- /** Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` */
1526
+ /** Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` */
1387
1527
  quantity?: number;
1388
1528
  /** The Document URI - only allowed for website data stores. */
1389
1529
  uri?: string;
@@ -1440,7 +1580,7 @@ declare namespace gapi.client {
1440
1580
  dataStoreIds?: string[];
1441
1581
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
1442
1582
  displayName?: string;
1443
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
1583
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
1444
1584
  industryVertical?: string;
1445
1585
  /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
1446
1586
  name?: string;
@@ -1472,7 +1612,7 @@ declare namespace gapi.client {
1472
1612
  dialogflowAgent?: string;
1473
1613
  }
1474
1614
  interface GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
1475
- /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
1615
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
1476
1616
  companyName?: string;
1477
1617
  }
1478
1618
  interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
@@ -1506,7 +1646,7 @@ declare namespace gapi.client {
1506
1646
  gcsStagingDir?: string;
1507
1647
  }
1508
1648
  interface GoogleCloudDiscoveryengineV1betaFirestoreSource {
1509
- /** Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. */
1649
+ /** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
1510
1650
  collectionId?: string;
1511
1651
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
1512
1652
  databaseId?: string;
@@ -1516,9 +1656,9 @@ declare namespace gapi.client {
1516
1656
  projectId?: string;
1517
1657
  }
1518
1658
  interface GoogleCloudDiscoveryengineV1betaGcsSource {
1519
- /** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
1659
+ /** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. */
1520
1660
  dataSchema?: string;
1521
- /** Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
1661
+ /** Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
1522
1662
  inputUris?: string[];
1523
1663
  }
1524
1664
  interface GoogleCloudDiscoveryengineV1betaGroundingFact {
@@ -1649,6 +1789,12 @@ declare namespace gapi.client {
1649
1789
  /** Inclusive lower bound. */
1650
1790
  minimum?: number;
1651
1791
  }
1792
+ interface GoogleCloudDiscoveryengineV1betaListControlsResponse {
1793
+ /** All the Controls for a given data store. */
1794
+ controls?: GoogleCloudDiscoveryengineV1betaControl[];
1795
+ /** Pagination token, if not returned indicates the last page. */
1796
+ nextPageToken?: string;
1797
+ }
1652
1798
  interface GoogleCloudDiscoveryengineV1betaListConversationsResponse {
1653
1799
  /** All the Conversations for a given data store. */
1654
1800
  conversations?: GoogleCloudDiscoveryengineV1betaConversation[];
@@ -1730,6 +1876,37 @@ declare namespace gapi.client {
1730
1876
  totalPanels?: number;
1731
1877
  }
1732
1878
  interface GoogleCloudDiscoveryengineV1betaPauseEngineRequest {}
1879
+ interface GoogleCloudDiscoveryengineV1betaProject {
1880
+ /** Output only. The timestamp when this project is created. */
1881
+ createTime?: string;
1882
+ /** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
1883
+ name?: string;
1884
+ /** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
1885
+ provisionCompletionTime?: string;
1886
+ /** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
1887
+ serviceTermsMap?: {
1888
+ [P in string]: GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
1889
+ };
1890
+ }
1891
+ interface GoogleCloudDiscoveryengineV1betaProjectServiceTerms {
1892
+ /** The last time when the project agreed to the terms of service. */
1893
+ acceptTime?: string;
1894
+ /** The last time when the project declined or revoked the agreement to terms of service. */
1895
+ declineTime?: string;
1896
+ /** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
1897
+ id?: string;
1898
+ /** Whether the project has accepted/rejected the service terms or it is still pending. */
1899
+ state?: string;
1900
+ /** The version string of the terms of service. For acceptable values, see the comments for id above. */
1901
+ version?: string;
1902
+ }
1903
+ interface GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {}
1904
+ interface GoogleCloudDiscoveryengineV1betaProvisionProjectRequest {
1905
+ /** Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms). */
1906
+ acceptDataUseTerms?: boolean;
1907
+ /** Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. */
1908
+ dataUseTermsVersion?: string;
1909
+ }
1733
1910
  interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
1734
1911
  /** Operation create time. */
1735
1912
  createTime?: string;
@@ -1794,23 +1971,25 @@ declare namespace gapi.client {
1794
1971
  records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
1795
1972
  /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
1796
1973
  topN?: number;
1974
+ /** 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. */
1975
+ userLabels?: {[P in string]: string};
1797
1976
  }
1798
1977
  interface GoogleCloudDiscoveryengineV1betaRankResponse {
1799
1978
  /** A list of records sorted by descending score. */
1800
1979
  records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
1801
1980
  }
1802
1981
  interface GoogleCloudDiscoveryengineV1betaRecommendRequest {
1803
- /** 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. */
1982
+ /** 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 returns 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 never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. */
1804
1983
  filter?: string;
1805
- /** Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. */
1984
+ /** Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. */
1806
1985
  pageSize?: number;
1807
- /** 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. */
1986
+ /** Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is 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 returns 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. */
1808
1987
  params?: {[P in string]: any};
1809
1988
  /** Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset. */
1810
1989
  userEvent?: GoogleCloudDiscoveryengineV1betaUserEvent;
1811
1990
  /** 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 [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
1812
1991
  userLabels?: {[P in string]: string};
1813
- /** Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. */
1992
+ /** Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. */
1814
1993
  validateOnly?: boolean;
1815
1994
  }
1816
1995
  interface GoogleCloudDiscoveryengineV1betaRecommendResponse {
@@ -1828,7 +2007,7 @@ declare namespace gapi.client {
1828
2007
  document?: GoogleCloudDiscoveryengineV1betaDocument;
1829
2008
  /** Resource ID of the recommended Document. */
1830
2009
  id?: string;
1831
- /** Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
2010
+ /** Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
1832
2011
  metadata?: {[P in string]: any};
1833
2012
  }
1834
2013
  interface GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest {
@@ -1871,7 +2050,7 @@ declare namespace gapi.client {
1871
2050
  searchQuery?: string;
1872
2051
  }
1873
2052
  interface GoogleCloudDiscoveryengineV1betaSearchRequest {
1874
- /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
2053
+ /** 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) */
1875
2054
  boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
1876
2055
  /** The branch resource name, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */
1877
2056
  branch?: string;
@@ -1879,7 +2058,7 @@ declare namespace gapi.client {
1879
2058
  canonicalFilter?: string;
1880
2059
  /** A specification for configuring the behavior of content search. */
1881
2060
  contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
1882
- /** A list of data store specs to apply on a search call. */
2061
+ /** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
1883
2062
  dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
1884
2063
  /** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
1885
2064
  embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
@@ -1897,7 +2076,7 @@ declare namespace gapi.client {
1897
2076
  pageSize?: number;
1898
2077
  /** A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1899
2078
  pageToken?: string;
1900
- /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1 */
2079
+ /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */
1901
2080
  params?: {[P in string]: any};
1902
2081
  /** Raw search query. */
1903
2082
  query?: string;
@@ -2019,13 +2198,13 @@ declare namespace gapi.client {
2019
2198
  excludedFilterKeys?: string[];
2020
2199
  /** Required. The facet key specification. */
2021
2200
  facetKey?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey;
2022
- /** Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned. */
2201
+ /** Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned. */
2023
2202
  limit?: number;
2024
2203
  }
2025
2204
  interface GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey {
2026
2205
  /** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
2027
2206
  caseInsensitive?: boolean;
2028
- /** Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. */
2207
+ /** Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. */
2029
2208
  contains?: string[];
2030
2209
  /** Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */
2031
2210
  intervals?: GoogleCloudDiscoveryengineV1betaInterval[];
@@ -2049,7 +2228,7 @@ declare namespace gapi.client {
2049
2228
  pinUnexpandedResults?: boolean;
2050
2229
  }
2051
2230
  interface GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec {
2052
- /** The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. */
2231
+ /** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
2053
2232
  mode?: string;
2054
2233
  }
2055
2234
  interface GoogleCloudDiscoveryengineV1betaSearchResponse {
@@ -2080,7 +2259,7 @@ declare namespace gapi.client {
2080
2259
  interface GoogleCloudDiscoveryengineV1betaSearchResponseFacet {
2081
2260
  /** Whether the facet is dynamically generated. */
2082
2261
  dynamicFacet?: boolean;
2083
- /** The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. */
2262
+ /** The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. */
2084
2263
  key?: string;
2085
2264
  /** The facet values for this field. */
2086
2265
  values?: GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue[];
@@ -2106,9 +2285,9 @@ declare namespace gapi.client {
2106
2285
  refinementAttributes?: GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute[];
2107
2286
  }
2108
2287
  interface GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute {
2109
- /** Attribute key used to refine the results e.g. 'movie_type'. */
2288
+ /** Attribute key used to refine the results. For example, `"movie_type"`. */
2110
2289
  attributeKey?: string;
2111
- /** Attribute value used to refine the results e.g. 'drama'. */
2290
+ /** Attribute value used to refine the results. For example, `"drama"`. */
2112
2291
  attributeValue?: string;
2113
2292
  }
2114
2293
  interface GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo {
@@ -2118,7 +2297,7 @@ declare namespace gapi.client {
2118
2297
  pinnedResultCount?: string;
2119
2298
  }
2120
2299
  interface GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult {
2121
- /** The document data snippet in the search response. Only fields that are marked as retrievable are populated. */
2300
+ /** The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */
2122
2301
  document?: GoogleCloudDiscoveryengineV1betaDocument;
2123
2302
  /** Document.id of the searched Document. */
2124
2303
  id?: string;
@@ -2250,7 +2429,7 @@ declare namespace gapi.client {
2250
2429
  userPseudoId?: string;
2251
2430
  }
2252
2431
  interface GoogleCloudDiscoveryengineV1betaSessionTurn {
2253
- /** The resource name of the answer to the user query. */
2432
+ /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
2254
2433
  answer?: string;
2255
2434
  /** The user query. */
2256
2435
  query?: GoogleCloudDiscoveryengineV1betaQuery;
@@ -2398,10 +2577,14 @@ declare namespace gapi.client {
2398
2577
  attributionToken?: string;
2399
2578
  /** CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
2400
2579
  completionInfo?: GoogleCloudDiscoveryengineV1betaCompletionInfo;
2580
+ /** The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted. */
2581
+ dataStore?: string;
2401
2582
  /** Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent. */
2402
2583
  directUserRequest?: boolean;
2403
2584
  /** List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired. */
2404
2585
  documents?: GoogleCloudDiscoveryengineV1betaDocumentInfo[];
2586
+ /** The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. */
2587
+ engine?: string;
2405
2588
  /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
2406
2589
  eventTime?: string;
2407
2590
  /** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
@@ -2420,7 +2603,7 @@ declare namespace gapi.client {
2420
2603
  searchInfo?: GoogleCloudDiscoveryengineV1betaSearchInfo;
2421
2604
  /** A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix. */
2422
2605
  sessionId?: string;
2423
- /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end. */
2606
+ /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups. */
2424
2607
  tagIds?: string[];
2425
2608
  /** The transaction metadata (if any) associated with this user event. */
2426
2609
  transactionInfo?: GoogleCloudDiscoveryengineV1betaTransactionInfo;
@@ -2435,6 +2618,68 @@ declare namespace gapi.client {
2435
2618
  /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2436
2619
  userId?: string;
2437
2620
  }
2621
+ interface GoogleCloudDiscoveryengineV1Condition {
2622
+ /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
2623
+ activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
2624
+ /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
2625
+ queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
2626
+ }
2627
+ interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
2628
+ /** Whether the search query needs to exactly match the query term. */
2629
+ fullMatch?: boolean;
2630
+ /** The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */
2631
+ value?: string;
2632
+ }
2633
+ interface GoogleCloudDiscoveryengineV1ConditionTimeRange {
2634
+ /** End of time range. Range is inclusive. Must be in the future. */
2635
+ endTime?: string;
2636
+ /** Start of time range. Range is inclusive. */
2637
+ startTime?: string;
2638
+ }
2639
+ interface GoogleCloudDiscoveryengineV1Control {
2640
+ /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
2641
+ associatedServingConfigIds?: string[];
2642
+ /** Defines a boost-type control */
2643
+ boostAction?: GoogleCloudDiscoveryengineV1ControlBoostAction;
2644
+ /** Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */
2645
+ conditions?: GoogleCloudDiscoveryengineV1Condition[];
2646
+ /** Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */
2647
+ displayName?: string;
2648
+ /** Defines a filter-type control Currently not supported by Recommendation */
2649
+ filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
2650
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
2651
+ name?: string;
2652
+ /** Defines a redirect-type control. */
2653
+ redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
2654
+ /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
2655
+ solutionType?: string;
2656
+ /** Treats a group of terms as synonyms of one another. */
2657
+ synonymsAction?: GoogleCloudDiscoveryengineV1ControlSynonymsAction;
2658
+ /** Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */
2659
+ useCases?: string[];
2660
+ }
2661
+ interface GoogleCloudDiscoveryengineV1ControlBoostAction {
2662
+ /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
2663
+ boost?: number;
2664
+ /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
2665
+ dataStore?: string;
2666
+ /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
2667
+ filter?: string;
2668
+ }
2669
+ interface GoogleCloudDiscoveryengineV1ControlFilterAction {
2670
+ /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
2671
+ dataStore?: string;
2672
+ /** 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. */
2673
+ filter?: string;
2674
+ }
2675
+ interface GoogleCloudDiscoveryengineV1ControlRedirectAction {
2676
+ /** 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. */
2677
+ redirectUri?: string;
2678
+ }
2679
+ interface GoogleCloudDiscoveryengineV1ControlSynonymsAction {
2680
+ /** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
2681
+ synonyms?: string[];
2682
+ }
2438
2683
  interface GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
2439
2684
  /** Operation create time. */
2440
2685
  createTime?: string;
@@ -2553,7 +2798,7 @@ declare namespace gapi.client {
2553
2798
  dataStoreIds?: string[];
2554
2799
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
2555
2800
  displayName?: string;
2556
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
2801
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
2557
2802
  industryVertical?: string;
2558
2803
  /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
2559
2804
  name?: string;
@@ -2585,7 +2830,7 @@ declare namespace gapi.client {
2585
2830
  dialogflowAgent?: string;
2586
2831
  }
2587
2832
  interface GoogleCloudDiscoveryengineV1EngineCommonConfig {
2588
- /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
2833
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
2589
2834
  companyName?: string;
2590
2835
  }
2591
2836
  interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
@@ -2650,6 +2895,31 @@ declare namespace gapi.client {
2650
2895
  /** Count of user events imported, but with Document information not found in the existing Branch. */
2651
2896
  unjoinedEventsCount?: string;
2652
2897
  }
2898
+ interface GoogleCloudDiscoveryengineV1Project {
2899
+ /** Output only. The timestamp when this project is created. */
2900
+ createTime?: string;
2901
+ /** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
2902
+ name?: string;
2903
+ /** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
2904
+ provisionCompletionTime?: string;
2905
+ /** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
2906
+ serviceTermsMap?: {
2907
+ [P in string]: GoogleCloudDiscoveryengineV1ProjectServiceTerms;
2908
+ };
2909
+ }
2910
+ interface GoogleCloudDiscoveryengineV1ProjectServiceTerms {
2911
+ /** The last time when the project agreed to the terms of service. */
2912
+ acceptTime?: string;
2913
+ /** The last time when the project declined or revoked the agreement to terms of service. */
2914
+ declineTime?: string;
2915
+ /** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
2916
+ id?: string;
2917
+ /** Whether the project has accepted/rejected the service terms or it is still pending. */
2918
+ state?: string;
2919
+ /** The version string of the terms of service. For acceptable values, see the comments for id above. */
2920
+ version?: string;
2921
+ }
2922
+ interface GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {}
2653
2923
  interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
2654
2924
  /** Operation create time. */
2655
2925
  createTime?: string;
@@ -2848,7 +3118,7 @@ declare namespace gapi.client {
2848
3118
  alt?: string;
2849
3119
  /** JSONP */
2850
3120
  callback?: string;
2851
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
3121
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2852
3122
  documentId?: string;
2853
3123
  /** Selector specifying which fields to include in a partial response. */
2854
3124
  fields?: string;
@@ -2879,7 +3149,7 @@ declare namespace gapi.client {
2879
3149
  alt?: string;
2880
3150
  /** JSONP */
2881
3151
  callback?: string;
2882
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
3152
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2883
3153
  documentId?: string;
2884
3154
  /** Selector specifying which fields to include in a partial response. */
2885
3155
  fields?: string;
@@ -2954,7 +3224,7 @@ declare namespace gapi.client {
2954
3224
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2955
3225
  uploadType?: string;
2956
3226
  }): Request<GoogleCloudDiscoveryengineV1betaDocument>;
2957
- /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. */
3227
+ /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. */
2958
3228
  import(request: {
2959
3229
  /** V1 error format. */
2960
3230
  '$.xgafv'?: string;
@@ -3028,7 +3298,7 @@ declare namespace gapi.client {
3028
3298
  key?: string;
3029
3299
  /** OAuth 2.0 token for the current user. */
3030
3300
  oauth_token?: string;
3031
- /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
3301
+ /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
3032
3302
  pageSize?: number;
3033
3303
  /** A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
3034
3304
  pageToken?: string;
@@ -3049,7 +3319,7 @@ declare namespace gapi.client {
3049
3319
  '$.xgafv'?: string;
3050
3320
  /** OAuth access token. */
3051
3321
  access_token?: string;
3052
- /** If set to true, and the Document is not found, a new Document will be created. */
3322
+ /** If set to `true` and the Document is not found, a new Document is be created. */
3053
3323
  allowMissing?: boolean;
3054
3324
  /** Data format for response. */
3055
3325
  alt?: string;
@@ -3067,7 +3337,7 @@ declare namespace gapi.client {
3067
3337
  prettyPrint?: boolean;
3068
3338
  /** 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. */
3069
3339
  quotaUser?: string;
3070
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3340
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
3071
3341
  updateMask?: string;
3072
3342
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3073
3343
  upload_protocol?: string;
@@ -3082,7 +3352,7 @@ declare namespace gapi.client {
3082
3352
  '$.xgafv'?: string;
3083
3353
  /** OAuth access token. */
3084
3354
  access_token?: string;
3085
- /** If set to true, and the Document is not found, a new Document will be created. */
3355
+ /** If set to `true` and the Document is not found, a new Document is be created. */
3086
3356
  allowMissing?: boolean;
3087
3357
  /** Data format for response. */
3088
3358
  alt?: string;
@@ -3100,7 +3370,7 @@ declare namespace gapi.client {
3100
3370
  prettyPrint?: boolean;
3101
3371
  /** 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. */
3102
3372
  quotaUser?: string;
3103
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3373
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
3104
3374
  updateMask?: string;
3105
3375
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3106
3376
  upload_protocol?: string;
@@ -3292,6 +3562,219 @@ declare namespace gapi.client {
3292
3562
  documents: DocumentsResource;
3293
3563
  operations: OperationsResource;
3294
3564
  }
3565
+ interface ControlsResource {
3566
+ /** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
3567
+ create(request: {
3568
+ /** V1 error format. */
3569
+ '$.xgafv'?: string;
3570
+ /** OAuth access token. */
3571
+ access_token?: string;
3572
+ /** Data format for response. */
3573
+ alt?: string;
3574
+ /** JSONP */
3575
+ callback?: string;
3576
+ /** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
3577
+ controlId?: string;
3578
+ /** Selector specifying which fields to include in a partial response. */
3579
+ fields?: string;
3580
+ /** 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. */
3581
+ key?: string;
3582
+ /** OAuth 2.0 token for the current user. */
3583
+ oauth_token?: string;
3584
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3585
+ parent: string;
3586
+ /** Returns response with indentations and line breaks. */
3587
+ prettyPrint?: boolean;
3588
+ /** 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. */
3589
+ quotaUser?: string;
3590
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3591
+ upload_protocol?: string;
3592
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3593
+ uploadType?: string;
3594
+ /** Request body */
3595
+ resource: GoogleCloudDiscoveryengineV1betaControl;
3596
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
3597
+ create(
3598
+ request: {
3599
+ /** V1 error format. */
3600
+ '$.xgafv'?: string;
3601
+ /** OAuth access token. */
3602
+ access_token?: string;
3603
+ /** Data format for response. */
3604
+ alt?: string;
3605
+ /** JSONP */
3606
+ callback?: string;
3607
+ /** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
3608
+ controlId?: string;
3609
+ /** Selector specifying which fields to include in a partial response. */
3610
+ fields?: string;
3611
+ /** 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. */
3612
+ key?: string;
3613
+ /** OAuth 2.0 token for the current user. */
3614
+ oauth_token?: string;
3615
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3616
+ parent: string;
3617
+ /** Returns response with indentations and line breaks. */
3618
+ prettyPrint?: boolean;
3619
+ /** 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. */
3620
+ quotaUser?: string;
3621
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3622
+ upload_protocol?: string;
3623
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3624
+ uploadType?: string;
3625
+ },
3626
+ body: GoogleCloudDiscoveryengineV1betaControl
3627
+ ): Request<GoogleCloudDiscoveryengineV1betaControl>;
3628
+ /** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
3629
+ delete(request?: {
3630
+ /** V1 error format. */
3631
+ '$.xgafv'?: string;
3632
+ /** OAuth access token. */
3633
+ access_token?: string;
3634
+ /** Data format for response. */
3635
+ alt?: string;
3636
+ /** JSONP */
3637
+ callback?: string;
3638
+ /** Selector specifying which fields to include in a partial response. */
3639
+ fields?: string;
3640
+ /** 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. */
3641
+ key?: string;
3642
+ /** Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
3643
+ name: string;
3644
+ /** OAuth 2.0 token for the current user. */
3645
+ oauth_token?: string;
3646
+ /** Returns response with indentations and line breaks. */
3647
+ prettyPrint?: boolean;
3648
+ /** 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. */
3649
+ quotaUser?: string;
3650
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3651
+ upload_protocol?: string;
3652
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3653
+ uploadType?: string;
3654
+ }): Request<{}>;
3655
+ /** Gets a Control. */
3656
+ get(request?: {
3657
+ /** V1 error format. */
3658
+ '$.xgafv'?: string;
3659
+ /** OAuth access token. */
3660
+ access_token?: string;
3661
+ /** Data format for response. */
3662
+ alt?: string;
3663
+ /** JSONP */
3664
+ callback?: string;
3665
+ /** Selector specifying which fields to include in a partial response. */
3666
+ fields?: string;
3667
+ /** 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. */
3668
+ key?: string;
3669
+ /** Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
3670
+ name: string;
3671
+ /** OAuth 2.0 token for the current user. */
3672
+ oauth_token?: string;
3673
+ /** Returns response with indentations and line breaks. */
3674
+ prettyPrint?: boolean;
3675
+ /** 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. */
3676
+ quotaUser?: string;
3677
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3678
+ upload_protocol?: string;
3679
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3680
+ uploadType?: string;
3681
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
3682
+ /** Lists all Controls by their parent DataStore. */
3683
+ list(request?: {
3684
+ /** V1 error format. */
3685
+ '$.xgafv'?: string;
3686
+ /** OAuth access token. */
3687
+ access_token?: string;
3688
+ /** Data format for response. */
3689
+ alt?: string;
3690
+ /** JSONP */
3691
+ callback?: string;
3692
+ /** Selector specifying which fields to include in a partial response. */
3693
+ fields?: string;
3694
+ /** Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */
3695
+ filter?: string;
3696
+ /** 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. */
3697
+ key?: string;
3698
+ /** OAuth 2.0 token for the current user. */
3699
+ oauth_token?: string;
3700
+ /** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
3701
+ pageSize?: number;
3702
+ /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
3703
+ pageToken?: string;
3704
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3705
+ parent: string;
3706
+ /** Returns response with indentations and line breaks. */
3707
+ prettyPrint?: boolean;
3708
+ /** 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. */
3709
+ quotaUser?: string;
3710
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3711
+ upload_protocol?: string;
3712
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3713
+ uploadType?: string;
3714
+ }): Request<GoogleCloudDiscoveryengineV1betaListControlsResponse>;
3715
+ /** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
3716
+ patch(request: {
3717
+ /** V1 error format. */
3718
+ '$.xgafv'?: string;
3719
+ /** OAuth access token. */
3720
+ access_token?: string;
3721
+ /** Data format for response. */
3722
+ alt?: string;
3723
+ /** JSONP */
3724
+ callback?: string;
3725
+ /** Selector specifying which fields to include in a partial response. */
3726
+ fields?: string;
3727
+ /** 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. */
3728
+ key?: string;
3729
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
3730
+ name: string;
3731
+ /** OAuth 2.0 token for the current user. */
3732
+ oauth_token?: string;
3733
+ /** Returns response with indentations and line breaks. */
3734
+ prettyPrint?: boolean;
3735
+ /** 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. */
3736
+ quotaUser?: string;
3737
+ /** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
3738
+ updateMask?: string;
3739
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3740
+ upload_protocol?: string;
3741
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3742
+ uploadType?: string;
3743
+ /** Request body */
3744
+ resource: GoogleCloudDiscoveryengineV1betaControl;
3745
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
3746
+ patch(
3747
+ request: {
3748
+ /** V1 error format. */
3749
+ '$.xgafv'?: string;
3750
+ /** OAuth access token. */
3751
+ access_token?: string;
3752
+ /** Data format for response. */
3753
+ alt?: string;
3754
+ /** JSONP */
3755
+ callback?: string;
3756
+ /** Selector specifying which fields to include in a partial response. */
3757
+ fields?: string;
3758
+ /** 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. */
3759
+ key?: string;
3760
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
3761
+ name: string;
3762
+ /** OAuth 2.0 token for the current user. */
3763
+ oauth_token?: string;
3764
+ /** Returns response with indentations and line breaks. */
3765
+ prettyPrint?: boolean;
3766
+ /** 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. */
3767
+ quotaUser?: string;
3768
+ /** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
3769
+ updateMask?: string;
3770
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3771
+ upload_protocol?: string;
3772
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3773
+ uploadType?: string;
3774
+ },
3775
+ body: GoogleCloudDiscoveryengineV1betaControl
3776
+ ): Request<GoogleCloudDiscoveryengineV1betaControl>;
3777
+ }
3295
3778
  interface ConversationsResource {
3296
3779
  /** Converses a conversation. */
3297
3780
  converse(request: {
@@ -3802,7 +4285,7 @@ declare namespace gapi.client {
3802
4285
  prettyPrint?: boolean;
3803
4286
  /** 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. */
3804
4287
  quotaUser?: string;
3805
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
4288
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3806
4289
  schemaId?: string;
3807
4290
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3808
4291
  upload_protocol?: string;
@@ -3833,7 +4316,7 @@ declare namespace gapi.client {
3833
4316
  prettyPrint?: boolean;
3834
4317
  /** 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. */
3835
4318
  quotaUser?: string;
3836
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
4319
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3837
4320
  schemaId?: string;
3838
4321
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3839
4322
  upload_protocol?: string;
@@ -3912,7 +4395,7 @@ declare namespace gapi.client {
3912
4395
  key?: string;
3913
4396
  /** OAuth 2.0 token for the current user. */
3914
4397
  oauth_token?: string;
3915
- /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
4398
+ /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */
3916
4399
  pageSize?: number;
3917
4400
  /** A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */
3918
4401
  pageToken?: string;
@@ -3933,7 +4416,7 @@ declare namespace gapi.client {
3933
4416
  '$.xgafv'?: string;
3934
4417
  /** OAuth access token. */
3935
4418
  access_token?: string;
3936
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
4419
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3937
4420
  allowMissing?: boolean;
3938
4421
  /** Data format for response. */
3939
4422
  alt?: string;
@@ -3964,7 +4447,7 @@ declare namespace gapi.client {
3964
4447
  '$.xgafv'?: string;
3965
4448
  /** OAuth access token. */
3966
4449
  access_token?: string;
3967
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
4450
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3968
4451
  allowMissing?: boolean;
3969
4452
  /** Data format for response. */
3970
4453
  alt?: string;
@@ -4190,7 +4673,7 @@ declare namespace gapi.client {
4190
4673
  prettyPrint?: boolean;
4191
4674
  /** 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. */
4192
4675
  quotaUser?: string;
4193
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4676
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4194
4677
  servingConfig: string;
4195
4678
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4196
4679
  upload_protocol?: string;
@@ -4219,7 +4702,7 @@ declare namespace gapi.client {
4219
4702
  prettyPrint?: boolean;
4220
4703
  /** 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. */
4221
4704
  quotaUser?: string;
4222
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4705
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4223
4706
  servingConfig: string;
4224
4707
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4225
4708
  upload_protocol?: string;
@@ -5333,7 +5816,7 @@ declare namespace gapi.client {
5333
5816
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
5334
5817
  userEvent?: string;
5335
5818
  }): Request<GoogleApiHttpBody>;
5336
- /** Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
5819
+ /** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
5337
5820
  import(request: {
5338
5821
  /** V1 error format. */
5339
5822
  '$.xgafv'?: string;
@@ -5417,6 +5900,8 @@ declare namespace gapi.client {
5417
5900
  upload_protocol?: string;
5418
5901
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5419
5902
  uploadType?: string;
5903
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
5904
+ writeAsync?: boolean;
5420
5905
  /** Request body */
5421
5906
  resource: GoogleCloudDiscoveryengineV1betaUserEvent;
5422
5907
  }): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
@@ -5446,6 +5931,8 @@ declare namespace gapi.client {
5446
5931
  upload_protocol?: string;
5447
5932
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5448
5933
  uploadType?: string;
5934
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
5935
+ writeAsync?: boolean;
5449
5936
  },
5450
5937
  body: GoogleCloudDiscoveryengineV1betaUserEvent
5451
5938
  ): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
@@ -5645,7 +6132,7 @@ declare namespace gapi.client {
5645
6132
  callback?: string;
5646
6133
  /** Selector specifying which fields to include in a partial response. */
5647
6134
  fields?: string;
5648
- /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
6135
+ /** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
5649
6136
  filter?: string;
5650
6137
  /** 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. */
5651
6138
  key?: string;
@@ -5755,9 +6242,232 @@ declare namespace gapi.client {
5755
6242
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5756
6243
  uploadType?: string;
5757
6244
  /** Request body */
5758
- resource: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
5759
- }): Request<GoogleLongrunningOperation>;
5760
- trainCustomModel(
6245
+ resource: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
6246
+ }): Request<GoogleLongrunningOperation>;
6247
+ trainCustomModel(
6248
+ 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
+ /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
6258
+ dataStore: string;
6259
+ /** Selector specifying which fields to include in a partial response. */
6260
+ fields?: string;
6261
+ /** 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. */
6262
+ key?: 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
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6270
+ upload_protocol?: string;
6271
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6272
+ uploadType?: string;
6273
+ },
6274
+ body: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest
6275
+ ): Request<GoogleLongrunningOperation>;
6276
+ branches: BranchesResource;
6277
+ controls: ControlsResource;
6278
+ conversations: ConversationsResource;
6279
+ customModels: CustomModelsResource;
6280
+ models: ModelsResource;
6281
+ operations: OperationsResource;
6282
+ schemas: SchemasResource;
6283
+ servingConfigs: ServingConfigsResource;
6284
+ sessions: SessionsResource;
6285
+ siteSearchEngine: SiteSearchEngineResource;
6286
+ suggestionDenyListEntries: SuggestionDenyListEntriesResource;
6287
+ userEvents: UserEventsResource;
6288
+ }
6289
+ interface ControlsResource {
6290
+ /** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
6291
+ create(request: {
6292
+ /** V1 error format. */
6293
+ '$.xgafv'?: string;
6294
+ /** OAuth access token. */
6295
+ access_token?: string;
6296
+ /** Data format for response. */
6297
+ alt?: string;
6298
+ /** JSONP */
6299
+ callback?: string;
6300
+ /** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
6301
+ controlId?: string;
6302
+ /** Selector specifying which fields to include in a partial response. */
6303
+ fields?: string;
6304
+ /** 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. */
6305
+ key?: string;
6306
+ /** OAuth 2.0 token for the current user. */
6307
+ oauth_token?: string;
6308
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6309
+ parent: string;
6310
+ /** Returns response with indentations and line breaks. */
6311
+ prettyPrint?: boolean;
6312
+ /** 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. */
6313
+ quotaUser?: string;
6314
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6315
+ upload_protocol?: string;
6316
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6317
+ uploadType?: string;
6318
+ /** Request body */
6319
+ resource: GoogleCloudDiscoveryengineV1betaControl;
6320
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
6321
+ create(
6322
+ request: {
6323
+ /** V1 error format. */
6324
+ '$.xgafv'?: string;
6325
+ /** OAuth access token. */
6326
+ access_token?: string;
6327
+ /** Data format for response. */
6328
+ alt?: string;
6329
+ /** JSONP */
6330
+ callback?: string;
6331
+ /** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
6332
+ controlId?: string;
6333
+ /** Selector specifying which fields to include in a partial response. */
6334
+ fields?: string;
6335
+ /** 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. */
6336
+ key?: string;
6337
+ /** OAuth 2.0 token for the current user. */
6338
+ oauth_token?: string;
6339
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6340
+ parent: string;
6341
+ /** Returns response with indentations and line breaks. */
6342
+ prettyPrint?: boolean;
6343
+ /** 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. */
6344
+ quotaUser?: string;
6345
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6346
+ upload_protocol?: string;
6347
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6348
+ uploadType?: string;
6349
+ },
6350
+ body: GoogleCloudDiscoveryengineV1betaControl
6351
+ ): Request<GoogleCloudDiscoveryengineV1betaControl>;
6352
+ /** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
6353
+ delete(request?: {
6354
+ /** V1 error format. */
6355
+ '$.xgafv'?: string;
6356
+ /** OAuth access token. */
6357
+ access_token?: string;
6358
+ /** Data format for response. */
6359
+ alt?: string;
6360
+ /** JSONP */
6361
+ callback?: string;
6362
+ /** Selector specifying which fields to include in a partial response. */
6363
+ fields?: string;
6364
+ /** 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. */
6365
+ key?: string;
6366
+ /** Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
6367
+ name: string;
6368
+ /** OAuth 2.0 token for the current user. */
6369
+ oauth_token?: string;
6370
+ /** Returns response with indentations and line breaks. */
6371
+ prettyPrint?: boolean;
6372
+ /** 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. */
6373
+ quotaUser?: string;
6374
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6375
+ upload_protocol?: string;
6376
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6377
+ uploadType?: string;
6378
+ }): Request<{}>;
6379
+ /** Gets a Control. */
6380
+ get(request?: {
6381
+ /** V1 error format. */
6382
+ '$.xgafv'?: string;
6383
+ /** OAuth access token. */
6384
+ access_token?: string;
6385
+ /** Data format for response. */
6386
+ alt?: string;
6387
+ /** JSONP */
6388
+ callback?: string;
6389
+ /** Selector specifying which fields to include in a partial response. */
6390
+ fields?: string;
6391
+ /** 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. */
6392
+ key?: string;
6393
+ /** Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
6394
+ name: string;
6395
+ /** OAuth 2.0 token for the current user. */
6396
+ oauth_token?: string;
6397
+ /** Returns response with indentations and line breaks. */
6398
+ prettyPrint?: boolean;
6399
+ /** 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. */
6400
+ quotaUser?: string;
6401
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6402
+ upload_protocol?: string;
6403
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6404
+ uploadType?: string;
6405
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
6406
+ /** Lists all Controls by their parent DataStore. */
6407
+ list(request?: {
6408
+ /** V1 error format. */
6409
+ '$.xgafv'?: string;
6410
+ /** OAuth access token. */
6411
+ access_token?: string;
6412
+ /** Data format for response. */
6413
+ alt?: string;
6414
+ /** JSONP */
6415
+ callback?: string;
6416
+ /** Selector specifying which fields to include in a partial response. */
6417
+ fields?: string;
6418
+ /** Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */
6419
+ filter?: string;
6420
+ /** 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. */
6421
+ key?: string;
6422
+ /** OAuth 2.0 token for the current user. */
6423
+ oauth_token?: string;
6424
+ /** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
6425
+ pageSize?: number;
6426
+ /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
6427
+ pageToken?: string;
6428
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6429
+ parent: string;
6430
+ /** Returns response with indentations and line breaks. */
6431
+ prettyPrint?: boolean;
6432
+ /** 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. */
6433
+ quotaUser?: string;
6434
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6435
+ upload_protocol?: string;
6436
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6437
+ uploadType?: string;
6438
+ }): Request<GoogleCloudDiscoveryengineV1betaListControlsResponse>;
6439
+ /** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
6440
+ patch(request: {
6441
+ /** V1 error format. */
6442
+ '$.xgafv'?: string;
6443
+ /** OAuth access token. */
6444
+ access_token?: string;
6445
+ /** Data format for response. */
6446
+ alt?: string;
6447
+ /** JSONP */
6448
+ callback?: string;
6449
+ /** Selector specifying which fields to include in a partial response. */
6450
+ fields?: string;
6451
+ /** 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. */
6452
+ key?: string;
6453
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
6454
+ name: string;
6455
+ /** OAuth 2.0 token for the current user. */
6456
+ oauth_token?: string;
6457
+ /** Returns response with indentations and line breaks. */
6458
+ prettyPrint?: boolean;
6459
+ /** 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. */
6460
+ quotaUser?: string;
6461
+ /** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
6462
+ updateMask?: string;
6463
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6464
+ upload_protocol?: string;
6465
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6466
+ uploadType?: string;
6467
+ /** Request body */
6468
+ resource: GoogleCloudDiscoveryengineV1betaControl;
6469
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
6470
+ patch(
5761
6471
  request: {
5762
6472
  /** V1 error format. */
5763
6473
  '$.xgafv'?: string;
@@ -5767,36 +6477,27 @@ declare namespace gapi.client {
5767
6477
  alt?: string;
5768
6478
  /** JSONP */
5769
6479
  callback?: string;
5770
- /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
5771
- dataStore: string;
5772
6480
  /** Selector specifying which fields to include in a partial response. */
5773
6481
  fields?: string;
5774
6482
  /** 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. */
5775
6483
  key?: string;
6484
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
6485
+ name: string;
5776
6486
  /** OAuth 2.0 token for the current user. */
5777
6487
  oauth_token?: string;
5778
6488
  /** Returns response with indentations and line breaks. */
5779
6489
  prettyPrint?: boolean;
5780
6490
  /** 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. */
5781
6491
  quotaUser?: string;
6492
+ /** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
6493
+ updateMask?: string;
5782
6494
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5783
6495
  upload_protocol?: string;
5784
6496
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5785
6497
  uploadType?: string;
5786
6498
  },
5787
- body: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest
5788
- ): Request<GoogleLongrunningOperation>;
5789
- branches: BranchesResource;
5790
- conversations: ConversationsResource;
5791
- customModels: CustomModelsResource;
5792
- models: ModelsResource;
5793
- operations: OperationsResource;
5794
- schemas: SchemasResource;
5795
- servingConfigs: ServingConfigsResource;
5796
- sessions: SessionsResource;
5797
- siteSearchEngine: SiteSearchEngineResource;
5798
- suggestionDenyListEntries: SuggestionDenyListEntriesResource;
5799
- userEvents: UserEventsResource;
6499
+ body: GoogleCloudDiscoveryengineV1betaControl
6500
+ ): Request<GoogleCloudDiscoveryengineV1betaControl>;
5800
6501
  }
5801
6502
  interface ConversationsResource {
5802
6503
  /** Converses a conversation. */
@@ -6328,7 +7029,7 @@ declare namespace gapi.client {
6328
7029
  prettyPrint?: boolean;
6329
7030
  /** 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. */
6330
7031
  quotaUser?: string;
6331
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
7032
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6332
7033
  servingConfig: string;
6333
7034
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6334
7035
  upload_protocol?: string;
@@ -6357,7 +7058,7 @@ declare namespace gapi.client {
6357
7058
  prettyPrint?: boolean;
6358
7059
  /** 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. */
6359
7060
  quotaUser?: string;
6360
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
7061
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6361
7062
  servingConfig: string;
6362
7063
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6363
7064
  upload_protocol?: string;
@@ -7052,6 +7753,7 @@ declare namespace gapi.client {
7052
7753
  },
7053
7754
  body: GoogleCloudDiscoveryengineV1betaTuneEngineRequest
7054
7755
  ): Request<GoogleLongrunningOperation>;
7756
+ controls: ControlsResource;
7055
7757
  conversations: ConversationsResource;
7056
7758
  operations: OperationsResource;
7057
7759
  servingConfigs: ServingConfigsResource;
@@ -7136,7 +7838,7 @@ declare namespace gapi.client {
7136
7838
  alt?: string;
7137
7839
  /** JSONP */
7138
7840
  callback?: string;
7139
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7841
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7140
7842
  documentId?: string;
7141
7843
  /** Selector specifying which fields to include in a partial response. */
7142
7844
  fields?: string;
@@ -7167,7 +7869,7 @@ declare namespace gapi.client {
7167
7869
  alt?: string;
7168
7870
  /** JSONP */
7169
7871
  callback?: string;
7170
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7872
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7171
7873
  documentId?: string;
7172
7874
  /** Selector specifying which fields to include in a partial response. */
7173
7875
  fields?: string;
@@ -7242,7 +7944,7 @@ declare namespace gapi.client {
7242
7944
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7243
7945
  uploadType?: string;
7244
7946
  }): Request<GoogleCloudDiscoveryengineV1betaDocument>;
7245
- /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. */
7947
+ /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. */
7246
7948
  import(request: {
7247
7949
  /** V1 error format. */
7248
7950
  '$.xgafv'?: string;
@@ -7316,7 +8018,7 @@ declare namespace gapi.client {
7316
8018
  key?: string;
7317
8019
  /** OAuth 2.0 token for the current user. */
7318
8020
  oauth_token?: string;
7319
- /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
8021
+ /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
7320
8022
  pageSize?: number;
7321
8023
  /** A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7322
8024
  pageToken?: string;
@@ -7337,7 +8039,7 @@ declare namespace gapi.client {
7337
8039
  '$.xgafv'?: string;
7338
8040
  /** OAuth access token. */
7339
8041
  access_token?: string;
7340
- /** If set to true, and the Document is not found, a new Document will be created. */
8042
+ /** If set to `true` and the Document is not found, a new Document is be created. */
7341
8043
  allowMissing?: boolean;
7342
8044
  /** Data format for response. */
7343
8045
  alt?: string;
@@ -7355,7 +8057,7 @@ declare namespace gapi.client {
7355
8057
  prettyPrint?: boolean;
7356
8058
  /** 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. */
7357
8059
  quotaUser?: string;
7358
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
8060
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
7359
8061
  updateMask?: string;
7360
8062
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7361
8063
  upload_protocol?: string;
@@ -7370,7 +8072,7 @@ declare namespace gapi.client {
7370
8072
  '$.xgafv'?: string;
7371
8073
  /** OAuth access token. */
7372
8074
  access_token?: string;
7373
- /** If set to true, and the Document is not found, a new Document will be created. */
8075
+ /** If set to `true` and the Document is not found, a new Document is be created. */
7374
8076
  allowMissing?: boolean;
7375
8077
  /** Data format for response. */
7376
8078
  alt?: string;
@@ -7388,7 +8090,7 @@ declare namespace gapi.client {
7388
8090
  prettyPrint?: boolean;
7389
8091
  /** 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. */
7390
8092
  quotaUser?: string;
7391
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
8093
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
7392
8094
  updateMask?: string;
7393
8095
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7394
8096
  upload_protocol?: string;
@@ -7580,6 +8282,219 @@ declare namespace gapi.client {
7580
8282
  documents: DocumentsResource;
7581
8283
  operations: OperationsResource;
7582
8284
  }
8285
+ interface ControlsResource {
8286
+ /** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
8287
+ create(request: {
8288
+ /** V1 error format. */
8289
+ '$.xgafv'?: string;
8290
+ /** OAuth access token. */
8291
+ access_token?: string;
8292
+ /** Data format for response. */
8293
+ alt?: string;
8294
+ /** JSONP */
8295
+ callback?: string;
8296
+ /** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
8297
+ controlId?: string;
8298
+ /** Selector specifying which fields to include in a partial response. */
8299
+ fields?: string;
8300
+ /** 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. */
8301
+ key?: string;
8302
+ /** OAuth 2.0 token for the current user. */
8303
+ oauth_token?: string;
8304
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
8305
+ parent: string;
8306
+ /** Returns response with indentations and line breaks. */
8307
+ prettyPrint?: boolean;
8308
+ /** 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. */
8309
+ quotaUser?: string;
8310
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8311
+ upload_protocol?: string;
8312
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8313
+ uploadType?: string;
8314
+ /** Request body */
8315
+ resource: GoogleCloudDiscoveryengineV1betaControl;
8316
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
8317
+ create(
8318
+ request: {
8319
+ /** V1 error format. */
8320
+ '$.xgafv'?: string;
8321
+ /** OAuth access token. */
8322
+ access_token?: string;
8323
+ /** Data format for response. */
8324
+ alt?: string;
8325
+ /** JSONP */
8326
+ callback?: string;
8327
+ /** Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */
8328
+ controlId?: string;
8329
+ /** Selector specifying which fields to include in a partial response. */
8330
+ fields?: string;
8331
+ /** 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. */
8332
+ key?: string;
8333
+ /** OAuth 2.0 token for the current user. */
8334
+ oauth_token?: string;
8335
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
8336
+ parent: string;
8337
+ /** Returns response with indentations and line breaks. */
8338
+ prettyPrint?: boolean;
8339
+ /** 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. */
8340
+ quotaUser?: string;
8341
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8342
+ upload_protocol?: string;
8343
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8344
+ uploadType?: string;
8345
+ },
8346
+ body: GoogleCloudDiscoveryengineV1betaControl
8347
+ ): Request<GoogleCloudDiscoveryengineV1betaControl>;
8348
+ /** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
8349
+ delete(request?: {
8350
+ /** V1 error format. */
8351
+ '$.xgafv'?: string;
8352
+ /** OAuth access token. */
8353
+ access_token?: string;
8354
+ /** Data format for response. */
8355
+ alt?: string;
8356
+ /** JSONP */
8357
+ callback?: string;
8358
+ /** Selector specifying which fields to include in a partial response. */
8359
+ fields?: string;
8360
+ /** 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. */
8361
+ key?: string;
8362
+ /** Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
8363
+ name: string;
8364
+ /** OAuth 2.0 token for the current user. */
8365
+ oauth_token?: string;
8366
+ /** Returns response with indentations and line breaks. */
8367
+ prettyPrint?: boolean;
8368
+ /** 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. */
8369
+ quotaUser?: string;
8370
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8371
+ upload_protocol?: string;
8372
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8373
+ uploadType?: string;
8374
+ }): Request<{}>;
8375
+ /** Gets a Control. */
8376
+ get(request?: {
8377
+ /** V1 error format. */
8378
+ '$.xgafv'?: string;
8379
+ /** OAuth access token. */
8380
+ access_token?: string;
8381
+ /** Data format for response. */
8382
+ alt?: string;
8383
+ /** JSONP */
8384
+ callback?: string;
8385
+ /** Selector specifying which fields to include in a partial response. */
8386
+ fields?: string;
8387
+ /** 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. */
8388
+ key?: string;
8389
+ /** Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
8390
+ name: string;
8391
+ /** OAuth 2.0 token for the current user. */
8392
+ oauth_token?: string;
8393
+ /** Returns response with indentations and line breaks. */
8394
+ prettyPrint?: boolean;
8395
+ /** 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. */
8396
+ quotaUser?: string;
8397
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8398
+ upload_protocol?: string;
8399
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8400
+ uploadType?: string;
8401
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
8402
+ /** Lists all Controls by their parent DataStore. */
8403
+ list(request?: {
8404
+ /** V1 error format. */
8405
+ '$.xgafv'?: string;
8406
+ /** OAuth access token. */
8407
+ access_token?: string;
8408
+ /** Data format for response. */
8409
+ alt?: string;
8410
+ /** JSONP */
8411
+ callback?: string;
8412
+ /** Selector specifying which fields to include in a partial response. */
8413
+ fields?: string;
8414
+ /** Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */
8415
+ filter?: string;
8416
+ /** 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. */
8417
+ key?: string;
8418
+ /** OAuth 2.0 token for the current user. */
8419
+ oauth_token?: string;
8420
+ /** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
8421
+ pageSize?: number;
8422
+ /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
8423
+ pageToken?: string;
8424
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
8425
+ parent: string;
8426
+ /** Returns response with indentations and line breaks. */
8427
+ prettyPrint?: boolean;
8428
+ /** 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. */
8429
+ quotaUser?: string;
8430
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8431
+ upload_protocol?: string;
8432
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8433
+ uploadType?: string;
8434
+ }): Request<GoogleCloudDiscoveryengineV1betaListControlsResponse>;
8435
+ /** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
8436
+ patch(request: {
8437
+ /** V1 error format. */
8438
+ '$.xgafv'?: string;
8439
+ /** OAuth access token. */
8440
+ access_token?: string;
8441
+ /** Data format for response. */
8442
+ alt?: string;
8443
+ /** JSONP */
8444
+ callback?: string;
8445
+ /** Selector specifying which fields to include in a partial response. */
8446
+ fields?: string;
8447
+ /** 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. */
8448
+ key?: string;
8449
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
8450
+ name: string;
8451
+ /** OAuth 2.0 token for the current user. */
8452
+ oauth_token?: string;
8453
+ /** Returns response with indentations and line breaks. */
8454
+ prettyPrint?: boolean;
8455
+ /** 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. */
8456
+ quotaUser?: string;
8457
+ /** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
8458
+ updateMask?: string;
8459
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8460
+ upload_protocol?: string;
8461
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8462
+ uploadType?: string;
8463
+ /** Request body */
8464
+ resource: GoogleCloudDiscoveryengineV1betaControl;
8465
+ }): Request<GoogleCloudDiscoveryengineV1betaControl>;
8466
+ patch(
8467
+ request: {
8468
+ /** V1 error format. */
8469
+ '$.xgafv'?: string;
8470
+ /** OAuth access token. */
8471
+ access_token?: string;
8472
+ /** Data format for response. */
8473
+ alt?: string;
8474
+ /** JSONP */
8475
+ callback?: string;
8476
+ /** Selector specifying which fields to include in a partial response. */
8477
+ fields?: string;
8478
+ /** 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. */
8479
+ key?: string;
8480
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
8481
+ name: string;
8482
+ /** OAuth 2.0 token for the current user. */
8483
+ oauth_token?: string;
8484
+ /** Returns response with indentations and line breaks. */
8485
+ prettyPrint?: boolean;
8486
+ /** 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. */
8487
+ quotaUser?: string;
8488
+ /** Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. */
8489
+ updateMask?: string;
8490
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8491
+ upload_protocol?: string;
8492
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8493
+ uploadType?: string;
8494
+ },
8495
+ body: GoogleCloudDiscoveryengineV1betaControl
8496
+ ): Request<GoogleCloudDiscoveryengineV1betaControl>;
8497
+ }
7583
8498
  interface ConversationsResource {
7584
8499
  /** Converses a conversation. */
7585
8500
  converse(request: {
@@ -7999,7 +8914,7 @@ declare namespace gapi.client {
7999
8914
  prettyPrint?: boolean;
8000
8915
  /** 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. */
8001
8916
  quotaUser?: string;
8002
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8917
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8003
8918
  schemaId?: string;
8004
8919
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8005
8920
  upload_protocol?: string;
@@ -8030,7 +8945,7 @@ declare namespace gapi.client {
8030
8945
  prettyPrint?: boolean;
8031
8946
  /** 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. */
8032
8947
  quotaUser?: string;
8033
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8948
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8034
8949
  schemaId?: string;
8035
8950
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8036
8951
  upload_protocol?: string;
@@ -8109,7 +9024,7 @@ declare namespace gapi.client {
8109
9024
  key?: string;
8110
9025
  /** OAuth 2.0 token for the current user. */
8111
9026
  oauth_token?: string;
8112
- /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
9027
+ /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */
8113
9028
  pageSize?: number;
8114
9029
  /** A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */
8115
9030
  pageToken?: string;
@@ -8130,7 +9045,7 @@ declare namespace gapi.client {
8130
9045
  '$.xgafv'?: string;
8131
9046
  /** OAuth access token. */
8132
9047
  access_token?: string;
8133
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
9048
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
8134
9049
  allowMissing?: boolean;
8135
9050
  /** Data format for response. */
8136
9051
  alt?: string;
@@ -8161,7 +9076,7 @@ declare namespace gapi.client {
8161
9076
  '$.xgafv'?: string;
8162
9077
  /** OAuth access token. */
8163
9078
  access_token?: string;
8164
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
9079
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
8165
9080
  allowMissing?: boolean;
8166
9081
  /** Data format for response. */
8167
9082
  alt?: string;
@@ -8386,7 +9301,7 @@ declare namespace gapi.client {
8386
9301
  prettyPrint?: boolean;
8387
9302
  /** 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. */
8388
9303
  quotaUser?: string;
8389
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
9304
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
8390
9305
  servingConfig: string;
8391
9306
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8392
9307
  upload_protocol?: string;
@@ -8415,7 +9330,7 @@ declare namespace gapi.client {
8415
9330
  prettyPrint?: boolean;
8416
9331
  /** 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. */
8417
9332
  quotaUser?: string;
8418
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
9333
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
8419
9334
  servingConfig: string;
8420
9335
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8421
9336
  upload_protocol?: string;
@@ -9314,7 +10229,7 @@ declare namespace gapi.client {
9314
10229
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
9315
10230
  userEvent?: string;
9316
10231
  }): Request<GoogleApiHttpBody>;
9317
- /** Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
10232
+ /** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
9318
10233
  import(request: {
9319
10234
  /** V1 error format. */
9320
10235
  '$.xgafv'?: string;
@@ -9398,6 +10313,8 @@ declare namespace gapi.client {
9398
10313
  upload_protocol?: string;
9399
10314
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9400
10315
  uploadType?: string;
10316
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
10317
+ writeAsync?: boolean;
9401
10318
  /** Request body */
9402
10319
  resource: GoogleCloudDiscoveryengineV1betaUserEvent;
9403
10320
  }): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
@@ -9427,6 +10344,8 @@ declare namespace gapi.client {
9427
10344
  upload_protocol?: string;
9428
10345
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9429
10346
  uploadType?: string;
10347
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
10348
+ writeAsync?: boolean;
9430
10349
  },
9431
10350
  body: GoogleCloudDiscoveryengineV1betaUserEvent
9432
10351
  ): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
@@ -9626,7 +10545,7 @@ declare namespace gapi.client {
9626
10545
  callback?: string;
9627
10546
  /** Selector specifying which fields to include in a partial response. */
9628
10547
  fields?: string;
9629
- /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
10548
+ /** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
9630
10549
  filter?: string;
9631
10550
  /** 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. */
9632
10551
  key?: string;
@@ -9710,6 +10629,7 @@ declare namespace gapi.client {
9710
10629
  body: GoogleCloudDiscoveryengineV1betaDataStore
9711
10630
  ): Request<GoogleCloudDiscoveryengineV1betaDataStore>;
9712
10631
  branches: BranchesResource;
10632
+ controls: ControlsResource;
9713
10633
  conversations: ConversationsResource;
9714
10634
  models: ModelsResource;
9715
10635
  operations: OperationsResource;
@@ -9929,6 +10849,8 @@ declare namespace gapi.client {
9929
10849
  upload_protocol?: string;
9930
10850
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9931
10851
  uploadType?: string;
10852
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
10853
+ writeAsync?: boolean;
9932
10854
  /** Request body */
9933
10855
  resource: GoogleCloudDiscoveryengineV1betaUserEvent;
9934
10856
  }): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
@@ -9958,6 +10880,8 @@ declare namespace gapi.client {
9958
10880
  upload_protocol?: string;
9959
10881
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9960
10882
  uploadType?: string;
10883
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
10884
+ writeAsync?: boolean;
9961
10885
  },
9962
10886
  body: GoogleCloudDiscoveryengineV1betaUserEvent
9963
10887
  ): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
@@ -10033,6 +10957,64 @@ declare namespace gapi.client {
10033
10957
  }): Request<GoogleLongrunningListOperationsResponse>;
10034
10958
  }
10035
10959
  interface ProjectsResource {
10960
+ /** Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. */
10961
+ provision(request: {
10962
+ /** V1 error format. */
10963
+ '$.xgafv'?: string;
10964
+ /** OAuth access token. */
10965
+ access_token?: string;
10966
+ /** Data format for response. */
10967
+ alt?: string;
10968
+ /** JSONP */
10969
+ callback?: string;
10970
+ /** Selector specifying which fields to include in a partial response. */
10971
+ fields?: string;
10972
+ /** 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. */
10973
+ key?: string;
10974
+ /** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
10975
+ name: string;
10976
+ /** OAuth 2.0 token for the current user. */
10977
+ oauth_token?: string;
10978
+ /** Returns response with indentations and line breaks. */
10979
+ prettyPrint?: boolean;
10980
+ /** 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. */
10981
+ quotaUser?: string;
10982
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10983
+ upload_protocol?: string;
10984
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10985
+ uploadType?: string;
10986
+ /** Request body */
10987
+ resource: GoogleCloudDiscoveryengineV1betaProvisionProjectRequest;
10988
+ }): Request<GoogleLongrunningOperation>;
10989
+ provision(
10990
+ request: {
10991
+ /** V1 error format. */
10992
+ '$.xgafv'?: string;
10993
+ /** OAuth access token. */
10994
+ access_token?: string;
10995
+ /** Data format for response. */
10996
+ alt?: string;
10997
+ /** JSONP */
10998
+ callback?: string;
10999
+ /** Selector specifying which fields to include in a partial response. */
11000
+ fields?: string;
11001
+ /** 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. */
11002
+ key?: string;
11003
+ /** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
11004
+ name: string;
11005
+ /** OAuth 2.0 token for the current user. */
11006
+ oauth_token?: string;
11007
+ /** Returns response with indentations and line breaks. */
11008
+ prettyPrint?: boolean;
11009
+ /** 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. */
11010
+ quotaUser?: string;
11011
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11012
+ upload_protocol?: string;
11013
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11014
+ uploadType?: string;
11015
+ },
11016
+ body: GoogleCloudDiscoveryengineV1betaProvisionProjectRequest
11017
+ ): Request<GoogleLongrunningOperation>;
10036
11018
  locations: LocationsResource;
10037
11019
  operations: OperationsResource;
10038
11020
  }