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

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 +2215 -597
  2. package/package.json +1 -1
  3. package/tests.ts +242 -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: 20231110
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,173 @@ 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
+ /**
488
+ * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has
489
+ * to match vertical of the DataStore liniked to the engine.
490
+ */
491
+ industryVertical?:
492
+ string;
493
+ /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
494
+ mediaRecommendationEngineConfig?:
495
+ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
496
+ /**
497
+ * 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:
498
+ * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an
499
+ * INVALID_ARGUMENT error is returned.
500
+ */
501
+ name?:
502
+ string;
503
+ /** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
504
+ recommendationMetadata?:
505
+ GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
506
+ /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
507
+ searchEngineConfig?:
508
+ GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig;
509
+ /** Additional config specs for a `similar-items` engine. */
510
+ similarDocumentsConfig?:
511
+ any;
512
+ /** Required. The solutions of the engine. */
513
+ solutionType?:
514
+ string;
515
+ /** Output only. Timestamp the Recommendation Engine was last updated. */
516
+ updateTime?:
517
+ string;
518
+ }
519
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
520
+ /**
521
+ * 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
522
+ * means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
523
+ */
524
+ agentCreationConfig?:
525
+ GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
526
+ /**
527
+ * 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
528
+ * 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
529
+ * they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent
530
+ * association after Engine is created.
531
+ */
532
+ dialogflowAgentToLink?:
533
+ string;
534
+ }
535
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
536
+ /** Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */
537
+ business?:
538
+ string;
539
+ /**
540
+ * 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
541
+ * supported language codes.
542
+ */
543
+ defaultLanguageCode?:
544
+ string;
545
+ /** 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. */
546
+ timeZone?:
547
+ string;
548
+ }
549
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata {
550
+ /** The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */
551
+ dialogflowAgent?:
552
+ string;
553
+ }
554
+ interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
555
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
556
+ companyName?:
557
+ string;
558
+ }
559
+ interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
560
+ /**
561
+ * 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
562
+ * 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` =>
563
+ * `ctr`
564
+ */
565
+ optimizationObjective?:
566
+ string;
567
+ /**
568
+ * 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
569
+ * 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]
570
+ * (excludes 0, includes 1.0) (e.g., 0.5).
571
+ */
572
+ optimizationObjectiveConfig?:
573
+ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
574
+ /**
575
+ * 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
576
+ * 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
577
+ * state the same as before.
578
+ */
579
+ trainingState?:
580
+ string;
581
+ /**
582
+ * 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.
583
+ * Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
584
+ */
585
+ type?:
586
+ string;
587
+ }
588
+ interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
589
+ /** Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. */
590
+ targetField?:
591
+ string;
592
+ /** Required. The threshold to be applied to the target (e.g., 0.5). */
593
+ targetFieldValueFloat?:
594
+ number;
595
+ }
596
+ interface GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata {
597
+ /**
598
+ * 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`
599
+ * 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.
600
+ */
601
+ dataState?:
602
+ string;
603
+ /** Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines. */
604
+ lastTuneTime?:
605
+ string;
606
+ /** Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. */
607
+ servingState?:
608
+ string;
609
+ /**
610
+ * 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
611
+ * 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
612
+ * happened for this engine, the string is empty.
613
+ */
614
+ tuningOperation?:
615
+ string;
616
+ }
617
+ interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
618
+ /** The add-on that this search engine enables. */
619
+ searchAddOns?:
620
+ string[];
621
+ /**
622
+ * The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to
623
+ * SearchTier.SEARCH_TIER_STANDARD if not specified.
624
+ */
625
+ searchTier?:
626
+ string;
627
+ }
628
+ // tslint:disable-next-line:no-empty-interface
629
+ interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {
630
+ }
403
631
  interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
404
632
  /**
405
633
  * 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 +845,14 @@ declare namespace gapi.client {
617
845
  nextPageToken?:
618
846
  string;
619
847
  }
848
+ interface GoogleCloudDiscoveryengineV1alphaListDataStoresResponse {
849
+ /** All the customer's DataStores. */
850
+ dataStores?:
851
+ GoogleCloudDiscoveryengineV1alphaDataStore[];
852
+ /** 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. */
853
+ nextPageToken?:
854
+ string;
855
+ }
620
856
  interface GoogleCloudDiscoveryengineV1alphaListDocumentsResponse {
621
857
  /** The Documents. */
622
858
  documents?:
@@ -625,6 +861,14 @@ declare namespace gapi.client {
625
861
  nextPageToken?:
626
862
  string;
627
863
  }
864
+ interface GoogleCloudDiscoveryengineV1alphaListEnginesResponse {
865
+ /** All the customer's Engines. */
866
+ engines?:
867
+ GoogleCloudDiscoveryengineV1alphaEngine[];
868
+ /** Not supported. */
869
+ nextPageToken?:
870
+ string;
871
+ }
628
872
  interface GoogleCloudDiscoveryengineV1alphaListSchemasResponse {
629
873
  /** 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
874
  nextPageToken?:
@@ -700,6 +944,9 @@ declare namespace gapi.client {
700
944
  totalPanels?:
701
945
  number;
702
946
  }
947
+ // tslint:disable-next-line:no-empty-interface
948
+ interface GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {
949
+ }
703
950
  interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
704
951
  /** Operation create time. */
705
952
  createTime?:
@@ -923,6 +1170,9 @@ declare namespace gapi.client {
923
1170
  uri?:
924
1171
  string;
925
1172
  }
1173
+ // tslint:disable-next-line:no-empty-interface
1174
+ interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {
1175
+ }
926
1176
  interface GoogleCloudDiscoveryengineV1alphaSchema {
927
1177
  /** Output only. Configurations for fields of the schema. */
928
1178
  fieldConfigs?:
@@ -973,6 +1223,14 @@ declare namespace gapi.client {
973
1223
  */
974
1224
  branch?:
975
1225
  string;
1226
+ /**
1227
+ * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement
1228
+ * such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query
1229
+ * expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about
1230
+ * filter syntax, see SearchRequest.filter.
1231
+ */
1232
+ canonicalFilter?:
1233
+ string;
976
1234
  /** A specification for configuring the behavior of content search. */
977
1235
  contentSearchSpec?:
978
1236
  GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
@@ -1050,7 +1308,7 @@ declare namespace gapi.client {
1050
1308
  safeSearch?:
1051
1309
  boolean;
1052
1310
  /**
1053
- * Required. The resource name of the Search serving config, such as
1311
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or
1054
1312
  * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
1055
1313
  * configuration name, set of models used to make the search.
1056
1314
  */
@@ -1499,6 +1757,17 @@ declare namespace gapi.client {
1499
1757
  value?:
1500
1758
  number;
1501
1759
  }
1760
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
1761
+ /** 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}` */
1762
+ engine?:
1763
+ string;
1764
+ }
1765
+ // tslint:disable-next-line:no-empty-interface
1766
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineRequest {
1767
+ }
1768
+ // tslint:disable-next-line:no-empty-interface
1769
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {
1770
+ }
1502
1771
  interface GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata {
1503
1772
  /** Operation create time. */
1504
1773
  createTime?:
@@ -2426,6 +2695,99 @@ declare namespace gapi.client {
2426
2695
  },
2427
2696
  body: GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
2428
2697
  }
2698
+ interface OperationsResource {
2699
+ /** 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. */
2700
+ get(request?: {
2701
+ /** V1 error format. */
2702
+ "$.xgafv"?:
2703
+ string;
2704
+ /** OAuth access token. */
2705
+ access_token?:
2706
+ string;
2707
+ /** Data format for response. */
2708
+ alt?:
2709
+ string;
2710
+ /** JSONP */
2711
+ callback?:
2712
+ string;
2713
+ /** Selector specifying which fields to include in a partial response. */
2714
+ fields?:
2715
+ string;
2716
+ /** 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. */
2717
+ key?:
2718
+ string;
2719
+ /** The name of the operation resource. */
2720
+ name:
2721
+ string;
2722
+ /** OAuth 2.0 token for the current user. */
2723
+ oauth_token?:
2724
+ string;
2725
+ /** Returns response with indentations and line breaks. */
2726
+ prettyPrint?:
2727
+ boolean;
2728
+ /** 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. */
2729
+ quotaUser?:
2730
+ string;
2731
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2732
+ upload_protocol?:
2733
+ string;
2734
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2735
+ uploadType?:
2736
+ string;
2737
+ }): Request<GoogleLongrunningOperation>;
2738
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2739
+ list(request?: {
2740
+ /** V1 error format. */
2741
+ "$.xgafv"?:
2742
+ string;
2743
+ /** OAuth access token. */
2744
+ access_token?:
2745
+ string;
2746
+ /** Data format for response. */
2747
+ alt?:
2748
+ string;
2749
+ /** JSONP */
2750
+ callback?:
2751
+ string;
2752
+ /** Selector specifying which fields to include in a partial response. */
2753
+ fields?:
2754
+ string;
2755
+ /** The standard list filter. */
2756
+ filter?:
2757
+ string;
2758
+ /** 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. */
2759
+ key?:
2760
+ string;
2761
+ /** The name of the operation's parent resource. */
2762
+ name:
2763
+ string;
2764
+ /** OAuth 2.0 token for the current user. */
2765
+ oauth_token?:
2766
+ string;
2767
+ /** The standard list page size. */
2768
+ pageSize?:
2769
+ number;
2770
+ /** The standard list page token. */
2771
+ pageToken?:
2772
+ string;
2773
+ /** Returns response with indentations and line breaks. */
2774
+ prettyPrint?:
2775
+ boolean;
2776
+ /** 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. */
2777
+ quotaUser?:
2778
+ string;
2779
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2780
+ upload_protocol?:
2781
+ string;
2782
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2783
+ uploadType?:
2784
+ string;
2785
+ }): Request<GoogleLongrunningListOperationsResponse>;
2786
+ }
2787
+ interface DataConnectorResource {
2788
+ operations:
2789
+ OperationsResource;
2790
+ }
2429
2791
  interface DocumentsResource {
2430
2792
  /** Creates a Document. */
2431
2793
  create(request: {
@@ -4051,8 +4413,10 @@ declare namespace gapi.client {
4051
4413
  quotaUser?:
4052
4414
  string;
4053
4415
  /**
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.
4416
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
4417
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
4418
+ * 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
4419
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
4056
4420
  */
4057
4421
  servingConfig:
4058
4422
  string;
@@ -4095,8 +4459,10 @@ declare namespace gapi.client {
4095
4459
  quotaUser?:
4096
4460
  string;
4097
4461
  /**
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.
4462
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
4463
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
4464
+ * 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
4465
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
4100
4466
  */
4101
4467
  servingConfig:
4102
4468
  string;
@@ -4138,8 +4504,8 @@ declare namespace gapi.client {
4138
4504
  quotaUser?:
4139
4505
  string;
4140
4506
  /**
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
4507
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
4508
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4143
4509
  * configuration name, set of models used to make the search.
4144
4510
  */
4145
4511
  servingConfig:
@@ -4183,8 +4549,8 @@ declare namespace gapi.client {
4183
4549
  quotaUser?:
4184
4550
  string;
4185
4551
  /**
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
4552
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
4553
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4188
4554
  * configuration name, set of models used to make the search.
4189
4555
  */
4190
4556
  servingConfig:
@@ -4846,26 +5212,8 @@ declare namespace gapi.client {
4846
5212
  userPseudoId?:
4847
5213
  string;
4848
5214
  }): 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?: {
5215
+ /** 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. */
5216
+ create(request: {
4869
5217
  /** V1 error format. */
4870
5218
  "$.xgafv"?:
4871
5219
  string;
@@ -4878,18 +5226,30 @@ declare namespace gapi.client {
4878
5226
  /** JSONP */
4879
5227
  callback?:
4880
5228
  string;
5229
+ /**
5230
+ * 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
5231
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
5232
+ */
5233
+ createAdvancedSiteSearch?:
5234
+ boolean;
5235
+ /**
5236
+ * 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
5237
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5238
+ */
5239
+ dataStoreId?:
5240
+ string;
4881
5241
  /** Selector specifying which fields to include in a partial response. */
4882
5242
  fields?:
4883
5243
  string;
4884
5244
  /** 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
5245
  key?:
4886
5246
  string;
4887
- /** The name of the operation resource. */
4888
- name:
4889
- string;
4890
5247
  /** OAuth 2.0 token for the current user. */
4891
5248
  oauth_token?:
4892
5249
  string;
5250
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5251
+ parent:
5252
+ string;
4893
5253
  /** Returns response with indentations and line breaks. */
4894
5254
  prettyPrint?:
4895
5255
  boolean;
@@ -4902,9 +5262,11 @@ declare namespace gapi.client {
4902
5262
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4903
5263
  uploadType?:
4904
5264
  string;
4905
- }): 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?: {
5265
+ /** Request body */
5266
+ resource:
5267
+ GoogleCloudDiscoveryengineV1alphaDataStore;
5268
+ }): Request<GoogleLongrunningOperation>;
5269
+ create(request: {
4908
5270
  /** V1 error format. */
4909
5271
  "$.xgafv"?:
4910
5272
  string;
@@ -4917,26 +5279,29 @@ declare namespace gapi.client {
4917
5279
  /** JSONP */
4918
5280
  callback?:
4919
5281
  string;
5282
+ /**
5283
+ * 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
5284
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
5285
+ */
5286
+ createAdvancedSiteSearch?:
5287
+ boolean;
5288
+ /**
5289
+ * 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
5290
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5291
+ */
5292
+ dataStoreId?:
5293
+ string;
4920
5294
  /** Selector specifying which fields to include in a partial response. */
4921
5295
  fields?:
4922
5296
  string;
4923
- /** The standard list filter. */
4924
- filter?:
4925
- string;
4926
5297
  /** 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
5298
  key?:
4928
5299
  string;
4929
- /** The name of the operation's parent resource. */
4930
- name:
4931
- string;
4932
5300
  /** OAuth 2.0 token for the current user. */
4933
5301
  oauth_token?:
4934
5302
  string;
4935
- /** The standard list page size. */
4936
- pageSize?:
4937
- number;
4938
- /** The standard list page token. */
4939
- pageToken?:
5303
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5304
+ parent:
4940
5305
  string;
4941
5306
  /** Returns response with indentations and line breaks. */
4942
5307
  prettyPrint?:
@@ -4950,11 +5315,10 @@ declare namespace gapi.client {
4950
5315
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4951
5316
  uploadType?:
4952
5317
  string;
4953
- }): Request<GoogleLongrunningListOperationsResponse>;
4954
- }
4955
- interface ServingConfigsResource {
4956
- /** Makes a recommendation, which requires a contextual user event. */
4957
- recommend(request: {
5318
+ },
5319
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleLongrunningOperation>;
5320
+ /** Deletes a DataStore. */
5321
+ delete(request?: {
4958
5322
  /** V1 error format. */
4959
5323
  "$.xgafv"?:
4960
5324
  string;
@@ -4973,6 +5337,13 @@ declare namespace gapi.client {
4973
5337
  /** 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
5338
  key?:
4975
5339
  string;
5340
+ /**
5341
+ * 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
5342
+ * 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
5343
+ * is returned.
5344
+ */
5345
+ name:
5346
+ string;
4976
5347
  /** OAuth 2.0 token for the current user. */
4977
5348
  oauth_token?:
4978
5349
  string;
@@ -4982,23 +5353,15 @@ declare namespace gapi.client {
4982
5353
  /** 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
5354
  quotaUser?:
4984
5355
  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
5356
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4992
5357
  upload_protocol?:
4993
5358
  string;
4994
5359
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4995
5360
  uploadType?:
4996
5361
  string;
4997
- /** Request body */
4998
- resource:
4999
- GoogleCloudDiscoveryengineV1alphaRecommendRequest;
5000
- }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5001
- recommend(request: {
5362
+ }): Request<GoogleLongrunningOperation>;
5363
+ /** Gets a DataStore. */
5364
+ get(request?: {
5002
5365
  /** V1 error format. */
5003
5366
  "$.xgafv"?:
5004
5367
  string;
@@ -5017,6 +5380,13 @@ declare namespace gapi.client {
5017
5380
  /** 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
5381
  key?:
5019
5382
  string;
5383
+ /**
5384
+ * 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
5385
+ * 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
5386
+ * is returned.
5387
+ */
5388
+ name:
5389
+ string;
5020
5390
  /** OAuth 2.0 token for the current user. */
5021
5391
  oauth_token?:
5022
5392
  string;
@@ -5026,11 +5396,62 @@ declare namespace gapi.client {
5026
5396
  /** 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
5397
  quotaUser?:
5028
5398
  string;
5399
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5400
+ upload_protocol?:
5401
+ string;
5402
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5403
+ uploadType?:
5404
+ string;
5405
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
5406
+ /** Lists all the DataStores associated with the project. */
5407
+ list(request?: {
5408
+ /** V1 error format. */
5409
+ "$.xgafv"?:
5410
+ string;
5411
+ /** OAuth access token. */
5412
+ access_token?:
5413
+ string;
5414
+ /** Data format for response. */
5415
+ alt?:
5416
+ string;
5417
+ /** JSONP */
5418
+ callback?:
5419
+ string;
5420
+ /** Selector specifying which fields to include in a partial response. */
5421
+ fields?:
5422
+ string;
5423
+ /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
5424
+ filter?:
5425
+ string;
5426
+ /** 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. */
5427
+ key?:
5428
+ string;
5429
+ /** OAuth 2.0 token for the current user. */
5430
+ oauth_token?:
5431
+ string;
5029
5432
  /**
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.
5433
+ * 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
5434
+ * INVALID_ARGUMENT is returned.
5032
5435
  */
5033
- servingConfig:
5436
+ pageSize?:
5437
+ number;
5438
+ /**
5439
+ * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When
5440
+ * paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
5441
+ */
5442
+ pageToken?:
5443
+ string;
5444
+ /**
5445
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list
5446
+ * DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
5447
+ */
5448
+ parent:
5449
+ string;
5450
+ /** Returns response with indentations and line breaks. */
5451
+ prettyPrint?:
5452
+ boolean;
5453
+ /** 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. */
5454
+ quotaUser?:
5034
5455
  string;
5035
5456
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5036
5457
  upload_protocol?:
@@ -5038,10 +5459,9 @@ declare namespace gapi.client {
5038
5459
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5039
5460
  uploadType?:
5040
5461
  string;
5041
- },
5042
- body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5043
- /** Performs a search. */
5044
- search(request: {
5462
+ }): Request<GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>;
5463
+ /** Updates a DataStore */
5464
+ patch(request: {
5045
5465
  /** V1 error format. */
5046
5466
  "$.xgafv"?:
5047
5467
  string;
@@ -5060,6 +5480,12 @@ declare namespace gapi.client {
5060
5480
  /** 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
5481
  key?:
5062
5482
  string;
5483
+ /**
5484
+ * 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
5485
+ * a UTF-8 encoded string with a length limit of 1024 characters.
5486
+ */
5487
+ name:
5488
+ string;
5063
5489
  /** OAuth 2.0 token for the current user. */
5064
5490
  oauth_token?:
5065
5491
  string;
@@ -5069,12 +5495,8 @@ declare namespace gapi.client {
5069
5495
  /** 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
5496
  quotaUser?:
5071
5497
  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:
5498
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
5499
+ updateMask?:
5078
5500
  string;
5079
5501
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5080
5502
  upload_protocol?:
@@ -5084,9 +5506,9 @@ declare namespace gapi.client {
5084
5506
  string;
5085
5507
  /** Request body */
5086
5508
  resource:
5087
- GoogleCloudDiscoveryengineV1alphaSearchRequest;
5088
- }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5089
- search(request: {
5509
+ GoogleCloudDiscoveryengineV1alphaDataStore;
5510
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
5511
+ patch(request: {
5090
5512
  /** V1 error format. */
5091
5513
  "$.xgafv"?:
5092
5514
  string;
@@ -5105,6 +5527,12 @@ declare namespace gapi.client {
5105
5527
  /** 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
5528
  key?:
5107
5529
  string;
5530
+ /**
5531
+ * 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
5532
+ * a UTF-8 encoded string with a length limit of 1024 characters.
5533
+ */
5534
+ name:
5535
+ string;
5108
5536
  /** OAuth 2.0 token for the current user. */
5109
5537
  oauth_token?:
5110
5538
  string;
@@ -5114,12 +5542,8 @@ declare namespace gapi.client {
5114
5542
  /** 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
5543
  quotaUser?:
5116
5544
  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:
5545
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
5546
+ updateMask?:
5123
5547
  string;
5124
5548
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5125
5549
  upload_protocol?:
@@ -5128,13 +5552,23 @@ declare namespace gapi.client {
5128
5552
  uploadType?:
5129
5553
  string;
5130
5554
  },
5131
- body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5132
- }
5133
- interface EnginesResource {
5555
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
5556
+ branches:
5557
+ BranchesResource;
5558
+ conversations:
5559
+ ConversationsResource;
5560
+ models:
5561
+ ModelsResource;
5134
5562
  operations:
5135
5563
  OperationsResource;
5564
+ schemas:
5565
+ SchemasResource;
5136
5566
  servingConfigs:
5137
5567
  ServingConfigsResource;
5568
+ siteSearchEngine:
5569
+ SiteSearchEngineResource;
5570
+ userEvents:
5571
+ UserEventsResource;
5138
5572
  }
5139
5573
  interface OperationsResource {
5140
5574
  /** 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 +5659,9 @@ declare namespace gapi.client {
5225
5659
  string;
5226
5660
  }): Request<GoogleLongrunningListOperationsResponse>;
5227
5661
  }
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: {
5662
+ interface ServingConfigsResource {
5663
+ /** Makes a recommendation, which requires a contextual user event. */
5664
+ recommend(request: {
5239
5665
  /** V1 error format. */
5240
5666
  "$.xgafv"?:
5241
5667
  string;
@@ -5248,14 +5674,6 @@ declare namespace gapi.client {
5248
5674
  /** JSONP */
5249
5675
  callback?:
5250
5676
  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
5677
  /** Selector specifying which fields to include in a partial response. */
5260
5678
  fields?:
5261
5679
  string;
@@ -5265,15 +5683,20 @@ declare namespace gapi.client {
5265
5683
  /** OAuth 2.0 token for the current user. */
5266
5684
  oauth_token?:
5267
5685
  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
5686
  /** Returns response with indentations and line breaks. */
5272
5687
  prettyPrint?:
5273
5688
  boolean;
5274
5689
  /** 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
5690
  quotaUser?:
5276
5691
  string;
5692
+ /**
5693
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
5694
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
5695
+ * 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
5696
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
5697
+ */
5698
+ servingConfig:
5699
+ string;
5277
5700
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5278
5701
  upload_protocol?:
5279
5702
  string;
@@ -5282,9 +5705,9 @@ declare namespace gapi.client {
5282
5705
  string;
5283
5706
  /** Request body */
5284
5707
  resource:
5285
- GoogleCloudDiscoveryengineV1alphaDocument;
5286
- }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5287
- create(request: {
5708
+ GoogleCloudDiscoveryengineV1alphaRecommendRequest;
5709
+ }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5710
+ recommend(request: {
5288
5711
  /** V1 error format. */
5289
5712
  "$.xgafv"?:
5290
5713
  string;
@@ -5297,14 +5720,6 @@ declare namespace gapi.client {
5297
5720
  /** JSONP */
5298
5721
  callback?:
5299
5722
  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
5723
  /** Selector specifying which fields to include in a partial response. */
5309
5724
  fields?:
5310
5725
  string;
@@ -5314,15 +5729,20 @@ declare namespace gapi.client {
5314
5729
  /** OAuth 2.0 token for the current user. */
5315
5730
  oauth_token?:
5316
5731
  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
5732
  /** Returns response with indentations and line breaks. */
5321
5733
  prettyPrint?:
5322
5734
  boolean;
5323
5735
  /** 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
5736
  quotaUser?:
5325
5737
  string;
5738
+ /**
5739
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
5740
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
5741
+ * 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
5742
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
5743
+ */
5744
+ servingConfig:
5745
+ string;
5326
5746
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5327
5747
  upload_protocol?:
5328
5748
  string;
@@ -5330,9 +5750,9 @@ declare namespace gapi.client {
5330
5750
  uploadType?:
5331
5751
  string;
5332
5752
  },
5333
- body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5334
- /** Deletes a Document. */
5335
- delete(request?: {
5753
+ body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
5754
+ /** Performs a search. */
5755
+ search(request: {
5336
5756
  /** V1 error format. */
5337
5757
  "$.xgafv"?:
5338
5758
  string;
@@ -5351,13 +5771,6 @@ declare namespace gapi.client {
5351
5771
  /** 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
5772
  key?:
5353
5773
  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
5774
  /** OAuth 2.0 token for the current user. */
5362
5775
  oauth_token?:
5363
5776
  string;
@@ -5367,15 +5780,24 @@ declare namespace gapi.client {
5367
5780
  /** 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
5781
  quotaUser?:
5369
5782
  string;
5783
+ /**
5784
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
5785
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
5786
+ * configuration name, set of models used to make the search.
5787
+ */
5788
+ servingConfig:
5789
+ string;
5370
5790
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5371
5791
  upload_protocol?:
5372
5792
  string;
5373
5793
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5374
5794
  uploadType?:
5375
5795
  string;
5376
- }): Request<{}>;
5377
- /** Gets a Document. */
5378
- get(request?: {
5796
+ /** Request body */
5797
+ resource:
5798
+ GoogleCloudDiscoveryengineV1alphaSearchRequest;
5799
+ }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5800
+ search(request: {
5379
5801
  /** V1 error format. */
5380
5802
  "$.xgafv"?:
5381
5803
  string;
@@ -5394,13 +5816,6 @@ declare namespace gapi.client {
5394
5816
  /** 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
5817
  key?:
5396
5818
  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
5819
  /** OAuth 2.0 token for the current user. */
5405
5820
  oauth_token?:
5406
5821
  string;
@@ -5410,18 +5825,25 @@ declare namespace gapi.client {
5410
5825
  /** 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
5826
  quotaUser?:
5412
5827
  string;
5828
+ /**
5829
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
5830
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
5831
+ * configuration name, set of models used to make the search.
5832
+ */
5833
+ servingConfig:
5834
+ string;
5413
5835
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5414
5836
  upload_protocol?:
5415
5837
  string;
5416
5838
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5417
5839
  uploadType?:
5418
5840
  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: {
5841
+ },
5842
+ body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
5843
+ }
5844
+ interface EnginesResource {
5845
+ /** Creates a Engine. */
5846
+ create(request: {
5425
5847
  /** V1 error format. */
5426
5848
  "$.xgafv"?:
5427
5849
  string;
@@ -5434,6 +5856,12 @@ declare namespace gapi.client {
5434
5856
  /** JSONP */
5435
5857
  callback?:
5436
5858
  string;
5859
+ /**
5860
+ * 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
5861
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5862
+ */
5863
+ engineId?:
5864
+ string;
5437
5865
  /** Selector specifying which fields to include in a partial response. */
5438
5866
  fields?:
5439
5867
  string;
@@ -5443,10 +5871,7 @@ declare namespace gapi.client {
5443
5871
  /** OAuth 2.0 token for the current user. */
5444
5872
  oauth_token?:
5445
5873
  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
- */
5874
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5450
5875
  parent:
5451
5876
  string;
5452
5877
  /** Returns response with indentations and line breaks. */
@@ -5463,9 +5888,9 @@ declare namespace gapi.client {
5463
5888
  string;
5464
5889
  /** Request body */
5465
5890
  resource:
5466
- GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
5891
+ GoogleCloudDiscoveryengineV1alphaEngine;
5467
5892
  }): Request<GoogleLongrunningOperation>;
5468
- import(request: {
5893
+ create(request: {
5469
5894
  /** V1 error format. */
5470
5895
  "$.xgafv"?:
5471
5896
  string;
@@ -5478,6 +5903,12 @@ declare namespace gapi.client {
5478
5903
  /** JSONP */
5479
5904
  callback?:
5480
5905
  string;
5906
+ /**
5907
+ * 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
5908
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5909
+ */
5910
+ engineId?:
5911
+ string;
5481
5912
  /** Selector specifying which fields to include in a partial response. */
5482
5913
  fields?:
5483
5914
  string;
@@ -5487,10 +5918,7 @@ declare namespace gapi.client {
5487
5918
  /** OAuth 2.0 token for the current user. */
5488
5919
  oauth_token?:
5489
5920
  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
- */
5921
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5494
5922
  parent:
5495
5923
  string;
5496
5924
  /** Returns response with indentations and line breaks. */
@@ -5506,9 +5934,9 @@ declare namespace gapi.client {
5506
5934
  uploadType?:
5507
5935
  string;
5508
5936
  },
5509
- body: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest): Request<GoogleLongrunningOperation>;
5510
- /** Gets a list of Documents. */
5511
- list(request?: {
5937
+ body: GoogleCloudDiscoveryengineV1alphaEngine): Request<GoogleLongrunningOperation>;
5938
+ /** Deletes a Engine. */
5939
+ delete(request?: {
5512
5940
  /** V1 error format. */
5513
5941
  "$.xgafv"?:
5514
5942
  string;
@@ -5527,27 +5955,14 @@ declare namespace gapi.client {
5527
5955
  /** 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
5956
  key?:
5529
5957
  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
5958
  /**
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.
5959
+ * 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
5960
+ * 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
5961
  */
5543
- pageToken?:
5962
+ name:
5544
5963
  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:
5964
+ /** OAuth 2.0 token for the current user. */
5965
+ oauth_token?:
5551
5966
  string;
5552
5967
  /** Returns response with indentations and line breaks. */
5553
5968
  prettyPrint?:
@@ -5561,18 +5976,15 @@ declare namespace gapi.client {
5561
5976
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5562
5977
  uploadType?:
5563
5978
  string;
5564
- }): Request<GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
5565
- /** Updates a Document. */
5566
- patch(request: {
5979
+ }): Request<GoogleLongrunningOperation>;
5980
+ /** Gets a Engine. */
5981
+ get(request?: {
5567
5982
  /** V1 error format. */
5568
5983
  "$.xgafv"?:
5569
5984
  string;
5570
5985
  /** OAuth access token. */
5571
5986
  access_token?:
5572
5987
  string;
5573
- /** If set to true, and the Document is not found, a new Document will be created. */
5574
- allowMissing?:
5575
- boolean;
5576
5988
  /** Data format for response. */
5577
5989
  alt?:
5578
5990
  string;
@@ -5585,11 +5997,7 @@ declare namespace gapi.client {
5585
5997
  /** 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
5998
  key?:
5587
5999
  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
- */
6000
+ /** Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
5593
6001
  name:
5594
6002
  string;
5595
6003
  /** OAuth 2.0 token for the current user. */
@@ -5607,20 +6015,15 @@ declare namespace gapi.client {
5607
6015
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5608
6016
  uploadType?:
5609
6017
  string;
5610
- /** Request body */
5611
- resource:
5612
- GoogleCloudDiscoveryengineV1alphaDocument;
5613
- }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
5614
- patch(request: {
6018
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6019
+ /** Lists all the Engines associated with the project. */
6020
+ list(request?: {
5615
6021
  /** V1 error format. */
5616
6022
  "$.xgafv"?:
5617
6023
  string;
5618
6024
  /** OAuth access token. */
5619
6025
  access_token?:
5620
6026
  string;
5621
- /** If set to true, and the Document is not found, a new Document will be created. */
5622
- allowMissing?:
5623
- boolean;
5624
6027
  /** Data format for response. */
5625
6028
  alt?:
5626
6029
  string;
@@ -5630,19 +6033,24 @@ declare namespace gapi.client {
5630
6033
  /** Selector specifying which fields to include in a partial response. */
5631
6034
  fields?:
5632
6035
  string;
6036
+ /** Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH */
6037
+ filter?:
6038
+ string;
5633
6039
  /** 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
6040
  key?:
5635
6041
  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
6042
  /** OAuth 2.0 token for the current user. */
5644
6043
  oauth_token?:
5645
6044
  string;
6045
+ /** Optional. Not supported. */
6046
+ pageSize?:
6047
+ number;
6048
+ /** Optional. Not supported. */
6049
+ pageToken?:
6050
+ string;
6051
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. */
6052
+ parent:
6053
+ string;
5646
6054
  /** Returns response with indentations and line breaks. */
5647
6055
  prettyPrint?:
5648
6056
  boolean;
@@ -5655,14 +6063,9 @@ declare namespace gapi.client {
5655
6063
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5656
6064
  uploadType?:
5657
6065
  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: {
6066
+ }): Request<GoogleCloudDiscoveryengineV1alphaListEnginesResponse>;
6067
+ /** Updates an Engine */
6068
+ patch(request: {
5666
6069
  /** V1 error format. */
5667
6070
  "$.xgafv"?:
5668
6071
  string;
@@ -5681,18 +6084,25 @@ declare namespace gapi.client {
5681
6084
  /** 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
6085
  key?:
5683
6086
  string;
6087
+ /**
6088
+ * 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:
6089
+ * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an
6090
+ * INVALID_ARGUMENT error is returned.
6091
+ */
6092
+ name:
6093
+ string;
5684
6094
  /** OAuth 2.0 token for the current user. */
5685
6095
  oauth_token?:
5686
6096
  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
6097
  /** Returns response with indentations and line breaks. */
5691
6098
  prettyPrint?:
5692
6099
  boolean;
5693
6100
  /** 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
6101
  quotaUser?:
5695
6102
  string;
6103
+ /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
6104
+ updateMask?:
6105
+ string;
5696
6106
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5697
6107
  upload_protocol?:
5698
6108
  string;
@@ -5701,9 +6111,9 @@ declare namespace gapi.client {
5701
6111
  string;
5702
6112
  /** Request body */
5703
6113
  resource:
5704
- GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
5705
- }): Request<GoogleLongrunningOperation>;
5706
- purge(request: {
6114
+ GoogleCloudDiscoveryengineV1alphaEngine;
6115
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6116
+ patch(request: {
5707
6117
  /** V1 error format. */
5708
6118
  "$.xgafv"?:
5709
6119
  string;
@@ -5722,18 +6132,25 @@ declare namespace gapi.client {
5722
6132
  /** 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
6133
  key?:
5724
6134
  string;
6135
+ /**
6136
+ * 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:
6137
+ * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an
6138
+ * INVALID_ARGUMENT error is returned.
6139
+ */
6140
+ name:
6141
+ string;
5725
6142
  /** OAuth 2.0 token for the current user. */
5726
6143
  oauth_token?:
5727
6144
  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
6145
  /** Returns response with indentations and line breaks. */
5732
6146
  prettyPrint?:
5733
6147
  boolean;
5734
6148
  /** 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
6149
  quotaUser?:
5736
6150
  string;
6151
+ /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
6152
+ updateMask?:
6153
+ string;
5737
6154
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5738
6155
  upload_protocol?:
5739
6156
  string;
@@ -5741,11 +6158,9 @@ declare namespace gapi.client {
5741
6158
  uploadType?:
5742
6159
  string;
5743
6160
  },
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?: {
6161
+ body: GoogleCloudDiscoveryengineV1alphaEngine): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6162
+ /** Pauses the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
6163
+ pause(request: {
5749
6164
  /** V1 error format. */
5750
6165
  "$.xgafv"?:
5751
6166
  string;
@@ -5764,7 +6179,7 @@ declare namespace gapi.client {
5764
6179
  /** 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
6180
  key?:
5766
6181
  string;
5767
- /** The name of the operation resource. */
6182
+ /** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5768
6183
  name:
5769
6184
  string;
5770
6185
  /** OAuth 2.0 token for the current user. */
@@ -5782,9 +6197,11 @@ declare namespace gapi.client {
5782
6197
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5783
6198
  uploadType?:
5784
6199
  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?: {
6200
+ /** Request body */
6201
+ resource:
6202
+ GoogleCloudDiscoveryengineV1alphaPauseEngineRequest;
6203
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6204
+ pause(request: {
5788
6205
  /** V1 error format. */
5789
6206
  "$.xgafv"?:
5790
6207
  string;
@@ -5800,24 +6217,15 @@ declare namespace gapi.client {
5800
6217
  /** Selector specifying which fields to include in a partial response. */
5801
6218
  fields?:
5802
6219
  string;
5803
- /** The standard list filter. */
5804
- filter?:
5805
- string;
5806
6220
  /** 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
6221
  key?:
5808
6222
  string;
5809
- /** The name of the operation's parent resource. */
6223
+ /** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5810
6224
  name:
5811
6225
  string;
5812
6226
  /** OAuth 2.0 token for the current user. */
5813
6227
  oauth_token?:
5814
6228
  string;
5815
- /** The standard list page size. */
5816
- pageSize?:
5817
- number;
5818
- /** The standard list page token. */
5819
- pageToken?:
5820
- string;
5821
6229
  /** Returns response with indentations and line breaks. */
5822
6230
  prettyPrint?:
5823
6231
  boolean;
@@ -5830,17 +6238,10 @@ declare namespace gapi.client {
5830
6238
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5831
6239
  uploadType?:
5832
6240
  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: {
6241
+ },
6242
+ body: GoogleCloudDiscoveryengineV1alphaPauseEngineRequest): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6243
+ /** Resumes the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
6244
+ resume(request: {
5844
6245
  /** V1 error format. */
5845
6246
  "$.xgafv"?:
5846
6247
  string;
@@ -5859,12 +6260,7 @@ declare namespace gapi.client {
5859
6260
  /** 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
6261
  key?:
5861
6262
  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
- */
6263
+ /** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5868
6264
  name:
5869
6265
  string;
5870
6266
  /** OAuth 2.0 token for the current user. */
@@ -5884,9 +6280,9 @@ declare namespace gapi.client {
5884
6280
  string;
5885
6281
  /** Request body */
5886
6282
  resource:
5887
- GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
5888
- }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
5889
- converse(request: {
6283
+ GoogleCloudDiscoveryengineV1alphaResumeEngineRequest;
6284
+ }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6285
+ resume(request: {
5890
6286
  /** V1 error format. */
5891
6287
  "$.xgafv"?:
5892
6288
  string;
@@ -5905,12 +6301,7 @@ declare namespace gapi.client {
5905
6301
  /** 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
6302
  key?:
5907
6303
  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
- */
6304
+ /** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5914
6305
  name:
5915
6306
  string;
5916
6307
  /** OAuth 2.0 token for the current user. */
@@ -5929,9 +6320,9 @@ declare namespace gapi.client {
5929
6320
  uploadType?:
5930
6321
  string;
5931
6322
  },
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: {
6323
+ body: GoogleCloudDiscoveryengineV1alphaResumeEngineRequest): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
6324
+ /** Tunes an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
6325
+ tune(request: {
5935
6326
  /** V1 error format. */
5936
6327
  "$.xgafv"?:
5937
6328
  string;
@@ -5950,12 +6341,12 @@ declare namespace gapi.client {
5950
6341
  /** 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
6342
  key?:
5952
6343
  string;
6344
+ /** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
6345
+ name:
6346
+ string;
5953
6347
  /** OAuth 2.0 token for the current user. */
5954
6348
  oauth_token?:
5955
6349
  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
6350
  /** Returns response with indentations and line breaks. */
5960
6351
  prettyPrint?:
5961
6352
  boolean;
@@ -5970,9 +6361,9 @@ declare namespace gapi.client {
5970
6361
  string;
5971
6362
  /** Request body */
5972
6363
  resource:
5973
- GoogleCloudDiscoveryengineV1alphaConversation;
5974
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
5975
- create(request: {
6364
+ GoogleCloudDiscoveryengineV1alphaTuneEngineRequest;
6365
+ }): Request<GoogleLongrunningOperation>;
6366
+ tune(request: {
5976
6367
  /** V1 error format. */
5977
6368
  "$.xgafv"?:
5978
6369
  string;
@@ -5991,12 +6382,12 @@ declare namespace gapi.client {
5991
6382
  /** 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
6383
  key?:
5993
6384
  string;
6385
+ /** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
6386
+ name:
6387
+ string;
5994
6388
  /** OAuth 2.0 token for the current user. */
5995
6389
  oauth_token?:
5996
6390
  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
6391
  /** Returns response with indentations and line breaks. */
6001
6392
  prettyPrint?:
6002
6393
  boolean;
@@ -6010,9 +6401,15 @@ declare namespace gapi.client {
6010
6401
  uploadType?:
6011
6402
  string;
6012
6403
  },
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?: {
6404
+ body: GoogleCloudDiscoveryengineV1alphaTuneEngineRequest): Request<GoogleLongrunningOperation>;
6405
+ operations:
6406
+ OperationsResource;
6407
+ servingConfigs:
6408
+ ServingConfigsResource;
6409
+ }
6410
+ interface OperationsResource {
6411
+ /** 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. */
6412
+ get(request?: {
6016
6413
  /** V1 error format. */
6017
6414
  "$.xgafv"?:
6018
6415
  string;
@@ -6031,10 +6428,7 @@ declare namespace gapi.client {
6031
6428
  /** 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
6429
  key?:
6033
6430
  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
- */
6431
+ /** The name of the operation resource. */
6038
6432
  name:
6039
6433
  string;
6040
6434
  /** OAuth 2.0 token for the current user. */
@@ -6052,9 +6446,9 @@ declare namespace gapi.client {
6052
6446
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6053
6447
  uploadType?:
6054
6448
  string;
6055
- }): Request<{}>;
6056
- /** Gets a Conversation. */
6057
- get(request?: {
6449
+ }): Request<GoogleLongrunningOperation>;
6450
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6451
+ list(request?: {
6058
6452
  /** V1 error format. */
6059
6453
  "$.xgafv"?:
6060
6454
  string;
@@ -6070,18 +6464,24 @@ declare namespace gapi.client {
6070
6464
  /** Selector specifying which fields to include in a partial response. */
6071
6465
  fields?:
6072
6466
  string;
6467
+ /** The standard list filter. */
6468
+ filter?:
6469
+ string;
6073
6470
  /** 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
6471
  key?:
6075
6472
  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
- */
6473
+ /** The name of the operation's parent resource. */
6080
6474
  name:
6081
6475
  string;
6082
6476
  /** OAuth 2.0 token for the current user. */
6083
6477
  oauth_token?:
6084
6478
  string;
6479
+ /** The standard list page size. */
6480
+ pageSize?:
6481
+ number;
6482
+ /** The standard list page token. */
6483
+ pageToken?:
6484
+ string;
6085
6485
  /** Returns response with indentations and line breaks. */
6086
6486
  prettyPrint?:
6087
6487
  boolean;
@@ -6094,9 +6494,21 @@ declare namespace gapi.client {
6094
6494
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6095
6495
  uploadType?:
6096
6496
  string;
6097
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
6098
- /** Lists all Conversations by their parent DataStore. */
6099
- list(request?: {
6497
+ }): Request<GoogleLongrunningListOperationsResponse>;
6498
+ }
6499
+ interface CollectionsResource {
6500
+ dataConnector:
6501
+ DataConnectorResource;
6502
+ dataStores:
6503
+ DataStoresResource;
6504
+ engines:
6505
+ EnginesResource;
6506
+ operations:
6507
+ OperationsResource;
6508
+ }
6509
+ interface DocumentsResource {
6510
+ /** Creates a Document. */
6511
+ create(request: {
6100
6512
  /** V1 error format. */
6101
6513
  "$.xgafv"?:
6102
6514
  string;
@@ -6109,31 +6521,24 @@ declare namespace gapi.client {
6109
6521
  /** JSONP */
6110
6522
  callback?:
6111
6523
  string;
6524
+ /**
6525
+ * 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
6526
+ * 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
6527
+ * 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
6528
+ * returned.
6529
+ */
6530
+ documentId?:
6531
+ string;
6112
6532
  /** Selector specifying which fields to include in a partial response. */
6113
6533
  fields?:
6114
6534
  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
6535
  /** 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
6536
  key?:
6120
6537
  string;
6121
6538
  /** OAuth 2.0 token for the current user. */
6122
6539
  oauth_token?:
6123
6540
  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}` */
6541
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6137
6542
  parent:
6138
6543
  string;
6139
6544
  /** Returns response with indentations and line breaks. */
@@ -6148,9 +6553,11 @@ declare namespace gapi.client {
6148
6553
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6149
6554
  uploadType?:
6150
6555
  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: {
6556
+ /** Request body */
6557
+ resource:
6558
+ GoogleCloudDiscoveryengineV1alphaDocument;
6559
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6560
+ create(request: {
6154
6561
  /** V1 error format. */
6155
6562
  "$.xgafv"?:
6156
6563
  string;
@@ -6163,26 +6570,163 @@ declare namespace gapi.client {
6163
6570
  /** JSONP */
6164
6571
  callback?:
6165
6572
  string;
6573
+ /**
6574
+ * 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
6575
+ * 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
6576
+ * 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
6577
+ * returned.
6578
+ */
6579
+ documentId?:
6580
+ string;
6166
6581
  /** Selector specifying which fields to include in a partial response. */
6167
6582
  fields?:
6168
6583
  string;
6169
6584
  /** 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
6585
  key?:
6171
6586
  string;
6172
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
6173
- name:
6174
- string;
6175
6587
  /** OAuth 2.0 token for the current user. */
6176
6588
  oauth_token?:
6177
6589
  string;
6590
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6591
+ parent:
6592
+ string;
6178
6593
  /** Returns response with indentations and line breaks. */
6179
6594
  prettyPrint?:
6180
6595
  boolean;
6181
6596
  /** 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
6597
  quotaUser?:
6183
6598
  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?:
6599
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6600
+ upload_protocol?:
6601
+ string;
6602
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6603
+ uploadType?:
6604
+ string;
6605
+ },
6606
+ body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6607
+ /** Deletes a Document. */
6608
+ delete(request?: {
6609
+ /** V1 error format. */
6610
+ "$.xgafv"?:
6611
+ string;
6612
+ /** OAuth access token. */
6613
+ access_token?:
6614
+ string;
6615
+ /** Data format for response. */
6616
+ alt?:
6617
+ string;
6618
+ /** JSONP */
6619
+ callback?:
6620
+ string;
6621
+ /** Selector specifying which fields to include in a partial response. */
6622
+ fields?:
6623
+ string;
6624
+ /** 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. */
6625
+ key?:
6626
+ string;
6627
+ /**
6628
+ * Required. Full resource name of Document, such as
6629
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
6630
+ * 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.
6631
+ */
6632
+ name:
6633
+ string;
6634
+ /** OAuth 2.0 token for the current user. */
6635
+ oauth_token?:
6636
+ string;
6637
+ /** Returns response with indentations and line breaks. */
6638
+ prettyPrint?:
6639
+ boolean;
6640
+ /** 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. */
6641
+ quotaUser?:
6642
+ string;
6643
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6644
+ upload_protocol?:
6645
+ string;
6646
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6647
+ uploadType?:
6648
+ string;
6649
+ }): Request<{}>;
6650
+ /** Gets a Document. */
6651
+ get(request?: {
6652
+ /** V1 error format. */
6653
+ "$.xgafv"?:
6654
+ string;
6655
+ /** OAuth access token. */
6656
+ access_token?:
6657
+ string;
6658
+ /** Data format for response. */
6659
+ alt?:
6660
+ string;
6661
+ /** JSONP */
6662
+ callback?:
6663
+ string;
6664
+ /** Selector specifying which fields to include in a partial response. */
6665
+ fields?:
6666
+ string;
6667
+ /** 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. */
6668
+ key?:
6669
+ string;
6670
+ /**
6671
+ * Required. Full resource name of Document, such as
6672
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
6673
+ * 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.
6674
+ */
6675
+ name:
6676
+ string;
6677
+ /** OAuth 2.0 token for the current user. */
6678
+ oauth_token?:
6679
+ string;
6680
+ /** Returns response with indentations and line breaks. */
6681
+ prettyPrint?:
6682
+ boolean;
6683
+ /** 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. */
6684
+ quotaUser?:
6685
+ string;
6686
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6687
+ upload_protocol?:
6688
+ string;
6689
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6690
+ uploadType?:
6691
+ string;
6692
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6693
+ /**
6694
+ * 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
6695
+ * updated.
6696
+ */
6697
+ import(request: {
6698
+ /** V1 error format. */
6699
+ "$.xgafv"?:
6700
+ string;
6701
+ /** OAuth access token. */
6702
+ access_token?:
6703
+ string;
6704
+ /** Data format for response. */
6705
+ alt?:
6706
+ string;
6707
+ /** JSONP */
6708
+ callback?:
6709
+ string;
6710
+ /** Selector specifying which fields to include in a partial response. */
6711
+ fields?:
6712
+ string;
6713
+ /** 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. */
6714
+ key?:
6715
+ string;
6716
+ /** OAuth 2.0 token for the current user. */
6717
+ oauth_token?:
6718
+ string;
6719
+ /**
6720
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
6721
+ * create/update permission.
6722
+ */
6723
+ parent:
6724
+ string;
6725
+ /** Returns response with indentations and line breaks. */
6726
+ prettyPrint?:
6727
+ boolean;
6728
+ /** 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. */
6729
+ quotaUser?:
6186
6730
  string;
6187
6731
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6188
6732
  upload_protocol?:
@@ -6192,9 +6736,1058 @@ declare namespace gapi.client {
6192
6736
  string;
6193
6737
  /** Request body */
6194
6738
  resource:
6195
- GoogleCloudDiscoveryengineV1alphaConversation;
6196
- }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
6739
+ GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
6740
+ }): Request<GoogleLongrunningOperation>;
6741
+ import(request: {
6742
+ /** V1 error format. */
6743
+ "$.xgafv"?:
6744
+ string;
6745
+ /** OAuth access token. */
6746
+ access_token?:
6747
+ string;
6748
+ /** Data format for response. */
6749
+ alt?:
6750
+ string;
6751
+ /** JSONP */
6752
+ callback?:
6753
+ string;
6754
+ /** Selector specifying which fields to include in a partial response. */
6755
+ fields?:
6756
+ string;
6757
+ /** 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. */
6758
+ key?:
6759
+ string;
6760
+ /** OAuth 2.0 token for the current user. */
6761
+ oauth_token?:
6762
+ string;
6763
+ /**
6764
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
6765
+ * create/update permission.
6766
+ */
6767
+ parent:
6768
+ string;
6769
+ /** Returns response with indentations and line breaks. */
6770
+ prettyPrint?:
6771
+ boolean;
6772
+ /** 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. */
6773
+ quotaUser?:
6774
+ string;
6775
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6776
+ upload_protocol?:
6777
+ string;
6778
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6779
+ uploadType?:
6780
+ string;
6781
+ },
6782
+ body: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest): Request<GoogleLongrunningOperation>;
6783
+ /** Gets a list of Documents. */
6784
+ list(request?: {
6785
+ /** V1 error format. */
6786
+ "$.xgafv"?:
6787
+ string;
6788
+ /** OAuth access token. */
6789
+ access_token?:
6790
+ string;
6791
+ /** Data format for response. */
6792
+ alt?:
6793
+ string;
6794
+ /** JSONP */
6795
+ callback?:
6796
+ string;
6797
+ /** Selector specifying which fields to include in a partial response. */
6798
+ fields?:
6799
+ string;
6800
+ /** 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. */
6801
+ key?:
6802
+ string;
6803
+ /** OAuth 2.0 token for the current user. */
6804
+ oauth_token?:
6805
+ string;
6806
+ /**
6807
+ * 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,
6808
+ * an `INVALID_ARGUMENT` error is returned.
6809
+ */
6810
+ pageSize?:
6811
+ number;
6812
+ /**
6813
+ * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating,
6814
+ * all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
6815
+ */
6816
+ pageToken?:
6817
+ string;
6818
+ /**
6819
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
6820
+ * `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
6821
+ * or not this branch exists, a `PERMISSION_DENIED` error is returned.
6822
+ */
6823
+ parent:
6824
+ string;
6825
+ /** Returns response with indentations and line breaks. */
6826
+ prettyPrint?:
6827
+ boolean;
6828
+ /** 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. */
6829
+ quotaUser?:
6830
+ string;
6831
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6832
+ upload_protocol?:
6833
+ string;
6834
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6835
+ uploadType?:
6836
+ string;
6837
+ }): Request<GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
6838
+ /** Updates a Document. */
6197
6839
  patch(request: {
6840
+ /** V1 error format. */
6841
+ "$.xgafv"?:
6842
+ string;
6843
+ /** OAuth access token. */
6844
+ access_token?:
6845
+ string;
6846
+ /** If set to true, and the Document is not found, a new Document will be created. */
6847
+ allowMissing?:
6848
+ boolean;
6849
+ /** Data format for response. */
6850
+ alt?:
6851
+ string;
6852
+ /** JSONP */
6853
+ callback?:
6854
+ string;
6855
+ /** Selector specifying which fields to include in a partial response. */
6856
+ fields?:
6857
+ string;
6858
+ /** 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. */
6859
+ key?:
6860
+ string;
6861
+ /**
6862
+ * Immutable. The full resource name of the document. Format:
6863
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
6864
+ * with a length limit of 1024 characters.
6865
+ */
6866
+ name:
6867
+ string;
6868
+ /** OAuth 2.0 token for the current user. */
6869
+ oauth_token?:
6870
+ string;
6871
+ /** Returns response with indentations and line breaks. */
6872
+ prettyPrint?:
6873
+ boolean;
6874
+ /** 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. */
6875
+ quotaUser?:
6876
+ string;
6877
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6878
+ upload_protocol?:
6879
+ string;
6880
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6881
+ uploadType?:
6882
+ string;
6883
+ /** Request body */
6884
+ resource:
6885
+ GoogleCloudDiscoveryengineV1alphaDocument;
6886
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6887
+ patch(request: {
6888
+ /** V1 error format. */
6889
+ "$.xgafv"?:
6890
+ string;
6891
+ /** OAuth access token. */
6892
+ access_token?:
6893
+ string;
6894
+ /** If set to true, and the Document is not found, a new Document will be created. */
6895
+ allowMissing?:
6896
+ boolean;
6897
+ /** Data format for response. */
6898
+ alt?:
6899
+ string;
6900
+ /** JSONP */
6901
+ callback?:
6902
+ string;
6903
+ /** Selector specifying which fields to include in a partial response. */
6904
+ fields?:
6905
+ string;
6906
+ /** 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. */
6907
+ key?:
6908
+ string;
6909
+ /**
6910
+ * Immutable. The full resource name of the document. Format:
6911
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
6912
+ * with a length limit of 1024 characters.
6913
+ */
6914
+ name:
6915
+ string;
6916
+ /** OAuth 2.0 token for the current user. */
6917
+ oauth_token?:
6918
+ string;
6919
+ /** Returns response with indentations and line breaks. */
6920
+ prettyPrint?:
6921
+ boolean;
6922
+ /** 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. */
6923
+ quotaUser?:
6924
+ string;
6925
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6926
+ upload_protocol?:
6927
+ string;
6928
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6929
+ uploadType?:
6930
+ string;
6931
+ },
6932
+ body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
6933
+ /**
6934
+ * 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.
6935
+ * 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
6936
+ * deleted, set PurgeDocumentsRequest.force to false.
6937
+ */
6938
+ purge(request: {
6939
+ /** V1 error format. */
6940
+ "$.xgafv"?:
6941
+ string;
6942
+ /** OAuth access token. */
6943
+ access_token?:
6944
+ string;
6945
+ /** Data format for response. */
6946
+ alt?:
6947
+ string;
6948
+ /** JSONP */
6949
+ callback?:
6950
+ string;
6951
+ /** Selector specifying which fields to include in a partial response. */
6952
+ fields?:
6953
+ string;
6954
+ /** 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. */
6955
+ key?:
6956
+ string;
6957
+ /** OAuth 2.0 token for the current user. */
6958
+ oauth_token?:
6959
+ string;
6960
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6961
+ parent:
6962
+ string;
6963
+ /** Returns response with indentations and line breaks. */
6964
+ prettyPrint?:
6965
+ boolean;
6966
+ /** 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. */
6967
+ quotaUser?:
6968
+ string;
6969
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6970
+ upload_protocol?:
6971
+ string;
6972
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6973
+ uploadType?:
6974
+ string;
6975
+ /** Request body */
6976
+ resource:
6977
+ GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
6978
+ }): Request<GoogleLongrunningOperation>;
6979
+ purge(request: {
6980
+ /** V1 error format. */
6981
+ "$.xgafv"?:
6982
+ string;
6983
+ /** OAuth access token. */
6984
+ access_token?:
6985
+ string;
6986
+ /** Data format for response. */
6987
+ alt?:
6988
+ string;
6989
+ /** JSONP */
6990
+ callback?:
6991
+ string;
6992
+ /** Selector specifying which fields to include in a partial response. */
6993
+ fields?:
6994
+ string;
6995
+ /** 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. */
6996
+ key?:
6997
+ string;
6998
+ /** OAuth 2.0 token for the current user. */
6999
+ oauth_token?:
7000
+ string;
7001
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
7002
+ parent:
7003
+ string;
7004
+ /** Returns response with indentations and line breaks. */
7005
+ prettyPrint?:
7006
+ boolean;
7007
+ /** 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. */
7008
+ quotaUser?:
7009
+ string;
7010
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7011
+ upload_protocol?:
7012
+ string;
7013
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7014
+ uploadType?:
7015
+ string;
7016
+ },
7017
+ body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest): Request<GoogleLongrunningOperation>;
7018
+ }
7019
+ interface OperationsResource {
7020
+ /** 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. */
7021
+ get(request?: {
7022
+ /** V1 error format. */
7023
+ "$.xgafv"?:
7024
+ string;
7025
+ /** OAuth access token. */
7026
+ access_token?:
7027
+ string;
7028
+ /** Data format for response. */
7029
+ alt?:
7030
+ string;
7031
+ /** JSONP */
7032
+ callback?:
7033
+ string;
7034
+ /** Selector specifying which fields to include in a partial response. */
7035
+ fields?:
7036
+ string;
7037
+ /** 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. */
7038
+ key?:
7039
+ string;
7040
+ /** The name of the operation resource. */
7041
+ name:
7042
+ string;
7043
+ /** OAuth 2.0 token for the current user. */
7044
+ oauth_token?:
7045
+ string;
7046
+ /** Returns response with indentations and line breaks. */
7047
+ prettyPrint?:
7048
+ boolean;
7049
+ /** 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. */
7050
+ quotaUser?:
7051
+ string;
7052
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7053
+ upload_protocol?:
7054
+ string;
7055
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7056
+ uploadType?:
7057
+ string;
7058
+ }): Request<GoogleLongrunningOperation>;
7059
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7060
+ list(request?: {
7061
+ /** V1 error format. */
7062
+ "$.xgafv"?:
7063
+ string;
7064
+ /** OAuth access token. */
7065
+ access_token?:
7066
+ string;
7067
+ /** Data format for response. */
7068
+ alt?:
7069
+ string;
7070
+ /** JSONP */
7071
+ callback?:
7072
+ string;
7073
+ /** Selector specifying which fields to include in a partial response. */
7074
+ fields?:
7075
+ string;
7076
+ /** The standard list filter. */
7077
+ filter?:
7078
+ string;
7079
+ /** 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. */
7080
+ key?:
7081
+ string;
7082
+ /** The name of the operation's parent resource. */
7083
+ name:
7084
+ string;
7085
+ /** OAuth 2.0 token for the current user. */
7086
+ oauth_token?:
7087
+ string;
7088
+ /** The standard list page size. */
7089
+ pageSize?:
7090
+ number;
7091
+ /** The standard list page token. */
7092
+ pageToken?:
7093
+ string;
7094
+ /** Returns response with indentations and line breaks. */
7095
+ prettyPrint?:
7096
+ boolean;
7097
+ /** 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. */
7098
+ quotaUser?:
7099
+ string;
7100
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7101
+ upload_protocol?:
7102
+ string;
7103
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7104
+ uploadType?:
7105
+ string;
7106
+ }): Request<GoogleLongrunningListOperationsResponse>;
7107
+ }
7108
+ interface BranchesResource {
7109
+ documents:
7110
+ DocumentsResource;
7111
+ operations:
7112
+ OperationsResource;
7113
+ }
7114
+ interface ConversationsResource {
7115
+ /** Converses a conversation. */
7116
+ converse(request: {
7117
+ /** V1 error format. */
7118
+ "$.xgafv"?:
7119
+ string;
7120
+ /** OAuth access token. */
7121
+ access_token?:
7122
+ string;
7123
+ /** Data format for response. */
7124
+ alt?:
7125
+ string;
7126
+ /** JSONP */
7127
+ callback?:
7128
+ string;
7129
+ /** Selector specifying which fields to include in a partial response. */
7130
+ fields?:
7131
+ string;
7132
+ /** 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. */
7133
+ key?:
7134
+ string;
7135
+ /**
7136
+ * Required. The resource name of the Conversation to get. Format:
7137
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
7138
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
7139
+ * creates a new conversation inside a ConverseConversation session.
7140
+ */
7141
+ name:
7142
+ string;
7143
+ /** OAuth 2.0 token for the current user. */
7144
+ oauth_token?:
7145
+ string;
7146
+ /** Returns response with indentations and line breaks. */
7147
+ prettyPrint?:
7148
+ boolean;
7149
+ /** 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. */
7150
+ quotaUser?:
7151
+ string;
7152
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7153
+ upload_protocol?:
7154
+ string;
7155
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7156
+ uploadType?:
7157
+ string;
7158
+ /** Request body */
7159
+ resource:
7160
+ GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
7161
+ }): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
7162
+ converse(request: {
7163
+ /** V1 error format. */
7164
+ "$.xgafv"?:
7165
+ string;
7166
+ /** OAuth access token. */
7167
+ access_token?:
7168
+ string;
7169
+ /** Data format for response. */
7170
+ alt?:
7171
+ string;
7172
+ /** JSONP */
7173
+ callback?:
7174
+ string;
7175
+ /** Selector specifying which fields to include in a partial response. */
7176
+ fields?:
7177
+ string;
7178
+ /** 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. */
7179
+ key?:
7180
+ string;
7181
+ /**
7182
+ * Required. The resource name of the Conversation to get. Format:
7183
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use
7184
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically
7185
+ * creates a new conversation inside a ConverseConversation session.
7186
+ */
7187
+ name:
7188
+ string;
7189
+ /** OAuth 2.0 token for the current user. */
7190
+ oauth_token?:
7191
+ string;
7192
+ /** Returns response with indentations and line breaks. */
7193
+ prettyPrint?:
7194
+ boolean;
7195
+ /** 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. */
7196
+ quotaUser?:
7197
+ string;
7198
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7199
+ upload_protocol?:
7200
+ string;
7201
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7202
+ uploadType?:
7203
+ string;
7204
+ },
7205
+ body: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest): Request<GoogleCloudDiscoveryengineV1alphaConverseConversationResponse>;
7206
+ /** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
7207
+ create(request: {
7208
+ /** V1 error format. */
7209
+ "$.xgafv"?:
7210
+ string;
7211
+ /** OAuth access token. */
7212
+ access_token?:
7213
+ string;
7214
+ /** Data format for response. */
7215
+ alt?:
7216
+ string;
7217
+ /** JSONP */
7218
+ callback?:
7219
+ string;
7220
+ /** Selector specifying which fields to include in a partial response. */
7221
+ fields?:
7222
+ string;
7223
+ /** 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. */
7224
+ key?:
7225
+ string;
7226
+ /** OAuth 2.0 token for the current user. */
7227
+ oauth_token?:
7228
+ string;
7229
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7230
+ parent:
7231
+ string;
7232
+ /** Returns response with indentations and line breaks. */
7233
+ prettyPrint?:
7234
+ boolean;
7235
+ /** 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. */
7236
+ quotaUser?:
7237
+ string;
7238
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7239
+ upload_protocol?:
7240
+ string;
7241
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7242
+ uploadType?:
7243
+ string;
7244
+ /** Request body */
7245
+ resource:
7246
+ GoogleCloudDiscoveryengineV1alphaConversation;
7247
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7248
+ create(request: {
7249
+ /** V1 error format. */
7250
+ "$.xgafv"?:
7251
+ string;
7252
+ /** OAuth access token. */
7253
+ access_token?:
7254
+ string;
7255
+ /** Data format for response. */
7256
+ alt?:
7257
+ string;
7258
+ /** JSONP */
7259
+ callback?:
7260
+ string;
7261
+ /** Selector specifying which fields to include in a partial response. */
7262
+ fields?:
7263
+ string;
7264
+ /** 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. */
7265
+ key?:
7266
+ string;
7267
+ /** OAuth 2.0 token for the current user. */
7268
+ oauth_token?:
7269
+ string;
7270
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7271
+ parent:
7272
+ string;
7273
+ /** Returns response with indentations and line breaks. */
7274
+ prettyPrint?:
7275
+ boolean;
7276
+ /** 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. */
7277
+ quotaUser?:
7278
+ string;
7279
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7280
+ upload_protocol?:
7281
+ string;
7282
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7283
+ uploadType?:
7284
+ string;
7285
+ },
7286
+ body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7287
+ /** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
7288
+ delete(request?: {
7289
+ /** V1 error format. */
7290
+ "$.xgafv"?:
7291
+ string;
7292
+ /** OAuth access token. */
7293
+ access_token?:
7294
+ string;
7295
+ /** Data format for response. */
7296
+ alt?:
7297
+ string;
7298
+ /** JSONP */
7299
+ callback?:
7300
+ string;
7301
+ /** Selector specifying which fields to include in a partial response. */
7302
+ fields?:
7303
+ string;
7304
+ /** 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. */
7305
+ key?:
7306
+ string;
7307
+ /**
7308
+ * Required. The resource name of the Conversation to delete. Format:
7309
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
7310
+ */
7311
+ name:
7312
+ string;
7313
+ /** OAuth 2.0 token for the current user. */
7314
+ oauth_token?:
7315
+ string;
7316
+ /** Returns response with indentations and line breaks. */
7317
+ prettyPrint?:
7318
+ boolean;
7319
+ /** 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. */
7320
+ quotaUser?:
7321
+ string;
7322
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7323
+ upload_protocol?:
7324
+ string;
7325
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7326
+ uploadType?:
7327
+ string;
7328
+ }): Request<{}>;
7329
+ /** Gets a Conversation. */
7330
+ get(request?: {
7331
+ /** V1 error format. */
7332
+ "$.xgafv"?:
7333
+ string;
7334
+ /** OAuth access token. */
7335
+ access_token?:
7336
+ string;
7337
+ /** Data format for response. */
7338
+ alt?:
7339
+ string;
7340
+ /** JSONP */
7341
+ callback?:
7342
+ string;
7343
+ /** Selector specifying which fields to include in a partial response. */
7344
+ fields?:
7345
+ string;
7346
+ /** 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. */
7347
+ key?:
7348
+ string;
7349
+ /**
7350
+ * Required. The resource name of the Conversation to get. Format:
7351
+ * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
7352
+ */
7353
+ name:
7354
+ string;
7355
+ /** OAuth 2.0 token for the current user. */
7356
+ oauth_token?:
7357
+ string;
7358
+ /** Returns response with indentations and line breaks. */
7359
+ prettyPrint?:
7360
+ boolean;
7361
+ /** 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
+ quotaUser?:
7363
+ string;
7364
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7365
+ upload_protocol?:
7366
+ string;
7367
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7368
+ uploadType?:
7369
+ string;
7370
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7371
+ /** Lists all Conversations by their parent DataStore. */
7372
+ list(request?: {
7373
+ /** V1 error format. */
7374
+ "$.xgafv"?:
7375
+ string;
7376
+ /** OAuth access token. */
7377
+ access_token?:
7378
+ string;
7379
+ /** Data format for response. */
7380
+ alt?:
7381
+ string;
7382
+ /** JSONP */
7383
+ callback?:
7384
+ string;
7385
+ /** Selector specifying which fields to include in a partial response. */
7386
+ fields?:
7387
+ string;
7388
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
7389
+ filter?:
7390
+ string;
7391
+ /** 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. */
7392
+ key?:
7393
+ string;
7394
+ /** OAuth 2.0 token for the current user. */
7395
+ oauth_token?:
7396
+ string;
7397
+ /**
7398
+ * 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` *
7399
+ * `conversation_name` Example: "update_time desc" "create_time"
7400
+ */
7401
+ orderBy?:
7402
+ string;
7403
+ /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
7404
+ pageSize?:
7405
+ number;
7406
+ /** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
7407
+ pageToken?:
7408
+ string;
7409
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7410
+ parent:
7411
+ string;
7412
+ /** Returns response with indentations and line breaks. */
7413
+ prettyPrint?:
7414
+ boolean;
7415
+ /** 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. */
7416
+ quotaUser?:
7417
+ string;
7418
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7419
+ upload_protocol?:
7420
+ string;
7421
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7422
+ uploadType?:
7423
+ string;
7424
+ }): Request<GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
7425
+ /** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
7426
+ patch(request: {
7427
+ /** V1 error format. */
7428
+ "$.xgafv"?:
7429
+ string;
7430
+ /** OAuth access token. */
7431
+ access_token?:
7432
+ string;
7433
+ /** Data format for response. */
7434
+ alt?:
7435
+ string;
7436
+ /** JSONP */
7437
+ callback?:
7438
+ string;
7439
+ /** Selector specifying which fields to include in a partial response. */
7440
+ fields?:
7441
+ string;
7442
+ /** 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. */
7443
+ key?:
7444
+ string;
7445
+ /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
7446
+ name:
7447
+ string;
7448
+ /** OAuth 2.0 token for the current user. */
7449
+ oauth_token?:
7450
+ string;
7451
+ /** Returns response with indentations and line breaks. */
7452
+ prettyPrint?:
7453
+ boolean;
7454
+ /** 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. */
7455
+ quotaUser?:
7456
+ string;
7457
+ /** 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. */
7458
+ updateMask?:
7459
+ string;
7460
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7461
+ upload_protocol?:
7462
+ string;
7463
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7464
+ uploadType?:
7465
+ string;
7466
+ /** Request body */
7467
+ resource:
7468
+ GoogleCloudDiscoveryengineV1alphaConversation;
7469
+ }): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7470
+ patch(request: {
7471
+ /** V1 error format. */
7472
+ "$.xgafv"?:
7473
+ string;
7474
+ /** OAuth access token. */
7475
+ access_token?:
7476
+ string;
7477
+ /** Data format for response. */
7478
+ alt?:
7479
+ string;
7480
+ /** JSONP */
7481
+ callback?:
7482
+ string;
7483
+ /** Selector specifying which fields to include in a partial response. */
7484
+ fields?:
7485
+ string;
7486
+ /** 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. */
7487
+ key?:
7488
+ string;
7489
+ /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
7490
+ name:
7491
+ string;
7492
+ /** OAuth 2.0 token for the current user. */
7493
+ oauth_token?:
7494
+ string;
7495
+ /** Returns response with indentations and line breaks. */
7496
+ prettyPrint?:
7497
+ boolean;
7498
+ /** 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. */
7499
+ quotaUser?:
7500
+ string;
7501
+ /** 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. */
7502
+ updateMask?:
7503
+ string;
7504
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7505
+ upload_protocol?:
7506
+ string;
7507
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7508
+ uploadType?:
7509
+ string;
7510
+ },
7511
+ body: GoogleCloudDiscoveryengineV1alphaConversation): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
7512
+ }
7513
+ interface OperationsResource {
7514
+ /** 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. */
7515
+ get(request?: {
7516
+ /** V1 error format. */
7517
+ "$.xgafv"?:
7518
+ string;
7519
+ /** OAuth access token. */
7520
+ access_token?:
7521
+ string;
7522
+ /** Data format for response. */
7523
+ alt?:
7524
+ string;
7525
+ /** JSONP */
7526
+ callback?:
7527
+ string;
7528
+ /** Selector specifying which fields to include in a partial response. */
7529
+ fields?:
7530
+ string;
7531
+ /** 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. */
7532
+ key?:
7533
+ string;
7534
+ /** The name of the operation resource. */
7535
+ name:
7536
+ string;
7537
+ /** OAuth 2.0 token for the current user. */
7538
+ oauth_token?:
7539
+ string;
7540
+ /** Returns response with indentations and line breaks. */
7541
+ prettyPrint?:
7542
+ boolean;
7543
+ /** 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. */
7544
+ quotaUser?:
7545
+ string;
7546
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7547
+ upload_protocol?:
7548
+ string;
7549
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7550
+ uploadType?:
7551
+ string;
7552
+ }): Request<GoogleLongrunningOperation>;
7553
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7554
+ list(request?: {
7555
+ /** V1 error format. */
7556
+ "$.xgafv"?:
7557
+ string;
7558
+ /** OAuth access token. */
7559
+ access_token?:
7560
+ string;
7561
+ /** Data format for response. */
7562
+ alt?:
7563
+ string;
7564
+ /** JSONP */
7565
+ callback?:
7566
+ string;
7567
+ /** Selector specifying which fields to include in a partial response. */
7568
+ fields?:
7569
+ string;
7570
+ /** The standard list filter. */
7571
+ filter?:
7572
+ string;
7573
+ /** 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. */
7574
+ key?:
7575
+ string;
7576
+ /** The name of the operation's parent resource. */
7577
+ name:
7578
+ string;
7579
+ /** OAuth 2.0 token for the current user. */
7580
+ oauth_token?:
7581
+ string;
7582
+ /** The standard list page size. */
7583
+ pageSize?:
7584
+ number;
7585
+ /** The standard list page token. */
7586
+ pageToken?:
7587
+ string;
7588
+ /** Returns response with indentations and line breaks. */
7589
+ prettyPrint?:
7590
+ boolean;
7591
+ /** 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. */
7592
+ quotaUser?:
7593
+ string;
7594
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7595
+ upload_protocol?:
7596
+ string;
7597
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7598
+ uploadType?:
7599
+ string;
7600
+ }): Request<GoogleLongrunningListOperationsResponse>;
7601
+ }
7602
+ interface ModelsResource {
7603
+ operations:
7604
+ OperationsResource;
7605
+ }
7606
+ interface OperationsResource {
7607
+ /** 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. */
7608
+ get(request?: {
7609
+ /** V1 error format. */
7610
+ "$.xgafv"?:
7611
+ string;
7612
+ /** OAuth access token. */
7613
+ access_token?:
7614
+ string;
7615
+ /** Data format for response. */
7616
+ alt?:
7617
+ string;
7618
+ /** JSONP */
7619
+ callback?:
7620
+ string;
7621
+ /** Selector specifying which fields to include in a partial response. */
7622
+ fields?:
7623
+ string;
7624
+ /** 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. */
7625
+ key?:
7626
+ string;
7627
+ /** The name of the operation resource. */
7628
+ name:
7629
+ string;
7630
+ /** OAuth 2.0 token for the current user. */
7631
+ oauth_token?:
7632
+ string;
7633
+ /** Returns response with indentations and line breaks. */
7634
+ prettyPrint?:
7635
+ boolean;
7636
+ /** 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. */
7637
+ quotaUser?:
7638
+ string;
7639
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7640
+ upload_protocol?:
7641
+ string;
7642
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7643
+ uploadType?:
7644
+ string;
7645
+ }): Request<GoogleLongrunningOperation>;
7646
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7647
+ list(request?: {
7648
+ /** V1 error format. */
7649
+ "$.xgafv"?:
7650
+ string;
7651
+ /** OAuth access token. */
7652
+ access_token?:
7653
+ string;
7654
+ /** Data format for response. */
7655
+ alt?:
7656
+ string;
7657
+ /** JSONP */
7658
+ callback?:
7659
+ string;
7660
+ /** Selector specifying which fields to include in a partial response. */
7661
+ fields?:
7662
+ string;
7663
+ /** The standard list filter. */
7664
+ filter?:
7665
+ string;
7666
+ /** 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. */
7667
+ key?:
7668
+ string;
7669
+ /** The name of the operation's parent resource. */
7670
+ name:
7671
+ string;
7672
+ /** OAuth 2.0 token for the current user. */
7673
+ oauth_token?:
7674
+ string;
7675
+ /** The standard list page size. */
7676
+ pageSize?:
7677
+ number;
7678
+ /** The standard list page token. */
7679
+ pageToken?:
7680
+ string;
7681
+ /** Returns response with indentations and line breaks. */
7682
+ prettyPrint?:
7683
+ boolean;
7684
+ /** 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. */
7685
+ quotaUser?:
7686
+ string;
7687
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7688
+ upload_protocol?:
7689
+ string;
7690
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7691
+ uploadType?:
7692
+ string;
7693
+ }): Request<GoogleLongrunningListOperationsResponse>;
7694
+ }
7695
+ interface SchemasResource {
7696
+ /** Creates a Schema. */
7697
+ create(request: {
7698
+ /** V1 error format. */
7699
+ "$.xgafv"?:
7700
+ string;
7701
+ /** OAuth access token. */
7702
+ access_token?:
7703
+ string;
7704
+ /** Data format for response. */
7705
+ alt?:
7706
+ string;
7707
+ /** JSONP */
7708
+ callback?:
7709
+ string;
7710
+ /** Selector specifying which fields to include in a partial response. */
7711
+ fields?:
7712
+ string;
7713
+ /** 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. */
7714
+ key?:
7715
+ string;
7716
+ /** OAuth 2.0 token for the current user. */
7717
+ oauth_token?:
7718
+ string;
7719
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7720
+ parent:
7721
+ string;
7722
+ /** Returns response with indentations and line breaks. */
7723
+ prettyPrint?:
7724
+ boolean;
7725
+ /** 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. */
7726
+ quotaUser?:
7727
+ string;
7728
+ /**
7729
+ * 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)
7730
+ * standard with a length limit of 63 characters.
7731
+ */
7732
+ schemaId?:
7733
+ string;
7734
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7735
+ upload_protocol?:
7736
+ string;
7737
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7738
+ uploadType?:
7739
+ string;
7740
+ /** Request body */
7741
+ resource:
7742
+ GoogleCloudDiscoveryengineV1alphaSchema;
7743
+ }): Request<GoogleLongrunningOperation>;
7744
+ create(request: {
7745
+ /** V1 error format. */
7746
+ "$.xgafv"?:
7747
+ string;
7748
+ /** OAuth access token. */
7749
+ access_token?:
7750
+ string;
7751
+ /** Data format for response. */
7752
+ alt?:
7753
+ string;
7754
+ /** JSONP */
7755
+ callback?:
7756
+ string;
7757
+ /** Selector specifying which fields to include in a partial response. */
7758
+ fields?:
7759
+ string;
7760
+ /** 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. */
7761
+ key?:
7762
+ string;
7763
+ /** OAuth 2.0 token for the current user. */
7764
+ oauth_token?:
7765
+ string;
7766
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7767
+ parent:
7768
+ string;
7769
+ /** Returns response with indentations and line breaks. */
7770
+ prettyPrint?:
7771
+ boolean;
7772
+ /** 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. */
7773
+ quotaUser?:
7774
+ string;
7775
+ /**
7776
+ * 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)
7777
+ * standard with a length limit of 63 characters.
7778
+ */
7779
+ schemaId?:
7780
+ string;
7781
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7782
+ upload_protocol?:
7783
+ string;
7784
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7785
+ uploadType?:
7786
+ string;
7787
+ },
7788
+ body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
7789
+ /** Deletes a Schema. */
7790
+ delete(request?: {
6198
7791
  /** V1 error format. */
6199
7792
  "$.xgafv"?:
6200
7793
  string;
@@ -6213,7 +7806,7 @@ declare namespace gapi.client {
6213
7806
  /** 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
7807
  key?:
6215
7808
  string;
6216
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` */
7809
+ /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
6217
7810
  name:
6218
7811
  string;
6219
7812
  /** OAuth 2.0 token for the current user. */
@@ -6225,20 +7818,14 @@ declare namespace gapi.client {
6225
7818
  /** 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
7819
  quotaUser?:
6227
7820
  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
7821
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6232
7822
  upload_protocol?:
6233
7823
  string;
6234
7824
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6235
7825
  uploadType?:
6236
7826
  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. */
7827
+ }): Request<GoogleLongrunningOperation>;
7828
+ /** Gets a Schema. */
6242
7829
  get(request?: {
6243
7830
  /** V1 error format. */
6244
7831
  "$.xgafv"?:
@@ -6258,7 +7845,7 @@ declare namespace gapi.client {
6258
7845
  /** 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
7846
  key?:
6260
7847
  string;
6261
- /** The name of the operation resource. */
7848
+ /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
6262
7849
  name:
6263
7850
  string;
6264
7851
  /** OAuth 2.0 token for the current user. */
@@ -6276,8 +7863,8 @@ declare namespace gapi.client {
6276
7863
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6277
7864
  uploadType?:
6278
7865
  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`. */
7866
+ }): Request<GoogleCloudDiscoveryengineV1alphaSchema>;
7867
+ /** Gets a list of Schemas. */
6281
7868
  list(request?: {
6282
7869
  /** V1 error format. */
6283
7870
  "$.xgafv"?:
@@ -6294,24 +7881,27 @@ declare namespace gapi.client {
6294
7881
  /** Selector specifying which fields to include in a partial response. */
6295
7882
  fields?:
6296
7883
  string;
6297
- /** The standard list filter. */
6298
- filter?:
6299
- string;
6300
7884
  /** 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
7885
  key?:
6302
7886
  string;
6303
- /** The name of the operation's parent resource. */
6304
- name:
6305
- string;
6306
7887
  /** OAuth 2.0 token for the current user. */
6307
7888
  oauth_token?:
6308
7889
  string;
6309
- /** The standard list page size. */
7890
+ /**
7891
+ * 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
7892
+ * above 1000 will be coerced to 1000.
7893
+ */
6310
7894
  pageSize?:
6311
7895
  number;
6312
- /** The standard list page token. */
7896
+ /**
7897
+ * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
7898
+ * SchemaService.ListSchemas must match the call that provided the page token.
7899
+ */
6313
7900
  pageToken?:
6314
7901
  string;
7902
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7903
+ parent:
7904
+ string;
6315
7905
  /** Returns response with indentations and line breaks. */
6316
7906
  prettyPrint?:
6317
7907
  boolean;
@@ -6324,21 +7914,18 @@ declare namespace gapi.client {
6324
7914
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6325
7915
  uploadType?:
6326
7916
  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?: {
7917
+ }): Request<GoogleCloudDiscoveryengineV1alphaListSchemasResponse>;
7918
+ /** Updates a Schema. */
7919
+ patch(request: {
6336
7920
  /** V1 error format. */
6337
7921
  "$.xgafv"?:
6338
7922
  string;
6339
7923
  /** OAuth access token. */
6340
7924
  access_token?:
6341
7925
  string;
7926
+ /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
7927
+ allowMissing?:
7928
+ boolean;
6342
7929
  /** Data format for response. */
6343
7930
  alt?:
6344
7931
  string;
@@ -6351,7 +7938,10 @@ declare namespace gapi.client {
6351
7938
  /** 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
7939
  key?:
6353
7940
  string;
6354
- /** The name of the operation resource. */
7941
+ /**
7942
+ * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
7943
+ * This field must be a UTF-8 encoded string with a length limit of 1024 characters.
7944
+ */
6355
7945
  name:
6356
7946
  string;
6357
7947
  /** OAuth 2.0 token for the current user. */
@@ -6369,15 +7959,20 @@ declare namespace gapi.client {
6369
7959
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6370
7960
  uploadType?:
6371
7961
  string;
7962
+ /** Request body */
7963
+ resource:
7964
+ GoogleCloudDiscoveryengineV1alphaSchema;
6372
7965
  }): Request<GoogleLongrunningOperation>;
6373
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6374
- list(request?: {
7966
+ patch(request: {
6375
7967
  /** V1 error format. */
6376
7968
  "$.xgafv"?:
6377
7969
  string;
6378
7970
  /** OAuth access token. */
6379
7971
  access_token?:
6380
7972
  string;
7973
+ /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
7974
+ allowMissing?:
7975
+ boolean;
6381
7976
  /** Data format for response. */
6382
7977
  alt?:
6383
7978
  string;
@@ -6387,24 +7982,18 @@ declare namespace gapi.client {
6387
7982
  /** Selector specifying which fields to include in a partial response. */
6388
7983
  fields?:
6389
7984
  string;
6390
- /** The standard list filter. */
6391
- filter?:
6392
- string;
6393
7985
  /** 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
7986
  key?:
6395
7987
  string;
6396
- /** The name of the operation's parent resource. */
7988
+ /**
7989
+ * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
7990
+ * This field must be a UTF-8 encoded string with a length limit of 1024 characters.
7991
+ */
6397
7992
  name:
6398
7993
  string;
6399
7994
  /** OAuth 2.0 token for the current user. */
6400
7995
  oauth_token?:
6401
7996
  string;
6402
- /** The standard list page size. */
6403
- pageSize?:
6404
- number;
6405
- /** The standard list page token. */
6406
- pageToken?:
6407
- string;
6408
7997
  /** Returns response with indentations and line breaks. */
6409
7998
  prettyPrint?:
6410
7999
  boolean;
@@ -6417,11 +8006,12 @@ declare namespace gapi.client {
6417
8006
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6418
8007
  uploadType?:
6419
8008
  string;
6420
- }): Request<GoogleLongrunningListOperationsResponse>;
8009
+ },
8010
+ body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
6421
8011
  }
6422
- interface SchemasResource {
6423
- /** Creates a Schema. */
6424
- create(request: {
8012
+ interface ServingConfigsResource {
8013
+ /** Makes a recommendation, which requires a contextual user event. */
8014
+ recommend(request: {
6425
8015
  /** V1 error format. */
6426
8016
  "$.xgafv"?:
6427
8017
  string;
@@ -6443,9 +8033,6 @@ declare namespace gapi.client {
6443
8033
  /** OAuth 2.0 token for the current user. */
6444
8034
  oauth_token?:
6445
8035
  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
8036
  /** Returns response with indentations and line breaks. */
6450
8037
  prettyPrint?:
6451
8038
  boolean;
@@ -6453,10 +8040,12 @@ declare namespace gapi.client {
6453
8040
  quotaUser?:
6454
8041
  string;
6455
8042
  /**
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.
8043
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
8044
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
8045
+ * 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
8046
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
6458
8047
  */
6459
- schemaId?:
8048
+ servingConfig:
6460
8049
  string;
6461
8050
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6462
8051
  upload_protocol?:
@@ -6466,9 +8055,9 @@ declare namespace gapi.client {
6466
8055
  string;
6467
8056
  /** Request body */
6468
8057
  resource:
6469
- GoogleCloudDiscoveryengineV1alphaSchema;
6470
- }): Request<GoogleLongrunningOperation>;
6471
- create(request: {
8058
+ GoogleCloudDiscoveryengineV1alphaRecommendRequest;
8059
+ }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
8060
+ recommend(request: {
6472
8061
  /** V1 error format. */
6473
8062
  "$.xgafv"?:
6474
8063
  string;
@@ -6490,9 +8079,6 @@ declare namespace gapi.client {
6490
8079
  /** OAuth 2.0 token for the current user. */
6491
8080
  oauth_token?:
6492
8081
  string;
6493
- /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
6494
- parent:
6495
- string;
6496
8082
  /** Returns response with indentations and line breaks. */
6497
8083
  prettyPrint?:
6498
8084
  boolean;
@@ -6500,10 +8086,12 @@ declare namespace gapi.client {
6500
8086
  quotaUser?:
6501
8087
  string;
6502
8088
  /**
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.
8089
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
8090
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
8091
+ * 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
8092
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
6505
8093
  */
6506
- schemaId?:
8094
+ servingConfig:
6507
8095
  string;
6508
8096
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6509
8097
  upload_protocol?:
@@ -6512,9 +8100,9 @@ declare namespace gapi.client {
6512
8100
  uploadType?:
6513
8101
  string;
6514
8102
  },
6515
- body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
6516
- /** Deletes a Schema. */
6517
- delete(request?: {
8103
+ body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
8104
+ /** Performs a search. */
8105
+ search(request: {
6518
8106
  /** V1 error format. */
6519
8107
  "$.xgafv"?:
6520
8108
  string;
@@ -6533,9 +8121,6 @@ declare namespace gapi.client {
6533
8121
  /** 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
8122
  key?:
6535
8123
  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
8124
  /** OAuth 2.0 token for the current user. */
6540
8125
  oauth_token?:
6541
8126
  string;
@@ -6545,15 +8130,24 @@ declare namespace gapi.client {
6545
8130
  /** 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. */
6546
8131
  quotaUser?:
6547
8132
  string;
8133
+ /**
8134
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
8135
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
8136
+ * configuration name, set of models used to make the search.
8137
+ */
8138
+ servingConfig:
8139
+ string;
6548
8140
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6549
8141
  upload_protocol?:
6550
8142
  string;
6551
8143
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6552
8144
  uploadType?:
6553
8145
  string;
6554
- }): Request<GoogleLongrunningOperation>;
6555
- /** Gets a Schema. */
6556
- get(request?: {
8146
+ /** Request body */
8147
+ resource:
8148
+ GoogleCloudDiscoveryengineV1alphaSearchRequest;
8149
+ }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
8150
+ search(request: {
6557
8151
  /** V1 error format. */
6558
8152
  "$.xgafv"?:
6559
8153
  string;
@@ -6572,9 +8166,6 @@ declare namespace gapi.client {
6572
8166
  /** 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
8167
  key?:
6574
8168
  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}`. */
6576
- name:
6577
- string;
6578
8169
  /** OAuth 2.0 token for the current user. */
6579
8170
  oauth_token?:
6580
8171
  string;
@@ -6584,15 +8175,25 @@ declare namespace gapi.client {
6584
8175
  /** 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. */
6585
8176
  quotaUser?:
6586
8177
  string;
8178
+ /**
8179
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
8180
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
8181
+ * configuration name, set of models used to make the search.
8182
+ */
8183
+ servingConfig:
8184
+ string;
6587
8185
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6588
8186
  upload_protocol?:
6589
8187
  string;
6590
8188
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6591
8189
  uploadType?:
6592
8190
  string;
6593
- }): Request<GoogleCloudDiscoveryengineV1alphaSchema>;
6594
- /** Gets a list of Schemas. */
6595
- list(request?: {
8191
+ },
8192
+ body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
8193
+ }
8194
+ interface SiteSearchEngineResource {
8195
+ /** Request on-demand recrawl for a list of URIs. */
8196
+ recrawlUris(request: {
6596
8197
  /** V1 error format. */
6597
8198
  "$.xgafv"?:
6598
8199
  string;
@@ -6614,45 +8215,32 @@ declare namespace gapi.client {
6614
8215
  /** OAuth 2.0 token for the current user. */
6615
8216
  oauth_token?:
6616
8217
  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
- */
6621
- pageSize?:
6622
- 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
- */
6627
- pageToken?:
6628
- 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
8218
  /** Returns response with indentations and line breaks. */
6633
8219
  prettyPrint?:
6634
8220
  boolean;
6635
8221
  /** 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. */
6636
8222
  quotaUser?:
6637
8223
  string;
8224
+ /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
8225
+ siteSearchEngine:
8226
+ string;
6638
8227
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6639
8228
  upload_protocol?:
6640
8229
  string;
6641
8230
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6642
8231
  uploadType?:
6643
8232
  string;
6644
- }): Request<GoogleCloudDiscoveryengineV1alphaListSchemasResponse>;
6645
- /** Updates a Schema. */
6646
- patch(request: {
8233
+ /** Request body */
8234
+ resource:
8235
+ GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
8236
+ }): Request<GoogleLongrunningOperation>;
8237
+ recrawlUris(request: {
6647
8238
  /** V1 error format. */
6648
8239
  "$.xgafv"?:
6649
8240
  string;
6650
8241
  /** OAuth access token. */
6651
8242
  access_token?:
6652
8243
  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
8244
  /** Data format for response. */
6657
8245
  alt?:
6658
8246
  string;
@@ -6665,12 +8253,6 @@ declare namespace gapi.client {
6665
8253
  /** 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. */
6666
8254
  key?:
6667
8255
  string;
6668
- /**
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.
6671
- */
6672
- name:
6673
- string;
6674
8256
  /** OAuth 2.0 token for the current user. */
6675
8257
  oauth_token?:
6676
8258
  string;
@@ -6680,47 +8262,51 @@ declare namespace gapi.client {
6680
8262
  /** 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. */
6681
8263
  quotaUser?:
6682
8264
  string;
8265
+ /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
8266
+ siteSearchEngine:
8267
+ string;
6683
8268
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6684
8269
  upload_protocol?:
6685
8270
  string;
6686
8271
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6687
8272
  uploadType?:
6688
8273
  string;
6689
- /** Request body */
6690
- resource:
6691
- GoogleCloudDiscoveryengineV1alphaSchema;
6692
- }): Request<GoogleLongrunningOperation>;
6693
- patch(request: {
8274
+ },
8275
+ body: GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest): Request<GoogleLongrunningOperation>;
8276
+ }
8277
+ interface UserEventsResource {
8278
+ /**
8279
+ * 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
8280
+ * Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
8281
+ */
8282
+ collect(request?: {
6694
8283
  /** V1 error format. */
6695
8284
  "$.xgafv"?:
6696
8285
  string;
6697
8286
  /** OAuth access token. */
6698
8287
  access_token?:
6699
8288
  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
8289
  /** Data format for response. */
6704
8290
  alt?:
6705
8291
  string;
6706
8292
  /** JSONP */
6707
8293
  callback?:
6708
8294
  string;
8295
+ /** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
8296
+ ets?:
8297
+ string;
6709
8298
  /** Selector specifying which fields to include in a partial response. */
6710
8299
  fields?:
6711
8300
  string;
6712
8301
  /** 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. */
6713
8302
  key?:
6714
8303
  string;
6715
- /**
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.
6718
- */
6719
- name:
6720
- string;
6721
8304
  /** OAuth 2.0 token for the current user. */
6722
8305
  oauth_token?:
6723
8306
  string;
8307
+ /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8308
+ parent:
8309
+ string;
6724
8310
  /** Returns response with indentations and line breaks. */
6725
8311
  prettyPrint?:
6726
8312
  boolean;
@@ -6733,12 +8319,21 @@ declare namespace gapi.client {
6733
8319
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6734
8320
  uploadType?:
6735
8321
  string;
6736
- },
6737
- body: GoogleCloudDiscoveryengineV1alphaSchema): Request<GoogleLongrunningOperation>;
6738
- }
6739
- interface ServingConfigsResource {
6740
- /** Makes a recommendation, which requires a contextual user event. */
6741
- recommend(request: {
8322
+ /**
8323
+ * 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
8324
+ * only send the domain for third-party requests.
8325
+ */
8326
+ uri?:
8327
+ string;
8328
+ /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
8329
+ userEvent?:
8330
+ string;
8331
+ }): Request<GoogleApiHttpBody>;
8332
+ /**
8333
+ * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
8334
+ * 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.
8335
+ */
8336
+ import(request: {
6742
8337
  /** V1 error format. */
6743
8338
  "$.xgafv"?:
6744
8339
  string;
@@ -6760,18 +8355,15 @@ declare namespace gapi.client {
6760
8355
  /** OAuth 2.0 token for the current user. */
6761
8356
  oauth_token?:
6762
8357
  string;
8358
+ /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8359
+ parent:
8360
+ string;
6763
8361
  /** Returns response with indentations and line breaks. */
6764
8362
  prettyPrint?:
6765
8363
  boolean;
6766
8364
  /** 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
8365
  quotaUser?:
6768
8366
  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
8367
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6776
8368
  upload_protocol?:
6777
8369
  string;
@@ -6780,9 +8372,9 @@ declare namespace gapi.client {
6780
8372
  string;
6781
8373
  /** Request body */
6782
8374
  resource:
6783
- GoogleCloudDiscoveryengineV1alphaRecommendRequest;
6784
- }): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
6785
- recommend(request: {
8375
+ GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest;
8376
+ }): Request<GoogleLongrunningOperation>;
8377
+ import(request: {
6786
8378
  /** V1 error format. */
6787
8379
  "$.xgafv"?:
6788
8380
  string;
@@ -6804,18 +8396,15 @@ declare namespace gapi.client {
6804
8396
  /** OAuth 2.0 token for the current user. */
6805
8397
  oauth_token?:
6806
8398
  string;
8399
+ /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8400
+ parent:
8401
+ string;
6807
8402
  /** Returns response with indentations and line breaks. */
6808
8403
  prettyPrint?:
6809
8404
  boolean;
6810
8405
  /** 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
8406
  quotaUser?:
6812
8407
  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
8408
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6820
8409
  upload_protocol?:
6821
8410
  string;
@@ -6823,9 +8412,12 @@ declare namespace gapi.client {
6823
8412
  uploadType?:
6824
8413
  string;
6825
8414
  },
6826
- body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
6827
- /** Performs a search. */
6828
- search(request: {
8415
+ body: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
8416
+ /**
8417
+ * 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.
8418
+ * To test a filter, use the list command first.
8419
+ */
8420
+ purge(request: {
6829
8421
  /** V1 error format. */
6830
8422
  "$.xgafv"?:
6831
8423
  string;
@@ -6847,19 +8439,18 @@ declare namespace gapi.client {
6847
8439
  /** OAuth 2.0 token for the current user. */
6848
8440
  oauth_token?:
6849
8441
  string;
8442
+ /**
8443
+ * Required. The resource name of the catalog under which the events are created. The format is
8444
+ * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
8445
+ */
8446
+ parent:
8447
+ string;
6850
8448
  /** Returns response with indentations and line breaks. */
6851
8449
  prettyPrint?:
6852
8450
  boolean;
6853
8451
  /** 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
8452
  quotaUser?:
6855
8453
  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
8454
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6864
8455
  upload_protocol?:
6865
8456
  string;
@@ -6868,9 +8459,9 @@ declare namespace gapi.client {
6868
8459
  string;
6869
8460
  /** Request body */
6870
8461
  resource:
6871
- GoogleCloudDiscoveryengineV1alphaSearchRequest;
6872
- }): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6873
- search(request: {
8462
+ GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest;
8463
+ }): Request<GoogleLongrunningOperation>;
8464
+ purge(request: {
6874
8465
  /** V1 error format. */
6875
8466
  "$.xgafv"?:
6876
8467
  string;
@@ -6892,19 +8483,18 @@ declare namespace gapi.client {
6892
8483
  /** OAuth 2.0 token for the current user. */
6893
8484
  oauth_token?:
6894
8485
  string;
8486
+ /**
8487
+ * Required. The resource name of the catalog under which the events are created. The format is
8488
+ * `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
8489
+ */
8490
+ parent:
8491
+ string;
6895
8492
  /** Returns response with indentations and line breaks. */
6896
8493
  prettyPrint?:
6897
8494
  boolean;
6898
8495
  /** 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
8496
  quotaUser?:
6900
8497
  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
8498
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6909
8499
  upload_protocol?:
6910
8500
  string;
@@ -6912,11 +8502,9 @@ declare namespace gapi.client {
6912
8502
  uploadType?:
6913
8503
  string;
6914
8504
  },
6915
- body: GoogleCloudDiscoveryengineV1alphaSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6916
- }
6917
- interface SiteSearchEngineResource {
6918
- /** Request on-demand recrawl for a list of URIs. */
6919
- recrawlUris(request: {
8505
+ body: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
8506
+ /** Writes a single user event. */
8507
+ write(request: {
6920
8508
  /** V1 error format. */
6921
8509
  "$.xgafv"?:
6922
8510
  string;
@@ -6938,15 +8526,15 @@ declare namespace gapi.client {
6938
8526
  /** OAuth 2.0 token for the current user. */
6939
8527
  oauth_token?:
6940
8528
  string;
8529
+ /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8530
+ parent:
8531
+ string;
6941
8532
  /** Returns response with indentations and line breaks. */
6942
8533
  prettyPrint?:
6943
8534
  boolean;
6944
8535
  /** 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
8536
  quotaUser?:
6946
8537
  string;
6947
- /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
6948
- siteSearchEngine:
6949
- string;
6950
8538
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6951
8539
  upload_protocol?:
6952
8540
  string;
@@ -6955,9 +8543,9 @@ declare namespace gapi.client {
6955
8543
  string;
6956
8544
  /** Request body */
6957
8545
  resource:
6958
- GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest;
6959
- }): Request<GoogleLongrunningOperation>;
6960
- recrawlUris(request: {
8546
+ GoogleCloudDiscoveryengineV1alphaUserEvent;
8547
+ }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
8548
+ write(request: {
6961
8549
  /** V1 error format. */
6962
8550
  "$.xgafv"?:
6963
8551
  string;
@@ -6979,15 +8567,15 @@ declare namespace gapi.client {
6979
8567
  /** OAuth 2.0 token for the current user. */
6980
8568
  oauth_token?:
6981
8569
  string;
8570
+ /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8571
+ parent:
8572
+ string;
6982
8573
  /** Returns response with indentations and line breaks. */
6983
8574
  prettyPrint?:
6984
8575
  boolean;
6985
8576
  /** 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
8577
  quotaUser?:
6987
8578
  string;
6988
- /** Required. Full resource name of the SiteSearchEngine, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine`. */
6989
- siteSearchEngine:
6990
- string;
6991
8579
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6992
8580
  upload_protocol?:
6993
8581
  string;
@@ -6995,14 +8583,11 @@ declare namespace gapi.client {
6995
8583
  uploadType?:
6996
8584
  string;
6997
8585
  },
6998
- body: GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest): Request<GoogleLongrunningOperation>;
8586
+ body: GoogleCloudDiscoveryengineV1alphaUserEvent): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
6999
8587
  }
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?: {
8588
+ interface DataStoresResource {
8589
+ /** Completes the specified user input with keyword suggestions. */
8590
+ completeQuery(request?: {
7006
8591
  /** V1 error format. */
7007
8592
  "$.xgafv"?:
7008
8593
  string;
@@ -7015,24 +8600,41 @@ declare namespace gapi.client {
7015
8600
  /** JSONP */
7016
8601
  callback?:
7017
8602
  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?:
8603
+ /**
8604
+ * Required. The parent data store resource name for which the completion is performed, such as
8605
+ * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`.
8606
+ */
8607
+ dataStore:
7020
8608
  string;
7021
8609
  /** Selector specifying which fields to include in a partial response. */
7022
8610
  fields?:
7023
8611
  string;
8612
+ /**
8613
+ * 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,
8614
+ * those are returned and no tail suggestions are returned.
8615
+ */
8616
+ includeTailSuggestions?:
8617
+ boolean;
7024
8618
  /** 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
8619
  key?:
7026
8620
  string;
7027
8621
  /** OAuth 2.0 token for the current user. */
7028
8622
  oauth_token?:
7029
8623
  string;
7030
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7031
- parent:
7032
- string;
7033
8624
  /** Returns response with indentations and line breaks. */
7034
8625
  prettyPrint?:
7035
8626
  boolean;
8627
+ /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
8628
+ query?:
8629
+ string;
8630
+ /**
8631
+ * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` -
8632
+ * 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
8633
+ * generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values:
8634
+ * * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
8635
+ */
8636
+ queryModel?:
8637
+ string;
7036
8638
  /** 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
8639
  quotaUser?:
7038
8640
  string;
@@ -7043,20 +8645,16 @@ declare namespace gapi.client {
7043
8645
  uploadType?:
7044
8646
  string;
7045
8647
  /**
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.
8648
+ * 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.
8649
+ * 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
8650
+ * 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
8651
+ * `INVALID_ARGUMENT` error is returned.
7048
8652
  */
7049
- uri?:
7050
- string;
7051
- /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
7052
- userEvent?:
8653
+ userPseudoId?:
7053
8654
  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: {
8655
+ }): Request<GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>;
8656
+ /** 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. */
8657
+ create(request: {
7060
8658
  /** V1 error format. */
7061
8659
  "$.xgafv"?:
7062
8660
  string;
@@ -7069,6 +8667,18 @@ declare namespace gapi.client {
7069
8667
  /** JSONP */
7070
8668
  callback?:
7071
8669
  string;
8670
+ /**
8671
+ * 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
8672
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
8673
+ */
8674
+ createAdvancedSiteSearch?:
8675
+ boolean;
8676
+ /**
8677
+ * 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
8678
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
8679
+ */
8680
+ dataStoreId?:
8681
+ string;
7072
8682
  /** Selector specifying which fields to include in a partial response. */
7073
8683
  fields?:
7074
8684
  string;
@@ -7078,7 +8688,7 @@ declare namespace gapi.client {
7078
8688
  /** OAuth 2.0 token for the current user. */
7079
8689
  oauth_token?:
7080
8690
  string;
7081
- /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8691
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
7082
8692
  parent:
7083
8693
  string;
7084
8694
  /** Returns response with indentations and line breaks. */
@@ -7095,9 +8705,9 @@ declare namespace gapi.client {
7095
8705
  string;
7096
8706
  /** Request body */
7097
8707
  resource:
7098
- GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest;
8708
+ GoogleCloudDiscoveryengineV1alphaDataStore;
7099
8709
  }): Request<GoogleLongrunningOperation>;
7100
- import(request: {
8710
+ create(request: {
7101
8711
  /** V1 error format. */
7102
8712
  "$.xgafv"?:
7103
8713
  string;
@@ -7110,6 +8720,18 @@ declare namespace gapi.client {
7110
8720
  /** JSONP */
7111
8721
  callback?:
7112
8722
  string;
8723
+ /**
8724
+ * 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
8725
+ * PUBLIC_WEBSITE content_config), this flag will be ignored.
8726
+ */
8727
+ createAdvancedSiteSearch?:
8728
+ boolean;
8729
+ /**
8730
+ * 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
8731
+ * [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
8732
+ */
8733
+ dataStoreId?:
8734
+ string;
7113
8735
  /** Selector specifying which fields to include in a partial response. */
7114
8736
  fields?:
7115
8737
  string;
@@ -7119,7 +8741,7 @@ declare namespace gapi.client {
7119
8741
  /** OAuth 2.0 token for the current user. */
7120
8742
  oauth_token?:
7121
8743
  string;
7122
- /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
8744
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
7123
8745
  parent:
7124
8746
  string;
7125
8747
  /** Returns response with indentations and line breaks. */
@@ -7135,12 +8757,9 @@ declare namespace gapi.client {
7135
8757
  uploadType?:
7136
8758
  string;
7137
8759
  },
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: {
8760
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleLongrunningOperation>;
8761
+ /** Deletes a DataStore. */
8762
+ delete(request?: {
7144
8763
  /** V1 error format. */
7145
8764
  "$.xgafv"?:
7146
8765
  string;
@@ -7159,14 +8778,15 @@ declare namespace gapi.client {
7159
8778
  /** 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
8779
  key?:
7161
8780
  string;
7162
- /** OAuth 2.0 token for the current user. */
7163
- oauth_token?:
7164
- string;
7165
8781
  /**
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}`
8782
+ * 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
8783
+ * 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
8784
+ * is returned.
7168
8785
  */
7169
- parent:
8786
+ name:
8787
+ string;
8788
+ /** OAuth 2.0 token for the current user. */
8789
+ oauth_token?:
7170
8790
  string;
7171
8791
  /** Returns response with indentations and line breaks. */
7172
8792
  prettyPrint?:
@@ -7180,11 +8800,9 @@ declare namespace gapi.client {
7180
8800
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7181
8801
  uploadType?:
7182
8802
  string;
7183
- /** Request body */
7184
- resource:
7185
- GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest;
7186
8803
  }): Request<GoogleLongrunningOperation>;
7187
- purge(request: {
8804
+ /** Gets a DataStore. */
8805
+ get(request?: {
7188
8806
  /** V1 error format. */
7189
8807
  "$.xgafv"?:
7190
8808
  string;
@@ -7203,14 +8821,15 @@ declare namespace gapi.client {
7203
8821
  /** 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
8822
  key?:
7205
8823
  string;
7206
- /** OAuth 2.0 token for the current user. */
7207
- oauth_token?:
7208
- string;
7209
8824
  /**
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}`
8825
+ * 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
8826
+ * 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
8827
+ * is returned.
7212
8828
  */
7213
- parent:
8829
+ name:
8830
+ string;
8831
+ /** OAuth 2.0 token for the current user. */
8832
+ oauth_token?:
7214
8833
  string;
7215
8834
  /** Returns response with indentations and line breaks. */
7216
8835
  prettyPrint?:
@@ -7224,10 +8843,9 @@ declare namespace gapi.client {
7224
8843
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7225
8844
  uploadType?:
7226
8845
  string;
7227
- },
7228
- body: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
7229
- /** Writes a single user event. */
7230
- write(request: {
8846
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
8847
+ /** Lists all the DataStores associated with the project. */
8848
+ list(request?: {
7231
8849
  /** V1 error format. */
7232
8850
  "$.xgafv"?:
7233
8851
  string;
@@ -7243,13 +8861,31 @@ declare namespace gapi.client {
7243
8861
  /** Selector specifying which fields to include in a partial response. */
7244
8862
  fields?:
7245
8863
  string;
8864
+ /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
8865
+ filter?:
8866
+ string;
7246
8867
  /** 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
8868
  key?:
7248
8869
  string;
7249
8870
  /** OAuth 2.0 token for the current user. */
7250
8871
  oauth_token?:
7251
8872
  string;
7252
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
8873
+ /**
8874
+ * 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
8875
+ * INVALID_ARGUMENT is returned.
8876
+ */
8877
+ pageSize?:
8878
+ number;
8879
+ /**
8880
+ * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When
8881
+ * paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
8882
+ */
8883
+ pageToken?:
8884
+ string;
8885
+ /**
8886
+ * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list
8887
+ * DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
8888
+ */
7253
8889
  parent:
7254
8890
  string;
7255
8891
  /** Returns response with indentations and line breaks. */
@@ -7264,11 +8900,9 @@ declare namespace gapi.client {
7264
8900
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7265
8901
  uploadType?:
7266
8902
  string;
7267
- /** Request body */
7268
- resource:
7269
- GoogleCloudDiscoveryengineV1alphaUserEvent;
7270
- }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
7271
- write(request: {
8903
+ }): Request<GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>;
8904
+ /** Updates a DataStore */
8905
+ patch(request: {
7272
8906
  /** V1 error format. */
7273
8907
  "$.xgafv"?:
7274
8908
  string;
@@ -7287,30 +8921,35 @@ declare namespace gapi.client {
7287
8921
  /** 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
8922
  key?:
7289
8923
  string;
8924
+ /**
8925
+ * 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
8926
+ * a UTF-8 encoded string with a length limit of 1024 characters.
8927
+ */
8928
+ name:
8929
+ string;
7290
8930
  /** OAuth 2.0 token for the current user. */
7291
8931
  oauth_token?:
7292
8932
  string;
7293
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7294
- parent:
7295
- string;
7296
8933
  /** Returns response with indentations and line breaks. */
7297
8934
  prettyPrint?:
7298
8935
  boolean;
7299
8936
  /** 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
8937
  quotaUser?:
7301
8938
  string;
8939
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
8940
+ updateMask?:
8941
+ string;
7302
8942
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7303
8943
  upload_protocol?:
7304
8944
  string;
7305
8945
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7306
8946
  uploadType?:
7307
8947
  string;
7308
- },
7309
- body: GoogleCloudDiscoveryengineV1alphaUserEvent): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
7310
- }
7311
- interface DataStoresResource {
7312
- /** Completes the specified user input with keyword suggestions. */
7313
- completeQuery(request?: {
8948
+ /** Request body */
8949
+ resource:
8950
+ GoogleCloudDiscoveryengineV1alphaDataStore;
8951
+ }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
8952
+ patch(request: {
7314
8953
  /** V1 error format. */
7315
8954
  "$.xgafv"?:
7316
8955
  string;
@@ -7323,59 +8962,38 @@ declare namespace gapi.client {
7323
8962
  /** JSONP */
7324
8963
  callback?:
7325
8964
  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
8965
  /** Selector specifying which fields to include in a partial response. */
7333
8966
  fields?:
7334
8967
  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
8968
  /** 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
8969
  key?:
7343
8970
  string;
8971
+ /**
8972
+ * 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
8973
+ * a UTF-8 encoded string with a length limit of 1024 characters.
8974
+ */
8975
+ name:
8976
+ string;
7344
8977
  /** OAuth 2.0 token for the current user. */
7345
8978
  oauth_token?:
7346
8979
  string;
7347
8980
  /** Returns response with indentations and line breaks. */
7348
8981
  prettyPrint?:
7349
8982
  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
8983
  /** 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
8984
  quotaUser?:
7363
8985
  string;
8986
+ /** Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
8987
+ updateMask?:
8988
+ string;
7364
8989
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7365
8990
  upload_protocol?:
7366
8991
  string;
7367
8992
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7368
8993
  uploadType?:
7369
8994
  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>;
8995
+ },
8996
+ body: GoogleCloudDiscoveryengineV1alphaDataStore): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
7379
8997
  branches:
7380
8998
  BranchesResource;
7381
8999
  conversations: