@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240526 → 0.0.20240607
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 +315 -11
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240607
|
|
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,12 @@ 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 GoogleApiMonitoredResource {
|
|
98
|
+
/** 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"`. */
|
|
99
|
+
labels?: {[P in string]: string};
|
|
100
|
+
/** 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`. */
|
|
101
|
+
type?: string;
|
|
102
|
+
}
|
|
39
103
|
interface GoogleCloudDiscoveryengineLoggingErrorContext {
|
|
40
104
|
/** The HTTP request which was processed when the error was triggered. */
|
|
41
105
|
httpRequest?: GoogleCloudDiscoveryengineLoggingHttpRequestContext;
|
|
@@ -88,6 +152,20 @@ declare namespace gapi.client {
|
|
|
88
152
|
/** 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
153
|
name?: string;
|
|
90
154
|
}
|
|
155
|
+
interface GoogleCloudDiscoveryengineV1alphaAlloyDbSource {
|
|
156
|
+
/** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
|
|
157
|
+
clusterId?: string;
|
|
158
|
+
/** Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */
|
|
159
|
+
databaseId?: string;
|
|
160
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
|
|
161
|
+
gcsStagingDir?: string;
|
|
162
|
+
/** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
|
|
163
|
+
locationId?: string;
|
|
164
|
+
/** The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
165
|
+
projectId?: string;
|
|
166
|
+
/** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
|
|
167
|
+
tableId?: string;
|
|
168
|
+
}
|
|
91
169
|
interface GoogleCloudDiscoveryengineV1alphaAnswer {
|
|
92
170
|
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
93
171
|
answerSkippedReasons?: string[];
|
|
@@ -141,6 +219,8 @@ declare namespace gapi.client {
|
|
|
141
219
|
searchSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec;
|
|
142
220
|
/** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
|
|
143
221
|
session?: string;
|
|
222
|
+
/** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
|
|
223
|
+
userLabels?: {[P in string]: string};
|
|
144
224
|
/** 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
145
225
|
userPseudoId?: string;
|
|
146
226
|
}
|
|
@@ -477,6 +557,36 @@ declare namespace gapi.client {
|
|
|
477
557
|
/** 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. */
|
|
478
558
|
citationThreshold?: number;
|
|
479
559
|
}
|
|
560
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest {
|
|
561
|
+
/** A Requirement.type specifying the requirement to check. */
|
|
562
|
+
requirementType?: string;
|
|
563
|
+
/** The resources to be checked for this requirement. */
|
|
564
|
+
resources?: GoogleApiMonitoredResource[];
|
|
565
|
+
}
|
|
566
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse {
|
|
567
|
+
/** Metric results. */
|
|
568
|
+
metricResults?: GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult[];
|
|
569
|
+
/** Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time. */
|
|
570
|
+
oldestMetricTimestamp?: string;
|
|
571
|
+
/** Requirement definition. */
|
|
572
|
+
requirement?: GoogleCloudDiscoveryengineV1alphaRequirement;
|
|
573
|
+
/** The condition for evaluating the requirement result. */
|
|
574
|
+
requirementCondition?: GoogleTypeExpr;
|
|
575
|
+
/** Requirement result, e.g. pass or fail. */
|
|
576
|
+
requirementResult?: string;
|
|
577
|
+
}
|
|
578
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult {
|
|
579
|
+
/** Type identifier of the metric corresponding to this query result. */
|
|
580
|
+
metricType?: string;
|
|
581
|
+
/** This metric query name is mapping to variables in the requirement_condition. */
|
|
582
|
+
name?: string;
|
|
583
|
+
/** Time corresponding to when this metric value was calculated. */
|
|
584
|
+
timestamp?: string;
|
|
585
|
+
/** The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. */
|
|
586
|
+
unit?: string;
|
|
587
|
+
/** Value of the metric query. */
|
|
588
|
+
value?: GoogleMonitoringV3TypedValue;
|
|
589
|
+
}
|
|
480
590
|
interface GoogleCloudDiscoveryengineV1alphaChunk {
|
|
481
591
|
/** Output only. Metadata of the current chunk. */
|
|
482
592
|
chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
|
|
@@ -1101,6 +1211,8 @@ declare namespace gapi.client {
|
|
|
1101
1211
|
updateTime?: string;
|
|
1102
1212
|
}
|
|
1103
1213
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
|
|
1214
|
+
/** AlloyDB input source. */
|
|
1215
|
+
alloyDbSource?: GoogleCloudDiscoveryengineV1alphaAlloyDbSource;
|
|
1104
1216
|
/** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
|
|
1105
1217
|
autoGenerateIds?: boolean;
|
|
1106
1218
|
/** BigQuery input source. */
|
|
@@ -1541,6 +1653,52 @@ declare namespace gapi.client {
|
|
|
1541
1653
|
/** Required. The version string of the terms of service to update. */
|
|
1542
1654
|
serviceTermVersion?: string;
|
|
1543
1655
|
}
|
|
1656
|
+
interface GoogleCloudDiscoveryengineV1alphaRequirement {
|
|
1657
|
+
/** The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`. */
|
|
1658
|
+
condition?: GoogleTypeExpr;
|
|
1659
|
+
/** The description of the requirement. */
|
|
1660
|
+
description?: string;
|
|
1661
|
+
/** The name of the requirement. */
|
|
1662
|
+
displayName?: string;
|
|
1663
|
+
/** A list of the metric bindings to be used in `condition`. */
|
|
1664
|
+
metricBindings?: GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding[];
|
|
1665
|
+
/** A list of threshold bindings to be used in `condition`. */
|
|
1666
|
+
thresholdBindings?: GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding[];
|
|
1667
|
+
/** The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encoraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate` */
|
|
1668
|
+
type?: string;
|
|
1669
|
+
/** A list of the metric bindings to be used in `condition`. */
|
|
1670
|
+
violationSamplesBindings?: GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding[];
|
|
1671
|
+
}
|
|
1672
|
+
interface GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding {
|
|
1673
|
+
/** The category of the metric's target resource. Example: "Events" */
|
|
1674
|
+
category?: string;
|
|
1675
|
+
/** Human readable description of the corresponding metric filter. */
|
|
1676
|
+
description?: string;
|
|
1677
|
+
/** The filter string used for metrics query. Example: "metric.type = \"discoveryengine.googleapis.com/events/day_count\" AND " "metric.conditions.time_range = \"NINETY_DAYS\"" */
|
|
1678
|
+
metricFilter?: string;
|
|
1679
|
+
/** The resource being monitored for the metric. */
|
|
1680
|
+
resourceType?: string;
|
|
1681
|
+
/** The variable id to be referenced in `condition`. */
|
|
1682
|
+
variableId?: string;
|
|
1683
|
+
}
|
|
1684
|
+
interface GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding {
|
|
1685
|
+
/** Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`. */
|
|
1686
|
+
blockingThreshold?: number;
|
|
1687
|
+
/** Human readable description of the corresponding threshold and sub-requirement. */
|
|
1688
|
+
description?: string;
|
|
1689
|
+
/** The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`. */
|
|
1690
|
+
variableId?: string;
|
|
1691
|
+
/** Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`. */
|
|
1692
|
+
warningThreshold?: number;
|
|
1693
|
+
}
|
|
1694
|
+
interface GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding {
|
|
1695
|
+
/** Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long. */
|
|
1696
|
+
description?: string;
|
|
1697
|
+
/** The filter string used for samples query. Example: "sample.type = \"retail.googleapis.com/user_event\" AND " "sample.labels.event_type = \"PURCHASE\" " */
|
|
1698
|
+
sampleFilter?: string;
|
|
1699
|
+
/** The variable id to be referenced in `condition`. */
|
|
1700
|
+
variableId?: string;
|
|
1701
|
+
}
|
|
1544
1702
|
interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {}
|
|
1545
1703
|
interface GoogleCloudDiscoveryengineV1alphaSchema {
|
|
1546
1704
|
/** Output only. Configurations for fields of the schema. */
|
|
@@ -1641,7 +1799,7 @@ declare namespace gapi.client {
|
|
|
1641
1799
|
chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
|
|
1642
1800
|
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
1643
1801
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
1644
|
-
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
1802
|
+
/** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. */
|
|
1645
1803
|
searchResultMode?: string;
|
|
1646
1804
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
1647
1805
|
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
@@ -2321,6 +2479,8 @@ declare namespace gapi.client {
|
|
|
2321
2479
|
}
|
|
2322
2480
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
|
|
2323
2481
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
|
|
2482
|
+
/** Whether chunking mode is enabled. */
|
|
2483
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig;
|
|
2324
2484
|
/** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
|
|
2325
2485
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2326
2486
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -2330,13 +2490,26 @@ declare namespace gapi.client {
|
|
|
2330
2490
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2331
2491
|
};
|
|
2332
2492
|
}
|
|
2493
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
2494
|
+
/** Configuration for the layout based chunking. */
|
|
2495
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
2496
|
+
}
|
|
2497
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
2498
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
2499
|
+
chunkSize?: number;
|
|
2500
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
2501
|
+
includeAncestorHeadings?: boolean;
|
|
2502
|
+
}
|
|
2333
2503
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
|
|
2334
2504
|
/** Configurations applied to digital parser. */
|
|
2335
2505
|
digitalParsingConfig?: any;
|
|
2506
|
+
/** Configurations applied to layout parser. */
|
|
2507
|
+
layoutParsingConfig?: any;
|
|
2336
2508
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
2337
2509
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
2338
2510
|
}
|
|
2339
2511
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2512
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
2340
2513
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2341
2514
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
2342
2515
|
enhancedDocumentElements?: string[];
|
|
@@ -2736,6 +2909,8 @@ declare namespace gapi.client {
|
|
|
2736
2909
|
}
|
|
2737
2910
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
|
|
2738
2911
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
|
|
2912
|
+
/** Whether chunking mode is enabled. */
|
|
2913
|
+
chunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig;
|
|
2739
2914
|
/** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
|
|
2740
2915
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2741
2916
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
@@ -2745,13 +2920,26 @@ declare namespace gapi.client {
|
|
|
2745
2920
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2746
2921
|
};
|
|
2747
2922
|
}
|
|
2923
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
2924
|
+
/** Configuration for the layout based chunking. */
|
|
2925
|
+
layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
2926
|
+
}
|
|
2927
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
2928
|
+
/** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
|
|
2929
|
+
chunkSize?: number;
|
|
2930
|
+
/** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
|
|
2931
|
+
includeAncestorHeadings?: boolean;
|
|
2932
|
+
}
|
|
2748
2933
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
|
|
2749
2934
|
/** Configurations applied to digital parser. */
|
|
2750
2935
|
digitalParsingConfig?: any;
|
|
2936
|
+
/** Configurations applied to layout parser. */
|
|
2937
|
+
layoutParsingConfig?: any;
|
|
2751
2938
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
2752
2939
|
ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
2753
2940
|
}
|
|
2754
2941
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2942
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
2755
2943
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2756
2944
|
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
2757
2945
|
enhancedDocumentElements?: string[];
|
|
@@ -3005,6 +3193,18 @@ declare namespace gapi.client {
|
|
|
3005
3193
|
/** 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`. */
|
|
3006
3194
|
response?: {[P in string]: any};
|
|
3007
3195
|
}
|
|
3196
|
+
interface GoogleMonitoringV3TypedValue {
|
|
3197
|
+
/** A Boolean value: `true` or `false`. */
|
|
3198
|
+
boolValue?: boolean;
|
|
3199
|
+
/** A distribution value. */
|
|
3200
|
+
distributionValue?: GoogleApiDistribution;
|
|
3201
|
+
/** A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. */
|
|
3202
|
+
doubleValue?: number;
|
|
3203
|
+
/** A 64-bit integer. Its range is approximately ±9.2x1018. */
|
|
3204
|
+
int64Value?: string;
|
|
3205
|
+
/** A variable-length string value. */
|
|
3206
|
+
stringValue?: string;
|
|
3207
|
+
}
|
|
3008
3208
|
interface GoogleProtobufEmpty {}
|
|
3009
3209
|
interface GoogleRpcStatus {
|
|
3010
3210
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
@@ -3022,6 +3222,16 @@ declare namespace gapi.client {
|
|
|
3022
3222
|
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
3023
3223
|
year?: number;
|
|
3024
3224
|
}
|
|
3225
|
+
interface GoogleTypeExpr {
|
|
3226
|
+
/** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
|
|
3227
|
+
description?: string;
|
|
3228
|
+
/** Textual representation of an expression in Common Expression Language syntax. */
|
|
3229
|
+
expression?: string;
|
|
3230
|
+
/** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
|
|
3231
|
+
location?: string;
|
|
3232
|
+
/** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
|
|
3233
|
+
title?: string;
|
|
3234
|
+
}
|
|
3025
3235
|
interface OperationsResource {
|
|
3026
3236
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
3027
3237
|
get(request?: {
|
|
@@ -3653,7 +3863,7 @@ declare namespace gapi.client {
|
|
|
3653
3863
|
key?: string;
|
|
3654
3864
|
/** OAuth 2.0 token for the current user. */
|
|
3655
3865
|
oauth_token?: string;
|
|
3656
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3866
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3657
3867
|
parent: string;
|
|
3658
3868
|
/** Returns response with indentations and line breaks. */
|
|
3659
3869
|
prettyPrint?: boolean;
|
|
@@ -3684,7 +3894,7 @@ declare namespace gapi.client {
|
|
|
3684
3894
|
key?: string;
|
|
3685
3895
|
/** OAuth 2.0 token for the current user. */
|
|
3686
3896
|
oauth_token?: string;
|
|
3687
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3897
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3688
3898
|
parent: string;
|
|
3689
3899
|
/** Returns response with indentations and line breaks. */
|
|
3690
3900
|
prettyPrint?: boolean;
|
|
@@ -3773,7 +3983,7 @@ declare namespace gapi.client {
|
|
|
3773
3983
|
pageSize?: number;
|
|
3774
3984
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
3775
3985
|
pageToken?: string;
|
|
3776
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
3986
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
3777
3987
|
parent: string;
|
|
3778
3988
|
/** Returns response with indentations and line breaks. */
|
|
3779
3989
|
prettyPrint?: boolean;
|
|
@@ -6524,7 +6734,7 @@ declare namespace gapi.client {
|
|
|
6524
6734
|
key?: string;
|
|
6525
6735
|
/** OAuth 2.0 token for the current user. */
|
|
6526
6736
|
oauth_token?: string;
|
|
6527
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6737
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
6528
6738
|
parent: string;
|
|
6529
6739
|
/** Returns response with indentations and line breaks. */
|
|
6530
6740
|
prettyPrint?: boolean;
|
|
@@ -6555,7 +6765,7 @@ declare namespace gapi.client {
|
|
|
6555
6765
|
key?: string;
|
|
6556
6766
|
/** OAuth 2.0 token for the current user. */
|
|
6557
6767
|
oauth_token?: string;
|
|
6558
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6768
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
6559
6769
|
parent: string;
|
|
6560
6770
|
/** Returns response with indentations and line breaks. */
|
|
6561
6771
|
prettyPrint?: boolean;
|
|
@@ -6644,7 +6854,7 @@ declare namespace gapi.client {
|
|
|
6644
6854
|
pageSize?: number;
|
|
6645
6855
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
6646
6856
|
pageToken?: string;
|
|
6647
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
6857
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
6648
6858
|
parent: string;
|
|
6649
6859
|
/** Returns response with indentations and line breaks. */
|
|
6650
6860
|
prettyPrint?: boolean;
|
|
@@ -8612,7 +8822,7 @@ declare namespace gapi.client {
|
|
|
8612
8822
|
key?: string;
|
|
8613
8823
|
/** OAuth 2.0 token for the current user. */
|
|
8614
8824
|
oauth_token?: string;
|
|
8615
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
8825
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
8616
8826
|
parent: string;
|
|
8617
8827
|
/** Returns response with indentations and line breaks. */
|
|
8618
8828
|
prettyPrint?: boolean;
|
|
@@ -8643,7 +8853,7 @@ declare namespace gapi.client {
|
|
|
8643
8853
|
key?: string;
|
|
8644
8854
|
/** OAuth 2.0 token for the current user. */
|
|
8645
8855
|
oauth_token?: string;
|
|
8646
|
-
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
8856
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
8647
8857
|
parent: string;
|
|
8648
8858
|
/** Returns response with indentations and line breaks. */
|
|
8649
8859
|
prettyPrint?: boolean;
|
|
@@ -8732,7 +8942,7 @@ declare namespace gapi.client {
|
|
|
8732
8942
|
pageSize?: number;
|
|
8733
8943
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
8734
8944
|
pageToken?: string;
|
|
8735
|
-
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
|
|
8945
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
|
|
8736
8946
|
parent: string;
|
|
8737
8947
|
/** Returns response with indentations and line breaks. */
|
|
8738
8948
|
prettyPrint?: boolean;
|
|
@@ -11312,6 +11522,66 @@ declare namespace gapi.client {
|
|
|
11312
11522
|
body: GoogleCloudDiscoveryengineV1alphaRankRequest
|
|
11313
11523
|
): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
|
|
11314
11524
|
}
|
|
11525
|
+
interface RequirementsResource {
|
|
11526
|
+
/** Check a particular requirement. */
|
|
11527
|
+
checkRequirement(request: {
|
|
11528
|
+
/** V1 error format. */
|
|
11529
|
+
'$.xgafv'?: string;
|
|
11530
|
+
/** OAuth access token. */
|
|
11531
|
+
access_token?: string;
|
|
11532
|
+
/** Data format for response. */
|
|
11533
|
+
alt?: string;
|
|
11534
|
+
/** JSONP */
|
|
11535
|
+
callback?: string;
|
|
11536
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11537
|
+
fields?: string;
|
|
11538
|
+
/** 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. */
|
|
11539
|
+
key?: string;
|
|
11540
|
+
/** Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}` */
|
|
11541
|
+
location: string;
|
|
11542
|
+
/** OAuth 2.0 token for the current user. */
|
|
11543
|
+
oauth_token?: string;
|
|
11544
|
+
/** Returns response with indentations and line breaks. */
|
|
11545
|
+
prettyPrint?: boolean;
|
|
11546
|
+
/** 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. */
|
|
11547
|
+
quotaUser?: string;
|
|
11548
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11549
|
+
upload_protocol?: string;
|
|
11550
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11551
|
+
uploadType?: string;
|
|
11552
|
+
/** Request body */
|
|
11553
|
+
resource: GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest;
|
|
11554
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse>;
|
|
11555
|
+
checkRequirement(
|
|
11556
|
+
request: {
|
|
11557
|
+
/** V1 error format. */
|
|
11558
|
+
'$.xgafv'?: string;
|
|
11559
|
+
/** OAuth access token. */
|
|
11560
|
+
access_token?: string;
|
|
11561
|
+
/** Data format for response. */
|
|
11562
|
+
alt?: string;
|
|
11563
|
+
/** JSONP */
|
|
11564
|
+
callback?: string;
|
|
11565
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11566
|
+
fields?: string;
|
|
11567
|
+
/** 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. */
|
|
11568
|
+
key?: string;
|
|
11569
|
+
/** Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}` */
|
|
11570
|
+
location: string;
|
|
11571
|
+
/** OAuth 2.0 token for the current user. */
|
|
11572
|
+
oauth_token?: string;
|
|
11573
|
+
/** Returns response with indentations and line breaks. */
|
|
11574
|
+
prettyPrint?: boolean;
|
|
11575
|
+
/** 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. */
|
|
11576
|
+
quotaUser?: string;
|
|
11577
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11578
|
+
upload_protocol?: string;
|
|
11579
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11580
|
+
uploadType?: string;
|
|
11581
|
+
},
|
|
11582
|
+
body: GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest
|
|
11583
|
+
): Request<GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse>;
|
|
11584
|
+
}
|
|
11315
11585
|
interface OperationsResource {
|
|
11316
11586
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
11317
11587
|
get(request?: {
|
|
@@ -11345,6 +11615,39 @@ declare namespace gapi.client {
|
|
|
11345
11615
|
operations: OperationsResource;
|
|
11346
11616
|
}
|
|
11347
11617
|
interface UserEventsResource {
|
|
11618
|
+
/** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
|
|
11619
|
+
collect(request?: {
|
|
11620
|
+
/** V1 error format. */
|
|
11621
|
+
'$.xgafv'?: string;
|
|
11622
|
+
/** OAuth access token. */
|
|
11623
|
+
access_token?: string;
|
|
11624
|
+
/** Data format for response. */
|
|
11625
|
+
alt?: string;
|
|
11626
|
+
/** JSONP */
|
|
11627
|
+
callback?: string;
|
|
11628
|
+
/** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
|
|
11629
|
+
ets?: string;
|
|
11630
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11631
|
+
fields?: string;
|
|
11632
|
+
/** 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. */
|
|
11633
|
+
key?: string;
|
|
11634
|
+
/** OAuth 2.0 token for the current user. */
|
|
11635
|
+
oauth_token?: string;
|
|
11636
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
11637
|
+
parent: string;
|
|
11638
|
+
/** Returns response with indentations and line breaks. */
|
|
11639
|
+
prettyPrint?: boolean;
|
|
11640
|
+
/** 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. */
|
|
11641
|
+
quotaUser?: string;
|
|
11642
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11643
|
+
upload_protocol?: string;
|
|
11644
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11645
|
+
uploadType?: string;
|
|
11646
|
+
/** The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. */
|
|
11647
|
+
uri?: string;
|
|
11648
|
+
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
11649
|
+
userEvent?: string;
|
|
11650
|
+
}): Request<GoogleApiHttpBody>;
|
|
11348
11651
|
/** Writes a single user event. */
|
|
11349
11652
|
write(request: {
|
|
11350
11653
|
/** V1 error format. */
|
|
@@ -11558,6 +11861,7 @@ declare namespace gapi.client {
|
|
|
11558
11861
|
groundingConfigs: GroundingConfigsResource;
|
|
11559
11862
|
operations: OperationsResource;
|
|
11560
11863
|
rankingConfigs: RankingConfigsResource;
|
|
11864
|
+
requirements: RequirementsResource;
|
|
11561
11865
|
sampleQuerySets: SampleQuerySetsResource;
|
|
11562
11866
|
userEvents: UserEventsResource;
|
|
11563
11867
|
}
|