@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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.
- package/index.d.ts +302 -26
- 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:
|
|
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 GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
163
168
|
/** Identity provider config. */
|
|
164
169
|
idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
@@ -286,6 +291,8 @@ declare namespace gapi.client {
|
|
|
286
291
|
references?: GoogleCloudDiscoveryengineV1alphaAnswerReference[];
|
|
287
292
|
/** Suggested related questions. */
|
|
288
293
|
relatedQuestions?: string[];
|
|
294
|
+
/** Optional. Safety ratings. */
|
|
295
|
+
safetyRatings?: GoogleCloudDiscoveryengineV1alphaSafetyRating[];
|
|
289
296
|
/** The state of the answer generation. */
|
|
290
297
|
state?: string;
|
|
291
298
|
/** Answer generation steps. */
|
|
@@ -400,6 +407,14 @@ declare namespace gapi.client {
|
|
|
400
407
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec {
|
|
401
408
|
/** Enable the safety filtering on the answer response. It is false by default. */
|
|
402
409
|
enable?: boolean;
|
|
410
|
+
/** Optional. Safety settings. This settings are effective only when the safety_spec.enable is true. */
|
|
411
|
+
safetySettings?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting[];
|
|
412
|
+
}
|
|
413
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting {
|
|
414
|
+
/** Required. Harm category. */
|
|
415
|
+
category?: string;
|
|
416
|
+
/** Required. The harm block threshold. */
|
|
417
|
+
threshold?: string;
|
|
403
418
|
}
|
|
404
419
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec {
|
|
405
420
|
/** Search parameters. */
|
|
@@ -835,7 +850,7 @@ declare namespace gapi.client {
|
|
|
835
850
|
interface GoogleCloudDiscoveryengineV1alphaCollection {
|
|
836
851
|
/** Output only. Timestamp the Collection was created at. */
|
|
837
852
|
createTime?: string;
|
|
838
|
-
/** 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
|
|
853
|
+
/** 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. */
|
|
839
854
|
dataConnector?: GoogleCloudDiscoveryengineV1alphaDataConnector;
|
|
840
855
|
/** 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. */
|
|
841
856
|
displayName?: string;
|
|
@@ -963,12 +978,14 @@ declare namespace gapi.client {
|
|
|
963
978
|
useCases?: string[];
|
|
964
979
|
}
|
|
965
980
|
interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
|
|
966
|
-
/**
|
|
981
|
+
/** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
967
982
|
boost?: number;
|
|
968
983
|
/** 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 */
|
|
969
984
|
dataStore?: string;
|
|
970
985
|
/** 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. */
|
|
971
986
|
filter?: string;
|
|
987
|
+
/** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
988
|
+
fixedBoost?: number;
|
|
972
989
|
}
|
|
973
990
|
interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
|
|
974
991
|
/** 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 */
|
|
@@ -1257,6 +1274,12 @@ declare namespace gapi.client {
|
|
|
1257
1274
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1258
1275
|
updateTime?: string;
|
|
1259
1276
|
}
|
|
1277
|
+
interface GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata {
|
|
1278
|
+
/** Operation create time. */
|
|
1279
|
+
createTime?: string;
|
|
1280
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1281
|
+
updateTime?: string;
|
|
1282
|
+
}
|
|
1260
1283
|
interface GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata {
|
|
1261
1284
|
/** Operation create time. */
|
|
1262
1285
|
createTime?: string;
|
|
@@ -1308,7 +1331,7 @@ declare namespace gapi.client {
|
|
|
1308
1331
|
content?: GoogleCloudDiscoveryengineV1alphaDocumentContent;
|
|
1309
1332
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
1310
1333
|
derivedStructData?: {[P in string]: any};
|
|
1311
|
-
/** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of
|
|
1334
|
+
/** 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. */
|
|
1312
1335
|
id?: string;
|
|
1313
1336
|
/** 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. */
|
|
1314
1337
|
indexStatus?: GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus;
|
|
@@ -1815,6 +1838,8 @@ declare namespace gapi.client {
|
|
|
1815
1838
|
maxRelatedQuestions?: number;
|
|
1816
1839
|
}
|
|
1817
1840
|
interface GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig {
|
|
1841
|
+
/** 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. */
|
|
1842
|
+
nextSyncTime?: GoogleTypeDateTime;
|
|
1818
1843
|
/** 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. */
|
|
1819
1844
|
refreshInterval?: string;
|
|
1820
1845
|
}
|
|
@@ -2081,7 +2106,7 @@ declare namespace gapi.client {
|
|
|
2081
2106
|
nextPageToken?: string;
|
|
2082
2107
|
}
|
|
2083
2108
|
interface GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse {
|
|
2084
|
-
/** The
|
|
2109
|
+
/** The evaluation results for the SampleQuerys. */
|
|
2085
2110
|
evaluationResults?: GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult[];
|
|
2086
2111
|
/** A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2087
2112
|
nextPageToken?: string;
|
|
@@ -2158,6 +2183,10 @@ declare namespace gapi.client {
|
|
|
2158
2183
|
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
2159
2184
|
mode?: string;
|
|
2160
2185
|
}
|
|
2186
|
+
interface GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest {
|
|
2187
|
+
/** Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. */
|
|
2188
|
+
crawlRateScope?: string;
|
|
2189
|
+
}
|
|
2161
2190
|
interface GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse {
|
|
2162
2191
|
/** The historical dedicated crawl rate timeseries data, used for monitoring. */
|
|
2163
2192
|
dedicatedCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries;
|
|
@@ -2435,7 +2464,7 @@ declare namespace gapi.client {
|
|
|
2435
2464
|
validUrisCount?: number;
|
|
2436
2465
|
}
|
|
2437
2466
|
interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest {
|
|
2438
|
-
/** Optional. Full resource name of the SiteCredential
|
|
2467
|
+
/** Optional. Full resource name of the `SiteCredential`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
|
|
2439
2468
|
siteCredential?: string;
|
|
2440
2469
|
/** 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`. */
|
|
2441
2470
|
uris?: string[];
|
|
@@ -2458,6 +2487,22 @@ declare namespace gapi.client {
|
|
|
2458
2487
|
/** Reason why the URI was not crawled. */
|
|
2459
2488
|
errorMessage?: string;
|
|
2460
2489
|
}
|
|
2490
|
+
interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata {
|
|
2491
|
+
/** Operation create time. */
|
|
2492
|
+
createTime?: string;
|
|
2493
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2494
|
+
updateTime?: string;
|
|
2495
|
+
}
|
|
2496
|
+
interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest {
|
|
2497
|
+
/** Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. */
|
|
2498
|
+
crawlRateScope?: string;
|
|
2499
|
+
}
|
|
2500
|
+
interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse {
|
|
2501
|
+
/** Errors from service when handling the request. */
|
|
2502
|
+
error?: GoogleRpcStatus;
|
|
2503
|
+
/** Output only. The state of the response. */
|
|
2504
|
+
state?: string;
|
|
2505
|
+
}
|
|
2461
2506
|
interface GoogleCloudDiscoveryengineV1alphaReply {
|
|
2462
2507
|
/** References in the reply. */
|
|
2463
2508
|
references?: GoogleCloudDiscoveryengineV1alphaReplyReference[];
|
|
@@ -2537,6 +2582,20 @@ declare namespace gapi.client {
|
|
|
2537
2582
|
variableId?: string;
|
|
2538
2583
|
}
|
|
2539
2584
|
interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {}
|
|
2585
|
+
interface GoogleCloudDiscoveryengineV1alphaSafetyRating {
|
|
2586
|
+
/** Output only. Indicates whether the content was filtered out because of this rating. */
|
|
2587
|
+
blocked?: boolean;
|
|
2588
|
+
/** Output only. Harm category. */
|
|
2589
|
+
category?: string;
|
|
2590
|
+
/** Output only. Harm probability levels in the content. */
|
|
2591
|
+
probability?: string;
|
|
2592
|
+
/** Output only. Harm probability score. */
|
|
2593
|
+
probabilityScore?: number;
|
|
2594
|
+
/** Output only. Harm severity levels in the content. */
|
|
2595
|
+
severity?: string;
|
|
2596
|
+
/** Output only. Harm severity score. */
|
|
2597
|
+
severityScore?: number;
|
|
2598
|
+
}
|
|
2540
2599
|
interface GoogleCloudDiscoveryengineV1alphaSampleQuery {
|
|
2541
2600
|
/** Output only. Timestamp the SampleQuery was created at. */
|
|
2542
2601
|
createTime?: string;
|
|
@@ -2812,7 +2871,7 @@ declare namespace gapi.client {
|
|
|
2812
2871
|
imageBytes?: string;
|
|
2813
2872
|
}
|
|
2814
2873
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
2815
|
-
/** The condition under which filter extraction should occur.
|
|
2874
|
+
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
2816
2875
|
filterExtractionCondition?: string;
|
|
2817
2876
|
/** 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. */
|
|
2818
2877
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
@@ -3091,7 +3150,7 @@ declare namespace gapi.client {
|
|
|
3091
3150
|
personalizationSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec;
|
|
3092
3151
|
/** Condition promote specifications. Maximum number of specifications is 100. */
|
|
3093
3152
|
promoteControlIds?: string[];
|
|
3094
|
-
/** 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)`. */
|
|
3153
|
+
/** 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)`. */
|
|
3095
3154
|
rankingExpression?: string;
|
|
3096
3155
|
/** 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. */
|
|
3097
3156
|
redirectControlIds?: string[];
|
|
@@ -3146,6 +3205,28 @@ declare namespace gapi.client {
|
|
|
3146
3205
|
/** The user query. */
|
|
3147
3206
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
3148
3207
|
}
|
|
3208
|
+
interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata {
|
|
3209
|
+
/** Operation create time. */
|
|
3210
|
+
createTime?: string;
|
|
3211
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3212
|
+
updateTime?: string;
|
|
3213
|
+
}
|
|
3214
|
+
interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest {
|
|
3215
|
+
/** Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website. */
|
|
3216
|
+
crawlRate?: number;
|
|
3217
|
+
/** Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. */
|
|
3218
|
+
crawlRateScope?: string;
|
|
3219
|
+
/** Optional. Whether it’s the crawl rate of user-triggered or auto-refresh. */
|
|
3220
|
+
crawlType?: string;
|
|
3221
|
+
/** Optional. Whether the rate is explicitly set by users, or set by vertex AI. */
|
|
3222
|
+
mode?: string;
|
|
3223
|
+
}
|
|
3224
|
+
interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse {
|
|
3225
|
+
/** Errors from service when handling the request. */
|
|
3226
|
+
error?: GoogleRpcStatus;
|
|
3227
|
+
/** Output only. The state of the response. */
|
|
3228
|
+
state?: string;
|
|
3229
|
+
}
|
|
3149
3230
|
interface GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata {}
|
|
3150
3231
|
interface GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest {
|
|
3151
3232
|
/** Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. */
|
|
@@ -3207,7 +3288,7 @@ declare namespace gapi.client {
|
|
|
3207
3288
|
interface GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest {
|
|
3208
3289
|
/** Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced. */
|
|
3209
3290
|
entities?: string[];
|
|
3210
|
-
/** The FHIR resource types to import. The resource types should be a subset of all supported FHIR resource types
|
|
3291
|
+
/** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
|
|
3211
3292
|
healthcareFhirResourceTypes?: string[];
|
|
3212
3293
|
/** If true, trigger Identity sync. */
|
|
3213
3294
|
syncIdentity?: boolean;
|
|
@@ -3221,7 +3302,7 @@ declare namespace gapi.client {
|
|
|
3221
3302
|
matchOperator?: string;
|
|
3222
3303
|
}
|
|
3223
3304
|
interface GoogleCloudDiscoveryengineV1alphaTargetSite {
|
|
3224
|
-
/**
|
|
3305
|
+
/** 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. */
|
|
3225
3306
|
exactMatch?: boolean;
|
|
3226
3307
|
/** Output only. Failure reason. */
|
|
3227
3308
|
failureReason?: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason;
|
|
@@ -3418,7 +3499,12 @@ declare namespace gapi.client {
|
|
|
3418
3499
|
/** TargetSites created. */
|
|
3419
3500
|
targetSites?: GoogleCloudDiscoveryengineV1TargetSite[];
|
|
3420
3501
|
}
|
|
3421
|
-
interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {
|
|
3502
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {
|
|
3503
|
+
/** If set true, automatic refresh is disabled for the DataStore. */
|
|
3504
|
+
disableAutomaticRefresh?: boolean;
|
|
3505
|
+
/** If set true, initial indexing is disabled for the DataStore. */
|
|
3506
|
+
disableInitialIndex?: boolean;
|
|
3507
|
+
}
|
|
3422
3508
|
interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
3423
3509
|
/** Operation create time. */
|
|
3424
3510
|
createTime?: string;
|
|
@@ -3490,12 +3576,14 @@ declare namespace gapi.client {
|
|
|
3490
3576
|
useCases?: string[];
|
|
3491
3577
|
}
|
|
3492
3578
|
interface GoogleCloudDiscoveryengineV1betaControlBoostAction {
|
|
3493
|
-
/**
|
|
3579
|
+
/** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
3494
3580
|
boost?: number;
|
|
3495
3581
|
/** 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 */
|
|
3496
3582
|
dataStore?: string;
|
|
3497
3583
|
/** 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. */
|
|
3498
3584
|
filter?: string;
|
|
3585
|
+
/** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
3586
|
+
fixedBoost?: number;
|
|
3499
3587
|
}
|
|
3500
3588
|
interface GoogleCloudDiscoveryengineV1betaControlFilterAction {
|
|
3501
3589
|
/** 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 */
|
|
@@ -3550,7 +3638,7 @@ declare namespace gapi.client {
|
|
|
3550
3638
|
}
|
|
3551
3639
|
interface GoogleCloudDiscoveryengineV1betaDataStore {
|
|
3552
3640
|
/** Optional. Configuration for advanced site search. */
|
|
3553
|
-
advancedSiteSearchConfig?:
|
|
3641
|
+
advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig;
|
|
3554
3642
|
/** Output only. Data size estimation for billing. */
|
|
3555
3643
|
billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
|
|
3556
3644
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -3616,6 +3704,12 @@ declare namespace gapi.client {
|
|
|
3616
3704
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3617
3705
|
updateTime?: string;
|
|
3618
3706
|
}
|
|
3707
|
+
interface GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata {
|
|
3708
|
+
/** Operation create time. */
|
|
3709
|
+
createTime?: string;
|
|
3710
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3711
|
+
updateTime?: string;
|
|
3712
|
+
}
|
|
3619
3713
|
interface GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
|
|
3620
3714
|
/** Operation create time. */
|
|
3621
3715
|
createTime?: string;
|
|
@@ -4200,7 +4294,7 @@ declare namespace gapi.client {
|
|
|
4200
4294
|
imageBytes?: string;
|
|
4201
4295
|
}
|
|
4202
4296
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
4203
|
-
/** The condition under which filter extraction should occur.
|
|
4297
|
+
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
4204
4298
|
filterExtractionCondition?: string;
|
|
4205
4299
|
/** 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. */
|
|
4206
4300
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
@@ -4248,7 +4342,7 @@ declare namespace gapi.client {
|
|
|
4248
4342
|
verifyTime?: string;
|
|
4249
4343
|
}
|
|
4250
4344
|
interface GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
4251
|
-
/**
|
|
4345
|
+
/** 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. */
|
|
4252
4346
|
exactMatch?: boolean;
|
|
4253
4347
|
/** Output only. Failure reason. */
|
|
4254
4348
|
failureReason?: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
@@ -4389,12 +4483,14 @@ declare namespace gapi.client {
|
|
|
4389
4483
|
useCases?: string[];
|
|
4390
4484
|
}
|
|
4391
4485
|
interface GoogleCloudDiscoveryengineV1ControlBoostAction {
|
|
4392
|
-
/**
|
|
4486
|
+
/** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
4393
4487
|
boost?: number;
|
|
4394
4488
|
/** 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 */
|
|
4395
4489
|
dataStore?: string;
|
|
4396
4490
|
/** 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. */
|
|
4397
4491
|
filter?: string;
|
|
4492
|
+
/** Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
4493
|
+
fixedBoost?: number;
|
|
4398
4494
|
}
|
|
4399
4495
|
interface GoogleCloudDiscoveryengineV1ControlFilterAction {
|
|
4400
4496
|
/** 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 */
|
|
@@ -4442,7 +4538,7 @@ declare namespace gapi.client {
|
|
|
4442
4538
|
}
|
|
4443
4539
|
interface GoogleCloudDiscoveryengineV1DataStore {
|
|
4444
4540
|
/** Optional. Configuration for advanced site search. */
|
|
4445
|
-
advancedSiteSearchConfig?:
|
|
4541
|
+
advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig;
|
|
4446
4542
|
/** Output only. Data size estimation for billing. */
|
|
4447
4543
|
billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
|
|
4448
4544
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -4504,6 +4600,12 @@ declare namespace gapi.client {
|
|
|
4504
4600
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4505
4601
|
updateTime?: string;
|
|
4506
4602
|
}
|
|
4603
|
+
interface GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata {
|
|
4604
|
+
/** Operation create time. */
|
|
4605
|
+
createTime?: string;
|
|
4606
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4607
|
+
updateTime?: string;
|
|
4608
|
+
}
|
|
4507
4609
|
interface GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
|
|
4508
4610
|
/** Operation create time. */
|
|
4509
4611
|
createTime?: string;
|
|
@@ -4878,7 +4980,7 @@ declare namespace gapi.client {
|
|
|
4878
4980
|
onewaySynonymsControlIds?: string[];
|
|
4879
4981
|
/** Condition promote specifications. Maximum number of specifications is 100. */
|
|
4880
4982
|
promoteControlIds?: string[];
|
|
4881
|
-
/** 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)`. */
|
|
4983
|
+
/** 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)`. */
|
|
4882
4984
|
rankingExpression?: string;
|
|
4883
4985
|
/** 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. */
|
|
4884
4986
|
redirectControlIds?: string[];
|
|
@@ -4918,7 +5020,7 @@ declare namespace gapi.client {
|
|
|
4918
5020
|
verifyTime?: string;
|
|
4919
5021
|
}
|
|
4920
5022
|
interface GoogleCloudDiscoveryengineV1TargetSite {
|
|
4921
|
-
/**
|
|
5023
|
+
/** 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. */
|
|
4922
5024
|
exactMatch?: boolean;
|
|
4923
5025
|
/** Output only. Failure reason. */
|
|
4924
5026
|
failureReason?: GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
|
|
@@ -5453,7 +5555,7 @@ declare namespace gapi.client {
|
|
|
5453
5555
|
alt?: string;
|
|
5454
5556
|
/** JSONP */
|
|
5455
5557
|
callback?: string;
|
|
5456
|
-
/** 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
|
|
5558
|
+
/** 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. */
|
|
5457
5559
|
documentId?: string;
|
|
5458
5560
|
/** Selector specifying which fields to include in a partial response. */
|
|
5459
5561
|
fields?: string;
|
|
@@ -5484,7 +5586,7 @@ declare namespace gapi.client {
|
|
|
5484
5586
|
alt?: string;
|
|
5485
5587
|
/** JSONP */
|
|
5486
5588
|
callback?: string;
|
|
5487
|
-
/** 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
|
|
5589
|
+
/** 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. */
|
|
5488
5590
|
documentId?: string;
|
|
5489
5591
|
/** Selector specifying which fields to include in a partial response. */
|
|
5490
5592
|
fields?: string;
|
|
@@ -11343,7 +11445,7 @@ declare namespace gapi.client {
|
|
|
11343
11445
|
alt?: string;
|
|
11344
11446
|
/** JSONP */
|
|
11345
11447
|
callback?: string;
|
|
11346
|
-
/** 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
|
|
11448
|
+
/** 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. */
|
|
11347
11449
|
documentId?: string;
|
|
11348
11450
|
/** Selector specifying which fields to include in a partial response. */
|
|
11349
11451
|
fields?: string;
|
|
@@ -11374,7 +11476,7 @@ declare namespace gapi.client {
|
|
|
11374
11476
|
alt?: string;
|
|
11375
11477
|
/** JSONP */
|
|
11376
11478
|
callback?: string;
|
|
11377
|
-
/** 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
|
|
11479
|
+
/** 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. */
|
|
11378
11480
|
documentId?: string;
|
|
11379
11481
|
/** Selector specifying which fields to include in a partial response. */
|
|
11380
11482
|
fields?: string;
|
|
@@ -14938,7 +15040,7 @@ declare namespace gapi.client {
|
|
|
14938
15040
|
alt?: string;
|
|
14939
15041
|
/** JSONP */
|
|
14940
15042
|
callback?: string;
|
|
14941
|
-
/** Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. */
|
|
15043
|
+
/** Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. */
|
|
14942
15044
|
evaluation: string;
|
|
14943
15045
|
/** Selector specifying which fields to include in a partial response. */
|
|
14944
15046
|
fields?: string;
|
|
@@ -14946,7 +15048,7 @@ declare namespace gapi.client {
|
|
|
14946
15048
|
key?: string;
|
|
14947
15049
|
/** OAuth 2.0 token for the current user. */
|
|
14948
15050
|
oauth_token?: string;
|
|
14949
|
-
/** Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
15051
|
+
/** Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
14950
15052
|
pageSize?: number;
|
|
14951
15053
|
/** A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
14952
15054
|
pageToken?: string;
|
|
@@ -16170,6 +16272,180 @@ declare namespace gapi.client {
|
|
|
16170
16272
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16171
16273
|
uploadType?: string;
|
|
16172
16274
|
}): Request<GoogleCloudDiscoveryengineV1alphaCmekConfig>;
|
|
16275
|
+
/** Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series. */
|
|
16276
|
+
obtainCrawlRate(request: {
|
|
16277
|
+
/** V1 error format. */
|
|
16278
|
+
'$.xgafv'?: string;
|
|
16279
|
+
/** OAuth access token. */
|
|
16280
|
+
access_token?: string;
|
|
16281
|
+
/** Data format for response. */
|
|
16282
|
+
alt?: string;
|
|
16283
|
+
/** JSONP */
|
|
16284
|
+
callback?: string;
|
|
16285
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16286
|
+
fields?: string;
|
|
16287
|
+
/** 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. */
|
|
16288
|
+
key?: string;
|
|
16289
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
16290
|
+
location: string;
|
|
16291
|
+
/** OAuth 2.0 token for the current user. */
|
|
16292
|
+
oauth_token?: string;
|
|
16293
|
+
/** Returns response with indentations and line breaks. */
|
|
16294
|
+
prettyPrint?: boolean;
|
|
16295
|
+
/** 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. */
|
|
16296
|
+
quotaUser?: string;
|
|
16297
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16298
|
+
upload_protocol?: string;
|
|
16299
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16300
|
+
uploadType?: string;
|
|
16301
|
+
/** Request body */
|
|
16302
|
+
resource: GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest;
|
|
16303
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>;
|
|
16304
|
+
obtainCrawlRate(
|
|
16305
|
+
request: {
|
|
16306
|
+
/** V1 error format. */
|
|
16307
|
+
'$.xgafv'?: string;
|
|
16308
|
+
/** OAuth access token. */
|
|
16309
|
+
access_token?: string;
|
|
16310
|
+
/** Data format for response. */
|
|
16311
|
+
alt?: string;
|
|
16312
|
+
/** JSONP */
|
|
16313
|
+
callback?: string;
|
|
16314
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16315
|
+
fields?: string;
|
|
16316
|
+
/** 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. */
|
|
16317
|
+
key?: string;
|
|
16318
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
16319
|
+
location: string;
|
|
16320
|
+
/** OAuth 2.0 token for the current user. */
|
|
16321
|
+
oauth_token?: string;
|
|
16322
|
+
/** Returns response with indentations and line breaks. */
|
|
16323
|
+
prettyPrint?: boolean;
|
|
16324
|
+
/** 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. */
|
|
16325
|
+
quotaUser?: string;
|
|
16326
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16327
|
+
upload_protocol?: string;
|
|
16328
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16329
|
+
uploadType?: string;
|
|
16330
|
+
},
|
|
16331
|
+
body: GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest
|
|
16332
|
+
): Request<GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>;
|
|
16333
|
+
/** Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op. */
|
|
16334
|
+
removeDedicatedCrawlRate(request: {
|
|
16335
|
+
/** V1 error format. */
|
|
16336
|
+
'$.xgafv'?: string;
|
|
16337
|
+
/** OAuth access token. */
|
|
16338
|
+
access_token?: string;
|
|
16339
|
+
/** Data format for response. */
|
|
16340
|
+
alt?: string;
|
|
16341
|
+
/** JSONP */
|
|
16342
|
+
callback?: string;
|
|
16343
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16344
|
+
fields?: string;
|
|
16345
|
+
/** 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. */
|
|
16346
|
+
key?: string;
|
|
16347
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
16348
|
+
location: string;
|
|
16349
|
+
/** OAuth 2.0 token for the current user. */
|
|
16350
|
+
oauth_token?: string;
|
|
16351
|
+
/** Returns response with indentations and line breaks. */
|
|
16352
|
+
prettyPrint?: boolean;
|
|
16353
|
+
/** 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. */
|
|
16354
|
+
quotaUser?: string;
|
|
16355
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16356
|
+
upload_protocol?: string;
|
|
16357
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16358
|
+
uploadType?: string;
|
|
16359
|
+
/** Request body */
|
|
16360
|
+
resource: GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest;
|
|
16361
|
+
}): Request<GoogleLongrunningOperation>;
|
|
16362
|
+
removeDedicatedCrawlRate(
|
|
16363
|
+
request: {
|
|
16364
|
+
/** V1 error format. */
|
|
16365
|
+
'$.xgafv'?: string;
|
|
16366
|
+
/** OAuth access token. */
|
|
16367
|
+
access_token?: string;
|
|
16368
|
+
/** Data format for response. */
|
|
16369
|
+
alt?: string;
|
|
16370
|
+
/** JSONP */
|
|
16371
|
+
callback?: string;
|
|
16372
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16373
|
+
fields?: string;
|
|
16374
|
+
/** 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. */
|
|
16375
|
+
key?: string;
|
|
16376
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
16377
|
+
location: string;
|
|
16378
|
+
/** OAuth 2.0 token for the current user. */
|
|
16379
|
+
oauth_token?: string;
|
|
16380
|
+
/** Returns response with indentations and line breaks. */
|
|
16381
|
+
prettyPrint?: boolean;
|
|
16382
|
+
/** 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. */
|
|
16383
|
+
quotaUser?: string;
|
|
16384
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16385
|
+
upload_protocol?: string;
|
|
16386
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16387
|
+
uploadType?: string;
|
|
16388
|
+
},
|
|
16389
|
+
body: GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest
|
|
16390
|
+
): Request<GoogleLongrunningOperation>;
|
|
16391
|
+
/** Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website. */
|
|
16392
|
+
setDedicatedCrawlRate(request: {
|
|
16393
|
+
/** V1 error format. */
|
|
16394
|
+
'$.xgafv'?: string;
|
|
16395
|
+
/** OAuth access token. */
|
|
16396
|
+
access_token?: string;
|
|
16397
|
+
/** Data format for response. */
|
|
16398
|
+
alt?: string;
|
|
16399
|
+
/** JSONP */
|
|
16400
|
+
callback?: string;
|
|
16401
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16402
|
+
fields?: string;
|
|
16403
|
+
/** 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. */
|
|
16404
|
+
key?: string;
|
|
16405
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
16406
|
+
location: string;
|
|
16407
|
+
/** OAuth 2.0 token for the current user. */
|
|
16408
|
+
oauth_token?: string;
|
|
16409
|
+
/** Returns response with indentations and line breaks. */
|
|
16410
|
+
prettyPrint?: boolean;
|
|
16411
|
+
/** 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. */
|
|
16412
|
+
quotaUser?: string;
|
|
16413
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16414
|
+
upload_protocol?: string;
|
|
16415
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16416
|
+
uploadType?: string;
|
|
16417
|
+
/** Request body */
|
|
16418
|
+
resource: GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest;
|
|
16419
|
+
}): Request<GoogleLongrunningOperation>;
|
|
16420
|
+
setDedicatedCrawlRate(
|
|
16421
|
+
request: {
|
|
16422
|
+
/** V1 error format. */
|
|
16423
|
+
'$.xgafv'?: string;
|
|
16424
|
+
/** OAuth access token. */
|
|
16425
|
+
access_token?: string;
|
|
16426
|
+
/** Data format for response. */
|
|
16427
|
+
alt?: string;
|
|
16428
|
+
/** JSONP */
|
|
16429
|
+
callback?: string;
|
|
16430
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16431
|
+
fields?: string;
|
|
16432
|
+
/** 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. */
|
|
16433
|
+
key?: string;
|
|
16434
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
16435
|
+
location: string;
|
|
16436
|
+
/** OAuth 2.0 token for the current user. */
|
|
16437
|
+
oauth_token?: string;
|
|
16438
|
+
/** Returns response with indentations and line breaks. */
|
|
16439
|
+
prettyPrint?: boolean;
|
|
16440
|
+
/** 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. */
|
|
16441
|
+
quotaUser?: string;
|
|
16442
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16443
|
+
upload_protocol?: string;
|
|
16444
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16445
|
+
uploadType?: string;
|
|
16446
|
+
},
|
|
16447
|
+
body: GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest
|
|
16448
|
+
): Request<GoogleLongrunningOperation>;
|
|
16173
16449
|
/** Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. */
|
|
16174
16450
|
setUpDataConnector(request: {
|
|
16175
16451
|
/** V1 error format. */
|