@maxim_mazurok/gapi.client.discoveryengine-v1 0.3.20260927 → 0.3.20261013
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 +34 -9
- 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: 20261013
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1982,6 +1982,8 @@ declare namespace gapi.client {
|
|
|
1982
1982
|
user?: string;
|
|
1983
1983
|
}
|
|
1984
1984
|
interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig {
|
|
1985
|
+
/** Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. */
|
|
1986
|
+
notebooks?: string[];
|
|
1985
1987
|
/** Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* */
|
|
1986
1988
|
searchConfig?: string;
|
|
1987
1989
|
}
|
|
@@ -2201,7 +2203,7 @@ declare namespace gapi.client {
|
|
|
2201
2203
|
disableAnalytics?: boolean;
|
|
2202
2204
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2203
2205
|
displayName?: string;
|
|
2204
|
-
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` */
|
|
2206
|
+
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` */
|
|
2205
2207
|
features?: {
|
|
2206
2208
|
[P in string]:
|
|
2207
2209
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -2461,6 +2463,16 @@ declare namespace gapi.client {
|
|
|
2461
2463
|
keyPropertyType?: string;
|
|
2462
2464
|
/** Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. */
|
|
2463
2465
|
metatagName?: string;
|
|
2466
|
+
/** Optional. If partial_matchable_option is PARTIAL_MATCHABLE_OPTION_ENABLED, field values are partial matchable. If partial_matchable_option is unset, the server behavior defaults to PARTIAL_MATCHABLE_OPTION_DISABLED for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting partial_matchable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
2467
|
+
partialMatchableOption?:
|
|
2468
|
+
| 'PARTIAL_MATCHABLE_OPTION_UNSPECIFIED'
|
|
2469
|
+
| 'PARTIAL_MATCHABLE_OPTION_ENABLED'
|
|
2470
|
+
| 'PARTIAL_MATCHABLE_OPTION_DISABLED';
|
|
2471
|
+
/** Optional. If prefix_matchable_option is PREFIX_MATCHABLE_OPTION_ENABLED, field values are prefix matchable. If prefix_matchable_option is unset, the server behavior defaults to PREFIX_MATCHABLE_OPTION_DISABLED for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting prefix_matchable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
2472
|
+
prefixMatchableOption?:
|
|
2473
|
+
| 'PREFIX_MATCHABLE_OPTION_UNSPECIFIED'
|
|
2474
|
+
| 'PREFIX_MATCHABLE_OPTION_ENABLED'
|
|
2475
|
+
| 'PREFIX_MATCHABLE_OPTION_DISABLED';
|
|
2464
2476
|
/** If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. */
|
|
2465
2477
|
recsFilterableOption?:
|
|
2466
2478
|
| 'FILTERABLE_OPTION_UNSPECIFIED'
|
|
@@ -3162,7 +3174,7 @@ declare namespace gapi.client {
|
|
|
3162
3174
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
3163
3175
|
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
3164
3176
|
customRankingParams?: GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams;
|
|
3165
|
-
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
3177
|
+
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. */
|
|
3166
3178
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
3167
3179
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
3168
3180
|
displaySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec;
|
|
@@ -4869,6 +4881,8 @@ declare namespace gapi.client {
|
|
|
4869
4881
|
user?: string;
|
|
4870
4882
|
}
|
|
4871
4883
|
interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig {
|
|
4884
|
+
/** Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. */
|
|
4885
|
+
notebooks?: string[];
|
|
4872
4886
|
/** Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* */
|
|
4873
4887
|
searchConfig?: string;
|
|
4874
4888
|
}
|
|
@@ -5028,7 +5042,7 @@ declare namespace gapi.client {
|
|
|
5028
5042
|
disableAnalytics?: boolean;
|
|
5029
5043
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
5030
5044
|
displayName?: string;
|
|
5031
|
-
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` */
|
|
5045
|
+
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` */
|
|
5032
5046
|
features?: {
|
|
5033
5047
|
[P in string]:
|
|
5034
5048
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -5643,7 +5657,7 @@ declare namespace gapi.client {
|
|
|
5643
5657
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
5644
5658
|
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
5645
5659
|
customRankingParams?: GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams;
|
|
5646
|
-
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
5660
|
+
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. */
|
|
5647
5661
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
5648
5662
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
5649
5663
|
displaySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec;
|
|
@@ -7020,6 +7034,8 @@ declare namespace gapi.client {
|
|
|
7020
7034
|
user?: string;
|
|
7021
7035
|
}
|
|
7022
7036
|
interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig {
|
|
7037
|
+
/** Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. */
|
|
7038
|
+
notebooks?: string[];
|
|
7023
7039
|
/** Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* */
|
|
7024
7040
|
searchConfig?: string;
|
|
7025
7041
|
}
|
|
@@ -7293,7 +7309,7 @@ declare namespace gapi.client {
|
|
|
7293
7309
|
disableAnalytics?: boolean;
|
|
7294
7310
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
7295
7311
|
displayName?: string;
|
|
7296
|
-
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` */
|
|
7312
|
+
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` */
|
|
7297
7313
|
features?: {
|
|
7298
7314
|
[P in string]:
|
|
7299
7315
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -7481,7 +7497,8 @@ declare namespace gapi.client {
|
|
|
7481
7497
|
| 'GOOGLE_CONSOLE'
|
|
7482
7498
|
| 'GOOGLE_WIDGET'
|
|
7483
7499
|
| 'GOOGLE_WEBAPP'
|
|
7484
|
-
| 'GOOGLE_AGENTSPACE_MOBILE'
|
|
7500
|
+
| 'GOOGLE_AGENTSPACE_MOBILE'
|
|
7501
|
+
| 'GOOGLE_AGENTSPACE_DESKTOP';
|
|
7485
7502
|
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
7486
7503
|
feedbackType?: 'FEEDBACK_TYPE_UNSPECIFIED' | 'LIKE' | 'DISLIKE';
|
|
7487
7504
|
/** The version of the LLM model that was used to generate the response. */
|
|
@@ -7510,6 +7527,12 @@ declare namespace gapi.client {
|
|
|
7510
7527
|
questionIndex?: number;
|
|
7511
7528
|
/** Name of the newly generated or continued session. */
|
|
7512
7529
|
session?: string;
|
|
7530
|
+
/** Optional. The `TaskServerEvent.seq_num` of the step that opened the rated agent task reply. */
|
|
7531
|
+
stepSeqNum?: string;
|
|
7532
|
+
/** Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} */
|
|
7533
|
+
taskName?: string;
|
|
7534
|
+
/** Optional. The runtime trajectory id of the rated agent task turn, as set on `TaskServerEvent.trajectory_id`. Shared by all steps of the turn. */
|
|
7535
|
+
trajectoryId?: string;
|
|
7513
7536
|
}
|
|
7514
7537
|
interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
|
|
7515
7538
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
@@ -8349,7 +8372,7 @@ declare namespace gapi.client {
|
|
|
8349
8372
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec[];
|
|
8350
8373
|
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
8351
8374
|
customRankingParams?: GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams;
|
|
8352
|
-
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
8375
|
+
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. */
|
|
8353
8376
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[];
|
|
8354
8377
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
8355
8378
|
displaySpec?: GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec;
|
|
@@ -9641,7 +9664,7 @@ declare namespace gapi.client {
|
|
|
9641
9664
|
enableSearchAsYouType?: boolean;
|
|
9642
9665
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
9643
9666
|
enableVisualContentSummary?: boolean;
|
|
9644
|
-
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` */
|
|
9667
|
+
/** 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` * `speech-to-text` * `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` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` * `code-extraction` */
|
|
9645
9668
|
features?: {
|
|
9646
9669
|
[P in string]:
|
|
9647
9670
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -9702,6 +9725,8 @@ declare namespace gapi.client {
|
|
|
9702
9725
|
resultCount?: number;
|
|
9703
9726
|
}
|
|
9704
9727
|
interface GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfo {
|
|
9728
|
+
/** Output only. The `model_id` a client must send when the end-user picks the "Auto" entry (the empty `model_id`). Populated only for surfaces known to have no true "Auto" mode, where leaving the model unset would fall back to a platform default rather than a backend-chosen model. Empty on every other surface, where "Auto" is resolved server-side, and when none of the surface's ranked models is available. When set, it is always one of the non-empty `model_id`s present in `resolved_models`. */
|
|
9729
|
+
autoModelId?: string;
|
|
9705
9730
|
/** Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. */
|
|
9706
9731
|
defaultModelId?: string;
|
|
9707
9732
|
/** Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. */
|