@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20250331 → 0.0.20250410
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 +61 -8
- 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: 20250410
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1096,10 +1096,14 @@ declare namespace gapi.client {
|
|
|
1096
1096
|
value?: GoogleMonitoringV3TypedValue;
|
|
1097
1097
|
}
|
|
1098
1098
|
interface GoogleCloudDiscoveryengineV1alphaChunk {
|
|
1099
|
+
/** Output only. Annotation contents if the current chunk contains annotations. */
|
|
1100
|
+
annotationContents?: string[];
|
|
1099
1101
|
/** Output only. Metadata of the current chunk. */
|
|
1100
1102
|
chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
|
|
1101
1103
|
/** Content is a string from a document (parsed content). */
|
|
1102
1104
|
content?: string;
|
|
1105
|
+
/** Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
|
|
1106
|
+
dataUrls?: string[];
|
|
1103
1107
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
1104
1108
|
derivedStructData?: {[P in string]: any};
|
|
1105
1109
|
/** Metadata of the document from the current chunk. */
|
|
@@ -1212,7 +1216,7 @@ declare namespace gapi.client {
|
|
|
1212
1216
|
interface GoogleCloudDiscoveryengineV1alphaCondition {
|
|
1213
1217
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
1214
1218
|
activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
|
|
1215
|
-
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set.
|
|
1219
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */
|
|
1216
1220
|
queryRegex?: string;
|
|
1217
1221
|
/** 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. */
|
|
1218
1222
|
queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
|
|
@@ -1709,7 +1713,7 @@ declare namespace gapi.client {
|
|
|
1709
1713
|
interface GoogleCloudDiscoveryengineV1alphaDocument {
|
|
1710
1714
|
/** Access control information for the document. */
|
|
1711
1715
|
aclInfo?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
|
|
1712
|
-
/** The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */
|
|
1716
|
+
/** The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. */
|
|
1713
1717
|
content?: GoogleCloudDiscoveryengineV1alphaDocumentContent;
|
|
1714
1718
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
1715
1719
|
derivedStructData?: {[P in string]: any};
|
|
@@ -1741,7 +1745,7 @@ declare namespace gapi.client {
|
|
|
1741
1745
|
principals?: GoogleCloudDiscoveryengineV1alphaPrincipal[];
|
|
1742
1746
|
}
|
|
1743
1747
|
interface GoogleCloudDiscoveryengineV1alphaDocumentContent {
|
|
1744
|
-
/** The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `
|
|
1748
|
+
/** The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
1745
1749
|
mimeType?: string;
|
|
1746
1750
|
/** The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. */
|
|
1747
1751
|
rawBytes?: string;
|
|
@@ -2062,6 +2066,18 @@ declare namespace gapi.client {
|
|
|
2062
2066
|
/** Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
|
|
2063
2067
|
inputUris?: string[];
|
|
2064
2068
|
}
|
|
2069
|
+
interface GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse {
|
|
2070
|
+
/** The app name of the associated Connector. */
|
|
2071
|
+
app?: string;
|
|
2072
|
+
/** The client id of the associated Connector. */
|
|
2073
|
+
clientId?: string;
|
|
2074
|
+
/** The instance name of the associated Connector. */
|
|
2075
|
+
instance?: string;
|
|
2076
|
+
/** The redirect url of the associated Connector. */
|
|
2077
|
+
redirectUri?: string;
|
|
2078
|
+
/** The tenant id of the associated Connector. */
|
|
2079
|
+
tenantId?: string;
|
|
2080
|
+
}
|
|
2065
2081
|
interface GoogleCloudDiscoveryengineV1alphaGetSessionRequest {
|
|
2066
2082
|
/** Optional. If set to true, the full session including all answer details will be returned. */
|
|
2067
2083
|
includeAnswerDetails?: boolean;
|
|
@@ -2985,6 +3001,8 @@ declare namespace gapi.client {
|
|
|
2985
3001
|
interface GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion {
|
|
2986
3002
|
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
2987
3003
|
description?: string;
|
|
3004
|
+
/** Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. */
|
|
3005
|
+
document?: string;
|
|
2988
3006
|
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
2989
3007
|
enabled?: boolean;
|
|
2990
3008
|
/** Optional. The promotion thumbnail image url. */
|
|
@@ -4136,7 +4154,7 @@ declare namespace gapi.client {
|
|
|
4136
4154
|
interface GoogleCloudDiscoveryengineV1betaCondition {
|
|
4137
4155
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
4138
4156
|
activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
|
|
4139
|
-
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set.
|
|
4157
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */
|
|
4140
4158
|
queryRegex?: string;
|
|
4141
4159
|
/** 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. */
|
|
4142
4160
|
queryTerms?: GoogleCloudDiscoveryengineV1betaConditionQueryTerm[];
|
|
@@ -4759,6 +4777,8 @@ declare namespace gapi.client {
|
|
|
4759
4777
|
interface GoogleCloudDiscoveryengineV1betaSearchLinkPromotion {
|
|
4760
4778
|
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
4761
4779
|
description?: string;
|
|
4780
|
+
/** Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. */
|
|
4781
|
+
document?: string;
|
|
4762
4782
|
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
4763
4783
|
enabled?: boolean;
|
|
4764
4784
|
/** Optional. The promotion thumbnail image url. */
|
|
@@ -5162,7 +5182,7 @@ declare namespace gapi.client {
|
|
|
5162
5182
|
interface GoogleCloudDiscoveryengineV1Condition {
|
|
5163
5183
|
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
5164
5184
|
activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
|
|
5165
|
-
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set.
|
|
5185
|
+
/** Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */
|
|
5166
5186
|
queryRegex?: string;
|
|
5167
5187
|
/** 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. */
|
|
5168
5188
|
queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
|
|
@@ -5664,6 +5684,8 @@ declare namespace gapi.client {
|
|
|
5664
5684
|
interface GoogleCloudDiscoveryengineV1SearchLinkPromotion {
|
|
5665
5685
|
/** Optional. The Promotion description. Maximum length: 200 characters. */
|
|
5666
5686
|
description?: string;
|
|
5687
|
+
/** Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. */
|
|
5688
|
+
document?: string;
|
|
5667
5689
|
/** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
|
|
5668
5690
|
enabled?: boolean;
|
|
5669
5691
|
/** Optional. The promotion thumbnail image url. */
|
|
@@ -6322,6 +6344,33 @@ declare namespace gapi.client {
|
|
|
6322
6344
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
6323
6345
|
}
|
|
6324
6346
|
interface DataConnectorResource {
|
|
6347
|
+
/** Get the secret for the associated connector. */
|
|
6348
|
+
getConnectorSecret(request?: {
|
|
6349
|
+
/** V1 error format. */
|
|
6350
|
+
'$.xgafv'?: string;
|
|
6351
|
+
/** OAuth access token. */
|
|
6352
|
+
access_token?: string;
|
|
6353
|
+
/** Data format for response. */
|
|
6354
|
+
alt?: string;
|
|
6355
|
+
/** JSONP */
|
|
6356
|
+
callback?: string;
|
|
6357
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6358
|
+
fields?: string;
|
|
6359
|
+
/** 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. */
|
|
6360
|
+
key?: string;
|
|
6361
|
+
/** Required. The full resource name of the associated data connector. */
|
|
6362
|
+
name: string;
|
|
6363
|
+
/** OAuth 2.0 token for the current user. */
|
|
6364
|
+
oauth_token?: string;
|
|
6365
|
+
/** Returns response with indentations and line breaks. */
|
|
6366
|
+
prettyPrint?: boolean;
|
|
6367
|
+
/** 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. */
|
|
6368
|
+
quotaUser?: string;
|
|
6369
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6370
|
+
upload_protocol?: string;
|
|
6371
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6372
|
+
uploadType?: string;
|
|
6373
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse>;
|
|
6325
6374
|
/** Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced. */
|
|
6326
6375
|
startConnectorRun(request: {
|
|
6327
6376
|
/** V1 error format. */
|
|
@@ -6572,6 +6621,8 @@ declare namespace gapi.client {
|
|
|
6572
6621
|
callback?: string;
|
|
6573
6622
|
/** Selector specifying which fields to include in a partial response. */
|
|
6574
6623
|
fields?: string;
|
|
6624
|
+
/** Optional. Specifies config for IMAGE_BYTES. */
|
|
6625
|
+
imageId?: string;
|
|
6575
6626
|
/** 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. */
|
|
6576
6627
|
key?: string;
|
|
6577
6628
|
/** Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. */
|
|
@@ -12379,7 +12430,7 @@ declare namespace gapi.client {
|
|
|
12379
12430
|
prettyPrint?: boolean;
|
|
12380
12431
|
/** 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. */
|
|
12381
12432
|
quotaUser?: string;
|
|
12382
|
-
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - destination_configs - blocking_reasons - sync_mode Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */
|
|
12433
|
+
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */
|
|
12383
12434
|
updateMask?: string;
|
|
12384
12435
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12385
12436
|
upload_protocol?: string;
|
|
@@ -12410,7 +12461,7 @@ declare namespace gapi.client {
|
|
|
12410
12461
|
prettyPrint?: boolean;
|
|
12411
12462
|
/** 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. */
|
|
12412
12463
|
quotaUser?: string;
|
|
12413
|
-
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - destination_configs - blocking_reasons - sync_mode Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */
|
|
12464
|
+
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */
|
|
12414
12465
|
updateMask?: string;
|
|
12415
12466
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12416
12467
|
upload_protocol?: string;
|
|
@@ -12613,6 +12664,8 @@ declare namespace gapi.client {
|
|
|
12613
12664
|
callback?: string;
|
|
12614
12665
|
/** Selector specifying which fields to include in a partial response. */
|
|
12615
12666
|
fields?: string;
|
|
12667
|
+
/** Optional. Specifies config for IMAGE_BYTES. */
|
|
12668
|
+
imageId?: string;
|
|
12616
12669
|
/** 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. */
|
|
12617
12670
|
key?: string;
|
|
12618
12671
|
/** Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. */
|