@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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 (2) hide show
  1. package/index.d.ts +1034 -120
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20240517
12
+ // Revision: 20240526
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -149,6 +149,8 @@ declare namespace gapi.client {
149
149
  answerLanguageCode?: string;
150
150
  /** 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. */
151
151
  ignoreAdversarialQuery?: boolean;
152
+ /** 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. */
153
+ ignoreLowRelevantContent?: boolean;
152
154
  /** 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. */
153
155
  ignoreNonAnswerSeekingQuery?: boolean;
154
156
  /** Specifies whether to include citation metadata in the answer. The default value is `false`. */
@@ -201,6 +203,8 @@ declare namespace gapi.client {
201
203
  boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
202
204
  /** Custom fine tuning configs. */
203
205
  customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
206
+ /** 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. */
207
+ dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
204
208
  /** 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) */
205
209
  filter?: string;
206
210
  /** Number of search results to return. The default value is 10. */
@@ -297,6 +301,8 @@ declare namespace gapi.client {
297
301
  document?: string;
298
302
  /** Page identifier. */
299
303
  pageIdentifier?: string;
304
+ /** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
305
+ structData?: {[P in string]: any};
300
306
  /** Title. */
301
307
  title?: string;
302
308
  /** URI for the document. */
@@ -307,6 +313,8 @@ declare namespace gapi.client {
307
313
  chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
308
314
  /** Document resource name. */
309
315
  document?: string;
316
+ /** The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */
317
+ structData?: {[P in string]: any};
310
318
  /** Title. */
311
319
  title?: string;
312
320
  /** URI for the document. */
@@ -484,7 +492,7 @@ declare namespace gapi.client {
484
492
  name?: string;
485
493
  /** Page span of the chunk. */
486
494
  pageSpan?: GoogleCloudDiscoveryengineV1alphaChunkPageSpan;
487
- /** Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse */
495
+ /** Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. */
488
496
  relevanceScore?: number;
489
497
  }
490
498
  interface GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
@@ -539,6 +547,68 @@ declare namespace gapi.client {
539
547
  /** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
540
548
  selectedSuggestion?: string;
541
549
  }
550
+ interface GoogleCloudDiscoveryengineV1alphaCondition {
551
+ /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
552
+ activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
553
+ /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
554
+ queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
555
+ }
556
+ interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
557
+ /** Whether the search query needs to exactly match the query term. */
558
+ fullMatch?: boolean;
559
+ /** 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. */
560
+ value?: string;
561
+ }
562
+ interface GoogleCloudDiscoveryengineV1alphaConditionTimeRange {
563
+ /** End of time range. Range is inclusive. Must be in the future. */
564
+ endTime?: string;
565
+ /** Start of time range. Range is inclusive. */
566
+ startTime?: string;
567
+ }
568
+ interface GoogleCloudDiscoveryengineV1alphaControl {
569
+ /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
570
+ associatedServingConfigIds?: string[];
571
+ /** Defines a boost-type control */
572
+ boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
573
+ /** 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. */
574
+ conditions?: GoogleCloudDiscoveryengineV1alphaCondition[];
575
+ /** 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. */
576
+ displayName?: string;
577
+ /** Defines a filter-type control Currently not supported by Recommendation */
578
+ filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
579
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
580
+ name?: string;
581
+ /** Defines a redirect-type control. */
582
+ redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
583
+ /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
584
+ solutionType?: string;
585
+ /** Treats a group of terms as synonyms of one another. */
586
+ synonymsAction?: GoogleCloudDiscoveryengineV1alphaControlSynonymsAction;
587
+ /** 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. */
588
+ useCases?: string[];
589
+ }
590
+ interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
591
+ /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
592
+ boost?: number;
593
+ /** 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 */
594
+ dataStore?: string;
595
+ /** 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. */
596
+ filter?: string;
597
+ }
598
+ interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
599
+ /** 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 */
600
+ dataStore?: string;
601
+ /** 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. */
602
+ filter?: string;
603
+ }
604
+ interface GoogleCloudDiscoveryengineV1alphaControlRedirectAction {
605
+ /** 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. */
606
+ redirectUri?: string;
607
+ }
608
+ interface GoogleCloudDiscoveryengineV1alphaControlSynonymsAction {
609
+ /** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
610
+ synonyms?: string[];
611
+ }
542
612
  interface GoogleCloudDiscoveryengineV1alphaConversation {
543
613
  /** Output only. The time the conversation finished. */
544
614
  endTime?: string;
@@ -642,6 +712,7 @@ declare namespace gapi.client {
642
712
  displayName?: string;
643
713
  /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
644
714
  modelState?: string;
715
+ /** The version of the model. */
645
716
  modelVersion?: string;
646
717
  /** 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. */
647
718
  name?: string;
@@ -859,7 +930,7 @@ declare namespace gapi.client {
859
930
  dialogflowAgent?: string;
860
931
  }
861
932
  interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
862
- /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
933
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
863
934
  companyName?: string;
864
935
  }
865
936
  interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
@@ -972,6 +1043,8 @@ declare namespace gapi.client {
972
1043
  recsFilterableOption?: string;
973
1044
  /** 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. */
974
1045
  retrievableOption?: string;
1046
+ /** 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 */
1047
+ schemaOrgPaths?: string[];
975
1048
  /** 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. */
976
1049
  searchableOption?: string;
977
1050
  }
@@ -1143,6 +1216,12 @@ declare namespace gapi.client {
1143
1216
  /** A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1144
1217
  nextPageToken?: string;
1145
1218
  }
1219
+ interface GoogleCloudDiscoveryengineV1alphaListControlsResponse {
1220
+ /** All the Controls for a given data store. */
1221
+ controls?: GoogleCloudDiscoveryengineV1alphaControl[];
1222
+ /** Pagination token, if not returned indicates the last page. */
1223
+ nextPageToken?: string;
1224
+ }
1146
1225
  interface GoogleCloudDiscoveryengineV1alphaListConversationsResponse {
1147
1226
  /** All the Conversations for a given data store. */
1148
1227
  conversations?: GoogleCloudDiscoveryengineV1alphaConversation[];
@@ -1359,6 +1438,8 @@ declare namespace gapi.client {
1359
1438
  records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
1360
1439
  /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
1361
1440
  topN?: number;
1441
+ /** 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. */
1442
+ userLabels?: {[P in string]: string};
1362
1443
  }
1363
1444
  interface GoogleCloudDiscoveryengineV1alphaRankResponse {
1364
1445
  /** A list of records sorted by descending score. */
@@ -1560,7 +1641,7 @@ declare namespace gapi.client {
1560
1641
  chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
1561
1642
  /** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
1562
1643
  extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
1563
- /** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. */
1644
+ /** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
1564
1645
  searchResultMode?: string;
1565
1646
  /** If `snippetSpec` is not specified, snippets are not included in the search response. */
1566
1647
  snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
@@ -2027,10 +2108,14 @@ declare namespace gapi.client {
2027
2108
  attributionToken?: string;
2028
2109
  /** 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. */
2029
2110
  completionInfo?: GoogleCloudDiscoveryengineV1alphaCompletionInfo;
2111
+ /** 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. */
2112
+ dataStore?: string;
2030
2113
  /** 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. */
2031
2114
  directUserRequest?: boolean;
2032
2115
  /** 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. */
2033
2116
  documents?: GoogleCloudDiscoveryengineV1alphaDocumentInfo[];
2117
+ /** 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. */
2118
+ engine?: string;
2034
2119
  /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
2035
2120
  eventTime?: string;
2036
2121
  /** 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. */
@@ -2084,6 +2169,68 @@ declare namespace gapi.client {
2084
2169
  /** TargetSites created. */
2085
2170
  targetSites?: GoogleCloudDiscoveryengineV1betaTargetSite[];
2086
2171
  }
2172
+ interface GoogleCloudDiscoveryengineV1betaCondition {
2173
+ /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
2174
+ activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
2175
+ /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
2176
+ queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
2177
+ }
2178
+ interface GoogleCloudDiscoveryengineV1betaConditionQueryTerm {
2179
+ /** Whether the search query needs to exactly match the query term. */
2180
+ fullMatch?: boolean;
2181
+ /** 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. */
2182
+ value?: string;
2183
+ }
2184
+ interface GoogleCloudDiscoveryengineV1betaConditionTimeRange {
2185
+ /** End of time range. Range is inclusive. Must be in the future. */
2186
+ endTime?: string;
2187
+ /** Start of time range. Range is inclusive. */
2188
+ startTime?: string;
2189
+ }
2190
+ interface GoogleCloudDiscoveryengineV1betaControl {
2191
+ /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
2192
+ associatedServingConfigIds?: string[];
2193
+ /** Defines a boost-type control */
2194
+ boostAction?: GoogleCloudDiscoveryengineV1betaControlBoostAction;
2195
+ /** 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. */
2196
+ conditions?: GoogleCloudDiscoveryengineV1betaCondition[];
2197
+ /** 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. */
2198
+ displayName?: string;
2199
+ /** Defines a filter-type control Currently not supported by Recommendation */
2200
+ filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
2201
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
2202
+ name?: string;
2203
+ /** Defines a redirect-type control. */
2204
+ redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
2205
+ /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
2206
+ solutionType?: string;
2207
+ /** Treats a group of terms as synonyms of one another. */
2208
+ synonymsAction?: GoogleCloudDiscoveryengineV1betaControlSynonymsAction;
2209
+ /** 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. */
2210
+ useCases?: string[];
2211
+ }
2212
+ interface GoogleCloudDiscoveryengineV1betaControlBoostAction {
2213
+ /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
2214
+ boost?: number;
2215
+ /** 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 */
2216
+ dataStore?: string;
2217
+ /** 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. */
2218
+ filter?: string;
2219
+ }
2220
+ interface GoogleCloudDiscoveryengineV1betaControlFilterAction {
2221
+ /** 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 */
2222
+ dataStore?: string;
2223
+ /** 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. */
2224
+ filter?: string;
2225
+ }
2226
+ interface GoogleCloudDiscoveryengineV1betaControlRedirectAction {
2227
+ /** 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. */
2228
+ redirectUri?: string;
2229
+ }
2230
+ interface GoogleCloudDiscoveryengineV1betaControlSynonymsAction {
2231
+ /** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
2232
+ synonyms?: string[];
2233
+ }
2087
2234
  interface GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
2088
2235
  /** Operation create time. */
2089
2236
  createTime?: string;
@@ -2115,6 +2262,7 @@ declare namespace gapi.client {
2115
2262
  displayName?: string;
2116
2263
  /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
2117
2264
  modelState?: string;
2265
+ /** The version of the model. */
2118
2266
  modelVersion?: string;
2119
2267
  /** 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. */
2120
2268
  name?: string;
@@ -2247,7 +2395,7 @@ declare namespace gapi.client {
2247
2395
  dialogflowAgent?: string;
2248
2396
  }
2249
2397
  interface GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
2250
- /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
2398
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
2251
2399
  companyName?: string;
2252
2400
  }
2253
2401
  interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
@@ -2316,6 +2464,31 @@ declare namespace gapi.client {
2316
2464
  /** List of custom tuning models. */
2317
2465
  models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
2318
2466
  }
2467
+ interface GoogleCloudDiscoveryengineV1betaProject {
2468
+ /** Output only. The timestamp when this project is created. */
2469
+ createTime?: string;
2470
+ /** 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. */
2471
+ name?: string;
2472
+ /** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
2473
+ provisionCompletionTime?: string;
2474
+ /** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
2475
+ serviceTermsMap?: {
2476
+ [P in string]: GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
2477
+ };
2478
+ }
2479
+ interface GoogleCloudDiscoveryengineV1betaProjectServiceTerms {
2480
+ /** The last time when the project agreed to the terms of service. */
2481
+ acceptTime?: string;
2482
+ /** The last time when the project declined or revoked the agreement to terms of service. */
2483
+ declineTime?: string;
2484
+ /** 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`. */
2485
+ id?: string;
2486
+ /** Whether the project has accepted/rejected the service terms or it is still pending. */
2487
+ state?: string;
2488
+ /** The version string of the terms of service. For acceptable values, see the comments for id above. */
2489
+ version?: string;
2490
+ }
2491
+ interface GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {}
2319
2492
  interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
2320
2493
  /** Operation create time. */
2321
2494
  createTime?: string;
@@ -2425,6 +2598,68 @@ declare namespace gapi.client {
2425
2598
  /** Operation last update time. If the operation is done, this is also the finish time. */
2426
2599
  updateTime?: string;
2427
2600
  }
2601
+ interface GoogleCloudDiscoveryengineV1Condition {
2602
+ /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
2603
+ activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
2604
+ /** Search only A list of terms to match the query on. Maximum of 10 query terms. */
2605
+ queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
2606
+ }
2607
+ interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
2608
+ /** Whether the search query needs to exactly match the query term. */
2609
+ fullMatch?: boolean;
2610
+ /** 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. */
2611
+ value?: string;
2612
+ }
2613
+ interface GoogleCloudDiscoveryengineV1ConditionTimeRange {
2614
+ /** End of time range. Range is inclusive. Must be in the future. */
2615
+ endTime?: string;
2616
+ /** Start of time range. Range is inclusive. */
2617
+ startTime?: string;
2618
+ }
2619
+ interface GoogleCloudDiscoveryengineV1Control {
2620
+ /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
2621
+ associatedServingConfigIds?: string[];
2622
+ /** Defines a boost-type control */
2623
+ boostAction?: GoogleCloudDiscoveryengineV1ControlBoostAction;
2624
+ /** 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. */
2625
+ conditions?: GoogleCloudDiscoveryengineV1Condition[];
2626
+ /** 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. */
2627
+ displayName?: string;
2628
+ /** Defines a filter-type control Currently not supported by Recommendation */
2629
+ filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
2630
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
2631
+ name?: string;
2632
+ /** Defines a redirect-type control. */
2633
+ redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
2634
+ /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
2635
+ solutionType?: string;
2636
+ /** Treats a group of terms as synonyms of one another. */
2637
+ synonymsAction?: GoogleCloudDiscoveryengineV1ControlSynonymsAction;
2638
+ /** 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. */
2639
+ useCases?: string[];
2640
+ }
2641
+ interface GoogleCloudDiscoveryengineV1ControlBoostAction {
2642
+ /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
2643
+ boost?: number;
2644
+ /** 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 */
2645
+ dataStore?: string;
2646
+ /** 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. */
2647
+ filter?: string;
2648
+ }
2649
+ interface GoogleCloudDiscoveryengineV1ControlFilterAction {
2650
+ /** 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 */
2651
+ dataStore?: string;
2652
+ /** 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. */
2653
+ filter?: string;
2654
+ }
2655
+ interface GoogleCloudDiscoveryengineV1ControlRedirectAction {
2656
+ /** 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. */
2657
+ redirectUri?: string;
2658
+ }
2659
+ interface GoogleCloudDiscoveryengineV1ControlSynonymsAction {
2660
+ /** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
2661
+ synonyms?: string[];
2662
+ }
2428
2663
  interface GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
2429
2664
  /** Operation create time. */
2430
2665
  createTime?: string;
@@ -2575,7 +2810,7 @@ declare namespace gapi.client {
2575
2810
  dialogflowAgent?: string;
2576
2811
  }
2577
2812
  interface GoogleCloudDiscoveryengineV1EngineCommonConfig {
2578
- /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
2813
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
2579
2814
  companyName?: string;
2580
2815
  }
2581
2816
  interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
@@ -2640,6 +2875,31 @@ declare namespace gapi.client {
2640
2875
  /** Count of user events imported, but with Document information not found in the existing Branch. */
2641
2876
  unjoinedEventsCount?: string;
2642
2877
  }
2878
+ interface GoogleCloudDiscoveryengineV1Project {
2879
+ /** Output only. The timestamp when this project is created. */
2880
+ createTime?: string;
2881
+ /** 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. */
2882
+ name?: string;
2883
+ /** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
2884
+ provisionCompletionTime?: string;
2885
+ /** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
2886
+ serviceTermsMap?: {
2887
+ [P in string]: GoogleCloudDiscoveryengineV1ProjectServiceTerms;
2888
+ };
2889
+ }
2890
+ interface GoogleCloudDiscoveryengineV1ProjectServiceTerms {
2891
+ /** The last time when the project agreed to the terms of service. */
2892
+ acceptTime?: string;
2893
+ /** The last time when the project declined or revoked the agreement to terms of service. */
2894
+ declineTime?: string;
2895
+ /** 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`. */
2896
+ id?: string;
2897
+ /** Whether the project has accepted/rejected the service terms or it is still pending. */
2898
+ state?: string;
2899
+ /** The version string of the terms of service. For acceptable values, see the comments for id above. */
2900
+ version?: string;
2901
+ }
2902
+ interface GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {}
2643
2903
  interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
2644
2904
  /** Operation create time. */
2645
2905
  createTime?: string;
@@ -3374,66 +3634,8 @@ declare namespace gapi.client {
3374
3634
  documents: DocumentsResource;
3375
3635
  operations: OperationsResource;
3376
3636
  }
3377
- interface ConversationsResource {
3378
- /** Converses a conversation. */
3379
- converse(request: {
3380
- /** V1 error format. */
3381
- '$.xgafv'?: string;
3382
- /** OAuth access token. */
3383
- access_token?: string;
3384
- /** Data format for response. */
3385
- alt?: string;
3386
- /** JSONP */
3387
- callback?: string;
3388
- /** Selector specifying which fields to include in a partial response. */
3389
- fields?: string;
3390
- /** 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. */
3391
- key?: string;
3392
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
3393
- name: string;
3394
- /** OAuth 2.0 token for the current user. */
3395
- oauth_token?: string;
3396
- /** Returns response with indentations and line breaks. */
3397
- prettyPrint?: boolean;
3398
- /** 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. */
3399
- quotaUser?: string;
3400
- /** Upload protocol for media (e.g. "raw", "multipart"). */
3401
- upload_protocol?: string;
3402
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3403
- uploadType?: string;
3404
- /** Request body */
3405
- resource: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
3406
- }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
3407
- converse(
3408
- request: {
3409
- /** V1 error format. */
3410
- '$.xgafv'?: string;
3411
- /** OAuth access token. */
3412
- access_token?: string;
3413
- /** Data format for response. */
3414
- alt?: string;
3415
- /** JSONP */
3416
- callback?: string;
3417
- /** Selector specifying which fields to include in a partial response. */
3418
- fields?: string;
3419
- /** 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. */
3420
- key?: string;
3421
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
3422
- name: string;
3423
- /** OAuth 2.0 token for the current user. */
3424
- oauth_token?: string;
3425
- /** Returns response with indentations and line breaks. */
3426
- prettyPrint?: boolean;
3427
- /** 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. */
3428
- quotaUser?: string;
3429
- /** Upload protocol for media (e.g. "raw", "multipart"). */
3430
- upload_protocol?: string;
3431
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3432
- uploadType?: string;
3433
- },
3434
- body: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest
3435
- ): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
3436
- /** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
3637
+ interface ControlsResource {
3638
+ /** 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. */
3437
3639
  create(request: {
3438
3640
  /** V1 error format. */
3439
3641
  '$.xgafv'?: string;
@@ -3443,13 +3645,15 @@ declare namespace gapi.client {
3443
3645
  alt?: string;
3444
3646
  /** JSONP */
3445
3647
  callback?: string;
3648
+ /** 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-_/. */
3649
+ controlId?: string;
3446
3650
  /** Selector specifying which fields to include in a partial response. */
3447
3651
  fields?: string;
3448
3652
  /** 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. */
3449
3653
  key?: string;
3450
3654
  /** OAuth 2.0 token for the current user. */
3451
3655
  oauth_token?: string;
3452
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
3656
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3453
3657
  parent: string;
3454
3658
  /** Returns response with indentations and line breaks. */
3455
3659
  prettyPrint?: boolean;
@@ -3460,8 +3664,8 @@ declare namespace gapi.client {
3460
3664
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3461
3665
  uploadType?: string;
3462
3666
  /** Request body */
3463
- resource: GoogleCloudDiscoveryengineV1alphaConversation;
3464
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3667
+ resource: GoogleCloudDiscoveryengineV1alphaControl;
3668
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
3465
3669
  create(
3466
3670
  request: {
3467
3671
  /** V1 error format. */
@@ -3472,13 +3676,15 @@ declare namespace gapi.client {
3472
3676
  alt?: string;
3473
3677
  /** JSONP */
3474
3678
  callback?: string;
3679
+ /** 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-_/. */
3680
+ controlId?: string;
3475
3681
  /** Selector specifying which fields to include in a partial response. */
3476
3682
  fields?: string;
3477
3683
  /** 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. */
3478
3684
  key?: string;
3479
3685
  /** OAuth 2.0 token for the current user. */
3480
3686
  oauth_token?: string;
3481
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
3687
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3482
3688
  parent: string;
3483
3689
  /** Returns response with indentations and line breaks. */
3484
3690
  prettyPrint?: boolean;
@@ -3489,9 +3695,9 @@ declare namespace gapi.client {
3489
3695
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3490
3696
  uploadType?: string;
3491
3697
  },
3492
- body: GoogleCloudDiscoveryengineV1alphaConversation
3493
- ): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3494
- /** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
3698
+ body: GoogleCloudDiscoveryengineV1alphaControl
3699
+ ): Request<GoogleCloudDiscoveryengineV1alphaControl>;
3700
+ /** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
3495
3701
  delete(request?: {
3496
3702
  /** V1 error format. */
3497
3703
  '$.xgafv'?: string;
@@ -3505,7 +3711,7 @@ declare namespace gapi.client {
3505
3711
  fields?: string;
3506
3712
  /** 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. */
3507
3713
  key?: string;
3508
- /** Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
3714
+ /** 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}` */
3509
3715
  name: string;
3510
3716
  /** OAuth 2.0 token for the current user. */
3511
3717
  oauth_token?: string;
@@ -3518,7 +3724,7 @@ declare namespace gapi.client {
3518
3724
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3519
3725
  uploadType?: string;
3520
3726
  }): Request<{}>;
3521
- /** Gets a Conversation. */
3727
+ /** Gets a Control. */
3522
3728
  get(request?: {
3523
3729
  /** V1 error format. */
3524
3730
  '$.xgafv'?: string;
@@ -3532,7 +3738,7 @@ declare namespace gapi.client {
3532
3738
  fields?: string;
3533
3739
  /** 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. */
3534
3740
  key?: string;
3535
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
3741
+ /** 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}` */
3536
3742
  name: string;
3537
3743
  /** OAuth 2.0 token for the current user. */
3538
3744
  oauth_token?: string;
@@ -3544,8 +3750,8 @@ declare namespace gapi.client {
3544
3750
  upload_protocol?: string;
3545
3751
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3546
3752
  uploadType?: string;
3547
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3548
- /** Lists all Conversations by their parent DataStore. */
3753
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
3754
+ /** Lists all Controls by their parent DataStore. */
3549
3755
  list(request?: {
3550
3756
  /** V1 error format. */
3551
3757
  '$.xgafv'?: string;
@@ -3557,19 +3763,17 @@ declare namespace gapi.client {
3557
3763
  callback?: string;
3558
3764
  /** Selector specifying which fields to include in a partial response. */
3559
3765
  fields?: string;
3560
- /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
3766
+ /** 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. */
3561
3767
  filter?: string;
3562
3768
  /** 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. */
3563
3769
  key?: string;
3564
3770
  /** OAuth 2.0 token for the current user. */
3565
3771
  oauth_token?: string;
3566
- /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" */
3567
- orderBy?: string;
3568
- /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
3772
+ /** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
3569
3773
  pageSize?: number;
3570
- /** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
3774
+ /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
3571
3775
  pageToken?: string;
3572
- /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
3776
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3573
3777
  parent: string;
3574
3778
  /** Returns response with indentations and line breaks. */
3575
3779
  prettyPrint?: boolean;
@@ -3579,8 +3783,8 @@ declare namespace gapi.client {
3579
3783
  upload_protocol?: string;
3580
3784
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3581
3785
  uploadType?: string;
3582
- }): Request<GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
3583
- /** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
3786
+ }): Request<GoogleCloudDiscoveryengineV1alphaListControlsResponse>;
3787
+ /** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
3584
3788
  patch(request: {
3585
3789
  /** V1 error format. */
3586
3790
  '$.xgafv'?: string;
@@ -3594,7 +3798,7 @@ declare namespace gapi.client {
3594
3798
  fields?: string;
3595
3799
  /** 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. */
3596
3800
  key?: string;
3597
- /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3801
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
3598
3802
  name: string;
3599
3803
  /** OAuth 2.0 token for the current user. */
3600
3804
  oauth_token?: string;
@@ -3602,15 +3806,15 @@ declare namespace gapi.client {
3602
3806
  prettyPrint?: boolean;
3603
3807
  /** 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. */
3604
3808
  quotaUser?: string;
3605
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
3809
+ /** 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. */
3606
3810
  updateMask?: string;
3607
3811
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3608
3812
  upload_protocol?: string;
3609
3813
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3610
3814
  uploadType?: string;
3611
3815
  /** Request body */
3612
- resource: GoogleCloudDiscoveryengineV1alphaConversation;
3613
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3816
+ resource: GoogleCloudDiscoveryengineV1alphaControl;
3817
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
3614
3818
  patch(
3615
3819
  request: {
3616
3820
  /** V1 error format. */
@@ -3625,7 +3829,7 @@ declare namespace gapi.client {
3625
3829
  fields?: string;
3626
3830
  /** 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. */
3627
3831
  key?: string;
3628
- /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3832
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
3629
3833
  name: string;
3630
3834
  /** OAuth 2.0 token for the current user. */
3631
3835
  oauth_token?: string;
@@ -3633,19 +3837,19 @@ declare namespace gapi.client {
3633
3837
  prettyPrint?: boolean;
3634
3838
  /** 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. */
3635
3839
  quotaUser?: string;
3636
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
3840
+ /** 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. */
3637
3841
  updateMask?: string;
3638
3842
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3639
3843
  upload_protocol?: string;
3640
3844
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3641
3845
  uploadType?: string;
3642
3846
  },
3643
- body: GoogleCloudDiscoveryengineV1alphaConversation
3644
- ): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3847
+ body: GoogleCloudDiscoveryengineV1alphaControl
3848
+ ): Request<GoogleCloudDiscoveryengineV1alphaControl>;
3645
3849
  }
3646
- interface CustomModelsResource {
3647
- /** Gets a list of all the custom models. */
3648
- list(request?: {
3850
+ interface ConversationsResource {
3851
+ /** Converses a conversation. */
3852
+ converse(request: {
3649
3853
  /** V1 error format. */
3650
3854
  '$.xgafv'?: string;
3651
3855
  /** OAuth access token. */
@@ -3654,12 +3858,12 @@ declare namespace gapi.client {
3654
3858
  alt?: string;
3655
3859
  /** JSONP */
3656
3860
  callback?: string;
3657
- /** Required. The resource name of the parent 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 fetch the models from. */
3658
- dataStore: string;
3659
3861
  /** Selector specifying which fields to include in a partial response. */
3660
3862
  fields?: string;
3661
3863
  /** 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. */
3662
3864
  key?: string;
3865
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
3866
+ name: string;
3663
3867
  /** OAuth 2.0 token for the current user. */
3664
3868
  oauth_token?: string;
3665
3869
  /** Returns response with indentations and line breaks. */
@@ -3670,11 +3874,40 @@ declare namespace gapi.client {
3670
3874
  upload_protocol?: string;
3671
3875
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3672
3876
  uploadType?: string;
3673
- }): Request<GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse>;
3674
- }
3675
- interface OperationsResource {
3676
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
3677
- get(request?: {
3877
+ /** Request body */
3878
+ resource: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
3879
+ }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
3880
+ converse(
3881
+ request: {
3882
+ /** V1 error format. */
3883
+ '$.xgafv'?: string;
3884
+ /** OAuth access token. */
3885
+ access_token?: string;
3886
+ /** Data format for response. */
3887
+ alt?: string;
3888
+ /** JSONP */
3889
+ callback?: string;
3890
+ /** Selector specifying which fields to include in a partial response. */
3891
+ fields?: string;
3892
+ /** 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. */
3893
+ key?: string;
3894
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
3895
+ name: string;
3896
+ /** OAuth 2.0 token for the current user. */
3897
+ oauth_token?: string;
3898
+ /** Returns response with indentations and line breaks. */
3899
+ prettyPrint?: boolean;
3900
+ /** 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. */
3901
+ quotaUser?: string;
3902
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3903
+ upload_protocol?: string;
3904
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3905
+ uploadType?: string;
3906
+ },
3907
+ body: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest
3908
+ ): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
3909
+ /** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
3910
+ create(request: {
3678
3911
  /** V1 error format. */
3679
3912
  '$.xgafv'?: string;
3680
3913
  /** OAuth access token. */
@@ -3687,10 +3920,10 @@ declare namespace gapi.client {
3687
3920
  fields?: string;
3688
3921
  /** 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. */
3689
3922
  key?: string;
3690
- /** The name of the operation resource. */
3691
- name: string;
3692
3923
  /** OAuth 2.0 token for the current user. */
3693
3924
  oauth_token?: string;
3925
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
3926
+ parent: string;
3694
3927
  /** Returns response with indentations and line breaks. */
3695
3928
  prettyPrint?: boolean;
3696
3929
  /** 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. */
@@ -3699,8 +3932,248 @@ declare namespace gapi.client {
3699
3932
  upload_protocol?: string;
3700
3933
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3701
3934
  uploadType?: string;
3702
- }): Request<GoogleLongrunningOperation>;
3703
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
3935
+ /** Request body */
3936
+ resource: GoogleCloudDiscoveryengineV1alphaConversation;
3937
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3938
+ create(
3939
+ request: {
3940
+ /** V1 error format. */
3941
+ '$.xgafv'?: string;
3942
+ /** OAuth access token. */
3943
+ access_token?: string;
3944
+ /** Data format for response. */
3945
+ alt?: string;
3946
+ /** JSONP */
3947
+ callback?: string;
3948
+ /** Selector specifying which fields to include in a partial response. */
3949
+ fields?: string;
3950
+ /** 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. */
3951
+ key?: string;
3952
+ /** OAuth 2.0 token for the current user. */
3953
+ oauth_token?: string;
3954
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
3955
+ parent: string;
3956
+ /** Returns response with indentations and line breaks. */
3957
+ prettyPrint?: boolean;
3958
+ /** 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. */
3959
+ quotaUser?: string;
3960
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3961
+ upload_protocol?: string;
3962
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3963
+ uploadType?: string;
3964
+ },
3965
+ body: GoogleCloudDiscoveryengineV1alphaConversation
3966
+ ): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3967
+ /** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
3968
+ delete(request?: {
3969
+ /** V1 error format. */
3970
+ '$.xgafv'?: string;
3971
+ /** OAuth access token. */
3972
+ access_token?: string;
3973
+ /** Data format for response. */
3974
+ alt?: string;
3975
+ /** JSONP */
3976
+ callback?: string;
3977
+ /** Selector specifying which fields to include in a partial response. */
3978
+ fields?: string;
3979
+ /** 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. */
3980
+ key?: string;
3981
+ /** Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
3982
+ name: string;
3983
+ /** OAuth 2.0 token for the current user. */
3984
+ oauth_token?: string;
3985
+ /** Returns response with indentations and line breaks. */
3986
+ prettyPrint?: boolean;
3987
+ /** 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. */
3988
+ quotaUser?: string;
3989
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3990
+ upload_protocol?: string;
3991
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3992
+ uploadType?: string;
3993
+ }): Request<{}>;
3994
+ /** Gets a Conversation. */
3995
+ get(request?: {
3996
+ /** V1 error format. */
3997
+ '$.xgafv'?: string;
3998
+ /** OAuth access token. */
3999
+ access_token?: string;
4000
+ /** Data format for response. */
4001
+ alt?: string;
4002
+ /** JSONP */
4003
+ callback?: string;
4004
+ /** Selector specifying which fields to include in a partial response. */
4005
+ fields?: string;
4006
+ /** 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. */
4007
+ key?: string;
4008
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
4009
+ name: string;
4010
+ /** OAuth 2.0 token for the current user. */
4011
+ oauth_token?: string;
4012
+ /** Returns response with indentations and line breaks. */
4013
+ prettyPrint?: boolean;
4014
+ /** 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. */
4015
+ quotaUser?: string;
4016
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4017
+ upload_protocol?: string;
4018
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4019
+ uploadType?: string;
4020
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
4021
+ /** Lists all Conversations by their parent DataStore. */
4022
+ list(request?: {
4023
+ /** V1 error format. */
4024
+ '$.xgafv'?: string;
4025
+ /** OAuth access token. */
4026
+ access_token?: string;
4027
+ /** Data format for response. */
4028
+ alt?: string;
4029
+ /** JSONP */
4030
+ callback?: string;
4031
+ /** Selector specifying which fields to include in a partial response. */
4032
+ fields?: string;
4033
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
4034
+ filter?: string;
4035
+ /** 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. */
4036
+ key?: string;
4037
+ /** OAuth 2.0 token for the current user. */
4038
+ oauth_token?: string;
4039
+ /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" */
4040
+ orderBy?: string;
4041
+ /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
4042
+ pageSize?: number;
4043
+ /** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
4044
+ pageToken?: string;
4045
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
4046
+ parent: string;
4047
+ /** Returns response with indentations and line breaks. */
4048
+ prettyPrint?: boolean;
4049
+ /** 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. */
4050
+ quotaUser?: string;
4051
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4052
+ upload_protocol?: string;
4053
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4054
+ uploadType?: string;
4055
+ }): Request<GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
4056
+ /** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
4057
+ patch(request: {
4058
+ /** V1 error format. */
4059
+ '$.xgafv'?: string;
4060
+ /** OAuth access token. */
4061
+ access_token?: string;
4062
+ /** Data format for response. */
4063
+ alt?: string;
4064
+ /** JSONP */
4065
+ callback?: string;
4066
+ /** Selector specifying which fields to include in a partial response. */
4067
+ fields?: string;
4068
+ /** 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. */
4069
+ key?: string;
4070
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
4071
+ name: string;
4072
+ /** OAuth 2.0 token for the current user. */
4073
+ oauth_token?: string;
4074
+ /** Returns response with indentations and line breaks. */
4075
+ prettyPrint?: boolean;
4076
+ /** 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. */
4077
+ quotaUser?: string;
4078
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
4079
+ updateMask?: string;
4080
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4081
+ upload_protocol?: string;
4082
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4083
+ uploadType?: string;
4084
+ /** Request body */
4085
+ resource: GoogleCloudDiscoveryengineV1alphaConversation;
4086
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
4087
+ patch(
4088
+ request: {
4089
+ /** V1 error format. */
4090
+ '$.xgafv'?: string;
4091
+ /** OAuth access token. */
4092
+ access_token?: string;
4093
+ /** Data format for response. */
4094
+ alt?: string;
4095
+ /** JSONP */
4096
+ callback?: string;
4097
+ /** Selector specifying which fields to include in a partial response. */
4098
+ fields?: string;
4099
+ /** 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. */
4100
+ key?: string;
4101
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
4102
+ name: string;
4103
+ /** OAuth 2.0 token for the current user. */
4104
+ oauth_token?: string;
4105
+ /** Returns response with indentations and line breaks. */
4106
+ prettyPrint?: boolean;
4107
+ /** 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. */
4108
+ quotaUser?: string;
4109
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
4110
+ updateMask?: string;
4111
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4112
+ upload_protocol?: string;
4113
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4114
+ uploadType?: string;
4115
+ },
4116
+ body: GoogleCloudDiscoveryengineV1alphaConversation
4117
+ ): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
4118
+ }
4119
+ interface CustomModelsResource {
4120
+ /** Gets a list of all the custom models. */
4121
+ list(request?: {
4122
+ /** V1 error format. */
4123
+ '$.xgafv'?: string;
4124
+ /** OAuth access token. */
4125
+ access_token?: string;
4126
+ /** Data format for response. */
4127
+ alt?: string;
4128
+ /** JSONP */
4129
+ callback?: string;
4130
+ /** Required. The resource name of the parent 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 fetch the models from. */
4131
+ dataStore: string;
4132
+ /** Selector specifying which fields to include in a partial response. */
4133
+ fields?: string;
4134
+ /** 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. */
4135
+ key?: string;
4136
+ /** OAuth 2.0 token for the current user. */
4137
+ oauth_token?: string;
4138
+ /** Returns response with indentations and line breaks. */
4139
+ prettyPrint?: boolean;
4140
+ /** 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. */
4141
+ quotaUser?: string;
4142
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4143
+ upload_protocol?: string;
4144
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4145
+ uploadType?: string;
4146
+ }): Request<GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse>;
4147
+ }
4148
+ interface OperationsResource {
4149
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
4150
+ get(request?: {
4151
+ /** V1 error format. */
4152
+ '$.xgafv'?: string;
4153
+ /** OAuth access token. */
4154
+ access_token?: string;
4155
+ /** Data format for response. */
4156
+ alt?: string;
4157
+ /** JSONP */
4158
+ callback?: string;
4159
+ /** Selector specifying which fields to include in a partial response. */
4160
+ fields?: string;
4161
+ /** 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. */
4162
+ key?: string;
4163
+ /** The name of the operation resource. */
4164
+ name: string;
4165
+ /** OAuth 2.0 token for the current user. */
4166
+ oauth_token?: string;
4167
+ /** Returns response with indentations and line breaks. */
4168
+ prettyPrint?: boolean;
4169
+ /** 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. */
4170
+ quotaUser?: string;
4171
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4172
+ upload_protocol?: string;
4173
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4174
+ uploadType?: string;
4175
+ }): Request<GoogleLongrunningOperation>;
4176
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
3704
4177
  list(request?: {
3705
4178
  /** V1 error format. */
3706
4179
  '$.xgafv'?: string;
@@ -5557,6 +6030,8 @@ declare namespace gapi.client {
5557
6030
  upload_protocol?: string;
5558
6031
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5559
6032
  uploadType?: string;
6033
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
6034
+ writeAsync?: boolean;
5560
6035
  /** Request body */
5561
6036
  resource: GoogleCloudDiscoveryengineV1alphaUserEvent;
5562
6037
  }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
@@ -5586,6 +6061,8 @@ declare namespace gapi.client {
5586
6061
  upload_protocol?: string;
5587
6062
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5588
6063
  uploadType?: string;
6064
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
6065
+ writeAsync?: boolean;
5589
6066
  },
5590
6067
  body: GoogleCloudDiscoveryengineV1alphaUserEvent
5591
6068
  ): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
@@ -5812,7 +6289,7 @@ declare namespace gapi.client {
5812
6289
  callback?: string;
5813
6290
  /** Selector specifying which fields to include in a partial response. */
5814
6291
  fields?: string;
5815
- /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
6292
+ /** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
5816
6293
  filter?: string;
5817
6294
  /** 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. */
5818
6295
  key?: string;
@@ -6016,6 +6493,7 @@ declare namespace gapi.client {
6016
6493
  body: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
6017
6494
  ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
6018
6495
  branches: BranchesResource;
6496
+ controls: ControlsResource;
6019
6497
  conversations: ConversationsResource;
6020
6498
  customModels: CustomModelsResource;
6021
6499
  models: ModelsResource;
@@ -6027,9 +6505,9 @@ declare namespace gapi.client {
6027
6505
  suggestionDenyListEntries: SuggestionDenyListEntriesResource;
6028
6506
  userEvents: UserEventsResource;
6029
6507
  }
6030
- interface ConversationsResource {
6031
- /** Converses a conversation. */
6032
- converse(request: {
6508
+ interface ControlsResource {
6509
+ /** 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. */
6510
+ create(request: {
6033
6511
  /** V1 error format. */
6034
6512
  '$.xgafv'?: string;
6035
6513
  /** OAuth access token. */
@@ -6038,14 +6516,16 @@ declare namespace gapi.client {
6038
6516
  alt?: string;
6039
6517
  /** JSONP */
6040
6518
  callback?: string;
6519
+ /** 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-_/. */
6520
+ controlId?: string;
6041
6521
  /** Selector specifying which fields to include in a partial response. */
6042
6522
  fields?: string;
6043
6523
  /** 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. */
6044
6524
  key?: string;
6045
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
6046
- name: string;
6047
6525
  /** OAuth 2.0 token for the current user. */
6048
6526
  oauth_token?: string;
6527
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6528
+ parent: string;
6049
6529
  /** Returns response with indentations and line breaks. */
6050
6530
  prettyPrint?: boolean;
6051
6531
  /** 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. */
@@ -6055,9 +6535,9 @@ declare namespace gapi.client {
6055
6535
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6056
6536
  uploadType?: string;
6057
6537
  /** Request body */
6058
- resource: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
6059
- }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
6060
- converse(
6538
+ resource: GoogleCloudDiscoveryengineV1alphaControl;
6539
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
6540
+ create(
6061
6541
  request: {
6062
6542
  /** V1 error format. */
6063
6543
  '$.xgafv'?: string;
@@ -6067,12 +6547,223 @@ declare namespace gapi.client {
6067
6547
  alt?: string;
6068
6548
  /** JSONP */
6069
6549
  callback?: string;
6550
+ /** 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-_/. */
6551
+ controlId?: string;
6070
6552
  /** Selector specifying which fields to include in a partial response. */
6071
6553
  fields?: string;
6072
6554
  /** 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. */
6073
6555
  key?: string;
6074
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
6075
- name: string;
6556
+ /** OAuth 2.0 token for the current user. */
6557
+ oauth_token?: string;
6558
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6559
+ parent: string;
6560
+ /** Returns response with indentations and line breaks. */
6561
+ prettyPrint?: boolean;
6562
+ /** 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. */
6563
+ quotaUser?: string;
6564
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6565
+ upload_protocol?: string;
6566
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6567
+ uploadType?: string;
6568
+ },
6569
+ body: GoogleCloudDiscoveryengineV1alphaControl
6570
+ ): Request<GoogleCloudDiscoveryengineV1alphaControl>;
6571
+ /** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
6572
+ delete(request?: {
6573
+ /** V1 error format. */
6574
+ '$.xgafv'?: string;
6575
+ /** OAuth access token. */
6576
+ access_token?: string;
6577
+ /** Data format for response. */
6578
+ alt?: string;
6579
+ /** JSONP */
6580
+ callback?: string;
6581
+ /** Selector specifying which fields to include in a partial response. */
6582
+ fields?: string;
6583
+ /** 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. */
6584
+ key?: string;
6585
+ /** 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}` */
6586
+ name: string;
6587
+ /** OAuth 2.0 token for the current user. */
6588
+ oauth_token?: string;
6589
+ /** Returns response with indentations and line breaks. */
6590
+ prettyPrint?: boolean;
6591
+ /** 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. */
6592
+ quotaUser?: string;
6593
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6594
+ upload_protocol?: string;
6595
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6596
+ uploadType?: string;
6597
+ }): Request<{}>;
6598
+ /** Gets a Control. */
6599
+ get(request?: {
6600
+ /** V1 error format. */
6601
+ '$.xgafv'?: string;
6602
+ /** OAuth access token. */
6603
+ access_token?: string;
6604
+ /** Data format for response. */
6605
+ alt?: string;
6606
+ /** JSONP */
6607
+ callback?: string;
6608
+ /** Selector specifying which fields to include in a partial response. */
6609
+ fields?: string;
6610
+ /** 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. */
6611
+ key?: string;
6612
+ /** 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}` */
6613
+ name: string;
6614
+ /** OAuth 2.0 token for the current user. */
6615
+ oauth_token?: string;
6616
+ /** Returns response with indentations and line breaks. */
6617
+ prettyPrint?: boolean;
6618
+ /** 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. */
6619
+ quotaUser?: string;
6620
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6621
+ upload_protocol?: string;
6622
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6623
+ uploadType?: string;
6624
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
6625
+ /** Lists all Controls by their parent DataStore. */
6626
+ list(request?: {
6627
+ /** V1 error format. */
6628
+ '$.xgafv'?: string;
6629
+ /** OAuth access token. */
6630
+ access_token?: string;
6631
+ /** Data format for response. */
6632
+ alt?: string;
6633
+ /** JSONP */
6634
+ callback?: string;
6635
+ /** Selector specifying which fields to include in a partial response. */
6636
+ fields?: string;
6637
+ /** 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. */
6638
+ filter?: string;
6639
+ /** 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. */
6640
+ key?: string;
6641
+ /** OAuth 2.0 token for the current user. */
6642
+ oauth_token?: string;
6643
+ /** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
6644
+ pageSize?: number;
6645
+ /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
6646
+ pageToken?: string;
6647
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6648
+ parent: string;
6649
+ /** Returns response with indentations and line breaks. */
6650
+ prettyPrint?: boolean;
6651
+ /** 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. */
6652
+ quotaUser?: string;
6653
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6654
+ upload_protocol?: string;
6655
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6656
+ uploadType?: string;
6657
+ }): Request<GoogleCloudDiscoveryengineV1alphaListControlsResponse>;
6658
+ /** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
6659
+ patch(request: {
6660
+ /** V1 error format. */
6661
+ '$.xgafv'?: string;
6662
+ /** OAuth access token. */
6663
+ access_token?: string;
6664
+ /** Data format for response. */
6665
+ alt?: string;
6666
+ /** JSONP */
6667
+ callback?: string;
6668
+ /** Selector specifying which fields to include in a partial response. */
6669
+ fields?: string;
6670
+ /** 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. */
6671
+ key?: string;
6672
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
6673
+ name: string;
6674
+ /** OAuth 2.0 token for the current user. */
6675
+ oauth_token?: string;
6676
+ /** Returns response with indentations and line breaks. */
6677
+ prettyPrint?: boolean;
6678
+ /** 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. */
6679
+ quotaUser?: string;
6680
+ /** 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. */
6681
+ updateMask?: string;
6682
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6683
+ upload_protocol?: string;
6684
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6685
+ uploadType?: string;
6686
+ /** Request body */
6687
+ resource: GoogleCloudDiscoveryengineV1alphaControl;
6688
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
6689
+ patch(
6690
+ request: {
6691
+ /** V1 error format. */
6692
+ '$.xgafv'?: string;
6693
+ /** OAuth access token. */
6694
+ access_token?: string;
6695
+ /** Data format for response. */
6696
+ alt?: string;
6697
+ /** JSONP */
6698
+ callback?: string;
6699
+ /** Selector specifying which fields to include in a partial response. */
6700
+ fields?: string;
6701
+ /** 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. */
6702
+ key?: string;
6703
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
6704
+ name: string;
6705
+ /** OAuth 2.0 token for the current user. */
6706
+ oauth_token?: string;
6707
+ /** Returns response with indentations and line breaks. */
6708
+ prettyPrint?: boolean;
6709
+ /** 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. */
6710
+ quotaUser?: string;
6711
+ /** 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. */
6712
+ updateMask?: string;
6713
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6714
+ upload_protocol?: string;
6715
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6716
+ uploadType?: string;
6717
+ },
6718
+ body: GoogleCloudDiscoveryengineV1alphaControl
6719
+ ): Request<GoogleCloudDiscoveryengineV1alphaControl>;
6720
+ }
6721
+ interface ConversationsResource {
6722
+ /** Converses a conversation. */
6723
+ converse(request: {
6724
+ /** V1 error format. */
6725
+ '$.xgafv'?: string;
6726
+ /** OAuth access token. */
6727
+ access_token?: string;
6728
+ /** Data format for response. */
6729
+ alt?: string;
6730
+ /** JSONP */
6731
+ callback?: string;
6732
+ /** Selector specifying which fields to include in a partial response. */
6733
+ fields?: string;
6734
+ /** 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. */
6735
+ key?: string;
6736
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
6737
+ name: string;
6738
+ /** OAuth 2.0 token for the current user. */
6739
+ oauth_token?: string;
6740
+ /** Returns response with indentations and line breaks. */
6741
+ prettyPrint?: boolean;
6742
+ /** 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. */
6743
+ quotaUser?: string;
6744
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6745
+ upload_protocol?: string;
6746
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6747
+ uploadType?: string;
6748
+ /** Request body */
6749
+ resource: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
6750
+ }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
6751
+ converse(
6752
+ request: {
6753
+ /** V1 error format. */
6754
+ '$.xgafv'?: string;
6755
+ /** OAuth access token. */
6756
+ access_token?: string;
6757
+ /** Data format for response. */
6758
+ alt?: string;
6759
+ /** JSONP */
6760
+ callback?: string;
6761
+ /** Selector specifying which fields to include in a partial response. */
6762
+ fields?: string;
6763
+ /** 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. */
6764
+ key?: string;
6765
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
6766
+ name: string;
6076
6767
  /** OAuth 2.0 token for the current user. */
6077
6768
  oauth_token?: string;
6078
6769
  /** Returns response with indentations and line breaks. */
@@ -7281,6 +7972,7 @@ declare namespace gapi.client {
7281
7972
  },
7282
7973
  body: GoogleCloudDiscoveryengineV1alphaTuneEngineRequest
7283
7974
  ): Request<GoogleLongrunningOperation>;
7975
+ controls: ControlsResource;
7284
7976
  conversations: ConversationsResource;
7285
7977
  operations: OperationsResource;
7286
7978
  servingConfigs: ServingConfigsResource;
@@ -7901,6 +8593,219 @@ declare namespace gapi.client {
7901
8593
  documents: DocumentsResource;
7902
8594
  operations: OperationsResource;
7903
8595
  }
8596
+ interface ControlsResource {
8597
+ /** 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. */
8598
+ create(request: {
8599
+ /** V1 error format. */
8600
+ '$.xgafv'?: string;
8601
+ /** OAuth access token. */
8602
+ access_token?: string;
8603
+ /** Data format for response. */
8604
+ alt?: string;
8605
+ /** JSONP */
8606
+ callback?: string;
8607
+ /** 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-_/. */
8608
+ controlId?: string;
8609
+ /** Selector specifying which fields to include in a partial response. */
8610
+ fields?: string;
8611
+ /** 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. */
8612
+ key?: string;
8613
+ /** OAuth 2.0 token for the current user. */
8614
+ oauth_token?: string;
8615
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
8616
+ parent: string;
8617
+ /** Returns response with indentations and line breaks. */
8618
+ prettyPrint?: boolean;
8619
+ /** 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. */
8620
+ quotaUser?: string;
8621
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8622
+ upload_protocol?: string;
8623
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8624
+ uploadType?: string;
8625
+ /** Request body */
8626
+ resource: GoogleCloudDiscoveryengineV1alphaControl;
8627
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
8628
+ create(
8629
+ request: {
8630
+ /** V1 error format. */
8631
+ '$.xgafv'?: string;
8632
+ /** OAuth access token. */
8633
+ access_token?: string;
8634
+ /** Data format for response. */
8635
+ alt?: string;
8636
+ /** JSONP */
8637
+ callback?: string;
8638
+ /** 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-_/. */
8639
+ controlId?: string;
8640
+ /** Selector specifying which fields to include in a partial response. */
8641
+ fields?: string;
8642
+ /** 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. */
8643
+ key?: string;
8644
+ /** OAuth 2.0 token for the current user. */
8645
+ oauth_token?: string;
8646
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
8647
+ parent: string;
8648
+ /** Returns response with indentations and line breaks. */
8649
+ prettyPrint?: boolean;
8650
+ /** 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. */
8651
+ quotaUser?: string;
8652
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8653
+ upload_protocol?: string;
8654
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8655
+ uploadType?: string;
8656
+ },
8657
+ body: GoogleCloudDiscoveryengineV1alphaControl
8658
+ ): Request<GoogleCloudDiscoveryengineV1alphaControl>;
8659
+ /** Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. */
8660
+ delete(request?: {
8661
+ /** V1 error format. */
8662
+ '$.xgafv'?: string;
8663
+ /** OAuth access token. */
8664
+ access_token?: string;
8665
+ /** Data format for response. */
8666
+ alt?: string;
8667
+ /** JSONP */
8668
+ callback?: string;
8669
+ /** Selector specifying which fields to include in a partial response. */
8670
+ fields?: string;
8671
+ /** 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. */
8672
+ key?: string;
8673
+ /** 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}` */
8674
+ name: string;
8675
+ /** OAuth 2.0 token for the current user. */
8676
+ oauth_token?: string;
8677
+ /** Returns response with indentations and line breaks. */
8678
+ prettyPrint?: boolean;
8679
+ /** 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. */
8680
+ quotaUser?: string;
8681
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8682
+ upload_protocol?: string;
8683
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8684
+ uploadType?: string;
8685
+ }): Request<{}>;
8686
+ /** Gets a Control. */
8687
+ get(request?: {
8688
+ /** V1 error format. */
8689
+ '$.xgafv'?: string;
8690
+ /** OAuth access token. */
8691
+ access_token?: string;
8692
+ /** Data format for response. */
8693
+ alt?: string;
8694
+ /** JSONP */
8695
+ callback?: string;
8696
+ /** Selector specifying which fields to include in a partial response. */
8697
+ fields?: string;
8698
+ /** 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. */
8699
+ key?: string;
8700
+ /** 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}` */
8701
+ name: string;
8702
+ /** OAuth 2.0 token for the current user. */
8703
+ oauth_token?: string;
8704
+ /** Returns response with indentations and line breaks. */
8705
+ prettyPrint?: boolean;
8706
+ /** 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. */
8707
+ quotaUser?: string;
8708
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8709
+ upload_protocol?: string;
8710
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8711
+ uploadType?: string;
8712
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
8713
+ /** Lists all Controls by their parent DataStore. */
8714
+ list(request?: {
8715
+ /** V1 error format. */
8716
+ '$.xgafv'?: string;
8717
+ /** OAuth access token. */
8718
+ access_token?: string;
8719
+ /** Data format for response. */
8720
+ alt?: string;
8721
+ /** JSONP */
8722
+ callback?: string;
8723
+ /** Selector specifying which fields to include in a partial response. */
8724
+ fields?: string;
8725
+ /** 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. */
8726
+ filter?: string;
8727
+ /** 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. */
8728
+ key?: string;
8729
+ /** OAuth 2.0 token for the current user. */
8730
+ oauth_token?: string;
8731
+ /** Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
8732
+ pageSize?: number;
8733
+ /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
8734
+ pageToken?: string;
8735
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
8736
+ parent: string;
8737
+ /** Returns response with indentations and line breaks. */
8738
+ prettyPrint?: boolean;
8739
+ /** 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. */
8740
+ quotaUser?: string;
8741
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8742
+ upload_protocol?: string;
8743
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8744
+ uploadType?: string;
8745
+ }): Request<GoogleCloudDiscoveryengineV1alphaListControlsResponse>;
8746
+ /** Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. */
8747
+ patch(request: {
8748
+ /** V1 error format. */
8749
+ '$.xgafv'?: string;
8750
+ /** OAuth access token. */
8751
+ access_token?: string;
8752
+ /** Data format for response. */
8753
+ alt?: string;
8754
+ /** JSONP */
8755
+ callback?: string;
8756
+ /** Selector specifying which fields to include in a partial response. */
8757
+ fields?: string;
8758
+ /** 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. */
8759
+ key?: string;
8760
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
8761
+ name: string;
8762
+ /** OAuth 2.0 token for the current user. */
8763
+ oauth_token?: string;
8764
+ /** Returns response with indentations and line breaks. */
8765
+ prettyPrint?: boolean;
8766
+ /** 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. */
8767
+ quotaUser?: string;
8768
+ /** 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. */
8769
+ updateMask?: string;
8770
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8771
+ upload_protocol?: string;
8772
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8773
+ uploadType?: string;
8774
+ /** Request body */
8775
+ resource: GoogleCloudDiscoveryengineV1alphaControl;
8776
+ }): Request<GoogleCloudDiscoveryengineV1alphaControl>;
8777
+ patch(
8778
+ request: {
8779
+ /** V1 error format. */
8780
+ '$.xgafv'?: string;
8781
+ /** OAuth access token. */
8782
+ access_token?: string;
8783
+ /** Data format for response. */
8784
+ alt?: string;
8785
+ /** JSONP */
8786
+ callback?: string;
8787
+ /** Selector specifying which fields to include in a partial response. */
8788
+ fields?: string;
8789
+ /** 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. */
8790
+ key?: string;
8791
+ /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
8792
+ name: string;
8793
+ /** OAuth 2.0 token for the current user. */
8794
+ oauth_token?: string;
8795
+ /** Returns response with indentations and line breaks. */
8796
+ prettyPrint?: boolean;
8797
+ /** 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. */
8798
+ quotaUser?: string;
8799
+ /** 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. */
8800
+ updateMask?: string;
8801
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8802
+ upload_protocol?: string;
8803
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8804
+ uploadType?: string;
8805
+ },
8806
+ body: GoogleCloudDiscoveryengineV1alphaControl
8807
+ ): Request<GoogleCloudDiscoveryengineV1alphaControl>;
8808
+ }
7904
8809
  interface ConversationsResource {
7905
8810
  /** Converses a conversation. */
7906
8811
  converse(request: {
@@ -9777,6 +10682,8 @@ declare namespace gapi.client {
9777
10682
  upload_protocol?: string;
9778
10683
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9779
10684
  uploadType?: string;
10685
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
10686
+ writeAsync?: boolean;
9780
10687
  /** Request body */
9781
10688
  resource: GoogleCloudDiscoveryengineV1alphaUserEvent;
9782
10689
  }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
@@ -9806,6 +10713,8 @@ declare namespace gapi.client {
9806
10713
  upload_protocol?: string;
9807
10714
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9808
10715
  uploadType?: string;
10716
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
10717
+ writeAsync?: boolean;
9809
10718
  },
9810
10719
  body: GoogleCloudDiscoveryengineV1alphaUserEvent
9811
10720
  ): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
@@ -10032,7 +10941,7 @@ declare namespace gapi.client {
10032
10941
  callback?: string;
10033
10942
  /** Selector specifying which fields to include in a partial response. */
10034
10943
  fields?: string;
10035
- /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
10944
+ /** Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */
10036
10945
  filter?: string;
10037
10946
  /** 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. */
10038
10947
  key?: string;
@@ -10178,6 +11087,7 @@ declare namespace gapi.client {
10178
11087
  body: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
10179
11088
  ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
10180
11089
  branches: BranchesResource;
11090
+ controls: ControlsResource;
10181
11091
  conversations: ConversationsResource;
10182
11092
  models: ModelsResource;
10183
11093
  operations: OperationsResource;
@@ -10461,6 +11371,8 @@ declare namespace gapi.client {
10461
11371
  upload_protocol?: string;
10462
11372
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10463
11373
  uploadType?: string;
11374
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
11375
+ writeAsync?: boolean;
10464
11376
  /** Request body */
10465
11377
  resource: GoogleCloudDiscoveryengineV1alphaUserEvent;
10466
11378
  }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
@@ -10490,6 +11402,8 @@ declare namespace gapi.client {
10490
11402
  upload_protocol?: string;
10491
11403
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10492
11404
  uploadType?: string;
11405
+ /** If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */
11406
+ writeAsync?: boolean;
10493
11407
  },
10494
11408
  body: GoogleCloudDiscoveryengineV1alphaUserEvent
10495
11409
  ): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;