@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/build/v1beta.d.ts CHANGED
@@ -380,11 +380,6 @@ export declare namespace discoveryengine_v1beta {
380
380
  */
381
381
  updateTime?: string | null;
382
382
  }
383
- /**
384
- * The digital parsing configurations for documents.
385
- */
386
- export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {
387
- }
388
383
  /**
389
384
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
390
385
  */
@@ -407,6 +402,10 @@ export declare namespace discoveryengine_v1beta {
407
402
  * 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.
408
403
  */
409
404
  export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
405
+ /**
406
+ * Whether chunking mode is enabled.
407
+ */
408
+ chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig;
410
409
  /**
411
410
  * 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.
412
411
  */
@@ -415,10 +414,6 @@ export declare namespace discoveryengine_v1beta {
415
414
  * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
416
415
  */
417
416
  name?: string | null;
418
- /**
419
- * [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.
420
- */
421
- ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
422
417
  /**
423
418
  * 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.
424
419
  */
@@ -426,6 +421,28 @@ export declare namespace discoveryengine_v1beta {
426
421
  [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
427
422
  } | null;
428
423
  }
424
+ /**
425
+ * Configuration for chunking config.
426
+ */
427
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
428
+ /**
429
+ * Configuration for the layout based chunking.
430
+ */
431
+ layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
432
+ }
433
+ /**
434
+ * Configuration for the layout based chunking.
435
+ */
436
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
437
+ /**
438
+ * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
439
+ */
440
+ chunkSize?: number | null;
441
+ /**
442
+ * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
443
+ */
444
+ includeAncestorHeadings?: boolean | null;
445
+ }
429
446
  /**
430
447
  * Related configurations applied to a specific type of document parser.
431
448
  */
@@ -433,15 +450,38 @@ export declare namespace discoveryengine_v1beta {
433
450
  /**
434
451
  * Configurations applied to digital parser.
435
452
  */
436
- digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig;
453
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
437
454
  /**
438
455
  * Configurations applied to layout parser.
439
456
  */
440
- layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig;
457
+ layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig;
441
458
  /**
442
459
  * Configurations applied to OCR parser. Currently it only applies to PDFs.
443
460
  */
444
- ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
461
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
462
+ }
463
+ /**
464
+ * The digital parsing configurations for documents.
465
+ */
466
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
467
+ }
468
+ /**
469
+ * The layout parsing configurations for documents.
470
+ */
471
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
472
+ }
473
+ /**
474
+ * The OCR parsing configurations for documents.
475
+ */
476
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
477
+ /**
478
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
479
+ */
480
+ enhancedDocumentElements?: string[] | null;
481
+ /**
482
+ * If true, will use native text instead of OCR text on pages containing native text.
483
+ */
484
+ useNativeText?: boolean | null;
445
485
  }
446
486
  /**
447
487
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -465,10 +505,6 @@ export declare namespace discoveryengine_v1beta {
465
505
  * Metadata that describes the training and serving parameters of an Engine.
466
506
  */
467
507
  export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
468
- /**
469
- * 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.
470
- */
471
- allowMultipleDataStoresSearchEngine?: boolean | null;
472
508
  /**
473
509
  * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
474
510
  */
@@ -851,41 +887,6 @@ export declare namespace discoveryengine_v1beta {
851
887
  */
852
888
  unjoinedEventsCount?: string | null;
853
889
  }
854
- /**
855
- * The layout parsing configurations for documents.
856
- */
857
- export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {
858
- }
859
- /**
860
- * The OCR options for parsing documents.
861
- */
862
- export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
863
- /**
864
- * 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.
865
- */
866
- enabled?: boolean | null;
867
- /**
868
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
869
- */
870
- enhancedDocumentElements?: string[] | null;
871
- /**
872
- * If true, will use native text instead of OCR text on pages containing native text.
873
- */
874
- useNativeText?: boolean | null;
875
- }
876
- /**
877
- * The OCR parsing configurations for documents.
878
- */
879
- export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
880
- /**
881
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
882
- */
883
- enhancedDocumentElements?: string[] | null;
884
- /**
885
- * If true, will use native text instead of OCR text on pages containing native text.
886
- */
887
- useNativeText?: boolean | null;
888
- }
889
890
  /**
890
891
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
891
892
  */
@@ -1633,11 +1634,6 @@ export declare namespace discoveryengine_v1beta {
1633
1634
  */
1634
1635
  updateTime?: string | null;
1635
1636
  }
1636
- /**
1637
- * The digital parsing configurations for documents.
1638
- */
1639
- export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {
1640
- }
1641
1637
  /**
1642
1638
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
1643
1639
  */
@@ -1774,11 +1770,29 @@ export declare namespace discoveryengine_v1beta {
1774
1770
  /**
1775
1771
  * Configurations applied to digital parser.
1776
1772
  */
1777
- digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig;
1773
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
1778
1774
  /**
1779
1775
  * Configurations applied to OCR parser. Currently it only applies to PDFs.
1780
1776
  */
1781
- ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
1777
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
1778
+ }
1779
+ /**
1780
+ * The digital parsing configurations for documents.
1781
+ */
1782
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
1783
+ }
1784
+ /**
1785
+ * The OCR parsing configurations for documents.
1786
+ */
1787
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
1788
+ /**
1789
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
1790
+ */
1791
+ enhancedDocumentElements?: string[] | null;
1792
+ /**
1793
+ * If true, will use native text instead of OCR text on pages containing native text.
1794
+ */
1795
+ useNativeText?: boolean | null;
1782
1796
  }
1783
1797
  /**
1784
1798
  * Double list.
@@ -2303,19 +2317,6 @@ export declare namespace discoveryengine_v1beta {
2303
2317
  */
2304
2318
  mediaProgressPercentage?: number | null;
2305
2319
  }
2306
- /**
2307
- * The OCR parsing configurations for documents.
2308
- */
2309
- export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
2310
- /**
2311
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
2312
- */
2313
- enhancedDocumentElements?: string[] | null;
2314
- /**
2315
- * If true, will use native text instead of OCR text on pages containing native text.
2316
- */
2317
- useNativeText?: boolean | null;
2318
- }
2319
2320
  /**
2320
2321
  * Detailed page information.
2321
2322
  */
@@ -2616,6 +2617,10 @@ export declare namespace discoveryengine_v1beta {
2616
2617
  * A specification for configuring the behavior of content search.
2617
2618
  */
2618
2619
  contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
2620
+ /**
2621
+ * A list of data store specs to apply on a search call.
2622
+ */
2623
+ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
2619
2624
  /**
2620
2625
  * 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.
2621
2626
  */
@@ -2703,11 +2708,11 @@ export declare namespace discoveryengine_v1beta {
2703
2708
  */
2704
2709
  export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
2705
2710
  /**
2706
- * 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.
2711
+ * 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.
2707
2712
  */
2708
2713
  boost?: number | null;
2709
2714
  /**
2710
- * 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"))
2715
+ * 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"))`
2711
2716
  */
2712
2717
  condition?: string | null;
2713
2718
  }
@@ -2748,6 +2753,10 @@ export declare namespace discoveryengine_v1beta {
2748
2753
  * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
2749
2754
  */
2750
2755
  numPreviousSegments?: number | null;
2756
+ /**
2757
+ * 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`.
2758
+ */
2759
+ returnExtractiveSegmentScore?: boolean | null;
2751
2760
  }
2752
2761
  /**
2753
2762
  * A specification for configuring snippets in a search response.
@@ -2795,9 +2804,13 @@ export declare namespace discoveryengine_v1beta {
2795
2804
  */
2796
2805
  modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
2797
2806
  /**
2798
- * 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.
2807
+ * 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.
2799
2808
  */
2800
2809
  summaryResultCount?: number | null;
2810
+ /**
2811
+ * 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.
2812
+ */
2813
+ useSemanticChunks?: boolean | null;
2801
2814
  }
2802
2815
  /**
2803
2816
  * Specification of the prompt to use with the model.
@@ -2813,10 +2826,19 @@ export declare namespace discoveryengine_v1beta {
2813
2826
  */
2814
2827
  export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
2815
2828
  /**
2816
- * 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.
2829
+ * 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).
2817
2830
  */
2818
2831
  version?: string | null;
2819
2832
  }
2833
+ /**
2834
+ * A struct to define data stores to filter on in a search call.
2835
+ */
2836
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
2837
+ /**
2838
+ * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`.
2839
+ */
2840
+ dataStore?: string | null;
2841
+ }
2820
2842
  /**
2821
2843
  * The specification that uses customized query embedding vector to do semantic document retrieval.
2822
2844
  */
@@ -3231,7 +3253,7 @@ export declare namespace discoveryengine_v1beta {
3231
3253
  */
3232
3254
  modelId?: string | null;
3233
3255
  /**
3234
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
3256
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
3235
3257
  */
3236
3258
  name?: string | null;
3237
3259
  /**
@@ -3280,10 +3302,6 @@ export declare namespace discoveryengine_v1beta {
3280
3302
  * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
3281
3303
  */
3282
3304
  contentFreshnessCutoffDays?: number | null;
3283
- /**
3284
- * Specifies the content watched minutes threshold for demotion.
3285
- */
3286
- contentWatchedMinutesThreshold?: number | null;
3287
3305
  /**
3288
3306
  * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
3289
3307
  */
@@ -3404,6 +3422,74 @@ export declare namespace discoveryengine_v1beta {
3404
3422
  */
3405
3423
  input?: string | null;
3406
3424
  }
3425
+ /**
3426
+ * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
3427
+ */
3428
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
3429
+ /**
3430
+ * Operation create time.
3431
+ */
3432
+ createTime?: string | null;
3433
+ /**
3434
+ * Operation last update time. If the operation is done, this is also the finish time.
3435
+ */
3436
+ updateTime?: string | null;
3437
+ }
3438
+ /**
3439
+ * Request message for SearchTuningService.TrainCustomModel method.
3440
+ */
3441
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest {
3442
+ /**
3443
+ * The desired location of errors incurred during the data ingestion and training.
3444
+ */
3445
+ errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
3446
+ /**
3447
+ * Cloud Storage training input.
3448
+ */
3449
+ gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput;
3450
+ /**
3451
+ * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.
3452
+ */
3453
+ modelType?: string | null;
3454
+ }
3455
+ /**
3456
+ * Cloud Storage training data input.
3457
+ */
3458
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput {
3459
+ /**
3460
+ * 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"\}`
3461
+ */
3462
+ corpusDataPath?: string | null;
3463
+ /**
3464
+ * 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"\}
3465
+ */
3466
+ queryDataPath?: string | null;
3467
+ /**
3468
+ * 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.
3469
+ */
3470
+ testDataPath?: string | null;
3471
+ /**
3472
+ * 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`
3473
+ */
3474
+ trainDataPath?: string | null;
3475
+ }
3476
+ /**
3477
+ * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
3478
+ */
3479
+ export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
3480
+ /**
3481
+ * Echoes the destination for the complete errors in the request if set.
3482
+ */
3483
+ errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
3484
+ /**
3485
+ * A sample of errors encountered while processing the data.
3486
+ */
3487
+ errorSamples?: Schema$GoogleRpcStatus[];
3488
+ /**
3489
+ * 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.
3490
+ */
3491
+ modelStatus?: string | null;
3492
+ }
3407
3493
  /**
3408
3494
  * A transaction represents the entire purchase transaction.
3409
3495
  */
@@ -3696,11 +3782,6 @@ export declare namespace discoveryengine_v1beta {
3696
3782
  */
3697
3783
  updateTime?: string | null;
3698
3784
  }
3699
- /**
3700
- * The digital parsing configurations for documents.
3701
- */
3702
- export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {
3703
- }
3704
3785
  /**
3705
3786
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
3706
3787
  */
@@ -3745,11 +3826,29 @@ export declare namespace discoveryengine_v1beta {
3745
3826
  /**
3746
3827
  * Configurations applied to digital parser.
3747
3828
  */
3748
- digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig;
3829
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig;
3749
3830
  /**
3750
3831
  * Configurations applied to OCR parser. Currently it only applies to PDFs.
3751
3832
  */
3752
- ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig;
3833
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
3834
+ }
3835
+ /**
3836
+ * The digital parsing configurations for documents.
3837
+ */
3838
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {
3839
+ }
3840
+ /**
3841
+ * The OCR parsing configurations for documents.
3842
+ */
3843
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
3844
+ /**
3845
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
3846
+ */
3847
+ enhancedDocumentElements?: string[] | null;
3848
+ /**
3849
+ * If true, will use native text instead of OCR text on pages containing native text.
3850
+ */
3851
+ useNativeText?: boolean | null;
3753
3852
  }
3754
3853
  /**
3755
3854
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -3998,19 +4097,6 @@ export declare namespace discoveryengine_v1beta {
3998
4097
  */
3999
4098
  unjoinedEventsCount?: string | null;
4000
4099
  }
4001
- /**
4002
- * The OCR parsing configurations for documents.
4003
- */
4004
- export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
4005
- /**
4006
- * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
4007
- */
4008
- enhancedDocumentElements?: string[] | null;
4009
- /**
4010
- * If true, will use native text instead of OCR text on pages containing native text.
4011
- */
4012
- useNativeText?: boolean | null;
4013
- }
4014
4100
  /**
4015
4101
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
4016
4102
  */
@@ -4467,6 +4553,20 @@ export declare namespace discoveryengine_v1beta {
4467
4553
  patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
4468
4554
  patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
4469
4555
  patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
4556
+ /**
4557
+ * Trains a custom model.
4558
+ *
4559
+ * @param params - Parameters for request
4560
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4561
+ * @param callback - Optional callback that handles the response.
4562
+ * @returns A promise if used with async/await, or void if used with a callback.
4563
+ */
4564
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions): GaxiosPromise<Readable>;
4565
+ trainCustomModel(params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
4566
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
4567
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4568
+ trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4569
+ trainCustomModel(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4470
4570
  }
4471
4571
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
4472
4572
  /**
@@ -4558,6 +4658,16 @@ export declare namespace discoveryengine_v1beta {
4558
4658
  */
4559
4659
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
4560
4660
  }
4661
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel extends StandardParameters {
4662
+ /**
4663
+ * 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.
4664
+ */
4665
+ dataStore?: string;
4666
+ /**
4667
+ * Request body metadata
4668
+ */
4669
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
4670
+ }
4561
4671
  export class Resource$Projects$Locations$Collections$Datastores$Branches {
4562
4672
  context: APIRequestContext;
4563
4673
  documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents;
@@ -5330,7 +5440,7 @@ export declare namespace discoveryengine_v1beta {
5330
5440
  }
5331
5441
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
5332
5442
  /**
5333
- * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
5443
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
5334
5444
  */
5335
5445
  name?: string;
5336
5446
  }
@@ -5344,13 +5454,13 @@ export declare namespace discoveryengine_v1beta {
5344
5454
  */
5345
5455
  pageToken?: string;
5346
5456
  /**
5347
- * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
5457
+ * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
5348
5458
  */
5349
5459
  parent?: string;
5350
5460
  }
5351
5461
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
5352
5462
  /**
5353
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
5463
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
5354
5464
  */
5355
5465
  name?: string;
5356
5466
  /**
@@ -6328,7 +6438,7 @@ export declare namespace discoveryengine_v1beta {
6328
6438
  }
6329
6439
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
6330
6440
  /**
6331
- * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
6441
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
6332
6442
  */
6333
6443
  name?: string;
6334
6444
  }
@@ -6342,13 +6452,13 @@ export declare namespace discoveryengine_v1beta {
6342
6452
  */
6343
6453
  pageToken?: string;
6344
6454
  /**
6345
- * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
6455
+ * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
6346
6456
  */
6347
6457
  parent?: string;
6348
6458
  }
6349
6459
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
6350
6460
  /**
6351
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
6461
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
6352
6462
  */
6353
6463
  name?: string;
6354
6464
  /**
@@ -7352,7 +7462,7 @@ export declare namespace discoveryengine_v1beta {
7352
7462
  }
7353
7463
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
7354
7464
  /**
7355
- * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
7465
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
7356
7466
  */
7357
7467
  name?: string;
7358
7468
  }
@@ -7366,13 +7476,13 @@ export declare namespace discoveryengine_v1beta {
7366
7476
  */
7367
7477
  pageToken?: string;
7368
7478
  /**
7369
- * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
7479
+ * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
7370
7480
  */
7371
7481
  parent?: string;
7372
7482
  }
7373
7483
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
7374
7484
  /**
7375
- * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
7485
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
7376
7486
  */
7377
7487
  name?: string;
7378
7488
  /**
package/build/v1beta.js CHANGED
@@ -394,6 +394,38 @@ var discoveryengine_v1beta;
394
394
  return (0, googleapis_common_1.createAPIRequest)(parameters);
395
395
  }
396
396
  }
397
+ trainCustomModel(paramsOrCallback, optionsOrCallback, callback) {
398
+ let params = (paramsOrCallback ||
399
+ {});
400
+ let options = (optionsOrCallback || {});
401
+ if (typeof paramsOrCallback === 'function') {
402
+ callback = paramsOrCallback;
403
+ params =
404
+ {};
405
+ options = {};
406
+ }
407
+ if (typeof optionsOrCallback === 'function') {
408
+ callback = optionsOrCallback;
409
+ options = {};
410
+ }
411
+ const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
412
+ const parameters = {
413
+ options: Object.assign({
414
+ url: (rootUrl + '/v1beta/{+dataStore}:trainCustomModel').replace(/([^:]\/)\/+/g, '$1'),
415
+ method: 'POST',
416
+ }, options),
417
+ params,
418
+ requiredParams: ['dataStore'],
419
+ pathParams: ['dataStore'],
420
+ context: this.context,
421
+ };
422
+ if (callback) {
423
+ (0, googleapis_common_1.createAPIRequest)(parameters, callback);
424
+ }
425
+ else {
426
+ return (0, googleapis_common_1.createAPIRequest)(parameters);
427
+ }
428
+ }
397
429
  }
398
430
  discoveryengine_v1beta.Resource$Projects$Locations$Collections$Datastores = Resource$Projects$Locations$Collections$Datastores;
399
431
  class Resource$Projects$Locations$Collections$Datastores$Branches {