@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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 +137 -114
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260629
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -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;
|
|
@@ -1808,7 +1803,7 @@ declare namespace gapi.client {
|
|
|
1808
1803
|
name?: string;
|
|
1809
1804
|
/** This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. */
|
|
1810
1805
|
numUniqueUsersThreshold?: number;
|
|
1811
|
-
/** This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is
|
|
1806
|
+
/** This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. */
|
|
1812
1807
|
queryFrequencyThreshold?: number;
|
|
1813
1808
|
/** The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. */
|
|
1814
1809
|
queryModel?: 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 {
|
|
@@ -2770,7 +2767,7 @@ declare namespace gapi.client {
|
|
|
2770
2767
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting;
|
|
2771
2768
|
/** 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. */
|
|
2772
2769
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
2773
|
-
/**
|
|
2770
|
+
/** 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. */
|
|
2774
2771
|
associatedAgentRegistry?: string;
|
|
2775
2772
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
2776
2773
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
@@ -2794,7 +2791,7 @@ declare namespace gapi.client {
|
|
|
2794
2791
|
disableAnalytics?: boolean;
|
|
2795
2792
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2796
2793
|
displayName?: string;
|
|
2797
|
-
/** 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` */
|
|
2794
|
+
/** 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` */
|
|
2798
2795
|
features?: {
|
|
2799
2796
|
[P in string]:
|
|
2800
2797
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -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,15 +2932,12 @@ 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
|
}
|
|
2947
2939
|
interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
2948
|
-
/** Optional. The required subscription tier of this engine.
|
|
2940
|
+
/** 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. */
|
|
2949
2941
|
requiredSubscriptionTier?:
|
|
2950
2942
|
| 'SUBSCRIPTION_TIER_UNSPECIFIED'
|
|
2951
2943
|
| 'SUBSCRIPTION_TIER_SEARCH'
|
|
@@ -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. */
|
|
@@ -3049,6 +3037,11 @@ declare namespace gapi.client {
|
|
|
3049
3037
|
outputConfig?: GoogleCloudDiscoveryengineV1alphaOutputConfig;
|
|
3050
3038
|
}
|
|
3051
3039
|
interface GoogleCloudDiscoveryengineV1alphaExportMetricsResponse {}
|
|
3040
|
+
interface GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest {}
|
|
3041
|
+
interface GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse {
|
|
3042
|
+
/** The full CSV document as raw bytes: the header row followed by one row per UserLicense. Contains user license data (e.g. user emails). An export with no matching licenses contains only the header row. */
|
|
3043
|
+
csvData?: string;
|
|
3044
|
+
}
|
|
3052
3045
|
interface GoogleCloudDiscoveryengineV1alphaExternalIdentity {
|
|
3053
3046
|
/** The display name of the user or group. */
|
|
3054
3047
|
displayName?: string;
|
|
@@ -3481,9 +3474,7 @@ declare namespace gapi.client {
|
|
|
3481
3474
|
inlineSource?: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
|
|
3482
3475
|
/** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
3483
3476
|
reconciliationMode?:
|
|
3484
|
-
| '
|
|
3485
|
-
| 'INCREMENTAL'
|
|
3486
|
-
| 'FULL';
|
|
3477
|
+
'RECONCILIATION_MODE_UNSPECIFIED' | 'INCREMENTAL' | 'FULL';
|
|
3487
3478
|
/** Spanner input source. */
|
|
3488
3479
|
spannerSource?: GoogleCloudDiscoveryengineV1alphaSpannerSource;
|
|
3489
3480
|
/** Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */
|
|
@@ -4769,9 +4760,7 @@ declare namespace gapi.client {
|
|
|
4769
4760
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
4770
4761
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
4771
4762
|
searchResultMode?:
|
|
4772
|
-
| '
|
|
4773
|
-
| 'DOCUMENTS'
|
|
4774
|
-
| 'CHUNKS';
|
|
4763
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
4775
4764
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
4776
4765
|
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
4777
4766
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -4922,14 +4911,10 @@ declare namespace gapi.client {
|
|
|
4922
4911
|
allowedFieldNames?: string[];
|
|
4923
4912
|
/** 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
4913
|
extractedFilterBehavior?:
|
|
4925
|
-
| '
|
|
4926
|
-
| 'HARD_FILTER'
|
|
4927
|
-
| 'SOFT_BOOST';
|
|
4914
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
4928
4915
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
4929
4916
|
filterExtractionCondition?:
|
|
4930
|
-
| '
|
|
4931
|
-
| 'DISABLED'
|
|
4932
|
-
| 'ENABLED';
|
|
4917
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
4933
4918
|
/** 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
4919
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
4935
4920
|
}
|
|
@@ -5871,7 +5856,9 @@ declare namespace gapi.client {
|
|
|
5871
5856
|
facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
5872
5857
|
/** 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
5858
|
fieldsUiComponentsMap?: {
|
|
5874
|
-
[
|
|
5859
|
+
[
|
|
5860
|
+
P in string
|
|
5861
|
+
]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
5875
5862
|
};
|
|
5876
5863
|
/** Output only. Whether the subscription is gemini bundle or not. */
|
|
5877
5864
|
geminiBundle?: boolean;
|
|
@@ -5893,9 +5880,7 @@ declare namespace gapi.client {
|
|
|
5893
5880
|
nodes?: GoogleCloudDiscoveryengineV1alphaWidgetConfigNode[];
|
|
5894
5881
|
/** 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
5882
|
resultDisplayType?:
|
|
5896
|
-
| '
|
|
5897
|
-
| 'SNIPPET'
|
|
5898
|
-
| 'EXTRACTIVE_ANSWER';
|
|
5883
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
5899
5884
|
/** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
|
|
5900
5885
|
solutionType?:
|
|
5901
5886
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -6004,14 +5989,17 @@ declare namespace gapi.client {
|
|
|
6004
5989
|
| 'GOOGLE_CHAT'
|
|
6005
5990
|
| 'GOOGLE_GROUPS'
|
|
6006
5991
|
| 'GOOGLE_KEEP'
|
|
6007
|
-
| 'GOOGLE_PEOPLE'
|
|
5992
|
+
| 'GOOGLE_PEOPLE'
|
|
5993
|
+
| 'GOOGLE_WORKSPACE';
|
|
6008
5994
|
}
|
|
6009
5995
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
|
|
6010
5996
|
/** Facet fields that store the mapping of fields to end user widget appearance. */
|
|
6011
5997
|
facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
6012
5998
|
/** 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
5999
|
fieldsUiComponentsMap?: {
|
|
6014
|
-
[
|
|
6000
|
+
[
|
|
6001
|
+
P in string
|
|
6002
|
+
]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
6015
6003
|
};
|
|
6016
6004
|
/** 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
6005
|
id?: string;
|
|
@@ -6061,9 +6049,7 @@ declare namespace gapi.client {
|
|
|
6061
6049
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
|
|
6062
6050
|
/** The field visibility on different types of devices. */
|
|
6063
6051
|
deviceVisibility?:
|
|
6064
|
-
| '
|
|
6065
|
-
| 'MOBILE'
|
|
6066
|
-
| 'DESKTOP'[];
|
|
6052
|
+
'DEVICE_VISIBILITY_UNSPECIFIED' | 'MOBILE' | 'DESKTOP'[];
|
|
6067
6053
|
/** The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". */
|
|
6068
6054
|
displayTemplate?: string;
|
|
6069
6055
|
/** Required. Registered field name. The format is `field.abc`. */
|
|
@@ -6090,7 +6076,7 @@ declare namespace gapi.client {
|
|
|
6090
6076
|
enableSearchAsYouType?: boolean;
|
|
6091
6077
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
6092
6078
|
enableVisualContentSummary?: boolean;
|
|
6093
|
-
/** 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` */
|
|
6079
|
+
/** 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` */
|
|
6094
6080
|
features?: {
|
|
6095
6081
|
[P in string]:
|
|
6096
6082
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -6099,6 +6085,8 @@ declare namespace gapi.client {
|
|
|
6099
6085
|
};
|
|
6100
6086
|
/** Describes generative answer configuration. */
|
|
6101
6087
|
generativeAnswerConfig?: GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig;
|
|
6088
|
+
/** 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. */
|
|
6089
|
+
googleDrivePickerEnabled?: boolean;
|
|
6102
6090
|
/** Describes widget (or web app) interaction type */
|
|
6103
6091
|
interactionType?:
|
|
6104
6092
|
| 'INTERACTION_TYPE_UNSPECIFIED'
|
|
@@ -6110,15 +6098,13 @@ declare namespace gapi.client {
|
|
|
6110
6098
|
/** 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
6099
|
modelConfigs?: {
|
|
6112
6100
|
[P in string]:
|
|
6113
|
-
| '
|
|
6114
|
-
| 'MODEL_ENABLED'
|
|
6115
|
-
| 'MODEL_DISABLED';
|
|
6101
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
6116
6102
|
};
|
|
6103
|
+
/** 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). */
|
|
6104
|
+
onedrivePickerEnabled?: boolean;
|
|
6117
6105
|
/** Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. */
|
|
6118
6106
|
resultDescriptionType?:
|
|
6119
|
-
| '
|
|
6120
|
-
| 'SNIPPET'
|
|
6121
|
-
| 'EXTRACTIVE_ANSWER';
|
|
6107
|
+
'RESULT_DISPLAY_TYPE_UNSPECIFIED' | 'SNIPPET' | 'EXTRACTIVE_ANSWER';
|
|
6122
6108
|
/** Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. */
|
|
6123
6109
|
searchAddonSpec?: GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec;
|
|
6124
6110
|
}
|
|
@@ -6191,7 +6177,8 @@ declare namespace gapi.client {
|
|
|
6191
6177
|
| 'GOOGLE_CHAT'
|
|
6192
6178
|
| 'GOOGLE_GROUPS'
|
|
6193
6179
|
| 'GOOGLE_KEEP'
|
|
6194
|
-
| 'GOOGLE_PEOPLE'
|
|
6180
|
+
| 'GOOGLE_PEOPLE'
|
|
6181
|
+
| 'GOOGLE_WORKSPACE';
|
|
6195
6182
|
}
|
|
6196
6183
|
interface GoogleCloudDiscoveryengineV1alphaWorkspaceSettings {
|
|
6197
6184
|
/** Whether the calling user's customer domain matches the workspace data stores under this engine. */
|
|
@@ -6751,7 +6738,9 @@ declare namespace gapi.client {
|
|
|
6751
6738
|
name?: string;
|
|
6752
6739
|
/** 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
6740
|
parsingConfigOverrides?: {
|
|
6754
|
-
[
|
|
6741
|
+
[
|
|
6742
|
+
P in string
|
|
6743
|
+
]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
6755
6744
|
};
|
|
6756
6745
|
}
|
|
6757
6746
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
|
|
@@ -6809,7 +6798,7 @@ declare namespace gapi.client {
|
|
|
6809
6798
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1betaAgentGatewaySetting;
|
|
6810
6799
|
/** 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. */
|
|
6811
6800
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
6812
|
-
/**
|
|
6801
|
+
/** 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. */
|
|
6813
6802
|
associatedAgentRegistry?: string;
|
|
6814
6803
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
6815
6804
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
|
|
@@ -6833,7 +6822,7 @@ declare namespace gapi.client {
|
|
|
6833
6822
|
disableAnalytics?: boolean;
|
|
6834
6823
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
6835
6824
|
displayName?: string;
|
|
6836
|
-
/** 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` */
|
|
6825
|
+
/** 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` */
|
|
6837
6826
|
features?: {
|
|
6838
6827
|
[P in string]:
|
|
6839
6828
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -6860,9 +6849,7 @@ declare namespace gapi.client {
|
|
|
6860
6849
|
/** 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
6850
|
modelConfigs?: {
|
|
6862
6851
|
[P in string]:
|
|
6863
|
-
| '
|
|
6864
|
-
| 'MODEL_ENABLED'
|
|
6865
|
-
| 'MODEL_DISABLED';
|
|
6852
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
6866
6853
|
};
|
|
6867
6854
|
/** 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
6855
|
name?: string;
|
|
@@ -6964,7 +6951,7 @@ declare namespace gapi.client {
|
|
|
6964
6951
|
contextEventType?: string;
|
|
6965
6952
|
}
|
|
6966
6953
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
6967
|
-
/** Optional. The required subscription tier of this engine.
|
|
6954
|
+
/** 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. */
|
|
6968
6955
|
requiredSubscriptionTier?:
|
|
6969
6956
|
| 'SUBSCRIPTION_TIER_UNSPECIFIED'
|
|
6970
6957
|
| 'SUBSCRIPTION_TIER_SEARCH'
|
|
@@ -7006,11 +6993,7 @@ declare namespace gapi.client {
|
|
|
7006
6993
|
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
7007
6994
|
/** Output only. The state of the evaluation. */
|
|
7008
6995
|
state?:
|
|
7009
|
-
| '
|
|
7010
|
-
| 'PENDING'
|
|
7011
|
-
| 'RUNNING'
|
|
7012
|
-
| 'SUCCEEDED'
|
|
7013
|
-
| 'FAILED';
|
|
6996
|
+
'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED';
|
|
7014
6997
|
}
|
|
7015
6998
|
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec {
|
|
7016
6999
|
/** Optional. The specification of the query set. */
|
|
@@ -7560,9 +7543,7 @@ declare namespace gapi.client {
|
|
|
7560
7543
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
7561
7544
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
7562
7545
|
searchResultMode?:
|
|
7563
|
-
| '
|
|
7564
|
-
| 'DOCUMENTS'
|
|
7565
|
-
| 'CHUNKS';
|
|
7546
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
7566
7547
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
7567
7548
|
snippetSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec;
|
|
7568
7549
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -7713,14 +7694,10 @@ declare namespace gapi.client {
|
|
|
7713
7694
|
allowedFieldNames?: string[];
|
|
7714
7695
|
/** 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
7696
|
extractedFilterBehavior?:
|
|
7716
|
-
| '
|
|
7717
|
-
| 'HARD_FILTER'
|
|
7718
|
-
| 'SOFT_BOOST';
|
|
7697
|
+
'EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED' | 'HARD_FILTER' | 'SOFT_BOOST';
|
|
7719
7698
|
/** The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. */
|
|
7720
7699
|
filterExtractionCondition?:
|
|
7721
|
-
| '
|
|
7722
|
-
| 'DISABLED'
|
|
7723
|
-
| 'ENABLED';
|
|
7700
|
+
'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED';
|
|
7724
7701
|
/** 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
7702
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
7726
7703
|
}
|
|
@@ -7950,7 +7927,8 @@ declare namespace gapi.client {
|
|
|
7950
7927
|
| 'GOOGLE_CHAT'
|
|
7951
7928
|
| 'GOOGLE_GROUPS'
|
|
7952
7929
|
| 'GOOGLE_KEEP'
|
|
7953
|
-
| 'GOOGLE_PEOPLE'
|
|
7930
|
+
| 'GOOGLE_PEOPLE'
|
|
7931
|
+
| 'GOOGLE_WORKSPACE';
|
|
7954
7932
|
}
|
|
7955
7933
|
interface GoogleCloudDiscoveryengineV1CliConfig {
|
|
7956
7934
|
/** Optional. The actions enabled on the associated CLI connection. */
|
|
@@ -8530,7 +8508,9 @@ declare namespace gapi.client {
|
|
|
8530
8508
|
name?: string;
|
|
8531
8509
|
/** 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
8510
|
parsingConfigOverrides?: {
|
|
8533
|
-
[
|
|
8511
|
+
[
|
|
8512
|
+
P in string
|
|
8513
|
+
]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
8534
8514
|
};
|
|
8535
8515
|
}
|
|
8536
8516
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
|
|
@@ -8598,7 +8578,7 @@ declare namespace gapi.client {
|
|
|
8598
8578
|
agentGatewaySetting?: GoogleCloudDiscoveryengineV1AgentGatewaySetting;
|
|
8599
8579
|
/** 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. */
|
|
8600
8580
|
appType?: 'APP_TYPE_UNSPECIFIED' | 'APP_TYPE_INTRANET';
|
|
8601
|
-
/**
|
|
8581
|
+
/** 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. */
|
|
8602
8582
|
associatedAgentRegistry?: string;
|
|
8603
8583
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
8604
8584
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
|
|
@@ -8622,7 +8602,7 @@ declare namespace gapi.client {
|
|
|
8622
8602
|
disableAnalytics?: boolean;
|
|
8623
8603
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
8624
8604
|
displayName?: string;
|
|
8625
|
-
/** 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` */
|
|
8605
|
+
/** 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` */
|
|
8626
8606
|
features?: {
|
|
8627
8607
|
[P in string]:
|
|
8628
8608
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -8649,9 +8629,7 @@ declare namespace gapi.client {
|
|
|
8649
8629
|
/** 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
8630
|
modelConfigs?: {
|
|
8651
8631
|
[P in string]:
|
|
8652
|
-
| '
|
|
8653
|
-
| 'MODEL_ENABLED'
|
|
8654
|
-
| 'MODEL_DISABLED';
|
|
8632
|
+
'MODEL_STATE_UNSPECIFIED' | 'MODEL_ENABLED' | 'MODEL_DISABLED';
|
|
8655
8633
|
};
|
|
8656
8634
|
/** 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
8635
|
name?: string;
|
|
@@ -8753,7 +8731,7 @@ declare namespace gapi.client {
|
|
|
8753
8731
|
contextEventType?: string;
|
|
8754
8732
|
}
|
|
8755
8733
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
8756
|
-
/** Optional. The required subscription tier of this engine.
|
|
8734
|
+
/** 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. */
|
|
8757
8735
|
requiredSubscriptionTier?:
|
|
8758
8736
|
| 'SUBSCRIPTION_TIER_UNSPECIFIED'
|
|
8759
8737
|
| 'SUBSCRIPTION_TIER_SEARCH'
|
|
@@ -9122,9 +9100,7 @@ declare namespace gapi.client {
|
|
|
9122
9100
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
|
|
9123
9101
|
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
9124
9102
|
searchResultMode?:
|
|
9125
|
-
| '
|
|
9126
|
-
| 'DOCUMENTS'
|
|
9127
|
-
| 'CHUNKS';
|
|
9103
|
+
'SEARCH_RESULT_MODE_UNSPECIFIED' | 'DOCUMENTS' | 'CHUNKS';
|
|
9128
9104
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
9129
9105
|
snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
|
|
9130
9106
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
@@ -9405,7 +9381,8 @@ declare namespace gapi.client {
|
|
|
9405
9381
|
| 'GOOGLE_CHAT'
|
|
9406
9382
|
| 'GOOGLE_GROUPS'
|
|
9407
9383
|
| 'GOOGLE_KEEP'
|
|
9408
|
-
| 'GOOGLE_PEOPLE'
|
|
9384
|
+
| 'GOOGLE_PEOPLE'
|
|
9385
|
+
| 'GOOGLE_WORKSPACE';
|
|
9409
9386
|
}
|
|
9410
9387
|
interface GoogleCloudNotebooklmV1alphaAccountAndRole {
|
|
9411
9388
|
/** Required. The email address associated with the account. */
|
|
@@ -10881,8 +10858,7 @@ declare namespace gapi.client {
|
|
|
10881
10858
|
prettyPrint?: boolean;
|
|
10882
10859
|
/** What format output should be. If unspecified, defaults to JSON. */
|
|
10883
10860
|
processedDocumentFormat?:
|
|
10884
|
-
| '
|
|
10885
|
-
| 'JSON';
|
|
10861
|
+
'PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED' | 'JSON';
|
|
10886
10862
|
/** Required. What type of processing to return. */
|
|
10887
10863
|
processedDocumentType?:
|
|
10888
10864
|
| 'PROCESSED_DOCUMENT_TYPE_UNSPECIFIED'
|
|
@@ -11294,9 +11270,7 @@ declare namespace gapi.client {
|
|
|
11294
11270
|
uploadType?: string;
|
|
11295
11271
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
11296
11272
|
view?:
|
|
11297
|
-
| '
|
|
11298
|
-
| 'BRANCH_VIEW_BASIC'
|
|
11299
|
-
| 'BRANCH_VIEW_FULL';
|
|
11273
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
11300
11274
|
}): Request<GoogleCloudDiscoveryengineV1alphaBranch>;
|
|
11301
11275
|
/** Lists all Branchs under the specified parent DataStore. */
|
|
11302
11276
|
list(request?: {
|
|
@@ -11326,9 +11300,7 @@ declare namespace gapi.client {
|
|
|
11326
11300
|
uploadType?: string;
|
|
11327
11301
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
11328
11302
|
view?:
|
|
11329
|
-
| '
|
|
11330
|
-
| 'BRANCH_VIEW_BASIC'
|
|
11331
|
-
| 'BRANCH_VIEW_FULL';
|
|
11303
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
11332
11304
|
}): Request<GoogleCloudDiscoveryengineV1alphaListBranchesResponse>;
|
|
11333
11305
|
documents: DocumentsResource;
|
|
11334
11306
|
operations: OperationsResource;
|
|
@@ -18863,8 +18835,7 @@ declare namespace gapi.client {
|
|
|
18863
18835
|
prettyPrint?: boolean;
|
|
18864
18836
|
/** What format output should be. If unspecified, defaults to JSON. */
|
|
18865
18837
|
processedDocumentFormat?:
|
|
18866
|
-
| '
|
|
18867
|
-
| 'JSON';
|
|
18838
|
+
'PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED' | 'JSON';
|
|
18868
18839
|
/** Required. What type of processing to return. */
|
|
18869
18840
|
processedDocumentType?:
|
|
18870
18841
|
| 'PROCESSED_DOCUMENT_TYPE_UNSPECIFIED'
|
|
@@ -19276,9 +19247,7 @@ declare namespace gapi.client {
|
|
|
19276
19247
|
uploadType?: string;
|
|
19277
19248
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
19278
19249
|
view?:
|
|
19279
|
-
| '
|
|
19280
|
-
| 'BRANCH_VIEW_BASIC'
|
|
19281
|
-
| 'BRANCH_VIEW_FULL';
|
|
19250
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
19282
19251
|
}): Request<GoogleCloudDiscoveryengineV1alphaBranch>;
|
|
19283
19252
|
/** Lists all Branchs under the specified parent DataStore. */
|
|
19284
19253
|
list(request?: {
|
|
@@ -19308,9 +19277,7 @@ declare namespace gapi.client {
|
|
|
19308
19277
|
uploadType?: string;
|
|
19309
19278
|
/** The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified. */
|
|
19310
19279
|
view?:
|
|
19311
|
-
| '
|
|
19312
|
-
| 'BRANCH_VIEW_BASIC'
|
|
19313
|
-
| 'BRANCH_VIEW_FULL';
|
|
19280
|
+
'BRANCH_VIEW_UNSPECIFIED' | 'BRANCH_VIEW_BASIC' | 'BRANCH_VIEW_FULL';
|
|
19314
19281
|
}): Request<GoogleCloudDiscoveryengineV1alphaListBranchesResponse>;
|
|
19315
19282
|
documents: DocumentsResource;
|
|
19316
19283
|
operations: OperationsResource;
|
|
@@ -25001,6 +24968,64 @@ declare namespace gapi.client {
|
|
|
25001
24968
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
25002
24969
|
}
|
|
25003
24970
|
interface UserLicensesResource {
|
|
24971
|
+
/** Exports all the UserLicenses under the parent UserStore as a single CSV document. This is the backend for the admin console "Download as CSV" action: it reuses the ListUserLicenses read path so admins can sort/filter offline in Excel or Sheets. The response carries the full CSV (header row followed by data rows) inline in ExportUserLicensesResponse.csv_data. */
|
|
24972
|
+
export(request: {
|
|
24973
|
+
/** V1 error format. */
|
|
24974
|
+
'$.xgafv'?: '1' | '2';
|
|
24975
|
+
/** OAuth access token. */
|
|
24976
|
+
access_token?: string;
|
|
24977
|
+
/** Data format for response. */
|
|
24978
|
+
alt?: 'json' | 'media' | 'proto';
|
|
24979
|
+
/** JSONP */
|
|
24980
|
+
callback?: string;
|
|
24981
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
24982
|
+
fields?: string;
|
|
24983
|
+
/** 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. */
|
|
24984
|
+
key?: string;
|
|
24985
|
+
/** OAuth 2.0 token for the current user. */
|
|
24986
|
+
oauth_token?: string;
|
|
24987
|
+
/** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. All UserLicenses under this UserStore are exported. */
|
|
24988
|
+
parent: string;
|
|
24989
|
+
/** Returns response with indentations and line breaks. */
|
|
24990
|
+
prettyPrint?: boolean;
|
|
24991
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
24992
|
+
quotaUser?: string;
|
|
24993
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
24994
|
+
upload_protocol?: string;
|
|
24995
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
24996
|
+
uploadType?: string;
|
|
24997
|
+
/** Request body */
|
|
24998
|
+
resource: GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest;
|
|
24999
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>;
|
|
25000
|
+
export(
|
|
25001
|
+
request: {
|
|
25002
|
+
/** V1 error format. */
|
|
25003
|
+
'$.xgafv'?: '1' | '2';
|
|
25004
|
+
/** OAuth access token. */
|
|
25005
|
+
access_token?: string;
|
|
25006
|
+
/** Data format for response. */
|
|
25007
|
+
alt?: 'json' | 'media' | 'proto';
|
|
25008
|
+
/** JSONP */
|
|
25009
|
+
callback?: string;
|
|
25010
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
25011
|
+
fields?: string;
|
|
25012
|
+
/** 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. */
|
|
25013
|
+
key?: string;
|
|
25014
|
+
/** OAuth 2.0 token for the current user. */
|
|
25015
|
+
oauth_token?: string;
|
|
25016
|
+
/** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. All UserLicenses under this UserStore are exported. */
|
|
25017
|
+
parent: string;
|
|
25018
|
+
/** Returns response with indentations and line breaks. */
|
|
25019
|
+
prettyPrint?: boolean;
|
|
25020
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
25021
|
+
quotaUser?: string;
|
|
25022
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
25023
|
+
upload_protocol?: string;
|
|
25024
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
25025
|
+
uploadType?: string;
|
|
25026
|
+
},
|
|
25027
|
+
body: GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest,
|
|
25028
|
+
): Request<GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>;
|
|
25004
25029
|
/** Lists the User Licenses. */
|
|
25005
25030
|
list(request?: {
|
|
25006
25031
|
/** V1 error format. */
|
|
@@ -25202,9 +25227,7 @@ declare namespace gapi.client {
|
|
|
25202
25227
|
callback?: string;
|
|
25203
25228
|
/** Optional. The type of entities to fetch. If not set, all entity types will be returned. */
|
|
25204
25229
|
entityTypeFilter?:
|
|
25205
|
-
| '
|
|
25206
|
-
| 'USERS'
|
|
25207
|
-
| 'GROUPS';
|
|
25230
|
+
'ENTITY_TYPE_FILTER_UNSPECIFIED' | 'USERS' | 'GROUPS';
|
|
25208
25231
|
/** Selector specifying which fields to include in a partial response. */
|
|
25209
25232
|
fields?: string;
|
|
25210
25233
|
/** 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. */
|