@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20231026 → 0.0.20231102

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +2114 -605
  2. package/package.json +1 -1
  3. package/tests.ts +225 -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: 20231026
12
+ // Revision: 20231102
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -290,6 +290,22 @@ declare namespace gapi.client {
290
290
  searchResults?:
291
291
  GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[];
292
292
  }
293
+ interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
294
+ /** Operation create time. */
295
+ createTime?:
296
+ string;
297
+ /** Operation last update time. If the operation is done, this is also the finish time. */
298
+ updateTime?:
299
+ string;
300
+ }
301
+ interface GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata {
302
+ /** Operation create time. */
303
+ createTime?:
304
+ string;
305
+ /** Operation last update time. If the operation is done, this is also the finish time. */
306
+ updateTime?:
307
+ string;
308
+ }
293
309
  interface GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata {
294
310
  /** Operation create time. */
295
311
  createTime?:
@@ -312,6 +328,51 @@ declare namespace gapi.client {
312
328
  text?:
313
329
  string[];
314
330
  }
331
+ interface GoogleCloudDiscoveryengineV1alphaDataStore {
332
+ /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
333
+ contentConfig?:
334
+ string;
335
+ /** Output only. Timestamp the DataStore was created at. */
336
+ createTime?:
337
+ string;
338
+ /** Output only. The id of the default Schema asscociated to this data store. */
339
+ defaultSchemaId?:
340
+ string;
341
+ /** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
342
+ displayName?:
343
+ string;
344
+ /** Immutable. The industry vertical that the data store registers. */
345
+ industryVertical?:
346
+ string;
347
+ /**
348
+ * Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a
349
+ * UTF-8 encoded string with a length limit of 1024 characters.
350
+ */
351
+ name?:
352
+ string;
353
+ /**
354
+ * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`:
355
+ * `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
356
+ */
357
+ solutionTypes?:
358
+ string[];
359
+ }
360
+ interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
361
+ /** Operation create time. */
362
+ createTime?:
363
+ string;
364
+ /** Operation last update time. If the operation is done, this is also the finish time. */
365
+ updateTime?:
366
+ string;
367
+ }
368
+ interface GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata {
369
+ /** Operation create time. */
370
+ createTime?:
371
+ string;
372
+ /** Operation last update time. If the operation is done, this is also the finish time. */
373
+ updateTime?:
374
+ string;
375
+ }
315
376
  interface GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata {
316
377
  /** Operation create time. */
317
378
  createTime?:
@@ -400,6 +461,167 @@ declare namespace gapi.client {
400
461
  values?:
401
462
  number[];
402
463
  }
464
+ interface GoogleCloudDiscoveryengineV1alphaEngine {
465
+ /** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
466
+ chatEngineConfig?:
467
+ GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
468
+ /** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
469
+ chatEngineMetadata?:
470
+ GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
471
+ /** Common config spec that specifies the metadata of the engine. */
472
+ commonConfig?:
473
+ GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
474
+ /** Output only. Timestamp the Recommendation Engine was created at. */
475
+ createTime?:
476
+ string;
477
+ /**
478
+ * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If
479
+ * solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided
480
+ * as the system will use it for necessary intializations.
481
+ */
482
+ dataStoreIds?:
483
+ string[];
484
+ /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
485
+ displayName?:
486
+ string;
487
+ /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
488
+ mediaRecommendationEngineConfig?:
489
+ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
490
+ /**
491
+ * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format:
492
+ * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an
493
+ * INVALID_ARGUMENT error is returned.
494
+ */
495
+ name?:
496
+ string;
497
+ /** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
498
+ recommendationMetadata?:
499
+ GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
500
+ /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
501
+ searchEngineConfig?:
502
+ GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig;
503
+ /** Additional config specs for a `similar-items` engine. */
504
+ similarDocumentsConfig?:
505
+ any;
506
+ /** Required. The solutions of the engine. */
507
+ solutionType?:
508
+ string;
509
+ /** Output only. Timestamp the Recommendation Engine was last updated. */
510
+ updateTime?:
511
+ string;
512
+ }
513
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
514
+ /**
515
+ * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It
516
+ * means they cannot be retrieved using GetEngine or ListEngine API after engine creation.
517
+ */
518
+ agentCreationConfig?:
519
+ GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
520
+ /**
521
+ * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links
522
+ * the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means
523
+ * they cannot be retrieved using GetEngine or ListEngine API after engine creation. Please use Engine.chat_engine_metadata.dialogflow_agent for actual agent association after Engine
524
+ * is created.
525
+ */
526
+ dialogflowAgentToLink?:
527
+ string;
528
+ }
529
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
530
+ /** Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */
531
+ business?:
532
+ string;
533
+ /**
534
+ * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently
535
+ * supported language codes.
536
+ */
537
+ defaultLanguageCode?:
538
+ string;
539
+ /** Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. */
540
+ timeZone?:
541
+ string;
542
+ }
543
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata {
544
+ /** The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */
545
+ dialogflowAgent?:
546
+ string;
547
+ }
548
+ interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
549
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
550
+ companyName?:
551
+ string;
552
+ }
553
+ interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
554
+ /**
555
+ * The optimization objective e.g. `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported
556
+ * values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` =>
557
+ * `ctr`
558
+ */
559
+ optimizationObjective?:
560
+ string;
561
+ /**
562
+ * Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time
563
+ * in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0]
564
+ * (excludes 0, includes 1.0) (e.g., 0.5).
565
+ */
566
+ optimizationObjectiveConfig?:
567
+ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
568
+ /**
569
+ * The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when
570
+ * to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the
571
+ * state the same as before.
572
+ */
573
+ trainingState?:
574
+ string;
575
+ /**
576
+ * Required. The type of engine e.g. `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving.
577
+ * Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
578
+ */
579
+ type?:
580
+ string;
581
+ }
582
+ interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
583
+ /** Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. */
584
+ targetField?:
585
+ string;
586
+ /** Required. The threshold to be applied to the target (e.g., 0.5). */
587
+ targetFieldValueFloat?:
588
+ number;
589
+ }
590
+ interface GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata {
591
+ /**
592
+ * Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR`
593
+ * state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
594
+ */
595
+ dataState?:
596
+ string;
597
+ /** Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines. */
598
+ lastTuneTime?:
599
+ string;
600
+ /** Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. */
601
+ servingState?:
602
+ string;
603
+ /**
604
+ * Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if
605
+ * there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has
606
+ * happened for this engine, the string is empty.
607
+ */
608
+ tuningOperation?:
609
+ string;
610
+ }
611
+ interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
612
+ /** The add-on that this search engine enables. */
613
+ searchAddOns?:
614
+ string[];
615
+ /**
616
+ * The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to
617
+ * SearchTier.SEARCH_TIER_STANDARD if not specified.
618
+ */
619
+ searchTier?:
620
+ string;
621
+ }
622
+ // tslint:disable-next-line:no-empty-interface
623
+ interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {
624
+ }
403
625
  interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
404
626
  /**
405
627
  * If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option
@@ -617,6 +839,14 @@ declare namespace gapi.client {
617
839
  nextPageToken?:
618
840
  string;
619
841
  }
842
+ interface GoogleCloudDiscoveryengineV1alphaListDataStoresResponse {
843
+ /** All the customer's DataStores. */
844
+ dataStores?:
845
+ GoogleCloudDiscoveryengineV1alphaDataStore[];
846
+ /** A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
847
+ nextPageToken?:
848
+ string;
849
+ }
620
850
  interface GoogleCloudDiscoveryengineV1alphaListDocumentsResponse {
621
851
  /** The Documents. */
622
852
  documents?:
@@ -625,6 +855,14 @@ declare namespace gapi.client {
625
855
  nextPageToken?:
626
856
  string;
627
857
  }
858
+ interface GoogleCloudDiscoveryengineV1alphaListEnginesResponse {
859
+ /** All the customer's Engines. */
860
+ engines?:
861
+ GoogleCloudDiscoveryengineV1alphaEngine[];
862
+ /** Not supported. */
863
+ nextPageToken?:
864
+ string;
865
+ }
628
866
  interface GoogleCloudDiscoveryengineV1alphaListSchemasResponse {
629
867
  /** A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
630
868
  nextPageToken?:
@@ -700,6 +938,9 @@ declare namespace gapi.client {
700
938
  totalPanels?:
701
939
  number;
702
940
  }
941
+ // tslint:disable-next-line:no-empty-interface
942
+ interface GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {
943
+ }
703
944
  interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
704
945
  /** Operation create time. */
705
946
  createTime?:
@@ -923,6 +1164,9 @@ declare namespace gapi.client {
923
1164
  uri?:
924
1165
  string;
925
1166
  }
1167
+ // tslint:disable-next-line:no-empty-interface
1168
+ interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {
1169
+ }
926
1170
  interface GoogleCloudDiscoveryengineV1alphaSchema {
927
1171
  /** Output only. Configurations for fields of the schema. */
928
1172
  fieldConfigs?:
@@ -1050,7 +1294,7 @@ declare namespace gapi.client {
1050
1294
  safeSearch?:
1051
1295
  boolean;
1052
1296
  /**
1053
- * Required. The resource name of the Search serving config, such as
1297
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or
1054
1298
  * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
1055
1299
  * configuration name, set of models used to make the search.
1056
1300
  */
@@ -1499,6 +1743,17 @@ declare namespace gapi.client {
1499
1743
  value?:
1500
1744
  number;
1501
1745
  }
1746
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
1747
+ /** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
1748
+ engine?:
1749
+ string;
1750
+ }
1751
+ // tslint:disable-next-line:no-empty-interface
1752
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineRequest {
1753
+ }
1754
+ // tslint:disable-next-line:no-empty-interface
1755
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {
1756
+ }
1502
1757
  interface GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata {
1503
1758
  /** Operation create time. */
1504
1759
  createTime?:
@@ -4051,8 +4306,10 @@ declare namespace gapi.client {
4051
4306
  quotaUser?:
4052
4307
  string;
4053
4308
  /**
4054
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
4055
- * you must create at least one serving config for it.
4309
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
4310
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
4311
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
4312
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
4056
4313
  */
4057
4314
  servingConfig:
4058
4315
  string;
@@ -4095,8 +4352,10 @@ declare namespace gapi.client {
4095
4352
  quotaUser?:
4096
4353
  string;
4097
4354
  /**
4098
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
4099
- * you must create at least one serving config for it.
4355
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
4356
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
4357
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
4358
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
4100
4359
  */
4101
4360
  servingConfig:
4102
4361
  string;
@@ -4138,8 +4397,8 @@ declare namespace gapi.client {
4138
4397
  quotaUser?:
4139
4398
  string;
4140
4399
  /**
4141
- * Required. The resource name of the Search serving config, such as
4142
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4400
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
4401
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4143
4402
  * configuration name, set of models used to make the search.
4144
4403
  */
4145
4404
  servingConfig:
@@ -4183,8 +4442,8 @@ declare namespace gapi.client {
4183
4442
  quotaUser?:
4184
4443
  string;
4185
4444
  /**
4186
- * Required. The resource name of the Search serving config, such as
4187
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4445
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
4446
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4188
4447
  * configuration name, set of models used to make the search.
4189
4448
  */
4190
4449
  servingConfig:
@@ -4846,26 +5105,8 @@ declare namespace gapi.client {
4846
5105
  userPseudoId?:
4847
5106
  string;
4848
5107
  }): Request<GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>;
4849
- branches:
4850
- BranchesResource;
4851
- conversations:
4852
- ConversationsResource;
4853
- models:
4854
- ModelsResource;
4855
- operations:
4856
- OperationsResource;
4857
- schemas:
4858
- SchemasResource;
4859
- servingConfigs:
4860
- ServingConfigsResource;
4861
- siteSearchEngine:
4862
- SiteSearchEngineResource;
4863
- userEvents:
4864
- UserEventsResource;
4865
- }
4866
- interface OperationsResource {
4867
- /** 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. */
4868
- get(request?: {
5108
+ /** Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. */
5109
+ create(request: {
4869
5110
  /** V1 error format. */
4870
5111
  "$.xgafv"?:
4871
5112
  string;
@@ -4878,18 +5119,30 @@ declare namespace gapi.client {
4878
5119
  /** JSONP */
4879
5120
  callback?:
4880
5121
  string;
5122
+ /**
5123
+ * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and
5124
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
5125
+ */
5126
+ createAdvancedSiteSearch?:
5127
+ boolean;
5128
+ /**
5129
+ * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to
5130
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5131
+ */
5132
+ dataStoreId?:
5133
+ string;
4881
5134
  /** Selector specifying which fields to include in a partial response. */
4882
5135
  fields?:
4883
5136
  string;
4884
5137
  /** 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. */
4885
5138
  key?:
4886
5139
  string;
4887
- /** The name of the operation resource. */
4888
- name:
4889
- string;
4890
5140
  /** OAuth 2.0 token for the current user. */
4891
5141
  oauth_token?:
4892
5142
  string;
5143
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5144
+ parent:
5145
+ string;
4893
5146
  /** Returns response with indentations and line breaks. */
4894
5147
  prettyPrint?:
4895
5148
  boolean;
@@ -4902,9 +5155,11 @@ declare namespace gapi.client {
4902
5155
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4903
5156
  uploadType?:
4904
5157
  string;
5158
+ /** Request body */
5159
+ resource:
5160
+ GoogleCloudDiscoveryengineV1alphaDataStore;
4905
5161
  }): Request<GoogleLongrunningOperation>;
4906
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
4907
- list(request?: {
5162
+ create(request: {
4908
5163
  /** V1 error format. */
4909
5164
  "$.xgafv"?:
4910
5165
  string;
@@ -4917,26 +5172,29 @@ declare namespace gapi.client {
4917
5172
  /** JSONP */
4918
5173
  callback?:
4919
5174
  string;
5175
+ /**
5176
+ * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and
5177
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
5178
+ */
5179
+ createAdvancedSiteSearch?:
5180
+ boolean;
5181
+ /**
5182
+ * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to
5183
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5184
+ */
5185
+ dataStoreId?:
5186
+ string;
4920
5187
  /** Selector specifying which fields to include in a partial response. */
4921
5188
  fields?:
4922
5189
  string;
4923
- /** The standard list filter. */
4924
- filter?:
4925
- string;
4926
5190
  /** 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. */
4927
5191
  key?:
4928
5192
  string;
4929
- /** The name of the operation's parent resource. */
4930
- name:
4931
- string;
4932
5193
  /** OAuth 2.0 token for the current user. */
4933
5194
  oauth_token?:
4934
5195
  string;
4935
- /** The standard list page size. */
4936
- pageSize?:
4937
- number;
4938
- /** The standard list page token. */
4939
- pageToken?:
5196
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5197
+ parent:
4940
5198
  string;
4941
5199
  /** Returns response with indentations and line breaks. */
4942
5200
  prettyPrint?:
@@ -4950,11 +5208,10 @@ declare namespace gapi.client {
4950
5208
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4951
5209
  uploadType?:
4952
5210
  string;
4953
- }): Request<GoogleLongrunningListOperationsResponse>;
4954
- }
4955
- interface ServingConfigsResource {
4956
- /** Makes a recommendation, which requires a contextual user event. */
4957
- recommend(request: {
5211
+ },
5212
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleLongrunningOperation>;
5213
+ /** Deletes a DataStore. */
5214
+ delete(request?: {
4958
5215
  /** V1 error format. */
4959
5216
  "$.xgafv"?:
4960
5217
  string;
@@ -4973,6 +5230,13 @@ declare namespace gapi.client {
4973
5230
  /** 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. */
4974
5231
  key?:
4975
5232
  string;
5233
+ /**
5234
+ * Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have
5235
+ * permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error
5236
+ * is returned.
5237
+ */
5238
+ name:
5239
+ string;
4976
5240
  /** OAuth 2.0 token for the current user. */
4977
5241
  oauth_token?:
4978
5242
  string;
@@ -4982,23 +5246,15 @@ declare namespace gapi.client {
4982
5246
  /** 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. */
4983
5247
  quotaUser?:
4984
5248
  string;
4985
- /**
4986
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
4987
- * you must create at least one serving config for it.
4988
- */
4989
- servingConfig:
4990
- string;
4991
5249
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4992
5250
  upload_protocol?:
4993
5251
  string;
4994
5252
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4995
5253
  uploadType?:
4996
5254
  string;
4997
- /** Request body */
4998
- resource:
4999
- GoogleCloudDiscoveryengineV1alphaRecommendRequest;
5000
- }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5001
- recommend(request: {
5255
+ }): Request<GoogleLongrunningOperation>;
5256
+ /** Gets a DataStore. */
5257
+ get(request?: {
5002
5258
  /** V1 error format. */
5003
5259
  "$.xgafv"?:
5004
5260
  string;
@@ -5017,6 +5273,13 @@ declare namespace gapi.client {
5017
5273
  /** 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. */
5018
5274
  key?:
5019
5275
  string;
5276
+ /**
5277
+ * Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have
5278
+ * permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error
5279
+ * is returned.
5280
+ */
5281
+ name:
5282
+ string;
5020
5283
  /** OAuth 2.0 token for the current user. */
5021
5284
  oauth_token?:
5022
5285
  string;
@@ -5026,22 +5289,15 @@ declare namespace gapi.client {
5026
5289
  /** 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. */
5027
5290
  quotaUser?:
5028
5291
  string;
5029
- /**
5030
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
5031
- * you must create at least one serving config for it.
5032
- */
5033
- servingConfig:
5034
- string;
5035
5292
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5036
5293
  upload_protocol?:
5037
5294
  string;
5038
5295
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5039
5296
  uploadType?:
5040
5297
  string;
5041
- },
5042
- body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5043
- /** Performs a search. */
5044
- search(request: {
5298
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
5299
+ /** Lists all the DataStores associated with the project. */
5300
+ list(request?: {
5045
5301
  /** V1 error format. */
5046
5302
  "$.xgafv"?:
5047
5303
  string;
@@ -5057,36 +5313,48 @@ declare namespace gapi.client {
5057
5313
  /** Selector specifying which fields to include in a partial response. */
5058
5314
  fields?:
5059
5315
  string;
5316
+ /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
5317
+ filter?:
5318
+ string;
5060
5319
  /** 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. */
5061
5320
  key?:
5062
5321
  string;
5063
5322
  /** OAuth 2.0 token for the current user. */
5064
5323
  oauth_token?:
5065
5324
  string;
5325
+ /**
5326
+ * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an
5327
+ * INVALID_ARGUMENT is returned.
5328
+ */
5329
+ pageSize?:
5330
+ number;
5331
+ /**
5332
+ * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When
5333
+ * paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
5334
+ */
5335
+ pageToken?:
5336
+ string;
5337
+ /**
5338
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list
5339
+ * DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
5340
+ */
5341
+ parent:
5342
+ string;
5066
5343
  /** Returns response with indentations and line breaks. */
5067
5344
  prettyPrint?:
5068
5345
  boolean;
5069
5346
  /** 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. */
5070
5347
  quotaUser?:
5071
5348
  string;
5072
- /**
5073
- * Required. The resource name of the Search serving config, such as
5074
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
5075
- * configuration name, set of models used to make the search.
5076
- */
5077
- servingConfig:
5078
- string;
5079
5349
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5080
5350
  upload_protocol?:
5081
5351
  string;
5082
5352
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5083
5353
  uploadType?:
5084
5354
  string;
5085
- /** Request body */
5086
- resource:
5087
- GoogleCloudDiscoveryengineV1alphaSearchRequest;
5088
- }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5089
- search(request: {
5355
+ }): Request<GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>;
5356
+ /** Updates a DataStore */
5357
+ patch(request: {
5090
5358
  /** V1 error format. */
5091
5359
  "$.xgafv"?:
5092
5360
  string;
@@ -5105,6 +5373,12 @@ declare namespace gapi.client {
5105
5373
  /** 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. */
5106
5374
  key?:
5107
5375
  string;
5376
+ /**
5377
+ * Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be
5378
+ * a UTF-8 encoded string with a length limit of 1024 characters.
5379
+ */
5380
+ name:
5381
+ string;
5108
5382
  /** OAuth 2.0 token for the current user. */
5109
5383
  oauth_token?:
5110
5384
  string;
@@ -5114,12 +5388,8 @@ declare namespace gapi.client {
5114
5388
  /** 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. */
5115
5389
  quotaUser?:
5116
5390
  string;
5117
- /**
5118
- * Required. The resource name of the Search serving config, such as
5119
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
5120
- * configuration name, set of models used to make the search.
5121
- */
5122
- servingConfig:
5391
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
5392
+ updateMask?:
5123
5393
  string;
5124
5394
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5125
5395
  upload_protocol?:
@@ -5127,14 +5397,71 @@ declare namespace gapi.client {
5127
5397
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5128
5398
  uploadType?:
5129
5399
  string;
5130
- },
5131
- body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5132
- }
5133
- interface EnginesResource {
5134
- operations:
5135
- OperationsResource;
5136
- servingConfigs:
5400
+ /** Request body */
5401
+ resource:
5402
+ GoogleCloudDiscoveryengineV1alphaDataStore;
5403
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
5404
+ patch(request: {
5405
+ /** V1 error format. */
5406
+ "$.xgafv"?:
5407
+ string;
5408
+ /** OAuth access token. */
5409
+ access_token?:
5410
+ string;
5411
+ /** Data format for response. */
5412
+ alt?:
5413
+ string;
5414
+ /** JSONP */
5415
+ callback?:
5416
+ string;
5417
+ /** Selector specifying which fields to include in a partial response. */
5418
+ fields?:
5419
+ string;
5420
+ /** 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. */
5421
+ key?:
5422
+ string;
5423
+ /**
5424
+ * Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be
5425
+ * a UTF-8 encoded string with a length limit of 1024 characters.
5426
+ */
5427
+ name:
5428
+ string;
5429
+ /** OAuth 2.0 token for the current user. */
5430
+ oauth_token?:
5431
+ string;
5432
+ /** Returns response with indentations and line breaks. */
5433
+ prettyPrint?:
5434
+ boolean;
5435
+ /** 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. */
5436
+ quotaUser?:
5437
+ string;
5438
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
5439
+ updateMask?:
5440
+ string;
5441
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5442
+ upload_protocol?:
5443
+ string;
5444
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5445
+ uploadType?:
5446
+ string;
5447
+ },
5448
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
5449
+ branches:
5450
+ BranchesResource;
5451
+ conversations:
5452
+ ConversationsResource;
5453
+ models:
5454
+ ModelsResource;
5455
+ operations:
5456
+ OperationsResource;
5457
+ schemas:
5458
+ SchemasResource;
5459
+ servingConfigs:
5137
5460
  ServingConfigsResource;
5461
+ siteSearchEngine:
5462
+ SiteSearchEngineResource;
5463
+ userEvents:
5464
+ UserEventsResource;
5138
5465
  }
5139
5466
  interface OperationsResource {
5140
5467
  /** 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. */
@@ -5225,17 +5552,9 @@ declare namespace gapi.client {
5225
5552
  string;
5226
5553
  }): Request<GoogleLongrunningListOperationsResponse>;
5227
5554
  }
5228
- interface CollectionsResource {
5229
- dataStores:
5230
- DataStoresResource;
5231
- engines:
5232
- EnginesResource;
5233
- operations:
5234
- OperationsResource;
5235
- }
5236
- interface DocumentsResource {
5237
- /** Creates a Document. */
5238
- create(request: {
5555
+ interface ServingConfigsResource {
5556
+ /** Makes a recommendation, which requires a contextual user event. */
5557
+ recommend(request: {
5239
5558
  /** V1 error format. */
5240
5559
  "$.xgafv"?:
5241
5560
  string;
@@ -5248,14 +5567,6 @@ declare namespace gapi.client {
5248
5567
  /** JSONP */
5249
5568
  callback?:
5250
5569
  string;
5251
- /**
5252
- * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
5253
- * of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
5254
- * returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
5255
- * returned.
5256
- */
5257
- documentId?:
5258
- string;
5259
5570
  /** Selector specifying which fields to include in a partial response. */
5260
5571
  fields?:
5261
5572
  string;
@@ -5265,15 +5576,20 @@ declare namespace gapi.client {
5265
5576
  /** OAuth 2.0 token for the current user. */
5266
5577
  oauth_token?:
5267
5578
  string;
5268
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
5269
- parent:
5270
- string;
5271
5579
  /** Returns response with indentations and line breaks. */
5272
5580
  prettyPrint?:
5273
5581
  boolean;
5274
5582
  /** 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. */
5275
5583
  quotaUser?:
5276
5584
  string;
5585
+ /**
5586
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
5587
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
5588
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
5589
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
5590
+ */
5591
+ servingConfig:
5592
+ string;
5277
5593
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5278
5594
  upload_protocol?:
5279
5595
  string;
@@ -5282,9 +5598,9 @@ declare namespace gapi.client {
5282
5598
  string;
5283
5599
  /** Request body */
5284
5600
  resource:
5285
- GoogleCloudDiscoveryengineV1alphaDocument;
5286
- }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5287
- create(request: {
5601
+ GoogleCloudDiscoveryengineV1alphaRecommendRequest;
5602
+ }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5603
+ recommend(request: {
5288
5604
  /** V1 error format. */
5289
5605
  "$.xgafv"?:
5290
5606
  string;
@@ -5297,14 +5613,6 @@ declare namespace gapi.client {
5297
5613
  /** JSONP */
5298
5614
  callback?:
5299
5615
  string;
5300
- /**
5301
- * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
5302
- * of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
5303
- * returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
5304
- * returned.
5305
- */
5306
- documentId?:
5307
- string;
5308
5616
  /** Selector specifying which fields to include in a partial response. */
5309
5617
  fields?:
5310
5618
  string;
@@ -5314,15 +5622,20 @@ declare namespace gapi.client {
5314
5622
  /** OAuth 2.0 token for the current user. */
5315
5623
  oauth_token?:
5316
5624
  string;
5317
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
5318
- parent:
5319
- string;
5320
5625
  /** Returns response with indentations and line breaks. */
5321
5626
  prettyPrint?:
5322
5627
  boolean;
5323
5628
  /** 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. */
5324
5629
  quotaUser?:
5325
5630
  string;
5631
+ /**
5632
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
5633
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
5634
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
5635
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
5636
+ */
5637
+ servingConfig:
5638
+ string;
5326
5639
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5327
5640
  upload_protocol?:
5328
5641
  string;
@@ -5330,9 +5643,9 @@ declare namespace gapi.client {
5330
5643
  uploadType?:
5331
5644
  string;
5332
5645
  },
5333
- body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5334
- /** Deletes a Document. */
5335
- delete(request?: {
5646
+ body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5647
+ /** Performs a search. */
5648
+ search(request: {
5336
5649
  /** V1 error format. */
5337
5650
  "$.xgafv"?:
5338
5651
  string;
@@ -5351,13 +5664,6 @@ declare namespace gapi.client {
5351
5664
  /** 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. */
5352
5665
  key?:
5353
5666
  string;
5354
- /**
5355
- * Required. Full resource name of Document, such as
5356
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
5357
- * delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.
5358
- */
5359
- name:
5360
- string;
5361
5667
  /** OAuth 2.0 token for the current user. */
5362
5668
  oauth_token?:
5363
5669
  string;
@@ -5367,15 +5673,24 @@ declare namespace gapi.client {
5367
5673
  /** 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. */
5368
5674
  quotaUser?:
5369
5675
  string;
5676
+ /**
5677
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
5678
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
5679
+ * configuration name, set of models used to make the search.
5680
+ */
5681
+ servingConfig:
5682
+ string;
5370
5683
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5371
5684
  upload_protocol?:
5372
5685
  string;
5373
5686
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5374
5687
  uploadType?:
5375
5688
  string;
5376
- }): Request<{}>;
5377
- /** Gets a Document. */
5378
- get(request?: {
5689
+ /** Request body */
5690
+ resource:
5691
+ GoogleCloudDiscoveryengineV1alphaSearchRequest;
5692
+ }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5693
+ search(request: {
5379
5694
  /** V1 error format. */
5380
5695
  "$.xgafv"?:
5381
5696
  string;
@@ -5394,13 +5709,6 @@ declare namespace gapi.client {
5394
5709
  /** 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. */
5395
5710
  key?:
5396
5711
  string;
5397
- /**
5398
- * Required. Full resource name of Document, such as
5399
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
5400
- * access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
5401
- */
5402
- name:
5403
- string;
5404
5712
  /** OAuth 2.0 token for the current user. */
5405
5713
  oauth_token?:
5406
5714
  string;
@@ -5410,18 +5718,25 @@ declare namespace gapi.client {
5410
5718
  /** 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. */
5411
5719
  quotaUser?:
5412
5720
  string;
5721
+ /**
5722
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
5723
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
5724
+ * configuration name, set of models used to make the search.
5725
+ */
5726
+ servingConfig:
5727
+ string;
5413
5728
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5414
5729
  upload_protocol?:
5415
5730
  string;
5416
5731
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5417
5732
  uploadType?:
5418
5733
  string;
5419
- }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5420
- /**
5421
- * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully
5422
- * updated.
5423
- */
5424
- import(request: {
5734
+ },
5735
+ body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5736
+ }
5737
+ interface EnginesResource {
5738
+ /** Creates a Engine. */
5739
+ create(request: {
5425
5740
  /** V1 error format. */
5426
5741
  "$.xgafv"?:
5427
5742
  string;
@@ -5434,6 +5749,12 @@ declare namespace gapi.client {
5434
5749
  /** JSONP */
5435
5750
  callback?:
5436
5751
  string;
5752
+ /**
5753
+ * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to
5754
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5755
+ */
5756
+ engineId?:
5757
+ string;
5437
5758
  /** Selector specifying which fields to include in a partial response. */
5438
5759
  fields?:
5439
5760
  string;
@@ -5443,10 +5764,7 @@ declare namespace gapi.client {
5443
5764
  /** OAuth 2.0 token for the current user. */
5444
5765
  oauth_token?:
5445
5766
  string;
5446
- /**
5447
- * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
5448
- * create/update permission.
5449
- */
5767
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5450
5768
  parent:
5451
5769
  string;
5452
5770
  /** Returns response with indentations and line breaks. */
@@ -5463,9 +5781,9 @@ declare namespace gapi.client {
5463
5781
  string;
5464
5782
  /** Request body */
5465
5783
  resource:
5466
- GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
5784
+ GoogleCloudDiscoveryengineV1alphaEngine;
5467
5785
  }): Request<GoogleLongrunningOperation>;
5468
- import(request: {
5786
+ create(request: {
5469
5787
  /** V1 error format. */
5470
5788
  "$.xgafv"?:
5471
5789
  string;
@@ -5478,6 +5796,12 @@ declare namespace gapi.client {
5478
5796
  /** JSONP */
5479
5797
  callback?:
5480
5798
  string;
5799
+ /**
5800
+ * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to
5801
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5802
+ */
5803
+ engineId?:
5804
+ string;
5481
5805
  /** Selector specifying which fields to include in a partial response. */
5482
5806
  fields?:
5483
5807
  string;
@@ -5487,10 +5811,7 @@ declare namespace gapi.client {
5487
5811
  /** OAuth 2.0 token for the current user. */
5488
5812
  oauth_token?:
5489
5813
  string;
5490
- /**
5491
- * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
5492
- * create/update permission.
5493
- */
5814
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5494
5815
  parent:
5495
5816
  string;
5496
5817
  /** Returns response with indentations and line breaks. */
@@ -5506,9 +5827,9 @@ declare namespace gapi.client {
5506
5827
  uploadType?:
5507
5828
  string;
5508
5829
  },
5509
- body: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest): Request<GoogleLongrunningOperation>;
5510
- /** Gets a list of Documents. */
5511
- list(request?: {
5830
+ body: GoogleCloudDiscoveryengineV1alphaEngine): Request<GoogleLongrunningOperation>;
5831
+ /** Deletes a Engine. */
5832
+ delete(request?: {
5512
5833
  /** V1 error format. */
5513
5834
  "$.xgafv"?:
5514
5835
  string;
@@ -5527,27 +5848,14 @@ declare namespace gapi.client {
5527
5848
  /** 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. */
5528
5849
  key?:
5529
5850
  string;
5530
- /** OAuth 2.0 token for the current user. */
5531
- oauth_token?:
5532
- string;
5533
- /**
5534
- * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative,
5535
- * an `INVALID_ARGUMENT` error is returned.
5536
- */
5537
- pageSize?:
5538
- number;
5539
5851
  /**
5540
- * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating,
5541
- * all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
5852
+ * Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission
5853
+ * to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
5542
5854
  */
5543
- pageToken?:
5855
+ name:
5544
5856
  string;
5545
- /**
5546
- * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
5547
- * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether
5548
- * or not this branch exists, a `PERMISSION_DENIED` error is returned.
5549
- */
5550
- parent:
5857
+ /** OAuth 2.0 token for the current user. */
5858
+ oauth_token?:
5551
5859
  string;
5552
5860
  /** Returns response with indentations and line breaks. */
5553
5861
  prettyPrint?:
@@ -5561,18 +5869,15 @@ declare namespace gapi.client {
5561
5869
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5562
5870
  uploadType?:
5563
5871
  string;
5564
- }): Request<GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
5565
- /** Updates a Document. */
5566
- patch(request: {
5872
+ }): Request<{}>;
5873
+ /** Gets a Engine. */
5874
+ get(request?: {
5567
5875
  /** V1 error format. */
5568
5876
  "$.xgafv"?:
5569
5877
  string;
5570
5878
  /** OAuth access token. */
5571
5879
  access_token?:
5572
5880
  string;
5573
- /** If set to true, and the Document is not found, a new Document will be created. */
5574
- allowMissing?:
5575
- boolean;
5576
5881
  /** Data format for response. */
5577
5882
  alt?:
5578
5883
  string;
@@ -5585,11 +5890,7 @@ declare namespace gapi.client {
5585
5890
  /** 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. */
5586
5891
  key?:
5587
5892
  string;
5588
- /**
5589
- * Immutable. The full resource name of the document. Format:
5590
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
5591
- * with a length limit of 1024 characters.
5592
- */
5893
+ /** Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
5593
5894
  name:
5594
5895
  string;
5595
5896
  /** OAuth 2.0 token for the current user. */
@@ -5607,20 +5908,15 @@ declare namespace gapi.client {
5607
5908
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5608
5909
  uploadType?:
5609
5910
  string;
5610
- /** Request body */
5611
- resource:
5612
- GoogleCloudDiscoveryengineV1alphaDocument;
5613
- }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5614
- patch(request: {
5911
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
5912
+ /** Lists all the Engines associated with the project. */
5913
+ list(request?: {
5615
5914
  /** V1 error format. */
5616
5915
  "$.xgafv"?:
5617
5916
  string;
5618
5917
  /** OAuth access token. */
5619
5918
  access_token?:
5620
5919
  string;
5621
- /** If set to true, and the Document is not found, a new Document will be created. */
5622
- allowMissing?:
5623
- boolean;
5624
5920
  /** Data format for response. */
5625
5921
  alt?:
5626
5922
  string;
@@ -5630,19 +5926,24 @@ declare namespace gapi.client {
5630
5926
  /** Selector specifying which fields to include in a partial response. */
5631
5927
  fields?:
5632
5928
  string;
5929
+ /** Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH */
5930
+ filter?:
5931
+ string;
5633
5932
  /** 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. */
5634
5933
  key?:
5635
5934
  string;
5636
- /**
5637
- * Immutable. The full resource name of the document. Format:
5638
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
5639
- * with a length limit of 1024 characters.
5640
- */
5641
- name:
5642
- string;
5643
5935
  /** OAuth 2.0 token for the current user. */
5644
5936
  oauth_token?:
5645
5937
  string;
5938
+ /** Optional. Not supported. */
5939
+ pageSize?:
5940
+ number;
5941
+ /** Optional. Not supported. */
5942
+ pageToken?:
5943
+ string;
5944
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. */
5945
+ parent:
5946
+ string;
5646
5947
  /** Returns response with indentations and line breaks. */
5647
5948
  prettyPrint?:
5648
5949
  boolean;
@@ -5655,14 +5956,9 @@ declare namespace gapi.client {
5655
5956
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5656
5957
  uploadType?:
5657
5958
  string;
5658
- },
5659
- body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5660
- /**
5661
- * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete.
5662
- * Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be
5663
- * deleted, set PurgeDocumentsRequest.force to false.
5664
- */
5665
- purge(request: {
5959
+ }): Request<GoogleCloudDiscoveryengineV1alphaListEnginesResponse>;
5960
+ /** Updates an Engine */
5961
+ patch(request: {
5666
5962
  /** V1 error format. */
5667
5963
  "$.xgafv"?:
5668
5964
  string;
@@ -5681,18 +5977,25 @@ declare namespace gapi.client {
5681
5977
  /** 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. */
5682
5978
  key?:
5683
5979
  string;
5980
+ /**
5981
+ * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format:
5982
+ * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an
5983
+ * INVALID_ARGUMENT error is returned.
5984
+ */
5985
+ name:
5986
+ string;
5684
5987
  /** OAuth 2.0 token for the current user. */
5685
5988
  oauth_token?:
5686
5989
  string;
5687
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
5688
- parent:
5689
- string;
5690
5990
  /** Returns response with indentations and line breaks. */
5691
5991
  prettyPrint?:
5692
5992
  boolean;
5693
5993
  /** 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. */
5694
5994
  quotaUser?:
5695
5995
  string;
5996
+ /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
5997
+ updateMask?:
5998
+ string;
5696
5999
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5697
6000
  upload_protocol?:
5698
6001
  string;
@@ -5701,9 +6004,9 @@ declare namespace gapi.client {
5701
6004
  string;
5702
6005
  /** Request body */
5703
6006
  resource:
5704
- GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
5705
- }): Request<GoogleLongrunningOperation>;
5706
- purge(request: {
6007
+ GoogleCloudDiscoveryengineV1alphaEngine;
6008
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6009
+ patch(request: {
5707
6010
  /** V1 error format. */
5708
6011
  "$.xgafv"?:
5709
6012
  string;
@@ -5722,18 +6025,25 @@ declare namespace gapi.client {
5722
6025
  /** 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. */
5723
6026
  key?:
5724
6027
  string;
6028
+ /**
6029
+ * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format:
6030
+ * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an
6031
+ * INVALID_ARGUMENT error is returned.
6032
+ */
6033
+ name:
6034
+ string;
5725
6035
  /** OAuth 2.0 token for the current user. */
5726
6036
  oauth_token?:
5727
6037
  string;
5728
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
5729
- parent:
5730
- string;
5731
6038
  /** Returns response with indentations and line breaks. */
5732
6039
  prettyPrint?:
5733
6040
  boolean;
5734
6041
  /** 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. */
5735
6042
  quotaUser?:
5736
6043
  string;
6044
+ /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
6045
+ updateMask?:
6046
+ string;
5737
6047
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5738
6048
  upload_protocol?:
5739
6049
  string;
@@ -5741,11 +6051,9 @@ declare namespace gapi.client {
5741
6051
  uploadType?:
5742
6052
  string;
5743
6053
  },
5744
- body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest): Request<GoogleLongrunningOperation>;
5745
- }
5746
- interface OperationsResource {
5747
- /** 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. */
5748
- get(request?: {
6054
+ body: GoogleCloudDiscoveryengineV1alphaEngine): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6055
+ /** Pauses the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
6056
+ pause(request: {
5749
6057
  /** V1 error format. */
5750
6058
  "$.xgafv"?:
5751
6059
  string;
@@ -5764,7 +6072,7 @@ declare namespace gapi.client {
5764
6072
  /** 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. */
5765
6073
  key?:
5766
6074
  string;
5767
- /** The name of the operation resource. */
6075
+ /** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5768
6076
  name:
5769
6077
  string;
5770
6078
  /** OAuth 2.0 token for the current user. */
@@ -5782,9 +6090,11 @@ declare namespace gapi.client {
5782
6090
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5783
6091
  uploadType?:
5784
6092
  string;
5785
- }): Request<GoogleLongrunningOperation>;
5786
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
5787
- list(request?: {
6093
+ /** Request body */
6094
+ resource:
6095
+ GoogleCloudDiscoveryengineV1alphaPauseEngineRequest;
6096
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6097
+ pause(request: {
5788
6098
  /** V1 error format. */
5789
6099
  "$.xgafv"?:
5790
6100
  string;
@@ -5800,24 +6110,15 @@ declare namespace gapi.client {
5800
6110
  /** Selector specifying which fields to include in a partial response. */
5801
6111
  fields?:
5802
6112
  string;
5803
- /** The standard list filter. */
5804
- filter?:
5805
- string;
5806
6113
  /** 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. */
5807
6114
  key?:
5808
6115
  string;
5809
- /** The name of the operation's parent resource. */
6116
+ /** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5810
6117
  name:
5811
6118
  string;
5812
6119
  /** OAuth 2.0 token for the current user. */
5813
6120
  oauth_token?:
5814
6121
  string;
5815
- /** The standard list page size. */
5816
- pageSize?:
5817
- number;
5818
- /** The standard list page token. */
5819
- pageToken?:
5820
- string;
5821
6122
  /** Returns response with indentations and line breaks. */
5822
6123
  prettyPrint?:
5823
6124
  boolean;
@@ -5830,17 +6131,10 @@ declare namespace gapi.client {
5830
6131
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5831
6132
  uploadType?:
5832
6133
  string;
5833
- }): Request<GoogleLongrunningListOperationsResponse>;
5834
- }
5835
- interface BranchesResource {
5836
- documents:
5837
- DocumentsResource;
5838
- operations:
5839
- OperationsResource;
5840
- }
5841
- interface ConversationsResource {
5842
- /** Converses a conversation. */
5843
- converse(request: {
6134
+ },
6135
+ body: GoogleCloudDiscoveryengineV1alphaPauseEngineRequest): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6136
+ /** Resumes the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
6137
+ resume(request: {
5844
6138
  /** V1 error format. */
5845
6139
  "$.xgafv"?:
5846
6140
  string;
@@ -5859,12 +6153,7 @@ declare namespace gapi.client {
5859
6153
  /** 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. */
5860
6154
  key?:
5861
6155
  string;
5862
- /**
5863
- * Required. The resource name of the Conversation to get. Format:
5864
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
5865
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
5866
- * creates a new conversation inside a ConverseConversation session.
5867
- */
6156
+ /** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5868
6157
  name:
5869
6158
  string;
5870
6159
  /** OAuth 2.0 token for the current user. */
@@ -5884,9 +6173,9 @@ declare namespace gapi.client {
5884
6173
  string;
5885
6174
  /** Request body */
5886
6175
  resource:
5887
- GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
5888
- }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
5889
- converse(request: {
6176
+ GoogleCloudDiscoveryengineV1alphaResumeEngineRequest;
6177
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6178
+ resume(request: {
5890
6179
  /** V1 error format. */
5891
6180
  "$.xgafv"?:
5892
6181
  string;
@@ -5905,12 +6194,7 @@ declare namespace gapi.client {
5905
6194
  /** 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. */
5906
6195
  key?:
5907
6196
  string;
5908
- /**
5909
- * Required. The resource name of the Conversation to get. Format:
5910
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
5911
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
5912
- * creates a new conversation inside a ConverseConversation session.
5913
- */
6197
+ /** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5914
6198
  name:
5915
6199
  string;
5916
6200
  /** OAuth 2.0 token for the current user. */
@@ -5929,9 +6213,9 @@ declare namespace gapi.client {
5929
6213
  uploadType?:
5930
6214
  string;
5931
6215
  },
5932
- body: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
5933
- /** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
5934
- create(request: {
6216
+ body: GoogleCloudDiscoveryengineV1alphaResumeEngineRequest): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6217
+ /** Tunes an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
6218
+ tune(request: {
5935
6219
  /** V1 error format. */
5936
6220
  "$.xgafv"?:
5937
6221
  string;
@@ -5950,12 +6234,12 @@ declare namespace gapi.client {
5950
6234
  /** 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. */
5951
6235
  key?:
5952
6236
  string;
6237
+ /** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
6238
+ name:
6239
+ string;
5953
6240
  /** OAuth 2.0 token for the current user. */
5954
6241
  oauth_token?:
5955
6242
  string;
5956
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
5957
- parent:
5958
- string;
5959
6243
  /** Returns response with indentations and line breaks. */
5960
6244
  prettyPrint?:
5961
6245
  boolean;
@@ -5970,9 +6254,9 @@ declare namespace gapi.client {
5970
6254
  string;
5971
6255
  /** Request body */
5972
6256
  resource:
5973
- GoogleCloudDiscoveryengineV1alphaConversation;
5974
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
5975
- create(request: {
6257
+ GoogleCloudDiscoveryengineV1alphaTuneEngineRequest;
6258
+ }): Request<GoogleLongrunningOperation>;
6259
+ tune(request: {
5976
6260
  /** V1 error format. */
5977
6261
  "$.xgafv"?:
5978
6262
  string;
@@ -5991,12 +6275,12 @@ declare namespace gapi.client {
5991
6275
  /** 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. */
5992
6276
  key?:
5993
6277
  string;
6278
+ /** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
6279
+ name:
6280
+ string;
5994
6281
  /** OAuth 2.0 token for the current user. */
5995
6282
  oauth_token?:
5996
6283
  string;
5997
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
5998
- parent:
5999
- string;
6000
6284
  /** Returns response with indentations and line breaks. */
6001
6285
  prettyPrint?:
6002
6286
  boolean;
@@ -6010,9 +6294,15 @@ declare namespace gapi.client {
6010
6294
  uploadType?:
6011
6295
  string;
6012
6296
  },
6013
- body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
6014
- /** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
6015
- delete(request?: {
6297
+ body: GoogleCloudDiscoveryengineV1alphaTuneEngineRequest): Request<GoogleLongrunningOperation>;
6298
+ operations:
6299
+ OperationsResource;
6300
+ servingConfigs:
6301
+ ServingConfigsResource;
6302
+ }
6303
+ interface OperationsResource {
6304
+ /** 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. */
6305
+ get(request?: {
6016
6306
  /** V1 error format. */
6017
6307
  "$.xgafv"?:
6018
6308
  string;
@@ -6031,10 +6321,7 @@ declare namespace gapi.client {
6031
6321
  /** 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. */
6032
6322
  key?:
6033
6323
  string;
6034
- /**
6035
- * Required. The resource name of the Conversation to delete. Format:
6036
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
6037
- */
6324
+ /** The name of the operation resource. */
6038
6325
  name:
6039
6326
  string;
6040
6327
  /** OAuth 2.0 token for the current user. */
@@ -6052,9 +6339,9 @@ declare namespace gapi.client {
6052
6339
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6053
6340
  uploadType?:
6054
6341
  string;
6055
- }): Request<{}>;
6056
- /** Gets a Conversation. */
6057
- get(request?: {
6342
+ }): Request<GoogleLongrunningOperation>;
6343
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6344
+ list(request?: {
6058
6345
  /** V1 error format. */
6059
6346
  "$.xgafv"?:
6060
6347
  string;
@@ -6070,18 +6357,24 @@ declare namespace gapi.client {
6070
6357
  /** Selector specifying which fields to include in a partial response. */
6071
6358
  fields?:
6072
6359
  string;
6360
+ /** The standard list filter. */
6361
+ filter?:
6362
+ string;
6073
6363
  /** 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. */
6074
6364
  key?:
6075
6365
  string;
6076
- /**
6077
- * Required. The resource name of the Conversation to get. Format:
6078
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
6079
- */
6366
+ /** The name of the operation's parent resource. */
6080
6367
  name:
6081
6368
  string;
6082
6369
  /** OAuth 2.0 token for the current user. */
6083
6370
  oauth_token?:
6084
6371
  string;
6372
+ /** The standard list page size. */
6373
+ pageSize?:
6374
+ number;
6375
+ /** The standard list page token. */
6376
+ pageToken?:
6377
+ string;
6085
6378
  /** Returns response with indentations and line breaks. */
6086
6379
  prettyPrint?:
6087
6380
  boolean;
@@ -6094,9 +6387,19 @@ declare namespace gapi.client {
6094
6387
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6095
6388
  uploadType?:
6096
6389
  string;
6097
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
6098
- /** Lists all Conversations by their parent DataStore. */
6099
- list(request?: {
6390
+ }): Request<GoogleLongrunningListOperationsResponse>;
6391
+ }
6392
+ interface CollectionsResource {
6393
+ dataStores:
6394
+ DataStoresResource;
6395
+ engines:
6396
+ EnginesResource;
6397
+ operations:
6398
+ OperationsResource;
6399
+ }
6400
+ interface DocumentsResource {
6401
+ /** Creates a Document. */
6402
+ create(request: {
6100
6403
  /** V1 error format. */
6101
6404
  "$.xgafv"?:
6102
6405
  string;
@@ -6109,31 +6412,24 @@ declare namespace gapi.client {
6109
6412
  /** JSONP */
6110
6413
  callback?:
6111
6414
  string;
6415
+ /**
6416
+ * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
6417
+ * of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
6418
+ * returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
6419
+ * returned.
6420
+ */
6421
+ documentId?:
6422
+ string;
6112
6423
  /** Selector specifying which fields to include in a partial response. */
6113
6424
  fields?:
6114
6425
  string;
6115
- /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
6116
- filter?:
6117
- string;
6118
6426
  /** 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. */
6119
6427
  key?:
6120
6428
  string;
6121
6429
  /** OAuth 2.0 token for the current user. */
6122
6430
  oauth_token?:
6123
6431
  string;
6124
- /**
6125
- * 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` *
6126
- * `conversation_name` Example: "update_time desc" "create_time"
6127
- */
6128
- orderBy?:
6129
- string;
6130
- /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
6131
- pageSize?:
6132
- number;
6133
- /** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
6134
- pageToken?:
6135
- string;
6136
- /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
6432
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6137
6433
  parent:
6138
6434
  string;
6139
6435
  /** Returns response with indentations and line breaks. */
@@ -6148,9 +6444,11 @@ declare namespace gapi.client {
6148
6444
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6149
6445
  uploadType?:
6150
6446
  string;
6151
- }): Request<GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
6152
- /** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
6153
- patch(request: {
6447
+ /** Request body */
6448
+ resource:
6449
+ GoogleCloudDiscoveryengineV1alphaDocument;
6450
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6451
+ create(request: {
6154
6452
  /** V1 error format. */
6155
6453
  "$.xgafv"?:
6156
6454
  string;
@@ -6163,38 +6461,42 @@ declare namespace gapi.client {
6163
6461
  /** JSONP */
6164
6462
  callback?:
6165
6463
  string;
6464
+ /**
6465
+ * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless
6466
+ * of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
6467
+ * returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
6468
+ * returned.
6469
+ */
6470
+ documentId?:
6471
+ string;
6166
6472
  /** Selector specifying which fields to include in a partial response. */
6167
6473
  fields?:
6168
6474
  string;
6169
6475
  /** 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. */
6170
6476
  key?:
6171
6477
  string;
6172
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
6173
- name:
6174
- string;
6175
6478
  /** OAuth 2.0 token for the current user. */
6176
6479
  oauth_token?:
6177
6480
  string;
6481
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6482
+ parent:
6483
+ string;
6178
6484
  /** Returns response with indentations and line breaks. */
6179
6485
  prettyPrint?:
6180
6486
  boolean;
6181
6487
  /** 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. */
6182
6488
  quotaUser?:
6183
6489
  string;
6184
- /** 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. */
6185
- updateMask?:
6186
- string;
6187
6490
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6188
6491
  upload_protocol?:
6189
6492
  string;
6190
6493
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6191
6494
  uploadType?:
6192
6495
  string;
6193
- /** Request body */
6194
- resource:
6195
- GoogleCloudDiscoveryengineV1alphaConversation;
6196
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
6197
- patch(request: {
6496
+ },
6497
+ body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6498
+ /** Deletes a Document. */
6499
+ delete(request?: {
6198
6500
  /** V1 error format. */
6199
6501
  "$.xgafv"?:
6200
6502
  string;
@@ -6213,7 +6515,11 @@ declare namespace gapi.client {
6213
6515
  /** 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. */
6214
6516
  key?:
6215
6517
  string;
6216
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
6518
+ /**
6519
+ * Required. Full resource name of Document, such as
6520
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
6521
+ * delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.
6522
+ */
6217
6523
  name:
6218
6524
  string;
6219
6525
  /** OAuth 2.0 token for the current user. */
@@ -6225,20 +6531,14 @@ declare namespace gapi.client {
6225
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. */
6226
6532
  quotaUser?:
6227
6533
  string;
6228
- /** 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. */
6229
- updateMask?:
6230
- string;
6231
6534
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6232
6535
  upload_protocol?:
6233
6536
  string;
6234
6537
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6235
6538
  uploadType?:
6236
6539
  string;
6237
- },
6238
- body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
6239
- }
6240
- interface OperationsResource {
6241
- /** 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. */
6540
+ }): Request<{}>;
6541
+ /** Gets a Document. */
6242
6542
  get(request?: {
6243
6543
  /** V1 error format. */
6244
6544
  "$.xgafv"?:
@@ -6258,7 +6558,11 @@ declare namespace gapi.client {
6258
6558
  /** 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. */
6259
6559
  key?:
6260
6560
  string;
6261
- /** The name of the operation resource. */
6561
+ /**
6562
+ * Required. Full resource name of Document, such as
6563
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
6564
+ * access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
6565
+ */
6262
6566
  name:
6263
6567
  string;
6264
6568
  /** OAuth 2.0 token for the current user. */
@@ -6276,9 +6580,12 @@ declare namespace gapi.client {
6276
6580
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6277
6581
  uploadType?:
6278
6582
  string;
6279
- }): Request<GoogleLongrunningOperation>;
6280
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6281
- list(request?: {
6583
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6584
+ /**
6585
+ * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully
6586
+ * updated.
6587
+ */
6588
+ import(request: {
6282
6589
  /** V1 error format. */
6283
6590
  "$.xgafv"?:
6284
6591
  string;
@@ -6294,23 +6601,17 @@ declare namespace gapi.client {
6294
6601
  /** Selector specifying which fields to include in a partial response. */
6295
6602
  fields?:
6296
6603
  string;
6297
- /** The standard list filter. */
6298
- filter?:
6299
- string;
6300
6604
  /** 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. */
6301
6605
  key?:
6302
6606
  string;
6303
- /** The name of the operation's parent resource. */
6304
- name:
6305
- string;
6306
6607
  /** OAuth 2.0 token for the current user. */
6307
6608
  oauth_token?:
6308
6609
  string;
6309
- /** The standard list page size. */
6310
- pageSize?:
6311
- number;
6312
- /** The standard list page token. */
6313
- pageToken?:
6610
+ /**
6611
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
6612
+ * create/update permission.
6613
+ */
6614
+ parent:
6314
6615
  string;
6315
6616
  /** Returns response with indentations and line breaks. */
6316
6617
  prettyPrint?:
@@ -6324,15 +6625,11 @@ declare namespace gapi.client {
6324
6625
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6325
6626
  uploadType?:
6326
6627
  string;
6327
- }): Request<GoogleLongrunningListOperationsResponse>;
6328
- }
6329
- interface ModelsResource {
6330
- operations:
6331
- OperationsResource;
6332
- }
6333
- interface OperationsResource {
6334
- /** 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. */
6335
- get(request?: {
6628
+ /** Request body */
6629
+ resource:
6630
+ GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
6631
+ }): Request<GoogleLongrunningOperation>;
6632
+ import(request: {
6336
6633
  /** V1 error format. */
6337
6634
  "$.xgafv"?:
6338
6635
  string;
@@ -6351,17 +6648,20 @@ declare namespace gapi.client {
6351
6648
  /** 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. */
6352
6649
  key?:
6353
6650
  string;
6354
- /** The name of the operation resource. */
6355
- name:
6356
- string;
6357
6651
  /** OAuth 2.0 token for the current user. */
6358
6652
  oauth_token?:
6359
6653
  string;
6360
- /** Returns response with indentations and line breaks. */
6361
- prettyPrint?:
6362
- boolean;
6363
- /** 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. */
6364
- quotaUser?:
6654
+ /**
6655
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
6656
+ * create/update permission.
6657
+ */
6658
+ parent:
6659
+ string;
6660
+ /** Returns response with indentations and line breaks. */
6661
+ prettyPrint?:
6662
+ boolean;
6663
+ /** 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. */
6664
+ quotaUser?:
6365
6665
  string;
6366
6666
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6367
6667
  upload_protocol?:
@@ -6369,8 +6669,9 @@ declare namespace gapi.client {
6369
6669
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6370
6670
  uploadType?:
6371
6671
  string;
6372
- }): Request<GoogleLongrunningOperation>;
6373
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6672
+ },
6673
+ body: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest): Request<GoogleLongrunningOperation>;
6674
+ /** Gets a list of Documents. */
6374
6675
  list(request?: {
6375
6676
  /** V1 error format. */
6376
6677
  "$.xgafv"?:
@@ -6387,24 +6688,31 @@ declare namespace gapi.client {
6387
6688
  /** Selector specifying which fields to include in a partial response. */
6388
6689
  fields?:
6389
6690
  string;
6390
- /** The standard list filter. */
6391
- filter?:
6392
- string;
6393
6691
  /** 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. */
6394
6692
  key?:
6395
6693
  string;
6396
- /** The name of the operation's parent resource. */
6397
- name:
6398
- string;
6399
6694
  /** OAuth 2.0 token for the current user. */
6400
6695
  oauth_token?:
6401
6696
  string;
6402
- /** The standard list page size. */
6697
+ /**
6698
+ * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative,
6699
+ * an `INVALID_ARGUMENT` error is returned.
6700
+ */
6403
6701
  pageSize?:
6404
6702
  number;
6405
- /** The standard list page token. */
6703
+ /**
6704
+ * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating,
6705
+ * all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
6706
+ */
6406
6707
  pageToken?:
6407
6708
  string;
6709
+ /**
6710
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
6711
+ * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether
6712
+ * or not this branch exists, a `PERMISSION_DENIED` error is returned.
6713
+ */
6714
+ parent:
6715
+ string;
6408
6716
  /** Returns response with indentations and line breaks. */
6409
6717
  prettyPrint?:
6410
6718
  boolean;
@@ -6417,17 +6725,18 @@ declare namespace gapi.client {
6417
6725
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6418
6726
  uploadType?:
6419
6727
  string;
6420
- }): Request<GoogleLongrunningListOperationsResponse>;
6421
- }
6422
- interface SchemasResource {
6423
- /** Creates a Schema. */
6424
- create(request: {
6728
+ }): Request<GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
6729
+ /** Updates a Document. */
6730
+ patch(request: {
6425
6731
  /** V1 error format. */
6426
6732
  "$.xgafv"?:
6427
6733
  string;
6428
6734
  /** OAuth access token. */
6429
6735
  access_token?:
6430
6736
  string;
6737
+ /** If set to true, and the Document is not found, a new Document will be created. */
6738
+ allowMissing?:
6739
+ boolean;
6431
6740
  /** Data format for response. */
6432
6741
  alt?:
6433
6742
  string;
@@ -6440,23 +6749,69 @@ declare namespace gapi.client {
6440
6749
  /** 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. */
6441
6750
  key?:
6442
6751
  string;
6752
+ /**
6753
+ * Immutable. The full resource name of the document. Format:
6754
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
6755
+ * with a length limit of 1024 characters.
6756
+ */
6757
+ name:
6758
+ string;
6443
6759
  /** OAuth 2.0 token for the current user. */
6444
6760
  oauth_token?:
6445
6761
  string;
6446
- /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
6447
- parent:
6448
- string;
6449
6762
  /** Returns response with indentations and line breaks. */
6450
6763
  prettyPrint?:
6451
6764
  boolean;
6452
6765
  /** 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. */
6453
6766
  quotaUser?:
6454
6767
  string;
6768
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6769
+ upload_protocol?:
6770
+ string;
6771
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6772
+ uploadType?:
6773
+ string;
6774
+ /** Request body */
6775
+ resource:
6776
+ GoogleCloudDiscoveryengineV1alphaDocument;
6777
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6778
+ patch(request: {
6779
+ /** V1 error format. */
6780
+ "$.xgafv"?:
6781
+ string;
6782
+ /** OAuth access token. */
6783
+ access_token?:
6784
+ string;
6785
+ /** If set to true, and the Document is not found, a new Document will be created. */
6786
+ allowMissing?:
6787
+ boolean;
6788
+ /** Data format for response. */
6789
+ alt?:
6790
+ string;
6791
+ /** JSONP */
6792
+ callback?:
6793
+ string;
6794
+ /** Selector specifying which fields to include in a partial response. */
6795
+ fields?:
6796
+ string;
6797
+ /** 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. */
6798
+ key?:
6799
+ string;
6455
6800
  /**
6456
- * Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
6457
- * standard with a length limit of 63 characters.
6801
+ * Immutable. The full resource name of the document. Format:
6802
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
6803
+ * with a length limit of 1024 characters.
6458
6804
  */
6459
- schemaId?:
6805
+ name:
6806
+ string;
6807
+ /** OAuth 2.0 token for the current user. */
6808
+ oauth_token?:
6809
+ string;
6810
+ /** Returns response with indentations and line breaks. */
6811
+ prettyPrint?:
6812
+ boolean;
6813
+ /** 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. */
6814
+ quotaUser?:
6460
6815
  string;
6461
6816
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6462
6817
  upload_protocol?:
@@ -6464,11 +6819,14 @@ declare namespace gapi.client {
6464
6819
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6465
6820
  uploadType?:
6466
6821
  string;
6467
- /** Request body */
6468
- resource:
6469
- GoogleCloudDiscoveryengineV1alphaSchema;
6470
- }): Request<GoogleLongrunningOperation>;
6471
- create(request: {
6822
+ },
6823
+ body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6824
+ /**
6825
+ * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete.
6826
+ * Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be
6827
+ * deleted, set PurgeDocumentsRequest.force to false.
6828
+ */
6829
+ purge(request: {
6472
6830
  /** V1 error format. */
6473
6831
  "$.xgafv"?:
6474
6832
  string;
@@ -6490,7 +6848,7 @@ declare namespace gapi.client {
6490
6848
  /** OAuth 2.0 token for the current user. */
6491
6849
  oauth_token?:
6492
6850
  string;
6493
- /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
6851
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6494
6852
  parent:
6495
6853
  string;
6496
6854
  /** Returns response with indentations and line breaks. */
@@ -6499,22 +6857,17 @@ declare namespace gapi.client {
6499
6857
  /** 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. */
6500
6858
  quotaUser?:
6501
6859
  string;
6502
- /**
6503
- * Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
6504
- * standard with a length limit of 63 characters.
6505
- */
6506
- schemaId?:
6507
- string;
6508
6860
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6509
6861
  upload_protocol?:
6510
6862
  string;
6511
6863
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6512
6864
  uploadType?:
6513
6865
  string;
6514
- },
6515
- body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
6516
- /** Deletes a Schema. */
6517
- delete(request?: {
6866
+ /** Request body */
6867
+ resource:
6868
+ GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
6869
+ }): Request<GoogleLongrunningOperation>;
6870
+ purge(request: {
6518
6871
  /** V1 error format. */
6519
6872
  "$.xgafv"?:
6520
6873
  string;
@@ -6533,12 +6886,12 @@ declare namespace gapi.client {
6533
6886
  /** 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. */
6534
6887
  key?:
6535
6888
  string;
6536
- /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
6537
- name:
6538
- string;
6539
6889
  /** OAuth 2.0 token for the current user. */
6540
6890
  oauth_token?:
6541
6891
  string;
6892
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6893
+ parent:
6894
+ string;
6542
6895
  /** Returns response with indentations and line breaks. */
6543
6896
  prettyPrint?:
6544
6897
  boolean;
@@ -6551,8 +6904,11 @@ declare namespace gapi.client {
6551
6904
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6552
6905
  uploadType?:
6553
6906
  string;
6554
- }): Request<GoogleLongrunningOperation>;
6555
- /** Gets a Schema. */
6907
+ },
6908
+ body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest): Request<GoogleLongrunningOperation>;
6909
+ }
6910
+ interface OperationsResource {
6911
+ /** 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. */
6556
6912
  get(request?: {
6557
6913
  /** V1 error format. */
6558
6914
  "$.xgafv"?:
@@ -6572,7 +6928,7 @@ declare namespace gapi.client {
6572
6928
  /** 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. */
6573
6929
  key?:
6574
6930
  string;
6575
- /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
6931
+ /** The name of the operation resource. */
6576
6932
  name:
6577
6933
  string;
6578
6934
  /** OAuth 2.0 token for the current user. */
@@ -6590,8 +6946,8 @@ declare namespace gapi.client {
6590
6946
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6591
6947
  uploadType?:
6592
6948
  string;
6593
- }): Request<GoogleCloudDiscoveryengineV1alphaSchema>;
6594
- /** Gets a list of Schemas. */
6949
+ }): Request<GoogleLongrunningOperation>;
6950
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6595
6951
  list(request?: {
6596
6952
  /** V1 error format. */
6597
6953
  "$.xgafv"?:
@@ -6608,27 +6964,24 @@ declare namespace gapi.client {
6608
6964
  /** Selector specifying which fields to include in a partial response. */
6609
6965
  fields?:
6610
6966
  string;
6967
+ /** The standard list filter. */
6968
+ filter?:
6969
+ string;
6611
6970
  /** 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. */
6612
6971
  key?:
6613
6972
  string;
6973
+ /** The name of the operation's parent resource. */
6974
+ name:
6975
+ string;
6614
6976
  /** OAuth 2.0 token for the current user. */
6615
6977
  oauth_token?:
6616
6978
  string;
6617
- /**
6618
- * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values
6619
- * above 1000 will be coerced to 1000.
6620
- */
6979
+ /** The standard list page size. */
6621
6980
  pageSize?:
6622
6981
  number;
6623
- /**
6624
- * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
6625
- * SchemaService.ListSchemas must match the call that provided the page token.
6626
- */
6982
+ /** The standard list page token. */
6627
6983
  pageToken?:
6628
6984
  string;
6629
- /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
6630
- parent:
6631
- string;
6632
6985
  /** Returns response with indentations and line breaks. */
6633
6986
  prettyPrint?:
6634
6987
  boolean;
@@ -6641,18 +6994,23 @@ declare namespace gapi.client {
6641
6994
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6642
6995
  uploadType?:
6643
6996
  string;
6644
- }): Request<GoogleCloudDiscoveryengineV1alphaListSchemasResponse>;
6645
- /** Updates a Schema. */
6646
- patch(request: {
6997
+ }): Request<GoogleLongrunningListOperationsResponse>;
6998
+ }
6999
+ interface BranchesResource {
7000
+ documents:
7001
+ DocumentsResource;
7002
+ operations:
7003
+ OperationsResource;
7004
+ }
7005
+ interface ConversationsResource {
7006
+ /** Converses a conversation. */
7007
+ converse(request: {
6647
7008
  /** V1 error format. */
6648
7009
  "$.xgafv"?:
6649
7010
  string;
6650
7011
  /** OAuth access token. */
6651
7012
  access_token?:
6652
7013
  string;
6653
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
6654
- allowMissing?:
6655
- boolean;
6656
7014
  /** Data format for response. */
6657
7015
  alt?:
6658
7016
  string;
@@ -6666,8 +7024,10 @@ declare namespace gapi.client {
6666
7024
  key?:
6667
7025
  string;
6668
7026
  /**
6669
- * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
6670
- * This field must be a UTF-8 encoded string with a length limit of 1024 characters.
7027
+ * Required. The resource name of the Conversation to get. Format:
7028
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
7029
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
7030
+ * creates a new conversation inside a ConverseConversation session.
6671
7031
  */
6672
7032
  name:
6673
7033
  string;
@@ -6688,18 +7048,15 @@ declare namespace gapi.client {
6688
7048
  string;
6689
7049
  /** Request body */
6690
7050
  resource:
6691
- GoogleCloudDiscoveryengineV1alphaSchema;
6692
- }): Request<GoogleLongrunningOperation>;
6693
- patch(request: {
7051
+ GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
7052
+ }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
7053
+ converse(request: {
6694
7054
  /** V1 error format. */
6695
7055
  "$.xgafv"?:
6696
7056
  string;
6697
7057
  /** OAuth access token. */
6698
7058
  access_token?:
6699
7059
  string;
6700
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
6701
- allowMissing?:
6702
- boolean;
6703
7060
  /** Data format for response. */
6704
7061
  alt?:
6705
7062
  string;
@@ -6713,8 +7070,10 @@ declare namespace gapi.client {
6713
7070
  key?:
6714
7071
  string;
6715
7072
  /**
6716
- * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
6717
- * This field must be a UTF-8 encoded string with a length limit of 1024 characters.
7073
+ * Required. The resource name of the Conversation to get. Format:
7074
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
7075
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
7076
+ * creates a new conversation inside a ConverseConversation session.
6718
7077
  */
6719
7078
  name:
6720
7079
  string;
@@ -6734,11 +7093,9 @@ declare namespace gapi.client {
6734
7093
  uploadType?:
6735
7094
  string;
6736
7095
  },
6737
- body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
6738
- }
6739
- interface ServingConfigsResource {
6740
- /** Makes a recommendation, which requires a contextual user event. */
6741
- recommend(request: {
7096
+ body: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
7097
+ /** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
7098
+ create(request: {
6742
7099
  /** V1 error format. */
6743
7100
  "$.xgafv"?:
6744
7101
  string;
@@ -6760,18 +7117,15 @@ declare namespace gapi.client {
6760
7117
  /** OAuth 2.0 token for the current user. */
6761
7118
  oauth_token?:
6762
7119
  string;
7120
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7121
+ parent:
7122
+ string;
6763
7123
  /** Returns response with indentations and line breaks. */
6764
7124
  prettyPrint?:
6765
7125
  boolean;
6766
7126
  /** 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. */
6767
7127
  quotaUser?:
6768
7128
  string;
6769
- /**
6770
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
6771
- * you must create at least one serving config for it.
6772
- */
6773
- servingConfig:
6774
- string;
6775
7129
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6776
7130
  upload_protocol?:
6777
7131
  string;
@@ -6780,9 +7134,9 @@ declare namespace gapi.client {
6780
7134
  string;
6781
7135
  /** Request body */
6782
7136
  resource:
6783
- GoogleCloudDiscoveryengineV1alphaRecommendRequest;
6784
- }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
6785
- recommend(request: {
7137
+ GoogleCloudDiscoveryengineV1alphaConversation;
7138
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7139
+ create(request: {
6786
7140
  /** V1 error format. */
6787
7141
  "$.xgafv"?:
6788
7142
  string;
@@ -6804,18 +7158,1144 @@ declare namespace gapi.client {
6804
7158
  /** OAuth 2.0 token for the current user. */
6805
7159
  oauth_token?:
6806
7160
  string;
7161
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7162
+ parent:
7163
+ string;
7164
+ /** Returns response with indentations and line breaks. */
7165
+ prettyPrint?:
7166
+ boolean;
7167
+ /** 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. */
7168
+ quotaUser?:
7169
+ string;
7170
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7171
+ upload_protocol?:
7172
+ string;
7173
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7174
+ uploadType?:
7175
+ string;
7176
+ },
7177
+ body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7178
+ /** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
7179
+ delete(request?: {
7180
+ /** V1 error format. */
7181
+ "$.xgafv"?:
7182
+ string;
7183
+ /** OAuth access token. */
7184
+ access_token?:
7185
+ string;
7186
+ /** Data format for response. */
7187
+ alt?:
7188
+ string;
7189
+ /** JSONP */
7190
+ callback?:
7191
+ string;
7192
+ /** Selector specifying which fields to include in a partial response. */
7193
+ fields?:
7194
+ string;
7195
+ /** 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. */
7196
+ key?:
7197
+ string;
7198
+ /**
7199
+ * Required. The resource name of the Conversation to delete. Format:
7200
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
7201
+ */
7202
+ name:
7203
+ string;
7204
+ /** OAuth 2.0 token for the current user. */
7205
+ oauth_token?:
7206
+ string;
7207
+ /** Returns response with indentations and line breaks. */
7208
+ prettyPrint?:
7209
+ boolean;
7210
+ /** 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. */
7211
+ quotaUser?:
7212
+ string;
7213
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7214
+ upload_protocol?:
7215
+ string;
7216
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7217
+ uploadType?:
7218
+ string;
7219
+ }): Request<{}>;
7220
+ /** Gets a Conversation. */
7221
+ get(request?: {
7222
+ /** V1 error format. */
7223
+ "$.xgafv"?:
7224
+ string;
7225
+ /** OAuth access token. */
7226
+ access_token?:
7227
+ string;
7228
+ /** Data format for response. */
7229
+ alt?:
7230
+ string;
7231
+ /** JSONP */
7232
+ callback?:
7233
+ string;
7234
+ /** Selector specifying which fields to include in a partial response. */
7235
+ fields?:
7236
+ string;
7237
+ /** 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. */
7238
+ key?:
7239
+ string;
7240
+ /**
7241
+ * Required. The resource name of the Conversation to get. Format:
7242
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
7243
+ */
7244
+ name:
7245
+ string;
7246
+ /** OAuth 2.0 token for the current user. */
7247
+ oauth_token?:
7248
+ string;
7249
+ /** Returns response with indentations and line breaks. */
7250
+ prettyPrint?:
7251
+ boolean;
7252
+ /** 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. */
7253
+ quotaUser?:
7254
+ string;
7255
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7256
+ upload_protocol?:
7257
+ string;
7258
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7259
+ uploadType?:
7260
+ string;
7261
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7262
+ /** Lists all Conversations by their parent DataStore. */
7263
+ list(request?: {
7264
+ /** V1 error format. */
7265
+ "$.xgafv"?:
7266
+ string;
7267
+ /** OAuth access token. */
7268
+ access_token?:
7269
+ string;
7270
+ /** Data format for response. */
7271
+ alt?:
7272
+ string;
7273
+ /** JSONP */
7274
+ callback?:
7275
+ string;
7276
+ /** Selector specifying which fields to include in a partial response. */
7277
+ fields?:
7278
+ string;
7279
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
7280
+ filter?:
7281
+ string;
7282
+ /** 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. */
7283
+ key?:
7284
+ string;
7285
+ /** OAuth 2.0 token for the current user. */
7286
+ oauth_token?:
7287
+ string;
7288
+ /**
7289
+ * 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` *
7290
+ * `conversation_name` Example: "update_time desc" "create_time"
7291
+ */
7292
+ orderBy?:
7293
+ string;
7294
+ /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
7295
+ pageSize?:
7296
+ number;
7297
+ /** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
7298
+ pageToken?:
7299
+ string;
7300
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7301
+ parent:
7302
+ string;
7303
+ /** Returns response with indentations and line breaks. */
7304
+ prettyPrint?:
7305
+ boolean;
7306
+ /** 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. */
7307
+ quotaUser?:
7308
+ string;
7309
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7310
+ upload_protocol?:
7311
+ string;
7312
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7313
+ uploadType?:
7314
+ string;
7315
+ }): Request<GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
7316
+ /** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
7317
+ patch(request: {
7318
+ /** V1 error format. */
7319
+ "$.xgafv"?:
7320
+ string;
7321
+ /** OAuth access token. */
7322
+ access_token?:
7323
+ string;
7324
+ /** Data format for response. */
7325
+ alt?:
7326
+ string;
7327
+ /** JSONP */
7328
+ callback?:
7329
+ string;
7330
+ /** Selector specifying which fields to include in a partial response. */
7331
+ fields?:
7332
+ string;
7333
+ /** 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. */
7334
+ key?:
7335
+ string;
7336
+ /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
7337
+ name:
7338
+ string;
7339
+ /** OAuth 2.0 token for the current user. */
7340
+ oauth_token?:
7341
+ string;
7342
+ /** Returns response with indentations and line breaks. */
7343
+ prettyPrint?:
7344
+ boolean;
7345
+ /** 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. */
7346
+ quotaUser?:
7347
+ string;
7348
+ /** 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. */
7349
+ updateMask?:
7350
+ string;
7351
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7352
+ upload_protocol?:
7353
+ string;
7354
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7355
+ uploadType?:
7356
+ string;
7357
+ /** Request body */
7358
+ resource:
7359
+ GoogleCloudDiscoveryengineV1alphaConversation;
7360
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7361
+ patch(request: {
7362
+ /** V1 error format. */
7363
+ "$.xgafv"?:
7364
+ string;
7365
+ /** OAuth access token. */
7366
+ access_token?:
7367
+ string;
7368
+ /** Data format for response. */
7369
+ alt?:
7370
+ string;
7371
+ /** JSONP */
7372
+ callback?:
7373
+ string;
7374
+ /** Selector specifying which fields to include in a partial response. */
7375
+ fields?:
7376
+ string;
7377
+ /** 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. */
7378
+ key?:
7379
+ string;
7380
+ /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
7381
+ name:
7382
+ string;
7383
+ /** OAuth 2.0 token for the current user. */
7384
+ oauth_token?:
7385
+ string;
7386
+ /** Returns response with indentations and line breaks. */
7387
+ prettyPrint?:
7388
+ boolean;
7389
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
7390
+ quotaUser?:
7391
+ string;
7392
+ /** 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. */
7393
+ updateMask?:
7394
+ string;
7395
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7396
+ upload_protocol?:
7397
+ string;
7398
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7399
+ uploadType?:
7400
+ string;
7401
+ },
7402
+ body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7403
+ }
7404
+ interface OperationsResource {
7405
+ /** 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. */
7406
+ get(request?: {
7407
+ /** V1 error format. */
7408
+ "$.xgafv"?:
7409
+ string;
7410
+ /** OAuth access token. */
7411
+ access_token?:
7412
+ string;
7413
+ /** Data format for response. */
7414
+ alt?:
7415
+ string;
7416
+ /** JSONP */
7417
+ callback?:
7418
+ string;
7419
+ /** Selector specifying which fields to include in a partial response. */
7420
+ fields?:
7421
+ string;
7422
+ /** 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. */
7423
+ key?:
7424
+ string;
7425
+ /** The name of the operation resource. */
7426
+ name:
7427
+ string;
7428
+ /** OAuth 2.0 token for the current user. */
7429
+ oauth_token?:
7430
+ string;
7431
+ /** Returns response with indentations and line breaks. */
7432
+ prettyPrint?:
7433
+ boolean;
7434
+ /** 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. */
7435
+ quotaUser?:
7436
+ string;
7437
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7438
+ upload_protocol?:
7439
+ string;
7440
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7441
+ uploadType?:
7442
+ string;
7443
+ }): Request<GoogleLongrunningOperation>;
7444
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7445
+ list(request?: {
7446
+ /** V1 error format. */
7447
+ "$.xgafv"?:
7448
+ string;
7449
+ /** OAuth access token. */
7450
+ access_token?:
7451
+ string;
7452
+ /** Data format for response. */
7453
+ alt?:
7454
+ string;
7455
+ /** JSONP */
7456
+ callback?:
7457
+ string;
7458
+ /** Selector specifying which fields to include in a partial response. */
7459
+ fields?:
7460
+ string;
7461
+ /** The standard list filter. */
7462
+ filter?:
7463
+ string;
7464
+ /** 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. */
7465
+ key?:
7466
+ string;
7467
+ /** The name of the operation's parent resource. */
7468
+ name:
7469
+ string;
7470
+ /** OAuth 2.0 token for the current user. */
7471
+ oauth_token?:
7472
+ string;
7473
+ /** The standard list page size. */
7474
+ pageSize?:
7475
+ number;
7476
+ /** The standard list page token. */
7477
+ pageToken?:
7478
+ string;
7479
+ /** Returns response with indentations and line breaks. */
7480
+ prettyPrint?:
7481
+ boolean;
7482
+ /** 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. */
7483
+ quotaUser?:
7484
+ string;
7485
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7486
+ upload_protocol?:
7487
+ string;
7488
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7489
+ uploadType?:
7490
+ string;
7491
+ }): Request<GoogleLongrunningListOperationsResponse>;
7492
+ }
7493
+ interface ModelsResource {
7494
+ operations:
7495
+ OperationsResource;
7496
+ }
7497
+ interface OperationsResource {
7498
+ /** 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. */
7499
+ get(request?: {
7500
+ /** V1 error format. */
7501
+ "$.xgafv"?:
7502
+ string;
7503
+ /** OAuth access token. */
7504
+ access_token?:
7505
+ string;
7506
+ /** Data format for response. */
7507
+ alt?:
7508
+ string;
7509
+ /** JSONP */
7510
+ callback?:
7511
+ string;
7512
+ /** Selector specifying which fields to include in a partial response. */
7513
+ fields?:
7514
+ string;
7515
+ /** 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. */
7516
+ key?:
7517
+ string;
7518
+ /** The name of the operation resource. */
7519
+ name:
7520
+ string;
7521
+ /** OAuth 2.0 token for the current user. */
7522
+ oauth_token?:
7523
+ string;
7524
+ /** Returns response with indentations and line breaks. */
7525
+ prettyPrint?:
7526
+ boolean;
7527
+ /** 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. */
7528
+ quotaUser?:
7529
+ string;
7530
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7531
+ upload_protocol?:
7532
+ string;
7533
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7534
+ uploadType?:
7535
+ string;
7536
+ }): Request<GoogleLongrunningOperation>;
7537
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7538
+ list(request?: {
7539
+ /** V1 error format. */
7540
+ "$.xgafv"?:
7541
+ string;
7542
+ /** OAuth access token. */
7543
+ access_token?:
7544
+ string;
7545
+ /** Data format for response. */
7546
+ alt?:
7547
+ string;
7548
+ /** JSONP */
7549
+ callback?:
7550
+ string;
7551
+ /** Selector specifying which fields to include in a partial response. */
7552
+ fields?:
7553
+ string;
7554
+ /** The standard list filter. */
7555
+ filter?:
7556
+ string;
7557
+ /** 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. */
7558
+ key?:
7559
+ string;
7560
+ /** The name of the operation's parent resource. */
7561
+ name:
7562
+ string;
7563
+ /** OAuth 2.0 token for the current user. */
7564
+ oauth_token?:
7565
+ string;
7566
+ /** The standard list page size. */
7567
+ pageSize?:
7568
+ number;
7569
+ /** The standard list page token. */
7570
+ pageToken?:
7571
+ string;
7572
+ /** Returns response with indentations and line breaks. */
7573
+ prettyPrint?:
7574
+ boolean;
7575
+ /** 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. */
7576
+ quotaUser?:
7577
+ string;
7578
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7579
+ upload_protocol?:
7580
+ string;
7581
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7582
+ uploadType?:
7583
+ string;
7584
+ }): Request<GoogleLongrunningListOperationsResponse>;
7585
+ }
7586
+ interface SchemasResource {
7587
+ /** Creates a Schema. */
7588
+ create(request: {
7589
+ /** V1 error format. */
7590
+ "$.xgafv"?:
7591
+ string;
7592
+ /** OAuth access token. */
7593
+ access_token?:
7594
+ string;
7595
+ /** Data format for response. */
7596
+ alt?:
7597
+ string;
7598
+ /** JSONP */
7599
+ callback?:
7600
+ string;
7601
+ /** Selector specifying which fields to include in a partial response. */
7602
+ fields?:
7603
+ string;
7604
+ /** 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. */
7605
+ key?:
7606
+ string;
7607
+ /** OAuth 2.0 token for the current user. */
7608
+ oauth_token?:
7609
+ string;
7610
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7611
+ parent:
7612
+ string;
7613
+ /** Returns response with indentations and line breaks. */
7614
+ prettyPrint?:
7615
+ boolean;
7616
+ /** 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. */
7617
+ quotaUser?:
7618
+ string;
7619
+ /**
7620
+ * Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
7621
+ * standard with a length limit of 63 characters.
7622
+ */
7623
+ schemaId?:
7624
+ string;
7625
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7626
+ upload_protocol?:
7627
+ string;
7628
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7629
+ uploadType?:
7630
+ string;
7631
+ /** Request body */
7632
+ resource:
7633
+ GoogleCloudDiscoveryengineV1alphaSchema;
7634
+ }): Request<GoogleLongrunningOperation>;
7635
+ create(request: {
7636
+ /** V1 error format. */
7637
+ "$.xgafv"?:
7638
+ string;
7639
+ /** OAuth access token. */
7640
+ access_token?:
7641
+ string;
7642
+ /** Data format for response. */
7643
+ alt?:
7644
+ string;
7645
+ /** JSONP */
7646
+ callback?:
7647
+ string;
7648
+ /** Selector specifying which fields to include in a partial response. */
7649
+ fields?:
7650
+ string;
7651
+ /** 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. */
7652
+ key?:
7653
+ string;
7654
+ /** OAuth 2.0 token for the current user. */
7655
+ oauth_token?:
7656
+ string;
7657
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7658
+ parent:
7659
+ string;
7660
+ /** Returns response with indentations and line breaks. */
7661
+ prettyPrint?:
7662
+ boolean;
7663
+ /** 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. */
7664
+ quotaUser?:
7665
+ string;
7666
+ /**
7667
+ * Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
7668
+ * standard with a length limit of 63 characters.
7669
+ */
7670
+ schemaId?:
7671
+ string;
7672
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7673
+ upload_protocol?:
7674
+ string;
7675
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7676
+ uploadType?:
7677
+ string;
7678
+ },
7679
+ body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
7680
+ /** Deletes a Schema. */
7681
+ delete(request?: {
7682
+ /** V1 error format. */
7683
+ "$.xgafv"?:
7684
+ string;
7685
+ /** OAuth access token. */
7686
+ access_token?:
7687
+ string;
7688
+ /** Data format for response. */
7689
+ alt?:
7690
+ string;
7691
+ /** JSONP */
7692
+ callback?:
7693
+ string;
7694
+ /** Selector specifying which fields to include in a partial response. */
7695
+ fields?:
7696
+ string;
7697
+ /** 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. */
7698
+ key?:
7699
+ string;
7700
+ /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
7701
+ name:
7702
+ string;
7703
+ /** OAuth 2.0 token for the current user. */
7704
+ oauth_token?:
7705
+ string;
7706
+ /** Returns response with indentations and line breaks. */
7707
+ prettyPrint?:
7708
+ boolean;
7709
+ /** 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. */
7710
+ quotaUser?:
7711
+ string;
7712
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7713
+ upload_protocol?:
7714
+ string;
7715
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7716
+ uploadType?:
7717
+ string;
7718
+ }): Request<GoogleLongrunningOperation>;
7719
+ /** Gets a Schema. */
7720
+ get(request?: {
7721
+ /** V1 error format. */
7722
+ "$.xgafv"?:
7723
+ string;
7724
+ /** OAuth access token. */
7725
+ access_token?:
7726
+ string;
7727
+ /** Data format for response. */
7728
+ alt?:
7729
+ string;
7730
+ /** JSONP */
7731
+ callback?:
7732
+ string;
7733
+ /** Selector specifying which fields to include in a partial response. */
7734
+ fields?:
7735
+ string;
7736
+ /** 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. */
7737
+ key?:
7738
+ string;
7739
+ /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
7740
+ name:
7741
+ string;
7742
+ /** OAuth 2.0 token for the current user. */
7743
+ oauth_token?:
7744
+ string;
7745
+ /** Returns response with indentations and line breaks. */
7746
+ prettyPrint?:
7747
+ boolean;
7748
+ /** 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. */
7749
+ quotaUser?:
7750
+ string;
7751
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7752
+ upload_protocol?:
7753
+ string;
7754
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7755
+ uploadType?:
7756
+ string;
7757
+ }): Request<GoogleCloudDiscoveryengineV1alphaSchema>;
7758
+ /** Gets a list of Schemas. */
7759
+ list(request?: {
7760
+ /** V1 error format. */
7761
+ "$.xgafv"?:
7762
+ string;
7763
+ /** OAuth access token. */
7764
+ access_token?:
7765
+ string;
7766
+ /** Data format for response. */
7767
+ alt?:
7768
+ string;
7769
+ /** JSONP */
7770
+ callback?:
7771
+ string;
7772
+ /** Selector specifying which fields to include in a partial response. */
7773
+ fields?:
7774
+ string;
7775
+ /** 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. */
7776
+ key?:
7777
+ string;
7778
+ /** OAuth 2.0 token for the current user. */
7779
+ oauth_token?:
7780
+ string;
7781
+ /**
7782
+ * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values
7783
+ * above 1000 will be coerced to 1000.
7784
+ */
7785
+ pageSize?:
7786
+ number;
7787
+ /**
7788
+ * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
7789
+ * SchemaService.ListSchemas must match the call that provided the page token.
7790
+ */
7791
+ pageToken?:
7792
+ string;
7793
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7794
+ parent:
7795
+ string;
7796
+ /** Returns response with indentations and line breaks. */
7797
+ prettyPrint?:
7798
+ boolean;
7799
+ /** 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. */
7800
+ quotaUser?:
7801
+ string;
7802
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7803
+ upload_protocol?:
7804
+ string;
7805
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7806
+ uploadType?:
7807
+ string;
7808
+ }): Request<GoogleCloudDiscoveryengineV1alphaListSchemasResponse>;
7809
+ /** Updates a Schema. */
7810
+ patch(request: {
7811
+ /** V1 error format. */
7812
+ "$.xgafv"?:
7813
+ string;
7814
+ /** OAuth access token. */
7815
+ access_token?:
7816
+ string;
7817
+ /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
7818
+ allowMissing?:
7819
+ boolean;
7820
+ /** Data format for response. */
7821
+ alt?:
7822
+ string;
7823
+ /** JSONP */
7824
+ callback?:
7825
+ string;
7826
+ /** Selector specifying which fields to include in a partial response. */
7827
+ fields?:
7828
+ string;
7829
+ /** 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. */
7830
+ key?:
7831
+ string;
7832
+ /**
7833
+ * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
7834
+ * This field must be a UTF-8 encoded string with a length limit of 1024 characters.
7835
+ */
7836
+ name:
7837
+ string;
7838
+ /** OAuth 2.0 token for the current user. */
7839
+ oauth_token?:
7840
+ string;
7841
+ /** Returns response with indentations and line breaks. */
7842
+ prettyPrint?:
7843
+ boolean;
7844
+ /** 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. */
7845
+ quotaUser?:
7846
+ string;
7847
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7848
+ upload_protocol?:
7849
+ string;
7850
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7851
+ uploadType?:
7852
+ string;
7853
+ /** Request body */
7854
+ resource:
7855
+ GoogleCloudDiscoveryengineV1alphaSchema;
7856
+ }): Request<GoogleLongrunningOperation>;
7857
+ patch(request: {
7858
+ /** V1 error format. */
7859
+ "$.xgafv"?:
7860
+ string;
7861
+ /** OAuth access token. */
7862
+ access_token?:
7863
+ string;
7864
+ /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
7865
+ allowMissing?:
7866
+ boolean;
7867
+ /** Data format for response. */
7868
+ alt?:
7869
+ string;
7870
+ /** JSONP */
7871
+ callback?:
7872
+ string;
7873
+ /** Selector specifying which fields to include in a partial response. */
7874
+ fields?:
7875
+ string;
7876
+ /** 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. */
7877
+ key?:
7878
+ string;
7879
+ /**
7880
+ * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
7881
+ * This field must be a UTF-8 encoded string with a length limit of 1024 characters.
7882
+ */
7883
+ name:
7884
+ string;
7885
+ /** OAuth 2.0 token for the current user. */
7886
+ oauth_token?:
7887
+ string;
7888
+ /** Returns response with indentations and line breaks. */
7889
+ prettyPrint?:
7890
+ boolean;
7891
+ /** 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. */
7892
+ quotaUser?:
7893
+ string;
7894
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7895
+ upload_protocol?:
7896
+ string;
7897
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7898
+ uploadType?:
7899
+ string;
7900
+ },
7901
+ body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
7902
+ }
7903
+ interface ServingConfigsResource {
7904
+ /** Makes a recommendation, which requires a contextual user event. */
7905
+ recommend(request: {
7906
+ /** V1 error format. */
7907
+ "$.xgafv"?:
7908
+ string;
7909
+ /** OAuth access token. */
7910
+ access_token?:
7911
+ string;
7912
+ /** Data format for response. */
7913
+ alt?:
7914
+ string;
7915
+ /** JSONP */
7916
+ callback?:
7917
+ string;
7918
+ /** Selector specifying which fields to include in a partial response. */
7919
+ fields?:
7920
+ string;
7921
+ /** 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. */
7922
+ key?:
7923
+ string;
7924
+ /** OAuth 2.0 token for the current user. */
7925
+ oauth_token?:
7926
+ string;
7927
+ /** Returns response with indentations and line breaks. */
7928
+ prettyPrint?:
7929
+ boolean;
7930
+ /** 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. */
7931
+ quotaUser?:
7932
+ string;
7933
+ /**
7934
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
7935
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
7936
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
7937
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
7938
+ */
7939
+ servingConfig:
7940
+ string;
7941
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7942
+ upload_protocol?:
7943
+ string;
7944
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7945
+ uploadType?:
7946
+ string;
7947
+ /** Request body */
7948
+ resource:
7949
+ GoogleCloudDiscoveryengineV1alphaRecommendRequest;
7950
+ }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
7951
+ recommend(request: {
7952
+ /** V1 error format. */
7953
+ "$.xgafv"?:
7954
+ string;
7955
+ /** OAuth access token. */
7956
+ access_token?:
7957
+ string;
7958
+ /** Data format for response. */
7959
+ alt?:
7960
+ string;
7961
+ /** JSONP */
7962
+ callback?:
7963
+ string;
7964
+ /** Selector specifying which fields to include in a partial response. */
7965
+ fields?:
7966
+ string;
7967
+ /** 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. */
7968
+ key?:
7969
+ string;
7970
+ /** OAuth 2.0 token for the current user. */
7971
+ oauth_token?:
7972
+ string;
7973
+ /** Returns response with indentations and line breaks. */
7974
+ prettyPrint?:
7975
+ boolean;
7976
+ /** 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. */
7977
+ quotaUser?:
7978
+ string;
7979
+ /**
7980
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
7981
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
7982
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
7983
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
7984
+ */
7985
+ servingConfig:
7986
+ string;
7987
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7988
+ upload_protocol?:
7989
+ string;
7990
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7991
+ uploadType?:
7992
+ string;
7993
+ },
7994
+ body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
7995
+ /** Performs a search. */
7996
+ search(request: {
7997
+ /** V1 error format. */
7998
+ "$.xgafv"?:
7999
+ string;
8000
+ /** OAuth access token. */
8001
+ access_token?:
8002
+ string;
8003
+ /** Data format for response. */
8004
+ alt?:
8005
+ string;
8006
+ /** JSONP */
8007
+ callback?:
8008
+ string;
8009
+ /** Selector specifying which fields to include in a partial response. */
8010
+ fields?:
8011
+ string;
8012
+ /** 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. */
8013
+ key?:
8014
+ string;
8015
+ /** OAuth 2.0 token for the current user. */
8016
+ oauth_token?:
8017
+ string;
8018
+ /** Returns response with indentations and line breaks. */
8019
+ prettyPrint?:
8020
+ boolean;
8021
+ /** 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. */
8022
+ quotaUser?:
8023
+ string;
8024
+ /**
8025
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
8026
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
8027
+ * configuration name, set of models used to make the search.
8028
+ */
8029
+ servingConfig:
8030
+ string;
8031
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8032
+ upload_protocol?:
8033
+ string;
8034
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8035
+ uploadType?:
8036
+ string;
8037
+ /** Request body */
8038
+ resource:
8039
+ GoogleCloudDiscoveryengineV1alphaSearchRequest;
8040
+ }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
8041
+ search(request: {
8042
+ /** V1 error format. */
8043
+ "$.xgafv"?:
8044
+ string;
8045
+ /** OAuth access token. */
8046
+ access_token?:
8047
+ string;
8048
+ /** Data format for response. */
8049
+ alt?:
8050
+ string;
8051
+ /** JSONP */
8052
+ callback?:
8053
+ string;
8054
+ /** Selector specifying which fields to include in a partial response. */
8055
+ fields?:
8056
+ string;
8057
+ /** 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. */
8058
+ key?:
8059
+ string;
8060
+ /** OAuth 2.0 token for the current user. */
8061
+ oauth_token?:
8062
+ string;
8063
+ /** Returns response with indentations and line breaks. */
8064
+ prettyPrint?:
8065
+ boolean;
8066
+ /** 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. */
8067
+ quotaUser?:
8068
+ string;
8069
+ /**
8070
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
8071
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
8072
+ * configuration name, set of models used to make the search.
8073
+ */
8074
+ servingConfig:
8075
+ string;
8076
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8077
+ upload_protocol?:
8078
+ string;
8079
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8080
+ uploadType?:
8081
+ string;
8082
+ },
8083
+ body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
8084
+ }
8085
+ interface SiteSearchEngineResource {
8086
+ /** Request on-demand recrawl for a list of URIs. */
8087
+ recrawlUris(request: {
8088
+ /** V1 error format. */
8089
+ "$.xgafv"?:
8090
+ string;
8091
+ /** OAuth access token. */
8092
+ access_token?:
8093
+ string;
8094
+ /** Data format for response. */
8095
+ alt?:
8096
+ string;
8097
+ /** JSONP */
8098
+ callback?:
8099
+ string;
8100
+ /** Selector specifying which fields to include in a partial response. */
8101
+ fields?:
8102
+ string;
8103
+ /** 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. */
8104
+ key?:
8105
+ string;
8106
+ /** OAuth 2.0 token for the current user. */
8107
+ oauth_token?:
8108
+ string;
8109
+ /** Returns response with indentations and line breaks. */
8110
+ prettyPrint?:
8111
+ boolean;
8112
+ /** 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. */
8113
+ quotaUser?:
8114
+ string;
8115
+ /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
8116
+ siteSearchEngine:
8117
+ string;
8118
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8119
+ upload_protocol?:
8120
+ string;
8121
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8122
+ uploadType?:
8123
+ string;
8124
+ /** Request body */
8125
+ resource:
8126
+ GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
8127
+ }): Request<GoogleLongrunningOperation>;
8128
+ recrawlUris(request: {
8129
+ /** V1 error format. */
8130
+ "$.xgafv"?:
8131
+ string;
8132
+ /** OAuth access token. */
8133
+ access_token?:
8134
+ string;
8135
+ /** Data format for response. */
8136
+ alt?:
8137
+ string;
8138
+ /** JSONP */
8139
+ callback?:
8140
+ string;
8141
+ /** Selector specifying which fields to include in a partial response. */
8142
+ fields?:
8143
+ string;
8144
+ /** 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. */
8145
+ key?:
8146
+ string;
8147
+ /** OAuth 2.0 token for the current user. */
8148
+ oauth_token?:
8149
+ string;
8150
+ /** Returns response with indentations and line breaks. */
8151
+ prettyPrint?:
8152
+ boolean;
8153
+ /** 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. */
8154
+ quotaUser?:
8155
+ string;
8156
+ /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
8157
+ siteSearchEngine:
8158
+ string;
8159
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8160
+ upload_protocol?:
8161
+ string;
8162
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8163
+ uploadType?:
8164
+ string;
8165
+ },
8166
+ body: GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest): Request<GoogleLongrunningOperation>;
8167
+ }
8168
+ interface UserEventsResource {
8169
+ /**
8170
+ * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery
8171
+ * Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
8172
+ */
8173
+ collect(request?: {
8174
+ /** V1 error format. */
8175
+ "$.xgafv"?:
8176
+ string;
8177
+ /** OAuth access token. */
8178
+ access_token?:
8179
+ string;
8180
+ /** Data format for response. */
8181
+ alt?:
8182
+ string;
8183
+ /** JSONP */
8184
+ callback?:
8185
+ string;
8186
+ /** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
8187
+ ets?:
8188
+ string;
8189
+ /** Selector specifying which fields to include in a partial response. */
8190
+ fields?:
8191
+ string;
8192
+ /** 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. */
8193
+ key?:
8194
+ string;
8195
+ /** OAuth 2.0 token for the current user. */
8196
+ oauth_token?:
8197
+ string;
8198
+ /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8199
+ parent:
8200
+ string;
8201
+ /** Returns response with indentations and line breaks. */
8202
+ prettyPrint?:
8203
+ boolean;
8204
+ /** 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. */
8205
+ quotaUser?:
8206
+ string;
8207
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8208
+ upload_protocol?:
8209
+ string;
8210
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8211
+ uploadType?:
8212
+ string;
8213
+ /**
8214
+ * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
8215
+ * only send the domain for third-party requests.
8216
+ */
8217
+ uri?:
8218
+ string;
8219
+ /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
8220
+ userEvent?:
8221
+ string;
8222
+ }): Request<GoogleApiHttpBody>;
8223
+ /**
8224
+ * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
8225
+ * Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
8226
+ */
8227
+ import(request: {
8228
+ /** V1 error format. */
8229
+ "$.xgafv"?:
8230
+ string;
8231
+ /** OAuth access token. */
8232
+ access_token?:
8233
+ string;
8234
+ /** Data format for response. */
8235
+ alt?:
8236
+ string;
8237
+ /** JSONP */
8238
+ callback?:
8239
+ string;
8240
+ /** Selector specifying which fields to include in a partial response. */
8241
+ fields?:
8242
+ string;
8243
+ /** 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. */
8244
+ key?:
8245
+ string;
8246
+ /** OAuth 2.0 token for the current user. */
8247
+ oauth_token?:
8248
+ string;
8249
+ /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8250
+ parent:
8251
+ string;
8252
+ /** Returns response with indentations and line breaks. */
8253
+ prettyPrint?:
8254
+ boolean;
8255
+ /** 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. */
8256
+ quotaUser?:
8257
+ string;
8258
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8259
+ upload_protocol?:
8260
+ string;
8261
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8262
+ uploadType?:
8263
+ string;
8264
+ /** Request body */
8265
+ resource:
8266
+ GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest;
8267
+ }): Request<GoogleLongrunningOperation>;
8268
+ import(request: {
8269
+ /** V1 error format. */
8270
+ "$.xgafv"?:
8271
+ string;
8272
+ /** OAuth access token. */
8273
+ access_token?:
8274
+ string;
8275
+ /** Data format for response. */
8276
+ alt?:
8277
+ string;
8278
+ /** JSONP */
8279
+ callback?:
8280
+ string;
8281
+ /** Selector specifying which fields to include in a partial response. */
8282
+ fields?:
8283
+ string;
8284
+ /** 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. */
8285
+ key?:
8286
+ string;
8287
+ /** OAuth 2.0 token for the current user. */
8288
+ oauth_token?:
8289
+ string;
8290
+ /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8291
+ parent:
8292
+ string;
6807
8293
  /** Returns response with indentations and line breaks. */
6808
8294
  prettyPrint?:
6809
8295
  boolean;
6810
8296
  /** 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. */
6811
8297
  quotaUser?:
6812
8298
  string;
6813
- /**
6814
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
6815
- * you must create at least one serving config for it.
6816
- */
6817
- servingConfig:
6818
- string;
6819
8299
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6820
8300
  upload_protocol?:
6821
8301
  string;
@@ -6823,9 +8303,12 @@ declare namespace gapi.client {
6823
8303
  uploadType?:
6824
8304
  string;
6825
8305
  },
6826
- body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
6827
- /** Performs a search. */
6828
- search(request: {
8306
+ body: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
8307
+ /**
8308
+ * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete.
8309
+ * To test a filter, use the list command first.
8310
+ */
8311
+ purge(request: {
6829
8312
  /** V1 error format. */
6830
8313
  "$.xgafv"?:
6831
8314
  string;
@@ -6847,19 +8330,18 @@ declare namespace gapi.client {
6847
8330
  /** OAuth 2.0 token for the current user. */
6848
8331
  oauth_token?:
6849
8332
  string;
8333
+ /**
8334
+ * Required. The resource name of the catalog under which the events are created. The format is
8335
+ * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
8336
+ */
8337
+ parent:
8338
+ string;
6850
8339
  /** Returns response with indentations and line breaks. */
6851
8340
  prettyPrint?:
6852
8341
  boolean;
6853
8342
  /** 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. */
6854
8343
  quotaUser?:
6855
8344
  string;
6856
- /**
6857
- * Required. The resource name of the Search serving config, such as
6858
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
6859
- * configuration name, set of models used to make the search.
6860
- */
6861
- servingConfig:
6862
- string;
6863
8345
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6864
8346
  upload_protocol?:
6865
8347
  string;
@@ -6868,9 +8350,9 @@ declare namespace gapi.client {
6868
8350
  string;
6869
8351
  /** Request body */
6870
8352
  resource:
6871
- GoogleCloudDiscoveryengineV1alphaSearchRequest;
6872
- }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6873
- search(request: {
8353
+ GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest;
8354
+ }): Request<GoogleLongrunningOperation>;
8355
+ purge(request: {
6874
8356
  /** V1 error format. */
6875
8357
  "$.xgafv"?:
6876
8358
  string;
@@ -6892,19 +8374,18 @@ declare namespace gapi.client {
6892
8374
  /** OAuth 2.0 token for the current user. */
6893
8375
  oauth_token?:
6894
8376
  string;
8377
+ /**
8378
+ * Required. The resource name of the catalog under which the events are created. The format is
8379
+ * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
8380
+ */
8381
+ parent:
8382
+ string;
6895
8383
  /** Returns response with indentations and line breaks. */
6896
8384
  prettyPrint?:
6897
8385
  boolean;
6898
8386
  /** 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. */
6899
8387
  quotaUser?:
6900
8388
  string;
6901
- /**
6902
- * Required. The resource name of the Search serving config, such as
6903
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
6904
- * configuration name, set of models used to make the search.
6905
- */
6906
- servingConfig:
6907
- string;
6908
8389
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6909
8390
  upload_protocol?:
6910
8391
  string;
@@ -6912,11 +8393,9 @@ declare namespace gapi.client {
6912
8393
  uploadType?:
6913
8394
  string;
6914
8395
  },
6915
- body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6916
- }
6917
- interface SiteSearchEngineResource {
6918
- /** Request on-demand recrawl for a list of URIs. */
6919
- recrawlUris(request: {
8396
+ body: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
8397
+ /** Writes a single user event. */
8398
+ write(request: {
6920
8399
  /** V1 error format. */
6921
8400
  "$.xgafv"?:
6922
8401
  string;
@@ -6938,15 +8417,15 @@ declare namespace gapi.client {
6938
8417
  /** OAuth 2.0 token for the current user. */
6939
8418
  oauth_token?:
6940
8419
  string;
8420
+ /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8421
+ parent:
8422
+ string;
6941
8423
  /** Returns response with indentations and line breaks. */
6942
8424
  prettyPrint?:
6943
8425
  boolean;
6944
8426
  /** 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. */
6945
8427
  quotaUser?:
6946
8428
  string;
6947
- /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
6948
- siteSearchEngine:
6949
- string;
6950
8429
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6951
8430
  upload_protocol?:
6952
8431
  string;
@@ -6955,9 +8434,9 @@ declare namespace gapi.client {
6955
8434
  string;
6956
8435
  /** Request body */
6957
8436
  resource:
6958
- GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
6959
- }): Request<GoogleLongrunningOperation>;
6960
- recrawlUris(request: {
8437
+ GoogleCloudDiscoveryengineV1alphaUserEvent;
8438
+ }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
8439
+ write(request: {
6961
8440
  /** V1 error format. */
6962
8441
  "$.xgafv"?:
6963
8442
  string;
@@ -6979,15 +8458,15 @@ declare namespace gapi.client {
6979
8458
  /** OAuth 2.0 token for the current user. */
6980
8459
  oauth_token?:
6981
8460
  string;
8461
+ /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8462
+ parent:
8463
+ string;
6982
8464
  /** Returns response with indentations and line breaks. */
6983
8465
  prettyPrint?:
6984
8466
  boolean;
6985
8467
  /** 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. */
6986
8468
  quotaUser?:
6987
8469
  string;
6988
- /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
6989
- siteSearchEngine:
6990
- string;
6991
8470
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6992
8471
  upload_protocol?:
6993
8472
  string;
@@ -6995,14 +8474,11 @@ declare namespace gapi.client {
6995
8474
  uploadType?:
6996
8475
  string;
6997
8476
  },
6998
- body: GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest): Request<GoogleLongrunningOperation>;
8477
+ body: GoogleCloudDiscoveryengineV1alphaUserEvent): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
6999
8478
  }
7000
- interface UserEventsResource {
7001
- /**
7002
- * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery
7003
- * Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
7004
- */
7005
- collect(request?: {
8479
+ interface DataStoresResource {
8480
+ /** Completes the specified user input with keyword suggestions. */
8481
+ completeQuery(request?: {
7006
8482
  /** V1 error format. */
7007
8483
  "$.xgafv"?:
7008
8484
  string;
@@ -7015,24 +8491,41 @@ declare namespace gapi.client {
7015
8491
  /** JSONP */
7016
8492
  callback?:
7017
8493
  string;
7018
- /** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
7019
- ets?:
8494
+ /**
8495
+ * Required. The parent data store resource name for which the completion is performed, such as
8496
+ * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`.
8497
+ */
8498
+ dataStore:
7020
8499
  string;
7021
8500
  /** Selector specifying which fields to include in a partial response. */
7022
8501
  fields?:
7023
8502
  string;
8503
+ /**
8504
+ * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query,
8505
+ * those are returned and no tail suggestions are returned.
8506
+ */
8507
+ includeTailSuggestions?:
8508
+ boolean;
7024
8509
  /** 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. */
7025
8510
  key?:
7026
8511
  string;
7027
8512
  /** OAuth 2.0 token for the current user. */
7028
8513
  oauth_token?:
7029
8514
  string;
7030
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7031
- parent:
7032
- string;
7033
8515
  /** Returns response with indentations and line breaks. */
7034
8516
  prettyPrint?:
7035
8517
  boolean;
8518
+ /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
8519
+ query?:
8520
+ string;
8521
+ /**
8522
+ * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` -
8523
+ * Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions
8524
+ * generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values:
8525
+ * * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
8526
+ */
8527
+ queryModel?:
8528
+ string;
7036
8529
  /** 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. */
7037
8530
  quotaUser?:
7038
8531
  string;
@@ -7043,20 +8536,16 @@ declare namespace gapi.client {
7043
8536
  uploadType?:
7044
8537
  string;
7045
8538
  /**
7046
- * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
7047
- * only send the domain for third-party requests.
8539
+ * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device.
8540
+ * This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the
8541
+ * same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
8542
+ * `INVALID_ARGUMENT` error is returned.
7048
8543
  */
7049
- uri?:
7050
- string;
7051
- /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
7052
- userEvent?:
8544
+ userPseudoId?:
7053
8545
  string;
7054
- }): Request<GoogleApiHttpBody>;
7055
- /**
7056
- * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
7057
- * Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
7058
- */
7059
- import(request: {
8546
+ }): Request<GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>;
8547
+ /** Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. */
8548
+ create(request: {
7060
8549
  /** V1 error format. */
7061
8550
  "$.xgafv"?:
7062
8551
  string;
@@ -7069,6 +8558,18 @@ declare namespace gapi.client {
7069
8558
  /** JSONP */
7070
8559
  callback?:
7071
8560
  string;
8561
+ /**
8562
+ * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and
8563
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
8564
+ */
8565
+ createAdvancedSiteSearch?:
8566
+ boolean;
8567
+ /**
8568
+ * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to
8569
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
8570
+ */
8571
+ dataStoreId?:
8572
+ string;
7072
8573
  /** Selector specifying which fields to include in a partial response. */
7073
8574
  fields?:
7074
8575
  string;
@@ -7078,7 +8579,7 @@ declare namespace gapi.client {
7078
8579
  /** OAuth 2.0 token for the current user. */
7079
8580
  oauth_token?:
7080
8581
  string;
7081
- /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8582
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
7082
8583
  parent:
7083
8584
  string;
7084
8585
  /** Returns response with indentations and line breaks. */
@@ -7095,9 +8596,9 @@ declare namespace gapi.client {
7095
8596
  string;
7096
8597
  /** Request body */
7097
8598
  resource:
7098
- GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest;
8599
+ GoogleCloudDiscoveryengineV1alphaDataStore;
7099
8600
  }): Request<GoogleLongrunningOperation>;
7100
- import(request: {
8601
+ create(request: {
7101
8602
  /** V1 error format. */
7102
8603
  "$.xgafv"?:
7103
8604
  string;
@@ -7110,6 +8611,18 @@ declare namespace gapi.client {
7110
8611
  /** JSONP */
7111
8612
  callback?:
7112
8613
  string;
8614
+ /**
8615
+ * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and
8616
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
8617
+ */
8618
+ createAdvancedSiteSearch?:
8619
+ boolean;
8620
+ /**
8621
+ * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to
8622
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
8623
+ */
8624
+ dataStoreId?:
8625
+ string;
7113
8626
  /** Selector specifying which fields to include in a partial response. */
7114
8627
  fields?:
7115
8628
  string;
@@ -7119,7 +8632,7 @@ declare namespace gapi.client {
7119
8632
  /** OAuth 2.0 token for the current user. */
7120
8633
  oauth_token?:
7121
8634
  string;
7122
- /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8635
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
7123
8636
  parent:
7124
8637
  string;
7125
8638
  /** Returns response with indentations and line breaks. */
@@ -7135,12 +8648,9 @@ declare namespace gapi.client {
7135
8648
  uploadType?:
7136
8649
  string;
7137
8650
  },
7138
- body: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
7139
- /**
7140
- * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete.
7141
- * To test a filter, use the list command first.
7142
- */
7143
- purge(request: {
8651
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleLongrunningOperation>;
8652
+ /** Deletes a DataStore. */
8653
+ delete(request?: {
7144
8654
  /** V1 error format. */
7145
8655
  "$.xgafv"?:
7146
8656
  string;
@@ -7159,14 +8669,15 @@ declare namespace gapi.client {
7159
8669
  /** 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. */
7160
8670
  key?:
7161
8671
  string;
7162
- /** OAuth 2.0 token for the current user. */
7163
- oauth_token?:
7164
- string;
7165
8672
  /**
7166
- * Required. The resource name of the catalog under which the events are created. The format is
7167
- * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
8673
+ * Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have
8674
+ * permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error
8675
+ * is returned.
7168
8676
  */
7169
- parent:
8677
+ name:
8678
+ string;
8679
+ /** OAuth 2.0 token for the current user. */
8680
+ oauth_token?:
7170
8681
  string;
7171
8682
  /** Returns response with indentations and line breaks. */
7172
8683
  prettyPrint?:
@@ -7180,11 +8691,9 @@ declare namespace gapi.client {
7180
8691
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7181
8692
  uploadType?:
7182
8693
  string;
7183
- /** Request body */
7184
- resource:
7185
- GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest;
7186
8694
  }): Request<GoogleLongrunningOperation>;
7187
- purge(request: {
8695
+ /** Gets a DataStore. */
8696
+ get(request?: {
7188
8697
  /** V1 error format. */
7189
8698
  "$.xgafv"?:
7190
8699
  string;
@@ -7203,14 +8712,15 @@ declare namespace gapi.client {
7203
8712
  /** 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. */
7204
8713
  key?:
7205
8714
  string;
7206
- /** OAuth 2.0 token for the current user. */
7207
- oauth_token?:
7208
- string;
7209
8715
  /**
7210
- * Required. The resource name of the catalog under which the events are created. The format is
7211
- * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
8716
+ * Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have
8717
+ * permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error
8718
+ * is returned.
7212
8719
  */
7213
- parent:
8720
+ name:
8721
+ string;
8722
+ /** OAuth 2.0 token for the current user. */
8723
+ oauth_token?:
7214
8724
  string;
7215
8725
  /** Returns response with indentations and line breaks. */
7216
8726
  prettyPrint?:
@@ -7224,10 +8734,9 @@ declare namespace gapi.client {
7224
8734
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7225
8735
  uploadType?:
7226
8736
  string;
7227
- },
7228
- body: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
7229
- /** Writes a single user event. */
7230
- write(request: {
8737
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
8738
+ /** Lists all the DataStores associated with the project. */
8739
+ list(request?: {
7231
8740
  /** V1 error format. */
7232
8741
  "$.xgafv"?:
7233
8742
  string;
@@ -7243,13 +8752,31 @@ declare namespace gapi.client {
7243
8752
  /** Selector specifying which fields to include in a partial response. */
7244
8753
  fields?:
7245
8754
  string;
8755
+ /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
8756
+ filter?:
8757
+ string;
7246
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. */
7247
8759
  key?:
7248
8760
  string;
7249
8761
  /** OAuth 2.0 token for the current user. */
7250
8762
  oauth_token?:
7251
8763
  string;
7252
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8764
+ /**
8765
+ * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an
8766
+ * INVALID_ARGUMENT is returned.
8767
+ */
8768
+ pageSize?:
8769
+ number;
8770
+ /**
8771
+ * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When
8772
+ * paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
8773
+ */
8774
+ pageToken?:
8775
+ string;
8776
+ /**
8777
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list
8778
+ * DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
8779
+ */
7253
8780
  parent:
7254
8781
  string;
7255
8782
  /** Returns response with indentations and line breaks. */
@@ -7264,11 +8791,9 @@ declare namespace gapi.client {
7264
8791
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7265
8792
  uploadType?:
7266
8793
  string;
7267
- /** Request body */
7268
- resource:
7269
- GoogleCloudDiscoveryengineV1alphaUserEvent;
7270
- }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
7271
- write(request: {
8794
+ }): Request<GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>;
8795
+ /** Updates a DataStore */
8796
+ patch(request: {
7272
8797
  /** V1 error format. */
7273
8798
  "$.xgafv"?:
7274
8799
  string;
@@ -7287,30 +8812,35 @@ declare namespace gapi.client {
7287
8812
  /** 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. */
7288
8813
  key?:
7289
8814
  string;
8815
+ /**
8816
+ * Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be
8817
+ * a UTF-8 encoded string with a length limit of 1024 characters.
8818
+ */
8819
+ name:
8820
+ string;
7290
8821
  /** OAuth 2.0 token for the current user. */
7291
8822
  oauth_token?:
7292
8823
  string;
7293
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7294
- parent:
7295
- string;
7296
8824
  /** Returns response with indentations and line breaks. */
7297
8825
  prettyPrint?:
7298
8826
  boolean;
7299
8827
  /** 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. */
7300
8828
  quotaUser?:
7301
8829
  string;
8830
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
8831
+ updateMask?:
8832
+ string;
7302
8833
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7303
8834
  upload_protocol?:
7304
8835
  string;
7305
8836
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7306
8837
  uploadType?:
7307
8838
  string;
7308
- },
7309
- body: GoogleCloudDiscoveryengineV1alphaUserEvent): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
7310
- }
7311
- interface DataStoresResource {
7312
- /** Completes the specified user input with keyword suggestions. */
7313
- completeQuery(request?: {
8839
+ /** Request body */
8840
+ resource:
8841
+ GoogleCloudDiscoveryengineV1alphaDataStore;
8842
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
8843
+ patch(request: {
7314
8844
  /** V1 error format. */
7315
8845
  "$.xgafv"?:
7316
8846
  string;
@@ -7323,59 +8853,38 @@ declare namespace gapi.client {
7323
8853
  /** JSONP */
7324
8854
  callback?:
7325
8855
  string;
7326
- /**
7327
- * Required. The parent data store resource name for which the completion is performed, such as
7328
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`.
7329
- */
7330
- dataStore:
7331
- string;
7332
8856
  /** Selector specifying which fields to include in a partial response. */
7333
8857
  fields?:
7334
8858
  string;
7335
- /**
7336
- * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query,
7337
- * those are returned and no tail suggestions are returned.
7338
- */
7339
- includeTailSuggestions?:
7340
- boolean;
7341
8859
  /** 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. */
7342
8860
  key?:
7343
8861
  string;
8862
+ /**
8863
+ * Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be
8864
+ * a UTF-8 encoded string with a length limit of 1024 characters.
8865
+ */
8866
+ name:
8867
+ string;
7344
8868
  /** OAuth 2.0 token for the current user. */
7345
8869
  oauth_token?:
7346
8870
  string;
7347
8871
  /** Returns response with indentations and line breaks. */
7348
8872
  prettyPrint?:
7349
8873
  boolean;
7350
- /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
7351
- query?:
7352
- string;
7353
- /**
7354
- * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` -
7355
- * Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions
7356
- * generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values:
7357
- * * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
7358
- */
7359
- queryModel?:
7360
- string;
7361
8874
  /** 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. */
7362
8875
  quotaUser?:
7363
8876
  string;
8877
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
8878
+ updateMask?:
8879
+ string;
7364
8880
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7365
8881
  upload_protocol?:
7366
8882
  string;
7367
8883
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7368
8884
  uploadType?:
7369
8885
  string;
7370
- /**
7371
- * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device.
7372
- * This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the
7373
- * same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
7374
- * `INVALID_ARGUMENT` error is returned.
7375
- */
7376
- userPseudoId?:
7377
- string;
7378
- }): Request<GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>;
8886
+ },
8887
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
7379
8888
  branches:
7380
8889
  BranchesResource;
7381
8890
  conversations: