@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20241014 → 0.0.20241025
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 +643 -38
- 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: 20241025
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -28,6 +28,64 @@ declare namespace gapi.client {
|
|
|
28
28
|
): void;
|
|
29
29
|
|
|
30
30
|
namespace discoveryengine {
|
|
31
|
+
interface GoogleApiDistribution {
|
|
32
|
+
/** The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1). */
|
|
33
|
+
bucketCounts?: string[];
|
|
34
|
+
/** Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field. */
|
|
35
|
+
bucketOptions?: GoogleApiDistributionBucketOptions;
|
|
36
|
+
/** The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided. */
|
|
37
|
+
count?: string;
|
|
38
|
+
/** Must be in increasing order of `value` field. */
|
|
39
|
+
exemplars?: GoogleApiDistributionExemplar[];
|
|
40
|
+
/** The arithmetic mean of the values in the population. If `count` is zero then this field must be zero. */
|
|
41
|
+
mean?: number;
|
|
42
|
+
/** If specified, contains the range of the population values. The field must not be present if the `count` is zero. */
|
|
43
|
+
range?: GoogleApiDistributionRange;
|
|
44
|
+
/** The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero. */
|
|
45
|
+
sumOfSquaredDeviation?: number;
|
|
46
|
+
}
|
|
47
|
+
interface GoogleApiDistributionBucketOptions {
|
|
48
|
+
/** The explicit buckets. */
|
|
49
|
+
explicitBuckets?: GoogleApiDistributionBucketOptionsExplicit;
|
|
50
|
+
/** The exponential buckets. */
|
|
51
|
+
exponentialBuckets?: GoogleApiDistributionBucketOptionsExponential;
|
|
52
|
+
/** The linear bucket. */
|
|
53
|
+
linearBuckets?: GoogleApiDistributionBucketOptionsLinear;
|
|
54
|
+
}
|
|
55
|
+
interface GoogleApiDistributionBucketOptionsExplicit {
|
|
56
|
+
/** The values must be monotonically increasing. */
|
|
57
|
+
bounds?: number[];
|
|
58
|
+
}
|
|
59
|
+
interface GoogleApiDistributionBucketOptionsExponential {
|
|
60
|
+
/** Must be greater than 1. */
|
|
61
|
+
growthFactor?: number;
|
|
62
|
+
/** Must be greater than 0. */
|
|
63
|
+
numFiniteBuckets?: number;
|
|
64
|
+
/** Must be greater than 0. */
|
|
65
|
+
scale?: number;
|
|
66
|
+
}
|
|
67
|
+
interface GoogleApiDistributionBucketOptionsLinear {
|
|
68
|
+
/** Must be greater than 0. */
|
|
69
|
+
numFiniteBuckets?: number;
|
|
70
|
+
/** Lower bound of the first bucket. */
|
|
71
|
+
offset?: number;
|
|
72
|
+
/** Must be greater than 0. */
|
|
73
|
+
width?: number;
|
|
74
|
+
}
|
|
75
|
+
interface GoogleApiDistributionExemplar {
|
|
76
|
+
/** Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. */
|
|
77
|
+
attachments?: Array<{[P in string]: any}>;
|
|
78
|
+
/** The observation (sampling) time of the above value. */
|
|
79
|
+
timestamp?: string;
|
|
80
|
+
/** Value of the exemplar point. This value determines to which bucket the exemplar belongs. */
|
|
81
|
+
value?: number;
|
|
82
|
+
}
|
|
83
|
+
interface GoogleApiDistributionRange {
|
|
84
|
+
/** The maximum of the population values. */
|
|
85
|
+
max?: number;
|
|
86
|
+
/** The minimum of the population values. */
|
|
87
|
+
min?: number;
|
|
88
|
+
}
|
|
31
89
|
interface GoogleApiHttpBody {
|
|
32
90
|
/** The HTTP Content-Type header value specifying the content type of the body. */
|
|
33
91
|
contentType?: string;
|
|
@@ -36,6 +94,24 @@ declare namespace gapi.client {
|
|
|
36
94
|
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
37
95
|
extensions?: Array<{[P in string]: any}>;
|
|
38
96
|
}
|
|
97
|
+
interface GoogleApiMetric {
|
|
98
|
+
/** The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values. */
|
|
99
|
+
labels?: {[P in string]: string};
|
|
100
|
+
/** An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`. */
|
|
101
|
+
type?: string;
|
|
102
|
+
}
|
|
103
|
+
interface GoogleApiMonitoredResource {
|
|
104
|
+
/** Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`. */
|
|
105
|
+
labels?: {[P in string]: string};
|
|
106
|
+
/** Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`. */
|
|
107
|
+
type?: string;
|
|
108
|
+
}
|
|
109
|
+
interface GoogleApiMonitoredResourceMetadata {
|
|
110
|
+
/** Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } */
|
|
111
|
+
systemLabels?: {[P in string]: any};
|
|
112
|
+
/** Output only. A map of user-defined metadata labels. */
|
|
113
|
+
userLabels?: {[P in string]: string};
|
|
114
|
+
}
|
|
39
115
|
interface GoogleCloudDiscoveryengineLoggingErrorContext {
|
|
40
116
|
/** The HTTP request which was processed when the error was triggered. */
|
|
41
117
|
httpRequest?: GoogleCloudDiscoveryengineLoggingHttpRequestContext;
|
|
@@ -82,12 +158,19 @@ declare namespace gapi.client {
|
|
|
82
158
|
/** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
|
|
83
159
|
functionName?: string;
|
|
84
160
|
}
|
|
161
|
+
interface GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {}
|
|
85
162
|
interface GoogleCloudDiscoveryengineV1alphaAclConfig {
|
|
86
163
|
/** Identity provider config. */
|
|
87
164
|
idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
|
|
88
165
|
/** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
89
166
|
name?: string;
|
|
90
167
|
}
|
|
168
|
+
interface GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig {
|
|
169
|
+
/** If set true, automatic refresh is disabled for the DataStore. */
|
|
170
|
+
disableAutomaticRefresh?: boolean;
|
|
171
|
+
/** If set true, initial indexing is disabled for the DataStore. */
|
|
172
|
+
disableInitialIndex?: boolean;
|
|
173
|
+
}
|
|
91
174
|
interface GoogleCloudDiscoveryengineV1alphaAnswer {
|
|
92
175
|
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
93
176
|
answerSkippedReasons?: string[];
|
|
@@ -217,7 +300,7 @@ declare namespace gapi.client {
|
|
|
217
300
|
document?: string;
|
|
218
301
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
219
302
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
220
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.
|
|
303
|
+
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. */
|
|
221
304
|
structData?: {[P in string]: any};
|
|
222
305
|
/** Title. */
|
|
223
306
|
title?: string;
|
|
@@ -269,7 +352,9 @@ declare namespace gapi.client {
|
|
|
269
352
|
interface GoogleCloudDiscoveryengineV1alphaCondition {
|
|
270
353
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
271
354
|
activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
|
|
272
|
-
/**
|
|
355
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. */
|
|
356
|
+
queryRegex?: string;
|
|
357
|
+
/** Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. */
|
|
273
358
|
queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
|
|
274
359
|
}
|
|
275
360
|
interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
|
|
@@ -328,6 +413,10 @@ declare namespace gapi.client {
|
|
|
328
413
|
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
329
414
|
synonyms?: string[];
|
|
330
415
|
}
|
|
416
|
+
interface GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries {
|
|
417
|
+
/** The QPS of the crawl rate. */
|
|
418
|
+
qpsTimeSeries?: GoogleMonitoringV3TimeSeries;
|
|
419
|
+
}
|
|
331
420
|
interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
|
|
332
421
|
/** Operation create time. */
|
|
333
422
|
createTime?: string;
|
|
@@ -358,7 +447,7 @@ declare namespace gapi.client {
|
|
|
358
447
|
enableSearchAdaptor?: boolean;
|
|
359
448
|
}
|
|
360
449
|
interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
|
|
361
|
-
/** Timestamp the Model was created at. */
|
|
450
|
+
/** Deprecated: Timestamp the Model was created at. */
|
|
362
451
|
createTime?: string;
|
|
363
452
|
/** The display name of the model. */
|
|
364
453
|
displayName?: string;
|
|
@@ -378,6 +467,8 @@ declare namespace gapi.client {
|
|
|
378
467
|
interface GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
379
468
|
/** 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. */
|
|
380
469
|
aclEnabled?: boolean;
|
|
470
|
+
/** Optional. Configuration for advanced site search. */
|
|
471
|
+
advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig;
|
|
381
472
|
/** Output only. Data size estimation for billing. */
|
|
382
473
|
billingEstimation?: GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation;
|
|
383
474
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -405,7 +496,7 @@ declare namespace gapi.client {
|
|
|
405
496
|
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
406
497
|
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig;
|
|
407
498
|
/** Optional. Stores serving config at DataStore level. */
|
|
408
|
-
servingConfigDataStore?:
|
|
499
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore;
|
|
409
500
|
/** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
|
|
410
501
|
solutionTypes?: string[];
|
|
411
502
|
/** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
@@ -427,6 +518,16 @@ declare namespace gapi.client {
|
|
|
427
518
|
/** Last updated timestamp for websites. */
|
|
428
519
|
websiteDataUpdateTime?: string;
|
|
429
520
|
}
|
|
521
|
+
interface GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore {
|
|
522
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
523
|
+
disabledForServing?: boolean;
|
|
524
|
+
}
|
|
525
|
+
interface GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries {
|
|
526
|
+
/** 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. */
|
|
527
|
+
autoRefreshCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
528
|
+
/** 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. */
|
|
529
|
+
userTriggeredCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
530
|
+
}
|
|
430
531
|
interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
|
|
431
532
|
/** Operation create time. */
|
|
432
533
|
createTime?: string;
|
|
@@ -788,6 +889,22 @@ declare namespace gapi.client {
|
|
|
788
889
|
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
789
890
|
mode?: string;
|
|
790
891
|
}
|
|
892
|
+
interface GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse {
|
|
893
|
+
/** The historical dedicated crawl rate timeseries data, used for monitoring. */
|
|
894
|
+
dedicatedCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries;
|
|
895
|
+
/** Errors from service when handling the request. */
|
|
896
|
+
error?: GoogleRpcStatus;
|
|
897
|
+
/** The historical organic crawl rate timeseries data, used for monitoring. */
|
|
898
|
+
organicCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries;
|
|
899
|
+
/** Output only. The state of the response. */
|
|
900
|
+
state?: string;
|
|
901
|
+
}
|
|
902
|
+
interface GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries {
|
|
903
|
+
/** 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. */
|
|
904
|
+
googleOrganicCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
905
|
+
/** 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. */
|
|
906
|
+
vertexAiOrganicCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
907
|
+
}
|
|
791
908
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
792
909
|
/** Output only. The timestamp when this project is created. */
|
|
793
910
|
createTime?: string;
|
|
@@ -900,8 +1017,10 @@ declare namespace gapi.client {
|
|
|
900
1017
|
interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
901
1018
|
/** Operation create time. */
|
|
902
1019
|
createTime?: string;
|
|
903
|
-
/** Unique URIs in the request that
|
|
1020
|
+
/** Unique URIs in the request that have invalid format. Sample limited to 1000. */
|
|
904
1021
|
invalidUris?: string[];
|
|
1022
|
+
/** Total number of unique URIs in the request that have invalid format. */
|
|
1023
|
+
invalidUrisCount?: number;
|
|
905
1024
|
/** Total number of URIs that have yet to be crawled. */
|
|
906
1025
|
pendingCount?: number;
|
|
907
1026
|
/** Total number of URIs that were rejected due to insufficient indexing resources. */
|
|
@@ -910,6 +1029,10 @@ declare namespace gapi.client {
|
|
|
910
1029
|
successCount?: number;
|
|
911
1030
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
912
1031
|
updateTime?: string;
|
|
1032
|
+
/** Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000. */
|
|
1033
|
+
urisNotMatchingTargetSites?: string[];
|
|
1034
|
+
/** Total number of URIs that don't match any TargetSites. */
|
|
1035
|
+
urisNotMatchingTargetSitesCount?: number;
|
|
913
1036
|
/** Total number of unique URIs in the request that are not in invalid_uris. */
|
|
914
1037
|
validUrisCount?: number;
|
|
915
1038
|
}
|
|
@@ -1181,10 +1304,6 @@ declare namespace gapi.client {
|
|
|
1181
1304
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
1182
1305
|
mode?: string;
|
|
1183
1306
|
}
|
|
1184
|
-
interface GoogleCloudDiscoveryengineV1alphaServingConfigDataStore {
|
|
1185
|
-
/** If set true, the DataStore will not be available for serving search requests. */
|
|
1186
|
-
disabledForServing?: boolean;
|
|
1187
|
-
}
|
|
1188
1307
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
1189
1308
|
/** Output only. The time the session finished. */
|
|
1190
1309
|
endTime?: string;
|
|
@@ -1315,6 +1434,79 @@ declare namespace gapi.client {
|
|
|
1315
1434
|
/** TargetSites created. */
|
|
1316
1435
|
targetSites?: GoogleCloudDiscoveryengineV1TargetSite[];
|
|
1317
1436
|
}
|
|
1437
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest {
|
|
1438
|
+
/** Optional. Specification to boost suggestions matching the condition. */
|
|
1439
|
+
boostSpec?: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec;
|
|
1440
|
+
/** Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. */
|
|
1441
|
+
includeTailSuggestions?: boolean;
|
|
1442
|
+
/** 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. */
|
|
1443
|
+
query?: string;
|
|
1444
|
+
/** Specifies the autocomplete data model. 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. */
|
|
1445
|
+
queryModel?: string;
|
|
1446
|
+
/** Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. */
|
|
1447
|
+
suggestionTypes?: string[];
|
|
1448
|
+
/** Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. */
|
|
1449
|
+
userInfo?: GoogleCloudDiscoveryengineV1betaUserInfo;
|
|
1450
|
+
/** 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 */
|
|
1451
|
+
userPseudoId?: string;
|
|
1452
|
+
}
|
|
1453
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec {
|
|
1454
|
+
/** Condition boost specifications. If a suggestion matches multiple conditions in the specifictions, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. */
|
|
1455
|
+
conditionBoostSpecs?: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[];
|
|
1456
|
+
}
|
|
1457
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec {
|
|
1458
|
+
/** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
|
|
1459
|
+
boost?: number;
|
|
1460
|
+
/** An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))` */
|
|
1461
|
+
condition?: string;
|
|
1462
|
+
}
|
|
1463
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse {
|
|
1464
|
+
/** Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. */
|
|
1465
|
+
contentSuggestions?: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion[];
|
|
1466
|
+
/** Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. */
|
|
1467
|
+
peopleSuggestions?: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion[];
|
|
1468
|
+
/** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
|
|
1469
|
+
querySuggestions?: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion[];
|
|
1470
|
+
/** Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. */
|
|
1471
|
+
recentSearchSuggestions?: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion[];
|
|
1472
|
+
/** True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. */
|
|
1473
|
+
tailMatchTriggered?: boolean;
|
|
1474
|
+
}
|
|
1475
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion {
|
|
1476
|
+
/** The type of the content suggestion. */
|
|
1477
|
+
contentType?: string;
|
|
1478
|
+
/** The name of the dataStore that this suggestion belongs to. */
|
|
1479
|
+
dataStore?: string;
|
|
1480
|
+
/** The document data snippet in the suggestion. Only a subset of fields will be populated. */
|
|
1481
|
+
document?: GoogleCloudDiscoveryengineV1betaDocument;
|
|
1482
|
+
/** The suggestion for the query. */
|
|
1483
|
+
suggestion?: string;
|
|
1484
|
+
}
|
|
1485
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion {
|
|
1486
|
+
/** The name of the dataStore that this suggestion belongs to. */
|
|
1487
|
+
dataStore?: string;
|
|
1488
|
+
/** The document data snippet in the suggestion. Only a subset of fields is populated. */
|
|
1489
|
+
document?: GoogleCloudDiscoveryengineV1betaDocument;
|
|
1490
|
+
/** The type of the person. */
|
|
1491
|
+
personType?: string;
|
|
1492
|
+
/** The suggestion for the query. */
|
|
1493
|
+
suggestion?: string;
|
|
1494
|
+
}
|
|
1495
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion {
|
|
1496
|
+
/** The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. */
|
|
1497
|
+
completableFieldPaths?: string[];
|
|
1498
|
+
/** The name of the dataStore that this suggestion belongs to. */
|
|
1499
|
+
dataStore?: string[];
|
|
1500
|
+
/** The suggestion for the query. */
|
|
1501
|
+
suggestion?: string;
|
|
1502
|
+
}
|
|
1503
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion {
|
|
1504
|
+
/** The time when this recent rearch happened. */
|
|
1505
|
+
recentSearchTime?: string;
|
|
1506
|
+
/** The suggestion for the query. */
|
|
1507
|
+
suggestion?: string;
|
|
1508
|
+
}
|
|
1509
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {}
|
|
1318
1510
|
interface GoogleCloudDiscoveryengineV1betaAlloyDbSource {
|
|
1319
1511
|
/** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
|
|
1320
1512
|
clusterId?: string;
|
|
@@ -1370,6 +1562,8 @@ declare namespace gapi.client {
|
|
|
1370
1562
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec;
|
|
1371
1563
|
/** Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */
|
|
1372
1564
|
asynchronousMode?: boolean;
|
|
1565
|
+
/** Optional. Grounding specification. */
|
|
1566
|
+
groundingSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec;
|
|
1373
1567
|
/** Required. Current user query. */
|
|
1374
1568
|
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
1375
1569
|
/** Query understanding specification. */
|
|
@@ -1413,6 +1607,12 @@ declare namespace gapi.client {
|
|
|
1413
1607
|
/** Customized preamble. */
|
|
1414
1608
|
preamble?: string;
|
|
1415
1609
|
}
|
|
1610
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec {
|
|
1611
|
+
/** Optional. Specifies whether to enable the filtering based on grounding score and at what level. */
|
|
1612
|
+
filteringLevel?: string;
|
|
1613
|
+
/** Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. */
|
|
1614
|
+
includeGroundingSupports?: boolean;
|
|
1615
|
+
}
|
|
1416
1616
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec {
|
|
1417
1617
|
/** Query classification specification. */
|
|
1418
1618
|
queryClassificationSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
|
|
@@ -1616,7 +1816,7 @@ declare namespace gapi.client {
|
|
|
1616
1816
|
document?: string;
|
|
1617
1817
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
1618
1818
|
snippetInfo?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
1619
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.
|
|
1819
|
+
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. */
|
|
1620
1820
|
structData?: {[P in string]: any};
|
|
1621
1821
|
/** Title. */
|
|
1622
1822
|
title?: string;
|
|
@@ -1670,7 +1870,7 @@ declare namespace gapi.client {
|
|
|
1670
1870
|
state?: string;
|
|
1671
1871
|
}
|
|
1672
1872
|
interface GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
1673
|
-
/**
|
|
1873
|
+
/** Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
1674
1874
|
fhirResource?: string;
|
|
1675
1875
|
/** If match by URI, the URI of the Document. */
|
|
1676
1876
|
uri?: string;
|
|
@@ -1729,7 +1929,7 @@ declare namespace gapi.client {
|
|
|
1729
1929
|
tableId?: string;
|
|
1730
1930
|
}
|
|
1731
1931
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingRequest {
|
|
1732
|
-
/** Answer candidate to check.
|
|
1932
|
+
/** Answer candidate to check. It can have a maximum length of 4096 tokens. */
|
|
1733
1933
|
answerCandidate?: string;
|
|
1734
1934
|
/** List of facts for the grounding check. We support up to 200 facts. */
|
|
1735
1935
|
facts?: GoogleCloudDiscoveryengineV1betaGroundingFact[];
|
|
@@ -1740,7 +1940,7 @@ declare namespace gapi.client {
|
|
|
1740
1940
|
}
|
|
1741
1941
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponse {
|
|
1742
1942
|
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
1743
|
-
citedChunks?:
|
|
1943
|
+
citedChunks?: GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk[];
|
|
1744
1944
|
/** Claim texts and citation info across all claims in the answer candidate. */
|
|
1745
1945
|
claims?: GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[];
|
|
1746
1946
|
/** The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. */
|
|
@@ -1758,6 +1958,12 @@ declare namespace gapi.client {
|
|
|
1758
1958
|
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
1759
1959
|
startPos?: number;
|
|
1760
1960
|
}
|
|
1961
|
+
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk {
|
|
1962
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1963
|
+
chunkText?: string;
|
|
1964
|
+
/** Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved. */
|
|
1965
|
+
source?: string;
|
|
1966
|
+
}
|
|
1761
1967
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingSpec {
|
|
1762
1968
|
/** The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */
|
|
1763
1969
|
citationThreshold?: number;
|
|
@@ -1865,7 +2071,9 @@ declare namespace gapi.client {
|
|
|
1865
2071
|
interface GoogleCloudDiscoveryengineV1betaCondition {
|
|
1866
2072
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
1867
2073
|
activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
|
|
1868
|
-
/**
|
|
2074
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. */
|
|
2075
|
+
queryRegex?: string;
|
|
2076
|
+
/** Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. */
|
|
1869
2077
|
queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
|
|
1870
2078
|
}
|
|
1871
2079
|
interface GoogleCloudDiscoveryengineV1betaConditionQueryTerm {
|
|
@@ -2018,7 +2226,7 @@ declare namespace gapi.client {
|
|
|
2018
2226
|
text?: string[];
|
|
2019
2227
|
}
|
|
2020
2228
|
interface GoogleCloudDiscoveryengineV1betaCustomTuningModel {
|
|
2021
|
-
/** Timestamp the Model was created at. */
|
|
2229
|
+
/** Deprecated: Timestamp the Model was created at. */
|
|
2022
2230
|
createTime?: string;
|
|
2023
2231
|
/** The display name of the model. */
|
|
2024
2232
|
displayName?: string;
|
|
@@ -2036,6 +2244,8 @@ declare namespace gapi.client {
|
|
|
2036
2244
|
trainingStartTime?: string;
|
|
2037
2245
|
}
|
|
2038
2246
|
interface GoogleCloudDiscoveryengineV1betaDataStore {
|
|
2247
|
+
/** Optional. Configuration for advanced site search. */
|
|
2248
|
+
advancedSiteSearchConfig?: any;
|
|
2039
2249
|
/** Output only. Data size estimation for billing. */
|
|
2040
2250
|
billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
|
|
2041
2251
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -2061,7 +2271,7 @@ declare namespace gapi.client {
|
|
|
2061
2271
|
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
2062
2272
|
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig;
|
|
2063
2273
|
/** Optional. Stores serving config at DataStore level. */
|
|
2064
|
-
servingConfigDataStore?:
|
|
2274
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore;
|
|
2065
2275
|
/** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
|
|
2066
2276
|
solutionTypes?: string[];
|
|
2067
2277
|
/** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
@@ -2083,6 +2293,10 @@ declare namespace gapi.client {
|
|
|
2083
2293
|
/** Last updated timestamp for websites. */
|
|
2084
2294
|
websiteDataUpdateTime?: string;
|
|
2085
2295
|
}
|
|
2296
|
+
interface GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore {
|
|
2297
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
2298
|
+
disabledForServing?: boolean;
|
|
2299
|
+
}
|
|
2086
2300
|
interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
2087
2301
|
/** Operation create time. */
|
|
2088
2302
|
createTime?: string;
|
|
@@ -2303,16 +2517,6 @@ declare namespace gapi.client {
|
|
|
2303
2517
|
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
2304
2518
|
sampleQuerySet?: string;
|
|
2305
2519
|
}
|
|
2306
|
-
interface GoogleCloudDiscoveryengineV1betaFactChunk {
|
|
2307
|
-
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
2308
|
-
chunkText?: string;
|
|
2309
|
-
/** The index of this chunk. Currently, only used for the streaming mode. */
|
|
2310
|
-
index?: number;
|
|
2311
|
-
/** Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. */
|
|
2312
|
-
source?: string;
|
|
2313
|
-
/** More fine-grained information for the source reference. */
|
|
2314
|
-
sourceMetadata?: {[P in string]: string};
|
|
2315
|
-
}
|
|
2316
2520
|
interface GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse {
|
|
2317
2521
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2318
2522
|
nextPageToken?: string;
|
|
@@ -3409,10 +3613,6 @@ declare namespace gapi.client {
|
|
|
3409
3613
|
/** Output only. ServingConfig updated timestamp. */
|
|
3410
3614
|
updateTime?: string;
|
|
3411
3615
|
}
|
|
3412
|
-
interface GoogleCloudDiscoveryengineV1betaServingConfigDataStore {
|
|
3413
|
-
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3414
|
-
disabledForServing?: boolean;
|
|
3415
|
-
}
|
|
3416
3616
|
interface GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig {
|
|
3417
3617
|
/** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
|
|
3418
3618
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
@@ -3424,6 +3624,8 @@ declare namespace gapi.client {
|
|
|
3424
3624
|
contentWatchedPercentageThreshold?: number;
|
|
3425
3625
|
/** Specifies the content watched minutes threshold for demotion. */
|
|
3426
3626
|
contentWatchedSecondsThreshold?: number;
|
|
3627
|
+
/** Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. */
|
|
3628
|
+
demoteContentWatchedPastDays?: number;
|
|
3427
3629
|
/** Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */
|
|
3428
3630
|
demotionEventType?: string;
|
|
3429
3631
|
}
|
|
@@ -3600,7 +3802,7 @@ declare namespace gapi.client {
|
|
|
3600
3802
|
engine?: string;
|
|
3601
3803
|
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
3602
3804
|
eventTime?: string;
|
|
3603
|
-
/** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
|
|
3805
|
+
/** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
|
|
3604
3806
|
eventType?: string;
|
|
3605
3807
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
3606
3808
|
filter?: string;
|
|
@@ -3658,7 +3860,9 @@ declare namespace gapi.client {
|
|
|
3658
3860
|
interface GoogleCloudDiscoveryengineV1Condition {
|
|
3659
3861
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
3660
3862
|
activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
|
|
3661
|
-
/**
|
|
3863
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. */
|
|
3864
|
+
queryRegex?: string;
|
|
3865
|
+
/** Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. */
|
|
3662
3866
|
queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
|
|
3663
3867
|
}
|
|
3664
3868
|
interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
|
|
@@ -3742,6 +3946,8 @@ declare namespace gapi.client {
|
|
|
3742
3946
|
updateTime?: string;
|
|
3743
3947
|
}
|
|
3744
3948
|
interface GoogleCloudDiscoveryengineV1DataStore {
|
|
3949
|
+
/** Optional. Configuration for advanced site search. */
|
|
3950
|
+
advancedSiteSearchConfig?: any;
|
|
3745
3951
|
/** Output only. Data size estimation for billing. */
|
|
3746
3952
|
billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
|
|
3747
3953
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -3763,7 +3969,7 @@ declare namespace gapi.client {
|
|
|
3763
3969
|
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
3764
3970
|
name?: string;
|
|
3765
3971
|
/** Optional. Stores serving config at DataStore level. */
|
|
3766
|
-
servingConfigDataStore?:
|
|
3972
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore;
|
|
3767
3973
|
/** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
|
|
3768
3974
|
solutionTypes?: string[];
|
|
3769
3975
|
/** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
@@ -3785,6 +3991,10 @@ declare namespace gapi.client {
|
|
|
3785
3991
|
/** Last updated timestamp for websites. */
|
|
3786
3992
|
websiteDataUpdateTime?: string;
|
|
3787
3993
|
}
|
|
3994
|
+
interface GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore {
|
|
3995
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3996
|
+
disabledForServing?: boolean;
|
|
3997
|
+
}
|
|
3788
3998
|
interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
3789
3999
|
/** Operation create time. */
|
|
3790
4000
|
createTime?: string;
|
|
@@ -4064,10 +4274,6 @@ declare namespace gapi.client {
|
|
|
4064
4274
|
/** The structured representation of the schema. */
|
|
4065
4275
|
structSchema?: {[P in string]: any};
|
|
4066
4276
|
}
|
|
4067
|
-
interface GoogleCloudDiscoveryengineV1ServingConfigDataStore {
|
|
4068
|
-
/** If set true, the DataStore will not be available for serving search requests. */
|
|
4069
|
-
disabledForServing?: boolean;
|
|
4070
|
-
}
|
|
4071
4277
|
interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
4072
4278
|
/** Site verification state indicating the ownership and validity. */
|
|
4073
4279
|
siteVerificationState?: string;
|
|
@@ -4169,6 +4375,48 @@ declare namespace gapi.client {
|
|
|
4169
4375
|
/** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
|
|
4170
4376
|
response?: {[P in string]: any};
|
|
4171
4377
|
}
|
|
4378
|
+
interface GoogleMonitoringV3Point {
|
|
4379
|
+
/** The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. */
|
|
4380
|
+
interval?: GoogleMonitoringV3TimeInterval;
|
|
4381
|
+
/** The value of the data point. */
|
|
4382
|
+
value?: GoogleMonitoringV3TypedValue;
|
|
4383
|
+
}
|
|
4384
|
+
interface GoogleMonitoringV3TimeInterval {
|
|
4385
|
+
/** Required. The end of the time interval. */
|
|
4386
|
+
endTime?: string;
|
|
4387
|
+
/** Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */
|
|
4388
|
+
startTime?: string;
|
|
4389
|
+
}
|
|
4390
|
+
interface GoogleMonitoringV3TimeSeries {
|
|
4391
|
+
/** Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. */
|
|
4392
|
+
description?: string;
|
|
4393
|
+
/** Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. */
|
|
4394
|
+
metadata?: GoogleApiMonitoredResourceMetadata;
|
|
4395
|
+
/** The associated metric. A fully-specified metric used to identify the time series. */
|
|
4396
|
+
metric?: GoogleApiMetric;
|
|
4397
|
+
/** The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`. */
|
|
4398
|
+
metricKind?: string;
|
|
4399
|
+
/** The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`. */
|
|
4400
|
+
points?: GoogleMonitoringV3Point[];
|
|
4401
|
+
/** The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources). */
|
|
4402
|
+
resource?: GoogleApiMonitoredResource;
|
|
4403
|
+
/** The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty. */
|
|
4404
|
+
unit?: string;
|
|
4405
|
+
/** The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field. */
|
|
4406
|
+
valueType?: string;
|
|
4407
|
+
}
|
|
4408
|
+
interface GoogleMonitoringV3TypedValue {
|
|
4409
|
+
/** A Boolean value: `true` or `false`. */
|
|
4410
|
+
boolValue?: boolean;
|
|
4411
|
+
/** A distribution value. */
|
|
4412
|
+
distributionValue?: GoogleApiDistribution;
|
|
4413
|
+
/** A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. */
|
|
4414
|
+
doubleValue?: number;
|
|
4415
|
+
/** A 64-bit integer. Its range is approximately ±9.2x1018. */
|
|
4416
|
+
int64Value?: string;
|
|
4417
|
+
/** A variable-length string value. */
|
|
4418
|
+
stringValue?: string;
|
|
4419
|
+
}
|
|
4172
4420
|
interface GoogleProtobufEmpty {}
|
|
4173
4421
|
interface GoogleRpcStatus {
|
|
4174
4422
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
@@ -4737,6 +4985,66 @@ declare namespace gapi.client {
|
|
|
4737
4985
|
documents: DocumentsResource;
|
|
4738
4986
|
operations: OperationsResource;
|
|
4739
4987
|
}
|
|
4988
|
+
interface CompletionConfigResource {
|
|
4989
|
+
/** Completes the user input with advanced keyword suggestions. */
|
|
4990
|
+
completeQuery(request: {
|
|
4991
|
+
/** V1 error format. */
|
|
4992
|
+
'$.xgafv'?: string;
|
|
4993
|
+
/** OAuth access token. */
|
|
4994
|
+
access_token?: string;
|
|
4995
|
+
/** Data format for response. */
|
|
4996
|
+
alt?: string;
|
|
4997
|
+
/** JSONP */
|
|
4998
|
+
callback?: string;
|
|
4999
|
+
/** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
5000
|
+
completionConfig: string;
|
|
5001
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5002
|
+
fields?: string;
|
|
5003
|
+
/** 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. */
|
|
5004
|
+
key?: string;
|
|
5005
|
+
/** OAuth 2.0 token for the current user. */
|
|
5006
|
+
oauth_token?: string;
|
|
5007
|
+
/** Returns response with indentations and line breaks. */
|
|
5008
|
+
prettyPrint?: boolean;
|
|
5009
|
+
/** 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. */
|
|
5010
|
+
quotaUser?: string;
|
|
5011
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5012
|
+
upload_protocol?: string;
|
|
5013
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5014
|
+
uploadType?: string;
|
|
5015
|
+
/** Request body */
|
|
5016
|
+
resource: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest;
|
|
5017
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse>;
|
|
5018
|
+
completeQuery(
|
|
5019
|
+
request: {
|
|
5020
|
+
/** V1 error format. */
|
|
5021
|
+
'$.xgafv'?: string;
|
|
5022
|
+
/** OAuth access token. */
|
|
5023
|
+
access_token?: string;
|
|
5024
|
+
/** Data format for response. */
|
|
5025
|
+
alt?: string;
|
|
5026
|
+
/** JSONP */
|
|
5027
|
+
callback?: string;
|
|
5028
|
+
/** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
5029
|
+
completionConfig: string;
|
|
5030
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5031
|
+
fields?: string;
|
|
5032
|
+
/** 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. */
|
|
5033
|
+
key?: string;
|
|
5034
|
+
/** OAuth 2.0 token for the current user. */
|
|
5035
|
+
oauth_token?: string;
|
|
5036
|
+
/** Returns response with indentations and line breaks. */
|
|
5037
|
+
prettyPrint?: boolean;
|
|
5038
|
+
/** 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. */
|
|
5039
|
+
quotaUser?: string;
|
|
5040
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5041
|
+
upload_protocol?: string;
|
|
5042
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5043
|
+
uploadType?: string;
|
|
5044
|
+
},
|
|
5045
|
+
body: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest
|
|
5046
|
+
): Request<GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse>;
|
|
5047
|
+
}
|
|
4740
5048
|
interface CompletionSuggestionsResource {
|
|
4741
5049
|
/** Imports CompletionSuggestions for a DataStore. */
|
|
4742
5050
|
import(request: {
|
|
@@ -6062,6 +6370,64 @@ declare namespace gapi.client {
|
|
|
6062
6370
|
},
|
|
6063
6371
|
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
6064
6372
|
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
6373
|
+
/** Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. */
|
|
6374
|
+
searchLite(request: {
|
|
6375
|
+
/** V1 error format. */
|
|
6376
|
+
'$.xgafv'?: string;
|
|
6377
|
+
/** OAuth access token. */
|
|
6378
|
+
access_token?: string;
|
|
6379
|
+
/** Data format for response. */
|
|
6380
|
+
alt?: string;
|
|
6381
|
+
/** JSONP */
|
|
6382
|
+
callback?: string;
|
|
6383
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6384
|
+
fields?: string;
|
|
6385
|
+
/** 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. */
|
|
6386
|
+
key?: string;
|
|
6387
|
+
/** OAuth 2.0 token for the current user. */
|
|
6388
|
+
oauth_token?: string;
|
|
6389
|
+
/** Returns response with indentations and line breaks. */
|
|
6390
|
+
prettyPrint?: boolean;
|
|
6391
|
+
/** 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. */
|
|
6392
|
+
quotaUser?: string;
|
|
6393
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6394
|
+
servingConfig: string;
|
|
6395
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6396
|
+
upload_protocol?: string;
|
|
6397
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6398
|
+
uploadType?: string;
|
|
6399
|
+
/** Request body */
|
|
6400
|
+
resource: GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
6401
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
6402
|
+
searchLite(
|
|
6403
|
+
request: {
|
|
6404
|
+
/** V1 error format. */
|
|
6405
|
+
'$.xgafv'?: string;
|
|
6406
|
+
/** OAuth access token. */
|
|
6407
|
+
access_token?: string;
|
|
6408
|
+
/** Data format for response. */
|
|
6409
|
+
alt?: string;
|
|
6410
|
+
/** JSONP */
|
|
6411
|
+
callback?: string;
|
|
6412
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6413
|
+
fields?: string;
|
|
6414
|
+
/** 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. */
|
|
6415
|
+
key?: string;
|
|
6416
|
+
/** OAuth 2.0 token for the current user. */
|
|
6417
|
+
oauth_token?: string;
|
|
6418
|
+
/** Returns response with indentations and line breaks. */
|
|
6419
|
+
prettyPrint?: boolean;
|
|
6420
|
+
/** 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. */
|
|
6421
|
+
quotaUser?: string;
|
|
6422
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6423
|
+
servingConfig: string;
|
|
6424
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6425
|
+
upload_protocol?: string;
|
|
6426
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6427
|
+
uploadType?: string;
|
|
6428
|
+
},
|
|
6429
|
+
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
6430
|
+
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
6065
6431
|
}
|
|
6066
6432
|
interface AnswersResource {
|
|
6067
6433
|
/** Gets a Answer. */
|
|
@@ -7637,6 +8003,7 @@ declare namespace gapi.client {
|
|
|
7637
8003
|
body: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest
|
|
7638
8004
|
): Request<GoogleLongrunningOperation>;
|
|
7639
8005
|
branches: BranchesResource;
|
|
8006
|
+
completionConfig: CompletionConfigResource;
|
|
7640
8007
|
completionSuggestions: CompletionSuggestionsResource;
|
|
7641
8008
|
controls: ControlsResource;
|
|
7642
8009
|
conversations: ConversationsResource;
|
|
@@ -7650,6 +8017,66 @@ declare namespace gapi.client {
|
|
|
7650
8017
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
7651
8018
|
userEvents: UserEventsResource;
|
|
7652
8019
|
}
|
|
8020
|
+
interface CompletionConfigResource {
|
|
8021
|
+
/** Completes the user input with advanced keyword suggestions. */
|
|
8022
|
+
completeQuery(request: {
|
|
8023
|
+
/** V1 error format. */
|
|
8024
|
+
'$.xgafv'?: string;
|
|
8025
|
+
/** OAuth access token. */
|
|
8026
|
+
access_token?: string;
|
|
8027
|
+
/** Data format for response. */
|
|
8028
|
+
alt?: string;
|
|
8029
|
+
/** JSONP */
|
|
8030
|
+
callback?: string;
|
|
8031
|
+
/** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
8032
|
+
completionConfig: string;
|
|
8033
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8034
|
+
fields?: string;
|
|
8035
|
+
/** 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. */
|
|
8036
|
+
key?: string;
|
|
8037
|
+
/** OAuth 2.0 token for the current user. */
|
|
8038
|
+
oauth_token?: string;
|
|
8039
|
+
/** Returns response with indentations and line breaks. */
|
|
8040
|
+
prettyPrint?: boolean;
|
|
8041
|
+
/** 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. */
|
|
8042
|
+
quotaUser?: string;
|
|
8043
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8044
|
+
upload_protocol?: string;
|
|
8045
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8046
|
+
uploadType?: string;
|
|
8047
|
+
/** Request body */
|
|
8048
|
+
resource: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest;
|
|
8049
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse>;
|
|
8050
|
+
completeQuery(
|
|
8051
|
+
request: {
|
|
8052
|
+
/** V1 error format. */
|
|
8053
|
+
'$.xgafv'?: string;
|
|
8054
|
+
/** OAuth access token. */
|
|
8055
|
+
access_token?: string;
|
|
8056
|
+
/** Data format for response. */
|
|
8057
|
+
alt?: string;
|
|
8058
|
+
/** JSONP */
|
|
8059
|
+
callback?: string;
|
|
8060
|
+
/** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
8061
|
+
completionConfig: string;
|
|
8062
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8063
|
+
fields?: string;
|
|
8064
|
+
/** 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. */
|
|
8065
|
+
key?: string;
|
|
8066
|
+
/** OAuth 2.0 token for the current user. */
|
|
8067
|
+
oauth_token?: string;
|
|
8068
|
+
/** Returns response with indentations and line breaks. */
|
|
8069
|
+
prettyPrint?: boolean;
|
|
8070
|
+
/** 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. */
|
|
8071
|
+
quotaUser?: string;
|
|
8072
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8073
|
+
upload_protocol?: string;
|
|
8074
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8075
|
+
uploadType?: string;
|
|
8076
|
+
},
|
|
8077
|
+
body: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest
|
|
8078
|
+
): Request<GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse>;
|
|
8079
|
+
}
|
|
7653
8080
|
interface ControlsResource {
|
|
7654
8081
|
/** 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. */
|
|
7655
8082
|
create(request: {
|
|
@@ -8489,6 +8916,64 @@ declare namespace gapi.client {
|
|
|
8489
8916
|
},
|
|
8490
8917
|
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
8491
8918
|
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
8919
|
+
/** Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. */
|
|
8920
|
+
searchLite(request: {
|
|
8921
|
+
/** V1 error format. */
|
|
8922
|
+
'$.xgafv'?: string;
|
|
8923
|
+
/** OAuth access token. */
|
|
8924
|
+
access_token?: string;
|
|
8925
|
+
/** Data format for response. */
|
|
8926
|
+
alt?: string;
|
|
8927
|
+
/** JSONP */
|
|
8928
|
+
callback?: string;
|
|
8929
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8930
|
+
fields?: string;
|
|
8931
|
+
/** 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. */
|
|
8932
|
+
key?: string;
|
|
8933
|
+
/** OAuth 2.0 token for the current user. */
|
|
8934
|
+
oauth_token?: string;
|
|
8935
|
+
/** Returns response with indentations and line breaks. */
|
|
8936
|
+
prettyPrint?: boolean;
|
|
8937
|
+
/** 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. */
|
|
8938
|
+
quotaUser?: string;
|
|
8939
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
8940
|
+
servingConfig: string;
|
|
8941
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8942
|
+
upload_protocol?: string;
|
|
8943
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8944
|
+
uploadType?: string;
|
|
8945
|
+
/** Request body */
|
|
8946
|
+
resource: GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
8947
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
8948
|
+
searchLite(
|
|
8949
|
+
request: {
|
|
8950
|
+
/** V1 error format. */
|
|
8951
|
+
'$.xgafv'?: string;
|
|
8952
|
+
/** OAuth access token. */
|
|
8953
|
+
access_token?: string;
|
|
8954
|
+
/** Data format for response. */
|
|
8955
|
+
alt?: string;
|
|
8956
|
+
/** JSONP */
|
|
8957
|
+
callback?: string;
|
|
8958
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8959
|
+
fields?: string;
|
|
8960
|
+
/** 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. */
|
|
8961
|
+
key?: string;
|
|
8962
|
+
/** OAuth 2.0 token for the current user. */
|
|
8963
|
+
oauth_token?: string;
|
|
8964
|
+
/** Returns response with indentations and line breaks. */
|
|
8965
|
+
prettyPrint?: boolean;
|
|
8966
|
+
/** 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. */
|
|
8967
|
+
quotaUser?: string;
|
|
8968
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
8969
|
+
servingConfig: string;
|
|
8970
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8971
|
+
upload_protocol?: string;
|
|
8972
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8973
|
+
uploadType?: string;
|
|
8974
|
+
},
|
|
8975
|
+
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
8976
|
+
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
8492
8977
|
}
|
|
8493
8978
|
interface AnswersResource {
|
|
8494
8979
|
/** Gets a Answer. */
|
|
@@ -9117,6 +9602,7 @@ declare namespace gapi.client {
|
|
|
9117
9602
|
},
|
|
9118
9603
|
body: GoogleCloudDiscoveryengineV1betaTuneEngineRequest
|
|
9119
9604
|
): Request<GoogleLongrunningOperation>;
|
|
9605
|
+
completionConfig: CompletionConfigResource;
|
|
9120
9606
|
controls: ControlsResource;
|
|
9121
9607
|
conversations: ConversationsResource;
|
|
9122
9608
|
operations: OperationsResource;
|
|
@@ -9677,6 +10163,66 @@ declare namespace gapi.client {
|
|
|
9677
10163
|
documents: DocumentsResource;
|
|
9678
10164
|
operations: OperationsResource;
|
|
9679
10165
|
}
|
|
10166
|
+
interface CompletionConfigResource {
|
|
10167
|
+
/** Completes the user input with advanced keyword suggestions. */
|
|
10168
|
+
completeQuery(request: {
|
|
10169
|
+
/** V1 error format. */
|
|
10170
|
+
'$.xgafv'?: string;
|
|
10171
|
+
/** OAuth access token. */
|
|
10172
|
+
access_token?: string;
|
|
10173
|
+
/** Data format for response. */
|
|
10174
|
+
alt?: string;
|
|
10175
|
+
/** JSONP */
|
|
10176
|
+
callback?: string;
|
|
10177
|
+
/** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
10178
|
+
completionConfig: string;
|
|
10179
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10180
|
+
fields?: string;
|
|
10181
|
+
/** 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. */
|
|
10182
|
+
key?: string;
|
|
10183
|
+
/** OAuth 2.0 token for the current user. */
|
|
10184
|
+
oauth_token?: string;
|
|
10185
|
+
/** Returns response with indentations and line breaks. */
|
|
10186
|
+
prettyPrint?: boolean;
|
|
10187
|
+
/** 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. */
|
|
10188
|
+
quotaUser?: string;
|
|
10189
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10190
|
+
upload_protocol?: string;
|
|
10191
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10192
|
+
uploadType?: string;
|
|
10193
|
+
/** Request body */
|
|
10194
|
+
resource: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest;
|
|
10195
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse>;
|
|
10196
|
+
completeQuery(
|
|
10197
|
+
request: {
|
|
10198
|
+
/** V1 error format. */
|
|
10199
|
+
'$.xgafv'?: string;
|
|
10200
|
+
/** OAuth access token. */
|
|
10201
|
+
access_token?: string;
|
|
10202
|
+
/** Data format for response. */
|
|
10203
|
+
alt?: string;
|
|
10204
|
+
/** JSONP */
|
|
10205
|
+
callback?: string;
|
|
10206
|
+
/** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. */
|
|
10207
|
+
completionConfig: string;
|
|
10208
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10209
|
+
fields?: string;
|
|
10210
|
+
/** 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. */
|
|
10211
|
+
key?: string;
|
|
10212
|
+
/** OAuth 2.0 token for the current user. */
|
|
10213
|
+
oauth_token?: string;
|
|
10214
|
+
/** Returns response with indentations and line breaks. */
|
|
10215
|
+
prettyPrint?: boolean;
|
|
10216
|
+
/** 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. */
|
|
10217
|
+
quotaUser?: string;
|
|
10218
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10219
|
+
upload_protocol?: string;
|
|
10220
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10221
|
+
uploadType?: string;
|
|
10222
|
+
},
|
|
10223
|
+
body: GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest
|
|
10224
|
+
): Request<GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse>;
|
|
10225
|
+
}
|
|
9680
10226
|
interface CompletionSuggestionsResource {
|
|
9681
10227
|
/** Imports CompletionSuggestions for a DataStore. */
|
|
9682
10228
|
import(request: {
|
|
@@ -10910,6 +11456,64 @@ declare namespace gapi.client {
|
|
|
10910
11456
|
},
|
|
10911
11457
|
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
10912
11458
|
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
11459
|
+
/** Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. */
|
|
11460
|
+
searchLite(request: {
|
|
11461
|
+
/** V1 error format. */
|
|
11462
|
+
'$.xgafv'?: string;
|
|
11463
|
+
/** OAuth access token. */
|
|
11464
|
+
access_token?: string;
|
|
11465
|
+
/** Data format for response. */
|
|
11466
|
+
alt?: string;
|
|
11467
|
+
/** JSONP */
|
|
11468
|
+
callback?: string;
|
|
11469
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11470
|
+
fields?: string;
|
|
11471
|
+
/** 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. */
|
|
11472
|
+
key?: string;
|
|
11473
|
+
/** OAuth 2.0 token for the current user. */
|
|
11474
|
+
oauth_token?: string;
|
|
11475
|
+
/** Returns response with indentations and line breaks. */
|
|
11476
|
+
prettyPrint?: boolean;
|
|
11477
|
+
/** 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. */
|
|
11478
|
+
quotaUser?: string;
|
|
11479
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11480
|
+
servingConfig: string;
|
|
11481
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11482
|
+
upload_protocol?: string;
|
|
11483
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11484
|
+
uploadType?: string;
|
|
11485
|
+
/** Request body */
|
|
11486
|
+
resource: GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
11487
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
11488
|
+
searchLite(
|
|
11489
|
+
request: {
|
|
11490
|
+
/** V1 error format. */
|
|
11491
|
+
'$.xgafv'?: string;
|
|
11492
|
+
/** OAuth access token. */
|
|
11493
|
+
access_token?: string;
|
|
11494
|
+
/** Data format for response. */
|
|
11495
|
+
alt?: string;
|
|
11496
|
+
/** JSONP */
|
|
11497
|
+
callback?: string;
|
|
11498
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11499
|
+
fields?: string;
|
|
11500
|
+
/** 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. */
|
|
11501
|
+
key?: string;
|
|
11502
|
+
/** OAuth 2.0 token for the current user. */
|
|
11503
|
+
oauth_token?: string;
|
|
11504
|
+
/** Returns response with indentations and line breaks. */
|
|
11505
|
+
prettyPrint?: boolean;
|
|
11506
|
+
/** 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. */
|
|
11507
|
+
quotaUser?: string;
|
|
11508
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11509
|
+
servingConfig: string;
|
|
11510
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11511
|
+
upload_protocol?: string;
|
|
11512
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11513
|
+
uploadType?: string;
|
|
11514
|
+
},
|
|
11515
|
+
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
11516
|
+
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
10913
11517
|
}
|
|
10914
11518
|
interface AnswersResource {
|
|
10915
11519
|
/** Gets a Answer. */
|
|
@@ -12212,6 +12816,7 @@ declare namespace gapi.client {
|
|
|
12212
12816
|
body: GoogleCloudDiscoveryengineV1betaDataStore
|
|
12213
12817
|
): Request<GoogleCloudDiscoveryengineV1betaDataStore>;
|
|
12214
12818
|
branches: BranchesResource;
|
|
12819
|
+
completionConfig: CompletionConfigResource;
|
|
12215
12820
|
completionSuggestions: CompletionSuggestionsResource;
|
|
12216
12821
|
controls: ControlsResource;
|
|
12217
12822
|
conversations: ConversationsResource;
|