@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240517 → 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 +1006 -24
  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: 20240517
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;
@@ -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
  }
@@ -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;
@@ -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 {
@@ -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,6 +1971,8 @@ 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. */
@@ -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. */
@@ -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;
@@ -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;
@@ -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: {
@@ -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. */
@@ -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;
@@ -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: {
@@ -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
  }