Skip to content

discoveryengine: add search_addon_spec to google_discovery_engine_widget_config #18962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slevenick merged 1 commit into from
Sep 16, 2026
+156 −0
Merged

discoveryengine: add search_addon_spec to google_discovery_engine_widget_config #18962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions mmv1/products/discoveryengine/WidgetConfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,35 @@ properties:
Whether to show the admin-configured display name for data connectors in
the widget sources UI (instead of the connector kind). Opt-in; defaults
to false.
- name: searchAddonSpec
type: NestedObject

@SirGitsalot SirGitsalot Sep 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
type: NestedObject
type: NestedObject
allow_empty_object: true

The (untested!) theory here is that explicitly setting one or more of the three bools to false w/o setting any of the others to true will cause the API to return an empty searchAddonSpec per the proto3 JSON encoding rules. The generated flattenDiscoveryEngineWidgetConfigUiSettingsSearchAddonSpec() looks like:

func flattenDiscoveryEngineWidgetConfigUiSettingsSearchAddonSpec(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
	if v == nil {
		return nil
	}
	original := v.(map[string]interface{})
	if len(original) == 0 {
		return nil
	}
    // ...
}

if len(original) == 0 returning nil would then be a permadiff since the user config has a value but the flattened result does not (again - untested theory).

diff_suppress_func: tpgresource.EmptyOrUnsetBlockDiffSuppress
description: |
SearchAddonSpec is used to disable add-ons for search. By default, if this
field is not specified, add-ons are enabled wherever applicable.
This field is only supported for search requests.
properties:
- name: semanticAddOnDisabled
type: Boolean
description: |
If true, semantic add-on is disabled. Semantic add-on includes
embeddings and jetstream.
send_empty_value: true
diff_suppress_func: tpgresource.EmptyOrFalseSuppressBoolean
- name: kpiPersonalizationAddOnDisabled
type: Boolean
description: |
If true, disables event re-ranking and personalization to optimize KPIs
& personalize results.
send_empty_value: true
diff_suppress_func: tpgresource.EmptyOrFalseSuppressBoolean
- name: generativeAnswerAddOnDisabled
type: Boolean
description: |
If true, generative answer add-on is disabled. Generative answer
add-on includes natural language to filters and simple answers.
send_empty_value: true
diff_suppress_func: tpgresource.EmptyOrFalseSuppressBoolean
- name: uiBranding
type: NestedObject
description: |
Expand Down
127 changes: 127 additions & 0 deletions ..._party/terraform/services/discoveryengine/resource_discovery_engine_widget_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ func TestAccDiscoveryEngineWidgetConfig_discoveryengineWidgetconfigBasicExample_
Steps: []resource.TestStep{
{
Config: testAccDiscoveryEngineWidgetConfig_discoveryengineWidgetconfigBasicExample_basic(context),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("google_discovery_engine_widget_config.basic", "ui_settings.0.search_addon_spec.0.semantic_add_on_disabled", "true"),
resource.TestCheckResourceAttr("google_discovery_engine_widget_config.basic", "ui_settings.0.search_addon_spec.0.kpi_personalization_add_on_disabled", "false"),
resource.TestCheckResourceAttr("google_discovery_engine_widget_config.basic", "ui_settings.0.search_addon_spec.0.generative_answer_add_on_disabled", "true"),
),
},
{
ResourceName: "google_discovery_engine_widget_config.basic",
Expand All @@ -30,6 +35,19 @@ func TestAccDiscoveryEngineWidgetConfig_discoveryengineWidgetconfigBasicExample_
},
{
Config: testAccDiscoveryEngineWidgetConfig_discoveryengineWidgetconfigBasicExample_update(context),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("google_discovery_engine_widget_config.basic", "ui_settings.0.search_addon_spec.0.semantic_add_on_disabled", "false"),
resource.TestCheckResourceAttr("google_discovery_engine_widget_config.basic", "ui_settings.0.search_addon_spec.0.kpi_personalization_add_on_disabled", "true"),
resource.TestCheckResourceAttr("google_discovery_engine_widget_config.basic", "ui_settings.0.search_addon_spec.0.generative_answer_add_on_disabled", "false"),
),
},
{
ResourceName: "google_discovery_engine_widget_config.basic",
ImportState: true,
ImportStateVerify: true,
},
{
Config: testAccDiscoveryEngineWidgetConfig_discoveryengineWidgetconfigBasicExample_allFalse(context),
},
{
ResourceName: "google_discovery_engine_widget_config.basic",
Expand Down Expand Up @@ -115,6 +133,11 @@ resource "google_discovery_engine_widget_config" "basic" {
display_template = "Name: {name}"
}
}
search_addon_spec {
semantic_add_on_disabled = true
kpi_personalization_add_on_disabled = false
generative_answer_add_on_disabled = true
}
}
ui_branding {
logo {
Expand Down Expand Up @@ -210,6 +233,110 @@ resource "google_discovery_engine_widget_config" "basic" {
display_template = "Name: {name}"
}
}
search_addon_spec {
semantic_add_on_disabled = false
kpi_personalization_add_on_disabled = true
generative_answer_add_on_disabled = false
}
}
ui_branding {
logo {
url = "https://example.com/new-logo.png"
}
}
homepage_setting {
shortcuts {
destination_uri = "https://example.com/new-destination"
icon {
url = "https://example.com/new-logo.png"
}
title = "Name"
}
}
}
`, context)
}

func testAccDiscoveryEngineWidgetConfig_discoveryengineWidgetconfigBasicExample_allFalse(context map[string]interface{}) string {
return acctest.Nprintf(`
data "google_project" "project" {}

resource "google_discovery_engine_data_store" "basic" {
location = "global"
data_store_id = "tf-test-data-store-id%{random_suffix}"
display_name = "tf-test-datastore"
industry_vertical = "GENERIC"
content_config = "NO_CONTENT"
solution_types = ["SOLUTION_TYPE_SEARCH"]
create_advanced_site_search = false
}

resource "google_discovery_engine_search_engine" "basic" {
engine_id = "tf-test-engine-id%{random_suffix}"
collection_id = "default_collection"
location = google_discovery_engine_data_store.basic.location
display_name = "tf-test-engine"
data_store_ids = [google_discovery_engine_data_store.basic.data_store_id]
industry_vertical = "GENERIC"
app_type = "APP_TYPE_INTRANET"
search_engine_config {
}
}

resource "google_discovery_engine_widget_config" "basic" {
location = google_discovery_engine_search_engine.basic.location
collection_id = "default_collection"
engine_id = google_discovery_engine_search_engine.basic.engine_id
widget_config_id = "default_search_widget_config"
access_settings {
enable_web_app = true
workforce_identity_pool_provider = "locations/global/workforcePools/workforce-pool-id/providers/workforce-pool-provider"
allow_public_access = false
allowlisted_domains = []
language_code = "en-US"
}
ui_settings {
interaction_type = "SEARCH_WITH_ANSWER"
enable_autocomplete = true
enable_quality_feedback = true
disable_user_events_collection = false
enable_create_agent_button = false
enable_people_search = false
enable_safe_search = false
enable_search_as_you_type = false
enable_visual_content_summary = false
default_search_request_order_by = "relevanceScore"
result_description_type = "SNIPPET"
generative_answer_config {
disable_related_questions = false
ignore_adversarial_query = false
ignore_low_relevant_content = false
ignore_non_answer_seeking_query = false
language_code = "en-US"
max_rephrase_steps = 1
result_count = 5
model_version = "stable"
model_prompt_preamble = "You are a helpful assistant."
image_source = "ALL_AVAILABLE_SOURCES"
}
data_store_ui_configs {
name = "projects/${data.google_project.project.number}/locations/${google_discovery_engine_data_store.basic.location}/collections/default_collection/dataStores/${google_discovery_engine_data_store.basic.data_store_id}"
facet_field {
field = "name"
display_name = "Name"
}
fields_ui_components_map {
ui_component = "title"
device_visibility = ["DESKTOP"]
field = "name"
display_template = "Name: {name}"
}
}
search_addon_spec {
semantic_add_on_disabled = false
kpi_personalization_add_on_disabled = false
generative_answer_add_on_disabled = false
}
}
ui_branding {
logo {
Expand Down
Loading