@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.2.20260620 → 0.3.20260620
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 +30 -64
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -1462,7 +1462,9 @@ declare namespace gapi.client {
|
|
|
1462
1462
|
name?: string;
|
|
1463
1463
|
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
1464
1464
|
parsingConfigOverrides?: {
|
|
1465
|
-
[
|
|
1465
|
+
[
|
|
1466
|
+
P in string
|
|
1467
|
+
]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
1466
1468
|
};
|
|
1467
1469
|
}
|
|
1468
1470
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
|
|
@@ -1581,9 +1583,7 @@ declare namespace gapi.client {
|
|
|
1581
1583
|
/** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
1582
1584
|
modelConfigs?: {
|
|
1583
1585
|
[P in string]:
|
|
1584
|
-
| '
|
|
1585
|
-
| 'MODEL_ENABLED'
|
|
1586
|
-
| 'MODEL_DISABLED';
|
|
1586
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
1587
1587
|
};
|
|
1588
1588
|
/** Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
1589
1589
|
name?: string;
|
|
@@ -1697,10 +1697,7 @@ declare namespace gapi.client {
|
|
|
1697
1697
|
lastTuneTime?: string;
|
|
1698
1698
|
/** Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. */
|
|
1699
1699
|
servingState?:
|
|
1700
|
-
| '
|
|
1701
|
-
| 'INACTIVE'
|
|
1702
|
-
| 'ACTIVE'
|
|
1703
|
-
| 'TUNED';
|
|
1700
|
+
'SERVING_STATE_UNSPECIFIED' | 'INACTIVE' | 'ACTIVE' | 'TUNED';
|
|
1704
1701
|
/** Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. */
|
|
1705
1702
|
tuningOperation?: string;
|
|
1706
1703
|
}
|
|
@@ -1758,11 +1755,7 @@ declare namespace gapi.client {
|
|
|
1758
1755
|
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
1759
1756
|
/** Output only. The state of the evaluation. */
|
|
1760
1757
|
state?:
|
|
1761
|
-
| '
|
|
1762
|
-
| 'PENDING'
|
|
1763
|
-
| 'RUNNING'
|
|
1764
|
-
| 'SUCCEEDED'
|
|
1765
|
-
| 'FAILED';
|
|
1758
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
1766
1759
|
}
|
|
1767
1760
|
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec {
|
|
1768
1761
|
/** Optional. The specification of the query set. */
|
|
@@ -2616,9 +2609,7 @@ declare namespace gapi.client {
|
|
|
2616
2609
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
2617
2610
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
2618
2611
|
searchResultMode?:
|
|
2619
|
-
| '
|
|
2620
|
-
| 'DOCUMENTS'
|
|
2621
|
-
| 'CHUNKS';
|
|
2612
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
2622
2613
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
2623
2614
|
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
2624
2615
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -2769,14 +2760,10 @@ declare namespace gapi.client {
|
|
|
2769
2760
|
allowedFieldNames?: string[];
|
|
2770
2761
|
/** Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. */
|
|
2771
2762
|
extractedFilterBehavior?:
|
|
2772
|
-
| '
|
|
2773
|
-
| 'HARD_FILTER'
|
|
2774
|
-
| 'SOFT_BOOST';
|
|
2763
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
2775
2764
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
2776
2765
|
filterExtractionCondition?:
|
|
2777
|
-
| '
|
|
2778
|
-
| 'DISABLED'
|
|
2779
|
-
| 'ENABLED';
|
|
2766
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
2780
2767
|
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. */
|
|
2781
2768
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
2782
2769
|
}
|
|
@@ -3278,9 +3265,7 @@ declare namespace gapi.client {
|
|
|
3278
3265
|
interface GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion {
|
|
3279
3266
|
/** The type of the content suggestion. */
|
|
3280
3267
|
contentType?:
|
|
3281
|
-
| '
|
|
3282
|
-
| 'GOOGLE_WORKSPACE'
|
|
3283
|
-
| 'THIRD_PARTY';
|
|
3268
|
+
'CONTENT_TYPE_UNSPECIFIED' | 'GOOGLE_WORKSPACE' | 'THIRD_PARTY';
|
|
3284
3269
|
/** The name of the dataStore that this suggestion belongs to. */
|
|
3285
3270
|
dataStore?: string;
|
|
3286
3271
|
/** The destination uri of the content suggestion. */
|
|
@@ -3305,9 +3290,7 @@ declare namespace gapi.client {
|
|
|
3305
3290
|
document?: GoogleCloudDiscoveryengineV1betaDocument;
|
|
3306
3291
|
/** The type of the person. */
|
|
3307
3292
|
personType?:
|
|
3308
|
-
| '
|
|
3309
|
-
| 'CLOUD_IDENTITY'
|
|
3310
|
-
| 'THIRD_PARTY_IDENTITY';
|
|
3293
|
+
'PERSON_TYPE_UNSPECIFIED' | 'CLOUD_IDENTITY' | 'THIRD_PARTY_IDENTITY';
|
|
3311
3294
|
/** The score of each suggestion. The score is in the range of [0, 1]. */
|
|
3312
3295
|
score?: number;
|
|
3313
3296
|
/** The suggestion for the query. */
|
|
@@ -3634,9 +3617,7 @@ declare namespace gapi.client {
|
|
|
3634
3617
|
orderBy?: string;
|
|
3635
3618
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */
|
|
3636
3619
|
searchResultMode?:
|
|
3637
|
-
| '
|
|
3638
|
-
| 'DOCUMENTS'
|
|
3639
|
-
| 'CHUNKS';
|
|
3620
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
3640
3621
|
}
|
|
3641
3622
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList {
|
|
3642
3623
|
/** Search results. */
|
|
@@ -4092,10 +4073,7 @@ declare namespace gapi.client {
|
|
|
4092
4073
|
matcherValue?: GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
|
|
4093
4074
|
/** The state of the document. */
|
|
4094
4075
|
state?:
|
|
4095
|
-
| '
|
|
4096
|
-
| 'INDEXED'
|
|
4097
|
-
| 'NOT_IN_TARGET_SITE'
|
|
4098
|
-
| 'NOT_IN_INDEX';
|
|
4076
|
+
'STATE_UNSPECIFIED' | 'INDEXED' | 'NOT_IN_TARGET_SITE' | 'NOT_IN_INDEX';
|
|
4099
4077
|
}
|
|
4100
4078
|
interface GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
4101
4079
|
/** Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
@@ -4149,7 +4127,9 @@ declare namespace gapi.client {
|
|
|
4149
4127
|
interface GoogleCloudDiscoveryengineV1betaBigtableOptions {
|
|
4150
4128
|
/** The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. */
|
|
4151
4129
|
families?: {
|
|
4152
|
-
[
|
|
4130
|
+
[
|
|
4131
|
+
P in string
|
|
4132
|
+
]: GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily;
|
|
4153
4133
|
};
|
|
4154
4134
|
/** The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */
|
|
4155
4135
|
keyFieldName?: string;
|
|
@@ -4910,7 +4890,9 @@ declare namespace gapi.client {
|
|
|
4910
4890
|
name?: string;
|
|
4911
4891
|
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
4912
4892
|
parsingConfigOverrides?: {
|
|
4913
|
-
[
|
|
4893
|
+
[
|
|
4894
|
+
P in string
|
|
4895
|
+
]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
4914
4896
|
};
|
|
4915
4897
|
}
|
|
4916
4898
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
@@ -5028,9 +5010,7 @@ declare namespace gapi.client {
|
|
|
5028
5010
|
/** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
5029
5011
|
modelConfigs?: {
|
|
5030
5012
|
[P in string]:
|
|
5031
|
-
| '
|
|
5032
|
-
| 'MODEL_ENABLED'
|
|
5033
|
-
| 'MODEL_DISABLED';
|
|
5013
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
5034
5014
|
};
|
|
5035
5015
|
/** Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
5036
5016
|
name?: string;
|
|
@@ -5174,11 +5154,7 @@ declare namespace gapi.client {
|
|
|
5174
5154
|
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
5175
5155
|
/** Output only. The state of the evaluation. */
|
|
5176
5156
|
state?:
|
|
5177
|
-
| '
|
|
5178
|
-
| 'PENDING'
|
|
5179
|
-
| 'RUNNING'
|
|
5180
|
-
| 'SUCCEEDED'
|
|
5181
|
-
| 'FAILED';
|
|
5157
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
5182
5158
|
}
|
|
5183
5159
|
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec {
|
|
5184
5160
|
/** Optional. The specification of the query set. */
|
|
@@ -5412,9 +5388,7 @@ declare namespace gapi.client {
|
|
|
5412
5388
|
inlineSource?: GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource;
|
|
5413
5389
|
/** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
5414
5390
|
reconciliationMode?:
|
|
5415
|
-
| '
|
|
5416
|
-
| 'INCREMENTAL'
|
|
5417
|
-
| 'FULL';
|
|
5391
|
+
'RECONCILIATION_MODE_UNSPECIFIED' | 'INCREMENTAL' | 'FULL';
|
|
5418
5392
|
/** Spanner input source. */
|
|
5419
5393
|
spannerSource?: GoogleCloudDiscoveryengineV1betaSpannerSource;
|
|
5420
5394
|
/** Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */
|
|
@@ -6373,9 +6347,7 @@ declare namespace gapi.client {
|
|
|
6373
6347
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
6374
6348
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
6375
6349
|
searchResultMode?:
|
|
6376
|
-
| '
|
|
6377
|
-
| 'DOCUMENTS'
|
|
6378
|
-
| 'CHUNKS';
|
|
6350
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
6379
6351
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
6380
6352
|
snippetSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec;
|
|
6381
6353
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -6526,14 +6498,10 @@ declare namespace gapi.client {
|
|
|
6526
6498
|
allowedFieldNames?: string[];
|
|
6527
6499
|
/** Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. */
|
|
6528
6500
|
extractedFilterBehavior?:
|
|
6529
|
-
| '
|
|
6530
|
-
| 'HARD_FILTER'
|
|
6531
|
-
| 'SOFT_BOOST';
|
|
6501
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
6532
6502
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
6533
6503
|
filterExtractionCondition?:
|
|
6534
|
-
| '
|
|
6535
|
-
| 'DISABLED'
|
|
6536
|
-
| 'ENABLED';
|
|
6504
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
6537
6505
|
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. */
|
|
6538
6506
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
6539
6507
|
}
|
|
@@ -7924,7 +7892,9 @@ declare namespace gapi.client {
|
|
|
7924
7892
|
name?: string;
|
|
7925
7893
|
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
7926
7894
|
parsingConfigOverrides?: {
|
|
7927
|
-
[
|
|
7895
|
+
[
|
|
7896
|
+
P in string
|
|
7897
|
+
]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
7928
7898
|
};
|
|
7929
7899
|
}
|
|
7930
7900
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
@@ -8043,9 +8013,7 @@ declare namespace gapi.client {
|
|
|
8043
8013
|
/** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
8044
8014
|
modelConfigs?: {
|
|
8045
8015
|
[P in string]:
|
|
8046
|
-
| '
|
|
8047
|
-
| 'MODEL_ENABLED'
|
|
8048
|
-
| 'MODEL_DISABLED';
|
|
8016
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
8049
8017
|
};
|
|
8050
8018
|
/** Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
8051
8019
|
name?: string;
|
|
@@ -8516,9 +8484,7 @@ declare namespace gapi.client {
|
|
|
8516
8484
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
|
|
8517
8485
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
8518
8486
|
searchResultMode?:
|
|
8519
|
-
| '
|
|
8520
|
-
| 'DOCUMENTS'
|
|
8521
|
-
| 'CHUNKS';
|
|
8487
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
8522
8488
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
8523
8489
|
snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
|
|
8524
8490
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|