@maxim_mazurok/gapi.client.discoveryengine-v1 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 +385 -39
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
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,6 +158,7 @@ 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 GoogleCloudDiscoveryengineV1AlloyDbSource {
|
|
86
163
|
/** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
|
|
87
164
|
clusterId?: string;
|
|
@@ -102,6 +179,12 @@ declare namespace gapi.client {
|
|
|
102
179
|
/** 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. */
|
|
103
180
|
name?: string;
|
|
104
181
|
}
|
|
182
|
+
interface GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig {
|
|
183
|
+
/** If set true, automatic refresh is disabled for the DataStore. */
|
|
184
|
+
disableAutomaticRefresh?: boolean;
|
|
185
|
+
/** If set true, initial indexing is disabled for the DataStore. */
|
|
186
|
+
disableInitialIndex?: boolean;
|
|
187
|
+
}
|
|
105
188
|
interface GoogleCloudDiscoveryengineV1alphaAnswer {
|
|
106
189
|
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
107
190
|
answerSkippedReasons?: string[];
|
|
@@ -231,7 +314,7 @@ declare namespace gapi.client {
|
|
|
231
314
|
document?: string;
|
|
232
315
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
233
316
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
234
|
-
/** 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.
|
|
317
|
+
/** 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. */
|
|
235
318
|
structData?: {[P in string]: any};
|
|
236
319
|
/** Title. */
|
|
237
320
|
title?: string;
|
|
@@ -283,7 +366,9 @@ declare namespace gapi.client {
|
|
|
283
366
|
interface GoogleCloudDiscoveryengineV1alphaCondition {
|
|
284
367
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
285
368
|
activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
|
|
286
|
-
/**
|
|
369
|
+
/** 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. */
|
|
370
|
+
queryRegex?: string;
|
|
371
|
+
/** 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. */
|
|
287
372
|
queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
|
|
288
373
|
}
|
|
289
374
|
interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
|
|
@@ -342,6 +427,10 @@ declare namespace gapi.client {
|
|
|
342
427
|
/** Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
343
428
|
synonyms?: string[];
|
|
344
429
|
}
|
|
430
|
+
interface GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries {
|
|
431
|
+
/** The QPS of the crawl rate. */
|
|
432
|
+
qpsTimeSeries?: GoogleMonitoringV3TimeSeries;
|
|
433
|
+
}
|
|
345
434
|
interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
|
|
346
435
|
/** Operation create time. */
|
|
347
436
|
createTime?: string;
|
|
@@ -372,7 +461,7 @@ declare namespace gapi.client {
|
|
|
372
461
|
enableSearchAdaptor?: boolean;
|
|
373
462
|
}
|
|
374
463
|
interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
|
|
375
|
-
/** Timestamp the Model was created at. */
|
|
464
|
+
/** Deprecated: Timestamp the Model was created at. */
|
|
376
465
|
createTime?: string;
|
|
377
466
|
/** The display name of the model. */
|
|
378
467
|
displayName?: string;
|
|
@@ -392,6 +481,8 @@ declare namespace gapi.client {
|
|
|
392
481
|
interface GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
393
482
|
/** 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. */
|
|
394
483
|
aclEnabled?: boolean;
|
|
484
|
+
/** Optional. Configuration for advanced site search. */
|
|
485
|
+
advancedSiteSearchConfig?: GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig;
|
|
395
486
|
/** Output only. Data size estimation for billing. */
|
|
396
487
|
billingEstimation?: GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation;
|
|
397
488
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -419,7 +510,7 @@ declare namespace gapi.client {
|
|
|
419
510
|
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
420
511
|
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig;
|
|
421
512
|
/** Optional. Stores serving config at DataStore level. */
|
|
422
|
-
servingConfigDataStore?:
|
|
513
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore;
|
|
423
514
|
/** 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. */
|
|
424
515
|
solutionTypes?: string[];
|
|
425
516
|
/** 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). */
|
|
@@ -441,6 +532,16 @@ declare namespace gapi.client {
|
|
|
441
532
|
/** Last updated timestamp for websites. */
|
|
442
533
|
websiteDataUpdateTime?: string;
|
|
443
534
|
}
|
|
535
|
+
interface GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore {
|
|
536
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
537
|
+
disabledForServing?: boolean;
|
|
538
|
+
}
|
|
539
|
+
interface GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries {
|
|
540
|
+
/** 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. */
|
|
541
|
+
autoRefreshCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
542
|
+
/** 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. */
|
|
543
|
+
userTriggeredCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
544
|
+
}
|
|
444
545
|
interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
|
|
445
546
|
/** Operation create time. */
|
|
446
547
|
createTime?: string;
|
|
@@ -802,6 +903,22 @@ declare namespace gapi.client {
|
|
|
802
903
|
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
803
904
|
mode?: string;
|
|
804
905
|
}
|
|
906
|
+
interface GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse {
|
|
907
|
+
/** The historical dedicated crawl rate timeseries data, used for monitoring. */
|
|
908
|
+
dedicatedCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries;
|
|
909
|
+
/** Errors from service when handling the request. */
|
|
910
|
+
error?: GoogleRpcStatus;
|
|
911
|
+
/** The historical organic crawl rate timeseries data, used for monitoring. */
|
|
912
|
+
organicCrawlRateTimeSeries?: GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries;
|
|
913
|
+
/** Output only. The state of the response. */
|
|
914
|
+
state?: string;
|
|
915
|
+
}
|
|
916
|
+
interface GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries {
|
|
917
|
+
/** 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. */
|
|
918
|
+
googleOrganicCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
919
|
+
/** 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. */
|
|
920
|
+
vertexAiOrganicCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
921
|
+
}
|
|
805
922
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
806
923
|
/** Output only. The timestamp when this project is created. */
|
|
807
924
|
createTime?: string;
|
|
@@ -914,8 +1031,10 @@ declare namespace gapi.client {
|
|
|
914
1031
|
interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
915
1032
|
/** Operation create time. */
|
|
916
1033
|
createTime?: string;
|
|
917
|
-
/** Unique URIs in the request that
|
|
1034
|
+
/** Unique URIs in the request that have invalid format. Sample limited to 1000. */
|
|
918
1035
|
invalidUris?: string[];
|
|
1036
|
+
/** Total number of unique URIs in the request that have invalid format. */
|
|
1037
|
+
invalidUrisCount?: number;
|
|
919
1038
|
/** Total number of URIs that have yet to be crawled. */
|
|
920
1039
|
pendingCount?: number;
|
|
921
1040
|
/** Total number of URIs that were rejected due to insufficient indexing resources. */
|
|
@@ -924,6 +1043,10 @@ declare namespace gapi.client {
|
|
|
924
1043
|
successCount?: number;
|
|
925
1044
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
926
1045
|
updateTime?: string;
|
|
1046
|
+
/** 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. */
|
|
1047
|
+
urisNotMatchingTargetSites?: string[];
|
|
1048
|
+
/** Total number of URIs that don't match any TargetSites. */
|
|
1049
|
+
urisNotMatchingTargetSitesCount?: number;
|
|
927
1050
|
/** Total number of unique URIs in the request that are not in invalid_uris. */
|
|
928
1051
|
validUrisCount?: number;
|
|
929
1052
|
}
|
|
@@ -1195,10 +1318,6 @@ declare namespace gapi.client {
|
|
|
1195
1318
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
1196
1319
|
mode?: string;
|
|
1197
1320
|
}
|
|
1198
|
-
interface GoogleCloudDiscoveryengineV1alphaServingConfigDataStore {
|
|
1199
|
-
/** If set true, the DataStore will not be available for serving search requests. */
|
|
1200
|
-
disabledForServing?: boolean;
|
|
1201
|
-
}
|
|
1202
1321
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
1203
1322
|
/** Output only. The time the session finished. */
|
|
1204
1323
|
endTime?: string;
|
|
@@ -1360,6 +1479,8 @@ declare namespace gapi.client {
|
|
|
1360
1479
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec;
|
|
1361
1480
|
/** 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. */
|
|
1362
1481
|
asynchronousMode?: boolean;
|
|
1482
|
+
/** Optional. Grounding specification. */
|
|
1483
|
+
groundingSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec;
|
|
1363
1484
|
/** Required. Current user query. */
|
|
1364
1485
|
query?: GoogleCloudDiscoveryengineV1Query;
|
|
1365
1486
|
/** Query understanding specification. */
|
|
@@ -1403,6 +1524,10 @@ declare namespace gapi.client {
|
|
|
1403
1524
|
/** Customized preamble. */
|
|
1404
1525
|
preamble?: string;
|
|
1405
1526
|
}
|
|
1527
|
+
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec {
|
|
1528
|
+
/** 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. */
|
|
1529
|
+
includeGroundingSupports?: boolean;
|
|
1530
|
+
}
|
|
1406
1531
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec {
|
|
1407
1532
|
/** Query classification specification. */
|
|
1408
1533
|
queryClassificationSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
|
|
@@ -1604,7 +1729,7 @@ declare namespace gapi.client {
|
|
|
1604
1729
|
document?: string;
|
|
1605
1730
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
1606
1731
|
snippetInfo?: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[];
|
|
1607
|
-
/** 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.
|
|
1732
|
+
/** 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. */
|
|
1608
1733
|
structData?: {[P in string]: any};
|
|
1609
1734
|
/** Title. */
|
|
1610
1735
|
title?: string;
|
|
@@ -1658,12 +1783,13 @@ declare namespace gapi.client {
|
|
|
1658
1783
|
state?: string;
|
|
1659
1784
|
}
|
|
1660
1785
|
interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
1661
|
-
/**
|
|
1786
|
+
/** Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
1662
1787
|
fhirResource?: string;
|
|
1663
1788
|
/** If match by URI, the URI of the Document. */
|
|
1664
1789
|
uri?: string;
|
|
1665
1790
|
}
|
|
1666
1791
|
interface GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {}
|
|
1792
|
+
interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {}
|
|
1667
1793
|
interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
1668
1794
|
/** Operation create time. */
|
|
1669
1795
|
createTime?: string;
|
|
@@ -1691,7 +1817,9 @@ declare namespace gapi.client {
|
|
|
1691
1817
|
interface GoogleCloudDiscoveryengineV1betaCondition {
|
|
1692
1818
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
1693
1819
|
activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
|
|
1694
|
-
/**
|
|
1820
|
+
/** 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. */
|
|
1821
|
+
queryRegex?: string;
|
|
1822
|
+
/** 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. */
|
|
1695
1823
|
queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
|
|
1696
1824
|
}
|
|
1697
1825
|
interface GoogleCloudDiscoveryengineV1betaConditionQueryTerm {
|
|
@@ -1776,7 +1904,7 @@ declare namespace gapi.client {
|
|
|
1776
1904
|
updateTime?: string;
|
|
1777
1905
|
}
|
|
1778
1906
|
interface GoogleCloudDiscoveryengineV1betaCustomTuningModel {
|
|
1779
|
-
/** Timestamp the Model was created at. */
|
|
1907
|
+
/** Deprecated: Timestamp the Model was created at. */
|
|
1780
1908
|
createTime?: string;
|
|
1781
1909
|
/** The display name of the model. */
|
|
1782
1910
|
displayName?: string;
|
|
@@ -1794,6 +1922,8 @@ declare namespace gapi.client {
|
|
|
1794
1922
|
trainingStartTime?: string;
|
|
1795
1923
|
}
|
|
1796
1924
|
interface GoogleCloudDiscoveryengineV1betaDataStore {
|
|
1925
|
+
/** Optional. Configuration for advanced site search. */
|
|
1926
|
+
advancedSiteSearchConfig?: any;
|
|
1797
1927
|
/** Output only. Data size estimation for billing. */
|
|
1798
1928
|
billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
|
|
1799
1929
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -1819,7 +1949,7 @@ declare namespace gapi.client {
|
|
|
1819
1949
|
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
1820
1950
|
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig;
|
|
1821
1951
|
/** Optional. Stores serving config at DataStore level. */
|
|
1822
|
-
servingConfigDataStore?:
|
|
1952
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore;
|
|
1823
1953
|
/** 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. */
|
|
1824
1954
|
solutionTypes?: string[];
|
|
1825
1955
|
/** 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). */
|
|
@@ -1841,6 +1971,10 @@ declare namespace gapi.client {
|
|
|
1841
1971
|
/** Last updated timestamp for websites. */
|
|
1842
1972
|
websiteDataUpdateTime?: string;
|
|
1843
1973
|
}
|
|
1974
|
+
interface GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore {
|
|
1975
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
1976
|
+
disabledForServing?: boolean;
|
|
1977
|
+
}
|
|
1844
1978
|
interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
|
|
1845
1979
|
/** Operation create time. */
|
|
1846
1980
|
createTime?: string;
|
|
@@ -2442,10 +2576,6 @@ declare namespace gapi.client {
|
|
|
2442
2576
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
2443
2577
|
mode?: string;
|
|
2444
2578
|
}
|
|
2445
|
-
interface GoogleCloudDiscoveryengineV1betaServingConfigDataStore {
|
|
2446
|
-
/** If set true, the DataStore will not be available for serving search requests. */
|
|
2447
|
-
disabledForServing?: boolean;
|
|
2448
|
-
}
|
|
2449
2579
|
interface GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
2450
2580
|
/** Site verification state indicating the ownership and validity. */
|
|
2451
2581
|
siteVerificationState?: string;
|
|
@@ -2586,7 +2716,7 @@ declare namespace gapi.client {
|
|
|
2586
2716
|
tableId?: string;
|
|
2587
2717
|
}
|
|
2588
2718
|
interface GoogleCloudDiscoveryengineV1CheckGroundingRequest {
|
|
2589
|
-
/** Answer candidate to check.
|
|
2719
|
+
/** Answer candidate to check. It can have a maximum length of 4096 tokens. */
|
|
2590
2720
|
answerCandidate?: string;
|
|
2591
2721
|
/** List of facts for the grounding check. We support up to 200 facts. */
|
|
2592
2722
|
facts?: GoogleCloudDiscoveryengineV1GroundingFact[];
|
|
@@ -2597,7 +2727,7 @@ declare namespace gapi.client {
|
|
|
2597
2727
|
}
|
|
2598
2728
|
interface GoogleCloudDiscoveryengineV1CheckGroundingResponse {
|
|
2599
2729
|
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
2600
|
-
citedChunks?:
|
|
2730
|
+
citedChunks?: GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk[];
|
|
2601
2731
|
/** Claim texts and citation info across all claims in the answer candidate. */
|
|
2602
2732
|
claims?: GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim[];
|
|
2603
2733
|
/** 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. */
|
|
@@ -2615,6 +2745,12 @@ declare namespace gapi.client {
|
|
|
2615
2745
|
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
2616
2746
|
startPos?: number;
|
|
2617
2747
|
}
|
|
2748
|
+
interface GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk {
|
|
2749
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
2750
|
+
chunkText?: string;
|
|
2751
|
+
/** 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. */
|
|
2752
|
+
source?: string;
|
|
2753
|
+
}
|
|
2618
2754
|
interface GoogleCloudDiscoveryengineV1CheckGroundingSpec {
|
|
2619
2755
|
/** 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. */
|
|
2620
2756
|
citationThreshold?: number;
|
|
@@ -2722,7 +2858,9 @@ declare namespace gapi.client {
|
|
|
2722
2858
|
interface GoogleCloudDiscoveryengineV1Condition {
|
|
2723
2859
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
2724
2860
|
activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
|
|
2725
|
-
/**
|
|
2861
|
+
/** 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. */
|
|
2862
|
+
queryRegex?: string;
|
|
2863
|
+
/** 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. */
|
|
2726
2864
|
queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
|
|
2727
2865
|
}
|
|
2728
2866
|
interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
|
|
@@ -2872,7 +3010,7 @@ declare namespace gapi.client {
|
|
|
2872
3010
|
text?: string[];
|
|
2873
3011
|
}
|
|
2874
3012
|
interface GoogleCloudDiscoveryengineV1CustomTuningModel {
|
|
2875
|
-
/** Timestamp the Model was created at. */
|
|
3013
|
+
/** Deprecated: Timestamp the Model was created at. */
|
|
2876
3014
|
createTime?: string;
|
|
2877
3015
|
/** The display name of the model. */
|
|
2878
3016
|
displayName?: string;
|
|
@@ -2890,6 +3028,8 @@ declare namespace gapi.client {
|
|
|
2890
3028
|
trainingStartTime?: string;
|
|
2891
3029
|
}
|
|
2892
3030
|
interface GoogleCloudDiscoveryengineV1DataStore {
|
|
3031
|
+
/** Optional. Configuration for advanced site search. */
|
|
3032
|
+
advancedSiteSearchConfig?: any;
|
|
2893
3033
|
/** Output only. Data size estimation for billing. */
|
|
2894
3034
|
billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
|
|
2895
3035
|
/** Output only. CMEK-related information for the DataStore. */
|
|
@@ -2911,7 +3051,7 @@ declare namespace gapi.client {
|
|
|
2911
3051
|
/** 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. */
|
|
2912
3052
|
name?: string;
|
|
2913
3053
|
/** Optional. Stores serving config at DataStore level. */
|
|
2914
|
-
servingConfigDataStore?:
|
|
3054
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore;
|
|
2915
3055
|
/** 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. */
|
|
2916
3056
|
solutionTypes?: string[];
|
|
2917
3057
|
/** 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). */
|
|
@@ -2933,6 +3073,10 @@ declare namespace gapi.client {
|
|
|
2933
3073
|
/** Last updated timestamp for websites. */
|
|
2934
3074
|
websiteDataUpdateTime?: string;
|
|
2935
3075
|
}
|
|
3076
|
+
interface GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore {
|
|
3077
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3078
|
+
disabledForServing?: boolean;
|
|
3079
|
+
}
|
|
2936
3080
|
interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
|
|
2937
3081
|
/** Operation create time. */
|
|
2938
3082
|
createTime?: string;
|
|
@@ -3117,16 +3261,6 @@ declare namespace gapi.client {
|
|
|
3117
3261
|
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
3118
3262
|
searchTier?: string;
|
|
3119
3263
|
}
|
|
3120
|
-
interface GoogleCloudDiscoveryengineV1FactChunk {
|
|
3121
|
-
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
3122
|
-
chunkText?: string;
|
|
3123
|
-
/** The index of this chunk. Currently, only used for the streaming mode. */
|
|
3124
|
-
index?: number;
|
|
3125
|
-
/** 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. */
|
|
3126
|
-
source?: string;
|
|
3127
|
-
/** More fine-grained information for the source reference. */
|
|
3128
|
-
sourceMetadata?: {[P in string]: string};
|
|
3129
|
-
}
|
|
3130
3264
|
interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
|
|
3131
3265
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
3132
3266
|
nextPageToken?: string;
|
|
@@ -3910,10 +4044,6 @@ declare namespace gapi.client {
|
|
|
3910
4044
|
/** Summary text with no citation information. */
|
|
3911
4045
|
summary?: string;
|
|
3912
4046
|
}
|
|
3913
|
-
interface GoogleCloudDiscoveryengineV1ServingConfigDataStore {
|
|
3914
|
-
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3915
|
-
disabledForServing?: boolean;
|
|
3916
|
-
}
|
|
3917
4047
|
interface GoogleCloudDiscoveryengineV1Session {
|
|
3918
4048
|
/** Output only. The time the session finished. */
|
|
3919
4049
|
endTime?: string;
|
|
@@ -4085,7 +4215,7 @@ declare namespace gapi.client {
|
|
|
4085
4215
|
engine?: string;
|
|
4086
4216
|
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
4087
4217
|
eventTime?: string;
|
|
4088
|
-
/** 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. */
|
|
4218
|
+
/** 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. */
|
|
4089
4219
|
eventType?: string;
|
|
4090
4220
|
/** 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. */
|
|
4091
4221
|
filter?: string;
|
|
@@ -4145,6 +4275,48 @@ declare namespace gapi.client {
|
|
|
4145
4275
|
/** 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`. */
|
|
4146
4276
|
response?: {[P in string]: any};
|
|
4147
4277
|
}
|
|
4278
|
+
interface GoogleMonitoringV3Point {
|
|
4279
|
+
/** 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. */
|
|
4280
|
+
interval?: GoogleMonitoringV3TimeInterval;
|
|
4281
|
+
/** The value of the data point. */
|
|
4282
|
+
value?: GoogleMonitoringV3TypedValue;
|
|
4283
|
+
}
|
|
4284
|
+
interface GoogleMonitoringV3TimeInterval {
|
|
4285
|
+
/** Required. The end of the time interval. */
|
|
4286
|
+
endTime?: string;
|
|
4287
|
+
/** 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. */
|
|
4288
|
+
startTime?: string;
|
|
4289
|
+
}
|
|
4290
|
+
interface GoogleMonitoringV3TimeSeries {
|
|
4291
|
+
/** 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. */
|
|
4292
|
+
description?: string;
|
|
4293
|
+
/** 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. */
|
|
4294
|
+
metadata?: GoogleApiMonitoredResourceMetadata;
|
|
4295
|
+
/** The associated metric. A fully-specified metric used to identify the time series. */
|
|
4296
|
+
metric?: GoogleApiMetric;
|
|
4297
|
+
/** 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`. */
|
|
4298
|
+
metricKind?: string;
|
|
4299
|
+
/** 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`. */
|
|
4300
|
+
points?: GoogleMonitoringV3Point[];
|
|
4301
|
+
/** 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). */
|
|
4302
|
+
resource?: GoogleApiMonitoredResource;
|
|
4303
|
+
/** 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. */
|
|
4304
|
+
unit?: string;
|
|
4305
|
+
/** 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. */
|
|
4306
|
+
valueType?: string;
|
|
4307
|
+
}
|
|
4308
|
+
interface GoogleMonitoringV3TypedValue {
|
|
4309
|
+
/** A Boolean value: `true` or `false`. */
|
|
4310
|
+
boolValue?: boolean;
|
|
4311
|
+
/** A distribution value. */
|
|
4312
|
+
distributionValue?: GoogleApiDistribution;
|
|
4313
|
+
/** A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. */
|
|
4314
|
+
doubleValue?: number;
|
|
4315
|
+
/** A 64-bit integer. Its range is approximately ±9.2x1018. */
|
|
4316
|
+
int64Value?: string;
|
|
4317
|
+
/** A variable-length string value. */
|
|
4318
|
+
stringValue?: string;
|
|
4319
|
+
}
|
|
4148
4320
|
interface GoogleProtobufEmpty {}
|
|
4149
4321
|
interface GoogleRpcStatus {
|
|
4150
4322
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
@@ -5918,6 +6090,64 @@ declare namespace gapi.client {
|
|
|
5918
6090
|
},
|
|
5919
6091
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
5920
6092
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
6093
|
+
/** 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. */
|
|
6094
|
+
searchLite(request: {
|
|
6095
|
+
/** V1 error format. */
|
|
6096
|
+
'$.xgafv'?: string;
|
|
6097
|
+
/** OAuth access token. */
|
|
6098
|
+
access_token?: string;
|
|
6099
|
+
/** Data format for response. */
|
|
6100
|
+
alt?: string;
|
|
6101
|
+
/** JSONP */
|
|
6102
|
+
callback?: string;
|
|
6103
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6104
|
+
fields?: string;
|
|
6105
|
+
/** 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. */
|
|
6106
|
+
key?: string;
|
|
6107
|
+
/** OAuth 2.0 token for the current user. */
|
|
6108
|
+
oauth_token?: string;
|
|
6109
|
+
/** Returns response with indentations and line breaks. */
|
|
6110
|
+
prettyPrint?: boolean;
|
|
6111
|
+
/** 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. */
|
|
6112
|
+
quotaUser?: string;
|
|
6113
|
+
/** 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. */
|
|
6114
|
+
servingConfig: string;
|
|
6115
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6116
|
+
upload_protocol?: string;
|
|
6117
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6118
|
+
uploadType?: string;
|
|
6119
|
+
/** Request body */
|
|
6120
|
+
resource: GoogleCloudDiscoveryengineV1SearchRequest;
|
|
6121
|
+
}): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
6122
|
+
searchLite(
|
|
6123
|
+
request: {
|
|
6124
|
+
/** V1 error format. */
|
|
6125
|
+
'$.xgafv'?: string;
|
|
6126
|
+
/** OAuth access token. */
|
|
6127
|
+
access_token?: string;
|
|
6128
|
+
/** Data format for response. */
|
|
6129
|
+
alt?: string;
|
|
6130
|
+
/** JSONP */
|
|
6131
|
+
callback?: string;
|
|
6132
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6133
|
+
fields?: string;
|
|
6134
|
+
/** 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. */
|
|
6135
|
+
key?: string;
|
|
6136
|
+
/** OAuth 2.0 token for the current user. */
|
|
6137
|
+
oauth_token?: string;
|
|
6138
|
+
/** Returns response with indentations and line breaks. */
|
|
6139
|
+
prettyPrint?: boolean;
|
|
6140
|
+
/** 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. */
|
|
6141
|
+
quotaUser?: string;
|
|
6142
|
+
/** 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. */
|
|
6143
|
+
servingConfig: string;
|
|
6144
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6145
|
+
upload_protocol?: string;
|
|
6146
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6147
|
+
uploadType?: string;
|
|
6148
|
+
},
|
|
6149
|
+
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
6150
|
+
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
5921
6151
|
}
|
|
5922
6152
|
interface AnswersResource {
|
|
5923
6153
|
/** Gets a Answer. */
|
|
@@ -8225,6 +8455,64 @@ declare namespace gapi.client {
|
|
|
8225
8455
|
},
|
|
8226
8456
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
8227
8457
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
8458
|
+
/** 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. */
|
|
8459
|
+
searchLite(request: {
|
|
8460
|
+
/** V1 error format. */
|
|
8461
|
+
'$.xgafv'?: string;
|
|
8462
|
+
/** OAuth access token. */
|
|
8463
|
+
access_token?: string;
|
|
8464
|
+
/** Data format for response. */
|
|
8465
|
+
alt?: string;
|
|
8466
|
+
/** JSONP */
|
|
8467
|
+
callback?: string;
|
|
8468
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8469
|
+
fields?: string;
|
|
8470
|
+
/** 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. */
|
|
8471
|
+
key?: string;
|
|
8472
|
+
/** OAuth 2.0 token for the current user. */
|
|
8473
|
+
oauth_token?: string;
|
|
8474
|
+
/** Returns response with indentations and line breaks. */
|
|
8475
|
+
prettyPrint?: boolean;
|
|
8476
|
+
/** 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. */
|
|
8477
|
+
quotaUser?: string;
|
|
8478
|
+
/** 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. */
|
|
8479
|
+
servingConfig: string;
|
|
8480
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8481
|
+
upload_protocol?: string;
|
|
8482
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8483
|
+
uploadType?: string;
|
|
8484
|
+
/** Request body */
|
|
8485
|
+
resource: GoogleCloudDiscoveryengineV1SearchRequest;
|
|
8486
|
+
}): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
8487
|
+
searchLite(
|
|
8488
|
+
request: {
|
|
8489
|
+
/** V1 error format. */
|
|
8490
|
+
'$.xgafv'?: string;
|
|
8491
|
+
/** OAuth access token. */
|
|
8492
|
+
access_token?: string;
|
|
8493
|
+
/** Data format for response. */
|
|
8494
|
+
alt?: string;
|
|
8495
|
+
/** JSONP */
|
|
8496
|
+
callback?: string;
|
|
8497
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8498
|
+
fields?: string;
|
|
8499
|
+
/** 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. */
|
|
8500
|
+
key?: string;
|
|
8501
|
+
/** OAuth 2.0 token for the current user. */
|
|
8502
|
+
oauth_token?: string;
|
|
8503
|
+
/** Returns response with indentations and line breaks. */
|
|
8504
|
+
prettyPrint?: boolean;
|
|
8505
|
+
/** 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. */
|
|
8506
|
+
quotaUser?: string;
|
|
8507
|
+
/** 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. */
|
|
8508
|
+
servingConfig: string;
|
|
8509
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8510
|
+
upload_protocol?: string;
|
|
8511
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8512
|
+
uploadType?: string;
|
|
8513
|
+
},
|
|
8514
|
+
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
8515
|
+
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
8228
8516
|
}
|
|
8229
8517
|
interface AnswersResource {
|
|
8230
8518
|
/** Gets a Answer. */
|
|
@@ -10352,6 +10640,64 @@ declare namespace gapi.client {
|
|
|
10352
10640
|
},
|
|
10353
10641
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
10354
10642
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
10643
|
+
/** 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. */
|
|
10644
|
+
searchLite(request: {
|
|
10645
|
+
/** V1 error format. */
|
|
10646
|
+
'$.xgafv'?: string;
|
|
10647
|
+
/** OAuth access token. */
|
|
10648
|
+
access_token?: string;
|
|
10649
|
+
/** Data format for response. */
|
|
10650
|
+
alt?: string;
|
|
10651
|
+
/** JSONP */
|
|
10652
|
+
callback?: string;
|
|
10653
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10654
|
+
fields?: string;
|
|
10655
|
+
/** 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. */
|
|
10656
|
+
key?: string;
|
|
10657
|
+
/** OAuth 2.0 token for the current user. */
|
|
10658
|
+
oauth_token?: string;
|
|
10659
|
+
/** Returns response with indentations and line breaks. */
|
|
10660
|
+
prettyPrint?: boolean;
|
|
10661
|
+
/** 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. */
|
|
10662
|
+
quotaUser?: string;
|
|
10663
|
+
/** 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. */
|
|
10664
|
+
servingConfig: string;
|
|
10665
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10666
|
+
upload_protocol?: string;
|
|
10667
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10668
|
+
uploadType?: string;
|
|
10669
|
+
/** Request body */
|
|
10670
|
+
resource: GoogleCloudDiscoveryengineV1SearchRequest;
|
|
10671
|
+
}): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
10672
|
+
searchLite(
|
|
10673
|
+
request: {
|
|
10674
|
+
/** V1 error format. */
|
|
10675
|
+
'$.xgafv'?: string;
|
|
10676
|
+
/** OAuth access token. */
|
|
10677
|
+
access_token?: string;
|
|
10678
|
+
/** Data format for response. */
|
|
10679
|
+
alt?: string;
|
|
10680
|
+
/** JSONP */
|
|
10681
|
+
callback?: string;
|
|
10682
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10683
|
+
fields?: string;
|
|
10684
|
+
/** 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. */
|
|
10685
|
+
key?: string;
|
|
10686
|
+
/** OAuth 2.0 token for the current user. */
|
|
10687
|
+
oauth_token?: string;
|
|
10688
|
+
/** Returns response with indentations and line breaks. */
|
|
10689
|
+
prettyPrint?: boolean;
|
|
10690
|
+
/** 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. */
|
|
10691
|
+
quotaUser?: string;
|
|
10692
|
+
/** 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. */
|
|
10693
|
+
servingConfig: string;
|
|
10694
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10695
|
+
upload_protocol?: string;
|
|
10696
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10697
|
+
uploadType?: string;
|
|
10698
|
+
},
|
|
10699
|
+
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
10700
|
+
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
10355
10701
|
}
|
|
10356
10702
|
interface AnswersResource {
|
|
10357
10703
|
/** Gets a Answer. */
|