@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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 +50 -98
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -359,9 +359,7 @@ declare namespace gapi.client {
|
|
|
359
359
|
interface GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion {
|
|
360
360
|
/** The type of the content suggestion. */
|
|
361
361
|
contentType?:
|
|
362
|
-
| '
|
|
363
|
-
| 'GOOGLE_WORKSPACE'
|
|
364
|
-
| 'THIRD_PARTY';
|
|
362
|
+
'CONTENT_TYPE_UNSPECIFIED' | 'GOOGLE_WORKSPACE' | 'THIRD_PARTY';
|
|
365
363
|
/** The name of the dataStore that this suggestion belongs to. */
|
|
366
364
|
dataStore?: string;
|
|
367
365
|
/** The destination uri of the content suggestion. */
|
|
@@ -386,9 +384,7 @@ declare namespace gapi.client {
|
|
|
386
384
|
document?: GoogleCloudDiscoveryengineV1alphaDocument;
|
|
387
385
|
/** The type of the person. */
|
|
388
386
|
personType?:
|
|
389
|
-
| '
|
|
390
|
-
| 'CLOUD_IDENTITY'
|
|
391
|
-
| 'THIRD_PARTY_IDENTITY';
|
|
387
|
+
'PERSON_TYPE_UNSPECIFIED' | 'CLOUD_IDENTITY' | 'THIRD_PARTY_IDENTITY';
|
|
392
388
|
/** The score of each suggestion. The score is in the range of [0, 1]. */
|
|
393
389
|
score?: number;
|
|
394
390
|
/** The suggestion for the query. */
|
|
@@ -828,9 +824,7 @@ declare namespace gapi.client {
|
|
|
828
824
|
orderBy?: string;
|
|
829
825
|
/** 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) */
|
|
830
826
|
searchResultMode?:
|
|
831
|
-
| '
|
|
832
|
-
| 'DOCUMENTS'
|
|
833
|
-
| 'CHUNKS';
|
|
827
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
834
828
|
}
|
|
835
829
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList {
|
|
836
830
|
/** Search results. */
|
|
@@ -1338,10 +1332,7 @@ declare namespace gapi.client {
|
|
|
1338
1332
|
matcherValue?: GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
|
|
1339
1333
|
/** The state of the document. */
|
|
1340
1334
|
state?:
|
|
1341
|
-
| '
|
|
1342
|
-
| 'INDEXED'
|
|
1343
|
-
| 'NOT_IN_TARGET_SITE'
|
|
1344
|
-
| 'NOT_IN_INDEX';
|
|
1335
|
+
'STATE_UNSPECIFIED' | 'INDEXED' | 'NOT_IN_TARGET_SITE' | 'NOT_IN_INDEX';
|
|
1345
1336
|
}
|
|
1346
1337
|
interface GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
1347
1338
|
/** Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
@@ -1401,7 +1392,9 @@ declare namespace gapi.client {
|
|
|
1401
1392
|
interface GoogleCloudDiscoveryengineV1alphaBigtableOptions {
|
|
1402
1393
|
/** 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. */
|
|
1403
1394
|
families?: {
|
|
1404
|
-
[
|
|
1395
|
+
[
|
|
1396
|
+
P in string
|
|
1397
|
+
]: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily;
|
|
1405
1398
|
};
|
|
1406
1399
|
/** The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */
|
|
1407
1400
|
keyFieldName?: string;
|
|
@@ -1536,7 +1529,9 @@ declare namespace gapi.client {
|
|
|
1536
1529
|
googleDefined?: boolean;
|
|
1537
1530
|
/** Optional. The translations of the text attributes. The keys should be BCP-47 language codes. */
|
|
1538
1531
|
localizedTexts?: {
|
|
1539
|
-
[
|
|
1532
|
+
[
|
|
1533
|
+
P in string
|
|
1534
|
+
]: GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts;
|
|
1540
1535
|
};
|
|
1541
1536
|
/** Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1542
1537
|
name?: string;
|
|
@@ -2693,7 +2688,9 @@ declare namespace gapi.client {
|
|
|
2693
2688
|
name?: string;
|
|
2694
2689
|
/** 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. */
|
|
2695
2690
|
parsingConfigOverrides?: {
|
|
2696
|
-
[
|
|
2691
|
+
[
|
|
2692
|
+
P in string
|
|
2693
|
+
]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
2697
2694
|
};
|
|
2698
2695
|
}
|
|
2699
2696
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
|
|
@@ -2821,9 +2818,7 @@ declare namespace gapi.client {
|
|
|
2821
2818
|
/** 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. */
|
|
2822
2819
|
modelConfigs?: {
|
|
2823
2820
|
[P in string]:
|
|
2824
|
-
| '
|
|
2825
|
-
| 'MODEL_ENABLED'
|
|
2826
|
-
| 'MODEL_DISABLED';
|
|
2821
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
2827
2822
|
};
|
|
2828
2823
|
/** 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. */
|
|
2829
2824
|
name?: string;
|
|
@@ -2937,10 +2932,7 @@ declare namespace gapi.client {
|
|
|
2937
2932
|
lastTuneTime?: string;
|
|
2938
2933
|
/** Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. */
|
|
2939
2934
|
servingState?:
|
|
2940
|
-
| '
|
|
2941
|
-
| 'INACTIVE'
|
|
2942
|
-
| 'ACTIVE'
|
|
2943
|
-
| 'TUNED';
|
|
2935
|
+
'SERVING_STATE_UNSPECIFIED' | 'INACTIVE' | 'ACTIVE' | 'TUNED';
|
|
2944
2936
|
/** 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. */
|
|
2945
2937
|
tuningOperation?: string;
|
|
2946
2938
|
}
|
|
@@ -3022,11 +3014,7 @@ declare namespace gapi.client {
|
|
|
3022
3014
|
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
3023
3015
|
/** Output only. The state of the evaluation. */
|
|
3024
3016
|
state?:
|
|
3025
|
-
| '
|
|
3026
|
-
| 'PENDING'
|
|
3027
|
-
| 'RUNNING'
|
|
3028
|
-
| 'SUCCEEDED'
|
|
3029
|
-
| 'FAILED';
|
|
3017
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
3030
3018
|
}
|
|
3031
3019
|
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec {
|
|
3032
3020
|
/** Optional. The specification of the query set. */
|
|
@@ -3481,9 +3469,7 @@ declare namespace gapi.client {
|
|
|
3481
3469
|
inlineSource?: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
|
|
3482
3470
|
/** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
3483
3471
|
reconciliationMode?:
|
|
3484
|
-
| '
|
|
3485
|
-
| 'INCREMENTAL'
|
|
3486
|
-
| 'FULL';
|
|
3472
|
+
'RECONCILIATION_MODE_UNSPECIFIED' | 'INCREMENTAL' | 'FULL';
|
|
3487
3473
|
/** Spanner input source. */
|
|
3488
3474
|
spannerSource?: GoogleCloudDiscoveryengineV1alphaSpannerSource;
|
|
3489
3475
|
/** Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */
|
|
@@ -4769,9 +4755,7 @@ declare namespace gapi.client {
|
|
|
4769
4755
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
4770
4756
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
4771
4757
|
searchResultMode?:
|
|
4772
|
-
| '
|
|
4773
|
-
| 'DOCUMENTS'
|
|
4774
|
-
| 'CHUNKS';
|
|
4758
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
4775
4759
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
4776
4760
|
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
4777
4761
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -4922,14 +4906,10 @@ declare namespace gapi.client {
|
|
|
4922
4906
|
allowedFieldNames?: string[];
|
|
4923
4907
|
/** 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. */
|
|
4924
4908
|
extractedFilterBehavior?:
|
|
4925
|
-
| '
|
|
4926
|
-
| 'HARD_FILTER'
|
|
4927
|
-
| 'SOFT_BOOST';
|
|
4909
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
4928
4910
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
4929
4911
|
filterExtractionCondition?:
|
|
4930
|
-
| '
|
|
4931
|
-
| 'DISABLED'
|
|
4932
|
-
| 'ENABLED';
|
|
4912
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
4933
4913
|
/** 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`. */
|
|
4934
4914
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
4935
4915
|
}
|
|
@@ -5871,7 +5851,9 @@ declare namespace gapi.client {
|
|
|
5871
5851
|
facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
5872
5852
|
/** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
|
|
5873
5853
|
fieldsUiComponentsMap?: {
|
|
5874
|
-
[
|
|
5854
|
+
[
|
|
5855
|
+
P in string
|
|
5856
|
+
]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
5875
5857
|
};
|
|
5876
5858
|
/** Output only. Whether the subscription is gemini bundle or not. */
|
|
5877
5859
|
geminiBundle?: boolean;
|
|
@@ -5893,9 +5875,7 @@ declare namespace gapi.client {
|
|
|
5893
5875
|
nodes?: GoogleCloudDiscoveryengineV1alphaWidgetConfigNode[];
|
|
5894
5876
|
/** The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. */
|
|
5895
5877
|
resultDisplayType?:
|
|
5896
|
-
| '
|
|
5897
|
-
| 'SNIPPET'
|
|
5898
|
-
| 'EXTRACTIVE_ANSWER';
|
|
5878
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
5899
5879
|
/** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
|
|
5900
5880
|
solutionType?:
|
|
5901
5881
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -6011,7 +5991,9 @@ declare namespace gapi.client {
|
|
|
6011
5991
|
facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
6012
5992
|
/** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
|
|
6013
5993
|
fieldsUiComponentsMap?: {
|
|
6014
|
-
[
|
|
5994
|
+
[
|
|
5995
|
+
P in string
|
|
5996
|
+
]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
6015
5997
|
};
|
|
6016
5998
|
/** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
|
|
6017
5999
|
id?: string;
|
|
@@ -6061,9 +6043,7 @@ declare namespace gapi.client {
|
|
|
6061
6043
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
|
|
6062
6044
|
/** The field visibility on different types of devices. */
|
|
6063
6045
|
deviceVisibility?:
|
|
6064
|
-
| '
|
|
6065
|
-
| 'MOBILE'
|
|
6066
|
-
| 'DESKTOP'[];
|
|
6046
|
+
'DEVICE_VISIBILITY_UNSPECIFIED' | 'MOBILE' | 'DESKTOP'[];
|
|
6067
6047
|
/** The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". */
|
|
6068
6048
|
displayTemplate?: string;
|
|
6069
6049
|
/** Required. Registered field name. The format is `field.abc`. */
|
|
@@ -6110,15 +6090,11 @@ declare namespace gapi.client {
|
|
|
6110
6090
|
/** Output only. 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. */
|
|
6111
6091
|
modelConfigs?: {
|
|
6112
6092
|
[P in string]:
|
|
6113
|
-
| '
|
|
6114
|
-
| 'MODEL_ENABLED'
|
|
6115
|
-
| 'MODEL_DISABLED';
|
|
6093
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
6116
6094
|
};
|
|
6117
6095
|
/** Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. */
|
|
6118
6096
|
resultDescriptionType?:
|
|
6119
|
-
| '
|
|
6120
|
-
| 'SNIPPET'
|
|
6121
|
-
| 'EXTRACTIVE_ANSWER';
|
|
6097
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
6122
6098
|
/** Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. */
|
|
6123
6099
|
searchAddonSpec?: GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec;
|
|
6124
6100
|
}
|
|
@@ -6751,7 +6727,9 @@ declare namespace gapi.client {
|
|
|
6751
6727
|
name?: string;
|
|
6752
6728
|
/** 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. */
|
|
6753
6729
|
parsingConfigOverrides?: {
|
|
6754
|
-
[
|
|
6730
|
+
[
|
|
6731
|
+
P in string
|
|
6732
|
+
]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
6755
6733
|
};
|
|
6756
6734
|
}
|
|
6757
6735
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
@@ -6860,9 +6838,7 @@ declare namespace gapi.client {
|
|
|
6860
6838
|
/** 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. */
|
|
6861
6839
|
modelConfigs?: {
|
|
6862
6840
|
[P in string]:
|
|
6863
|
-
| '
|
|
6864
|
-
| 'MODEL_ENABLED'
|
|
6865
|
-
| 'MODEL_DISABLED';
|
|
6841
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
6866
6842
|
};
|
|
6867
6843
|
/** 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. */
|
|
6868
6844
|
name?: string;
|
|
@@ -7006,11 +6982,7 @@ declare namespace gapi.client {
|
|
|
7006
6982
|
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
7007
6983
|
/** Output only. The state of the evaluation. */
|
|
7008
6984
|
state?:
|
|
7009
|
-
| '
|
|
7010
|
-
| 'PENDING'
|
|
7011
|
-
| 'RUNNING'
|
|
7012
|
-
| 'SUCCEEDED'
|
|
7013
|
-
| 'FAILED';
|
|
6985
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
7014
6986
|
}
|
|
7015
6987
|
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec {
|
|
7016
6988
|
/** Optional. The specification of the query set. */
|
|
@@ -7560,9 +7532,7 @@ declare namespace gapi.client {
|
|
|
7560
7532
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
7561
7533
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
7562
7534
|
searchResultMode?:
|
|
7563
|
-
| '
|
|
7564
|
-
| 'DOCUMENTS'
|
|
7565
|
-
| 'CHUNKS';
|
|
7535
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
7566
7536
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
7567
7537
|
snippetSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec;
|
|
7568
7538
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -7713,14 +7683,10 @@ declare namespace gapi.client {
|
|
|
7713
7683
|
allowedFieldNames?: string[];
|
|
7714
7684
|
/** 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. */
|
|
7715
7685
|
extractedFilterBehavior?:
|
|
7716
|
-
| '
|
|
7717
|
-
| 'HARD_FILTER'
|
|
7718
|
-
| 'SOFT_BOOST';
|
|
7686
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
7719
7687
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
7720
7688
|
filterExtractionCondition?:
|
|
7721
|
-
| '
|
|
7722
|
-
| 'DISABLED'
|
|
7723
|
-
| 'ENABLED';
|
|
7689
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
7724
7690
|
/** 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`. */
|
|
7725
7691
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
7726
7692
|
}
|
|
@@ -8530,7 +8496,9 @@ declare namespace gapi.client {
|
|
|
8530
8496
|
name?: string;
|
|
8531
8497
|
/** 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. */
|
|
8532
8498
|
parsingConfigOverrides?: {
|
|
8533
|
-
[
|
|
8499
|
+
[
|
|
8500
|
+
P in string
|
|
8501
|
+
]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
8534
8502
|
};
|
|
8535
8503
|
}
|
|
8536
8504
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
@@ -8649,9 +8617,7 @@ declare namespace gapi.client {
|
|
|
8649
8617
|
/** 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. */
|
|
8650
8618
|
modelConfigs?: {
|
|
8651
8619
|
[P in string]:
|
|
8652
|
-
| '
|
|
8653
|
-
| 'MODEL_ENABLED'
|
|
8654
|
-
| 'MODEL_DISABLED';
|
|
8620
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
8655
8621
|
};
|
|
8656
8622
|
/** 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. */
|
|
8657
8623
|
name?: string;
|
|
@@ -9122,9 +9088,7 @@ declare namespace gapi.client {
|
|
|
9122
9088
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
|
|
9123
9089
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
9124
9090
|
searchResultMode?:
|
|
9125
|
-
| '
|
|
9126
|
-
| 'DOCUMENTS'
|
|
9127
|
-
| 'CHUNKS';
|
|
9091
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
9128
9092
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
9129
9093
|
snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
|
|
9130
9094
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -10881,8 +10845,7 @@ declare namespace gapi.client {
|
|
|
10881
10845
|
prettyPrint?: boolean;
|
|
10882
10846
|
/** What format output should be. If unspecified, defaults to JSON. */
|
|
10883
10847
|
processedDocumentFormat?:
|
|
10884
|
-
| '
|
|
10885
|
-
| 'JSON';
|
|
10848
|
+
'PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED' | 'JSON';
|
|
10886
10849
|
/** Required. What type of processing to return. */
|
|
10887
10850
|
processedDocumentType?:
|
|
10888
10851
|
| 'PROCESSED_DOCUMENT_TYPE_UNSPECIFIED'
|
|
@@ -11294,9 +11257,7 @@ declare namespace gapi.client {
|
|
|
11294
11257
|
uploadType?: string;
|
|
11295
11258
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
11296
11259
|
view?:
|
|
11297
|
-
| '
|
|
11298
|
-
| 'BRANCH_VIEW_BASIC'
|
|
11299
|
-
| 'BRANCH_VIEW_FULL';
|
|
11260
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
11300
11261
|
}): Request<GoogleCloudDiscoveryengineV1alphaBranch>;
|
|
11301
11262
|
/** Lists all Branchs under the specified parent DataStore. */
|
|
11302
11263
|
list(request?: {
|
|
@@ -11326,9 +11287,7 @@ declare namespace gapi.client {
|
|
|
11326
11287
|
uploadType?: string;
|
|
11327
11288
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
11328
11289
|
view?:
|
|
11329
|
-
| '
|
|
11330
|
-
| 'BRANCH_VIEW_BASIC'
|
|
11331
|
-
| 'BRANCH_VIEW_FULL';
|
|
11290
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
11332
11291
|
}): Request<GoogleCloudDiscoveryengineV1alphaListBranchesResponse>;
|
|
11333
11292
|
documents: DocumentsResource;
|
|
11334
11293
|
operations: OperationsResource;
|
|
@@ -18863,8 +18822,7 @@ declare namespace gapi.client {
|
|
|
18863
18822
|
prettyPrint?: boolean;
|
|
18864
18823
|
/** What format output should be. If unspecified, defaults to JSON. */
|
|
18865
18824
|
processedDocumentFormat?:
|
|
18866
|
-
| '
|
|
18867
|
-
| 'JSON';
|
|
18825
|
+
'PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED' | 'JSON';
|
|
18868
18826
|
/** Required. What type of processing to return. */
|
|
18869
18827
|
processedDocumentType?:
|
|
18870
18828
|
| 'PROCESSED_DOCUMENT_TYPE_UNSPECIFIED'
|
|
@@ -19276,9 +19234,7 @@ declare namespace gapi.client {
|
|
|
19276
19234
|
uploadType?: string;
|
|
19277
19235
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
19278
19236
|
view?:
|
|
19279
|
-
| '
|
|
19280
|
-
| 'BRANCH_VIEW_BASIC'
|
|
19281
|
-
| 'BRANCH_VIEW_FULL';
|
|
19237
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
19282
19238
|
}): Request<GoogleCloudDiscoveryengineV1alphaBranch>;
|
|
19283
19239
|
/** Lists all Branchs under the specified parent DataStore. */
|
|
19284
19240
|
list(request?: {
|
|
@@ -19308,9 +19264,7 @@ declare namespace gapi.client {
|
|
|
19308
19264
|
uploadType?: string;
|
|
19309
19265
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
19310
19266
|
view?:
|
|
19311
|
-
| '
|
|
19312
|
-
| 'BRANCH_VIEW_BASIC'
|
|
19313
|
-
| 'BRANCH_VIEW_FULL';
|
|
19267
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
19314
19268
|
}): Request<GoogleCloudDiscoveryengineV1alphaListBranchesResponse>;
|
|
19315
19269
|
documents: DocumentsResource;
|
|
19316
19270
|
operations: OperationsResource;
|
|
@@ -25202,9 +25156,7 @@ declare namespace gapi.client {
|
|
|
25202
25156
|
callback?: string;
|
|
25203
25157
|
/** Optional. The type of entities to fetch. If not set, all entity types will be returned. */
|
|
25204
25158
|
entityTypeFilter?:
|
|
25205
|
-
| '
|
|
25206
|
-
| 'USERS'
|
|
25207
|
-
| 'GROUPS';
|
|
25159
|
+
'ENTITY_TYPE_FILTER_UNSPECIFIED' | 'USERS' | 'GROUPS';
|
|
25208
25160
|
/** Selector specifying which fields to include in a partial response. */
|
|
25209
25161
|
fields?: string;
|
|
25210
25162
|
/** 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. */
|