1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. discoveryengine
  5. WidgetConfig
Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.discoveryengine.WidgetConfig

gcp logo
Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    Represents a WidgetConfig.

    To get more information about WidgetConfig, see:

    Example Usage

    Discoveryengine Widgetconfig Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = new gcp.discoveryengine.DataStore("basic", {
    location: "global",
    dataStoreId: "data-store-id",
    displayName: "tf-test-datastore",
    industryVertical: "GENERIC",
    contentConfig: "NO_CONTENT",
    solutionTypes: ["SOLUTION_TYPE_SEARCH"],
    createAdvancedSiteSearch: false,
});
const basicSearchEngine = new gcp.discoveryengine.SearchEngine("basic", {
    engineId: "engine-id",
    collectionId: "default_collection",
    location: basic.location,
    displayName: "tf-test-engine",
    dataStoreIds: [basic.dataStoreId],
    industryVertical: "GENERIC",
    appType: "APP_TYPE_INTRANET",
    searchEngineConfig: {},
});
const basicWidgetConfig = new gcp.discoveryengine.WidgetConfig("basic", {
    location: basicSearchEngine.location,
    engineId: basicSearchEngine.engineId,
    accessSettings: {
        enableWebApp: true,
        workforceIdentityPoolProvider: "locations/global/workforcePools/workforce-pool-id/providers/workforce-pool-provider",
    },
    uiSettings: {
        interactionType: "SEARCH_WITH_ANSWER",
        enableAutocomplete: true,
        enableQualityFeedback: true,
        generativeAnswerConfig: {
            resultCount: 5,
        },
    },
});

    import pulumi
import pulumi_gcp as gcp

basic = gcp.discoveryengine.DataStore("basic",
    location="global",
    data_store_id="data-store-id",
    display_name="tf-test-datastore",
    industry_vertical="GENERIC",
    content_config="NO_CONTENT",
    solution_types=["SOLUTION_TYPE_SEARCH"],
    create_advanced_site_search=False)
basic_search_engine = gcp.discoveryengine.SearchEngine("basic",
    engine_id="engine-id",
    collection_id="default_collection",
    location=basic.location,
    display_name="tf-test-engine",
    data_store_ids=[basic.data_store_id],
    industry_vertical="GENERIC",
    app_type="APP_TYPE_INTRANET",
    search_engine_config={})
basic_widget_config = gcp.discoveryengine.WidgetConfig("basic",
    location=basic_search_engine.location,
    engine_id=basic_search_engine.engine_id,
    access_settings={
        "enable_web_app": True,
        "workforce_identity_pool_provider": "locations/global/workforcePools/workforce-pool-id/providers/workforce-pool-provider",
    },
    ui_settings={
        "interaction_type": "SEARCH_WITH_ANSWER",
        "enable_autocomplete": True,
        "enable_quality_feedback": True,
        "generative_answer_config": {
            "result_count": 5,
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basic, err := discoveryengine.NewDataStore(ctx, "basic", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("data-store-id"),
			DisplayName:      pulumi.String("tf-test-datastore"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_SEARCH"),
			},
			CreateAdvancedSiteSearch: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		basicSearchEngine, err := discoveryengine.NewSearchEngine(ctx, "basic", &discoveryengine.SearchEngineArgs{
			EngineId:     pulumi.String("engine-id"),
			CollectionId: pulumi.String("default_collection"),
			Location:     basic.Location,
			DisplayName:  pulumi.String("tf-test-engine"),
			DataStoreIds: pulumi.StringArray{
				basic.DataStoreId,
			},
			IndustryVertical:   pulumi.String("GENERIC"),
			AppType:            pulumi.String("APP_TYPE_INTRANET"),
			SearchEngineConfig: &discoveryengine.SearchEngineSearchEngineConfigArgs{},
		})
		if err != nil {
			return err
		}
		_, err = discoveryengine.NewWidgetConfig(ctx, "basic", &discoveryengine.WidgetConfigArgs{
			Location: basicSearchEngine.Location,
			EngineId: basicSearchEngine.EngineId,
			AccessSettings: &discoveryengine.WidgetConfigAccessSettingsArgs{
				EnableWebApp:                  pulumi.Bool(true),
				WorkforceIdentityPoolProvider: pulumi.String("locations/global/workforcePools/workforce-pool-id/providers/workforce-pool-provider"),
			},
			UiSettings: &discoveryengine.WidgetConfigUiSettingsArgs{
				InteractionType:       pulumi.String("SEARCH_WITH_ANSWER"),
				EnableAutocomplete:    pulumi.Bool(true),
				EnableQualityFeedback: pulumi.Bool(true),
				GenerativeAnswerConfig: &discoveryengine.WidgetConfigUiSettingsGenerativeAnswerConfigArgs{
					ResultCount: pulumi.Int(5),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var basic = new Gcp.DiscoveryEngine.DataStore("basic", new()
    {
        Location = "global",
        DataStoreId = "data-store-id",
        DisplayName = "tf-test-datastore",
        IndustryVertical = "GENERIC",
        ContentConfig = "NO_CONTENT",
        SolutionTypes = new[]
        {
            "SOLUTION_TYPE_SEARCH",
        },
        CreateAdvancedSiteSearch = false,
    });

    var basicSearchEngine = new Gcp.DiscoveryEngine.SearchEngine("basic", new()
    {
        EngineId = "engine-id",
        CollectionId = "default_collection",
        Location = basic.Location,
        DisplayName = "tf-test-engine",
        DataStoreIds = new[]
        {
            basic.DataStoreId,
        },
        IndustryVertical = "GENERIC",
        AppType = "APP_TYPE_INTRANET",
        SearchEngineConfig = null,
    });

    var basicWidgetConfig = new Gcp.DiscoveryEngine.WidgetConfig("basic", new()
    {
        Location = basicSearchEngine.Location,
        EngineId = basicSearchEngine.EngineId,
        AccessSettings = new Gcp.DiscoveryEngine.Inputs.WidgetConfigAccessSettingsArgs
        {
            EnableWebApp = true,
            WorkforceIdentityPoolProvider = "locations/global/workforcePools/workforce-pool-id/providers/workforce-pool-provider",
        },
        UiSettings = new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiSettingsArgs
        {
            InteractionType = "SEARCH_WITH_ANSWER",
            EnableAutocomplete = true,
            EnableQualityFeedback = true,
            GenerativeAnswerConfig = new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiSettingsGenerativeAnswerConfigArgs
            {
                ResultCount = 5,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.DataStore;
import com.pulumi.gcp.discoveryengine.DataStoreArgs;
import com.pulumi.gcp.discoveryengine.SearchEngine;
import com.pulumi.gcp.discoveryengine.SearchEngineArgs;
import com.pulumi.gcp.discoveryengine.inputs.SearchEngineSearchEngineConfigArgs;
import com.pulumi.gcp.discoveryengine.WidgetConfig;
import com.pulumi.gcp.discoveryengine.WidgetConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.WidgetConfigAccessSettingsArgs;
import com.pulumi.gcp.discoveryengine.inputs.WidgetConfigUiSettingsArgs;
import com.pulumi.gcp.discoveryengine.inputs.WidgetConfigUiSettingsGenerativeAnswerConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var basic = new DataStore("basic", DataStoreArgs.builder()
            .location("global")
            .dataStoreId("data-store-id")
            .displayName("tf-test-datastore")
            .industryVertical("GENERIC")
            .contentConfig("NO_CONTENT")
            .solutionTypes("SOLUTION_TYPE_SEARCH")
            .createAdvancedSiteSearch(false)
            .build());

        var basicSearchEngine = new SearchEngine("basicSearchEngine", SearchEngineArgs.builder()
            .engineId("engine-id")
            .collectionId("default_collection")
            .location(basic.location())
            .displayName("tf-test-engine")
            .dataStoreIds(basic.dataStoreId())
            .industryVertical("GENERIC")
            .appType("APP_TYPE_INTRANET")
            .searchEngineConfig(SearchEngineSearchEngineConfigArgs.builder()
                .build())
            .build());

        var basicWidgetConfig = new WidgetConfig("basicWidgetConfig", WidgetConfigArgs.builder()
            .location(basicSearchEngine.location())
            .engineId(basicSearchEngine.engineId())
            .accessSettings(WidgetConfigAccessSettingsArgs.builder()
                .enableWebApp(true)
                .workforceIdentityPoolProvider("locations/global/workforcePools/workforce-pool-id/providers/workforce-pool-provider")
                .build())
            .uiSettings(WidgetConfigUiSettingsArgs.builder()
                .interactionType("SEARCH_WITH_ANSWER")
                .enableAutocomplete(true)
                .enableQualityFeedback(true)
                .generativeAnswerConfig(WidgetConfigUiSettingsGenerativeAnswerConfigArgs.builder()
                    .resultCount(5)
                    .build())
                .build())
            .build());

    }
}

    resources:
  basic:
    type: gcp:discoveryengine:DataStore
    properties:
      location: global
      dataStoreId: data-store-id
      displayName: tf-test-datastore
      industryVertical: GENERIC
      contentConfig: NO_CONTENT
      solutionTypes:
        - SOLUTION_TYPE_SEARCH
      createAdvancedSiteSearch: false
  basicSearchEngine:
    type: gcp:discoveryengine:SearchEngine
    name: basic
    properties:
      engineId: engine-id
      collectionId: default_collection
      location: ${basic.location}
      displayName: tf-test-engine
      dataStoreIds:
        - ${basic.dataStoreId}
      industryVertical: GENERIC
      appType: APP_TYPE_INTRANET
      searchEngineConfig: {}
  basicWidgetConfig:
    type: gcp:discoveryengine:WidgetConfig
    name: basic
    properties:
      location: ${basicSearchEngine.location}
      engineId: ${basicSearchEngine.engineId}
      accessSettings:
        enableWebApp: true
        workforceIdentityPoolProvider: locations/global/workforcePools/workforce-pool-id/providers/workforce-pool-provider
      uiSettings:
        interactionType: SEARCH_WITH_ANSWER
        enableAutocomplete: true
        enableQualityFeedback: true
        generativeAnswerConfig:
          resultCount: 5

    Create WidgetConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WidgetConfig(name: string, args: WidgetConfigArgs, opts?: CustomResourceOptions);
    @overload
def WidgetConfig(resource_name: str,
                 args: WidgetConfigArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def WidgetConfig(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 engine_id: Optional[str] = None,
                 location: Optional[str] = None,
                 access_settings: Optional[WidgetConfigAccessSettingsArgs] = None,
                 collection_id: Optional[str] = None,
                 homepage_setting: Optional[WidgetConfigHomepageSettingArgs] = None,
                 project: Optional[str] = None,
                 ui_branding: Optional[WidgetConfigUiBrandingArgs] = None,
                 ui_settings: Optional[WidgetConfigUiSettingsArgs] = None,
                 widget_config_id: Optional[str] = None)
    func NewWidgetConfig(ctx *Context, name string, args WidgetConfigArgs, opts ...ResourceOption) (*WidgetConfig, error)
    public WidgetConfig(string name, WidgetConfigArgs args, CustomResourceOptions? opts = null)
    public WidgetConfig(String name, WidgetConfigArgs args)
public WidgetConfig(String name, WidgetConfigArgs args, CustomResourceOptions options)

    type: gcp:discoveryengine:WidgetConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WidgetConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WidgetConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WidgetConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WidgetConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WidgetConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var widgetConfigResource = new Gcp.DiscoveryEngine.WidgetConfig("widgetConfigResource", new()
{
    EngineId = "string",
    Location = "string",
    AccessSettings = new Gcp.DiscoveryEngine.Inputs.WidgetConfigAccessSettingsArgs
    {
        AllowPublicAccess = false,
        AllowlistedDomains = new[]
        {
            "string",
        },
        EnableWebApp = false,
        LanguageCode = "string",
        WorkforceIdentityPoolProvider = "string",
    },
    CollectionId = "string",
    HomepageSetting = new Gcp.DiscoveryEngine.Inputs.WidgetConfigHomepageSettingArgs
    {
        Shortcuts = new[]
        {
            new Gcp.DiscoveryEngine.Inputs.WidgetConfigHomepageSettingShortcutArgs
            {
                DestinationUri = "string",
                Icon = new Gcp.DiscoveryEngine.Inputs.WidgetConfigHomepageSettingShortcutIconArgs
                {
                    Url = "string",
                },
                Title = "string",
            },
        },
    },
    Project = "string",
    UiBranding = new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiBrandingArgs
    {
        Logo = new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiBrandingLogoArgs
        {
            Url = "string",
        },
    },
    UiSettings = new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiSettingsArgs
    {
        DataStoreUiConfigs = new[]
        {
            new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiSettingsDataStoreUiConfigArgs
            {
                FacetFields = new[]
                {
                    new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiSettingsDataStoreUiConfigFacetFieldArgs
                    {
                        Field = "string",
                        DisplayName = "string",
                    },
                },
                FieldsUiComponentsMaps = new[]
                {
                    new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMapArgs
                    {
                        Field = "string",
                        UiComponent = "string",
                        DeviceVisibilities = new[]
                        {
                            "string",
                        },
                        DisplayTemplate = "string",
                    },
                },
                Name = "string",
            },
        },
        DefaultSearchRequestOrderBy = "string",
        DisableUserEventsCollection = false,
        EnableAutocomplete = false,
        EnableCreateAgentButton = false,
        EnablePeopleSearch = false,
        EnableQualityFeedback = false,
        EnableSafeSearch = false,
        EnableSearchAsYouType = false,
        EnableVisualContentSummary = false,
        GenerativeAnswerConfig = new Gcp.DiscoveryEngine.Inputs.WidgetConfigUiSettingsGenerativeAnswerConfigArgs
        {
            DisableRelatedQuestions = false,
            IgnoreAdversarialQuery = false,
            IgnoreLowRelevantContent = false,
            IgnoreNonAnswerSeekingQuery = false,
            ImageSource = "string",
            LanguageCode = "string",
            MaxRephraseSteps = 0,
            ModelPromptPreamble = "string",
            ModelVersion = "string",
            ResultCount = 0,
        },
        InteractionType = "string",
        ResultDescriptionType = "string",
    },
    WidgetConfigId = "string",
});

    example, err := discoveryengine.NewWidgetConfig(ctx, "widgetConfigResource", &discoveryengine.WidgetConfigArgs{
	EngineId: pulumi.String("string"),
	Location: pulumi.String("string"),
	AccessSettings: &discoveryengine.WidgetConfigAccessSettingsArgs{
		AllowPublicAccess: pulumi.Bool(false),
		AllowlistedDomains: pulumi.StringArray{
			pulumi.String("string"),
		},
		EnableWebApp:                  pulumi.Bool(false),
		LanguageCode:                  pulumi.String("string"),
		WorkforceIdentityPoolProvider: pulumi.String("string"),
	},
	CollectionId: pulumi.String("string"),
	HomepageSetting: &discoveryengine.WidgetConfigHomepageSettingArgs{
		Shortcuts: discoveryengine.WidgetConfigHomepageSettingShortcutArray{
			&discoveryengine.WidgetConfigHomepageSettingShortcutArgs{
				DestinationUri: pulumi.String("string"),
				Icon: &discoveryengine.WidgetConfigHomepageSettingShortcutIconArgs{
					Url: pulumi.String("string"),
				},
				Title: pulumi.String("string"),
			},
		},
	},
	Project: pulumi.String("string"),
	UiBranding: &discoveryengine.WidgetConfigUiBrandingArgs{
		Logo: &discoveryengine.WidgetConfigUiBrandingLogoArgs{
			Url: pulumi.String("string"),
		},
	},
	UiSettings: &discoveryengine.WidgetConfigUiSettingsArgs{
		DataStoreUiConfigs: discoveryengine.WidgetConfigUiSettingsDataStoreUiConfigArray{
			&discoveryengine.WidgetConfigUiSettingsDataStoreUiConfigArgs{
				FacetFields: discoveryengine.WidgetConfigUiSettingsDataStoreUiConfigFacetFieldArray{
					&discoveryengine.WidgetConfigUiSettingsDataStoreUiConfigFacetFieldArgs{
						Field:       pulumi.String("string"),
						DisplayName: pulumi.String("string"),
					},
				},
				FieldsUiComponentsMaps: discoveryengine.WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMapArray{
					&discoveryengine.WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMapArgs{
						Field:       pulumi.String("string"),
						UiComponent: pulumi.String("string"),
						DeviceVisibilities: pulumi.StringArray{
							pulumi.String("string"),
						},
						DisplayTemplate: pulumi.String("string"),
					},
				},
				Name: pulumi.String("string"),
			},
		},
		DefaultSearchRequestOrderBy: pulumi.String("string"),
		DisableUserEventsCollection: pulumi.Bool(false),
		EnableAutocomplete:          pulumi.Bool(false),
		EnableCreateAgentButton:     pulumi.Bool(false),
		EnablePeopleSearch:          pulumi.Bool(false),
		EnableQualityFeedback:       pulumi.Bool(false),
		EnableSafeSearch:            pulumi.Bool(false),
		EnableSearchAsYouType:       pulumi.Bool(false),
		EnableVisualContentSummary:  pulumi.Bool(false),
		GenerativeAnswerConfig: &discoveryengine.WidgetConfigUiSettingsGenerativeAnswerConfigArgs{
			DisableRelatedQuestions:     pulumi.Bool(false),
			IgnoreAdversarialQuery:      pulumi.Bool(false),
			IgnoreLowRelevantContent:    pulumi.Bool(false),
			IgnoreNonAnswerSeekingQuery: pulumi.Bool(false),
			ImageSource:                 pulumi.String("string"),
			LanguageCode:                pulumi.String("string"),
			MaxRephraseSteps:            pulumi.Int(0),
			ModelPromptPreamble:         pulumi.String("string"),
			ModelVersion:                pulumi.String("string"),
			ResultCount:                 pulumi.Int(0),
		},
		InteractionType:       pulumi.String("string"),
		ResultDescriptionType: pulumi.String("string"),
	},
	WidgetConfigId: pulumi.String("string"),
})

    var widgetConfigResource = new WidgetConfig("widgetConfigResource", WidgetConfigArgs.builder()
    .engineId("string")
    .location("string")
    .accessSettings(WidgetConfigAccessSettingsArgs.builder()
        .allowPublicAccess(false)
        .allowlistedDomains("string")
        .enableWebApp(false)
        .languageCode("string")
        .workforceIdentityPoolProvider("string")
        .build())
    .collectionId("string")
    .homepageSetting(WidgetConfigHomepageSettingArgs.builder()
        .shortcuts(WidgetConfigHomepageSettingShortcutArgs.builder()
            .destinationUri("string")
            .icon(WidgetConfigHomepageSettingShortcutIconArgs.builder()
                .url("string")
                .build())
            .title("string")
            .build())
        .build())
    .project("string")
    .uiBranding(WidgetConfigUiBrandingArgs.builder()
        .logo(WidgetConfigUiBrandingLogoArgs.builder()
            .url("string")
            .build())
        .build())
    .uiSettings(WidgetConfigUiSettingsArgs.builder()
        .dataStoreUiConfigs(WidgetConfigUiSettingsDataStoreUiConfigArgs.builder()
            .facetFields(WidgetConfigUiSettingsDataStoreUiConfigFacetFieldArgs.builder()
                .field("string")
                .displayName("string")
                .build())
            .fieldsUiComponentsMaps(WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMapArgs.builder()
                .field("string")
                .uiComponent("string")
                .deviceVisibilities("string")
                .displayTemplate("string")
                .build())
            .name("string")
            .build())
        .defaultSearchRequestOrderBy("string")
        .disableUserEventsCollection(false)
        .enableAutocomplete(false)
        .enableCreateAgentButton(false)
        .enablePeopleSearch(false)
        .enableQualityFeedback(false)
        .enableSafeSearch(false)
        .enableSearchAsYouType(false)
        .enableVisualContentSummary(false)
        .generativeAnswerConfig(WidgetConfigUiSettingsGenerativeAnswerConfigArgs.builder()
            .disableRelatedQuestions(false)
            .ignoreAdversarialQuery(false)
            .ignoreLowRelevantContent(false)
            .ignoreNonAnswerSeekingQuery(false)
            .imageSource("string")
            .languageCode("string")
            .maxRephraseSteps(0)
            .modelPromptPreamble("string")
            .modelVersion("string")
            .resultCount(0)
            .build())
        .interactionType("string")
        .resultDescriptionType("string")
        .build())
    .widgetConfigId("string")
    .build());

    widget_config_resource = gcp.discoveryengine.WidgetConfig("widgetConfigResource",
    engine_id="string",
    location="string",
    access_settings={
        "allow_public_access": False,
        "allowlisted_domains": ["string"],
        "enable_web_app": False,
        "language_code": "string",
        "workforce_identity_pool_provider": "string",
    },
    collection_id="string",
    homepage_setting={
        "shortcuts": [{
            "destination_uri": "string",
            "icon": {
                "url": "string",
            },
            "title": "string",
        }],
    },
    project="string",
    ui_branding={
        "logo": {
            "url": "string",
        },
    },
    ui_settings={
        "data_store_ui_configs": [{
            "facet_fields": [{
                "field": "string",
                "display_name": "string",
            }],
            "fields_ui_components_maps": [{
                "field": "string",
                "ui_component": "string",
                "device_visibilities": ["string"],
                "display_template": "string",
            }],
            "name": "string",
        }],
        "default_search_request_order_by": "string",
        "disable_user_events_collection": False,
        "enable_autocomplete": False,
        "enable_create_agent_button": False,
        "enable_people_search": False,
        "enable_quality_feedback": False,
        "enable_safe_search": False,
        "enable_search_as_you_type": False,
        "enable_visual_content_summary": False,
        "generative_answer_config": {
            "disable_related_questions": False,
            "ignore_adversarial_query": False,
            "ignore_low_relevant_content": False,
            "ignore_non_answer_seeking_query": False,
            "image_source": "string",
            "language_code": "string",
            "max_rephrase_steps": 0,
            "model_prompt_preamble": "string",
            "model_version": "string",
            "result_count": 0,
        },
        "interaction_type": "string",
        "result_description_type": "string",
    },
    widget_config_id="string")

    const widgetConfigResource = new gcp.discoveryengine.WidgetConfig("widgetConfigResource", {
    engineId: "string",
    location: "string",
    accessSettings: {
        allowPublicAccess: false,
        allowlistedDomains: ["string"],
        enableWebApp: false,
        languageCode: "string",
        workforceIdentityPoolProvider: "string",
    },
    collectionId: "string",
    homepageSetting: {
        shortcuts: [{
            destinationUri: "string",
            icon: {
                url: "string",
            },
            title: "string",
        }],
    },
    project: "string",
    uiBranding: {
        logo: {
            url: "string",
        },
    },
    uiSettings: {
        dataStoreUiConfigs: [{
            facetFields: [{
                field: "string",
                displayName: "string",
            }],
            fieldsUiComponentsMaps: [{
                field: "string",
                uiComponent: "string",
                deviceVisibilities: ["string"],
                displayTemplate: "string",
            }],
            name: "string",
        }],
        defaultSearchRequestOrderBy: "string",
        disableUserEventsCollection: false,
        enableAutocomplete: false,
        enableCreateAgentButton: false,
        enablePeopleSearch: false,
        enableQualityFeedback: false,
        enableSafeSearch: false,
        enableSearchAsYouType: false,
        enableVisualContentSummary: false,
        generativeAnswerConfig: {
            disableRelatedQuestions: false,
            ignoreAdversarialQuery: false,
            ignoreLowRelevantContent: false,
            ignoreNonAnswerSeekingQuery: false,
            imageSource: "string",
            languageCode: "string",
            maxRephraseSteps: 0,
            modelPromptPreamble: "string",
            modelVersion: "string",
            resultCount: 0,
        },
        interactionType: "string",
        resultDescriptionType: "string",
    },
    widgetConfigId: "string",
});

    type: gcp:discoveryengine:WidgetConfig
properties:
    accessSettings:
        allowPublicAccess: false
        allowlistedDomains:
            - string
        enableWebApp: false
        languageCode: string
        workforceIdentityPoolProvider: string
    collectionId: string
    engineId: string
    homepageSetting:
        shortcuts:
            - destinationUri: string
              icon:
                url: string
              title: string
    location: string
    project: string
    uiBranding:
        logo:
            url: string
    uiSettings:
        dataStoreUiConfigs:
            - facetFields:
                - displayName: string
                  field: string
              fieldsUiComponentsMaps:
                - deviceVisibilities:
                    - string
                  displayTemplate: string
                  field: string
                  uiComponent: string
              name: string
        defaultSearchRequestOrderBy: string
        disableUserEventsCollection: false
        enableAutocomplete: false
        enableCreateAgentButton: false
        enablePeopleSearch: false
        enableQualityFeedback: false
        enableSafeSearch: false
        enableSearchAsYouType: false
        enableVisualContentSummary: false
        generativeAnswerConfig:
            disableRelatedQuestions: false
            ignoreAdversarialQuery: false
            ignoreLowRelevantContent: false
            ignoreNonAnswerSeekingQuery: false
            imageSource: string
            languageCode: string
            maxRephraseSteps: 0
            modelPromptPreamble: string
            modelVersion: string
            resultCount: 0
        interactionType: string
        resultDescriptionType: string
    widgetConfigId: string

    WidgetConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WidgetConfig resource accepts the following input properties:

    EngineId string
    The engine ID.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    AccessSettings WidgetConfigAccessSettings
    Describes widget access settings. Structure is documented below.
    CollectionId string
    The collection ID.
    HomepageSetting WidgetConfigHomepageSetting
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UiBranding WidgetConfigUiBranding
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    UiSettings WidgetConfigUiSettings
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    WidgetConfigId string
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    EngineId string
    The engine ID.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    AccessSettings WidgetConfigAccessSettingsArgs
    Describes widget access settings. Structure is documented below.
    CollectionId string
    The collection ID.
    HomepageSetting WidgetConfigHomepageSettingArgs
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UiBranding WidgetConfigUiBrandingArgs
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    UiSettings WidgetConfigUiSettingsArgs
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    WidgetConfigId string
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    engineId String
    The engine ID.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    accessSettings WidgetConfigAccessSettings
    Describes widget access settings. Structure is documented below.
    collectionId String
    The collection ID.
    homepageSetting WidgetConfigHomepageSetting
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    uiBranding WidgetConfigUiBranding
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    uiSettings WidgetConfigUiSettings
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widgetConfigId String
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    engineId string
    The engine ID.
    location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    accessSettings WidgetConfigAccessSettings
    Describes widget access settings. Structure is documented below.
    collectionId string
    The collection ID.
    homepageSetting WidgetConfigHomepageSetting
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    uiBranding WidgetConfigUiBranding
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    uiSettings WidgetConfigUiSettings
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widgetConfigId string
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    engine_id str
    The engine ID.
    location str
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    access_settings WidgetConfigAccessSettingsArgs
    Describes widget access settings. Structure is documented below.
    collection_id str
    The collection ID.
    homepage_setting WidgetConfigHomepageSettingArgs
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ui_branding WidgetConfigUiBrandingArgs
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    ui_settings WidgetConfigUiSettingsArgs
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widget_config_id str
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    engineId String
    The engine ID.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    accessSettings Property Map
    Describes widget access settings. Structure is documented below.
    collectionId String
    The collection ID.
    homepageSetting Property Map
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    uiBranding Property Map
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    uiSettings Property Map
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widgetConfigId String
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WidgetConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.

    Look up Existing WidgetConfig Resource

    Get an existing WidgetConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WidgetConfigState, opts?: CustomResourceOptions): WidgetConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_settings: Optional[WidgetConfigAccessSettingsArgs] = None,
        collection_id: Optional[str] = None,
        engine_id: Optional[str] = None,
        homepage_setting: Optional[WidgetConfigHomepageSettingArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        ui_branding: Optional[WidgetConfigUiBrandingArgs] = None,
        ui_settings: Optional[WidgetConfigUiSettingsArgs] = None,
        widget_config_id: Optional[str] = None) -> WidgetConfig
    func GetWidgetConfig(ctx *Context, name string, id IDInput, state *WidgetConfigState, opts ...ResourceOption) (*WidgetConfig, error)
    public static WidgetConfig Get(string name, Input<string> id, WidgetConfigState? state, CustomResourceOptions? opts = null)
    public static WidgetConfig get(String name, Output<String> id, WidgetConfigState state, CustomResourceOptions options)
    resources:  _:    type: gcp:discoveryengine:WidgetConfig    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessSettings WidgetConfigAccessSettings
    Describes widget access settings. Structure is documented below.
    CollectionId string
    The collection ID.
    EngineId string
    The engine ID.
    HomepageSetting WidgetConfigHomepageSetting
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    Name string
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UiBranding WidgetConfigUiBranding
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    UiSettings WidgetConfigUiSettings
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    WidgetConfigId string
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    AccessSettings WidgetConfigAccessSettingsArgs
    Describes widget access settings. Structure is documented below.
    CollectionId string
    The collection ID.
    EngineId string
    The engine ID.
    HomepageSetting WidgetConfigHomepageSettingArgs
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    Name string
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UiBranding WidgetConfigUiBrandingArgs
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    UiSettings WidgetConfigUiSettingsArgs
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    WidgetConfigId string
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    accessSettings WidgetConfigAccessSettings
    Describes widget access settings. Structure is documented below.
    collectionId String
    The collection ID.
    engineId String
    The engine ID.
    homepageSetting WidgetConfigHomepageSetting
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name String
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    uiBranding WidgetConfigUiBranding
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    uiSettings WidgetConfigUiSettings
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widgetConfigId String
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    accessSettings WidgetConfigAccessSettings
    Describes widget access settings. Structure is documented below.
    collectionId string
    The collection ID.
    engineId string
    The engine ID.
    homepageSetting WidgetConfigHomepageSetting
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name string
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    uiBranding WidgetConfigUiBranding
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    uiSettings WidgetConfigUiSettings
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widgetConfigId string
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    access_settings WidgetConfigAccessSettingsArgs
    Describes widget access settings. Structure is documented below.
    collection_id str
    The collection ID.
    engine_id str
    The engine ID.
    homepage_setting WidgetConfigHomepageSettingArgs
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    location str
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name str
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ui_branding WidgetConfigUiBrandingArgs
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    ui_settings WidgetConfigUiSettingsArgs
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widget_config_id str
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".
    accessSettings Property Map
    Describes widget access settings. Structure is documented below.
    collectionId String
    The collection ID.
    engineId String
    The engine ID.
    homepageSetting Property Map
    Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. Structure is documented below.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name String
    The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/widgetConfigs/{widget_config_id}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    uiBranding Property Map
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. Structure is documented below.
    uiSettings Property Map
    Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. Structure is documented below.
    widgetConfigId String
    The unique ID to use for the WidgetConfig. Currently only accepts <span pulumi-lang-nodejs=""defaultSearchWidgetConfig"" pulumi-lang-dotnet=""DefaultSearchWidgetConfig"" pulumi-lang-go=""defaultSearchWidgetConfig"" pulumi-lang-python=""default_search_widget_config"" pulumi-lang-yaml=""defaultSearchWidgetConfig"" pulumi-lang-java=""defaultSearchWidgetConfig"">"default_search_widget_config".

    Supporting Types

    WidgetConfigAccessSettings, WidgetConfigAccessSettingsArgs

    AllowPublicAccess bool
    Whether public unauthenticated access is allowed.
    AllowlistedDomains List<string>
    List of domains that are allowed to integrate the search widget.
    EnableWebApp bool
    Whether web app access is enabled.
    LanguageCode string
    Language code for user interface. Use language tags defined by BCP47. If unset, the default language code is "en-US".
    WorkforceIdentityPoolProvider string
    The workforce identity pool provider used to access the widget.
    AllowPublicAccess bool
    Whether public unauthenticated access is allowed.
    AllowlistedDomains []string
    List of domains that are allowed to integrate the search widget.
    EnableWebApp bool
    Whether web app access is enabled.
    LanguageCode string
    Language code for user interface. Use language tags defined by BCP47. If unset, the default language code is "en-US".
    WorkforceIdentityPoolProvider string
    The workforce identity pool provider used to access the widget.
    allowPublicAccess Boolean
    Whether public unauthenticated access is allowed.
    allowlistedDomains List<String>
    List of domains that are allowed to integrate the search widget.
    enableWebApp Boolean
    Whether web app access is enabled.
    languageCode String
    Language code for user interface. Use language tags defined by BCP47. If unset, the default language code is "en-US".
    workforceIdentityPoolProvider String
    The workforce identity pool provider used to access the widget.
    allowPublicAccess boolean
    Whether public unauthenticated access is allowed.
    allowlistedDomains string[]
    List of domains that are allowed to integrate the search widget.
    enableWebApp boolean
    Whether web app access is enabled.
    languageCode string
    Language code for user interface. Use language tags defined by BCP47. If unset, the default language code is "en-US".
    workforceIdentityPoolProvider string
    The workforce identity pool provider used to access the widget.
    allow_public_access bool
    Whether public unauthenticated access is allowed.
    allowlisted_domains Sequence[str]
    List of domains that are allowed to integrate the search widget.
    enable_web_app bool
    Whether web app access is enabled.
    language_code str
    Language code for user interface. Use language tags defined by BCP47. If unset, the default language code is "en-US".
    workforce_identity_pool_provider str
    The workforce identity pool provider used to access the widget.
    allowPublicAccess Boolean
    Whether public unauthenticated access is allowed.
    allowlistedDomains List<String>
    List of domains that are allowed to integrate the search widget.
    enableWebApp Boolean
    Whether web app access is enabled.
    languageCode String
    Language code for user interface. Use language tags defined by BCP47. If unset, the default language code is "en-US".
    workforceIdentityPoolProvider String
    The workforce identity pool provider used to access the widget.

    WidgetConfigHomepageSetting, WidgetConfigHomepageSettingArgs

    Shortcuts List<WidgetConfigHomepageSettingShortcut>
    The shortcuts to display on the homepage. Structure is documented below.
    Shortcuts []WidgetConfigHomepageSettingShortcut
    The shortcuts to display on the homepage. Structure is documented below.
    shortcuts List<WidgetConfigHomepageSettingShortcut>
    The shortcuts to display on the homepage. Structure is documented below.
    shortcuts WidgetConfigHomepageSettingShortcut[]
    The shortcuts to display on the homepage. Structure is documented below.
    shortcuts Sequence[WidgetConfigHomepageSettingShortcut]
    The shortcuts to display on the homepage. Structure is documented below.
    shortcuts List<Property Map>
    The shortcuts to display on the homepage. Structure is documented below.

    WidgetConfigHomepageSettingShortcut, WidgetConfigHomepageSettingShortcutArgs

    DestinationUri string
    Destination URL of shortcut.
    Icon WidgetConfigHomepageSettingShortcutIcon
    Icon URL of shortcut. Structure is documented below.
    Title string
    Title of the shortcut.
    DestinationUri string
    Destination URL of shortcut.
    Icon WidgetConfigHomepageSettingShortcutIcon
    Icon URL of shortcut. Structure is documented below.
    Title string
    Title of the shortcut.
    destinationUri String
    Destination URL of shortcut.
    icon WidgetConfigHomepageSettingShortcutIcon
    Icon URL of shortcut. Structure is documented below.
    title String
    Title of the shortcut.
    destinationUri string
    Destination URL of shortcut.
    icon WidgetConfigHomepageSettingShortcutIcon
    Icon URL of shortcut. Structure is documented below.
    title string
    Title of the shortcut.
    destination_uri str
    Destination URL of shortcut.
    icon WidgetConfigHomepageSettingShortcutIcon
    Icon URL of shortcut. Structure is documented below.
    title str
    Title of the shortcut.
    destinationUri String
    Destination URL of shortcut.
    icon Property Map
    Icon URL of shortcut. Structure is documented below.
    title String
    Title of the shortcut.

    WidgetConfigHomepageSettingShortcutIcon, WidgetConfigHomepageSettingShortcutIconArgs

    Url string
    Image URL.
    Url string
    Image URL.
    url String
    Image URL.
    url string
    Image URL.
    url str
    Image URL.
    url String
    Image URL.

    WidgetConfigUiBranding, WidgetConfigUiBrandingArgs

    Logo WidgetConfigUiBrandingLogo
    Logo image. Structure is documented below.
    Logo WidgetConfigUiBrandingLogo
    Logo image. Structure is documented below.
    logo WidgetConfigUiBrandingLogo
    Logo image. Structure is documented below.
    logo WidgetConfigUiBrandingLogo
    Logo image. Structure is documented below.
    logo WidgetConfigUiBrandingLogo
    Logo image. Structure is documented below.
    logo Property Map
    Logo image. Structure is documented below.
    Url string
    Image URL.
    Url string
    Image URL.
    url String
    Image URL.
    url string
    Image URL.
    url str
    Image URL.
    url String
    Image URL.

    WidgetConfigUiSettings, WidgetConfigUiSettingsArgs

    DataStoreUiConfigs List<WidgetConfigUiSettingsDataStoreUiConfig>
    Per data store configuration. Structure is documented below.
    DefaultSearchRequestOrderBy string
    The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests.
    DisableUserEventsCollection bool
    If set to true, the widget will not collect user events.
    EnableAutocomplete bool
    Whether or not to enable autocomplete.
    EnableCreateAgentButton bool
    If set to true, the widget will enable the create agent button.
    EnablePeopleSearch bool
    If set to true, the widget will enable people search.
    EnableQualityFeedback bool
    Turn on or off collecting the search result quality feedback from end users.
    EnableSafeSearch bool
    Whether to enable safe search.
    EnableSearchAsYouType bool
    Whether to enable search-as-you-type behavior for the search widget.
    EnableVisualContentSummary bool
    If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
    GenerativeAnswerConfig WidgetConfigUiSettingsGenerativeAnswerConfig
    Describes generative answer configuration. Structure is documented below.
    InteractionType string
    Describes widget (or web app) interaction type Possible values are: SEARCH_ONLY, SEARCH_WITH_ANSWER, SEARCH_WITH_FOLLOW_UPS.
    ResultDescriptionType string
    Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. Possible values are: SNIPPET, EXTRACTIVE_ANSWER.
    DataStoreUiConfigs []WidgetConfigUiSettingsDataStoreUiConfig
    Per data store configuration. Structure is documented below.
    DefaultSearchRequestOrderBy string
    The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests.
    DisableUserEventsCollection bool
    If set to true, the widget will not collect user events.
    EnableAutocomplete bool
    Whether or not to enable autocomplete.
    EnableCreateAgentButton bool
    If set to true, the widget will enable the create agent button.
    EnablePeopleSearch bool
    If set to true, the widget will enable people search.
    EnableQualityFeedback bool
    Turn on or off collecting the search result quality feedback from end users.
    EnableSafeSearch bool
    Whether to enable safe search.
    EnableSearchAsYouType bool
    Whether to enable search-as-you-type behavior for the search widget.
    EnableVisualContentSummary bool
    If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
    GenerativeAnswerConfig WidgetConfigUiSettingsGenerativeAnswerConfig
    Describes generative answer configuration. Structure is documented below.
    InteractionType string
    Describes widget (or web app) interaction type Possible values are: SEARCH_ONLY, SEARCH_WITH_ANSWER, SEARCH_WITH_FOLLOW_UPS.
    ResultDescriptionType string
    Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. Possible values are: SNIPPET, EXTRACTIVE_ANSWER.
    dataStoreUiConfigs List<WidgetConfigUiSettingsDataStoreUiConfig>
    Per data store configuration. Structure is documented below.
    defaultSearchRequestOrderBy String
    The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests.
    disableUserEventsCollection Boolean
    If set to true, the widget will not collect user events.
    enableAutocomplete Boolean
    Whether or not to enable autocomplete.
    enableCreateAgentButton Boolean
    If set to true, the widget will enable the create agent button.
    enablePeopleSearch Boolean
    If set to true, the widget will enable people search.
    enableQualityFeedback Boolean
    Turn on or off collecting the search result quality feedback from end users.
    enableSafeSearch Boolean
    Whether to enable safe search.
    enableSearchAsYouType Boolean
    Whether to enable search-as-you-type behavior for the search widget.
    enableVisualContentSummary Boolean
    If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
    generativeAnswerConfig WidgetConfigUiSettingsGenerativeAnswerConfig
    Describes generative answer configuration. Structure is documented below.
    interactionType String
    Describes widget (or web app) interaction type Possible values are: SEARCH_ONLY, SEARCH_WITH_ANSWER, SEARCH_WITH_FOLLOW_UPS.
    resultDescriptionType String
    Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. Possible values are: SNIPPET, EXTRACTIVE_ANSWER.
    dataStoreUiConfigs WidgetConfigUiSettingsDataStoreUiConfig[]
    Per data store configuration. Structure is documented below.
    defaultSearchRequestOrderBy string
    The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests.
    disableUserEventsCollection boolean
    If set to true, the widget will not collect user events.
    enableAutocomplete boolean
    Whether or not to enable autocomplete.
    enableCreateAgentButton boolean
    If set to true, the widget will enable the create agent button.
    enablePeopleSearch boolean
    If set to true, the widget will enable people search.
    enableQualityFeedback boolean
    Turn on or off collecting the search result quality feedback from end users.
    enableSafeSearch boolean
    Whether to enable safe search.
    enableSearchAsYouType boolean
    Whether to enable search-as-you-type behavior for the search widget.
    enableVisualContentSummary boolean
    If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
    generativeAnswerConfig WidgetConfigUiSettingsGenerativeAnswerConfig
    Describes generative answer configuration. Structure is documented below.
    interactionType string
    Describes widget (or web app) interaction type Possible values are: SEARCH_ONLY, SEARCH_WITH_ANSWER, SEARCH_WITH_FOLLOW_UPS.
    resultDescriptionType string
    Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. Possible values are: SNIPPET, EXTRACTIVE_ANSWER.
    data_store_ui_configs Sequence[WidgetConfigUiSettingsDataStoreUiConfig]
    Per data store configuration. Structure is documented below.
    default_search_request_order_by str
    The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests.
    disable_user_events_collection bool
    If set to true, the widget will not collect user events.
    enable_autocomplete bool
    Whether or not to enable autocomplete.
    enable_create_agent_button bool
    If set to true, the widget will enable the create agent button.
    enable_people_search bool
    If set to true, the widget will enable people search.
    enable_quality_feedback bool
    Turn on or off collecting the search result quality feedback from end users.
    enable_safe_search bool
    Whether to enable safe search.
    enable_search_as_you_type bool
    Whether to enable search-as-you-type behavior for the search widget.
    enable_visual_content_summary bool
    If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
    generative_answer_config WidgetConfigUiSettingsGenerativeAnswerConfig
    Describes generative answer configuration. Structure is documented below.
    interaction_type str
    Describes widget (or web app) interaction type Possible values are: SEARCH_ONLY, SEARCH_WITH_ANSWER, SEARCH_WITH_FOLLOW_UPS.
    result_description_type str
    Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. Possible values are: SNIPPET, EXTRACTIVE_ANSWER.
    dataStoreUiConfigs List<Property Map>
    Per data store configuration. Structure is documented below.
    defaultSearchRequestOrderBy String
    The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests.
    disableUserEventsCollection Boolean
    If set to true, the widget will not collect user events.
    enableAutocomplete Boolean
    Whether or not to enable autocomplete.
    enableCreateAgentButton Boolean
    If set to true, the widget will enable the create agent button.
    enablePeopleSearch Boolean
    If set to true, the widget will enable people search.
    enableQualityFeedback Boolean
    Turn on or off collecting the search result quality feedback from end users.
    enableSafeSearch Boolean
    Whether to enable safe search.
    enableSearchAsYouType Boolean
    Whether to enable search-as-you-type behavior for the search widget.
    enableVisualContentSummary Boolean
    If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
    generativeAnswerConfig Property Map
    Describes generative answer configuration. Structure is documented below.
    interactionType String
    Describes widget (or web app) interaction type Possible values are: SEARCH_ONLY, SEARCH_WITH_ANSWER, SEARCH_WITH_FOLLOW_UPS.
    resultDescriptionType String
    Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. Possible values are: SNIPPET, EXTRACTIVE_ANSWER.

    WidgetConfigUiSettingsDataStoreUiConfig, WidgetConfigUiSettingsDataStoreUiConfigArgs

    FacetFields List<WidgetConfigUiSettingsDataStoreUiConfigFacetField>
    Structure is documented below.
    FieldsUiComponentsMaps List<WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMap>
    'The key is the UI component. 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. Structure is documented below.
    Name string
    The name of the data store. It should be data store resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
    FacetFields []WidgetConfigUiSettingsDataStoreUiConfigFacetField
    Structure is documented below.
    FieldsUiComponentsMaps []WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMap
    'The key is the UI component. 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. Structure is documented below.
    Name string
    The name of the data store. It should be data store resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
    facetFields List<WidgetConfigUiSettingsDataStoreUiConfigFacetField>
    Structure is documented below.
    fieldsUiComponentsMaps List<WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMap>
    'The key is the UI component. 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. Structure is documented below.
    name String
    The name of the data store. It should be data store resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
    facetFields WidgetConfigUiSettingsDataStoreUiConfigFacetField[]
    Structure is documented below.
    fieldsUiComponentsMaps WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMap[]
    'The key is the UI component. 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. Structure is documented below.
    name string
    The name of the data store. It should be data store resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
    facet_fields Sequence[WidgetConfigUiSettingsDataStoreUiConfigFacetField]
    Structure is documented below.
    fields_ui_components_maps Sequence[WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMap]
    'The key is the UI component. 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. Structure is documented below.
    name str
    The name of the data store. It should be data store resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
    facetFields List<Property Map>
    Structure is documented below.
    fieldsUiComponentsMaps List<Property Map>
    'The key is the UI component. 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. Structure is documented below.
    name String
    The name of the data store. It should be data store resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.

    WidgetConfigUiSettingsDataStoreUiConfigFacetField, WidgetConfigUiSettingsDataStoreUiConfigFacetFieldArgs

    Field string
    Registered field name. The format is field.abc.
    DisplayName string
    The field name that end users will see.
    Field string
    Registered field name. The format is field.abc.
    DisplayName string
    The field name that end users will see.
    field String
    Registered field name. The format is field.abc.
    displayName String
    The field name that end users will see.
    field string
    Registered field name. The format is field.abc.
    displayName string
    The field name that end users will see.
    field str
    Registered field name. The format is field.abc.
    display_name str
    The field name that end users will see.
    field String
    Registered field name. The format is field.abc.
    displayName String
    The field name that end users will see.

    WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMap, WidgetConfigUiSettingsDataStoreUiConfigFieldsUiComponentsMapArgs

    Field string
    Registered field name. The format is field.abc.
    UiComponent string
    The identifier for this object. Format specified above.
    DeviceVisibilities List<string>
    Each value may be one of: MOBILE, DESKTOP.
    DisplayTemplate string
    The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
    Field string
    Registered field name. The format is field.abc.
    UiComponent string
    The identifier for this object. Format specified above.
    DeviceVisibilities []string
    Each value may be one of: MOBILE, DESKTOP.
    DisplayTemplate string
    The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
    field String
    Registered field name. The format is field.abc.
    uiComponent String
    The identifier for this object. Format specified above.
    deviceVisibilities List<String>
    Each value may be one of: MOBILE, DESKTOP.
    displayTemplate String
    The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
    field string
    Registered field name. The format is field.abc.
    uiComponent string
    The identifier for this object. Format specified above.
    deviceVisibilities string[]
    Each value may be one of: MOBILE, DESKTOP.
    displayTemplate string
    The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
    field str
    Registered field name. The format is field.abc.
    ui_component str
    The identifier for this object. Format specified above.
    device_visibilities Sequence[str]
    Each value may be one of: MOBILE, DESKTOP.
    display_template str
    The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
    field String
    Registered field name. The format is field.abc.
    uiComponent String
    The identifier for this object. Format specified above.
    deviceVisibilities List<String>
    Each value may be one of: MOBILE, DESKTOP.
    displayTemplate String
    The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".

    WidgetConfigUiSettingsGenerativeAnswerConfig, WidgetConfigUiSettingsGenerativeAnswerConfigArgs

    DisableRelatedQuestions bool
    Whether generated answer contains suggested related questions.
    IgnoreAdversarialQuery bool
    Specifies whether to filter out queries that are adversarial.
    IgnoreLowRelevantContent bool
    Specifies whether to filter out queries that are not relevant to the content.
    IgnoreNonAnswerSeekingQuery bool
    Specifies whether to filter out queries that are not answer-seeking. The default value is false. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    ImageSource string
    Source of image returned in the answer. Possible values are: ALL_AVAILABLE_SOURCES, CORPUS_IMAGE_ONLY, FIGURE_GENERATION_ONLY.
    LanguageCode string
    Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
    MaxRephraseSteps int
    Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
    ModelPromptPreamble string
    Text at the beginning of the prompt that instructs the model that generates the answer.
    ModelVersion string
    The model version used to generate the answer.
    ResultCount int
    The number of top results to generate the answer from. Up to 10.
    DisableRelatedQuestions bool
    Whether generated answer contains suggested related questions.
    IgnoreAdversarialQuery bool
    Specifies whether to filter out queries that are adversarial.
    IgnoreLowRelevantContent bool
    Specifies whether to filter out queries that are not relevant to the content.
    IgnoreNonAnswerSeekingQuery bool
    Specifies whether to filter out queries that are not answer-seeking. The default value is false. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    ImageSource string
    Source of image returned in the answer. Possible values are: ALL_AVAILABLE_SOURCES, CORPUS_IMAGE_ONLY, FIGURE_GENERATION_ONLY.
    LanguageCode string
    Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
    MaxRephraseSteps int
    Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
    ModelPromptPreamble string
    Text at the beginning of the prompt that instructs the model that generates the answer.
    ModelVersion string
    The model version used to generate the answer.
    ResultCount int
    The number of top results to generate the answer from. Up to 10.
    disableRelatedQuestions Boolean
    Whether generated answer contains suggested related questions.
    ignoreAdversarialQuery Boolean
    Specifies whether to filter out queries that are adversarial.
    ignoreLowRelevantContent Boolean
    Specifies whether to filter out queries that are not relevant to the content.
    ignoreNonAnswerSeekingQuery Boolean
    Specifies whether to filter out queries that are not answer-seeking. The default value is false. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    imageSource String
    Source of image returned in the answer. Possible values are: ALL_AVAILABLE_SOURCES, CORPUS_IMAGE_ONLY, FIGURE_GENERATION_ONLY.
    languageCode String
    Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
    maxRephraseSteps Integer
    Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
    modelPromptPreamble String
    Text at the beginning of the prompt that instructs the model that generates the answer.
    modelVersion String
    The model version used to generate the answer.
    resultCount Integer
    The number of top results to generate the answer from. Up to 10.
    disableRelatedQuestions boolean
    Whether generated answer contains suggested related questions.
    ignoreAdversarialQuery boolean
    Specifies whether to filter out queries that are adversarial.
    ignoreLowRelevantContent boolean
    Specifies whether to filter out queries that are not relevant to the content.
    ignoreNonAnswerSeekingQuery boolean
    Specifies whether to filter out queries that are not answer-seeking. The default value is false. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    imageSource string
    Source of image returned in the answer. Possible values are: ALL_AVAILABLE_SOURCES, CORPUS_IMAGE_ONLY, FIGURE_GENERATION_ONLY.
    languageCode string
    Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
    maxRephraseSteps number
    Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
    modelPromptPreamble string
    Text at the beginning of the prompt that instructs the model that generates the answer.
    modelVersion string
    The model version used to generate the answer.
    resultCount number
    The number of top results to generate the answer from. Up to 10.
    disable_related_questions bool
    Whether generated answer contains suggested related questions.
    ignore_adversarial_query bool
    Specifies whether to filter out queries that are adversarial.
    ignore_low_relevant_content bool
    Specifies whether to filter out queries that are not relevant to the content.
    ignore_non_answer_seeking_query bool
    Specifies whether to filter out queries that are not answer-seeking. The default value is false. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    image_source str
    Source of image returned in the answer. Possible values are: ALL_AVAILABLE_SOURCES, CORPUS_IMAGE_ONLY, FIGURE_GENERATION_ONLY.
    language_code str
    Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
    max_rephrase_steps int
    Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
    model_prompt_preamble str
    Text at the beginning of the prompt that instructs the model that generates the answer.
    model_version str
    The model version used to generate the answer.
    result_count int
    The number of top results to generate the answer from. Up to 10.
    disableRelatedQuestions Boolean
    Whether generated answer contains suggested related questions.
    ignoreAdversarialQuery Boolean
    Specifies whether to filter out queries that are adversarial.
    ignoreLowRelevantContent Boolean
    Specifies whether to filter out queries that are not relevant to the content.
    ignoreNonAnswerSeekingQuery Boolean
    Specifies whether to filter out queries that are not answer-seeking. The default value is false. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    imageSource String
    Source of image returned in the answer. Possible values are: ALL_AVAILABLE_SOURCES, CORPUS_IMAGE_ONLY, FIGURE_GENERATION_ONLY.
    languageCode String
    Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
    maxRephraseSteps Number
    Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
    modelPromptPreamble String
    Text at the beginning of the prompt that instructs the model that generates the answer.
    modelVersion String
    The model version used to generate the answer.
    resultCount Number
    The number of top results to generate the answer from. Up to 10.

    Import

    WidgetConfig can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}/widgetConfigs/{{widget_config_id}}

    • {{project}}/{{location}}/{{collection_id}}/{{engine_id}}/{{widget_config_id}}

    • {{location}}/{{collection_id}}/{{engine_id}}/{{widget_config_id}}

    When using the pulumi import command, WidgetConfig can be imported using one of the formats above. For example:

    $ pulumi import gcp:discoveryengine/widgetConfig:WidgetConfig default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}/widgetConfigs/{{widget_config_id}}

    $ pulumi import gcp:discoveryengine/widgetConfig:WidgetConfig default {{project}}/{{location}}/{{collection_id}}/{{engine_id}}/{{widget_config_id}}

    $ pulumi import gcp:discoveryengine/widgetConfig:WidgetConfig default {{location}}/{{collection_id}}/{{engine_id}}/{{widget_config_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp
      Meet Neo: Your AI Platform Teammate