@maxim_mazurok/gapi.client.discoveryengine-v1 0.2.20260614 → 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 +56 -88
- 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: 20260620
|
|
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,6 +2001,8 @@ 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';
|
|
2004
|
+
/** Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. */
|
|
2005
|
+
associatedAgentRegistry?: string;
|
|
2006
2006
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
2007
2007
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
2008
2008
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -2025,7 +2025,7 @@ declare namespace gapi.client {
|
|
|
2025
2025
|
disableAnalytics?: boolean;
|
|
2026
2026
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2027
2027
|
displayName?: string;
|
|
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` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` */
|
|
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` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` */
|
|
2029
2029
|
features?: {
|
|
2030
2030
|
[P in string]:
|
|
2031
2031
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -2052,9 +2052,7 @@ declare namespace gapi.client {
|
|
|
2052
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. */
|
|
2053
2053
|
modelConfigs?: {
|
|
2054
2054
|
[P in string]:
|
|
2055
|
-
| '
|
|
2056
|
-
| 'MODEL_ENABLED'
|
|
2057
|
-
| 'MODEL_DISABLED';
|
|
2055
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
2058
2056
|
};
|
|
2059
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. */
|
|
2060
2058
|
name?: string;
|
|
@@ -2168,10 +2166,7 @@ declare namespace gapi.client {
|
|
|
2168
2166
|
lastTuneTime?: string;
|
|
2169
2167
|
/** Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. */
|
|
2170
2168
|
servingState?:
|
|
2171
|
-
| '
|
|
2172
|
-
| 'INACTIVE'
|
|
2173
|
-
| 'ACTIVE'
|
|
2174
|
-
| 'TUNED';
|
|
2169
|
+
'SERVING_STATE_UNSPECIFIED' | 'INACTIVE' | 'ACTIVE' | 'TUNED';
|
|
2175
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. */
|
|
2176
2171
|
tuningOperation?: string;
|
|
2177
2172
|
}
|
|
@@ -2229,11 +2224,7 @@ declare namespace gapi.client {
|
|
|
2229
2224
|
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
2230
2225
|
/** Output only. The state of the evaluation. */
|
|
2231
2226
|
state?:
|
|
2232
|
-
| '
|
|
2233
|
-
| 'PENDING'
|
|
2234
|
-
| 'RUNNING'
|
|
2235
|
-
| 'SUCCEEDED'
|
|
2236
|
-
| 'FAILED';
|
|
2227
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
2237
2228
|
}
|
|
2238
2229
|
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec {
|
|
2239
2230
|
/** Optional. The specification of the query set. */
|
|
@@ -3087,9 +3078,7 @@ declare namespace gapi.client {
|
|
|
3087
3078
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
3088
3079
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
3089
3080
|
searchResultMode?:
|
|
3090
|
-
| '
|
|
3091
|
-
| 'DOCUMENTS'
|
|
3092
|
-
| 'CHUNKS';
|
|
3081
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
3093
3082
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
3094
3083
|
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
3095
3084
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -3240,14 +3229,10 @@ declare namespace gapi.client {
|
|
|
3240
3229
|
allowedFieldNames?: string[];
|
|
3241
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. */
|
|
3242
3231
|
extractedFilterBehavior?:
|
|
3243
|
-
| '
|
|
3244
|
-
| 'HARD_FILTER'
|
|
3245
|
-
| 'SOFT_BOOST';
|
|
3232
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
3246
3233
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
3247
3234
|
filterExtractionCondition?:
|
|
3248
|
-
| '
|
|
3249
|
-
| 'DISABLED'
|
|
3250
|
-
| 'ENABLED';
|
|
3235
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
3251
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`. */
|
|
3252
3237
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
3253
3238
|
}
|
|
@@ -3786,9 +3771,7 @@ declare namespace gapi.client {
|
|
|
3786
3771
|
orderBy?: string;
|
|
3787
3772
|
/** 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) */
|
|
3788
3773
|
searchResultMode?:
|
|
3789
|
-
| '
|
|
3790
|
-
| 'DOCUMENTS'
|
|
3791
|
-
| 'CHUNKS';
|
|
3774
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
3792
3775
|
}
|
|
3793
3776
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList {
|
|
3794
3777
|
/** Search results. */
|
|
@@ -4258,10 +4241,7 @@ declare namespace gapi.client {
|
|
|
4258
4241
|
matcherValue?: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
|
|
4259
4242
|
/** The state of the document. */
|
|
4260
4243
|
state?:
|
|
4261
|
-
| '
|
|
4262
|
-
| 'INDEXED'
|
|
4263
|
-
| 'NOT_IN_TARGET_SITE'
|
|
4264
|
-
| 'NOT_IN_INDEX';
|
|
4244
|
+
'STATE_UNSPECIFIED' | 'INDEXED' | 'NOT_IN_TARGET_SITE' | 'NOT_IN_INDEX';
|
|
4265
4245
|
}
|
|
4266
4246
|
interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
4267
4247
|
/** Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
@@ -4707,7 +4687,9 @@ declare namespace gapi.client {
|
|
|
4707
4687
|
name?: string;
|
|
4708
4688
|
/** 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. */
|
|
4709
4689
|
parsingConfigOverrides?: {
|
|
4710
|
-
[
|
|
4690
|
+
[
|
|
4691
|
+
P in string
|
|
4692
|
+
]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
4711
4693
|
};
|
|
4712
4694
|
}
|
|
4713
4695
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
@@ -4765,6 +4747,8 @@ declare namespace gapi.client {
|
|
|
4765
4747
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1betaAgentGatewaySetting;
|
|
4766
4748
|
/** 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. */
|
|
4767
4749
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
4750
|
+
/** Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. */
|
|
4751
|
+
associatedAgentRegistry?: string;
|
|
4768
4752
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
4769
4753
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
4770
4754
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -4787,7 +4771,7 @@ declare namespace gapi.client {
|
|
|
4787
4771
|
disableAnalytics?: boolean;
|
|
4788
4772
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
4789
4773
|
displayName?: string;
|
|
4790
|
-
/** 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` */
|
|
4774
|
+
/** 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` */
|
|
4791
4775
|
features?: {
|
|
4792
4776
|
[P in string]:
|
|
4793
4777
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -4814,9 +4798,7 @@ declare namespace gapi.client {
|
|
|
4814
4798
|
/** 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. */
|
|
4815
4799
|
modelConfigs?: {
|
|
4816
4800
|
[P in string]:
|
|
4817
|
-
| '
|
|
4818
|
-
| 'MODEL_ENABLED'
|
|
4819
|
-
| 'MODEL_DISABLED';
|
|
4801
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
4820
4802
|
};
|
|
4821
4803
|
/** 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. */
|
|
4822
4804
|
name?: string;
|
|
@@ -4960,11 +4942,7 @@ declare namespace gapi.client {
|
|
|
4960
4942
|
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
4961
4943
|
/** Output only. The state of the evaluation. */
|
|
4962
4944
|
state?:
|
|
4963
|
-
| '
|
|
4964
|
-
| 'PENDING'
|
|
4965
|
-
| 'RUNNING'
|
|
4966
|
-
| 'SUCCEEDED'
|
|
4967
|
-
| 'FAILED';
|
|
4945
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
4968
4946
|
}
|
|
4969
4947
|
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec {
|
|
4970
4948
|
/** Optional. The specification of the query set. */
|
|
@@ -5514,9 +5492,7 @@ declare namespace gapi.client {
|
|
|
5514
5492
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
5515
5493
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
5516
5494
|
searchResultMode?:
|
|
5517
|
-
| '
|
|
5518
|
-
| 'DOCUMENTS'
|
|
5519
|
-
| 'CHUNKS';
|
|
5495
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
5520
5496
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
5521
5497
|
snippetSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec;
|
|
5522
5498
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -5667,14 +5643,10 @@ declare namespace gapi.client {
|
|
|
5667
5643
|
allowedFieldNames?: string[];
|
|
5668
5644
|
/** 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. */
|
|
5669
5645
|
extractedFilterBehavior?:
|
|
5670
|
-
| '
|
|
5671
|
-
| 'HARD_FILTER'
|
|
5672
|
-
| 'SOFT_BOOST';
|
|
5646
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
5673
5647
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
5674
5648
|
filterExtractionCondition?:
|
|
5675
|
-
| '
|
|
5676
|
-
| 'DISABLED'
|
|
5677
|
-
| 'ENABLED';
|
|
5649
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
5678
5650
|
/** 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`. */
|
|
5679
5651
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
5680
5652
|
}
|
|
@@ -5923,7 +5895,9 @@ declare namespace gapi.client {
|
|
|
5923
5895
|
interface GoogleCloudDiscoveryengineV1BigtableOptions {
|
|
5924
5896
|
/** 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. */
|
|
5925
5897
|
families?: {
|
|
5926
|
-
[
|
|
5898
|
+
[
|
|
5899
|
+
P in string
|
|
5900
|
+
]: GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily;
|
|
5927
5901
|
};
|
|
5928
5902
|
/** The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */
|
|
5929
5903
|
keyFieldName?: string;
|
|
@@ -6897,7 +6871,9 @@ declare namespace gapi.client {
|
|
|
6897
6871
|
name?: string;
|
|
6898
6872
|
/** 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. */
|
|
6899
6873
|
parsingConfigOverrides?: {
|
|
6900
|
-
[
|
|
6874
|
+
[
|
|
6875
|
+
P in string
|
|
6876
|
+
]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
6901
6877
|
};
|
|
6902
6878
|
}
|
|
6903
6879
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
@@ -6970,6 +6946,8 @@ declare namespace gapi.client {
|
|
|
6970
6946
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1AgentGatewaySetting;
|
|
6971
6947
|
/** 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. */
|
|
6972
6948
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
6949
|
+
/** Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. */
|
|
6950
|
+
associatedAgentRegistry?: string;
|
|
6973
6951
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
6974
6952
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
6975
6953
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -6992,7 +6970,7 @@ declare namespace gapi.client {
|
|
|
6992
6970
|
disableAnalytics?: boolean;
|
|
6993
6971
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
6994
6972
|
displayName?: string;
|
|
6995
|
-
/** 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` */
|
|
6973
|
+
/** 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` */
|
|
6996
6974
|
features?: {
|
|
6997
6975
|
[P in string]:
|
|
6998
6976
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -7019,9 +6997,7 @@ declare namespace gapi.client {
|
|
|
7019
6997
|
/** 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. */
|
|
7020
6998
|
modelConfigs?: {
|
|
7021
6999
|
[P in string]:
|
|
7022
|
-
| '
|
|
7023
|
-
| 'MODEL_ENABLED'
|
|
7024
|
-
| 'MODEL_DISABLED';
|
|
7000
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
7025
7001
|
};
|
|
7026
7002
|
/** 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. */
|
|
7027
7003
|
name?: string;
|
|
@@ -7376,9 +7352,7 @@ declare namespace gapi.client {
|
|
|
7376
7352
|
inlineSource?: GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource;
|
|
7377
7353
|
/** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
7378
7354
|
reconciliationMode?:
|
|
7379
|
-
| '
|
|
7380
|
-
| 'INCREMENTAL'
|
|
7381
|
-
| 'FULL';
|
|
7355
|
+
'RECONCILIATION_MODE_UNSPECIFIED' | 'INCREMENTAL' | 'FULL';
|
|
7382
7356
|
/** Spanner input source. */
|
|
7383
7357
|
spannerSource?: GoogleCloudDiscoveryengineV1SpannerSource;
|
|
7384
7358
|
/** Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */
|
|
@@ -8146,9 +8120,7 @@ declare namespace gapi.client {
|
|
|
8146
8120
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
|
|
8147
8121
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
8148
8122
|
searchResultMode?:
|
|
8149
|
-
| '
|
|
8150
|
-
| 'DOCUMENTS'
|
|
8151
|
-
| 'CHUNKS';
|
|
8123
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
8152
8124
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
8153
8125
|
snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
|
|
8154
8126
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -8279,14 +8251,10 @@ declare namespace gapi.client {
|
|
|
8279
8251
|
allowedFieldNames?: string[];
|
|
8280
8252
|
/** 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. */
|
|
8281
8253
|
extractedFilterBehavior?:
|
|
8282
|
-
| '
|
|
8283
|
-
| 'HARD_FILTER'
|
|
8284
|
-
| 'SOFT_BOOST';
|
|
8254
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
8285
8255
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
8286
8256
|
filterExtractionCondition?:
|
|
8287
|
-
| '
|
|
8288
|
-
| 'DISABLED'
|
|
8289
|
-
| 'ENABLED';
|
|
8257
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
8290
8258
|
/** 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`. */
|
|
8291
8259
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
8292
8260
|
}
|
|
@@ -8734,6 +8702,8 @@ declare namespace gapi.client {
|
|
|
8734
8702
|
answer?: GoogleCloudDiscoveryengineV1AssistAnswer;
|
|
8735
8703
|
/** A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. */
|
|
8736
8704
|
assistToken?: string;
|
|
8705
|
+
/** Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors. */
|
|
8706
|
+
connectorAuthErrors?: GoogleCloudDiscoveryengineV1StreamAssistResponseConnectorAuthError[];
|
|
8737
8707
|
/** The tool names of the tools that were invoked. */
|
|
8738
8708
|
invocationTools?: string[];
|
|
8739
8709
|
/** The skills executed during the turn. */
|
|
@@ -8741,6 +8711,12 @@ declare namespace gapi.client {
|
|
|
8741
8711
|
/** Session information. Only included in the final StreamAssistResponse of the response stream. */
|
|
8742
8712
|
sessionInfo?: GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo;
|
|
8743
8713
|
}
|
|
8714
|
+
interface GoogleCloudDiscoveryengineV1StreamAssistResponseConnectorAuthError {
|
|
8715
|
+
/** Resource name of the data connector that failed authentication. */
|
|
8716
|
+
dataConnector?: string;
|
|
8717
|
+
/** Human-readable error message describing the auth failure. */
|
|
8718
|
+
errorMessage?: string;
|
|
8719
|
+
}
|
|
8744
8720
|
interface GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill {
|
|
8745
8721
|
/** The display name of the skill. */
|
|
8746
8722
|
displayName?: string;
|
|
@@ -9056,9 +9032,7 @@ declare namespace gapi.client {
|
|
|
9056
9032
|
nodes?: GoogleCloudDiscoveryengineV1WidgetConfigNode[];
|
|
9057
9033
|
/** 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. */
|
|
9058
9034
|
resultDisplayType?:
|
|
9059
|
-
| '
|
|
9060
|
-
| 'SNIPPET'
|
|
9061
|
-
| 'EXTRACTIVE_ANSWER';
|
|
9035
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
9062
9036
|
/** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
|
|
9063
9037
|
solutionType?:
|
|
9064
9038
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -9206,9 +9180,7 @@ declare namespace gapi.client {
|
|
|
9206
9180
|
interface GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField {
|
|
9207
9181
|
/** The field visibility on different types of devices. */
|
|
9208
9182
|
deviceVisibility?:
|
|
9209
|
-
| '
|
|
9210
|
-
| 'MOBILE'
|
|
9211
|
-
| 'DESKTOP'[];
|
|
9183
|
+
'DEVICE_VISIBILITY_UNSPECIFIED' | 'MOBILE' | 'DESKTOP'[];
|
|
9212
9184
|
/** The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". */
|
|
9213
9185
|
displayTemplate?: string;
|
|
9214
9186
|
/** Required. Registered field name. The format is `field.abc`. */
|
|
@@ -9235,7 +9207,7 @@ declare namespace gapi.client {
|
|
|
9235
9207
|
enableSearchAsYouType?: boolean;
|
|
9236
9208
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
9237
9209
|
enableVisualContentSummary?: boolean;
|
|
9238
|
-
/** 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` */
|
|
9210
|
+
/** 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` */
|
|
9239
9211
|
features?: {
|
|
9240
9212
|
[P in string]:
|
|
9241
9213
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -9255,15 +9227,11 @@ declare namespace gapi.client {
|
|
|
9255
9227
|
/** 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. */
|
|
9256
9228
|
modelConfigs?: {
|
|
9257
9229
|
[P in string]:
|
|
9258
|
-
| '
|
|
9259
|
-
| 'MODEL_ENABLED'
|
|
9260
|
-
| 'MODEL_DISABLED';
|
|
9230
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
9261
9231
|
};
|
|
9262
9232
|
/** Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. */
|
|
9263
9233
|
resultDescriptionType?:
|
|
9264
|
-
| '
|
|
9265
|
-
| 'SNIPPET'
|
|
9266
|
-
| 'EXTRACTIVE_ANSWER';
|
|
9234
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
9267
9235
|
}
|
|
9268
9236
|
interface GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig {
|
|
9269
9237
|
/** Whether generated answer contains suggested related questions. */
|
|
@@ -20958,7 +20926,7 @@ declare namespace gapi.client {
|
|
|
20958
20926
|
oauth_token?: string;
|
|
20959
20927
|
/** Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order. */
|
|
20960
20928
|
orderBy?: string;
|
|
20961
|
-
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
20929
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */
|
|
20962
20930
|
pageSize?: number;
|
|
20963
20931
|
/** Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. */
|
|
20964
20932
|
pageToken?: string;
|