@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241219 → 0.0.20250107

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 +121 -21
  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=v1
12
- // Revision: 20241219
12
+ // Revision: 20250107
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -158,7 +158,12 @@ declare namespace gapi.client {
158
158
  /** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
159
159
  functionName?: string;
160
160
  }
161
- interface GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {}
161
+ interface GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {
162
+ /** If set true, automatic refresh is disabled for the DataStore. */
163
+ disableAutomaticRefresh?: boolean;
164
+ /** If set true, initial indexing is disabled for the DataStore. */
165
+ disableInitialIndex?: boolean;
166
+ }
162
167
  interface GoogleCloudDiscoveryengineV1AlloyDbSource {
163
168
  /** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
164
169
  clusterId?: string;
@@ -214,6 +219,8 @@ declare namespace gapi.client {
214
219
  references?: GoogleCloudDiscoveryengineV1alphaAnswerReference[];
215
220
  /** Suggested related questions. */
216
221
  relatedQuestions?: string[];
222
+ /** Optional. Safety ratings. */
223
+ safetyRatings?: GoogleCloudDiscoveryengineV1alphaSafetyRating[];
217
224
  /** The state of the answer generation. */
218
225
  state?: string;
219
226
  /** Answer generation steps. */
@@ -390,7 +397,7 @@ declare namespace gapi.client {
390
397
  interface GoogleCloudDiscoveryengineV1alphaCollection {
391
398
  /** Output only. Timestamp the Collection was created at. */
392
399
  createTime?: string;
393
- /** Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnector.GetDataConnector method. */
400
+ /** Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. */
394
401
  dataConnector?: GoogleCloudDiscoveryengineV1alphaDataConnector;
395
402
  /** Required. The Collection 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. */
396
403
  displayName?: string;
@@ -484,12 +491,14 @@ declare namespace gapi.client {
484
491
  useCases?: string[];
485
492
  }
486
493
  interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
487
- /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
494
+ /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
488
495
  boost?: number;
489
496
  /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
490
497
  dataStore?: string;
491
498
  /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
492
499
  filter?: string;
500
+ /** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
501
+ fixedBoost?: number;
493
502
  }
494
503
  interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
495
504
  /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
@@ -692,6 +701,12 @@ declare namespace gapi.client {
692
701
  /** Operation last update time. If the operation is done, this is also the finish time. */
693
702
  updateTime?: string;
694
703
  }
704
+ interface GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata {
705
+ /** Operation create time. */
706
+ createTime?: string;
707
+ /** Operation last update time. If the operation is done, this is also the finish time. */
708
+ updateTime?: string;
709
+ }
695
710
  interface GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata {
696
711
  /** Operation create time. */
697
712
  createTime?: string;
@@ -952,6 +967,8 @@ declare namespace gapi.client {
952
967
  documentDataMap?: {[P in string]: {[P in string]: any}};
953
968
  }
954
969
  interface GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig {
970
+ /** Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. */
971
+ nextSyncTime?: GoogleTypeDateTime;
955
972
  /** Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. */
956
973
  refreshInterval?: string;
957
974
  }
@@ -1262,6 +1279,32 @@ declare namespace gapi.client {
1262
1279
  /** Reason why the URI was not crawled. */
1263
1280
  errorMessage?: string;
1264
1281
  }
1282
+ interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata {
1283
+ /** Operation create time. */
1284
+ createTime?: string;
1285
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1286
+ updateTime?: string;
1287
+ }
1288
+ interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse {
1289
+ /** Errors from service when handling the request. */
1290
+ error?: GoogleRpcStatus;
1291
+ /** Output only. The state of the response. */
1292
+ state?: string;
1293
+ }
1294
+ interface GoogleCloudDiscoveryengineV1alphaSafetyRating {
1295
+ /** Output only. Indicates whether the content was filtered out because of this rating. */
1296
+ blocked?: boolean;
1297
+ /** Output only. Harm category. */
1298
+ category?: string;
1299
+ /** Output only. Harm probability levels in the content. */
1300
+ probability?: string;
1301
+ /** Output only. Harm probability score. */
1302
+ probabilityScore?: number;
1303
+ /** Output only. Harm severity levels in the content. */
1304
+ severity?: string;
1305
+ /** Output only. Harm severity score. */
1306
+ severityScore?: number;
1307
+ }
1265
1308
  interface GoogleCloudDiscoveryengineV1alphaSchema {
1266
1309
  /** Output only. Configurations for fields of the schema. */
1267
1310
  fieldConfigs?: GoogleCloudDiscoveryengineV1alphaFieldConfig[];
@@ -1497,7 +1540,7 @@ declare namespace gapi.client {
1497
1540
  imageBytes?: string;
1498
1541
  }
1499
1542
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
1500
- /** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
1543
+ /** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
1501
1544
  filterExtractionCondition?: string;
1502
1545
  /** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
1503
1546
  geoSearchQueryDetectionFieldNames?: string[];
@@ -1552,6 +1595,18 @@ declare namespace gapi.client {
1552
1595
  /** The user query. */
1553
1596
  query?: GoogleCloudDiscoveryengineV1alphaQuery;
1554
1597
  }
1598
+ interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata {
1599
+ /** Operation create time. */
1600
+ createTime?: string;
1601
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1602
+ updateTime?: string;
1603
+ }
1604
+ interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse {
1605
+ /** Errors from service when handling the request. */
1606
+ error?: GoogleRpcStatus;
1607
+ /** Output only. The state of the response. */
1608
+ state?: string;
1609
+ }
1555
1610
  interface GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata {}
1556
1611
  interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata {
1557
1612
  /** Operation create time. */
@@ -1579,7 +1634,7 @@ declare namespace gapi.client {
1579
1634
  verifyTime?: string;
1580
1635
  }
1581
1636
  interface GoogleCloudDiscoveryengineV1alphaTargetSite {
1582
- /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
1637
+ /** Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
1583
1638
  exactMatch?: boolean;
1584
1639
  /** Output only. Failure reason. */
1585
1640
  failureReason?: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason;
@@ -1700,6 +1755,8 @@ declare namespace gapi.client {
1700
1755
  references?: GoogleCloudDiscoveryengineV1AnswerReference[];
1701
1756
  /** Suggested related questions. */
1702
1757
  relatedQuestions?: string[];
1758
+ /** Optional. Safety ratings. */
1759
+ safetyRatings?: GoogleCloudDiscoveryengineV1SafetyRating[];
1703
1760
  /** The state of the answer generation. */
1704
1761
  state?: string;
1705
1762
  /** Answer generation steps. */
@@ -1814,6 +1871,14 @@ declare namespace gapi.client {
1814
1871
  interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec {
1815
1872
  /** Enable the safety filtering on the answer response. It is false by default. */
1816
1873
  enable?: boolean;
1874
+ /** Optional. Safety settings. This settings are effective only when the safety_spec.enable is true. */
1875
+ safetySettings?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting[];
1876
+ }
1877
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting {
1878
+ /** Required. Harm category. */
1879
+ category?: string;
1880
+ /** Required. The harm block threshold. */
1881
+ threshold?: string;
1817
1882
  }
1818
1883
  interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec {
1819
1884
  /** Search parameters. */
@@ -2052,7 +2117,12 @@ declare namespace gapi.client {
2052
2117
  uri?: string;
2053
2118
  }
2054
2119
  interface GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {}
2055
- interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {}
2120
+ interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {
2121
+ /** If set true, automatic refresh is disabled for the DataStore. */
2122
+ disableAutomaticRefresh?: boolean;
2123
+ /** If set true, initial indexing is disabled for the DataStore. */
2124
+ disableInitialIndex?: boolean;
2125
+ }
2056
2126
  interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
2057
2127
  /** Operation create time. */
2058
2128
  createTime?: string;
@@ -2124,12 +2194,14 @@ declare namespace gapi.client {
2124
2194
  useCases?: string[];
2125
2195
  }
2126
2196
  interface GoogleCloudDiscoveryengineV1betaControlBoostAction {
2127
- /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
2197
+ /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
2128
2198
  boost?: number;
2129
2199
  /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
2130
2200
  dataStore?: string;
2131
2201
  /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
2132
2202
  filter?: string;
2203
+ /** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
2204
+ fixedBoost?: number;
2133
2205
  }
2134
2206
  interface GoogleCloudDiscoveryengineV1betaControlFilterAction {
2135
2207
  /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
@@ -2184,7 +2256,7 @@ declare namespace gapi.client {
2184
2256
  }
2185
2257
  interface GoogleCloudDiscoveryengineV1betaDataStore {
2186
2258
  /** Optional. Configuration for advanced site search. */
2187
- advancedSiteSearchConfig?: any;
2259
+ advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig;
2188
2260
  /** Output only. Data size estimation for billing. */
2189
2261
  billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
2190
2262
  /** Output only. CMEK-related information for the DataStore. */
@@ -2250,6 +2322,12 @@ declare namespace gapi.client {
2250
2322
  /** Operation last update time. If the operation is done, this is also the finish time. */
2251
2323
  updateTime?: string;
2252
2324
  }
2325
+ interface GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata {
2326
+ /** Operation create time. */
2327
+ createTime?: string;
2328
+ /** Operation last update time. If the operation is done, this is also the finish time. */
2329
+ updateTime?: string;
2330
+ }
2253
2331
  interface GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
2254
2332
  /** Operation create time. */
2255
2333
  createTime?: string;
@@ -2834,7 +2912,7 @@ declare namespace gapi.client {
2834
2912
  imageBytes?: string;
2835
2913
  }
2836
2914
  interface GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
2837
- /** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
2915
+ /** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
2838
2916
  filterExtractionCondition?: string;
2839
2917
  /** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
2840
2918
  geoSearchQueryDetectionFieldNames?: string[];
@@ -2882,7 +2960,7 @@ declare namespace gapi.client {
2882
2960
  verifyTime?: string;
2883
2961
  }
2884
2962
  interface GoogleCloudDiscoveryengineV1betaTargetSite {
2885
- /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
2963
+ /** Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
2886
2964
  exactMatch?: boolean;
2887
2965
  /** Output only. Failure reason. */
2888
2966
  failureReason?: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
@@ -3201,12 +3279,14 @@ declare namespace gapi.client {
3201
3279
  useCases?: string[];
3202
3280
  }
3203
3281
  interface GoogleCloudDiscoveryengineV1ControlBoostAction {
3204
- /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
3282
+ /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
3205
3283
  boost?: number;
3206
3284
  /** Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
3207
3285
  dataStore?: string;
3208
3286
  /** Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
3209
3287
  filter?: string;
3288
+ /** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
3289
+ fixedBoost?: number;
3210
3290
  }
3211
3291
  interface GoogleCloudDiscoveryengineV1ControlFilterAction {
3212
3292
  /** Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */
@@ -3338,7 +3418,7 @@ declare namespace gapi.client {
3338
3418
  }
3339
3419
  interface GoogleCloudDiscoveryengineV1DataStore {
3340
3420
  /** Optional. Configuration for advanced site search. */
3341
- advancedSiteSearchConfig?: any;
3421
+ advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig;
3342
3422
  /** Output only. Data size estimation for billing. */
3343
3423
  billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
3344
3424
  /** Output only. CMEK-related information for the DataStore. */
@@ -3400,6 +3480,12 @@ declare namespace gapi.client {
3400
3480
  /** Operation last update time. If the operation is done, this is also the finish time. */
3401
3481
  updateTime?: string;
3402
3482
  }
3483
+ interface GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata {
3484
+ /** Operation create time. */
3485
+ createTime?: string;
3486
+ /** Operation last update time. If the operation is done, this is also the finish time. */
3487
+ updateTime?: string;
3488
+ }
3403
3489
  interface GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
3404
3490
  /** Operation create time. */
3405
3491
  createTime?: string;
@@ -3425,7 +3511,7 @@ declare namespace gapi.client {
3425
3511
  content?: GoogleCloudDiscoveryengineV1DocumentContent;
3426
3512
  /** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
3427
3513
  derivedStructData?: {[P in string]: any};
3428
- /** 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. */
3514
+ /** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. */
3429
3515
  id?: string;
3430
3516
  /** Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. */
3431
3517
  indexStatus?: GoogleCloudDiscoveryengineV1DocumentIndexStatus;
@@ -4170,7 +4256,7 @@ declare namespace gapi.client {
4170
4256
  metadata?: {[P in string]: any};
4171
4257
  }
4172
4258
  interface GoogleCloudDiscoveryengineV1RecrawlUrisRequest {
4173
- /** Optional. Full resource name of the SiteCredential, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
4259
+ /** Optional. Full resource name of the `SiteCredential`, such as `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
4174
4260
  siteCredential?: string;
4175
4261
  /** Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. */
4176
4262
  uris?: string[];
@@ -4179,6 +4265,20 @@ declare namespace gapi.client {
4179
4265
  /** Summary based on search results. */
4180
4266
  summary?: GoogleCloudDiscoveryengineV1SearchResponseSummary;
4181
4267
  }
4268
+ interface GoogleCloudDiscoveryengineV1SafetyRating {
4269
+ /** Output only. Indicates whether the content was filtered out because of this rating. */
4270
+ blocked?: boolean;
4271
+ /** Output only. Harm category. */
4272
+ category?: string;
4273
+ /** Output only. Harm probability levels in the content. */
4274
+ probability?: string;
4275
+ /** Output only. Harm probability score. */
4276
+ probabilityScore?: number;
4277
+ /** Output only. Harm severity levels in the content. */
4278
+ severity?: string;
4279
+ /** Output only. Harm severity score. */
4280
+ severityScore?: number;
4281
+ }
4182
4282
  interface GoogleCloudDiscoveryengineV1Schema {
4183
4283
  /** The JSON representation of the schema. */
4184
4284
  jsonSchema?: string;
@@ -4556,7 +4656,7 @@ declare namespace gapi.client {
4556
4656
  onewaySynonymsControlIds?: string[];
4557
4657
  /** Condition promote specifications. Maximum number of specifications is 100. */
4558
4658
  promoteControlIds?: string[];
4559
- /** 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)`. */
4659
+ /** 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)`. */
4560
4660
  rankingExpression?: string;
4561
4661
  /** 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. */
4562
4662
  redirectControlIds?: string[];
@@ -4644,7 +4744,7 @@ declare namespace gapi.client {
4644
4744
  matchOperator?: string;
4645
4745
  }
4646
4746
  interface GoogleCloudDiscoveryengineV1TargetSite {
4647
- /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
4747
+ /** Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
4648
4748
  exactMatch?: boolean;
4649
4749
  /** Output only. Failure reason. */
4650
4750
  failureReason?: GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
@@ -4991,7 +5091,7 @@ declare namespace gapi.client {
4991
5091
  alt?: string;
4992
5092
  /** JSONP */
4993
5093
  callback?: string;
4994
- /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5094
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
4995
5095
  documentId?: string;
4996
5096
  /** Selector specifying which fields to include in a partial response. */
4997
5097
  fields?: string;
@@ -5022,7 +5122,7 @@ declare namespace gapi.client {
5022
5122
  alt?: string;
5023
5123
  /** JSONP */
5024
5124
  callback?: string;
5025
- /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5125
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5026
5126
  documentId?: string;
5027
5127
  /** Selector specifying which fields to include in a partial response. */
5028
5128
  fields?: string;
@@ -9877,7 +9977,7 @@ declare namespace gapi.client {
9877
9977
  alt?: string;
9878
9978
  /** JSONP */
9879
9979
  callback?: string;
9880
- /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
9980
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
9881
9981
  documentId?: string;
9882
9982
  /** Selector specifying which fields to include in a partial response. */
9883
9983
  fields?: string;
@@ -9908,7 +10008,7 @@ declare namespace gapi.client {
9908
10008
  alt?: string;
9909
10009
  /** JSONP */
9910
10010
  callback?: string;
9911
- /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
10011
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
9912
10012
  documentId?: string;
9913
10013
  /** Selector specifying which fields to include in a partial response. */
9914
10014
  fields?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
3
- "version": "0.0.20241219",
3
+ "version": "0.0.20250107",
4
4
  "description": "TypeScript typings for Discovery Engine API v1",
5
5
  "repository": {
6
6
  "type": "git",