@googleapis/discoveryengine 6.0.0 → 7.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
@@ -239,6 +239,19 @@ export namespace discoveryengine_v1beta {
239
239
  */
240
240
  functionName?: string | null;
241
241
  }
242
+ /**
243
+ * Access Control Configuration.
244
+ */
245
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
246
+ /**
247
+ * Identity provider config.
248
+ */
249
+ idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
250
+ /**
251
+ * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
252
+ */
253
+ name?: string | null;
254
+ }
242
255
  /**
243
256
  * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
244
257
  */
@@ -317,6 +330,10 @@ export namespace discoveryengine_v1beta {
317
330
  * DataStore captures global settings and configs at the DataStore level.
318
331
  */
319
332
  export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
333
+ /**
334
+ * Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.
335
+ */
336
+ aclEnabled?: boolean | null;
320
337
  /**
321
338
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
322
339
  */
@@ -333,6 +350,14 @@ export namespace discoveryengine_v1beta {
333
350
  * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
334
351
  */
335
352
  displayName?: string | null;
353
+ /**
354
+ * Configuration for Document understanding and enrichment.
355
+ */
356
+ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
357
+ /**
358
+ * Output only. Data store level identity provider config.
359
+ */
360
+ idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
336
361
  /**
337
362
  * Immutable. The industry vertical that the data store registers.
338
363
  */
@@ -345,6 +370,10 @@ export namespace discoveryengine_v1beta {
345
370
  * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
346
371
  */
347
372
  solutionTypes?: string[] | null;
373
+ /**
374
+ * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
375
+ */
376
+ startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
348
377
  }
349
378
  /**
350
379
  * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -436,7 +465,7 @@ export namespace discoveryengine_v1beta {
436
465
  */
437
466
  ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
438
467
  /**
439
- * 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.
468
+ * 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.
440
469
  */
441
470
  parsingConfigOverrides?: {
442
471
  [
@@ -482,6 +511,10 @@ export namespace discoveryengine_v1beta {
482
511
  * Metadata that describes the training and serving parameters of an Engine.
483
512
  */
484
513
  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;
485
518
  /**
486
519
  * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
487
520
  */
@@ -726,6 +759,28 @@ export namespace discoveryengine_v1beta {
726
759
  */
727
760
  searchableOption?: string | null;
728
761
  }
762
+ /**
763
+ * Identity Provider Config.
764
+ */
765
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig {
766
+ /**
767
+ * External Identity provider config.
768
+ */
769
+ externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
770
+ /**
771
+ * Identity provider type configured.
772
+ */
773
+ idpType?: string | null;
774
+ }
775
+ /**
776
+ * Third party IDP Config.
777
+ */
778
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
779
+ /**
780
+ * Workforce pool name. Example: "locations/global/workforcePools/pool_id"
781
+ */
782
+ workforcePoolName?: string | null;
783
+ }
729
784
  /**
730
785
  * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
731
786
  */
@@ -887,6 +942,10 @@ export namespace discoveryengine_v1beta {
887
942
  * Count of entries that encountered errors while processing.
888
943
  */
889
944
  failureCount?: string | null;
945
+ /**
946
+ * Count of entries that were ignored as entries were not found.
947
+ */
948
+ ignoredCount?: string | null;
890
949
  /**
891
950
  * Count of entries that were deleted successfully.
892
951
  */
@@ -1121,6 +1180,9 @@ export namespace discoveryengine_v1beta {
1121
1180
  */
1122
1181
  quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
1123
1182
  }
1183
+ /**
1184
+ * Failed due to insufficient quota.
1185
+ */
1124
1186
  export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
1125
1187
  /**
1126
1188
  * This number is an estimation on how much total quota this project needs to successfully complete indexing.
@@ -1384,6 +1446,10 @@ export namespace discoveryengine_v1beta {
1384
1446
  * Request message for ConversationalSearchService.ConverseConversation method.
1385
1447
  */
1386
1448
  export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest {
1449
+ /**
1450
+ * Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
1451
+ */
1452
+ boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
1387
1453
  /**
1388
1454
  * The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
1389
1455
  */
@@ -1532,6 +1598,10 @@ export namespace discoveryengine_v1beta {
1532
1598
  * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
1533
1599
  */
1534
1600
  displayName?: string | null;
1601
+ /**
1602
+ * Configuration for Document understanding and enrichment.
1603
+ */
1604
+ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
1535
1605
  /**
1536
1606
  * Immutable. The industry vertical that the data store registers.
1537
1607
  */
@@ -1544,6 +1614,10 @@ export namespace discoveryengine_v1beta {
1544
1614
  * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
1545
1615
  */
1546
1616
  solutionTypes?: string[] | null;
1617
+ /**
1618
+ * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
1619
+ */
1620
+ startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
1547
1621
  }
1548
1622
  /**
1549
1623
  * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -1597,6 +1671,10 @@ export namespace discoveryengine_v1beta {
1597
1671
  */
1598
1672
  updateTime?: string | null;
1599
1673
  }
1674
+ /**
1675
+ * The digital parsing configurations for documents.
1676
+ */
1677
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
1600
1678
  /**
1601
1679
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
1602
1680
  */
@@ -1634,6 +1712,10 @@ export namespace discoveryengine_v1beta {
1634
1712
  * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
1635
1713
  */
1636
1714
  id?: string | null;
1715
+ /**
1716
+ * Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
1717
+ */
1718
+ indexTime?: string | null;
1637
1719
  /**
1638
1720
  * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
1639
1721
  */
@@ -1697,6 +1779,40 @@ export namespace discoveryengine_v1beta {
1697
1779
  */
1698
1780
  uri?: string | null;
1699
1781
  }
1782
+ /**
1783
+ * 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.
1784
+ */
1785
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
1786
+ /**
1787
+ * 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.
1788
+ */
1789
+ defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
1790
+ /**
1791
+ * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
1792
+ */
1793
+ name?: string | null;
1794
+ /**
1795
+ * 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.
1796
+ */
1797
+ parsingConfigOverrides?: {
1798
+ [
1799
+ key: string
1800
+ ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
1801
+ } | null;
1802
+ }
1803
+ /**
1804
+ * Related configurations applied to a specific type of document parser.
1805
+ */
1806
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
1807
+ /**
1808
+ * Configurations applied to digital parser.
1809
+ */
1810
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig;
1811
+ /**
1812
+ * Configurations applied to OCR parser. Currently it only applies to PDFs.
1813
+ */
1814
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
1815
+ }
1700
1816
  /**
1701
1817
  * Double list.
1702
1818
  */
@@ -1706,6 +1822,15 @@ export namespace discoveryengine_v1beta {
1706
1822
  */
1707
1823
  values?: number[] | null;
1708
1824
  }
1825
+ /**
1826
+ * Defines embedding config, used for bring your own embeddings feature.
1827
+ */
1828
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig {
1829
+ /**
1830
+ * Full field path in the schema mapped as embedding field.
1831
+ */
1832
+ fieldPath?: string | null;
1833
+ }
1709
1834
  /**
1710
1835
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
1711
1836
  */
@@ -2166,6 +2291,19 @@ export namespace discoveryengine_v1beta {
2166
2291
  */
2167
2292
  schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[];
2168
2293
  }
2294
+ /**
2295
+ * Response for ListServingConfigs method.
2296
+ */
2297
+ export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse {
2298
+ /**
2299
+ * Pagination token, if not returned indicates the last page.
2300
+ */
2301
+ nextPageToken?: string | null;
2302
+ /**
2303
+ * All the ServingConfigs for a given dataStore.
2304
+ */
2305
+ servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[];
2306
+ }
2169
2307
  /**
2170
2308
  * Response message for SiteSearchEngineService.ListTargetSites method.
2171
2309
  */
@@ -2196,6 +2334,19 @@ export namespace discoveryengine_v1beta {
2196
2334
  */
2197
2335
  mediaProgressPercentage?: number | null;
2198
2336
  }
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
+ }
2199
2350
  /**
2200
2351
  * Detailed page information.
2201
2352
  */
@@ -2250,6 +2401,10 @@ export namespace discoveryengine_v1beta {
2250
2401
  * Count of entries that encountered errors while processing.
2251
2402
  */
2252
2403
  failureCount?: string | null;
2404
+ /**
2405
+ * Count of entries that were ignored as entries were not found.
2406
+ */
2407
+ ignoredCount?: string | null;
2253
2408
  /**
2254
2409
  * Count of entries that were deleted successfully.
2255
2410
  */
@@ -2570,7 +2725,7 @@ export namespace discoveryengine_v1beta {
2570
2725
  */
2571
2726
  boost?: number | null;
2572
2727
  /**
2573
- * 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": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
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"))
2574
2729
  */
2575
2730
  condition?: string | null;
2576
2731
  }
@@ -2958,6 +3113,9 @@ export namespace discoveryengine_v1beta {
2958
3113
  * The summary content.
2959
3114
  */
2960
3115
  summaryText?: string | null;
3116
+ /**
3117
+ * Summary with metadata information.
3118
+ */
2961
3119
  summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata;
2962
3120
  }
2963
3121
  /**
@@ -3042,6 +3200,121 @@ export namespace discoveryengine_v1beta {
3042
3200
  */
3043
3201
  summary?: string | null;
3044
3202
  }
3203
+ /**
3204
+ * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
3205
+ */
3206
+ export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig {
3207
+ /**
3208
+ * Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
3209
+ */
3210
+ boostControlIds?: string[] | null;
3211
+ /**
3212
+ * Output only. ServingConfig created timestamp.
3213
+ */
3214
+ createTime?: string | null;
3215
+ /**
3216
+ * Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
3217
+ */
3218
+ displayName?: string | null;
3219
+ /**
3220
+ * Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
3221
+ */
3222
+ dissociateControlIds?: string[] | null;
3223
+ /**
3224
+ * How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
3225
+ */
3226
+ diversityLevel?: string | null;
3227
+ /**
3228
+ * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.
3229
+ */
3230
+ embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig;
3231
+ /**
3232
+ * Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
3233
+ */
3234
+ filterControlIds?: string[] | null;
3235
+ /**
3236
+ * The GenericConfig of the serving configuration.
3237
+ */
3238
+ genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig;
3239
+ /**
3240
+ * Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
3241
+ */
3242
+ ignoreControlIds?: string[] | null;
3243
+ /**
3244
+ * The MediaConfig of the serving configuration.
3245
+ */
3246
+ mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig;
3247
+ /**
3248
+ * The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
3249
+ */
3250
+ modelId?: string | null;
3251
+ /**
3252
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
3253
+ */
3254
+ name?: string | null;
3255
+ /**
3256
+ * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
3257
+ */
3258
+ onewaySynonymsControlIds?: string[] | null;
3259
+ /**
3260
+ * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
3261
+ */
3262
+ rankingExpression?: string | null;
3263
+ /**
3264
+ * IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
3265
+ */
3266
+ redirectControlIds?: string[] | null;
3267
+ /**
3268
+ * Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
3269
+ */
3270
+ replacementControlIds?: string[] | null;
3271
+ /**
3272
+ * Required. Immutable. Specifies the solution type that a serving config can be associated with.
3273
+ */
3274
+ solutionType?: string | null;
3275
+ /**
3276
+ * Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
3277
+ */
3278
+ synonymsControlIds?: string[] | null;
3279
+ /**
3280
+ * Output only. ServingConfig updated timestamp.
3281
+ */
3282
+ updateTime?: string | null;
3283
+ }
3284
+ /**
3285
+ * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
3286
+ */
3287
+ export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig {
3288
+ /**
3289
+ * Specifies the expected behavior of content search. Only valid for content-search enabled data store.
3290
+ */
3291
+ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
3292
+ }
3293
+ /**
3294
+ * Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
3295
+ */
3296
+ export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig {
3297
+ /**
3298
+ * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
3299
+ */
3300
+ contentFreshnessCutoffDays?: number | null;
3301
+ /**
3302
+ * Specifies the content watched minutes threshold for demotion.
3303
+ */
3304
+ contentWatchedMinutesThreshold?: number | null;
3305
+ /**
3306
+ * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
3307
+ */
3308
+ contentWatchedPercentageThreshold?: number | null;
3309
+ /**
3310
+ * Specifies the content watched minutes threshold for demotion.
3311
+ */
3312
+ contentWatchedSecondsThreshold?: number | null;
3313
+ /**
3314
+ * Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
3315
+ */
3316
+ demotionEventType?: string | null;
3317
+ }
3045
3318
  /**
3046
3319
  * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
3047
3320
  */
@@ -3127,6 +3400,9 @@ export namespace discoveryengine_v1beta {
3127
3400
  */
3128
3401
  quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
3129
3402
  }
3403
+ /**
3404
+ * Failed due to insufficient quota.
3405
+ */
3130
3406
  export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
3131
3407
  /**
3132
3408
  * This number is an estimation on how much total quota this project needs to successfully complete indexing.
@@ -3365,6 +3641,10 @@ export namespace discoveryengine_v1beta {
3365
3641
  * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
3366
3642
  */
3367
3643
  displayName?: string | null;
3644
+ /**
3645
+ * Configuration for Document understanding and enrichment.
3646
+ */
3647
+ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
3368
3648
  /**
3369
3649
  * Immutable. The industry vertical that the data store registers.
3370
3650
  */
@@ -3377,6 +3657,10 @@ export namespace discoveryengine_v1beta {
3377
3657
  * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
3378
3658
  */
3379
3659
  solutionTypes?: string[] | null;
3660
+ /**
3661
+ * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
3662
+ */
3663
+ startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
3380
3664
  }
3381
3665
  /**
3382
3666
  * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -3430,6 +3714,10 @@ export namespace discoveryengine_v1beta {
3430
3714
  */
3431
3715
  updateTime?: string | null;
3432
3716
  }
3717
+ /**
3718
+ * The digital parsing configurations for documents.
3719
+ */
3720
+ export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
3433
3721
  /**
3434
3722
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
3435
3723
  */
@@ -3447,6 +3735,40 @@ export namespace discoveryengine_v1beta {
3447
3735
  * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
3448
3736
  */
3449
3737
  export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
3738
+ /**
3739
+ * 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.
3740
+ */
3741
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
3742
+ /**
3743
+ * 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.
3744
+ */
3745
+ defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
3746
+ /**
3747
+ * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
3748
+ */
3749
+ name?: string | null;
3750
+ /**
3751
+ * 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.
3752
+ */
3753
+ parsingConfigOverrides?: {
3754
+ [
3755
+ key: string
3756
+ ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
3757
+ } | null;
3758
+ }
3759
+ /**
3760
+ * Related configurations applied to a specific type of document parser.
3761
+ */
3762
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
3763
+ /**
3764
+ * Configurations applied to digital parser.
3765
+ */
3766
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig;
3767
+ /**
3768
+ * Configurations applied to OCR parser. Currently it only applies to PDFs.
3769
+ */
3770
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig;
3771
+ }
3450
3772
  /**
3451
3773
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
3452
3774
  */
@@ -3693,6 +4015,19 @@ export namespace discoveryengine_v1beta {
3693
4015
  */
3694
4016
  unjoinedEventsCount?: string | null;
3695
4017
  }
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
+ }
3696
4031
  /**
3697
4032
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
3698
4033
  */
@@ -3705,6 +4040,10 @@ export namespace discoveryengine_v1beta {
3705
4040
  * Count of entries that encountered errors while processing.
3706
4041
  */
3707
4042
  failureCount?: string | null;
4043
+ /**
4044
+ * Count of entries that were ignored as entries were not found.
4045
+ */
4046
+ ignoredCount?: string | null;
3708
4047
  /**
3709
4048
  * Count of entries that were deleted successfully.
3710
4049
  */
@@ -3833,6 +4172,9 @@ export namespace discoveryengine_v1beta {
3833
4172
  */
3834
4173
  quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
3835
4174
  }
4175
+ /**
4176
+ * Failed due to insufficient quota.
4177
+ */
3836
4178
  export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
3837
4179
  /**
3838
4180
  * This number is an estimation on how much total quota this project needs to successfully complete indexing.
@@ -7956,65 +8298,65 @@ export namespace discoveryengine_v1beta {
7956
8298
  }
7957
8299
 
7958
8300
  /**
7959
- * Makes a recommendation, which requires a contextual user event.
8301
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
7960
8302
  *
7961
8303
  * @param params - Parameters for request
7962
8304
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7963
8305
  * @param callback - Optional callback that handles the response.
7964
8306
  * @returns A promise if used with async/await, or void if used with a callback.
7965
8307
  */
7966
- recommend(
7967
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8308
+ get(
8309
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
7968
8310
  options: StreamMethodOptions
7969
8311
  ): GaxiosPromise<Readable>;
7970
- recommend(
7971
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8312
+ get(
8313
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
7972
8314
  options?: MethodOptions
7973
- ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
7974
- recommend(
7975
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8315
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
8316
+ get(
8317
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
7976
8318
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
7977
8319
  callback: BodyResponseCallback<Readable>
7978
8320
  ): void;
7979
- recommend(
7980
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8321
+ get(
8322
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
7981
8323
  options:
7982
8324
  | MethodOptions
7983
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>,
7984
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8325
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
8326
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
7985
8327
  ): void;
7986
- recommend(
7987
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
7988
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8328
+ get(
8329
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
8330
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
7989
8331
  ): void;
7990
- recommend(
7991
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8332
+ get(
8333
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
7992
8334
  ): void;
7993
- recommend(
8335
+ get(
7994
8336
  paramsOrCallback?:
7995
- | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
7996
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8337
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
8338
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
7997
8339
  | BodyResponseCallback<Readable>,
7998
8340
  optionsOrCallback?:
7999
8341
  | MethodOptions
8000
8342
  | StreamMethodOptions
8001
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8343
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8002
8344
  | BodyResponseCallback<Readable>,
8003
8345
  callback?:
8004
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8346
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8005
8347
  | BodyResponseCallback<Readable>
8006
8348
  ):
8007
8349
  | void
8008
- | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8350
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8009
8351
  | GaxiosPromise<Readable> {
8010
8352
  let params = (paramsOrCallback ||
8011
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
8353
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
8012
8354
  let options = (optionsOrCallback || {}) as MethodOptions;
8013
8355
 
8014
8356
  if (typeof paramsOrCallback === 'function') {
8015
8357
  callback = paramsOrCallback;
8016
8358
  params =
8017
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
8359
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
8018
8360
  options = {};
8019
8361
  }
8020
8362
 
@@ -8028,8 +8370,296 @@ export namespace discoveryengine_v1beta {
8028
8370
  const parameters = {
8029
8371
  options: Object.assign(
8030
8372
  {
8031
- url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace(
8032
- /([^:]\/)\/+/g,
8373
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
8374
+ method: 'GET',
8375
+ },
8376
+ options
8377
+ ),
8378
+ params,
8379
+ requiredParams: ['name'],
8380
+ pathParams: ['name'],
8381
+ context: this.context,
8382
+ };
8383
+ if (callback) {
8384
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
8385
+ parameters,
8386
+ callback as BodyResponseCallback<unknown>
8387
+ );
8388
+ } else {
8389
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
8390
+ parameters
8391
+ );
8392
+ }
8393
+ }
8394
+
8395
+ /**
8396
+ * Lists all ServingConfigs linked to this dataStore.
8397
+ *
8398
+ * @param params - Parameters for request
8399
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
8400
+ * @param callback - Optional callback that handles the response.
8401
+ * @returns A promise if used with async/await, or void if used with a callback.
8402
+ */
8403
+ list(
8404
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
8405
+ options: StreamMethodOptions
8406
+ ): GaxiosPromise<Readable>;
8407
+ list(
8408
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
8409
+ options?: MethodOptions
8410
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
8411
+ list(
8412
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
8413
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
8414
+ callback: BodyResponseCallback<Readable>
8415
+ ): void;
8416
+ list(
8417
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
8418
+ options:
8419
+ | MethodOptions
8420
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>,
8421
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
8422
+ ): void;
8423
+ list(
8424
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
8425
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
8426
+ ): void;
8427
+ list(
8428
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
8429
+ ): void;
8430
+ list(
8431
+ paramsOrCallback?:
8432
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
8433
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
8434
+ | BodyResponseCallback<Readable>,
8435
+ optionsOrCallback?:
8436
+ | MethodOptions
8437
+ | StreamMethodOptions
8438
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
8439
+ | BodyResponseCallback<Readable>,
8440
+ callback?:
8441
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
8442
+ | BodyResponseCallback<Readable>
8443
+ ):
8444
+ | void
8445
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
8446
+ | GaxiosPromise<Readable> {
8447
+ let params = (paramsOrCallback ||
8448
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
8449
+ let options = (optionsOrCallback || {}) as MethodOptions;
8450
+
8451
+ if (typeof paramsOrCallback === 'function') {
8452
+ callback = paramsOrCallback;
8453
+ params =
8454
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
8455
+ options = {};
8456
+ }
8457
+
8458
+ if (typeof optionsOrCallback === 'function') {
8459
+ callback = optionsOrCallback;
8460
+ options = {};
8461
+ }
8462
+
8463
+ const rootUrl =
8464
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
8465
+ const parameters = {
8466
+ options: Object.assign(
8467
+ {
8468
+ url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace(
8469
+ /([^:]\/)\/+/g,
8470
+ '$1'
8471
+ ),
8472
+ method: 'GET',
8473
+ },
8474
+ options
8475
+ ),
8476
+ params,
8477
+ requiredParams: ['parent'],
8478
+ pathParams: ['parent'],
8479
+ context: this.context,
8480
+ };
8481
+ if (callback) {
8482
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
8483
+ parameters,
8484
+ callback as BodyResponseCallback<unknown>
8485
+ );
8486
+ } else {
8487
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
8488
+ parameters
8489
+ );
8490
+ }
8491
+ }
8492
+
8493
+ /**
8494
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
8495
+ *
8496
+ * @param params - Parameters for request
8497
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
8498
+ * @param callback - Optional callback that handles the response.
8499
+ * @returns A promise if used with async/await, or void if used with a callback.
8500
+ */
8501
+ patch(
8502
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
8503
+ options: StreamMethodOptions
8504
+ ): GaxiosPromise<Readable>;
8505
+ patch(
8506
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
8507
+ options?: MethodOptions
8508
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
8509
+ patch(
8510
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
8511
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
8512
+ callback: BodyResponseCallback<Readable>
8513
+ ): void;
8514
+ patch(
8515
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
8516
+ options:
8517
+ | MethodOptions
8518
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
8519
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8520
+ ): void;
8521
+ patch(
8522
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
8523
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8524
+ ): void;
8525
+ patch(
8526
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8527
+ ): void;
8528
+ patch(
8529
+ paramsOrCallback?:
8530
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
8531
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8532
+ | BodyResponseCallback<Readable>,
8533
+ optionsOrCallback?:
8534
+ | MethodOptions
8535
+ | StreamMethodOptions
8536
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8537
+ | BodyResponseCallback<Readable>,
8538
+ callback?:
8539
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8540
+ | BodyResponseCallback<Readable>
8541
+ ):
8542
+ | void
8543
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
8544
+ | GaxiosPromise<Readable> {
8545
+ let params = (paramsOrCallback ||
8546
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
8547
+ let options = (optionsOrCallback || {}) as MethodOptions;
8548
+
8549
+ if (typeof paramsOrCallback === 'function') {
8550
+ callback = paramsOrCallback;
8551
+ params =
8552
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
8553
+ options = {};
8554
+ }
8555
+
8556
+ if (typeof optionsOrCallback === 'function') {
8557
+ callback = optionsOrCallback;
8558
+ options = {};
8559
+ }
8560
+
8561
+ const rootUrl =
8562
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
8563
+ const parameters = {
8564
+ options: Object.assign(
8565
+ {
8566
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
8567
+ method: 'PATCH',
8568
+ },
8569
+ options
8570
+ ),
8571
+ params,
8572
+ requiredParams: ['name'],
8573
+ pathParams: ['name'],
8574
+ context: this.context,
8575
+ };
8576
+ if (callback) {
8577
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
8578
+ parameters,
8579
+ callback as BodyResponseCallback<unknown>
8580
+ );
8581
+ } else {
8582
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
8583
+ parameters
8584
+ );
8585
+ }
8586
+ }
8587
+
8588
+ /**
8589
+ * Makes a recommendation, which requires a contextual user event.
8590
+ *
8591
+ * @param params - Parameters for request
8592
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
8593
+ * @param callback - Optional callback that handles the response.
8594
+ * @returns A promise if used with async/await, or void if used with a callback.
8595
+ */
8596
+ recommend(
8597
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8598
+ options: StreamMethodOptions
8599
+ ): GaxiosPromise<Readable>;
8600
+ recommend(
8601
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8602
+ options?: MethodOptions
8603
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
8604
+ recommend(
8605
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8606
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
8607
+ callback: BodyResponseCallback<Readable>
8608
+ ): void;
8609
+ recommend(
8610
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8611
+ options:
8612
+ | MethodOptions
8613
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>,
8614
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8615
+ ): void;
8616
+ recommend(
8617
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
8618
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8619
+ ): void;
8620
+ recommend(
8621
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8622
+ ): void;
8623
+ recommend(
8624
+ paramsOrCallback?:
8625
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
8626
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8627
+ | BodyResponseCallback<Readable>,
8628
+ optionsOrCallback?:
8629
+ | MethodOptions
8630
+ | StreamMethodOptions
8631
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8632
+ | BodyResponseCallback<Readable>,
8633
+ callback?:
8634
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8635
+ | BodyResponseCallback<Readable>
8636
+ ):
8637
+ | void
8638
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
8639
+ | GaxiosPromise<Readable> {
8640
+ let params = (paramsOrCallback ||
8641
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
8642
+ let options = (optionsOrCallback || {}) as MethodOptions;
8643
+
8644
+ if (typeof paramsOrCallback === 'function') {
8645
+ callback = paramsOrCallback;
8646
+ params =
8647
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
8648
+ options = {};
8649
+ }
8650
+
8651
+ if (typeof optionsOrCallback === 'function') {
8652
+ callback = optionsOrCallback;
8653
+ options = {};
8654
+ }
8655
+
8656
+ const rootUrl =
8657
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
8658
+ const parameters = {
8659
+ options: Object.assign(
8660
+ {
8661
+ url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace(
8662
+ /([^:]\/)\/+/g,
8033
8663
  '$1'
8034
8664
  ),
8035
8665
  method: 'POST',
@@ -8152,6 +8782,44 @@ export namespace discoveryengine_v1beta {
8152
8782
  }
8153
8783
  }
8154
8784
 
8785
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
8786
+ extends StandardParameters {
8787
+ /**
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\}`
8789
+ */
8790
+ name?: string;
8791
+ }
8792
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
8793
+ extends StandardParameters {
8794
+ /**
8795
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
8796
+ */
8797
+ pageSize?: number;
8798
+ /**
8799
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
8800
+ */
8801
+ pageToken?: string;
8802
+ /**
8803
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
8804
+ */
8805
+ parent?: string;
8806
+ }
8807
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
8808
+ extends StandardParameters {
8809
+ /**
8810
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
8811
+ */
8812
+ name?: string;
8813
+ /**
8814
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
8815
+ */
8816
+ updateMask?: string;
8817
+
8818
+ /**
8819
+ * Request body metadata
8820
+ */
8821
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
8822
+ }
8155
8823
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
8156
8824
  extends StandardParameters {
8157
8825
  /**
@@ -11849,6 +12517,294 @@ export namespace discoveryengine_v1beta {
11849
12517
  this.context = context;
11850
12518
  }
11851
12519
 
12520
+ /**
12521
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
12522
+ *
12523
+ * @param params - Parameters for request
12524
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
12525
+ * @param callback - Optional callback that handles the response.
12526
+ * @returns A promise if used with async/await, or void if used with a callback.
12527
+ */
12528
+ get(
12529
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
12530
+ options: StreamMethodOptions
12531
+ ): GaxiosPromise<Readable>;
12532
+ get(
12533
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
12534
+ options?: MethodOptions
12535
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
12536
+ get(
12537
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
12538
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
12539
+ callback: BodyResponseCallback<Readable>
12540
+ ): void;
12541
+ get(
12542
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
12543
+ options:
12544
+ | MethodOptions
12545
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
12546
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12547
+ ): void;
12548
+ get(
12549
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
12550
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12551
+ ): void;
12552
+ get(
12553
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12554
+ ): void;
12555
+ get(
12556
+ paramsOrCallback?:
12557
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
12558
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12559
+ | BodyResponseCallback<Readable>,
12560
+ optionsOrCallback?:
12561
+ | MethodOptions
12562
+ | StreamMethodOptions
12563
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12564
+ | BodyResponseCallback<Readable>,
12565
+ callback?:
12566
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12567
+ | BodyResponseCallback<Readable>
12568
+ ):
12569
+ | void
12570
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12571
+ | GaxiosPromise<Readable> {
12572
+ let params = (paramsOrCallback ||
12573
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
12574
+ let options = (optionsOrCallback || {}) as MethodOptions;
12575
+
12576
+ if (typeof paramsOrCallback === 'function') {
12577
+ callback = paramsOrCallback;
12578
+ params =
12579
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
12580
+ options = {};
12581
+ }
12582
+
12583
+ if (typeof optionsOrCallback === 'function') {
12584
+ callback = optionsOrCallback;
12585
+ options = {};
12586
+ }
12587
+
12588
+ const rootUrl =
12589
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
12590
+ const parameters = {
12591
+ options: Object.assign(
12592
+ {
12593
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
12594
+ method: 'GET',
12595
+ },
12596
+ options
12597
+ ),
12598
+ params,
12599
+ requiredParams: ['name'],
12600
+ pathParams: ['name'],
12601
+ context: this.context,
12602
+ };
12603
+ if (callback) {
12604
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
12605
+ parameters,
12606
+ callback as BodyResponseCallback<unknown>
12607
+ );
12608
+ } else {
12609
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
12610
+ parameters
12611
+ );
12612
+ }
12613
+ }
12614
+
12615
+ /**
12616
+ * Lists all ServingConfigs linked to this dataStore.
12617
+ *
12618
+ * @param params - Parameters for request
12619
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
12620
+ * @param callback - Optional callback that handles the response.
12621
+ * @returns A promise if used with async/await, or void if used with a callback.
12622
+ */
12623
+ list(
12624
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
12625
+ options: StreamMethodOptions
12626
+ ): GaxiosPromise<Readable>;
12627
+ list(
12628
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
12629
+ options?: MethodOptions
12630
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
12631
+ list(
12632
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
12633
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
12634
+ callback: BodyResponseCallback<Readable>
12635
+ ): void;
12636
+ list(
12637
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
12638
+ options:
12639
+ | MethodOptions
12640
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>,
12641
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
12642
+ ): void;
12643
+ list(
12644
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
12645
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
12646
+ ): void;
12647
+ list(
12648
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
12649
+ ): void;
12650
+ list(
12651
+ paramsOrCallback?:
12652
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
12653
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
12654
+ | BodyResponseCallback<Readable>,
12655
+ optionsOrCallback?:
12656
+ | MethodOptions
12657
+ | StreamMethodOptions
12658
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
12659
+ | BodyResponseCallback<Readable>,
12660
+ callback?:
12661
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
12662
+ | BodyResponseCallback<Readable>
12663
+ ):
12664
+ | void
12665
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
12666
+ | GaxiosPromise<Readable> {
12667
+ let params = (paramsOrCallback ||
12668
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
12669
+ let options = (optionsOrCallback || {}) as MethodOptions;
12670
+
12671
+ if (typeof paramsOrCallback === 'function') {
12672
+ callback = paramsOrCallback;
12673
+ params =
12674
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
12675
+ options = {};
12676
+ }
12677
+
12678
+ if (typeof optionsOrCallback === 'function') {
12679
+ callback = optionsOrCallback;
12680
+ options = {};
12681
+ }
12682
+
12683
+ const rootUrl =
12684
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
12685
+ const parameters = {
12686
+ options: Object.assign(
12687
+ {
12688
+ url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace(
12689
+ /([^:]\/)\/+/g,
12690
+ '$1'
12691
+ ),
12692
+ method: 'GET',
12693
+ },
12694
+ options
12695
+ ),
12696
+ params,
12697
+ requiredParams: ['parent'],
12698
+ pathParams: ['parent'],
12699
+ context: this.context,
12700
+ };
12701
+ if (callback) {
12702
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
12703
+ parameters,
12704
+ callback as BodyResponseCallback<unknown>
12705
+ );
12706
+ } else {
12707
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
12708
+ parameters
12709
+ );
12710
+ }
12711
+ }
12712
+
12713
+ /**
12714
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
12715
+ *
12716
+ * @param params - Parameters for request
12717
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
12718
+ * @param callback - Optional callback that handles the response.
12719
+ * @returns A promise if used with async/await, or void if used with a callback.
12720
+ */
12721
+ patch(
12722
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
12723
+ options: StreamMethodOptions
12724
+ ): GaxiosPromise<Readable>;
12725
+ patch(
12726
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
12727
+ options?: MethodOptions
12728
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
12729
+ patch(
12730
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
12731
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
12732
+ callback: BodyResponseCallback<Readable>
12733
+ ): void;
12734
+ patch(
12735
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
12736
+ options:
12737
+ | MethodOptions
12738
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
12739
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12740
+ ): void;
12741
+ patch(
12742
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
12743
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12744
+ ): void;
12745
+ patch(
12746
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12747
+ ): void;
12748
+ patch(
12749
+ paramsOrCallback?:
12750
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
12751
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12752
+ | BodyResponseCallback<Readable>,
12753
+ optionsOrCallback?:
12754
+ | MethodOptions
12755
+ | StreamMethodOptions
12756
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12757
+ | BodyResponseCallback<Readable>,
12758
+ callback?:
12759
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12760
+ | BodyResponseCallback<Readable>
12761
+ ):
12762
+ | void
12763
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
12764
+ | GaxiosPromise<Readable> {
12765
+ let params = (paramsOrCallback ||
12766
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
12767
+ let options = (optionsOrCallback || {}) as MethodOptions;
12768
+
12769
+ if (typeof paramsOrCallback === 'function') {
12770
+ callback = paramsOrCallback;
12771
+ params =
12772
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
12773
+ options = {};
12774
+ }
12775
+
12776
+ if (typeof optionsOrCallback === 'function') {
12777
+ callback = optionsOrCallback;
12778
+ options = {};
12779
+ }
12780
+
12781
+ const rootUrl =
12782
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
12783
+ const parameters = {
12784
+ options: Object.assign(
12785
+ {
12786
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
12787
+ method: 'PATCH',
12788
+ },
12789
+ options
12790
+ ),
12791
+ params,
12792
+ requiredParams: ['name'],
12793
+ pathParams: ['name'],
12794
+ context: this.context,
12795
+ };
12796
+ if (callback) {
12797
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
12798
+ parameters,
12799
+ callback as BodyResponseCallback<unknown>
12800
+ );
12801
+ } else {
12802
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
12803
+ parameters
12804
+ );
12805
+ }
12806
+ }
12807
+
11852
12808
  /**
11853
12809
  * Makes a recommendation, which requires a contextual user event.
11854
12810
  *
@@ -12045,7 +13001,45 @@ export namespace discoveryengine_v1beta {
12045
13001
  }
12046
13002
  }
12047
13003
  }
12048
-
13004
+
13005
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
13006
+ extends StandardParameters {
13007
+ /**
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\}`
13009
+ */
13010
+ name?: string;
13011
+ }
13012
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
13013
+ extends StandardParameters {
13014
+ /**
13015
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
13016
+ */
13017
+ pageSize?: number;
13018
+ /**
13019
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
13020
+ */
13021
+ pageToken?: string;
13022
+ /**
13023
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
13024
+ */
13025
+ parent?: string;
13026
+ }
13027
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
13028
+ extends StandardParameters {
13029
+ /**
13030
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
13031
+ */
13032
+ name?: string;
13033
+ /**
13034
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
13035
+ */
13036
+ updateMask?: string;
13037
+
13038
+ /**
13039
+ * Request body metadata
13040
+ */
13041
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
13042
+ }
12049
13043
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
12050
13044
  extends StandardParameters {
12051
13045
  /**
@@ -15776,6 +16770,294 @@ export namespace discoveryengine_v1beta {
15776
16770
  this.context = context;
15777
16771
  }
15778
16772
 
16773
+ /**
16774
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
16775
+ *
16776
+ * @param params - Parameters for request
16777
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
16778
+ * @param callback - Optional callback that handles the response.
16779
+ * @returns A promise if used with async/await, or void if used with a callback.
16780
+ */
16781
+ get(
16782
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
16783
+ options: StreamMethodOptions
16784
+ ): GaxiosPromise<Readable>;
16785
+ get(
16786
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
16787
+ options?: MethodOptions
16788
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
16789
+ get(
16790
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
16791
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
16792
+ callback: BodyResponseCallback<Readable>
16793
+ ): void;
16794
+ get(
16795
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
16796
+ options:
16797
+ | MethodOptions
16798
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
16799
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16800
+ ): void;
16801
+ get(
16802
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
16803
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16804
+ ): void;
16805
+ get(
16806
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16807
+ ): void;
16808
+ get(
16809
+ paramsOrCallback?:
16810
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
16811
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16812
+ | BodyResponseCallback<Readable>,
16813
+ optionsOrCallback?:
16814
+ | MethodOptions
16815
+ | StreamMethodOptions
16816
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16817
+ | BodyResponseCallback<Readable>,
16818
+ callback?:
16819
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16820
+ | BodyResponseCallback<Readable>
16821
+ ):
16822
+ | void
16823
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16824
+ | GaxiosPromise<Readable> {
16825
+ let params = (paramsOrCallback ||
16826
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
16827
+ let options = (optionsOrCallback || {}) as MethodOptions;
16828
+
16829
+ if (typeof paramsOrCallback === 'function') {
16830
+ callback = paramsOrCallback;
16831
+ params =
16832
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
16833
+ options = {};
16834
+ }
16835
+
16836
+ if (typeof optionsOrCallback === 'function') {
16837
+ callback = optionsOrCallback;
16838
+ options = {};
16839
+ }
16840
+
16841
+ const rootUrl =
16842
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
16843
+ const parameters = {
16844
+ options: Object.assign(
16845
+ {
16846
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
16847
+ method: 'GET',
16848
+ },
16849
+ options
16850
+ ),
16851
+ params,
16852
+ requiredParams: ['name'],
16853
+ pathParams: ['name'],
16854
+ context: this.context,
16855
+ };
16856
+ if (callback) {
16857
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
16858
+ parameters,
16859
+ callback as BodyResponseCallback<unknown>
16860
+ );
16861
+ } else {
16862
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
16863
+ parameters
16864
+ );
16865
+ }
16866
+ }
16867
+
16868
+ /**
16869
+ * Lists all ServingConfigs linked to this dataStore.
16870
+ *
16871
+ * @param params - Parameters for request
16872
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
16873
+ * @param callback - Optional callback that handles the response.
16874
+ * @returns A promise if used with async/await, or void if used with a callback.
16875
+ */
16876
+ list(
16877
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
16878
+ options: StreamMethodOptions
16879
+ ): GaxiosPromise<Readable>;
16880
+ list(
16881
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
16882
+ options?: MethodOptions
16883
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
16884
+ list(
16885
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
16886
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
16887
+ callback: BodyResponseCallback<Readable>
16888
+ ): void;
16889
+ list(
16890
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
16891
+ options:
16892
+ | MethodOptions
16893
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>,
16894
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
16895
+ ): void;
16896
+ list(
16897
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
16898
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
16899
+ ): void;
16900
+ list(
16901
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
16902
+ ): void;
16903
+ list(
16904
+ paramsOrCallback?:
16905
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
16906
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
16907
+ | BodyResponseCallback<Readable>,
16908
+ optionsOrCallback?:
16909
+ | MethodOptions
16910
+ | StreamMethodOptions
16911
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
16912
+ | BodyResponseCallback<Readable>,
16913
+ callback?:
16914
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
16915
+ | BodyResponseCallback<Readable>
16916
+ ):
16917
+ | void
16918
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
16919
+ | GaxiosPromise<Readable> {
16920
+ let params = (paramsOrCallback ||
16921
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
16922
+ let options = (optionsOrCallback || {}) as MethodOptions;
16923
+
16924
+ if (typeof paramsOrCallback === 'function') {
16925
+ callback = paramsOrCallback;
16926
+ params =
16927
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
16928
+ options = {};
16929
+ }
16930
+
16931
+ if (typeof optionsOrCallback === 'function') {
16932
+ callback = optionsOrCallback;
16933
+ options = {};
16934
+ }
16935
+
16936
+ const rootUrl =
16937
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
16938
+ const parameters = {
16939
+ options: Object.assign(
16940
+ {
16941
+ url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace(
16942
+ /([^:]\/)\/+/g,
16943
+ '$1'
16944
+ ),
16945
+ method: 'GET',
16946
+ },
16947
+ options
16948
+ ),
16949
+ params,
16950
+ requiredParams: ['parent'],
16951
+ pathParams: ['parent'],
16952
+ context: this.context,
16953
+ };
16954
+ if (callback) {
16955
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
16956
+ parameters,
16957
+ callback as BodyResponseCallback<unknown>
16958
+ );
16959
+ } else {
16960
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
16961
+ parameters
16962
+ );
16963
+ }
16964
+ }
16965
+
16966
+ /**
16967
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
16968
+ *
16969
+ * @param params - Parameters for request
16970
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
16971
+ * @param callback - Optional callback that handles the response.
16972
+ * @returns A promise if used with async/await, or void if used with a callback.
16973
+ */
16974
+ patch(
16975
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
16976
+ options: StreamMethodOptions
16977
+ ): GaxiosPromise<Readable>;
16978
+ patch(
16979
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
16980
+ options?: MethodOptions
16981
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
16982
+ patch(
16983
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
16984
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
16985
+ callback: BodyResponseCallback<Readable>
16986
+ ): void;
16987
+ patch(
16988
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
16989
+ options:
16990
+ | MethodOptions
16991
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
16992
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16993
+ ): void;
16994
+ patch(
16995
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
16996
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
16997
+ ): void;
16998
+ patch(
16999
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
17000
+ ): void;
17001
+ patch(
17002
+ paramsOrCallback?:
17003
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
17004
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
17005
+ | BodyResponseCallback<Readable>,
17006
+ optionsOrCallback?:
17007
+ | MethodOptions
17008
+ | StreamMethodOptions
17009
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
17010
+ | BodyResponseCallback<Readable>,
17011
+ callback?:
17012
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
17013
+ | BodyResponseCallback<Readable>
17014
+ ):
17015
+ | void
17016
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
17017
+ | GaxiosPromise<Readable> {
17018
+ let params = (paramsOrCallback ||
17019
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
17020
+ let options = (optionsOrCallback || {}) as MethodOptions;
17021
+
17022
+ if (typeof paramsOrCallback === 'function') {
17023
+ callback = paramsOrCallback;
17024
+ params =
17025
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
17026
+ options = {};
17027
+ }
17028
+
17029
+ if (typeof optionsOrCallback === 'function') {
17030
+ callback = optionsOrCallback;
17031
+ options = {};
17032
+ }
17033
+
17034
+ const rootUrl =
17035
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
17036
+ const parameters = {
17037
+ options: Object.assign(
17038
+ {
17039
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
17040
+ method: 'PATCH',
17041
+ },
17042
+ options
17043
+ ),
17044
+ params,
17045
+ requiredParams: ['name'],
17046
+ pathParams: ['name'],
17047
+ context: this.context,
17048
+ };
17049
+ if (callback) {
17050
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
17051
+ parameters,
17052
+ callback as BodyResponseCallback<unknown>
17053
+ );
17054
+ } else {
17055
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
17056
+ parameters
17057
+ );
17058
+ }
17059
+ }
17060
+
15779
17061
  /**
15780
17062
  * Makes a recommendation, which requires a contextual user event.
15781
17063
  *
@@ -15973,6 +17255,44 @@ export namespace discoveryengine_v1beta {
15973
17255
  }
15974
17256
  }
15975
17257
 
17258
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
17259
+ extends StandardParameters {
17260
+ /**
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\}`
17262
+ */
17263
+ name?: string;
17264
+ }
17265
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
17266
+ extends StandardParameters {
17267
+ /**
17268
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
17269
+ */
17270
+ pageSize?: number;
17271
+ /**
17272
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
17273
+ */
17274
+ pageToken?: string;
17275
+ /**
17276
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
17277
+ */
17278
+ parent?: string;
17279
+ }
17280
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
17281
+ extends StandardParameters {
17282
+ /**
17283
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
17284
+ */
17285
+ name?: string;
17286
+ /**
17287
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
17288
+ */
17289
+ updateMask?: string;
17290
+
17291
+ /**
17292
+ * Request body metadata
17293
+ */
17294
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
17295
+ }
15976
17296
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend
15977
17297
  extends StandardParameters {
15978
17298
  /**