@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240131 → 0.0.20240213

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +444 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20240131
12
+ // Revision: 20240213
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -237,6 +237,10 @@ declare namespace gapi.client {
237
237
  /** The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. */
238
238
  text?: string[];
239
239
  }
240
+ interface GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
241
+ /** Whether or not to enable and include custom fine tuned search adaptor model. */
242
+ enableSearchAdaptor?: boolean;
243
+ }
240
244
  interface GoogleCloudDiscoveryengineV1alphaDataStore {
241
245
  /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
242
246
  contentConfig?: string;
@@ -348,6 +352,10 @@ declare namespace gapi.client {
348
352
  /** Double values. */
349
353
  values?: number[];
350
354
  }
355
+ interface GoogleCloudDiscoveryengineV1alphaEmbeddingConfig {
356
+ /** Full field path in the schema mapped as embedding field. */
357
+ fieldPath?: string;
358
+ }
351
359
  interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata {
352
360
  /** Operation create time. */
353
361
  createTime?: string;
@@ -511,6 +519,14 @@ declare namespace gapi.client {
511
519
  /** Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
512
520
  inputUris?: string[];
513
521
  }
522
+ interface GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
523
+ /** Whether or not to enable and include refinement attributes in gudied search result. */
524
+ enableRefinementAttributes?: boolean;
525
+ /** Whether or not to enable and include related questions in search response. */
526
+ enableRelatedQuestions?: boolean;
527
+ /** Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3. */
528
+ maxRelatedQuestions?: number;
529
+ }
514
530
  interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
515
531
  /** Operation create time. */
516
532
  createTime?: string;
@@ -650,6 +666,12 @@ declare namespace gapi.client {
650
666
  /** The Schemas. */
651
667
  schemas?: GoogleCloudDiscoveryengineV1alphaSchema[];
652
668
  }
669
+ interface GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse {
670
+ /** Pagination token, if not returned indicates the last page. */
671
+ nextPageToken?: string;
672
+ /** All the ServingConfigs for a given dataStore. */
673
+ servingConfigs?: GoogleCloudDiscoveryengineV1alphaServingConfig[];
674
+ }
653
675
  interface GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse {
654
676
  /** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
655
677
  nextPageToken?: string;
@@ -1107,6 +1129,7 @@ declare namespace gapi.client {
1107
1129
  summarySkippedReasons?: string[];
1108
1130
  /** The summary content. */
1109
1131
  summaryText?: string;
1132
+ /** Summary with metadata information. */
1110
1133
  summaryWithMetadata?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
1111
1134
  }
1112
1135
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation {
@@ -1147,6 +1170,66 @@ declare namespace gapi.client {
1147
1170
  /** Summary text with no citation information. */
1148
1171
  summary?: string;
1149
1172
  }
1173
+ interface GoogleCloudDiscoveryengineV1alphaServingConfig {
1174
+ /** 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. */
1175
+ boostControlIds?: string[];
1176
+ /** Output only. ServingConfig created timestamp. */
1177
+ createTime?: string;
1178
+ /** Custom fine tuning configs. */
1179
+ customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
1180
+ /** 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. */
1181
+ displayName?: string;
1182
+ /** 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. */
1183
+ dissociateControlIds?: string[];
1184
+ /** 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. */
1185
+ diversityLevel?: string;
1186
+ /** 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. */
1187
+ embeddingConfig?: GoogleCloudDiscoveryengineV1alphaEmbeddingConfig;
1188
+ /** 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. */
1189
+ filterControlIds?: string[];
1190
+ /** The GenericConfig of the serving configuration. */
1191
+ genericConfig?: GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig;
1192
+ /** Guided search configs. */
1193
+ guidedSearchSpec?: GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec;
1194
+ /** 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. */
1195
+ ignoreControlIds?: string[];
1196
+ /** The MediaConfig of the serving configuration. */
1197
+ mediaConfig?: GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
1198
+ /** 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. */
1199
+ modelId?: string;
1200
+ /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` */
1201
+ name?: string;
1202
+ /** 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. */
1203
+ onewaySynonymsControlIds?: string[];
1204
+ /** 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). */
1205
+ rankingExpression?: string;
1206
+ /** 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. */
1207
+ redirectControlIds?: string[];
1208
+ /** 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. */
1209
+ replacementControlIds?: string[];
1210
+ /** Required. Immutable. Specifies the solution type that a serving config can be associated with. */
1211
+ solutionType?: string;
1212
+ /** 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. */
1213
+ synonymsControlIds?: string[];
1214
+ /** Output only. ServingConfig updated timestamp. */
1215
+ updateTime?: string;
1216
+ }
1217
+ interface GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
1218
+ /** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
1219
+ contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
1220
+ }
1221
+ interface GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
1222
+ /** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
1223
+ contentFreshnessCutoffDays?: number;
1224
+ /** Specifies the content watched minutes threshold for demotion. */
1225
+ contentWatchedMinutesThreshold?: number;
1226
+ /** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
1227
+ contentWatchedPercentageThreshold?: number;
1228
+ /** Specifies the content watched minutes threshold for demotion. */
1229
+ contentWatchedSecondsThreshold?: number;
1230
+ /** 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. */
1231
+ demotionEventType?: string;
1232
+ }
1150
1233
  interface GoogleCloudDiscoveryengineV1alphaSiteSearchEngine {
1151
1234
  /** The fully qualified resource name of the site search engine. Format: `projects/*‍/locations/*‍/dataStores/*‍/siteSearchEngine` */
1152
1235
  name?: string;
@@ -3375,6 +3458,126 @@ declare namespace gapi.client {
3375
3458
  operations: OperationsResource;
3376
3459
  }
3377
3460
  interface ServingConfigsResource {
3461
+ /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
3462
+ get(request?: {
3463
+ /** V1 error format. */
3464
+ '$.xgafv'?: string;
3465
+ /** OAuth access token. */
3466
+ access_token?: string;
3467
+ /** Data format for response. */
3468
+ alt?: string;
3469
+ /** JSONP */
3470
+ callback?: string;
3471
+ /** Selector specifying which fields to include in a partial response. */
3472
+ fields?: string;
3473
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3474
+ key?: string;
3475
+ /** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}` */
3476
+ name: string;
3477
+ /** OAuth 2.0 token for the current user. */
3478
+ oauth_token?: string;
3479
+ /** Returns response with indentations and line breaks. */
3480
+ prettyPrint?: boolean;
3481
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3482
+ quotaUser?: string;
3483
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3484
+ upload_protocol?: string;
3485
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3486
+ uploadType?: string;
3487
+ }): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
3488
+ /** Lists all ServingConfigs linked to this dataStore. */
3489
+ list(request?: {
3490
+ /** V1 error format. */
3491
+ '$.xgafv'?: string;
3492
+ /** OAuth access token. */
3493
+ access_token?: string;
3494
+ /** Data format for response. */
3495
+ alt?: string;
3496
+ /** JSONP */
3497
+ callback?: string;
3498
+ /** Selector specifying which fields to include in a partial response. */
3499
+ fields?: string;
3500
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3501
+ key?: string;
3502
+ /** OAuth 2.0 token for the current user. */
3503
+ oauth_token?: string;
3504
+ /** 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. */
3505
+ pageSize?: number;
3506
+ /** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
3507
+ pageToken?: string;
3508
+ /** Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
3509
+ parent: string;
3510
+ /** Returns response with indentations and line breaks. */
3511
+ prettyPrint?: boolean;
3512
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3513
+ quotaUser?: string;
3514
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3515
+ upload_protocol?: string;
3516
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3517
+ uploadType?: string;
3518
+ }): Request<GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
3519
+ /** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
3520
+ patch(request: {
3521
+ /** V1 error format. */
3522
+ '$.xgafv'?: string;
3523
+ /** OAuth access token. */
3524
+ access_token?: string;
3525
+ /** Data format for response. */
3526
+ alt?: string;
3527
+ /** JSONP */
3528
+ callback?: string;
3529
+ /** Selector specifying which fields to include in a partial response. */
3530
+ fields?: string;
3531
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3532
+ key?: string;
3533
+ /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` */
3534
+ name: string;
3535
+ /** OAuth 2.0 token for the current user. */
3536
+ oauth_token?: string;
3537
+ /** Returns response with indentations and line breaks. */
3538
+ prettyPrint?: boolean;
3539
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3540
+ quotaUser?: string;
3541
+ /** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
3542
+ updateMask?: string;
3543
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3544
+ upload_protocol?: string;
3545
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3546
+ uploadType?: string;
3547
+ /** Request body */
3548
+ resource: GoogleCloudDiscoveryengineV1alphaServingConfig;
3549
+ }): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
3550
+ patch(
3551
+ request: {
3552
+ /** V1 error format. */
3553
+ '$.xgafv'?: string;
3554
+ /** OAuth access token. */
3555
+ access_token?: string;
3556
+ /** Data format for response. */
3557
+ alt?: string;
3558
+ /** JSONP */
3559
+ callback?: string;
3560
+ /** Selector specifying which fields to include in a partial response. */
3561
+ fields?: string;
3562
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3563
+ key?: string;
3564
+ /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` */
3565
+ name: string;
3566
+ /** OAuth 2.0 token for the current user. */
3567
+ oauth_token?: string;
3568
+ /** Returns response with indentations and line breaks. */
3569
+ prettyPrint?: boolean;
3570
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3571
+ quotaUser?: string;
3572
+ /** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
3573
+ updateMask?: string;
3574
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3575
+ upload_protocol?: string;
3576
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3577
+ uploadType?: string;
3578
+ },
3579
+ body: GoogleCloudDiscoveryengineV1alphaServingConfig
3580
+ ): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
3378
3581
  /** Makes a recommendation, which requires a contextual user event. */
3379
3582
  recommend(request: {
3380
3583
  /** V1 error format. */
@@ -5239,6 +5442,126 @@ declare namespace gapi.client {
5239
5442
  }): Request<GoogleLongrunningListOperationsResponse>;
5240
5443
  }
5241
5444
  interface ServingConfigsResource {
5445
+ /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
5446
+ get(request?: {
5447
+ /** V1 error format. */
5448
+ '$.xgafv'?: string;
5449
+ /** OAuth access token. */
5450
+ access_token?: string;
5451
+ /** Data format for response. */
5452
+ alt?: string;
5453
+ /** JSONP */
5454
+ callback?: string;
5455
+ /** Selector specifying which fields to include in a partial response. */
5456
+ fields?: string;
5457
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
5458
+ key?: string;
5459
+ /** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}` */
5460
+ name: string;
5461
+ /** OAuth 2.0 token for the current user. */
5462
+ oauth_token?: string;
5463
+ /** Returns response with indentations and line breaks. */
5464
+ prettyPrint?: boolean;
5465
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
5466
+ quotaUser?: string;
5467
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5468
+ upload_protocol?: string;
5469
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5470
+ uploadType?: string;
5471
+ }): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
5472
+ /** Lists all ServingConfigs linked to this dataStore. */
5473
+ list(request?: {
5474
+ /** V1 error format. */
5475
+ '$.xgafv'?: string;
5476
+ /** OAuth access token. */
5477
+ access_token?: string;
5478
+ /** Data format for response. */
5479
+ alt?: string;
5480
+ /** JSONP */
5481
+ callback?: string;
5482
+ /** Selector specifying which fields to include in a partial response. */
5483
+ fields?: string;
5484
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
5485
+ key?: string;
5486
+ /** OAuth 2.0 token for the current user. */
5487
+ oauth_token?: string;
5488
+ /** 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. */
5489
+ pageSize?: number;
5490
+ /** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
5491
+ pageToken?: string;
5492
+ /** Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
5493
+ parent: string;
5494
+ /** Returns response with indentations and line breaks. */
5495
+ prettyPrint?: boolean;
5496
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
5497
+ quotaUser?: string;
5498
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5499
+ upload_protocol?: string;
5500
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5501
+ uploadType?: string;
5502
+ }): Request<GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
5503
+ /** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
5504
+ patch(request: {
5505
+ /** V1 error format. */
5506
+ '$.xgafv'?: string;
5507
+ /** OAuth access token. */
5508
+ access_token?: string;
5509
+ /** Data format for response. */
5510
+ alt?: string;
5511
+ /** JSONP */
5512
+ callback?: string;
5513
+ /** Selector specifying which fields to include in a partial response. */
5514
+ fields?: string;
5515
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
5516
+ key?: string;
5517
+ /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` */
5518
+ name: string;
5519
+ /** OAuth 2.0 token for the current user. */
5520
+ oauth_token?: string;
5521
+ /** Returns response with indentations and line breaks. */
5522
+ prettyPrint?: boolean;
5523
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
5524
+ quotaUser?: string;
5525
+ /** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
5526
+ updateMask?: string;
5527
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5528
+ upload_protocol?: string;
5529
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5530
+ uploadType?: string;
5531
+ /** Request body */
5532
+ resource: GoogleCloudDiscoveryengineV1alphaServingConfig;
5533
+ }): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
5534
+ patch(
5535
+ request: {
5536
+ /** V1 error format. */
5537
+ '$.xgafv'?: string;
5538
+ /** OAuth access token. */
5539
+ access_token?: string;
5540
+ /** Data format for response. */
5541
+ alt?: string;
5542
+ /** JSONP */
5543
+ callback?: string;
5544
+ /** Selector specifying which fields to include in a partial response. */
5545
+ fields?: string;
5546
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
5547
+ key?: string;
5548
+ /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` */
5549
+ name: string;
5550
+ /** OAuth 2.0 token for the current user. */
5551
+ oauth_token?: string;
5552
+ /** Returns response with indentations and line breaks. */
5553
+ prettyPrint?: boolean;
5554
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
5555
+ quotaUser?: string;
5556
+ /** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
5557
+ updateMask?: string;
5558
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5559
+ upload_protocol?: string;
5560
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5561
+ uploadType?: string;
5562
+ },
5563
+ body: GoogleCloudDiscoveryengineV1alphaServingConfig
5564
+ ): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
5242
5565
  /** Makes a recommendation, which requires a contextual user event. */
5243
5566
  recommend(request: {
5244
5567
  /** V1 error format. */
@@ -6815,6 +7138,126 @@ declare namespace gapi.client {
6815
7138
  ): Request<GoogleLongrunningOperation>;
6816
7139
  }
6817
7140
  interface ServingConfigsResource {
7141
+ /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
7142
+ get(request?: {
7143
+ /** V1 error format. */
7144
+ '$.xgafv'?: string;
7145
+ /** OAuth access token. */
7146
+ access_token?: string;
7147
+ /** Data format for response. */
7148
+ alt?: string;
7149
+ /** JSONP */
7150
+ callback?: string;
7151
+ /** Selector specifying which fields to include in a partial response. */
7152
+ fields?: string;
7153
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
7154
+ key?: string;
7155
+ /** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}` */
7156
+ name: string;
7157
+ /** OAuth 2.0 token for the current user. */
7158
+ oauth_token?: string;
7159
+ /** Returns response with indentations and line breaks. */
7160
+ prettyPrint?: boolean;
7161
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
7162
+ quotaUser?: string;
7163
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7164
+ upload_protocol?: string;
7165
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7166
+ uploadType?: string;
7167
+ }): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
7168
+ /** Lists all ServingConfigs linked to this dataStore. */
7169
+ list(request?: {
7170
+ /** V1 error format. */
7171
+ '$.xgafv'?: string;
7172
+ /** OAuth access token. */
7173
+ access_token?: string;
7174
+ /** Data format for response. */
7175
+ alt?: string;
7176
+ /** JSONP */
7177
+ callback?: string;
7178
+ /** Selector specifying which fields to include in a partial response. */
7179
+ fields?: string;
7180
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
7181
+ key?: string;
7182
+ /** OAuth 2.0 token for the current user. */
7183
+ oauth_token?: string;
7184
+ /** 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. */
7185
+ pageSize?: number;
7186
+ /** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
7187
+ pageToken?: string;
7188
+ /** Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
7189
+ parent: string;
7190
+ /** Returns response with indentations and line breaks. */
7191
+ prettyPrint?: boolean;
7192
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
7193
+ quotaUser?: string;
7194
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7195
+ upload_protocol?: string;
7196
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7197
+ uploadType?: string;
7198
+ }): Request<GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
7199
+ /** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
7200
+ patch(request: {
7201
+ /** V1 error format. */
7202
+ '$.xgafv'?: string;
7203
+ /** OAuth access token. */
7204
+ access_token?: string;
7205
+ /** Data format for response. */
7206
+ alt?: string;
7207
+ /** JSONP */
7208
+ callback?: string;
7209
+ /** Selector specifying which fields to include in a partial response. */
7210
+ fields?: string;
7211
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
7212
+ key?: string;
7213
+ /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` */
7214
+ name: string;
7215
+ /** OAuth 2.0 token for the current user. */
7216
+ oauth_token?: string;
7217
+ /** Returns response with indentations and line breaks. */
7218
+ prettyPrint?: boolean;
7219
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
7220
+ quotaUser?: string;
7221
+ /** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
7222
+ updateMask?: string;
7223
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7224
+ upload_protocol?: string;
7225
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7226
+ uploadType?: string;
7227
+ /** Request body */
7228
+ resource: GoogleCloudDiscoveryengineV1alphaServingConfig;
7229
+ }): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
7230
+ patch(
7231
+ request: {
7232
+ /** V1 error format. */
7233
+ '$.xgafv'?: string;
7234
+ /** OAuth access token. */
7235
+ access_token?: string;
7236
+ /** Data format for response. */
7237
+ alt?: string;
7238
+ /** JSONP */
7239
+ callback?: string;
7240
+ /** Selector specifying which fields to include in a partial response. */
7241
+ fields?: string;
7242
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
7243
+ key?: string;
7244
+ /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` */
7245
+ name: string;
7246
+ /** OAuth 2.0 token for the current user. */
7247
+ oauth_token?: string;
7248
+ /** Returns response with indentations and line breaks. */
7249
+ prettyPrint?: boolean;
7250
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
7251
+ quotaUser?: string;
7252
+ /** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
7253
+ updateMask?: string;
7254
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7255
+ upload_protocol?: string;
7256
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7257
+ uploadType?: string;
7258
+ },
7259
+ body: GoogleCloudDiscoveryengineV1alphaServingConfig
7260
+ ): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
6818
7261
  /** Makes a recommendation, which requires a contextual user event. */
6819
7262
  recommend(request: {
6820
7263
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20240131",
3
+ "version": "0.0.20240213",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",