discovery_engine library

Vertex AI Search (Discovery Engine): data stores, search engines, IAM, schema / serving controls, location CMEK config and third-party data connectors (apply-excluded), and Gemini Enterprise license configs (never_apply — seat subscriptions).

Classes

DiscoveryEngineAclConfigIdpConfig

Typed helper for the idp_config block of google_discovery_engine_acl_config (derived from provider schema).

DiscoveryEngineAclConfigIdpConfigExternalIdpConfig

Typed helper for the idp_config.external_idp_config block of google_discovery_engine_acl_config (derived from provider schema).

DiscoveryEngineAssistantCustomerPolicy

Typed helper for the customer_policy block of google_discovery_engine_assistant (derived from provider schema).

DiscoveryEngineAssistantCustomerPolicyBannedPhrases

Typed helper for the customer_policy.banned_phrases block of google_discovery_engine_assistant (derived from provider schema).

DiscoveryEngineAssistantCustomerPolicyModelArmorConfig

Typed helper for the customer_policy.model_armor_config block of google_discovery_engine_assistant (derived from provider schema).

DiscoveryEngineAssistantGenerationConfig

Typed helper for the generation_config block of google_discovery_engine_assistant (derived from provider schema).

DiscoveryEngineAssistantGenerationConfigSystemInstruction

Typed helper for the generation_config.system_instruction block of google_discovery_engine_assistant (derived from provider schema).

DiscoveryEngineChatEngineChatEngineConfig

Typed helper for the chat_engine_config block of google_discovery_engine_chat_engine (derived from provider schema).

DiscoveryEngineChatEngineChatEngineConfigAgentCreationConfig

Typed helper for the chat_engine_config.agent_creation_config block of google_discovery_engine_chat_engine (derived from provider schema).

DiscoveryEngineChatEngineCommonConfig

Typed helper for the common_config block of google_discovery_engine_chat_engine (derived from provider schema).

DiscoveryEngineCmekConfigSingleRegionKeys

Typed helper for the single_region_keys block of google_discovery_engine_cmek_config (derived from provider schema).

DiscoveryEngineControlAction

Choice of serving-control action. Sealed so the MM exactly_one_of group (boost_action / filter_action / redirect_action / synonyms_action / promote_action) is exhaustive at the type level.

DiscoveryEngineControlBoostAction

boost_action — change result order. Pick at most one of fixedBoost or interpolationBoostSpec.

DiscoveryEngineControlFilterAction

filter_action — drop matching results.

DiscoveryEngineControlInterpolationBoostSpec

boost_action.interpolation_boost_spec (max 1).

DiscoveryEngineControlPromoteAction

promote_action — pin a search-link promotion on dataStore.

DiscoveryEngineControlRedirectAction

redirect_action — send the query to redirectUri.

DiscoveryEngineControlSearchLinkPromotion

promote_action.search_link_promotion (min 1).

DiscoveryEngineControlSynonymsAction

synonyms_action — treat synonyms as equivalent query terms.

DiscoveryEngineDataConnectorActionConfig

Typed helper for the action_config block of google_discovery_engine_data_connector (derived from provider schema).

DiscoveryEngineDataConnectorBapConfig

Typed helper for the bap_config block of google_discovery_engine_data_connector (derived from provider schema).

DiscoveryEngineDataConnectorDestinationConfigs

Typed helper for the destination_configs block of google_discovery_engine_data_connector (derived from provider schema).

DiscoveryEngineDataConnectorDestinationConfigsDestinations

Typed helper for the destination_configs.destinations block of google_discovery_engine_data_connector (derived from provider schema).

DiscoveryEngineDataConnectorEntities

Typed helper for the entities block of google_discovery_engine_data_connector (derived from provider schema).

DiscoveryEngineLicenseConfigEndDate

Typed helper for the end_date block of google_discovery_engine_license_config (derived from provider schema).

DiscoveryEngineLicenseConfigStartDate

Typed helper for the start_date block of google_discovery_engine_license_config (derived from provider schema).

DiscoveryEngineRecommendationEngineCommonConfig

Typed helper for the common_config block of google_discovery_engine_recommendation_engine (derived from provider schema).

DiscoveryEngineRecommendationEngineMediaRecommendationEngineConfig

Typed helper for the media_recommendation_engine_config block of google_discovery_engine_recommendation_engine (derived from provider schema).

DiscoveryEngineRecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfig

Typed helper for the media_recommendation_engine_config.engine_features_config block of google_discovery_engine_recommendation_engine (derived from provider schema).

DiscoveryEngineRecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigMostPopularConfig

Typed helper for the media_recommendation_engine_config.engine_features_config.most_popular_config block of google_discovery_engine_recommendation_engine (derived from provider schema).

DiscoveryEngineRecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigRecommendedForYouConfig

Typed helper for the media_recommendation_engine_config.engine_features_config.recommended_for_you_config block of google_discovery_engine_recommendation_engine (derived from provider schema).

DiscoveryEngineRecommendationEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig

Typed helper for the media_recommendation_engine_config.optimization_objective_config block of google_discovery_engine_recommendation_engine (derived from provider schema).

DiscoveryEngineSearchEngineSearchEngineConfig

search_engine_config block (required, max=1).

DiscoveryEngineWidgetConfigAccessSettings

Typed helper for the access_settings block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigHomepageSetting

Typed helper for the homepage_setting block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigHomepageSettingShortcuts

Typed helper for the homepage_setting.shortcuts block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigHomepageSettingShortcutsIcon

Typed helper for the homepage_setting.shortcuts.icon block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigUiBranding

Typed helper for the ui_branding block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigUiBrandingLogo

Typed helper for the ui_branding.logo block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigUiSettings

Typed helper for the ui_settings block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigUiSettingsDataStoreUiConfigs

Typed helper for the ui_settings.data_store_ui_configs block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigUiSettingsDataStoreUiConfigsFacetField

Typed helper for the ui_settings.data_store_ui_configs.facet_field block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigUiSettingsDataStoreUiConfigsFieldsUiComponentsMap

Typed helper for the ui_settings.data_store_ui_configs.fields_ui_components_map block of google_discovery_engine_widget_config (derived from provider schema).

DiscoveryEngineWidgetConfigUiSettingsGenerativeAnswerConfig

Typed helper for the ui_settings.generative_answer_config block of google_discovery_engine_widget_config (derived from provider schema).

GoogleDiscoveryEngineAclConfig

Factory wrapper for google_discovery_engine_acl_config.

GoogleDiscoveryEngineAssistant

Factory wrapper for google_discovery_engine_assistant.

GoogleDiscoveryEngineChatEngine

Factory wrapper for google_discovery_engine_chat_engine.

GoogleDiscoveryEngineCmekConfig

Factory wrapper for google_discovery_engine_cmek_config.

GoogleDiscoveryEngineControl

Factory wrapper for google_discovery_engine_control.

GoogleDiscoveryEngineDataConnector

Factory wrapper for google_discovery_engine_data_connector.

GoogleDiscoveryEngineDataStore

Factory wrapper for google_discovery_engine_data_store.

GoogleDiscoveryEngineLicenseConfig

Factory wrapper for google_discovery_engine_license_config.

GoogleDiscoveryEngineRecommendationEngine

Factory wrapper for google_discovery_engine_recommendation_engine.

GoogleDiscoveryEngineSchema

Factory wrapper for google_discovery_engine_schema.

GoogleDiscoveryEngineSearchEngine

Factory wrapper for google_discovery_engine_search_engine.

GoogleDiscoveryEngineSearchEngineIamBinding

Factory wrapper for google_discovery_engine_search_engine_iam_binding.

GoogleDiscoveryEngineSearchEngineIamMember

Factory wrapper for google_discovery_engine_search_engine_iam_member.

GoogleDiscoveryEngineSearchEngineIamPolicy

Factory wrapper for google_discovery_engine_search_engine_iam_policy.

GoogleDiscoveryEngineServingConfig

Factory wrapper for google_discovery_engine_serving_config.

GoogleDiscoveryEngineSitemap

Factory wrapper for google_discovery_engine_sitemap.

GoogleDiscoveryEngineTargetSite

Factory wrapper for google_discovery_engine_target_site.

GoogleDiscoveryEngineUserStore

Factory wrapper for google_discovery_engine_user_store.

GoogleDiscoveryEngineWidgetConfig

Factory wrapper for google_discovery_engine_widget_config.

Enums

DiscoveryEngineAclConfigIdpConfigIdpType

idp_type — derived from the provider schema description.

DiscoveryEngineChatEngineIndustryVertical

Discovery Engine Chat Engine Industry enum for industry_vertical.

DiscoveryEngineControlInterpolationAttributeType

boost_action.interpolation_boost_spec.attribute_type.

DiscoveryEngineControlInterpolationType

boost_action.interpolation_boost_spec.interpolation_type.

DiscoveryEngineControlSolutionType

Discovery Engine Control Solution enum for solution_type.

DiscoveryEngineDataStoreContentConfig

Discovery Engine Data Store Content enum for content_config.

DiscoveryEngineDataStoreIndustryVertical

Discovery Engine Data Store Industry enum for industry_vertical.

DiscoveryEngineLicenseConfigSubscriptionTerm

Discovery Engine License Config Subscription enum for subscription_term.

DiscoveryEngineLicenseConfigSubscriptionTier

Discovery Engine License Config Subscription enum for subscription_tier.

DiscoveryEngineRecommendationEngineIndustryVertical

Discovery Engine Recommendation Engine Industry enum for industry_vertical.

DiscoveryEngineRecommendationEngineMediaRecommendationEngineConfigTrainingState

training_state — derived from the provider schema description.

DiscoveryEngineSearchEngineIndustryVertical

Discovery Engine Search Engine Industry enum for industry_vertical.

DiscoveryEngineSearchEngineSearchTier

search_engine_config.search_tier.

DiscoveryEngineTargetSiteIndexingStatus

Discovery Engine Target Site Indexing enum for indexing_status.

DiscoveryEngineTargetSiteType

Discovery Engine Target Site enum for type.

DiscoveryEngineWidgetConfigUiSettingsDataStoreUiConfigsFieldsUiComponentsMapDeviceVisibility

device_visibility — derived from the provider schema description.

DiscoveryEngineWidgetConfigUiSettingsGenerativeAnswerConfigImageSource

image_source — derived from the provider schema description.

DiscoveryEngineWidgetConfigUiSettingsInteractionType

interaction_type — derived from the provider schema description.

DiscoveryEngineWidgetConfigUiSettingsResultDescriptionType

result_description_type — derived from the provider schema description.