@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20250211 → 0.0.20250219
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 +418 -34
- 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250219
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -213,11 +213,11 @@ declare namespace gapi.client {
|
|
|
213
213
|
steps?: GoogleCloudDiscoveryengineV1alphaAnswerStep[];
|
|
214
214
|
}
|
|
215
215
|
interface GoogleCloudDiscoveryengineV1alphaAnswerCitation {
|
|
216
|
-
/** End of the attributed segment, exclusive. */
|
|
216
|
+
/** End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */
|
|
217
217
|
endIndex?: string;
|
|
218
218
|
/** Citation sources for the attributed segment. */
|
|
219
219
|
sources?: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
220
|
-
/** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). */
|
|
220
|
+
/** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */
|
|
221
221
|
startIndex?: string;
|
|
222
222
|
}
|
|
223
223
|
interface GoogleCloudDiscoveryengineV1alphaAnswerCitationSource {
|
|
@@ -281,6 +281,10 @@ declare namespace gapi.client {
|
|
|
281
281
|
document?: string;
|
|
282
282
|
/** Structured search data. */
|
|
283
283
|
structData?: {[P in string]: any};
|
|
284
|
+
/** Output only. The title of the document. */
|
|
285
|
+
title?: string;
|
|
286
|
+
/** Output only. The URI of the document. */
|
|
287
|
+
uri?: string;
|
|
284
288
|
}
|
|
285
289
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
|
|
286
290
|
/** List of cited chunk contents derived from document content. */
|
|
@@ -367,17 +371,17 @@ declare namespace gapi.client {
|
|
|
367
371
|
interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
|
|
368
372
|
/** Output only. The default CmekConfig for the Customer. */
|
|
369
373
|
isDefault?: boolean;
|
|
370
|
-
/**
|
|
374
|
+
/** KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
|
|
371
375
|
kmsKey?: string;
|
|
372
|
-
/**
|
|
376
|
+
/** KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
|
|
373
377
|
kmsKeyVersion?: string;
|
|
374
378
|
/** Output only. The timestamp of the last key rotation. */
|
|
375
379
|
lastRotationTimestampMicros?: string;
|
|
376
|
-
/** Required.
|
|
380
|
+
/** Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
|
|
377
381
|
name?: string;
|
|
378
382
|
/** Optional. Single-regional CMEKs that are required for some VAIS features. */
|
|
379
383
|
singleRegionKeys?: GoogleCloudDiscoveryengineV1alphaSingleRegionKey[];
|
|
380
|
-
/** Output only.
|
|
384
|
+
/** Output only. The states of the CmekConfig. */
|
|
381
385
|
state?: string;
|
|
382
386
|
}
|
|
383
387
|
interface GoogleCloudDiscoveryengineV1alphaCollection {
|
|
@@ -431,6 +435,8 @@ declare namespace gapi.client {
|
|
|
431
435
|
trigger?: string;
|
|
432
436
|
}
|
|
433
437
|
interface GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun {
|
|
438
|
+
/** The number of documents deleted. */
|
|
439
|
+
deletedRecordCount?: string;
|
|
434
440
|
/** The name of the source entity. */
|
|
435
441
|
entityName?: string;
|
|
436
442
|
/** The total number of documents failed at sync at any stage (extraction, indexing, etc). */
|
|
@@ -616,10 +622,14 @@ declare namespace gapi.client {
|
|
|
616
622
|
dataStore?: string;
|
|
617
623
|
/** The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` */
|
|
618
624
|
entityName?: string;
|
|
625
|
+
/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
|
|
626
|
+
healthcareFhirConfig?: GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
|
|
619
627
|
/** Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */
|
|
620
628
|
keyPropertyMappings?: {[P in string]: string};
|
|
621
629
|
/** The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. */
|
|
622
630
|
params?: {[P in string]: any};
|
|
631
|
+
/** Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
632
|
+
startingSchema?: GoogleCloudDiscoveryengineV1alphaSchema;
|
|
623
633
|
}
|
|
624
634
|
interface GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
625
635
|
/** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
|
|
@@ -634,7 +644,7 @@ declare namespace gapi.client {
|
|
|
634
644
|
contentConfig?: string;
|
|
635
645
|
/** Output only. Timestamp the DataStore was created at. */
|
|
636
646
|
createTime?: string;
|
|
637
|
-
/** Output only. The id of the default Schema
|
|
647
|
+
/** Output only. The id of the default Schema associated to this data store. */
|
|
638
648
|
defaultSchemaId?: string;
|
|
639
649
|
/** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
640
650
|
displayName?: string;
|
|
@@ -642,6 +652,8 @@ declare namespace gapi.client {
|
|
|
642
652
|
documentProcessingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
|
|
643
653
|
/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
|
|
644
654
|
healthcareFhirConfig?: GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
|
|
655
|
+
/** Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */
|
|
656
|
+
identityMappingStore?: string;
|
|
645
657
|
/** Output only. Data store level identity provider config. */
|
|
646
658
|
idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
647
659
|
/** Immutable. The industry vertical that the data store registers. */
|
|
@@ -934,14 +946,6 @@ declare namespace gapi.client {
|
|
|
934
946
|
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
935
947
|
sampleQuerySet?: string;
|
|
936
948
|
}
|
|
937
|
-
interface GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse {
|
|
938
|
-
/** List of Sitemaps fetched. */
|
|
939
|
-
sitemapsMetadata?: GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata[];
|
|
940
|
-
}
|
|
941
|
-
interface GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata {
|
|
942
|
-
/** The Sitemap. */
|
|
943
|
-
sitemap?: GoogleCloudDiscoveryengineV1alphaSitemap;
|
|
944
|
-
}
|
|
945
949
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
946
950
|
/** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
|
|
947
951
|
advancedSiteSearchDataSources?: string[];
|
|
@@ -1374,6 +1378,8 @@ declare namespace gapi.client {
|
|
|
1374
1378
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
1375
1379
|
/** Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
1376
1380
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
1381
|
+
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
1382
|
+
displaySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec;
|
|
1377
1383
|
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
1378
1384
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
1379
1385
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
@@ -1404,8 +1410,10 @@ declare namespace gapi.client {
|
|
|
1404
1410
|
query?: string;
|
|
1405
1411
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
1406
1412
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
1407
|
-
/** The ranking expression controls the customized ranking on retrieval documents. This overrides 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)`. */
|
|
1413
|
+
/** The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */
|
|
1408
1414
|
rankingExpression?: string;
|
|
1415
|
+
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
1416
|
+
rankingExpressionBackend?: string;
|
|
1409
1417
|
/** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
|
|
1410
1418
|
regionCode?: string;
|
|
1411
1419
|
/** The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */
|
|
@@ -1533,6 +1541,10 @@ declare namespace gapi.client {
|
|
|
1533
1541
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
1534
1542
|
filter?: string;
|
|
1535
1543
|
}
|
|
1544
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec {
|
|
1545
|
+
/** The condition under which match highlighting should occur. */
|
|
1546
|
+
matchHighlightingCondition?: string;
|
|
1547
|
+
}
|
|
1536
1548
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
|
|
1537
1549
|
/** The embedding vector used for retrieval. Limit to 1. */
|
|
1538
1550
|
embeddingVectors?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
@@ -1596,7 +1608,7 @@ declare namespace gapi.client {
|
|
|
1596
1608
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec {
|
|
1597
1609
|
/** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
|
|
1598
1610
|
queryId?: string;
|
|
1599
|
-
/** The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is
|
|
1611
|
+
/** The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */
|
|
1600
1612
|
searchResultPersistenceCount?: number;
|
|
1601
1613
|
}
|
|
1602
1614
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec {
|
|
@@ -1783,7 +1795,7 @@ declare namespace gapi.client {
|
|
|
1783
1795
|
includeTailSuggestions?: boolean;
|
|
1784
1796
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. */
|
|
1785
1797
|
query?: string;
|
|
1786
|
-
/** Specifies the autocomplete
|
|
1798
|
+
/** Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
|
|
1787
1799
|
queryModel?: string;
|
|
1788
1800
|
/** Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. */
|
|
1789
1801
|
suggestionTypes?: string[];
|
|
@@ -1907,11 +1919,11 @@ declare namespace gapi.client {
|
|
|
1907
1919
|
steps?: GoogleCloudDiscoveryengineV1betaAnswerStep[];
|
|
1908
1920
|
}
|
|
1909
1921
|
interface GoogleCloudDiscoveryengineV1betaAnswerCitation {
|
|
1910
|
-
/** End of the attributed segment, exclusive. */
|
|
1922
|
+
/** End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */
|
|
1911
1923
|
endIndex?: string;
|
|
1912
1924
|
/** Citation sources for the attributed segment. */
|
|
1913
1925
|
sources?: GoogleCloudDiscoveryengineV1betaAnswerCitationSource[];
|
|
1914
|
-
/** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). */
|
|
1926
|
+
/** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */
|
|
1915
1927
|
startIndex?: string;
|
|
1916
1928
|
}
|
|
1917
1929
|
interface GoogleCloudDiscoveryengineV1betaAnswerCitationSource {
|
|
@@ -2175,6 +2187,10 @@ declare namespace gapi.client {
|
|
|
2175
2187
|
document?: string;
|
|
2176
2188
|
/** Structured search data. */
|
|
2177
2189
|
structData?: {[P in string]: any};
|
|
2190
|
+
/** Output only. The title of the document. */
|
|
2191
|
+
title?: string;
|
|
2192
|
+
/** Output only. The URI of the document. */
|
|
2193
|
+
uri?: string;
|
|
2178
2194
|
}
|
|
2179
2195
|
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo {
|
|
2180
2196
|
/** List of cited chunk contents derived from document content. */
|
|
@@ -2430,17 +2446,17 @@ declare namespace gapi.client {
|
|
|
2430
2446
|
interface GoogleCloudDiscoveryengineV1betaCmekConfig {
|
|
2431
2447
|
/** Output only. The default CmekConfig for the Customer. */
|
|
2432
2448
|
isDefault?: boolean;
|
|
2433
|
-
/**
|
|
2449
|
+
/** KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
|
|
2434
2450
|
kmsKey?: string;
|
|
2435
|
-
/**
|
|
2451
|
+
/** KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
|
|
2436
2452
|
kmsKeyVersion?: string;
|
|
2437
2453
|
/** Output only. The timestamp of the last key rotation. */
|
|
2438
2454
|
lastRotationTimestampMicros?: string;
|
|
2439
|
-
/** Required.
|
|
2455
|
+
/** Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
|
|
2440
2456
|
name?: string;
|
|
2441
2457
|
/** Optional. Single-regional CMEKs that are required for some VAIS features. */
|
|
2442
2458
|
singleRegionKeys?: GoogleCloudDiscoveryengineV1betaSingleRegionKey[];
|
|
2443
|
-
/** Output only.
|
|
2459
|
+
/** Output only. The states of the CmekConfig. */
|
|
2444
2460
|
state?: string;
|
|
2445
2461
|
}
|
|
2446
2462
|
interface GoogleCloudDiscoveryengineV1betaCompleteQueryResponse {
|
|
@@ -2625,6 +2641,10 @@ declare namespace gapi.client {
|
|
|
2625
2641
|
/** Search Results. */
|
|
2626
2642
|
searchResults?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[];
|
|
2627
2643
|
}
|
|
2644
|
+
interface GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries {
|
|
2645
|
+
/** The QPS of the crawl rate. */
|
|
2646
|
+
qpsTimeSeries?: GoogleMonitoringV3TimeSeries;
|
|
2647
|
+
}
|
|
2628
2648
|
interface GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
|
|
2629
2649
|
/** Operation create time. */
|
|
2630
2650
|
createTime?: string;
|
|
@@ -2697,7 +2717,7 @@ declare namespace gapi.client {
|
|
|
2697
2717
|
contentConfig?: string;
|
|
2698
2718
|
/** Output only. Timestamp the DataStore was created at. */
|
|
2699
2719
|
createTime?: string;
|
|
2700
|
-
/** Output only. The id of the default Schema
|
|
2720
|
+
/** Output only. The id of the default Schema associated to this data store. */
|
|
2701
2721
|
defaultSchemaId?: string;
|
|
2702
2722
|
/** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
2703
2723
|
displayName?: string;
|
|
@@ -2705,6 +2725,8 @@ declare namespace gapi.client {
|
|
|
2705
2725
|
documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
|
|
2706
2726
|
/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
|
|
2707
2727
|
healthcareFhirConfig?: GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig;
|
|
2728
|
+
/** Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */
|
|
2729
|
+
identityMappingStore?: string;
|
|
2708
2730
|
/** Immutable. The industry vertical that the data store registers. */
|
|
2709
2731
|
industryVertical?: string;
|
|
2710
2732
|
/** Optional. If set, this DataStore is an Infobot FAQ DataStore. */
|
|
@@ -2744,6 +2766,12 @@ declare namespace gapi.client {
|
|
|
2744
2766
|
/** If set true, the DataStore will not be available for serving search requests. */
|
|
2745
2767
|
disabledForServing?: boolean;
|
|
2746
2768
|
}
|
|
2769
|
+
interface GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries {
|
|
2770
|
+
/** Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. */
|
|
2771
|
+
autoRefreshCrawlRate?: GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries;
|
|
2772
|
+
/** Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. */
|
|
2773
|
+
userTriggeredCrawlRate?: GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries;
|
|
2774
|
+
}
|
|
2747
2775
|
interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
2748
2776
|
/** Operation create time. */
|
|
2749
2777
|
createTime?: string;
|
|
@@ -3530,6 +3558,26 @@ declare namespace gapi.client {
|
|
|
3530
3558
|
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
3531
3559
|
mode?: string;
|
|
3532
3560
|
}
|
|
3561
|
+
interface GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest {
|
|
3562
|
+
/** 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: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. */
|
|
3563
|
+
crawlRateScope?: string;
|
|
3564
|
+
}
|
|
3565
|
+
interface GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse {
|
|
3566
|
+
/** The historical dedicated crawl rate timeseries data, used for monitoring. */
|
|
3567
|
+
dedicatedCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries;
|
|
3568
|
+
/** Errors from service when handling the request. */
|
|
3569
|
+
error?: GoogleRpcStatus;
|
|
3570
|
+
/** The historical organic crawl rate timeseries data, used for monitoring. */
|
|
3571
|
+
organicCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries;
|
|
3572
|
+
/** Output only. The state of the response. */
|
|
3573
|
+
state?: string;
|
|
3574
|
+
}
|
|
3575
|
+
interface GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries {
|
|
3576
|
+
/** Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots. */
|
|
3577
|
+
googleOrganicCrawlRate?: GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries;
|
|
3578
|
+
/** Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot. */
|
|
3579
|
+
vertexAiOrganicCrawlRate?: GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries;
|
|
3580
|
+
}
|
|
3533
3581
|
interface GoogleCloudDiscoveryengineV1betaPageInfo {
|
|
3534
3582
|
/** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
3535
3583
|
pageCategory?: string;
|
|
@@ -3743,11 +3791,40 @@ declare namespace gapi.client {
|
|
|
3743
3791
|
metadata?: {[P in string]: any};
|
|
3744
3792
|
}
|
|
3745
3793
|
interface GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest {
|
|
3746
|
-
/** Optional.
|
|
3794
|
+
/** Optional. Credential id to use for crawling. */
|
|
3747
3795
|
siteCredential?: string;
|
|
3748
3796
|
/** 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`. */
|
|
3749
3797
|
uris?: string[];
|
|
3750
3798
|
}
|
|
3799
|
+
interface GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata {
|
|
3800
|
+
/** Operation create time. */
|
|
3801
|
+
createTime?: string;
|
|
3802
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3803
|
+
updateTime?: string;
|
|
3804
|
+
}
|
|
3805
|
+
interface GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest {
|
|
3806
|
+
/** Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. */
|
|
3807
|
+
crawlRateScope?: string;
|
|
3808
|
+
}
|
|
3809
|
+
interface GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse {
|
|
3810
|
+
/** Errors from service when handling the request. */
|
|
3811
|
+
error?: GoogleRpcStatus;
|
|
3812
|
+
/** Output only. The state of the response. */
|
|
3813
|
+
state?: string;
|
|
3814
|
+
}
|
|
3815
|
+
interface GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest {
|
|
3816
|
+
/** Remove all search history suggestions for the user. */
|
|
3817
|
+
removeAllSearchHistorySuggestions?: boolean;
|
|
3818
|
+
/** Optional. Time at which the suggestion was removed. If not set, the current time will be used. */
|
|
3819
|
+
removeTime?: string;
|
|
3820
|
+
/** The search history suggestion to be removed. */
|
|
3821
|
+
searchHistorySuggestion?: string;
|
|
3822
|
+
/** Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. */
|
|
3823
|
+
userInfo?: GoogleCloudDiscoveryengineV1betaUserInfo;
|
|
3824
|
+
/** Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128. */
|
|
3825
|
+
userPseudoId?: string;
|
|
3826
|
+
}
|
|
3827
|
+
interface GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse {}
|
|
3751
3828
|
interface GoogleCloudDiscoveryengineV1betaReply {
|
|
3752
3829
|
/** References in the reply. */
|
|
3753
3830
|
references?: GoogleCloudDiscoveryengineV1betaReplyReference[];
|
|
@@ -3882,8 +3959,10 @@ declare namespace gapi.client {
|
|
|
3882
3959
|
query?: string;
|
|
3883
3960
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
3884
3961
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
3885
|
-
/** The ranking expression controls the customized ranking on retrieval documents. This overrides 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)`. */
|
|
3962
|
+
/** The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */
|
|
3886
3963
|
rankingExpression?: string;
|
|
3964
|
+
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
3965
|
+
rankingExpressionBackend?: string;
|
|
3887
3966
|
/** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
|
|
3888
3967
|
regionCode?: string;
|
|
3889
3968
|
/** The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */
|
|
@@ -4074,7 +4153,7 @@ declare namespace gapi.client {
|
|
|
4074
4153
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec {
|
|
4075
4154
|
/** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
|
|
4076
4155
|
queryId?: string;
|
|
4077
|
-
/** The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is
|
|
4156
|
+
/** The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */
|
|
4078
4157
|
searchResultPersistenceCount?: number;
|
|
4079
4158
|
}
|
|
4080
4159
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec {
|
|
@@ -4388,6 +4467,28 @@ declare namespace gapi.client {
|
|
|
4388
4467
|
/** The user query. */
|
|
4389
4468
|
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
4390
4469
|
}
|
|
4470
|
+
interface GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata {
|
|
4471
|
+
/** Operation create time. */
|
|
4472
|
+
createTime?: string;
|
|
4473
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4474
|
+
updateTime?: string;
|
|
4475
|
+
}
|
|
4476
|
+
interface GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest {
|
|
4477
|
+
/** 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. */
|
|
4478
|
+
crawlRate?: number;
|
|
4479
|
+
/** 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: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. */
|
|
4480
|
+
crawlRateScope?: string;
|
|
4481
|
+
/** Optional. Whether it's the crawl rate of user-triggered or auto-refresh. */
|
|
4482
|
+
crawlType?: string;
|
|
4483
|
+
/** Optional. Whether the rate is explicitly set by users, or set by vertex AI. */
|
|
4484
|
+
mode?: string;
|
|
4485
|
+
}
|
|
4486
|
+
interface GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse {
|
|
4487
|
+
/** Errors from service when handling the request. */
|
|
4488
|
+
error?: GoogleRpcStatus;
|
|
4489
|
+
/** Output only. The state of the response. */
|
|
4490
|
+
state?: string;
|
|
4491
|
+
}
|
|
4391
4492
|
interface GoogleCloudDiscoveryengineV1betaSingleRegionKey {
|
|
4392
4493
|
/** Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
|
|
4393
4494
|
kmsKey?: string;
|
|
@@ -4601,17 +4702,17 @@ declare namespace gapi.client {
|
|
|
4601
4702
|
interface GoogleCloudDiscoveryengineV1CmekConfig {
|
|
4602
4703
|
/** Output only. The default CmekConfig for the Customer. */
|
|
4603
4704
|
isDefault?: boolean;
|
|
4604
|
-
/**
|
|
4705
|
+
/** KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
|
|
4605
4706
|
kmsKey?: string;
|
|
4606
|
-
/**
|
|
4707
|
+
/** KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
|
|
4607
4708
|
kmsKeyVersion?: string;
|
|
4608
4709
|
/** Output only. The timestamp of the last key rotation. */
|
|
4609
4710
|
lastRotationTimestampMicros?: string;
|
|
4610
|
-
/** Required.
|
|
4711
|
+
/** Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
|
|
4611
4712
|
name?: string;
|
|
4612
4713
|
/** Optional. Single-regional CMEKs that are required for some VAIS features. */
|
|
4613
4714
|
singleRegionKeys?: GoogleCloudDiscoveryengineV1SingleRegionKey[];
|
|
4614
|
-
/** Output only.
|
|
4715
|
+
/** Output only. The states of the CmekConfig. */
|
|
4615
4716
|
state?: string;
|
|
4616
4717
|
}
|
|
4617
4718
|
interface GoogleCloudDiscoveryengineV1Condition {
|
|
@@ -4724,6 +4825,12 @@ declare namespace gapi.client {
|
|
|
4724
4825
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4725
4826
|
updateTime?: string;
|
|
4726
4827
|
}
|
|
4828
|
+
interface GoogleCloudDiscoveryengineV1CreateSitemapMetadata {
|
|
4829
|
+
/** Operation create time. */
|
|
4830
|
+
createTime?: string;
|
|
4831
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4832
|
+
updateTime?: string;
|
|
4833
|
+
}
|
|
4727
4834
|
interface GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
|
|
4728
4835
|
/** Operation create time. */
|
|
4729
4836
|
createTime?: string;
|
|
@@ -4741,7 +4848,7 @@ declare namespace gapi.client {
|
|
|
4741
4848
|
contentConfig?: string;
|
|
4742
4849
|
/** Output only. Timestamp the DataStore was created at. */
|
|
4743
4850
|
createTime?: string;
|
|
4744
|
-
/** Output only. The id of the default Schema
|
|
4851
|
+
/** Output only. The id of the default Schema associated to this data store. */
|
|
4745
4852
|
defaultSchemaId?: string;
|
|
4746
4853
|
/** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
4747
4854
|
displayName?: string;
|
|
@@ -4749,6 +4856,8 @@ declare namespace gapi.client {
|
|
|
4749
4856
|
documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
|
|
4750
4857
|
/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
|
|
4751
4858
|
healthcareFhirConfig?: GoogleCloudDiscoveryengineV1HealthcareFhirConfig;
|
|
4859
|
+
/** Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */
|
|
4860
|
+
identityMappingStore?: string;
|
|
4752
4861
|
/** Immutable. The industry vertical that the data store registers. */
|
|
4753
4862
|
industryVertical?: string;
|
|
4754
4863
|
/** Optional. If set, this DataStore is an Infobot FAQ DataStore. */
|
|
@@ -4814,6 +4923,12 @@ declare namespace gapi.client {
|
|
|
4814
4923
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4815
4924
|
updateTime?: string;
|
|
4816
4925
|
}
|
|
4926
|
+
interface GoogleCloudDiscoveryengineV1DeleteSitemapMetadata {
|
|
4927
|
+
/** Operation create time. */
|
|
4928
|
+
createTime?: string;
|
|
4929
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4930
|
+
updateTime?: string;
|
|
4931
|
+
}
|
|
4817
4932
|
interface GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
|
|
4818
4933
|
/** Operation create time. */
|
|
4819
4934
|
createTime?: string;
|
|
@@ -5233,6 +5348,14 @@ declare namespace gapi.client {
|
|
|
5233
5348
|
/** Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
|
|
5234
5349
|
kmsKey?: string;
|
|
5235
5350
|
}
|
|
5351
|
+
interface GoogleCloudDiscoveryengineV1Sitemap {
|
|
5352
|
+
/** Output only. The sitemap's creation time. */
|
|
5353
|
+
createTime?: string;
|
|
5354
|
+
/** Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated. */
|
|
5355
|
+
name?: string;
|
|
5356
|
+
/** Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. */
|
|
5357
|
+
uri?: string;
|
|
5358
|
+
}
|
|
5236
5359
|
interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
5237
5360
|
/** Site verification state indicating the ownership and validity. */
|
|
5238
5361
|
siteVerificationState?: string;
|
|
@@ -7863,6 +7986,35 @@ declare namespace gapi.client {
|
|
|
7863
7986
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7864
7987
|
uploadType?: string;
|
|
7865
7988
|
}): Request<GoogleLongrunningOperation>;
|
|
7989
|
+
/** Fetch Sitemaps in a DataStore. */
|
|
7990
|
+
fetch(request?: {
|
|
7991
|
+
/** V1 error format. */
|
|
7992
|
+
'$.xgafv'?: string;
|
|
7993
|
+
/** OAuth access token. */
|
|
7994
|
+
access_token?: string;
|
|
7995
|
+
/** Data format for response. */
|
|
7996
|
+
alt?: string;
|
|
7997
|
+
/** JSONP */
|
|
7998
|
+
callback?: string;
|
|
7999
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8000
|
+
fields?: string;
|
|
8001
|
+
/** 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. */
|
|
8002
|
+
key?: string;
|
|
8003
|
+
/** The Sitemap uris. */
|
|
8004
|
+
'matcher.urisMatcher.uris'?: string | string[];
|
|
8005
|
+
/** OAuth 2.0 token for the current user. */
|
|
8006
|
+
oauth_token?: string;
|
|
8007
|
+
/** Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. */
|
|
8008
|
+
parent: string;
|
|
8009
|
+
/** Returns response with indentations and line breaks. */
|
|
8010
|
+
prettyPrint?: boolean;
|
|
8011
|
+
/** 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. */
|
|
8012
|
+
quotaUser?: string;
|
|
8013
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8014
|
+
upload_protocol?: string;
|
|
8015
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8016
|
+
uploadType?: string;
|
|
8017
|
+
}): Request<GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse>;
|
|
7866
8018
|
}
|
|
7867
8019
|
interface OperationsResource {
|
|
7868
8020
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
@@ -9209,6 +9361,64 @@ declare namespace gapi.client {
|
|
|
9209
9361
|
},
|
|
9210
9362
|
body: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest,
|
|
9211
9363
|
): Request<GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse>;
|
|
9364
|
+
/** Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again. */
|
|
9365
|
+
removeSuggestion(request: {
|
|
9366
|
+
/** V1 error format. */
|
|
9367
|
+
'$.xgafv'?: string;
|
|
9368
|
+
/** OAuth access token. */
|
|
9369
|
+
access_token?: string;
|
|
9370
|
+
/** Data format for response. */
|
|
9371
|
+
alt?: string;
|
|
9372
|
+
/** JSONP */
|
|
9373
|
+
callback?: string;
|
|
9374
|
+
/** Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
9375
|
+
completionConfig: string;
|
|
9376
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9377
|
+
fields?: string;
|
|
9378
|
+
/** 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. */
|
|
9379
|
+
key?: string;
|
|
9380
|
+
/** OAuth 2.0 token for the current user. */
|
|
9381
|
+
oauth_token?: string;
|
|
9382
|
+
/** Returns response with indentations and line breaks. */
|
|
9383
|
+
prettyPrint?: boolean;
|
|
9384
|
+
/** 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. */
|
|
9385
|
+
quotaUser?: string;
|
|
9386
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9387
|
+
upload_protocol?: string;
|
|
9388
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9389
|
+
uploadType?: string;
|
|
9390
|
+
/** Request body */
|
|
9391
|
+
resource: GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest;
|
|
9392
|
+
}): Request<{}>;
|
|
9393
|
+
removeSuggestion(
|
|
9394
|
+
request: {
|
|
9395
|
+
/** V1 error format. */
|
|
9396
|
+
'$.xgafv'?: string;
|
|
9397
|
+
/** OAuth access token. */
|
|
9398
|
+
access_token?: string;
|
|
9399
|
+
/** Data format for response. */
|
|
9400
|
+
alt?: string;
|
|
9401
|
+
/** JSONP */
|
|
9402
|
+
callback?: string;
|
|
9403
|
+
/** Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
9404
|
+
completionConfig: string;
|
|
9405
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9406
|
+
fields?: string;
|
|
9407
|
+
/** 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. */
|
|
9408
|
+
key?: string;
|
|
9409
|
+
/** OAuth 2.0 token for the current user. */
|
|
9410
|
+
oauth_token?: string;
|
|
9411
|
+
/** Returns response with indentations and line breaks. */
|
|
9412
|
+
prettyPrint?: boolean;
|
|
9413
|
+
/** 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. */
|
|
9414
|
+
quotaUser?: string;
|
|
9415
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9416
|
+
upload_protocol?: string;
|
|
9417
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9418
|
+
uploadType?: string;
|
|
9419
|
+
},
|
|
9420
|
+
body: GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest,
|
|
9421
|
+
): Request<{}>;
|
|
9212
9422
|
}
|
|
9213
9423
|
interface ControlsResource {
|
|
9214
9424
|
/** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
|
|
@@ -15652,6 +15862,180 @@ declare namespace gapi.client {
|
|
|
15652
15862
|
},
|
|
15653
15863
|
body: GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest,
|
|
15654
15864
|
): Request<GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse>;
|
|
15865
|
+
/** 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. */
|
|
15866
|
+
obtainCrawlRate(request: {
|
|
15867
|
+
/** V1 error format. */
|
|
15868
|
+
'$.xgafv'?: string;
|
|
15869
|
+
/** OAuth access token. */
|
|
15870
|
+
access_token?: string;
|
|
15871
|
+
/** Data format for response. */
|
|
15872
|
+
alt?: string;
|
|
15873
|
+
/** JSONP */
|
|
15874
|
+
callback?: string;
|
|
15875
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
15876
|
+
fields?: string;
|
|
15877
|
+
/** 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. */
|
|
15878
|
+
key?: string;
|
|
15879
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
15880
|
+
location: string;
|
|
15881
|
+
/** OAuth 2.0 token for the current user. */
|
|
15882
|
+
oauth_token?: string;
|
|
15883
|
+
/** Returns response with indentations and line breaks. */
|
|
15884
|
+
prettyPrint?: boolean;
|
|
15885
|
+
/** 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. */
|
|
15886
|
+
quotaUser?: string;
|
|
15887
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15888
|
+
upload_protocol?: string;
|
|
15889
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
15890
|
+
uploadType?: string;
|
|
15891
|
+
/** Request body */
|
|
15892
|
+
resource: GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest;
|
|
15893
|
+
}): Request<GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>;
|
|
15894
|
+
obtainCrawlRate(
|
|
15895
|
+
request: {
|
|
15896
|
+
/** V1 error format. */
|
|
15897
|
+
'$.xgafv'?: string;
|
|
15898
|
+
/** OAuth access token. */
|
|
15899
|
+
access_token?: string;
|
|
15900
|
+
/** Data format for response. */
|
|
15901
|
+
alt?: string;
|
|
15902
|
+
/** JSONP */
|
|
15903
|
+
callback?: string;
|
|
15904
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
15905
|
+
fields?: string;
|
|
15906
|
+
/** 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. */
|
|
15907
|
+
key?: string;
|
|
15908
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
15909
|
+
location: string;
|
|
15910
|
+
/** OAuth 2.0 token for the current user. */
|
|
15911
|
+
oauth_token?: string;
|
|
15912
|
+
/** Returns response with indentations and line breaks. */
|
|
15913
|
+
prettyPrint?: boolean;
|
|
15914
|
+
/** 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. */
|
|
15915
|
+
quotaUser?: string;
|
|
15916
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15917
|
+
upload_protocol?: string;
|
|
15918
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
15919
|
+
uploadType?: string;
|
|
15920
|
+
},
|
|
15921
|
+
body: GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest,
|
|
15922
|
+
): Request<GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>;
|
|
15923
|
+
/** 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. */
|
|
15924
|
+
removeDedicatedCrawlRate(request: {
|
|
15925
|
+
/** V1 error format. */
|
|
15926
|
+
'$.xgafv'?: string;
|
|
15927
|
+
/** OAuth access token. */
|
|
15928
|
+
access_token?: string;
|
|
15929
|
+
/** Data format for response. */
|
|
15930
|
+
alt?: string;
|
|
15931
|
+
/** JSONP */
|
|
15932
|
+
callback?: string;
|
|
15933
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
15934
|
+
fields?: string;
|
|
15935
|
+
/** 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. */
|
|
15936
|
+
key?: string;
|
|
15937
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
15938
|
+
location: string;
|
|
15939
|
+
/** OAuth 2.0 token for the current user. */
|
|
15940
|
+
oauth_token?: string;
|
|
15941
|
+
/** Returns response with indentations and line breaks. */
|
|
15942
|
+
prettyPrint?: boolean;
|
|
15943
|
+
/** 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. */
|
|
15944
|
+
quotaUser?: string;
|
|
15945
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15946
|
+
upload_protocol?: string;
|
|
15947
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
15948
|
+
uploadType?: string;
|
|
15949
|
+
/** Request body */
|
|
15950
|
+
resource: GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest;
|
|
15951
|
+
}): Request<GoogleLongrunningOperation>;
|
|
15952
|
+
removeDedicatedCrawlRate(
|
|
15953
|
+
request: {
|
|
15954
|
+
/** V1 error format. */
|
|
15955
|
+
'$.xgafv'?: string;
|
|
15956
|
+
/** OAuth access token. */
|
|
15957
|
+
access_token?: string;
|
|
15958
|
+
/** Data format for response. */
|
|
15959
|
+
alt?: string;
|
|
15960
|
+
/** JSONP */
|
|
15961
|
+
callback?: string;
|
|
15962
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
15963
|
+
fields?: string;
|
|
15964
|
+
/** 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. */
|
|
15965
|
+
key?: string;
|
|
15966
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
15967
|
+
location: string;
|
|
15968
|
+
/** OAuth 2.0 token for the current user. */
|
|
15969
|
+
oauth_token?: string;
|
|
15970
|
+
/** Returns response with indentations and line breaks. */
|
|
15971
|
+
prettyPrint?: boolean;
|
|
15972
|
+
/** 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. */
|
|
15973
|
+
quotaUser?: string;
|
|
15974
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15975
|
+
upload_protocol?: string;
|
|
15976
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
15977
|
+
uploadType?: string;
|
|
15978
|
+
},
|
|
15979
|
+
body: GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest,
|
|
15980
|
+
): Request<GoogleLongrunningOperation>;
|
|
15981
|
+
/** 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. */
|
|
15982
|
+
setDedicatedCrawlRate(request: {
|
|
15983
|
+
/** V1 error format. */
|
|
15984
|
+
'$.xgafv'?: string;
|
|
15985
|
+
/** OAuth access token. */
|
|
15986
|
+
access_token?: string;
|
|
15987
|
+
/** Data format for response. */
|
|
15988
|
+
alt?: string;
|
|
15989
|
+
/** JSONP */
|
|
15990
|
+
callback?: string;
|
|
15991
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
15992
|
+
fields?: string;
|
|
15993
|
+
/** 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. */
|
|
15994
|
+
key?: string;
|
|
15995
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
15996
|
+
location: string;
|
|
15997
|
+
/** OAuth 2.0 token for the current user. */
|
|
15998
|
+
oauth_token?: string;
|
|
15999
|
+
/** Returns response with indentations and line breaks. */
|
|
16000
|
+
prettyPrint?: boolean;
|
|
16001
|
+
/** 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. */
|
|
16002
|
+
quotaUser?: string;
|
|
16003
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16004
|
+
upload_protocol?: string;
|
|
16005
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16006
|
+
uploadType?: string;
|
|
16007
|
+
/** Request body */
|
|
16008
|
+
resource: GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest;
|
|
16009
|
+
}): Request<GoogleLongrunningOperation>;
|
|
16010
|
+
setDedicatedCrawlRate(
|
|
16011
|
+
request: {
|
|
16012
|
+
/** V1 error format. */
|
|
16013
|
+
'$.xgafv'?: string;
|
|
16014
|
+
/** OAuth access token. */
|
|
16015
|
+
access_token?: string;
|
|
16016
|
+
/** Data format for response. */
|
|
16017
|
+
alt?: string;
|
|
16018
|
+
/** JSONP */
|
|
16019
|
+
callback?: string;
|
|
16020
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
16021
|
+
fields?: string;
|
|
16022
|
+
/** 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. */
|
|
16023
|
+
key?: string;
|
|
16024
|
+
/** Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` */
|
|
16025
|
+
location: string;
|
|
16026
|
+
/** OAuth 2.0 token for the current user. */
|
|
16027
|
+
oauth_token?: string;
|
|
16028
|
+
/** Returns response with indentations and line breaks. */
|
|
16029
|
+
prettyPrint?: boolean;
|
|
16030
|
+
/** 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. */
|
|
16031
|
+
quotaUser?: string;
|
|
16032
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16033
|
+
upload_protocol?: string;
|
|
16034
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
16035
|
+
uploadType?: string;
|
|
16036
|
+
},
|
|
16037
|
+
body: GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest,
|
|
16038
|
+
): Request<GoogleLongrunningOperation>;
|
|
15655
16039
|
collections: CollectionsResource;
|
|
15656
16040
|
dataStores: DataStoresResource;
|
|
15657
16041
|
evaluations: EvaluationsResource;
|