@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240409 → 0.0.20240502

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 +409 -472
  2. package/package.json +1 -1
  3. package/readme.md +7 -18
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: 20240409
12
+ // Revision: 20240502
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -88,10 +88,6 @@ declare namespace gapi.client {
88
88
  /** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
89
89
  name?: string;
90
90
  }
91
- interface GoogleCloudDiscoveryengineV1alphaAdditionalParams {
92
- /** Token that used for non-human user check. */
93
- token?: string;
94
- }
95
91
  interface GoogleCloudDiscoveryengineV1alphaAnswer {
96
92
  /** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
97
93
  answerSkippedReasons?: string[];
@@ -103,7 +99,7 @@ declare namespace gapi.client {
103
99
  completeTime?: string;
104
100
  /** Output only. Answer creation timestamp. */
105
101
  createTime?: string;
106
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
102
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
107
103
  name?: string;
108
104
  /** Query understanding information. */
109
105
  queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
@@ -183,7 +179,7 @@ declare namespace gapi.client {
183
179
  interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
184
180
  /** Disable query rephraser. */
185
181
  disable?: boolean;
186
- /** Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default. */
182
+ /** Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */
187
183
  maxRephraseSteps?: number;
188
184
  }
189
185
  interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec {
@@ -203,6 +199,8 @@ declare namespace gapi.client {
203
199
  interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams {
204
200
  /** Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
205
201
  boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
202
+ /** Custom fine tuning configs. */
203
+ customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
206
204
  /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
207
205
  filter?: string;
208
206
  /** Number of search results to return. The default value is 10. */
@@ -263,6 +261,8 @@ declare namespace gapi.client {
263
261
  interface GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse {
264
262
  /** Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
265
263
  answer?: GoogleCloudDiscoveryengineV1alphaAnswer;
264
+ /** A global unique ID used for logging. */
265
+ answerQueryToken?: string;
266
266
  /** Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */
267
267
  session?: GoogleCloudDiscoveryengineV1alphaSession;
268
268
  }
@@ -436,12 +436,14 @@ declare namespace gapi.client {
436
436
  tableId?: string;
437
437
  }
438
438
  interface GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest {
439
- /** Answer candidate to check. */
439
+ /** Answer candidate to check. Can have a maximum length of 1024 characters. */
440
440
  answerCandidate?: string;
441
441
  /** List of facts for the grounding check. We support up to 200 facts. */
442
442
  facts?: GoogleCloudDiscoveryengineV1alphaGroundingFact[];
443
443
  /** Configuration of the grounding check. */
444
444
  groundingSpec?: GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec;
445
+ /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
446
+ userLabels?: {[P in string]: string};
445
447
  }
446
448
  interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse {
447
449
  /** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
@@ -458,7 +460,9 @@ declare namespace gapi.client {
458
460
  claimText?: string;
459
461
  /** Position indicating the end of the claim in the answer candidate, exclusive. */
460
462
  endPos?: number;
461
- /** Position indicating the start of the claim in the answer candidate, measured in bytes/unicode. */
463
+ /** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */
464
+ groundingCheckRequired?: boolean;
465
+ /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
462
466
  startPos?: number;
463
467
  }
464
468
  interface GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec {
@@ -488,6 +492,8 @@ declare namespace gapi.client {
488
492
  previousChunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
489
493
  }
490
494
  interface GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
495
+ /** Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
496
+ structData?: {[P in string]: any};
491
497
  /** Title of the document. */
492
498
  title?: string;
493
499
  /** Uri of the document. */
@@ -502,7 +508,7 @@ declare namespace gapi.client {
502
508
  interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
503
509
  /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
504
510
  databaseId?: string;
505
- /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
511
+ /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
506
512
  gcsStagingDir?: string;
507
513
  /** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
508
514
  instanceId?: string;
@@ -513,18 +519,6 @@ declare namespace gapi.client {
513
519
  /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
514
520
  tableId?: string;
515
521
  }
516
- interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
517
- /** Required. The parent data store resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. */
518
- dataStore?: string;
519
- /** 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, those are returned and no tail suggestions are returned. */
520
- includeTailSuggestions?: boolean;
521
- /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
522
- query?: string;
523
- /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - 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 generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
524
- queryModel?: string;
525
- /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the 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 `INVALID_ARGUMENT` error is returned. */
526
- userPseudoId?: string;
527
- }
528
522
  interface GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse {
529
523
  /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
530
524
  querySuggestions?: GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion[];
@@ -548,7 +542,7 @@ declare namespace gapi.client {
548
542
  endTime?: string;
549
543
  /** Conversation messages. */
550
544
  messages?: GoogleCloudDiscoveryengineV1alphaConversationMessage[];
551
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
545
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
552
546
  name?: string;
553
547
  /** Output only. The time the conversation started. */
554
548
  startTime?: string;
@@ -578,8 +572,6 @@ declare namespace gapi.client {
578
572
  conversation?: GoogleCloudDiscoveryengineV1alphaConversation;
579
573
  /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
580
574
  filter?: string;
581
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
582
- name?: string;
583
575
  /** Required. Current user input. */
584
576
  query?: GoogleCloudDiscoveryengineV1alphaTextInput;
585
577
  /** Whether to turn on safe search. */
@@ -641,6 +633,19 @@ declare namespace gapi.client {
641
633
  /** Whether or not to enable and include custom fine tuned search adaptor model. */
642
634
  enableSearchAdaptor?: boolean;
643
635
  }
636
+ interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
637
+ /** Timestamp the Model was created at. */
638
+ createTime?: string;
639
+ /** The display name of the model. */
640
+ displayName?: string;
641
+ /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
642
+ modelState?: string;
643
+ modelVersion?: string;
644
+ /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
645
+ name?: string;
646
+ /** Timestamp the model training was initiated. */
647
+ trainingStartTime?: string;
648
+ }
644
649
  interface GoogleCloudDiscoveryengineV1alphaDataStore {
645
650
  /** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
646
651
  aclEnabled?: boolean;
@@ -780,7 +785,7 @@ declare namespace gapi.client {
780
785
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
781
786
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
782
787
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
783
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
788
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
784
789
  enhancedDocumentElements?: string[];
785
790
  /** If true, will use native text instead of OCR text on pages containing native text. */
786
791
  useNativeText?: boolean;
@@ -834,7 +839,7 @@ declare namespace gapi.client {
834
839
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
835
840
  /** 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 means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
836
841
  agentCreationConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
837
- /** 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 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 they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
842
+ /** 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 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 they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
838
843
  dialogflowAgentToLink?: string;
839
844
  }
840
845
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
@@ -884,7 +889,7 @@ declare namespace gapi.client {
884
889
  interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
885
890
  /** The add-on that this search engine enables. */
886
891
  searchAddOns?: string[];
887
- /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
892
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
888
893
  searchTier?: string;
889
894
  }
890
895
  interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
@@ -925,6 +930,8 @@ declare namespace gapi.client {
925
930
  interface GoogleCloudDiscoveryengineV1alphaFactChunk {
926
931
  /** Text content of the fact chunk. Can be at most 10K characters long. */
927
932
  chunkText?: string;
933
+ /** The index of this chunk. Currently, only used for the streaming mode. */
934
+ index?: number;
928
935
  /** Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. */
929
936
  source?: string;
930
937
  /** More fine-grained information for the source reference. */
@@ -945,6 +952,8 @@ declare namespace gapi.client {
945
952
  gcsStagingDir?: string;
946
953
  }
947
954
  interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
955
+ /** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
956
+ advancedSiteSearchDataSources?: string[];
948
957
  /** If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. */
949
958
  completableOption?: string;
950
959
  /** If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. */
@@ -969,7 +978,7 @@ declare namespace gapi.client {
969
978
  collectionId?: string;
970
979
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
971
980
  databaseId?: string;
972
- /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
981
+ /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
973
982
  gcsStagingDir?: string;
974
983
  /** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
975
984
  projectId?: string;
@@ -1004,20 +1013,6 @@ declare namespace gapi.client {
1004
1013
  /** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
1005
1014
  workforcePoolName?: string;
1006
1015
  }
1007
- interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
1008
- /** Operation create time. */
1009
- createTime?: string;
1010
- /** Operation last update time. If the operation is done, this is also the finish time. */
1011
- updateTime?: string;
1012
- }
1013
- interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
1014
- /** A sample of errors encountered while processing the request. */
1015
- errorSamples?: GoogleRpcStatus[];
1016
- /** Count of CompletionSuggestions that failed to be imported. */
1017
- failureCount?: string;
1018
- /** Count of CompletionSuggestions successfully imported. */
1019
- successCount?: string;
1020
- }
1021
1016
  interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
1022
1017
  /** Operation create time. */
1023
1018
  createTime?: string;
@@ -1152,6 +1147,10 @@ declare namespace gapi.client {
1152
1147
  /** Pagination token, if not returned indicates the last page. */
1153
1148
  nextPageToken?: string;
1154
1149
  }
1150
+ interface GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse {
1151
+ /** List of custom tuning models. */
1152
+ models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
1153
+ }
1155
1154
  interface GoogleCloudDiscoveryengineV1alphaListDataStoresResponse {
1156
1155
  /** All the customer's DataStores. */
1157
1156
  dataStores?: GoogleCloudDiscoveryengineV1alphaDataStore[];
@@ -1196,14 +1195,6 @@ declare namespace gapi.client {
1196
1195
  /** The total number of items matching the request. This will always be populated in the response. */
1197
1196
  totalSize?: number;
1198
1197
  }
1199
- interface GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest {
1200
- /** Required. The UUID of the Widget Config. */
1201
- widgetConfigId?: string;
1202
- }
1203
- interface GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse {
1204
- /** The Anonymous Widget Config associated with the UUID. */
1205
- anonymousWidgetConfig?: GoogleCloudDiscoveryengineV1alphaWidgetConfig;
1206
- }
1207
1198
  interface GoogleCloudDiscoveryengineV1alphaMediaInfo {
1208
1199
  /** The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. */
1209
1200
  mediaProgressDuration?: string;
@@ -1211,7 +1202,7 @@ declare namespace gapi.client {
1211
1202
  mediaProgressPercentage?: number;
1212
1203
  }
1213
1204
  interface GoogleCloudDiscoveryengineV1alphaPageInfo {
1214
- /** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1205
+ /** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1215
1206
  pageCategory?: string;
1216
1207
  /** A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. */
1217
1208
  pageviewId?: string;
@@ -1243,6 +1234,37 @@ declare namespace gapi.client {
1243
1234
  /** The JSON string representation of the processed document. */
1244
1235
  jsonData?: string;
1245
1236
  }
1237
+ interface GoogleCloudDiscoveryengineV1alphaProject {
1238
+ /** Output only. The timestamp when this project is created. */
1239
+ createTime?: string;
1240
+ /** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
1241
+ name?: string;
1242
+ /** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
1243
+ provisionCompletionTime?: string;
1244
+ /** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
1245
+ serviceTermsMap?: {
1246
+ [P in string]: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
1247
+ };
1248
+ }
1249
+ interface GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
1250
+ /** The last time when the project agreed to the terms of service. */
1251
+ acceptTime?: string;
1252
+ /** The last time when the project declined or revoked the agreement to terms of service. */
1253
+ declineTime?: string;
1254
+ /** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
1255
+ id?: string;
1256
+ /** Whether the project has accepted/rejected the service terms or it is still pending. */
1257
+ state?: string;
1258
+ /** The version string of the terms of service. For acceptable values, see the comments for id above. */
1259
+ version?: string;
1260
+ }
1261
+ interface GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {}
1262
+ interface GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest {
1263
+ /** Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms). */
1264
+ acceptDataUseTerms?: boolean;
1265
+ /** Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. */
1266
+ dataUseTermsVersion?: string;
1267
+ }
1246
1268
  interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
1247
1269
  /** Operation create time. */
1248
1270
  createTime?: string;
@@ -1331,7 +1353,7 @@ declare namespace gapi.client {
1331
1353
  model?: string;
1332
1354
  /** The query to use. */
1333
1355
  query?: string;
1334
- /** Required. A list of records to rank. At most 100 records to rank. */
1356
+ /** Required. A list of records to rank. At most 200 records to rank. */
1335
1357
  records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
1336
1358
  /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
1337
1359
  topN?: number;
@@ -1428,6 +1450,14 @@ declare namespace gapi.client {
1428
1450
  /** URI link reference. */
1429
1451
  uri?: string;
1430
1452
  }
1453
+ interface GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest {
1454
+ /** Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported. */
1455
+ consentChangeAction?: string;
1456
+ /** Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`. */
1457
+ serviceTermId?: string;
1458
+ /** Required. The version string of the terms of service to update. */
1459
+ serviceTermVersion?: string;
1460
+ }
1431
1461
  interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {}
1432
1462
  interface GoogleCloudDiscoveryengineV1alphaSchema {
1433
1463
  /** Output only. Configurations for fields of the schema. */
@@ -1470,7 +1500,7 @@ declare namespace gapi.client {
1470
1500
  imageQuery?: GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery;
1471
1501
  /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
1472
1502
  offset?: number;
1473
- /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
1503
+ /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
1474
1504
  orderBy?: string;
1475
1505
  /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
1476
1506
  pageSize?: number;
@@ -1486,8 +1516,6 @@ declare namespace gapi.client {
1486
1516
  rankingExpression?: string;
1487
1517
  /** Whether to turn on safe search. This is only supported for website search. */
1488
1518
  safeSearch?: boolean;
1489
- /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
1490
- servingConfig?: string;
1491
1519
  /** The spell correction specification that specifies the mode under which spell correction takes effect. */
1492
1520
  spellCorrectionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec;
1493
1521
  /** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
@@ -1552,7 +1580,7 @@ declare namespace gapi.client {
1552
1580
  numNextSegments?: number;
1553
1581
  /** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
1554
1582
  numPreviousSegments?: number;
1555
- /** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`. */
1583
+ /** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. */
1556
1584
  returnExtractiveSegmentScore?: boolean;
1557
1585
  }
1558
1586
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec {
@@ -1576,9 +1604,9 @@ declare namespace gapi.client {
1576
1604
  modelPromptSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
1577
1605
  /** If specified, the spec will be used to modify the model specification provided to the LLM. */
1578
1606
  modelSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
1579
- /** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */
1607
+ /** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
1580
1608
  summaryResultCount?: number;
1581
- /** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
1609
+ /** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
1582
1610
  useSemanticChunks?: boolean;
1583
1611
  }
1584
1612
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
@@ -1837,7 +1865,7 @@ declare namespace gapi.client {
1837
1865
  interface GoogleCloudDiscoveryengineV1alphaSession {
1838
1866
  /** Output only. The time the session finished. */
1839
1867
  endTime?: string;
1840
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
1868
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
1841
1869
  name?: string;
1842
1870
  /** Output only. The time the session started. */
1843
1871
  startTime?: string;
@@ -1895,6 +1923,8 @@ declare namespace gapi.client {
1895
1923
  name?: string;
1896
1924
  /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
1897
1925
  providedUriPattern?: string;
1926
+ /** Output only. Root domain of the provided_uri_pattern. */
1927
+ rootDomainUri?: string;
1898
1928
  /** Output only. Site ownership and validity verification status. */
1899
1929
  siteVerificationInfo?: GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
1900
1930
  /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -1927,6 +1957,8 @@ declare namespace gapi.client {
1927
1957
  errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
1928
1958
  /** Cloud Storage training input. */
1929
1959
  gcsTrainingInput?: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
1960
+ /** If not provided, a UUID will be generated. */
1961
+ modelId?: string;
1930
1962
  /** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
1931
1963
  modelType?: string;
1932
1964
  }
@@ -1947,6 +1979,8 @@ declare namespace gapi.client {
1947
1979
  errorSamples?: GoogleRpcStatus[];
1948
1980
  /** The metrics of the trained model. */
1949
1981
  metrics?: {[P in string]: number};
1982
+ /** Fully qualified name of the CustomTuningModel. */
1983
+ modelName?: string;
1950
1984
  /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
1951
1985
  modelStatus?: string;
1952
1986
  }
@@ -2028,158 +2062,6 @@ declare namespace gapi.client {
2028
2062
  /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2029
2063
  userId?: string;
2030
2064
  }
2031
- interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest {
2032
- /** Additional params for security and privacy enhancement. */
2033
- additionalParams?: GoogleCloudDiscoveryengineV1alphaAdditionalParams;
2034
- /** Required. The CompleteQuery request to perform auto-complete suggestion query. */
2035
- completeQueryRequest?: GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest;
2036
- /** Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query. */
2037
- configId?: string;
2038
- }
2039
- interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse {
2040
- /** The token in response. */
2041
- uToken?: string;
2042
- /** Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion. */
2043
- widgetQuerySuggestions?: GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion[];
2044
- }
2045
- interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion {
2046
- /** The suggestion for the query. */
2047
- suggestion?: string;
2048
- }
2049
- interface GoogleCloudDiscoveryengineV1alphaWidgetConfig {
2050
- /** Allowlisted domains that can load this widget. */
2051
- allowlistedDomains?: string[];
2052
- /** Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. */
2053
- allowPublicAccess?: boolean;
2054
- /** Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. */
2055
- collectionComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
2056
- /** Output only. Unique obfuscated identifier of a WidgetConfig. */
2057
- configId?: string;
2058
- /** The content search spec that configs the desired behavior of content search. */
2059
- contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
2060
- /** Output only. Timestamp the WidgetConfig was created. */
2061
- createTime?: string;
2062
- /** Output only. The type of the parent data store. */
2063
- dataStoreType?: string;
2064
- /** Configurable UI configurations per data store. */
2065
- dataStoreUiConfigs?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[];
2066
- /** Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
2067
- displayName?: string;
2068
- /** Whether or not to enable autocomplete. */
2069
- enableAutocomplete?: boolean;
2070
- /** Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). */
2071
- enableConversationalSearch?: boolean;
2072
- /** Turn on or off collecting the search result quality feedback from end users. */
2073
- enableQualityFeedback?: boolean;
2074
- /** Whether to show the result score. */
2075
- enableResultScore?: boolean;
2076
- /** Whether to enable safe search. */
2077
- enableSafeSearch?: boolean;
2078
- /** Whether to enable search-as-you-type behavior for the search widget */
2079
- enableSearchAsYouType?: boolean;
2080
- /** Turn on or off summary for each snippets result. */
2081
- enableSnippetResultSummary?: boolean;
2082
- /** Turn on or off summarization for the search response. */
2083
- enableSummarization?: boolean;
2084
- /** Whether to enable standalone web app. */
2085
- enableWebApp?: boolean;
2086
- /** The configuration and appearance of facets in the end user view. */
2087
- facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
2088
- /** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
2089
- fieldsUiComponentsMap?: {
2090
- [P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
2091
- };
2092
- /** Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. */
2093
- industryVertical?: string;
2094
- /** Output only. Whether LLM is enabled in the corresponding data store. */
2095
- llmEnabled?: boolean;
2096
- /** Output only. Whether the customer accepted data use terms. */
2097
- minimumDataTermAccepted?: boolean;
2098
- /** Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
2099
- name?: string;
2100
- /** The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. */
2101
- resultDisplayType?: string;
2102
- /** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
2103
- solutionType?: string;
2104
- /** Output only. Timestamp the WidgetConfig was updated. */
2105
- updateTime?: string;
2106
- }
2107
- interface GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
2108
- /** For the data store collection, list of the children data stores. */
2109
- dataStoreComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
2110
- /** The display name of the collection. */
2111
- displayName?: string;
2112
- /** Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. */
2113
- id?: string;
2114
- /** The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
2115
- name?: string;
2116
- }
2117
- interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
2118
- /** The display name of the data store. */
2119
- displayName?: string;
2120
- /** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
2121
- id?: string;
2122
- /** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
2123
- name?: string;
2124
- }
2125
- interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
2126
- /** Facet fields that store the mapping of fields to end user widget appearance. */
2127
- facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
2128
- /** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
2129
- fieldsUiComponentsMap?: {
2130
- [P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
2131
- };
2132
- /** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
2133
- id?: string;
2134
- /** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
2135
- name?: string;
2136
- }
2137
- interface GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
2138
- /** Optional. The field name that end users will see. */
2139
- displayName?: string;
2140
- /** Required. Registered field name. The format is `field.abc`. */
2141
- field?: string;
2142
- }
2143
- interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
2144
- /** The field visibility on different types of devices. */
2145
- deviceVisibility?: string[];
2146
- /** The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". */
2147
- displayTemplate?: string;
2148
- /** Required. Registered field name. The format is `field.abc`. */
2149
- field?: string;
2150
- }
2151
- interface GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest {
2152
- /** Additional params for security and privacy enhancement. */
2153
- additionalParams?: GoogleCloudDiscoveryengineV1alphaAdditionalParams;
2154
- /** Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the user event collection. */
2155
- configId?: string;
2156
- /** The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
2157
- conversationId?: string;
2158
- /** Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default. */
2159
- converseConversationRequest?: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
2160
- }
2161
- interface GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse {
2162
- /** The id of the Conversation returned. */
2163
- conversationId?: string;
2164
- /** ConverseConversationResponse returned from ConversationalSearchService.ConverseConversation. */
2165
- converseConversationResponse?: GoogleCloudDiscoveryengineV1alphaConverseConversationResponse;
2166
- /** The token in response. */
2167
- uToken?: string;
2168
- }
2169
- interface GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest {
2170
- /** Additional params for security and privacy enhancement. */
2171
- additionalParams?: GoogleCloudDiscoveryengineV1alphaAdditionalParams;
2172
- /** Required. The UUID of the Search WidgetConfig. This field is used to identify the search widget configuration, set of models used to make the search. */
2173
- configId?: string;
2174
- /** Required. The search request to perform search. */
2175
- searchRequest?: GoogleCloudDiscoveryengineV1alphaSearchRequest;
2176
- }
2177
- interface GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse {
2178
- /** The search response after performing search. */
2179
- searchResponse?: GoogleCloudDiscoveryengineV1alphaSearchResponse;
2180
- /** The token in response. */
2181
- uToken?: string;
2182
- }
2183
2065
  interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
2184
2066
  /** Operation create time. */
2185
2067
  createTime?: string;
@@ -2224,6 +2106,19 @@ declare namespace gapi.client {
2224
2106
  /** Operation last update time. If the operation is done, this is also the finish time. */
2225
2107
  updateTime?: string;
2226
2108
  }
2109
+ interface GoogleCloudDiscoveryengineV1betaCustomTuningModel {
2110
+ /** Timestamp the Model was created at. */
2111
+ createTime?: string;
2112
+ /** The display name of the model. */
2113
+ displayName?: string;
2114
+ /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
2115
+ modelState?: string;
2116
+ modelVersion?: string;
2117
+ /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
2118
+ name?: string;
2119
+ /** Timestamp the model training was initiated. */
2120
+ trainingStartTime?: string;
2121
+ }
2227
2122
  interface GoogleCloudDiscoveryengineV1betaDataStore {
2228
2123
  /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
2229
2124
  contentConfig?: string;
@@ -2293,7 +2188,7 @@ declare namespace gapi.client {
2293
2188
  }
2294
2189
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
2295
2190
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
2296
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
2191
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
2297
2192
  enhancedDocumentElements?: string[];
2298
2193
  /** If true, will use native text instead of OCR text on pages containing native text. */
2299
2194
  useNativeText?: boolean;
@@ -2332,7 +2227,7 @@ declare namespace gapi.client {
2332
2227
  interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
2333
2228
  /** 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 means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
2334
2229
  agentCreationConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
2335
- /** 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 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 they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
2230
+ /** 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 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 they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
2336
2231
  dialogflowAgentToLink?: string;
2337
2232
  }
2338
2233
  interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
@@ -2356,7 +2251,7 @@ declare namespace gapi.client {
2356
2251
  interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
2357
2252
  /** The add-on that this search engine enables. */
2358
2253
  searchAddOns?: string[];
2359
- /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
2254
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
2360
2255
  searchTier?: string;
2361
2256
  }
2362
2257
  interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
@@ -2415,6 +2310,10 @@ declare namespace gapi.client {
2415
2310
  /** Count of user events imported, but with Document information not found in the existing Branch. */
2416
2311
  unjoinedEventsCount?: string;
2417
2312
  }
2313
+ interface GoogleCloudDiscoveryengineV1betaListCustomModelsResponse {
2314
+ /** List of custom tuning models. */
2315
+ models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
2316
+ }
2418
2317
  interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
2419
2318
  /** Operation create time. */
2420
2319
  createTime?: string;
@@ -2472,6 +2371,8 @@ declare namespace gapi.client {
2472
2371
  name?: string;
2473
2372
  /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
2474
2373
  providedUriPattern?: string;
2374
+ /** Output only. Root domain of the provided_uri_pattern. */
2375
+ rootDomainUri?: string;
2475
2376
  /** Output only. Site ownership and validity verification status. */
2476
2377
  siteVerificationInfo?: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
2477
2378
  /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -2500,6 +2401,8 @@ declare namespace gapi.client {
2500
2401
  errorSamples?: GoogleRpcStatus[];
2501
2402
  /** The metrics of the trained model. */
2502
2403
  metrics?: {[P in string]: number};
2404
+ /** Fully qualified name of the CustomTuningModel. */
2405
+ modelName?: string;
2503
2406
  /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
2504
2407
  modelStatus?: string;
2505
2408
  }
@@ -2507,6 +2410,7 @@ declare namespace gapi.client {
2507
2410
  /** 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}` */
2508
2411
  engine?: string;
2509
2412
  }
2413
+ interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
2510
2414
  interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
2511
2415
  /** Operation create time. */
2512
2416
  createTime?: string;
@@ -2612,7 +2516,7 @@ declare namespace gapi.client {
2612
2516
  }
2613
2517
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
2614
2518
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
2615
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
2519
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
2616
2520
  enhancedDocumentElements?: string[];
2617
2521
  /** If true, will use native text instead of OCR text on pages containing native text. */
2618
2522
  useNativeText?: boolean;
@@ -2651,7 +2555,7 @@ declare namespace gapi.client {
2651
2555
  interface GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
2652
2556
  /** 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 means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
2653
2557
  agentCreationConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
2654
- /** 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 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 they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
2558
+ /** 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 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 they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
2655
2559
  dialogflowAgentToLink?: string;
2656
2560
  }
2657
2561
  interface GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
@@ -2675,7 +2579,7 @@ declare namespace gapi.client {
2675
2579
  interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
2676
2580
  /** The add-on that this search engine enables. */
2677
2581
  searchAddOns?: string[];
2678
- /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
2582
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
2679
2583
  searchTier?: string;
2680
2584
  }
2681
2585
  interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
@@ -2791,6 +2695,8 @@ declare namespace gapi.client {
2791
2695
  name?: string;
2792
2696
  /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
2793
2697
  providedUriPattern?: string;
2698
+ /** Output only. Root domain of the provided_uri_pattern. */
2699
+ rootDomainUri?: string;
2794
2700
  /** Output only. Site ownership and validity verification status. */
2795
2701
  siteVerificationInfo?: GoogleCloudDiscoveryengineV1SiteVerificationInfo;
2796
2702
  /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -2853,240 +2759,6 @@ declare namespace gapi.client {
2853
2759
  /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
2854
2760
  year?: number;
2855
2761
  }
2856
- interface LocationsResource {
2857
- /** Gets the Widget Config using the uuid. */
2858
- lookupWidgetConfig(request: {
2859
- /** V1 error format. */
2860
- '$.xgafv'?: string;
2861
- /** OAuth access token. */
2862
- access_token?: string;
2863
- /** Data format for response. */
2864
- alt?: string;
2865
- /** JSONP */
2866
- callback?: string;
2867
- /** Selector specifying which fields to include in a partial response. */
2868
- fields?: string;
2869
- /** 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. */
2870
- key?: string;
2871
- /** Required. The location resource where lookup widget will be performed. Format: `locations/{location}` */
2872
- location: string;
2873
- /** OAuth 2.0 token for the current user. */
2874
- oauth_token?: string;
2875
- /** Returns response with indentations and line breaks. */
2876
- prettyPrint?: boolean;
2877
- /** 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. */
2878
- quotaUser?: string;
2879
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2880
- upload_protocol?: string;
2881
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2882
- uploadType?: string;
2883
- /** Request body */
2884
- resource: GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest;
2885
- }): Request<GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
2886
- lookupWidgetConfig(
2887
- request: {
2888
- /** V1 error format. */
2889
- '$.xgafv'?: string;
2890
- /** OAuth access token. */
2891
- access_token?: string;
2892
- /** Data format for response. */
2893
- alt?: string;
2894
- /** JSONP */
2895
- callback?: string;
2896
- /** Selector specifying which fields to include in a partial response. */
2897
- fields?: string;
2898
- /** 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. */
2899
- key?: string;
2900
- /** Required. The location resource where lookup widget will be performed. Format: `locations/{location}` */
2901
- location: string;
2902
- /** OAuth 2.0 token for the current user. */
2903
- oauth_token?: string;
2904
- /** Returns response with indentations and line breaks. */
2905
- prettyPrint?: boolean;
2906
- /** 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. */
2907
- quotaUser?: string;
2908
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2909
- upload_protocol?: string;
2910
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2911
- uploadType?: string;
2912
- },
2913
- body: GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest
2914
- ): Request<GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
2915
- /** Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It supports CompleteQuery with or without JWT token. */
2916
- widgetCompleteQuery(request: {
2917
- /** V1 error format. */
2918
- '$.xgafv'?: string;
2919
- /** OAuth access token. */
2920
- access_token?: string;
2921
- /** Data format for response. */
2922
- alt?: string;
2923
- /** JSONP */
2924
- callback?: string;
2925
- /** Selector specifying which fields to include in a partial response. */
2926
- fields?: string;
2927
- /** 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. */
2928
- key?: string;
2929
- /** Required. The location resource where widget complete query will be performed. Format: `locations/{location}` */
2930
- location: string;
2931
- /** OAuth 2.0 token for the current user. */
2932
- oauth_token?: string;
2933
- /** Returns response with indentations and line breaks. */
2934
- prettyPrint?: boolean;
2935
- /** 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. */
2936
- quotaUser?: string;
2937
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2938
- upload_protocol?: string;
2939
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2940
- uploadType?: string;
2941
- /** Request body */
2942
- resource: GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
2943
- }): Request<GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
2944
- widgetCompleteQuery(
2945
- request: {
2946
- /** V1 error format. */
2947
- '$.xgafv'?: string;
2948
- /** OAuth access token. */
2949
- access_token?: string;
2950
- /** Data format for response. */
2951
- alt?: string;
2952
- /** JSONP */
2953
- callback?: string;
2954
- /** Selector specifying which fields to include in a partial response. */
2955
- fields?: string;
2956
- /** 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. */
2957
- key?: string;
2958
- /** Required. The location resource where widget complete query will be performed. Format: `locations/{location}` */
2959
- location: string;
2960
- /** OAuth 2.0 token for the current user. */
2961
- oauth_token?: string;
2962
- /** Returns response with indentations and line breaks. */
2963
- prettyPrint?: boolean;
2964
- /** 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. */
2965
- quotaUser?: string;
2966
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2967
- upload_protocol?: string;
2968
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2969
- uploadType?: string;
2970
- },
2971
- body: GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest
2972
- ): Request<GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
2973
- /** Converse a conversation with Widget. */
2974
- widgetConverseConversation(request: {
2975
- /** V1 error format. */
2976
- '$.xgafv'?: string;
2977
- /** OAuth access token. */
2978
- access_token?: string;
2979
- /** Data format for response. */
2980
- alt?: string;
2981
- /** JSONP */
2982
- callback?: string;
2983
- /** Selector specifying which fields to include in a partial response. */
2984
- fields?: string;
2985
- /** 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. */
2986
- key?: string;
2987
- /** Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}` */
2988
- location: string;
2989
- /** OAuth 2.0 token for the current user. */
2990
- oauth_token?: string;
2991
- /** Returns response with indentations and line breaks. */
2992
- prettyPrint?: boolean;
2993
- /** 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. */
2994
- quotaUser?: string;
2995
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2996
- upload_protocol?: string;
2997
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2998
- uploadType?: string;
2999
- /** Request body */
3000
- resource: GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
3001
- }): Request<GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
3002
- widgetConverseConversation(
3003
- request: {
3004
- /** V1 error format. */
3005
- '$.xgafv'?: string;
3006
- /** OAuth access token. */
3007
- access_token?: string;
3008
- /** Data format for response. */
3009
- alt?: string;
3010
- /** JSONP */
3011
- callback?: string;
3012
- /** Selector specifying which fields to include in a partial response. */
3013
- fields?: string;
3014
- /** 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. */
3015
- key?: string;
3016
- /** Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}` */
3017
- location: string;
3018
- /** OAuth 2.0 token for the current user. */
3019
- oauth_token?: string;
3020
- /** Returns response with indentations and line breaks. */
3021
- prettyPrint?: boolean;
3022
- /** 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. */
3023
- quotaUser?: string;
3024
- /** Upload protocol for media (e.g. "raw", "multipart"). */
3025
- upload_protocol?: string;
3026
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3027
- uploadType?: string;
3028
- },
3029
- body: GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest
3030
- ): Request<GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
3031
- /** Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token. */
3032
- widgetSearch(request: {
3033
- /** V1 error format. */
3034
- '$.xgafv'?: string;
3035
- /** OAuth access token. */
3036
- access_token?: string;
3037
- /** Data format for response. */
3038
- alt?: string;
3039
- /** JSONP */
3040
- callback?: string;
3041
- /** Selector specifying which fields to include in a partial response. */
3042
- fields?: string;
3043
- /** 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. */
3044
- key?: string;
3045
- /** Required. The location resource where widget search will be performed. Format: `locations/{location}` */
3046
- location: string;
3047
- /** OAuth 2.0 token for the current user. */
3048
- oauth_token?: string;
3049
- /** Returns response with indentations and line breaks. */
3050
- prettyPrint?: boolean;
3051
- /** 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. */
3052
- quotaUser?: string;
3053
- /** Upload protocol for media (e.g. "raw", "multipart"). */
3054
- upload_protocol?: string;
3055
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3056
- uploadType?: string;
3057
- /** Request body */
3058
- resource: GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
3059
- }): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
3060
- widgetSearch(
3061
- request: {
3062
- /** V1 error format. */
3063
- '$.xgafv'?: string;
3064
- /** OAuth access token. */
3065
- access_token?: string;
3066
- /** Data format for response. */
3067
- alt?: string;
3068
- /** JSONP */
3069
- callback?: string;
3070
- /** Selector specifying which fields to include in a partial response. */
3071
- fields?: string;
3072
- /** 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. */
3073
- key?: string;
3074
- /** Required. The location resource where widget search will be performed. Format: `locations/{location}` */
3075
- location: string;
3076
- /** OAuth 2.0 token for the current user. */
3077
- oauth_token?: string;
3078
- /** Returns response with indentations and line breaks. */
3079
- prettyPrint?: boolean;
3080
- /** 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. */
3081
- quotaUser?: string;
3082
- /** Upload protocol for media (e.g. "raw", "multipart"). */
3083
- upload_protocol?: string;
3084
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3085
- uploadType?: string;
3086
- },
3087
- body: GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest
3088
- ): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
3089
- }
3090
2762
  interface OperationsResource {
3091
2763
  /** 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. */
3092
2764
  get(request?: {
@@ -3861,7 +3533,7 @@ declare namespace gapi.client {
3861
3533
  fields?: string;
3862
3534
  /** 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. */
3863
3535
  key?: string;
3864
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3536
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3865
3537
  name: string;
3866
3538
  /** OAuth 2.0 token for the current user. */
3867
3539
  oauth_token?: string;
@@ -3892,7 +3564,7 @@ declare namespace gapi.client {
3892
3564
  fields?: string;
3893
3565
  /** 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. */
3894
3566
  key?: string;
3895
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3567
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3896
3568
  name: string;
3897
3569
  /** OAuth 2.0 token for the current user. */
3898
3570
  oauth_token?: string;
@@ -3910,6 +3582,35 @@ declare namespace gapi.client {
3910
3582
  body: GoogleCloudDiscoveryengineV1alphaConversation
3911
3583
  ): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
3912
3584
  }
3585
+ interface CustomModelsResource {
3586
+ /** Gets a list of all the custom models. */
3587
+ list(request?: {
3588
+ /** V1 error format. */
3589
+ '$.xgafv'?: string;
3590
+ /** OAuth access token. */
3591
+ access_token?: string;
3592
+ /** Data format for response. */
3593
+ alt?: string;
3594
+ /** JSONP */
3595
+ callback?: string;
3596
+ /** Required. The resource name of the parent Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. */
3597
+ dataStore: string;
3598
+ /** Selector specifying which fields to include in a partial response. */
3599
+ fields?: string;
3600
+ /** 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. */
3601
+ key?: string;
3602
+ /** OAuth 2.0 token for the current user. */
3603
+ oauth_token?: string;
3604
+ /** Returns response with indentations and line breaks. */
3605
+ prettyPrint?: boolean;
3606
+ /** 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. */
3607
+ quotaUser?: string;
3608
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3609
+ upload_protocol?: string;
3610
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3611
+ uploadType?: string;
3612
+ }): Request<GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse>;
3613
+ }
3913
3614
  interface OperationsResource {
3914
3615
  /** 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. */
3915
3616
  get(request?: {
@@ -4798,7 +4499,7 @@ declare namespace gapi.client {
4798
4499
  fields?: string;
4799
4500
  /** 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. */
4800
4501
  key?: string;
4801
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4502
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4802
4503
  name: string;
4803
4504
  /** OAuth 2.0 token for the current user. */
4804
4505
  oauth_token?: string;
@@ -4829,7 +4530,7 @@ declare namespace gapi.client {
4829
4530
  fields?: string;
4830
4531
  /** 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. */
4831
4532
  key?: string;
4832
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4533
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4833
4534
  name: string;
4834
4535
  /** OAuth 2.0 token for the current user. */
4835
4536
  oauth_token?: string;
@@ -5785,7 +5486,7 @@ declare namespace gapi.client {
5785
5486
  key?: string;
5786
5487
  /** OAuth 2.0 token for the current user. */
5787
5488
  oauth_token?: string;
5788
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
5489
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
5789
5490
  parent: string;
5790
5491
  /** Returns response with indentations and line breaks. */
5791
5492
  prettyPrint?: boolean;
@@ -5814,7 +5515,7 @@ declare namespace gapi.client {
5814
5515
  key?: string;
5815
5516
  /** OAuth 2.0 token for the current user. */
5816
5517
  oauth_token?: string;
5817
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
5518
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
5818
5519
  parent: string;
5819
5520
  /** Returns response with indentations and line breaks. */
5820
5521
  prettyPrint?: boolean;
@@ -6050,7 +5751,7 @@ declare namespace gapi.client {
6050
5751
  callback?: string;
6051
5752
  /** Selector specifying which fields to include in a partial response. */
6052
5753
  fields?: string;
6053
- /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
5754
+ /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
6054
5755
  filter?: string;
6055
5756
  /** 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. */
6056
5757
  key?: string;
@@ -6255,6 +5956,7 @@ declare namespace gapi.client {
6255
5956
  ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
6256
5957
  branches: BranchesResource;
6257
5958
  conversations: ConversationsResource;
5959
+ customModels: CustomModelsResource;
6258
5960
  models: ModelsResource;
6259
5961
  operations: OperationsResource;
6260
5962
  schemas: SchemasResource;
@@ -6484,7 +6186,7 @@ declare namespace gapi.client {
6484
6186
  fields?: string;
6485
6187
  /** 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. */
6486
6188
  key?: string;
6487
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6189
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6488
6190
  name: string;
6489
6191
  /** OAuth 2.0 token for the current user. */
6490
6192
  oauth_token?: string;
@@ -6515,7 +6217,7 @@ declare namespace gapi.client {
6515
6217
  fields?: string;
6516
6218
  /** 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. */
6517
6219
  key?: string;
6518
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6220
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6519
6221
  name: string;
6520
6222
  /** OAuth 2.0 token for the current user. */
6521
6223
  oauth_token?: string;
@@ -7082,7 +6784,7 @@ declare namespace gapi.client {
7082
6784
  fields?: string;
7083
6785
  /** 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. */
7084
6786
  key?: string;
7085
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
6787
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
7086
6788
  name: string;
7087
6789
  /** OAuth 2.0 token for the current user. */
7088
6790
  oauth_token?: string;
@@ -7113,7 +6815,7 @@ declare namespace gapi.client {
7113
6815
  fields?: string;
7114
6816
  /** 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. */
7115
6817
  key?: string;
7116
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
6818
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
7117
6819
  name: string;
7118
6820
  /** OAuth 2.0 token for the current user. */
7119
6821
  oauth_token?: string;
@@ -8300,7 +8002,7 @@ declare namespace gapi.client {
8300
8002
  fields?: string;
8301
8003
  /** 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. */
8302
8004
  key?: string;
8303
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
8005
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
8304
8006
  name: string;
8305
8007
  /** OAuth 2.0 token for the current user. */
8306
8008
  oauth_token?: string;
@@ -8331,7 +8033,7 @@ declare namespace gapi.client {
8331
8033
  fields?: string;
8332
8034
  /** 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. */
8333
8035
  key?: string;
8334
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
8036
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
8335
8037
  name: string;
8336
8038
  /** OAuth 2.0 token for the current user. */
8337
8039
  oauth_token?: string;
@@ -9174,7 +8876,7 @@ declare namespace gapi.client {
9174
8876
  fields?: string;
9175
8877
  /** 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. */
9176
8878
  key?: string;
9177
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
8879
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
9178
8880
  name: string;
9179
8881
  /** OAuth 2.0 token for the current user. */
9180
8882
  oauth_token?: string;
@@ -9205,7 +8907,7 @@ declare namespace gapi.client {
9205
8907
  fields?: string;
9206
8908
  /** 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. */
9207
8909
  key?: string;
9208
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
8910
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
9209
8911
  name: string;
9210
8912
  /** OAuth 2.0 token for the current user. */
9211
8913
  oauth_token?: string;
@@ -9946,7 +9648,7 @@ declare namespace gapi.client {
9946
9648
  key?: string;
9947
9649
  /** OAuth 2.0 token for the current user. */
9948
9650
  oauth_token?: string;
9949
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
9651
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
9950
9652
  parent: string;
9951
9653
  /** Returns response with indentations and line breaks. */
9952
9654
  prettyPrint?: boolean;
@@ -9975,7 +9677,7 @@ declare namespace gapi.client {
9975
9677
  key?: string;
9976
9678
  /** OAuth 2.0 token for the current user. */
9977
9679
  oauth_token?: string;
9978
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
9680
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
9979
9681
  parent: string;
9980
9682
  /** Returns response with indentations and line breaks. */
9981
9683
  prettyPrint?: boolean;
@@ -10211,7 +9913,7 @@ declare namespace gapi.client {
10211
9913
  callback?: string;
10212
9914
  /** Selector specifying which fields to include in a partial response. */
10213
9915
  fields?: string;
10214
- /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
9916
+ /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
10215
9917
  filter?: string;
10216
9918
  /** 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. */
10217
9919
  key?: string;
@@ -10581,6 +10283,98 @@ declare namespace gapi.client {
10581
10283
  body: GoogleCloudDiscoveryengineV1alphaRankRequest
10582
10284
  ): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
10583
10285
  }
10286
+ interface OperationsResource {
10287
+ /** 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. */
10288
+ get(request?: {
10289
+ /** V1 error format. */
10290
+ '$.xgafv'?: string;
10291
+ /** OAuth access token. */
10292
+ access_token?: string;
10293
+ /** Data format for response. */
10294
+ alt?: string;
10295
+ /** JSONP */
10296
+ callback?: string;
10297
+ /** Selector specifying which fields to include in a partial response. */
10298
+ fields?: string;
10299
+ /** 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. */
10300
+ key?: string;
10301
+ /** The name of the operation resource. */
10302
+ name: string;
10303
+ /** OAuth 2.0 token for the current user. */
10304
+ oauth_token?: string;
10305
+ /** Returns response with indentations and line breaks. */
10306
+ prettyPrint?: boolean;
10307
+ /** 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. */
10308
+ quotaUser?: string;
10309
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10310
+ upload_protocol?: string;
10311
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10312
+ uploadType?: string;
10313
+ }): Request<GoogleLongrunningOperation>;
10314
+ }
10315
+ interface SampleQuerySetsResource {
10316
+ operations: OperationsResource;
10317
+ }
10318
+ interface UserEventsResource {
10319
+ /** Writes a single user event. */
10320
+ write(request: {
10321
+ /** V1 error format. */
10322
+ '$.xgafv'?: string;
10323
+ /** OAuth access token. */
10324
+ access_token?: string;
10325
+ /** Data format for response. */
10326
+ alt?: string;
10327
+ /** JSONP */
10328
+ callback?: string;
10329
+ /** Selector specifying which fields to include in a partial response. */
10330
+ fields?: string;
10331
+ /** 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. */
10332
+ key?: string;
10333
+ /** OAuth 2.0 token for the current user. */
10334
+ oauth_token?: string;
10335
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
10336
+ parent: string;
10337
+ /** Returns response with indentations and line breaks. */
10338
+ prettyPrint?: boolean;
10339
+ /** 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. */
10340
+ quotaUser?: string;
10341
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10342
+ upload_protocol?: string;
10343
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10344
+ uploadType?: string;
10345
+ /** Request body */
10346
+ resource: GoogleCloudDiscoveryengineV1alphaUserEvent;
10347
+ }): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
10348
+ write(
10349
+ request: {
10350
+ /** V1 error format. */
10351
+ '$.xgafv'?: string;
10352
+ /** OAuth access token. */
10353
+ access_token?: string;
10354
+ /** Data format for response. */
10355
+ alt?: string;
10356
+ /** JSONP */
10357
+ callback?: string;
10358
+ /** Selector specifying which fields to include in a partial response. */
10359
+ fields?: string;
10360
+ /** 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. */
10361
+ key?: string;
10362
+ /** OAuth 2.0 token for the current user. */
10363
+ oauth_token?: string;
10364
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
10365
+ parent: string;
10366
+ /** Returns response with indentations and line breaks. */
10367
+ prettyPrint?: boolean;
10368
+ /** 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. */
10369
+ quotaUser?: string;
10370
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10371
+ upload_protocol?: string;
10372
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10373
+ uploadType?: string;
10374
+ },
10375
+ body: GoogleCloudDiscoveryengineV1alphaUserEvent
10376
+ ): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
10377
+ }
10584
10378
  interface LocationsResource {
10585
10379
  /** Estimates the data size to be used by a customer. */
10586
10380
  estimateDataSize(request: {
@@ -10731,6 +10525,8 @@ declare namespace gapi.client {
10731
10525
  groundingConfigs: GroundingConfigsResource;
10732
10526
  operations: OperationsResource;
10733
10527
  rankingConfigs: RankingConfigsResource;
10528
+ sampleQuerySets: SampleQuerySetsResource;
10529
+ userEvents: UserEventsResource;
10734
10530
  }
10735
10531
  interface OperationsResource {
10736
10532
  /** 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. */
@@ -10795,12 +10591,153 @@ declare namespace gapi.client {
10795
10591
  }): Request<GoogleLongrunningListOperationsResponse>;
10796
10592
  }
10797
10593
  interface ProjectsResource {
10594
+ /** Gets a Project. Returns NOT_FOUND when the project is not yet created. */
10595
+ get(request?: {
10596
+ /** V1 error format. */
10597
+ '$.xgafv'?: string;
10598
+ /** OAuth access token. */
10599
+ access_token?: string;
10600
+ /** Data format for response. */
10601
+ alt?: string;
10602
+ /** JSONP */
10603
+ callback?: string;
10604
+ /** Selector specifying which fields to include in a partial response. */
10605
+ fields?: string;
10606
+ /** 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. */
10607
+ key?: string;
10608
+ /** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
10609
+ name: string;
10610
+ /** OAuth 2.0 token for the current user. */
10611
+ oauth_token?: string;
10612
+ /** Returns response with indentations and line breaks. */
10613
+ prettyPrint?: boolean;
10614
+ /** 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. */
10615
+ quotaUser?: string;
10616
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10617
+ upload_protocol?: string;
10618
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10619
+ uploadType?: string;
10620
+ }): Request<GoogleCloudDiscoveryengineV1alphaProject>;
10621
+ /** Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. */
10622
+ provision(request: {
10623
+ /** V1 error format. */
10624
+ '$.xgafv'?: string;
10625
+ /** OAuth access token. */
10626
+ access_token?: string;
10627
+ /** Data format for response. */
10628
+ alt?: string;
10629
+ /** JSONP */
10630
+ callback?: string;
10631
+ /** Selector specifying which fields to include in a partial response. */
10632
+ fields?: string;
10633
+ /** 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. */
10634
+ key?: string;
10635
+ /** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
10636
+ name: string;
10637
+ /** OAuth 2.0 token for the current user. */
10638
+ oauth_token?: string;
10639
+ /** Returns response with indentations and line breaks. */
10640
+ prettyPrint?: boolean;
10641
+ /** 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. */
10642
+ quotaUser?: string;
10643
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10644
+ upload_protocol?: string;
10645
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10646
+ uploadType?: string;
10647
+ /** Request body */
10648
+ resource: GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
10649
+ }): Request<GoogleLongrunningOperation>;
10650
+ provision(
10651
+ request: {
10652
+ /** V1 error format. */
10653
+ '$.xgafv'?: string;
10654
+ /** OAuth access token. */
10655
+ access_token?: string;
10656
+ /** Data format for response. */
10657
+ alt?: string;
10658
+ /** JSONP */
10659
+ callback?: string;
10660
+ /** Selector specifying which fields to include in a partial response. */
10661
+ fields?: string;
10662
+ /** 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. */
10663
+ key?: string;
10664
+ /** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
10665
+ name: string;
10666
+ /** OAuth 2.0 token for the current user. */
10667
+ oauth_token?: string;
10668
+ /** Returns response with indentations and line breaks. */
10669
+ prettyPrint?: boolean;
10670
+ /** 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. */
10671
+ quotaUser?: string;
10672
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10673
+ upload_protocol?: string;
10674
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10675
+ uploadType?: string;
10676
+ },
10677
+ body: GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest
10678
+ ): Request<GoogleLongrunningOperation>;
10679
+ /** Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms) */
10680
+ reportConsentChange(request: {
10681
+ /** V1 error format. */
10682
+ '$.xgafv'?: string;
10683
+ /** OAuth access token. */
10684
+ access_token?: string;
10685
+ /** Data format for response. */
10686
+ alt?: string;
10687
+ /** JSONP */
10688
+ callback?: string;
10689
+ /** Selector specifying which fields to include in a partial response. */
10690
+ fields?: string;
10691
+ /** 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. */
10692
+ key?: string;
10693
+ /** OAuth 2.0 token for the current user. */
10694
+ oauth_token?: string;
10695
+ /** Returns response with indentations and line breaks. */
10696
+ prettyPrint?: boolean;
10697
+ /** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
10698
+ project: string;
10699
+ /** 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. */
10700
+ quotaUser?: string;
10701
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10702
+ upload_protocol?: string;
10703
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10704
+ uploadType?: string;
10705
+ /** Request body */
10706
+ resource: GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest;
10707
+ }): Request<GoogleCloudDiscoveryengineV1alphaProject>;
10708
+ reportConsentChange(
10709
+ request: {
10710
+ /** V1 error format. */
10711
+ '$.xgafv'?: string;
10712
+ /** OAuth access token. */
10713
+ access_token?: string;
10714
+ /** Data format for response. */
10715
+ alt?: string;
10716
+ /** JSONP */
10717
+ callback?: string;
10718
+ /** Selector specifying which fields to include in a partial response. */
10719
+ fields?: string;
10720
+ /** 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. */
10721
+ key?: string;
10722
+ /** OAuth 2.0 token for the current user. */
10723
+ oauth_token?: string;
10724
+ /** Returns response with indentations and line breaks. */
10725
+ prettyPrint?: boolean;
10726
+ /** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
10727
+ project: string;
10728
+ /** 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. */
10729
+ quotaUser?: string;
10730
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10731
+ upload_protocol?: string;
10732
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10733
+ uploadType?: string;
10734
+ },
10735
+ body: GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest
10736
+ ): Request<GoogleCloudDiscoveryengineV1alphaProject>;
10798
10737
  locations: LocationsResource;
10799
10738
  operations: OperationsResource;
10800
10739
  }
10801
10740
 
10802
- const locations: LocationsResource;
10803
-
10804
10741
  const projects: ProjectsResource;
10805
10742
  }
10806
10743
  }