@googleapis/discoveryengine 7.0.0 → 8.0.0

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.
package/v1beta.ts CHANGED
@@ -427,10 +427,6 @@ export namespace discoveryengine_v1beta {
427
427
  */
428
428
  updateTime?: string | null;
429
429
  }
430
- /**
431
- * The digital parsing configurations for documents.
432
- */
433
- export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {}
434
430
  /**
435
431
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
436
432
  */
@@ -452,6 +448,10 @@ export namespace discoveryengine_v1beta {
452
448
  * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
453
449
  */
454
450
  export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
451
+ /**
452
+ * Whether chunking mode is enabled.
453
+ */
454
+ chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig;
455
455
  /**
456
456
  * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
457
457
  */
@@ -460,10 +460,6 @@ export namespace discoveryengine_v1beta {
460
460
  * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
461
461
  */
462
462
  name?: string | null;
463
- /**
464
- * [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs.
465
- */
466
- ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
467
463
  /**
468
464
  * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
469
465
  */
@@ -473,6 +469,28 @@ export namespace discoveryengine_v1beta {
473
469
  ]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
474
470
  } | null;
475
471
  }
472
+ /**
473
+ * Configuration for chunking config.
474
+ */
475
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
476
+ /**
477
+ * Configuration for the layout based chunking.
478
+ */
479
+ layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
480
+ }
481
+ /**
482
+ * Configuration for the layout based chunking.
483
+ */
484
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
485
+ /**
486
+ * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
487
+ */
488
+ chunkSize?: number | null;
489
+ /**
490
+ * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
491
+ */
492
+ includeAncestorHeadings?: boolean | null;
493
+ }
476
494
  /**
477
495
  * Related configurations applied to a specific type of document parser.
478
496
  */
@@ -480,15 +498,36 @@ export namespace discoveryengine_v1beta {
480
498
  /**
481
499
  * Configurations applied to digital parser.
482
500
  */
483
- digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig;
501
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
484
502
  /**
485
503
  * Configurations applied to layout parser.
486
504
  */
487
- layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig;
505
+ layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig;
488
506
  /**
489
507
  * Configurations applied to OCR parser. Currently it only applies to PDFs.
490
508
  */
491
- ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
509
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
510
+ }
511
+ /**
512
+ * The digital parsing configurations for documents.
513
+ */
514
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
515
+ /**
516
+ * The layout parsing configurations for documents.
517
+ */
518
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
519
+ /**
520
+ * The OCR parsing configurations for documents.
521
+ */
522
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
523
+ /**
524
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
525
+ */
526
+ enhancedDocumentElements?: string[] | null;
527
+ /**
528
+ * If true, will use native text instead of OCR text on pages containing native text.
529
+ */
530
+ useNativeText?: boolean | null;
492
531
  }
493
532
  /**
494
533
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -511,10 +550,6 @@ export namespace discoveryengine_v1beta {
511
550
  * Metadata that describes the training and serving parameters of an Engine.
512
551
  */
513
552
  export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
514
- /**
515
- * Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.
516
- */
517
- allowMultipleDataStoresSearchEngine?: boolean | null;
518
553
  /**
519
554
  * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
520
555
  */
@@ -896,40 +931,6 @@ export namespace discoveryengine_v1beta {
896
931
  */
897
932
  unjoinedEventsCount?: string | null;
898
933
  }
899
- /**
900
- * The layout parsing configurations for documents.
901
- */
902
- export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {}
903
- /**
904
- * The OCR options for parsing documents.
905
- */
906
- export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
907
- /**
908
- * 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.
909
- */
910
- enabled?: boolean | null;
911
- /**
912
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
913
- */
914
- enhancedDocumentElements?: string[] | null;
915
- /**
916
- * If true, will use native text instead of OCR text on pages containing native text.
917
- */
918
- useNativeText?: boolean | null;
919
- }
920
- /**
921
- * The OCR parsing configurations for documents.
922
- */
923
- export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
924
- /**
925
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
926
- */
927
- enhancedDocumentElements?: string[] | null;
928
- /**
929
- * If true, will use native text instead of OCR text on pages containing native text.
930
- */
931
- useNativeText?: boolean | null;
932
- }
933
934
  /**
934
935
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
935
936
  */
@@ -1671,10 +1672,6 @@ export namespace discoveryengine_v1beta {
1671
1672
  */
1672
1673
  updateTime?: string | null;
1673
1674
  }
1674
- /**
1675
- * The digital parsing configurations for documents.
1676
- */
1677
- export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
1678
1675
  /**
1679
1676
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
1680
1677
  */
@@ -1807,11 +1804,28 @@ export namespace discoveryengine_v1beta {
1807
1804
  /**
1808
1805
  * Configurations applied to digital parser.
1809
1806
  */
1810
- digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig;
1807
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
1811
1808
  /**
1812
1809
  * Configurations applied to OCR parser. Currently it only applies to PDFs.
1813
1810
  */
1814
- ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
1811
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
1812
+ }
1813
+ /**
1814
+ * The digital parsing configurations for documents.
1815
+ */
1816
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
1817
+ /**
1818
+ * The OCR parsing configurations for documents.
1819
+ */
1820
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
1821
+ /**
1822
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
1823
+ */
1824
+ enhancedDocumentElements?: string[] | null;
1825
+ /**
1826
+ * If true, will use native text instead of OCR text on pages containing native text.
1827
+ */
1828
+ useNativeText?: boolean | null;
1815
1829
  }
1816
1830
  /**
1817
1831
  * Double list.
@@ -2334,19 +2348,6 @@ export namespace discoveryengine_v1beta {
2334
2348
  */
2335
2349
  mediaProgressPercentage?: number | null;
2336
2350
  }
2337
- /**
2338
- * The OCR parsing configurations for documents.
2339
- */
2340
- export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
2341
- /**
2342
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
2343
- */
2344
- enhancedDocumentElements?: string[] | null;
2345
- /**
2346
- * If true, will use native text instead of OCR text on pages containing native text.
2347
- */
2348
- useNativeText?: boolean | null;
2349
- }
2350
2351
  /**
2351
2352
  * Detailed page information.
2352
2353
  */
@@ -2638,6 +2639,10 @@ export namespace discoveryengine_v1beta {
2638
2639
  * A specification for configuring the behavior of content search.
2639
2640
  */
2640
2641
  contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
2642
+ /**
2643
+ * A list of data store specs to apply on a search call.
2644
+ */
2645
+ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
2641
2646
  /**
2642
2647
  * 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_path.
2643
2648
  */
@@ -2721,11 +2726,11 @@ export namespace discoveryengine_v1beta {
2721
2726
  */
2722
2727
  export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
2723
2728
  /**
2724
- * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
2729
+ * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
2725
2730
  */
2726
2731
  boost?: number | null;
2727
2732
  /**
2728
- * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
2733
+ * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
2729
2734
  */
2730
2735
  condition?: string | null;
2731
2736
  }
@@ -2766,6 +2771,10 @@ export namespace discoveryengine_v1beta {
2766
2771
  * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
2767
2772
  */
2768
2773
  numPreviousSegments?: number | null;
2774
+ /**
2775
+ * 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`.
2776
+ */
2777
+ returnExtractiveSegmentScore?: boolean | null;
2769
2778
  }
2770
2779
  /**
2771
2780
  * A specification for configuring snippets in a search response.
@@ -2813,9 +2822,13 @@ export namespace discoveryengine_v1beta {
2813
2822
  */
2814
2823
  modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
2815
2824
  /**
2816
- * 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 five results can be used to generate a summary.
2825
+ * 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.
2817
2826
  */
2818
2827
  summaryResultCount?: number | null;
2828
+ /**
2829
+ * 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.
2830
+ */
2831
+ useSemanticChunks?: boolean | null;
2819
2832
  }
2820
2833
  /**
2821
2834
  * Specification of the prompt to use with the model.
@@ -2831,10 +2844,19 @@ export namespace discoveryengine_v1beta {
2831
2844
  */
2832
2845
  export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
2833
2846
  /**
2834
- * 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.
2847
+ * 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 model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
2835
2848
  */
2836
2849
  version?: string | null;
2837
2850
  }
2851
+ /**
2852
+ * A struct to define data stores to filter on in a search call.
2853
+ */
2854
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
2855
+ /**
2856
+ * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`.
2857
+ */
2858
+ dataStore?: string | null;
2859
+ }
2838
2860
  /**
2839
2861
  * The specification that uses customized query embedding vector to do semantic document retrieval.
2840
2862
  */
@@ -3249,7 +3271,7 @@ export namespace discoveryengine_v1beta {
3249
3271
  */
3250
3272
  modelId?: string | null;
3251
3273
  /**
3252
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
3274
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
3253
3275
  */
3254
3276
  name?: string | null;
3255
3277
  /**
@@ -3298,10 +3320,6 @@ export namespace discoveryengine_v1beta {
3298
3320
  * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
3299
3321
  */
3300
3322
  contentFreshnessCutoffDays?: number | null;
3301
- /**
3302
- * Specifies the content watched minutes threshold for demotion.
3303
- */
3304
- contentWatchedMinutesThreshold?: number | null;
3305
3323
  /**
3306
3324
  * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
3307
3325
  */
@@ -3422,6 +3440,74 @@ export namespace discoveryengine_v1beta {
3422
3440
  */
3423
3441
  input?: string | null;
3424
3442
  }
3443
+ /**
3444
+ * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
3445
+ */
3446
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
3447
+ /**
3448
+ * Operation create time.
3449
+ */
3450
+ createTime?: string | null;
3451
+ /**
3452
+ * Operation last update time. If the operation is done, this is also the finish time.
3453
+ */
3454
+ updateTime?: string | null;
3455
+ }
3456
+ /**
3457
+ * Request message for SearchTuningService.TrainCustomModel method.
3458
+ */
3459
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest {
3460
+ /**
3461
+ * The desired location of errors incurred during the data ingestion and training.
3462
+ */
3463
+ errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
3464
+ /**
3465
+ * Cloud Storage training input.
3466
+ */
3467
+ gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput;
3468
+ /**
3469
+ * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.
3470
+ */
3471
+ modelType?: string | null;
3472
+ }
3473
+ /**
3474
+ * Cloud Storage training data input.
3475
+ */
3476
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput {
3477
+ /**
3478
+ * 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"\}`
3479
+ */
3480
+ corpusDataPath?: string | null;
3481
+ /**
3482
+ * 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"\}
3483
+ */
3484
+ queryDataPath?: string | null;
3485
+ /**
3486
+ * 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.
3487
+ */
3488
+ testDataPath?: string | null;
3489
+ /**
3490
+ * 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`
3491
+ */
3492
+ trainDataPath?: string | null;
3493
+ }
3494
+ /**
3495
+ * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
3496
+ */
3497
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
3498
+ /**
3499
+ * Echoes the destination for the complete errors in the request if set.
3500
+ */
3501
+ errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
3502
+ /**
3503
+ * A sample of errors encountered while processing the data.
3504
+ */
3505
+ errorSamples?: Schema$GoogleRpcStatus[];
3506
+ /**
3507
+ * 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 is in progress. * **ready**: The model is ready for serving.
3508
+ */
3509
+ modelStatus?: string | null;
3510
+ }
3425
3511
  /**
3426
3512
  * A transaction represents the entire purchase transaction.
3427
3513
  */
@@ -3714,10 +3800,6 @@ export namespace discoveryengine_v1beta {
3714
3800
  */
3715
3801
  updateTime?: string | null;
3716
3802
  }
3717
- /**
3718
- * The digital parsing configurations for documents.
3719
- */
3720
- export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
3721
3803
  /**
3722
3804
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
3723
3805
  */
@@ -3763,11 +3845,28 @@ export namespace discoveryengine_v1beta {
3763
3845
  /**
3764
3846
  * Configurations applied to digital parser.
3765
3847
  */
3766
- digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig;
3848
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig;
3767
3849
  /**
3768
3850
  * Configurations applied to OCR parser. Currently it only applies to PDFs.
3769
3851
  */
3770
- ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig;
3852
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
3853
+ }
3854
+ /**
3855
+ * The digital parsing configurations for documents.
3856
+ */
3857
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
3858
+ /**
3859
+ * The OCR parsing configurations for documents.
3860
+ */
3861
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
3862
+ /**
3863
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
3864
+ */
3865
+ enhancedDocumentElements?: string[] | null;
3866
+ /**
3867
+ * If true, will use native text instead of OCR text on pages containing native text.
3868
+ */
3869
+ useNativeText?: boolean | null;
3771
3870
  }
3772
3871
  /**
3773
3872
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -4015,19 +4114,6 @@ export namespace discoveryengine_v1beta {
4015
4114
  */
4016
4115
  unjoinedEventsCount?: string | null;
4017
4116
  }
4018
- /**
4019
- * The OCR parsing configurations for documents.
4020
- */
4021
- export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
4022
- /**
4023
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
4024
- */
4025
- enhancedDocumentElements?: string[] | null;
4026
- /**
4027
- * If true, will use native text instead of OCR text on pages containing native text.
4028
- */
4029
- useNativeText?: boolean | null;
4030
- }
4031
4117
  /**
4032
4118
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
4033
4119
  */
@@ -5293,6 +5379,102 @@ export namespace discoveryengine_v1beta {
5293
5379
  );
5294
5380
  }
5295
5381
  }
5382
+
5383
+ /**
5384
+ * Trains a custom model.
5385
+ *
5386
+ * @param params - Parameters for request
5387
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5388
+ * @param callback - Optional callback that handles the response.
5389
+ * @returns A promise if used with async/await, or void if used with a callback.
5390
+ */
5391
+ trainCustomModel(
5392
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel,
5393
+ options: StreamMethodOptions
5394
+ ): GaxiosPromise<Readable>;
5395
+ trainCustomModel(
5396
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel,
5397
+ options?: MethodOptions
5398
+ ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
5399
+ trainCustomModel(
5400
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel,
5401
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
5402
+ callback: BodyResponseCallback<Readable>
5403
+ ): void;
5404
+ trainCustomModel(
5405
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel,
5406
+ options:
5407
+ | MethodOptions
5408
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
5409
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
5410
+ ): void;
5411
+ trainCustomModel(
5412
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel,
5413
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
5414
+ ): void;
5415
+ trainCustomModel(
5416
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
5417
+ ): void;
5418
+ trainCustomModel(
5419
+ paramsOrCallback?:
5420
+ | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel
5421
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
5422
+ | BodyResponseCallback<Readable>,
5423
+ optionsOrCallback?:
5424
+ | MethodOptions
5425
+ | StreamMethodOptions
5426
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
5427
+ | BodyResponseCallback<Readable>,
5428
+ callback?:
5429
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
5430
+ | BodyResponseCallback<Readable>
5431
+ ):
5432
+ | void
5433
+ | GaxiosPromise<Schema$GoogleLongrunningOperation>
5434
+ | GaxiosPromise<Readable> {
5435
+ let params = (paramsOrCallback ||
5436
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel;
5437
+ let options = (optionsOrCallback || {}) as MethodOptions;
5438
+
5439
+ if (typeof paramsOrCallback === 'function') {
5440
+ callback = paramsOrCallback;
5441
+ params =
5442
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel;
5443
+ options = {};
5444
+ }
5445
+
5446
+ if (typeof optionsOrCallback === 'function') {
5447
+ callback = optionsOrCallback;
5448
+ options = {};
5449
+ }
5450
+
5451
+ const rootUrl =
5452
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
5453
+ const parameters = {
5454
+ options: Object.assign(
5455
+ {
5456
+ url: (rootUrl + '/v1beta/{+dataStore}:trainCustomModel').replace(
5457
+ /([^:]\/)\/+/g,
5458
+ '$1'
5459
+ ),
5460
+ method: 'POST',
5461
+ },
5462
+ options
5463
+ ),
5464
+ params,
5465
+ requiredParams: ['dataStore'],
5466
+ pathParams: ['dataStore'],
5467
+ context: this.context,
5468
+ };
5469
+ if (callback) {
5470
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
5471
+ parameters,
5472
+ callback as BodyResponseCallback<unknown>
5473
+ );
5474
+ } else {
5475
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
5476
+ }
5477
+ }
5296
5478
  }
5297
5479
 
5298
5480
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery
@@ -5394,6 +5576,18 @@ export namespace discoveryengine_v1beta {
5394
5576
  */
5395
5577
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
5396
5578
  }
5579
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel
5580
+ extends StandardParameters {
5581
+ /**
5582
+ * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.
5583
+ */
5584
+ dataStore?: string;
5585
+
5586
+ /**
5587
+ * Request body metadata
5588
+ */
5589
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
5590
+ }
5397
5591
 
5398
5592
  export class Resource$Projects$Locations$Collections$Datastores$Branches {
5399
5593
  context: APIRequestContext;
@@ -8785,7 +8979,7 @@ export namespace discoveryengine_v1beta {
8785
8979
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
8786
8980
  extends StandardParameters {
8787
8981
  /**
8788
- * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
8982
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
8789
8983
  */
8790
8984
  name?: string;
8791
8985
  }
@@ -8800,14 +8994,14 @@ export namespace discoveryengine_v1beta {
8800
8994
  */
8801
8995
  pageToken?: string;
8802
8996
  /**
8803
- * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
8997
+ * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
8804
8998
  */
8805
8999
  parent?: string;
8806
9000
  }
8807
9001
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
8808
9002
  extends StandardParameters {
8809
9003
  /**
8810
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
9004
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
8811
9005
  */
8812
9006
  name?: string;
8813
9007
  /**
@@ -13005,7 +13199,7 @@ export namespace discoveryengine_v1beta {
13005
13199
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
13006
13200
  extends StandardParameters {
13007
13201
  /**
13008
- * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
13202
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
13009
13203
  */
13010
13204
  name?: string;
13011
13205
  }
@@ -13020,14 +13214,14 @@ export namespace discoveryengine_v1beta {
13020
13214
  */
13021
13215
  pageToken?: string;
13022
13216
  /**
13023
- * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
13217
+ * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
13024
13218
  */
13025
13219
  parent?: string;
13026
13220
  }
13027
13221
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
13028
13222
  extends StandardParameters {
13029
13223
  /**
13030
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
13224
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
13031
13225
  */
13032
13226
  name?: string;
13033
13227
  /**
@@ -17258,7 +17452,7 @@ export namespace discoveryengine_v1beta {
17258
17452
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
17259
17453
  extends StandardParameters {
17260
17454
  /**
17261
- * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
17455
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
17262
17456
  */
17263
17457
  name?: string;
17264
17458
  }
@@ -17273,14 +17467,14 @@ export namespace discoveryengine_v1beta {
17273
17467
  */
17274
17468
  pageToken?: string;
17275
17469
  /**
17276
- * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
17470
+ * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
17277
17471
  */
17278
17472
  parent?: string;
17279
17473
  }
17280
17474
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
17281
17475
  extends StandardParameters {
17282
17476
  /**
17283
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
17477
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
17284
17478
  */
17285
17479
  name?: string;
17286
17480
  /**