@maxim_mazurok/gapi.client.discoveryengine-v1 0.2.20260620 → 0.3.20260629
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 +57 -96
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260629
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -610,9 +610,7 @@ declare namespace gapi.client {
|
|
|
610
610
|
interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion {
|
|
611
611
|
/** The type of the content suggestion. */
|
|
612
612
|
contentType?:
|
|
613
|
-
| '
|
|
614
|
-
| 'GOOGLE_WORKSPACE'
|
|
615
|
-
| 'THIRD_PARTY';
|
|
613
|
+
'CONTENT_TYPE_UNSPECIFIED' | 'GOOGLE_WORKSPACE' | 'THIRD_PARTY';
|
|
616
614
|
/** The name of the dataStore that this suggestion belongs to. */
|
|
617
615
|
dataStore?: string;
|
|
618
616
|
/** The destination uri of the content suggestion. */
|
|
@@ -637,9 +635,7 @@ declare namespace gapi.client {
|
|
|
637
635
|
document?: GoogleCloudDiscoveryengineV1Document;
|
|
638
636
|
/** The type of the person. */
|
|
639
637
|
personType?:
|
|
640
|
-
| '
|
|
641
|
-
| 'CLOUD_IDENTITY'
|
|
642
|
-
| 'THIRD_PARTY_IDENTITY';
|
|
638
|
+
'PERSON_TYPE_UNSPECIFIED' | 'CLOUD_IDENTITY' | 'THIRD_PARTY_IDENTITY';
|
|
643
639
|
/** The score of each suggestion. The score is in the range of [0, 1]. */
|
|
644
640
|
score?: number;
|
|
645
641
|
/** The suggestion for the query. */
|
|
@@ -1935,7 +1931,9 @@ declare namespace gapi.client {
|
|
|
1935
1931
|
name?: string;
|
|
1936
1932
|
/** 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. */
|
|
1937
1933
|
parsingConfigOverrides?: {
|
|
1938
|
-
[
|
|
1934
|
+
[
|
|
1935
|
+
P in string
|
|
1936
|
+
]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
1939
1937
|
};
|
|
1940
1938
|
}
|
|
1941
1939
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
|
|
@@ -2003,7 +2001,7 @@ declare namespace gapi.client {
|
|
|
2003
2001
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting;
|
|
2004
2002
|
/** Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. */
|
|
2005
2003
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
2006
|
-
/**
|
|
2004
|
+
/** Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. */
|
|
2007
2005
|
associatedAgentRegistry?: string;
|
|
2008
2006
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
2009
2007
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
@@ -2027,7 +2025,7 @@ declare namespace gapi.client {
|
|
|
2027
2025
|
disableAnalytics?: boolean;
|
|
2028
2026
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2029
2027
|
displayName?: string;
|
|
2030
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
2028
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
2031
2029
|
features?: {
|
|
2032
2030
|
[P in string]:
|
|
2033
2031
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -2054,9 +2052,7 @@ declare namespace gapi.client {
|
|
|
2054
2052
|
/** 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. */
|
|
2055
2053
|
modelConfigs?: {
|
|
2056
2054
|
[P in string]:
|
|
2057
|
-
| '
|
|
2058
|
-
| 'MODEL_ENABLED'
|
|
2059
|
-
| 'MODEL_DISABLED';
|
|
2055
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
2060
2056
|
};
|
|
2061
2057
|
/** 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. */
|
|
2062
2058
|
name?: string;
|
|
@@ -2170,15 +2166,12 @@ declare namespace gapi.client {
|
|
|
2170
2166
|
lastTuneTime?: string;
|
|
2171
2167
|
/** Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. */
|
|
2172
2168
|
servingState?:
|
|
2173
|
-
| '
|
|
2174
|
-
| 'INACTIVE'
|
|
2175
|
-
| 'ACTIVE'
|
|
2176
|
-
| 'TUNED';
|
|
2169
|
+
'SERVING_STATE_UNSPECIFIED' | 'INACTIVE' | 'ACTIVE' | 'TUNED';
|
|
2177
2170
|
/** 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. */
|
|
2178
2171
|
tuningOperation?: string;
|
|
2179
2172
|
}
|
|
2180
2173
|
interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
2181
|
-
/** Optional. The required subscription tier of this engine.
|
|
2174
|
+
/** Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. */
|
|
2182
2175
|
requiredSubscriptionTier?:
|
|
2183
2176
|
| 'SUBSCRIPTION_TIER_UNSPECIFIED'
|
|
2184
2177
|
| 'SUBSCRIPTION_TIER_SEARCH'
|
|
@@ -2231,11 +2224,7 @@ declare namespace gapi.client {
|
|
|
2231
2224
|
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
2232
2225
|
/** Output only. The state of the evaluation. */
|
|
2233
2226
|
state?:
|
|
2234
|
-
| '
|
|
2235
|
-
| 'PENDING'
|
|
2236
|
-
| 'RUNNING'
|
|
2237
|
-
| 'SUCCEEDED'
|
|
2238
|
-
| 'FAILED';
|
|
2227
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
2239
2228
|
}
|
|
2240
2229
|
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec {
|
|
2241
2230
|
/** Optional. The specification of the query set. */
|
|
@@ -3089,9 +3078,7 @@ declare namespace gapi.client {
|
|
|
3089
3078
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
3090
3079
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
3091
3080
|
searchResultMode?:
|
|
3092
|
-
| '
|
|
3093
|
-
| 'DOCUMENTS'
|
|
3094
|
-
| 'CHUNKS';
|
|
3081
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
3095
3082
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
3096
3083
|
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
3097
3084
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -3242,14 +3229,10 @@ declare namespace gapi.client {
|
|
|
3242
3229
|
allowedFieldNames?: string[];
|
|
3243
3230
|
/** 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. */
|
|
3244
3231
|
extractedFilterBehavior?:
|
|
3245
|
-
| '
|
|
3246
|
-
| 'HARD_FILTER'
|
|
3247
|
-
| 'SOFT_BOOST';
|
|
3232
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
3248
3233
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
3249
3234
|
filterExtractionCondition?:
|
|
3250
|
-
| '
|
|
3251
|
-
| 'DISABLED'
|
|
3252
|
-
| 'ENABLED';
|
|
3235
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
3253
3236
|
/** 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`. */
|
|
3254
3237
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
3255
3238
|
}
|
|
@@ -3537,7 +3520,8 @@ declare namespace gapi.client {
|
|
|
3537
3520
|
| 'GOOGLE_CHAT'
|
|
3538
3521
|
| 'GOOGLE_GROUPS'
|
|
3539
3522
|
| 'GOOGLE_KEEP'
|
|
3540
|
-
| 'GOOGLE_PEOPLE'
|
|
3523
|
+
| 'GOOGLE_PEOPLE'
|
|
3524
|
+
| 'GOOGLE_WORKSPACE';
|
|
3541
3525
|
}
|
|
3542
3526
|
interface GoogleCloudDiscoveryengineV1Answer {
|
|
3543
3527
|
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
@@ -3788,9 +3772,7 @@ declare namespace gapi.client {
|
|
|
3788
3772
|
orderBy?: string;
|
|
3789
3773
|
/** 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) */
|
|
3790
3774
|
searchResultMode?:
|
|
3791
|
-
| '
|
|
3792
|
-
| 'DOCUMENTS'
|
|
3793
|
-
| 'CHUNKS';
|
|
3775
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
3794
3776
|
}
|
|
3795
3777
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList {
|
|
3796
3778
|
/** Search results. */
|
|
@@ -4260,10 +4242,7 @@ declare namespace gapi.client {
|
|
|
4260
4242
|
matcherValue?: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
|
|
4261
4243
|
/** The state of the document. */
|
|
4262
4244
|
state?:
|
|
4263
|
-
| '
|
|
4264
|
-
| 'INDEXED'
|
|
4265
|
-
| 'NOT_IN_TARGET_SITE'
|
|
4266
|
-
| 'NOT_IN_INDEX';
|
|
4245
|
+
'STATE_UNSPECIFIED' | 'INDEXED' | 'NOT_IN_TARGET_SITE' | 'NOT_IN_INDEX';
|
|
4267
4246
|
}
|
|
4268
4247
|
interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
4269
4248
|
/** Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
@@ -4709,7 +4688,9 @@ declare namespace gapi.client {
|
|
|
4709
4688
|
name?: string;
|
|
4710
4689
|
/** 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. */
|
|
4711
4690
|
parsingConfigOverrides?: {
|
|
4712
|
-
[
|
|
4691
|
+
[
|
|
4692
|
+
P in string
|
|
4693
|
+
]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
4713
4694
|
};
|
|
4714
4695
|
}
|
|
4715
4696
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
@@ -4767,7 +4748,7 @@ declare namespace gapi.client {
|
|
|
4767
4748
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1betaAgentGatewaySetting;
|
|
4768
4749
|
/** Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. */
|
|
4769
4750
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
4770
|
-
/**
|
|
4751
|
+
/** Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. */
|
|
4771
4752
|
associatedAgentRegistry?: string;
|
|
4772
4753
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
4773
4754
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
@@ -4791,7 +4772,7 @@ declare namespace gapi.client {
|
|
|
4791
4772
|
disableAnalytics?: boolean;
|
|
4792
4773
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
4793
4774
|
displayName?: string;
|
|
4794
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
4775
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
4795
4776
|
features?: {
|
|
4796
4777
|
[P in string]:
|
|
4797
4778
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -4818,9 +4799,7 @@ declare namespace gapi.client {
|
|
|
4818
4799
|
/** 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. */
|
|
4819
4800
|
modelConfigs?: {
|
|
4820
4801
|
[P in string]:
|
|
4821
|
-
| '
|
|
4822
|
-
| 'MODEL_ENABLED'
|
|
4823
|
-
| 'MODEL_DISABLED';
|
|
4802
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
4824
4803
|
};
|
|
4825
4804
|
/** 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. */
|
|
4826
4805
|
name?: string;
|
|
@@ -4922,7 +4901,7 @@ declare namespace gapi.client {
|
|
|
4922
4901
|
contextEventType?: string;
|
|
4923
4902
|
}
|
|
4924
4903
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
4925
|
-
/** Optional. The required subscription tier of this engine.
|
|
4904
|
+
/** Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. */
|
|
4926
4905
|
requiredSubscriptionTier?:
|
|
4927
4906
|
| 'SUBSCRIPTION_TIER_UNSPECIFIED'
|
|
4928
4907
|
| 'SUBSCRIPTION_TIER_SEARCH'
|
|
@@ -4964,11 +4943,7 @@ declare namespace gapi.client {
|
|
|
4964
4943
|
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
4965
4944
|
/** Output only. The state of the evaluation. */
|
|
4966
4945
|
state?:
|
|
4967
|
-
| '
|
|
4968
|
-
| 'PENDING'
|
|
4969
|
-
| 'RUNNING'
|
|
4970
|
-
| 'SUCCEEDED'
|
|
4971
|
-
| 'FAILED';
|
|
4946
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
4972
4947
|
}
|
|
4973
4948
|
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec {
|
|
4974
4949
|
/** Optional. The specification of the query set. */
|
|
@@ -5518,9 +5493,7 @@ declare namespace gapi.client {
|
|
|
5518
5493
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
5519
5494
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
5520
5495
|
searchResultMode?:
|
|
5521
|
-
| '
|
|
5522
|
-
| 'DOCUMENTS'
|
|
5523
|
-
| 'CHUNKS';
|
|
5496
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
5524
5497
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
5525
5498
|
snippetSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec;
|
|
5526
5499
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -5671,14 +5644,10 @@ declare namespace gapi.client {
|
|
|
5671
5644
|
allowedFieldNames?: string[];
|
|
5672
5645
|
/** 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. */
|
|
5673
5646
|
extractedFilterBehavior?:
|
|
5674
|
-
| '
|
|
5675
|
-
| 'HARD_FILTER'
|
|
5676
|
-
| 'SOFT_BOOST';
|
|
5647
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
5677
5648
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
5678
5649
|
filterExtractionCondition?:
|
|
5679
|
-
| '
|
|
5680
|
-
| 'DISABLED'
|
|
5681
|
-
| 'ENABLED';
|
|
5650
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
5682
5651
|
/** 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`. */
|
|
5683
5652
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
5684
5653
|
}
|
|
@@ -5908,7 +5877,8 @@ declare namespace gapi.client {
|
|
|
5908
5877
|
| 'GOOGLE_CHAT'
|
|
5909
5878
|
| 'GOOGLE_GROUPS'
|
|
5910
5879
|
| 'GOOGLE_KEEP'
|
|
5911
|
-
| 'GOOGLE_PEOPLE'
|
|
5880
|
+
| 'GOOGLE_PEOPLE'
|
|
5881
|
+
| 'GOOGLE_WORKSPACE';
|
|
5912
5882
|
}
|
|
5913
5883
|
interface GoogleCloudDiscoveryengineV1BigQuerySource {
|
|
5914
5884
|
/** The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. */
|
|
@@ -5927,7 +5897,9 @@ declare namespace gapi.client {
|
|
|
5927
5897
|
interface GoogleCloudDiscoveryengineV1BigtableOptions {
|
|
5928
5898
|
/** 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. */
|
|
5929
5899
|
families?: {
|
|
5930
|
-
[
|
|
5900
|
+
[
|
|
5901
|
+
P in string
|
|
5902
|
+
]: GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily;
|
|
5931
5903
|
};
|
|
5932
5904
|
/** The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */
|
|
5933
5905
|
keyFieldName?: string;
|
|
@@ -6901,7 +6873,9 @@ declare namespace gapi.client {
|
|
|
6901
6873
|
name?: string;
|
|
6902
6874
|
/** 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. */
|
|
6903
6875
|
parsingConfigOverrides?: {
|
|
6904
|
-
[
|
|
6876
|
+
[
|
|
6877
|
+
P in string
|
|
6878
|
+
]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
6905
6879
|
};
|
|
6906
6880
|
}
|
|
6907
6881
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
@@ -6974,7 +6948,7 @@ declare namespace gapi.client {
|
|
|
6974
6948
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1AgentGatewaySetting;
|
|
6975
6949
|
/** Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. */
|
|
6976
6950
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
6977
|
-
/**
|
|
6951
|
+
/** Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. */
|
|
6978
6952
|
associatedAgentRegistry?: string;
|
|
6979
6953
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
6980
6954
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
@@ -6998,7 +6972,7 @@ declare namespace gapi.client {
|
|
|
6998
6972
|
disableAnalytics?: boolean;
|
|
6999
6973
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
7000
6974
|
displayName?: string;
|
|
7001
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
6975
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
7002
6976
|
features?: {
|
|
7003
6977
|
[P in string]:
|
|
7004
6978
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -7025,9 +6999,7 @@ declare namespace gapi.client {
|
|
|
7025
6999
|
/** 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. */
|
|
7026
7000
|
modelConfigs?: {
|
|
7027
7001
|
[P in string]:
|
|
7028
|
-
| '
|
|
7029
|
-
| 'MODEL_ENABLED'
|
|
7030
|
-
| 'MODEL_DISABLED';
|
|
7002
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
7031
7003
|
};
|
|
7032
7004
|
/** 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. */
|
|
7033
7005
|
name?: string;
|
|
@@ -7129,7 +7101,7 @@ declare namespace gapi.client {
|
|
|
7129
7101
|
contextEventType?: string;
|
|
7130
7102
|
}
|
|
7131
7103
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
7132
|
-
/** Optional. The required subscription tier of this engine.
|
|
7104
|
+
/** Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. */
|
|
7133
7105
|
requiredSubscriptionTier?:
|
|
7134
7106
|
| 'SUBSCRIPTION_TIER_UNSPECIFIED'
|
|
7135
7107
|
| 'SUBSCRIPTION_TIER_SEARCH'
|
|
@@ -7382,9 +7354,7 @@ declare namespace gapi.client {
|
|
|
7382
7354
|
inlineSource?: GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource;
|
|
7383
7355
|
/** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
7384
7356
|
reconciliationMode?:
|
|
7385
|
-
| '
|
|
7386
|
-
| 'INCREMENTAL'
|
|
7387
|
-
| 'FULL';
|
|
7357
|
+
'RECONCILIATION_MODE_UNSPECIFIED' | 'INCREMENTAL' | 'FULL';
|
|
7388
7358
|
/** Spanner input source. */
|
|
7389
7359
|
spannerSource?: GoogleCloudDiscoveryengineV1SpannerSource;
|
|
7390
7360
|
/** Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */
|
|
@@ -8152,9 +8122,7 @@ declare namespace gapi.client {
|
|
|
8152
8122
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
|
|
8153
8123
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
8154
8124
|
searchResultMode?:
|
|
8155
|
-
| '
|
|
8156
|
-
| 'DOCUMENTS'
|
|
8157
|
-
| 'CHUNKS';
|
|
8125
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
8158
8126
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
8159
8127
|
snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
|
|
8160
8128
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -8285,14 +8253,10 @@ declare namespace gapi.client {
|
|
|
8285
8253
|
allowedFieldNames?: string[];
|
|
8286
8254
|
/** 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. */
|
|
8287
8255
|
extractedFilterBehavior?:
|
|
8288
|
-
| '
|
|
8289
|
-
| 'HARD_FILTER'
|
|
8290
|
-
| 'SOFT_BOOST';
|
|
8256
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
8291
8257
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
8292
8258
|
filterExtractionCondition?:
|
|
8293
|
-
| '
|
|
8294
|
-
| 'DISABLED'
|
|
8295
|
-
| 'ENABLED';
|
|
8259
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
8296
8260
|
/** 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`. */
|
|
8297
8261
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
8298
8262
|
}
|
|
@@ -9070,9 +9034,7 @@ declare namespace gapi.client {
|
|
|
9070
9034
|
nodes?: GoogleCloudDiscoveryengineV1WidgetConfigNode[];
|
|
9071
9035
|
/** 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. */
|
|
9072
9036
|
resultDisplayType?:
|
|
9073
|
-
| '
|
|
9074
|
-
| 'SNIPPET'
|
|
9075
|
-
| 'EXTRACTIVE_ANSWER';
|
|
9037
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
9076
9038
|
/** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
|
|
9077
9039
|
solutionType?:
|
|
9078
9040
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -9220,9 +9182,7 @@ declare namespace gapi.client {
|
|
|
9220
9182
|
interface GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField {
|
|
9221
9183
|
/** The field visibility on different types of devices. */
|
|
9222
9184
|
deviceVisibility?:
|
|
9223
|
-
| '
|
|
9224
|
-
| 'MOBILE'
|
|
9225
|
-
| 'DESKTOP'[];
|
|
9185
|
+
'DEVICE_VISIBILITY_UNSPECIFIED' | 'MOBILE' | 'DESKTOP'[];
|
|
9226
9186
|
/** The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". */
|
|
9227
9187
|
displayTemplate?: string;
|
|
9228
9188
|
/** Required. Registered field name. The format is `field.abc`. */
|
|
@@ -9249,7 +9209,7 @@ declare namespace gapi.client {
|
|
|
9249
9209
|
enableSearchAsYouType?: boolean;
|
|
9250
9210
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
9251
9211
|
enableVisualContentSummary?: boolean;
|
|
9252
|
-
/** Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
9212
|
+
/** Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
9253
9213
|
features?: {
|
|
9254
9214
|
[P in string]:
|
|
9255
9215
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -9258,6 +9218,8 @@ declare namespace gapi.client {
|
|
|
9258
9218
|
};
|
|
9259
9219
|
/** Describes generative answer configuration. */
|
|
9260
9220
|
generativeAnswerConfig?: GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig;
|
|
9221
|
+
/** Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. */
|
|
9222
|
+
googleDrivePickerEnabled?: boolean;
|
|
9261
9223
|
/** Describes widget (or web app) interaction type */
|
|
9262
9224
|
interactionType?:
|
|
9263
9225
|
| 'INTERACTION_TYPE_UNSPECIFIED'
|
|
@@ -9269,15 +9231,13 @@ declare namespace gapi.client {
|
|
|
9269
9231
|
/** 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. */
|
|
9270
9232
|
modelConfigs?: {
|
|
9271
9233
|
[P in string]:
|
|
9272
|
-
| '
|
|
9273
|
-
| 'MODEL_ENABLED'
|
|
9274
|
-
| 'MODEL_DISABLED';
|
|
9234
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
9275
9235
|
};
|
|
9236
|
+
/** Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). */
|
|
9237
|
+
onedrivePickerEnabled?: boolean;
|
|
9276
9238
|
/** Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. */
|
|
9277
9239
|
resultDescriptionType?:
|
|
9278
|
-
| '
|
|
9279
|
-
| 'SNIPPET'
|
|
9280
|
-
| 'EXTRACTIVE_ANSWER';
|
|
9240
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
9281
9241
|
}
|
|
9282
9242
|
interface GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig {
|
|
9283
9243
|
/** Whether generated answer contains suggested related questions. */
|
|
@@ -9340,7 +9300,8 @@ declare namespace gapi.client {
|
|
|
9340
9300
|
| 'GOOGLE_CHAT'
|
|
9341
9301
|
| 'GOOGLE_GROUPS'
|
|
9342
9302
|
| 'GOOGLE_KEEP'
|
|
9343
|
-
| 'GOOGLE_PEOPLE'
|
|
9303
|
+
| 'GOOGLE_PEOPLE'
|
|
9304
|
+
| 'GOOGLE_WORKSPACE';
|
|
9344
9305
|
}
|
|
9345
9306
|
interface GoogleIamV1Binding {
|
|
9346
9307
|
/** The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
|