@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20231209 → 0.0.20240108

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +557 -30
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20231209
12
+ // Revision: 20240108
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -308,7 +308,7 @@ declare namespace gapi.client {
308
308
  mimeType?: string;
309
309
  /** The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. */
310
310
  rawBytes?: string;
311
- /** The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 100 MB. */
311
+ /** The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 100 MB for other formats. */
312
312
  uri?: string;
313
313
  }
314
314
  interface GoogleCloudDiscoveryengineV1alphaDocumentInfo {
@@ -323,6 +323,12 @@ declare namespace gapi.client {
323
323
  /** The Document URI - only allowed for website data stores. */
324
324
  uri?: string;
325
325
  }
326
+ interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
327
+ /** Output only. The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
328
+ name?: string;
329
+ /** The OCR config. Currently it only applies to PDFs. */
330
+ ocrConfig?: GoogleCloudDiscoveryengineV1alphaOcrConfig;
331
+ }
326
332
  interface GoogleCloudDiscoveryengineV1alphaDoubleList {
327
333
  /** Double values. */
328
334
  values?: number[];
@@ -368,7 +374,7 @@ declare namespace gapi.client {
368
374
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
369
375
  /** 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. */
370
376
  agentCreationConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
371
- /** 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 chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created. */
377
+ /** 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. */
372
378
  dialogflowAgentToLink?: string;
373
379
  }
374
380
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
@@ -376,6 +382,8 @@ declare namespace gapi.client {
376
382
  business?: string;
377
383
  /** Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. */
378
384
  defaultLanguageCode?: string;
385
+ /** Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. */
386
+ location?: string;
379
387
  /** Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. */
380
388
  timeZone?: string;
381
389
  }
@@ -528,6 +536,30 @@ declare namespace gapi.client {
528
536
  /** Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
529
537
  gcsPrefix?: string;
530
538
  }
539
+ interface GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
540
+ /** Operation create time. */
541
+ createTime?: string;
542
+ /** Operation last update time. If the operation is done, this is also the finish time. */
543
+ updateTime?: string;
544
+ }
545
+ interface GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest {
546
+ /** Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line. */
547
+ gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
548
+ /** The Inline source for the input content for suggestion deny list entries. */
549
+ inlineSource?: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource;
550
+ }
551
+ interface GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource {
552
+ /** Required. A list of all denylist entries to import. Max of 1000 items. */
553
+ entries?: GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry[];
554
+ }
555
+ interface GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse {
556
+ /** A sample of errors encountered while processing the request. */
557
+ errorSamples?: GoogleRpcStatus[];
558
+ /** Count of deny list entries that failed to be imported. */
559
+ failedEntriesCount?: string;
560
+ /** Count of deny list entries successfully imported. */
561
+ importedEntriesCount?: string;
562
+ }
531
563
  interface GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata {
532
564
  /** Operation create time. */
533
565
  createTime?: string;
@@ -624,6 +656,14 @@ declare namespace gapi.client {
624
656
  /** Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */
625
657
  mediaProgressPercentage?: number;
626
658
  }
659
+ interface GoogleCloudDiscoveryengineV1alphaOcrConfig {
660
+ /** Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. */
661
+ enabled?: boolean;
662
+ /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
663
+ enhancedDocumentElements?: string[];
664
+ /** If true, will use native text instead of OCR text on pages containing native text. */
665
+ useNativeText?: boolean;
666
+ }
627
667
  interface GoogleCloudDiscoveryengineV1alphaPageInfo {
628
668
  /** 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. */
629
669
  pageCategory?: string;
@@ -667,6 +707,19 @@ declare namespace gapi.client {
667
707
  /** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
668
708
  purgeSample?: string[];
669
709
  }
710
+ interface GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
711
+ /** Operation create time. */
712
+ createTime?: string;
713
+ /** Operation last update time. If the operation is done, this is also the finish time. */
714
+ updateTime?: string;
715
+ }
716
+ interface GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest {}
717
+ interface GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse {
718
+ /** A sample of errors encountered while processing the request. */
719
+ errorSamples?: GoogleRpcStatus[];
720
+ /** Number of suggestion deny list entries purged. */
721
+ purgeCount?: string;
722
+ }
670
723
  interface GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata {
671
724
  /** Operation create time. */
672
725
  createTime?: string;
@@ -803,7 +856,7 @@ declare namespace gapi.client {
803
856
  canonicalFilter?: string;
804
857
  /** A specification for configuring the behavior of content search. */
805
858
  contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
806
- /** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.embedding_spec.embedding_vectors.vector and the document embedding that is provided in SearchRequest.embedding_spec.embedding_vectors.field_path. If SearchRequest.embedding_spec.embedding_vectors.field_path is not provided, it will use ServingConfig.embedding_config.field_paths. */
859
+ /** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_paths. */
807
860
  embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
808
861
  /** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
809
862
  facetSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
@@ -859,7 +912,7 @@ declare namespace gapi.client {
859
912
  summarySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
860
913
  }
861
914
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
862
- /** The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most one answer is returned for each SearchResult. */
915
+ /** The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */
863
916
  maxExtractiveAnswerCount?: number;
864
917
  /** The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */
865
918
  maxExtractiveSegmentCount?: number;
@@ -897,7 +950,7 @@ declare namespace gapi.client {
897
950
  preamble?: string;
898
951
  }
899
952
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
900
- /** The string format of the model version. e.g. stable, preview, etc. */
953
+ /** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. */
901
954
  version?: string;
902
955
  }
903
956
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
@@ -1055,7 +1108,7 @@ declare namespace gapi.client {
1055
1108
  document?: string;
1056
1109
  /** Title of the document. */
1057
1110
  title?: string;
1058
- /** GCS or HTTP uri for the document. */
1111
+ /** Cloud Storage or HTTP uri for the document. */
1059
1112
  uri?: string;
1060
1113
  }
1061
1114
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
@@ -1082,6 +1135,12 @@ declare namespace gapi.client {
1082
1135
  /** Latest site verification time. */
1083
1136
  verifyTime?: string;
1084
1137
  }
1138
+ interface GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
1139
+ /** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
1140
+ blockPhrase?: string;
1141
+ /** Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase. */
1142
+ matchOperator?: string;
1143
+ }
1085
1144
  interface GoogleCloudDiscoveryengineV1alphaTargetSite {
1086
1145
  /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
1087
1146
  exactMatch?: boolean;
@@ -1122,19 +1181,19 @@ declare namespace gapi.client {
1122
1181
  interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest {
1123
1182
  /** The desired location of errors incurred during the data ingestion and training. */
1124
1183
  errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
1125
- /** Gcs training input. */
1184
+ /** Cloud Storage training input. */
1126
1185
  gcsTrainingInput?: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
1127
1186
  /** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
1128
1187
  modelType?: string;
1129
1188
  }
1130
1189
  interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
1131
- /** The gcs corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id, title and text. Example: {"_id": "doc1", title: "relevant doc", "text": "relevant text"} */
1190
+ /** The Cloud Storage corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: {"_id": "doc1", title: "relevant doc", "text": "relevant text"} */
1132
1191
  corpusDataPath?: string;
1133
- /** The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
1192
+ /** The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
1134
1193
  queryDataPath?: string;
1135
- /** Gcs test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */
1194
+ /** Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */
1136
1195
  testDataPath?: string;
1137
- /** Gcs training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). * For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\tdoc1\t1 */
1196
+ /** Cloud Storage training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\tdoc1\t1 */
1138
1197
  trainDataPath?: string;
1139
1198
  }
1140
1199
  interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
@@ -1194,7 +1253,7 @@ declare namespace gapi.client {
1194
1253
  eventTime?: string;
1195
1254
  /** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
1196
1255
  eventType?: string;
1197
- /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1256
+ /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1198
1257
  filter?: string;
1199
1258
  /** Media-specific info. */
1200
1259
  mediaInfo?: GoogleCloudDiscoveryengineV1alphaMediaInfo;
@@ -1367,6 +1426,20 @@ declare namespace gapi.client {
1367
1426
  /** Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
1368
1427
  gcsPrefix?: string;
1369
1428
  }
1429
+ interface GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
1430
+ /** Operation create time. */
1431
+ createTime?: string;
1432
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1433
+ updateTime?: string;
1434
+ }
1435
+ interface GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse {
1436
+ /** A sample of errors encountered while processing the request. */
1437
+ errorSamples?: GoogleRpcStatus[];
1438
+ /** Count of deny list entries that failed to be imported. */
1439
+ failedEntriesCount?: string;
1440
+ /** Count of deny list entries successfully imported. */
1441
+ importedEntriesCount?: string;
1442
+ }
1370
1443
  interface GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata {
1371
1444
  /** Operation create time. */
1372
1445
  createTime?: string;
@@ -1403,6 +1476,18 @@ declare namespace gapi.client {
1403
1476
  /** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
1404
1477
  purgeSample?: string[];
1405
1478
  }
1479
+ interface GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
1480
+ /** Operation create time. */
1481
+ createTime?: string;
1482
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1483
+ updateTime?: string;
1484
+ }
1485
+ interface GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
1486
+ /** A sample of errors encountered while processing the request. */
1487
+ errorSamples?: GoogleRpcStatus[];
1488
+ /** Number of suggestion deny list entries purged. */
1489
+ purgeCount?: string;
1490
+ }
1406
1491
  interface GoogleCloudDiscoveryengineV1betaSchema {
1407
1492
  /** The JSON representation of the schema. */
1408
1493
  jsonSchema?: string;
@@ -1449,6 +1534,20 @@ declare namespace gapi.client {
1449
1534
  /** Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
1450
1535
  gcsPrefix?: string;
1451
1536
  }
1537
+ interface GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata {
1538
+ /** Operation create time. */
1539
+ createTime?: string;
1540
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1541
+ updateTime?: string;
1542
+ }
1543
+ interface GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse {
1544
+ /** A sample of errors encountered while processing the request. */
1545
+ errorSamples?: GoogleRpcStatus[];
1546
+ /** Count of deny list entries that failed to be imported. */
1547
+ failedEntriesCount?: string;
1548
+ /** Count of deny list entries successfully imported. */
1549
+ importedEntriesCount?: string;
1550
+ }
1452
1551
  interface GoogleCloudDiscoveryengineV1ImportUserEventsMetadata {
1453
1552
  /** Operation create time. */
1454
1553
  createTime?: string;
@@ -1485,6 +1584,18 @@ declare namespace gapi.client {
1485
1584
  /** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
1486
1585
  purgeSample?: string[];
1487
1586
  }
1587
+ interface GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
1588
+ /** Operation create time. */
1589
+ createTime?: string;
1590
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1591
+ updateTime?: string;
1592
+ }
1593
+ interface GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse {
1594
+ /** A sample of errors encountered while processing the request. */
1595
+ errorSamples?: GoogleRpcStatus[];
1596
+ /** Number of suggestion deny list entries purged. */
1597
+ purgeCount?: string;
1598
+ }
1488
1599
  interface GoogleCloudDiscoveryengineV1Schema {
1489
1600
  /** The JSON representation of the schema. */
1490
1601
  jsonSchema?: string;
@@ -2454,7 +2565,7 @@ declare namespace gapi.client {
2454
2565
  prettyPrint?: boolean;
2455
2566
  /** 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. */
2456
2567
  quotaUser?: string;
2457
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated. */
2568
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
2458
2569
  updateMask?: string;
2459
2570
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2460
2571
  upload_protocol?: string;
@@ -2485,7 +2596,7 @@ declare namespace gapi.client {
2485
2596
  prettyPrint?: boolean;
2486
2597
  /** 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. */
2487
2598
  quotaUser?: string;
2488
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated. */
2599
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
2489
2600
  updateMask?: string;
2490
2601
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2491
2602
  upload_protocol?: string;
@@ -2917,7 +3028,7 @@ declare namespace gapi.client {
2917
3028
  prettyPrint?: boolean;
2918
3029
  /** 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. */
2919
3030
  quotaUser?: string;
2920
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests. */
3031
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
2921
3032
  servingConfig: string;
2922
3033
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2923
3034
  upload_protocol?: string;
@@ -2946,7 +3057,7 @@ declare namespace gapi.client {
2946
3057
  prettyPrint?: boolean;
2947
3058
  /** 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. */
2948
3059
  quotaUser?: string;
2949
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests. */
3060
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
2950
3061
  servingConfig: string;
2951
3062
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2952
3063
  upload_protocol?: string;
@@ -3667,6 +3778,124 @@ declare namespace gapi.client {
3667
3778
  operations: OperationsResource;
3668
3779
  targetSites: TargetSitesResource;
3669
3780
  }
3781
+ interface SuggestionDenyListEntriesResource {
3782
+ /** Imports all SuggestionDenyListEntry for a DataStore. */
3783
+ import(request: {
3784
+ /** V1 error format. */
3785
+ '$.xgafv'?: string;
3786
+ /** OAuth access token. */
3787
+ access_token?: string;
3788
+ /** Data format for response. */
3789
+ alt?: string;
3790
+ /** JSONP */
3791
+ callback?: string;
3792
+ /** Selector specifying which fields to include in a partial response. */
3793
+ fields?: string;
3794
+ /** 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. */
3795
+ key?: string;
3796
+ /** OAuth 2.0 token for the current user. */
3797
+ oauth_token?: string;
3798
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
3799
+ parent: string;
3800
+ /** Returns response with indentations and line breaks. */
3801
+ prettyPrint?: boolean;
3802
+ /** 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. */
3803
+ quotaUser?: string;
3804
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3805
+ upload_protocol?: string;
3806
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3807
+ uploadType?: string;
3808
+ /** Request body */
3809
+ resource: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
3810
+ }): Request<GoogleLongrunningOperation>;
3811
+ import(
3812
+ request: {
3813
+ /** V1 error format. */
3814
+ '$.xgafv'?: string;
3815
+ /** OAuth access token. */
3816
+ access_token?: string;
3817
+ /** Data format for response. */
3818
+ alt?: string;
3819
+ /** JSONP */
3820
+ callback?: string;
3821
+ /** Selector specifying which fields to include in a partial response. */
3822
+ fields?: string;
3823
+ /** 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. */
3824
+ key?: string;
3825
+ /** OAuth 2.0 token for the current user. */
3826
+ oauth_token?: string;
3827
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
3828
+ parent: string;
3829
+ /** Returns response with indentations and line breaks. */
3830
+ prettyPrint?: boolean;
3831
+ /** 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. */
3832
+ quotaUser?: string;
3833
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3834
+ upload_protocol?: string;
3835
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3836
+ uploadType?: string;
3837
+ },
3838
+ body: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest
3839
+ ): Request<GoogleLongrunningOperation>;
3840
+ /** Permanently deletes all SuggestionDenyListEntry for a DataStore. */
3841
+ purge(request: {
3842
+ /** V1 error format. */
3843
+ '$.xgafv'?: string;
3844
+ /** OAuth access token. */
3845
+ access_token?: string;
3846
+ /** Data format for response. */
3847
+ alt?: string;
3848
+ /** JSONP */
3849
+ callback?: string;
3850
+ /** Selector specifying which fields to include in a partial response. */
3851
+ fields?: string;
3852
+ /** 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. */
3853
+ key?: string;
3854
+ /** OAuth 2.0 token for the current user. */
3855
+ oauth_token?: string;
3856
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
3857
+ parent: string;
3858
+ /** Returns response with indentations and line breaks. */
3859
+ prettyPrint?: boolean;
3860
+ /** 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. */
3861
+ quotaUser?: string;
3862
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3863
+ upload_protocol?: string;
3864
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3865
+ uploadType?: string;
3866
+ /** Request body */
3867
+ resource: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
3868
+ }): Request<GoogleLongrunningOperation>;
3869
+ purge(
3870
+ request: {
3871
+ /** V1 error format. */
3872
+ '$.xgafv'?: string;
3873
+ /** OAuth access token. */
3874
+ access_token?: string;
3875
+ /** Data format for response. */
3876
+ alt?: string;
3877
+ /** JSONP */
3878
+ callback?: string;
3879
+ /** Selector specifying which fields to include in a partial response. */
3880
+ fields?: string;
3881
+ /** 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. */
3882
+ key?: string;
3883
+ /** OAuth 2.0 token for the current user. */
3884
+ oauth_token?: string;
3885
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
3886
+ parent: string;
3887
+ /** Returns response with indentations and line breaks. */
3888
+ prettyPrint?: boolean;
3889
+ /** 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. */
3890
+ quotaUser?: string;
3891
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3892
+ upload_protocol?: string;
3893
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3894
+ uploadType?: string;
3895
+ },
3896
+ body: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest
3897
+ ): Request<GoogleLongrunningOperation>;
3898
+ }
3670
3899
  interface UserEventsResource {
3671
3900
  /** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
3672
3901
  collect(request?: {
@@ -4032,6 +4261,33 @@ declare namespace gapi.client {
4032
4261
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4033
4262
  uploadType?: string;
4034
4263
  }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
4264
+ /** Gets a DocumentProcessingConfig. */
4265
+ getDocumentProcessingConfig(request?: {
4266
+ /** V1 error format. */
4267
+ '$.xgafv'?: string;
4268
+ /** OAuth access token. */
4269
+ access_token?: string;
4270
+ /** Data format for response. */
4271
+ alt?: string;
4272
+ /** JSONP */
4273
+ callback?: string;
4274
+ /** Selector specifying which fields to include in a partial response. */
4275
+ fields?: string;
4276
+ /** 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. */
4277
+ key?: string;
4278
+ /** Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig` */
4279
+ name: string;
4280
+ /** OAuth 2.0 token for the current user. */
4281
+ oauth_token?: string;
4282
+ /** Returns response with indentations and line breaks. */
4283
+ prettyPrint?: boolean;
4284
+ /** 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. */
4285
+ quotaUser?: string;
4286
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4287
+ upload_protocol?: string;
4288
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4289
+ uploadType?: string;
4290
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
4035
4291
  /** Gets the SiteSearchEngine. */
4036
4292
  getSiteSearchEngine(request?: {
4037
4293
  /** V1 error format. */
@@ -4081,7 +4337,7 @@ declare namespace gapi.client {
4081
4337
  pageSize?: number;
4082
4338
  /** A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. */
4083
4339
  pageToken?: string;
4084
- /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. */
4340
+ /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. */
4085
4341
  parent: string;
4086
4342
  /** Returns response with indentations and line breaks. */
4087
4343
  prettyPrint?: boolean;
@@ -4212,6 +4468,68 @@ declare namespace gapi.client {
4212
4468
  },
4213
4469
  body: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest
4214
4470
  ): Request<GoogleLongrunningOperation>;
4471
+ /** Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. */
4472
+ updateDocumentProcessingConfig(request: {
4473
+ /** V1 error format. */
4474
+ '$.xgafv'?: string;
4475
+ /** OAuth access token. */
4476
+ access_token?: string;
4477
+ /** Data format for response. */
4478
+ alt?: string;
4479
+ /** JSONP */
4480
+ callback?: string;
4481
+ /** Selector specifying which fields to include in a partial response. */
4482
+ fields?: string;
4483
+ /** 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. */
4484
+ key?: string;
4485
+ /** Output only. The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
4486
+ name: string;
4487
+ /** OAuth 2.0 token for the current user. */
4488
+ oauth_token?: string;
4489
+ /** Returns response with indentations and line breaks. */
4490
+ prettyPrint?: boolean;
4491
+ /** 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. */
4492
+ quotaUser?: string;
4493
+ /** Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.orc_config If not set, all supported fields are updated. */
4494
+ updateMask?: string;
4495
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4496
+ upload_protocol?: string;
4497
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4498
+ uploadType?: string;
4499
+ /** Request body */
4500
+ resource: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
4501
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
4502
+ updateDocumentProcessingConfig(
4503
+ request: {
4504
+ /** V1 error format. */
4505
+ '$.xgafv'?: string;
4506
+ /** OAuth access token. */
4507
+ access_token?: string;
4508
+ /** Data format for response. */
4509
+ alt?: string;
4510
+ /** JSONP */
4511
+ callback?: string;
4512
+ /** Selector specifying which fields to include in a partial response. */
4513
+ fields?: string;
4514
+ /** 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. */
4515
+ key?: string;
4516
+ /** Output only. The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
4517
+ name: string;
4518
+ /** OAuth 2.0 token for the current user. */
4519
+ oauth_token?: string;
4520
+ /** Returns response with indentations and line breaks. */
4521
+ prettyPrint?: boolean;
4522
+ /** 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. */
4523
+ quotaUser?: string;
4524
+ /** Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.orc_config If not set, all supported fields are updated. */
4525
+ updateMask?: string;
4526
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4527
+ upload_protocol?: string;
4528
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4529
+ uploadType?: string;
4530
+ },
4531
+ body: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
4532
+ ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
4215
4533
  branches: BranchesResource;
4216
4534
  conversations: ConversationsResource;
4217
4535
  models: ModelsResource;
@@ -4219,6 +4537,7 @@ declare namespace gapi.client {
4219
4537
  schemas: SchemasResource;
4220
4538
  servingConfigs: ServingConfigsResource;
4221
4539
  siteSearchEngine: SiteSearchEngineResource;
4540
+ suggestionDenyListEntries: SuggestionDenyListEntriesResource;
4222
4541
  userEvents: UserEventsResource;
4223
4542
  }
4224
4543
  interface ConversationsResource {
@@ -4449,7 +4768,7 @@ declare namespace gapi.client {
4449
4768
  prettyPrint?: boolean;
4450
4769
  /** 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. */
4451
4770
  quotaUser?: string;
4452
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated. */
4771
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
4453
4772
  updateMask?: string;
4454
4773
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4455
4774
  upload_protocol?: string;
@@ -4480,7 +4799,7 @@ declare namespace gapi.client {
4480
4799
  prettyPrint?: boolean;
4481
4800
  /** 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. */
4482
4801
  quotaUser?: string;
4483
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated. */
4802
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
4484
4803
  updateMask?: string;
4485
4804
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4486
4805
  upload_protocol?: string;
@@ -4573,7 +4892,7 @@ declare namespace gapi.client {
4573
4892
  prettyPrint?: boolean;
4574
4893
  /** 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. */
4575
4894
  quotaUser?: string;
4576
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests. */
4895
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4577
4896
  servingConfig: string;
4578
4897
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4579
4898
  upload_protocol?: string;
@@ -4602,7 +4921,7 @@ declare namespace gapi.client {
4602
4921
  prettyPrint?: boolean;
4603
4922
  /** 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. */
4604
4923
  quotaUser?: string;
4605
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests. */
4924
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4606
4925
  servingConfig: string;
4607
4926
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4608
4927
  upload_protocol?: string;
@@ -4882,7 +5201,7 @@ declare namespace gapi.client {
4882
5201
  },
4883
5202
  body: GoogleCloudDiscoveryengineV1alphaEngine
4884
5203
  ): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
4885
- /** Pauses the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
5204
+ /** Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
4886
5205
  pause(request: {
4887
5206
  /** V1 error format. */
4888
5207
  '$.xgafv'?: string;
@@ -4940,7 +5259,7 @@ declare namespace gapi.client {
4940
5259
  },
4941
5260
  body: GoogleCloudDiscoveryengineV1alphaPauseEngineRequest
4942
5261
  ): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
4943
- /** Resumes the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
5262
+ /** Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
4944
5263
  resume(request: {
4945
5264
  /** V1 error format. */
4946
5265
  '$.xgafv'?: string;
@@ -4998,7 +5317,7 @@ declare namespace gapi.client {
4998
5317
  },
4999
5318
  body: GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
5000
5319
  ): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
5001
- /** Tunes an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
5320
+ /** Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
5002
5321
  tune(request: {
5003
5322
  /** V1 error format. */
5004
5323
  '$.xgafv'?: string;
@@ -5749,7 +6068,7 @@ declare namespace gapi.client {
5749
6068
  prettyPrint?: boolean;
5750
6069
  /** 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. */
5751
6070
  quotaUser?: string;
5752
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated. */
6071
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
5753
6072
  updateMask?: string;
5754
6073
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5755
6074
  upload_protocol?: string;
@@ -5780,7 +6099,7 @@ declare namespace gapi.client {
5780
6099
  prettyPrint?: boolean;
5781
6100
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
5782
6101
  quotaUser?: string;
5783
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated. */
6102
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
5784
6103
  updateMask?: string;
5785
6104
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5786
6105
  upload_protocol?: string;
@@ -6149,7 +6468,7 @@ declare namespace gapi.client {
6149
6468
  prettyPrint?: boolean;
6150
6469
  /** 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. */
6151
6470
  quotaUser?: string;
6152
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests. */
6471
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6153
6472
  servingConfig: string;
6154
6473
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6155
6474
  upload_protocol?: string;
@@ -6178,7 +6497,7 @@ declare namespace gapi.client {
6178
6497
  prettyPrint?: boolean;
6179
6498
  /** 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. */
6180
6499
  quotaUser?: string;
6181
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests. */
6500
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6182
6501
  servingConfig: string;
6183
6502
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6184
6503
  upload_protocol?: string;
@@ -6684,6 +7003,124 @@ declare namespace gapi.client {
6684
7003
  ): Request<GoogleLongrunningOperation>;
6685
7004
  targetSites: TargetSitesResource;
6686
7005
  }
7006
+ interface SuggestionDenyListEntriesResource {
7007
+ /** Imports all SuggestionDenyListEntry for a DataStore. */
7008
+ import(request: {
7009
+ /** V1 error format. */
7010
+ '$.xgafv'?: string;
7011
+ /** OAuth access token. */
7012
+ access_token?: string;
7013
+ /** Data format for response. */
7014
+ alt?: string;
7015
+ /** JSONP */
7016
+ callback?: string;
7017
+ /** Selector specifying which fields to include in a partial response. */
7018
+ fields?: string;
7019
+ /** 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. */
7020
+ key?: string;
7021
+ /** OAuth 2.0 token for the current user. */
7022
+ oauth_token?: string;
7023
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
7024
+ parent: string;
7025
+ /** Returns response with indentations and line breaks. */
7026
+ prettyPrint?: boolean;
7027
+ /** 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. */
7028
+ quotaUser?: string;
7029
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7030
+ upload_protocol?: string;
7031
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7032
+ uploadType?: string;
7033
+ /** Request body */
7034
+ resource: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest;
7035
+ }): Request<GoogleLongrunningOperation>;
7036
+ import(
7037
+ request: {
7038
+ /** V1 error format. */
7039
+ '$.xgafv'?: string;
7040
+ /** OAuth access token. */
7041
+ access_token?: string;
7042
+ /** Data format for response. */
7043
+ alt?: string;
7044
+ /** JSONP */
7045
+ callback?: string;
7046
+ /** Selector specifying which fields to include in a partial response. */
7047
+ fields?: string;
7048
+ /** 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. */
7049
+ key?: string;
7050
+ /** OAuth 2.0 token for the current user. */
7051
+ oauth_token?: string;
7052
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
7053
+ parent: string;
7054
+ /** Returns response with indentations and line breaks. */
7055
+ prettyPrint?: boolean;
7056
+ /** 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. */
7057
+ quotaUser?: string;
7058
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7059
+ upload_protocol?: string;
7060
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7061
+ uploadType?: string;
7062
+ },
7063
+ body: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest
7064
+ ): Request<GoogleLongrunningOperation>;
7065
+ /** Permanently deletes all SuggestionDenyListEntry for a DataStore. */
7066
+ purge(request: {
7067
+ /** V1 error format. */
7068
+ '$.xgafv'?: string;
7069
+ /** OAuth access token. */
7070
+ access_token?: string;
7071
+ /** Data format for response. */
7072
+ alt?: string;
7073
+ /** JSONP */
7074
+ callback?: string;
7075
+ /** Selector specifying which fields to include in a partial response. */
7076
+ fields?: string;
7077
+ /** 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. */
7078
+ key?: string;
7079
+ /** OAuth 2.0 token for the current user. */
7080
+ oauth_token?: string;
7081
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
7082
+ parent: string;
7083
+ /** Returns response with indentations and line breaks. */
7084
+ prettyPrint?: boolean;
7085
+ /** 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. */
7086
+ quotaUser?: string;
7087
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7088
+ upload_protocol?: string;
7089
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7090
+ uploadType?: string;
7091
+ /** Request body */
7092
+ resource: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest;
7093
+ }): Request<GoogleLongrunningOperation>;
7094
+ purge(
7095
+ request: {
7096
+ /** V1 error format. */
7097
+ '$.xgafv'?: string;
7098
+ /** OAuth access token. */
7099
+ access_token?: string;
7100
+ /** Data format for response. */
7101
+ alt?: string;
7102
+ /** JSONP */
7103
+ callback?: string;
7104
+ /** Selector specifying which fields to include in a partial response. */
7105
+ fields?: string;
7106
+ /** 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. */
7107
+ key?: string;
7108
+ /** OAuth 2.0 token for the current user. */
7109
+ oauth_token?: string;
7110
+ /** Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*‍/locations/*‍/collections/*‍/dataStores/*. */
7111
+ parent: string;
7112
+ /** Returns response with indentations and line breaks. */
7113
+ prettyPrint?: boolean;
7114
+ /** 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. */
7115
+ quotaUser?: string;
7116
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7117
+ upload_protocol?: string;
7118
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7119
+ uploadType?: string;
7120
+ },
7121
+ body: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest
7122
+ ): Request<GoogleLongrunningOperation>;
7123
+ }
6687
7124
  interface UserEventsResource {
6688
7125
  /** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
6689
7126
  collect(request?: {
@@ -7049,6 +7486,33 @@ declare namespace gapi.client {
7049
7486
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7050
7487
  uploadType?: string;
7051
7488
  }): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
7489
+ /** Gets a DocumentProcessingConfig. */
7490
+ getDocumentProcessingConfig(request?: {
7491
+ /** V1 error format. */
7492
+ '$.xgafv'?: string;
7493
+ /** OAuth access token. */
7494
+ access_token?: string;
7495
+ /** Data format for response. */
7496
+ alt?: string;
7497
+ /** JSONP */
7498
+ callback?: string;
7499
+ /** Selector specifying which fields to include in a partial response. */
7500
+ fields?: string;
7501
+ /** 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. */
7502
+ key?: string;
7503
+ /** Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig` */
7504
+ name: string;
7505
+ /** OAuth 2.0 token for the current user. */
7506
+ oauth_token?: string;
7507
+ /** Returns response with indentations and line breaks. */
7508
+ prettyPrint?: boolean;
7509
+ /** 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. */
7510
+ quotaUser?: string;
7511
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7512
+ upload_protocol?: string;
7513
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7514
+ uploadType?: string;
7515
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
7052
7516
  /** Gets the SiteSearchEngine. */
7053
7517
  getSiteSearchEngine(request?: {
7054
7518
  /** V1 error format. */
@@ -7098,7 +7562,7 @@ declare namespace gapi.client {
7098
7562
  pageSize?: number;
7099
7563
  /** A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. */
7100
7564
  pageToken?: string;
7101
- /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. */
7565
+ /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. */
7102
7566
  parent: string;
7103
7567
  /** Returns response with indentations and line breaks. */
7104
7568
  prettyPrint?: boolean;
@@ -7171,6 +7635,68 @@ declare namespace gapi.client {
7171
7635
  },
7172
7636
  body: GoogleCloudDiscoveryengineV1alphaDataStore
7173
7637
  ): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
7638
+ /** Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. */
7639
+ updateDocumentProcessingConfig(request: {
7640
+ /** V1 error format. */
7641
+ '$.xgafv'?: string;
7642
+ /** OAuth access token. */
7643
+ access_token?: string;
7644
+ /** Data format for response. */
7645
+ alt?: string;
7646
+ /** JSONP */
7647
+ callback?: string;
7648
+ /** Selector specifying which fields to include in a partial response. */
7649
+ fields?: string;
7650
+ /** 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. */
7651
+ key?: string;
7652
+ /** Output only. The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
7653
+ name: string;
7654
+ /** OAuth 2.0 token for the current user. */
7655
+ oauth_token?: string;
7656
+ /** Returns response with indentations and line breaks. */
7657
+ prettyPrint?: boolean;
7658
+ /** 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. */
7659
+ quotaUser?: string;
7660
+ /** Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.orc_config If not set, all supported fields are updated. */
7661
+ updateMask?: string;
7662
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7663
+ upload_protocol?: string;
7664
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7665
+ uploadType?: string;
7666
+ /** Request body */
7667
+ resource: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
7668
+ }): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
7669
+ updateDocumentProcessingConfig(
7670
+ request: {
7671
+ /** V1 error format. */
7672
+ '$.xgafv'?: string;
7673
+ /** OAuth access token. */
7674
+ access_token?: string;
7675
+ /** Data format for response. */
7676
+ alt?: string;
7677
+ /** JSONP */
7678
+ callback?: string;
7679
+ /** Selector specifying which fields to include in a partial response. */
7680
+ fields?: string;
7681
+ /** 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. */
7682
+ key?: string;
7683
+ /** Output only. The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
7684
+ name: string;
7685
+ /** OAuth 2.0 token for the current user. */
7686
+ oauth_token?: string;
7687
+ /** Returns response with indentations and line breaks. */
7688
+ prettyPrint?: boolean;
7689
+ /** 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. */
7690
+ quotaUser?: string;
7691
+ /** Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.orc_config If not set, all supported fields are updated. */
7692
+ updateMask?: string;
7693
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7694
+ upload_protocol?: string;
7695
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7696
+ uploadType?: string;
7697
+ },
7698
+ body: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
7699
+ ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
7174
7700
  branches: BranchesResource;
7175
7701
  conversations: ConversationsResource;
7176
7702
  models: ModelsResource;
@@ -7178,6 +7704,7 @@ declare namespace gapi.client {
7178
7704
  schemas: SchemasResource;
7179
7705
  servingConfigs: ServingConfigsResource;
7180
7706
  siteSearchEngine: SiteSearchEngineResource;
7707
+ suggestionDenyListEntries: SuggestionDenyListEntriesResource;
7181
7708
  userEvents: UserEventsResource;
7182
7709
  }
7183
7710
  interface OperationsResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20231209",
3
+ "version": "0.0.20240108",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",