Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. CxGenerativeSettings
Google Cloud v8.39.0 published on Tuesday, Jul 22, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.diagflow.CxGenerativeSettings

Explore with Pulumi AI

gcp logo
Google Cloud v8.39.0 published on Tuesday, Jul 22, 2025 by Pulumi
pulumi/pulumi-gcp

    Settings for Generative AI.

    To get more information about GenerativeSettings, see:

    Example Usage

    Dialogflowcx Generative Settings Full

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

const agent = new gcp.diagflow.CxAgent("agent", {
    displayName: "dialogflowcx-agent",
    location: "global",
    defaultLanguageCode: "en",
    timeZone: "America/New_York",
    description: "Example description.",
});
const fullGenerativeSettings = new gcp.diagflow.CxGenerativeSettings("full_generative_settings", {
    parent: agent.id,
    fallbackSettings: {
        selectedPrompt: "example prompt",
        promptTemplates: [{
            displayName: "example prompt",
            promptText: "example prompt text",
            frozen: false,
        }],
    },
    generativeSafetySettings: {
        defaultBannedPhraseMatchStrategy: "PARTIAL_MATCH",
        bannedPhrases: [{
            text: "example text",
            languageCode: "en",
        }],
    },
    knowledgeConnectorSettings: {
        business: "example business",
        agent: "example agent",
        agentIdentity: "virtual agent",
        businessDescription: "a family company selling freshly roasted coffee beans",
        agentScope: "Example company website",
        disableDataStoreFallback: false,
    },
    languageCode: "en",
    llmModelSettings: {
        model: "gemini-2.0-flash-001",
        promptText: "example prompt text",
    },
});

    import pulumi
import pulumi_gcp as gcp

agent = gcp.diagflow.CxAgent("agent",
    display_name="dialogflowcx-agent",
    location="global",
    default_language_code="en",
    time_zone="America/New_York",
    description="Example description.")
full_generative_settings = gcp.diagflow.CxGenerativeSettings("full_generative_settings",
    parent=agent.id,
    fallback_settings={
        "selected_prompt": "example prompt",
        "prompt_templates": [{
            "display_name": "example prompt",
            "prompt_text": "example prompt text",
            "frozen": False,
        }],
    },
    generative_safety_settings={
        "default_banned_phrase_match_strategy": "PARTIAL_MATCH",
        "banned_phrases": [{
            "text": "example text",
            "language_code": "en",
        }],
    },
    knowledge_connector_settings={
        "business": "example business",
        "agent": "example agent",
        "agent_identity": "virtual agent",
        "business_description": "a family company selling freshly roasted coffee beans",
        "agent_scope": "Example company website",
        "disable_data_store_fallback": False,
    },
    language_code="en",
    llm_model_settings={
        "model": "gemini-2.0-flash-001",
        "prompt_text": "example prompt text",
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/diagflow"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		agent, err := diagflow.NewCxAgent(ctx, "agent", &diagflow.CxAgentArgs{
			DisplayName:         pulumi.String("dialogflowcx-agent"),
			Location:            pulumi.String("global"),
			DefaultLanguageCode: pulumi.String("en"),
			TimeZone:            pulumi.String("America/New_York"),
			Description:         pulumi.String("Example description."),
		})
		if err != nil {
			return err
		}
		_, err = diagflow.NewCxGenerativeSettings(ctx, "full_generative_settings", &diagflow.CxGenerativeSettingsArgs{
			Parent: agent.ID(),
			FallbackSettings: &diagflow.CxGenerativeSettingsFallbackSettingsArgs{
				SelectedPrompt: pulumi.String("example prompt"),
				PromptTemplates: diagflow.CxGenerativeSettingsFallbackSettingsPromptTemplateArray{
					&diagflow.CxGenerativeSettingsFallbackSettingsPromptTemplateArgs{
						DisplayName: pulumi.String("example prompt"),
						PromptText:  pulumi.String("example prompt text"),
						Frozen:      pulumi.Bool(false),
					},
				},
			},
			GenerativeSafetySettings: &diagflow.CxGenerativeSettingsGenerativeSafetySettingsArgs{
				DefaultBannedPhraseMatchStrategy: pulumi.String("PARTIAL_MATCH"),
				BannedPhrases: diagflow.CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArray{
					&diagflow.CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArgs{
						Text:         pulumi.String("example text"),
						LanguageCode: pulumi.String("en"),
					},
				},
			},
			KnowledgeConnectorSettings: &diagflow.CxGenerativeSettingsKnowledgeConnectorSettingsArgs{
				Business:                 pulumi.String("example business"),
				Agent:                    pulumi.String("example agent"),
				AgentIdentity:            pulumi.String("virtual agent"),
				BusinessDescription:      pulumi.String("a family company selling freshly roasted coffee beans"),
				AgentScope:               pulumi.String("Example company website"),
				DisableDataStoreFallback: pulumi.Bool(false),
			},
			LanguageCode: pulumi.String("en"),
			LlmModelSettings: &diagflow.CxGenerativeSettingsLlmModelSettingsArgs{
				Model:      pulumi.String("gemini-2.0-flash-001"),
				PromptText: pulumi.String("example prompt text"),
			},
		})
		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 agent = new Gcp.Diagflow.CxAgent("agent", new()
    {
        DisplayName = "dialogflowcx-agent",
        Location = "global",
        DefaultLanguageCode = "en",
        TimeZone = "America/New_York",
        Description = "Example description.",
    });

    var fullGenerativeSettings = new Gcp.Diagflow.CxGenerativeSettings("full_generative_settings", new()
    {
        Parent = agent.Id,
        FallbackSettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsFallbackSettingsArgs
        {
            SelectedPrompt = "example prompt",
            PromptTemplates = new[]
            {
                new Gcp.Diagflow.Inputs.CxGenerativeSettingsFallbackSettingsPromptTemplateArgs
                {
                    DisplayName = "example prompt",
                    PromptText = "example prompt text",
                    Frozen = false,
                },
            },
        },
        GenerativeSafetySettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsGenerativeSafetySettingsArgs
        {
            DefaultBannedPhraseMatchStrategy = "PARTIAL_MATCH",
            BannedPhrases = new[]
            {
                new Gcp.Diagflow.Inputs.CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArgs
                {
                    Text = "example text",
                    LanguageCode = "en",
                },
            },
        },
        KnowledgeConnectorSettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsKnowledgeConnectorSettingsArgs
        {
            Business = "example business",
            Agent = "example agent",
            AgentIdentity = "virtual agent",
            BusinessDescription = "a family company selling freshly roasted coffee beans",
            AgentScope = "Example company website",
            DisableDataStoreFallback = false,
        },
        LanguageCode = "en",
        LlmModelSettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsLlmModelSettingsArgs
        {
            Model = "gemini-2.0-flash-001",
            PromptText = "example prompt text",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.diagflow.CxAgent;
import com.pulumi.gcp.diagflow.CxAgentArgs;
import com.pulumi.gcp.diagflow.CxGenerativeSettings;
import com.pulumi.gcp.diagflow.CxGenerativeSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxGenerativeSettingsFallbackSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxGenerativeSettingsGenerativeSafetySettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxGenerativeSettingsKnowledgeConnectorSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxGenerativeSettingsLlmModelSettingsArgs;
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 agent = new CxAgent("agent", CxAgentArgs.builder()
            .displayName("dialogflowcx-agent")
            .location("global")
            .defaultLanguageCode("en")
            .timeZone("America/New_York")
            .description("Example description.")
            .build());

        var fullGenerativeSettings = new CxGenerativeSettings("fullGenerativeSettings", CxGenerativeSettingsArgs.builder()
            .parent(agent.id())
            .fallbackSettings(CxGenerativeSettingsFallbackSettingsArgs.builder()
                .selectedPrompt("example prompt")
                .promptTemplates(CxGenerativeSettingsFallbackSettingsPromptTemplateArgs.builder()
                    .displayName("example prompt")
                    .promptText("example prompt text")
                    .frozen(false)
                    .build())
                .build())
            .generativeSafetySettings(CxGenerativeSettingsGenerativeSafetySettingsArgs.builder()
                .defaultBannedPhraseMatchStrategy("PARTIAL_MATCH")
                .bannedPhrases(CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArgs.builder()
                    .text("example text")
                    .languageCode("en")
                    .build())
                .build())
            .knowledgeConnectorSettings(CxGenerativeSettingsKnowledgeConnectorSettingsArgs.builder()
                .business("example business")
                .agent("example agent")
                .agentIdentity("virtual agent")
                .businessDescription("a family company selling freshly roasted coffee beans")
                .agentScope("Example company website")
                .disableDataStoreFallback(false)
                .build())
            .languageCode("en")
            .llmModelSettings(CxGenerativeSettingsLlmModelSettingsArgs.builder()
                .model("gemini-2.0-flash-001")
                .promptText("example prompt text")
                .build())
            .build());

    }
}

    resources:
  agent:
    type: gcp:diagflow:CxAgent
    properties:
      displayName: dialogflowcx-agent
      location: global
      defaultLanguageCode: en
      timeZone: America/New_York
      description: Example description.
  fullGenerativeSettings:
    type: gcp:diagflow:CxGenerativeSettings
    name: full_generative_settings
    properties:
      parent: ${agent.id}
      fallbackSettings:
        selectedPrompt: example prompt
        promptTemplates:
          - displayName: example prompt
            promptText: example prompt text
            frozen: false
      generativeSafetySettings:
        defaultBannedPhraseMatchStrategy: PARTIAL_MATCH
        bannedPhrases:
          - text: example text
            languageCode: en
      knowledgeConnectorSettings:
        business: example business
        agent: example agent
        agentIdentity: virtual agent
        businessDescription: a family company selling freshly roasted coffee beans
        agentScope: Example company website
        disableDataStoreFallback: false
      languageCode: en
      llmModelSettings:
        model: gemini-2.0-flash-001
        promptText: example prompt text

    Create CxGenerativeSettings Resource

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

    Constructor syntax

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

@overload
def CxGenerativeSettings(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         language_code: Optional[str] = None,
                         fallback_settings: Optional[CxGenerativeSettingsFallbackSettingsArgs] = None,
                         generative_safety_settings: Optional[CxGenerativeSettingsGenerativeSafetySettingsArgs] = None,
                         knowledge_connector_settings: Optional[CxGenerativeSettingsKnowledgeConnectorSettingsArgs] = None,
                         llm_model_settings: Optional[CxGenerativeSettingsLlmModelSettingsArgs] = None,
                         parent: Optional[str] = None)
    func NewCxGenerativeSettings(ctx *Context, name string, args CxGenerativeSettingsArgs, opts ...ResourceOption) (*CxGenerativeSettings, error)
    public CxGenerativeSettings(string name, CxGenerativeSettingsArgs args, CustomResourceOptions? opts = null)
    public CxGenerativeSettings(String name, CxGenerativeSettingsArgs args)
public CxGenerativeSettings(String name, CxGenerativeSettingsArgs args, CustomResourceOptions options)

    type: gcp:diagflow:CxGenerativeSettings
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 CxGenerativeSettingsArgs
    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 CxGenerativeSettingsArgs
    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 CxGenerativeSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CxGenerativeSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CxGenerativeSettingsArgs
    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 cxGenerativeSettingsResource = new Gcp.Diagflow.CxGenerativeSettings("cxGenerativeSettingsResource", new()
{
    LanguageCode = "string",
    FallbackSettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsFallbackSettingsArgs
    {
        PromptTemplates = new[]
        {
            new Gcp.Diagflow.Inputs.CxGenerativeSettingsFallbackSettingsPromptTemplateArgs
            {
                DisplayName = "string",
                Frozen = false,
                PromptText = "string",
            },
        },
        SelectedPrompt = "string",
    },
    GenerativeSafetySettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsGenerativeSafetySettingsArgs
    {
        BannedPhrases = new[]
        {
            new Gcp.Diagflow.Inputs.CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArgs
            {
                LanguageCode = "string",
                Text = "string",
            },
        },
        DefaultBannedPhraseMatchStrategy = "string",
    },
    KnowledgeConnectorSettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsKnowledgeConnectorSettingsArgs
    {
        Agent = "string",
        AgentIdentity = "string",
        AgentScope = "string",
        Business = "string",
        BusinessDescription = "string",
        DisableDataStoreFallback = false,
    },
    LlmModelSettings = new Gcp.Diagflow.Inputs.CxGenerativeSettingsLlmModelSettingsArgs
    {
        Model = "string",
        PromptText = "string",
    },
    Parent = "string",
});

    example, err := diagflow.NewCxGenerativeSettings(ctx, "cxGenerativeSettingsResource", &diagflow.CxGenerativeSettingsArgs{
	LanguageCode: pulumi.String("string"),
	FallbackSettings: &diagflow.CxGenerativeSettingsFallbackSettingsArgs{
		PromptTemplates: diagflow.CxGenerativeSettingsFallbackSettingsPromptTemplateArray{
			&diagflow.CxGenerativeSettingsFallbackSettingsPromptTemplateArgs{
				DisplayName: pulumi.String("string"),
				Frozen:      pulumi.Bool(false),
				PromptText:  pulumi.String("string"),
			},
		},
		SelectedPrompt: pulumi.String("string"),
	},
	GenerativeSafetySettings: &diagflow.CxGenerativeSettingsGenerativeSafetySettingsArgs{
		BannedPhrases: diagflow.CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArray{
			&diagflow.CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArgs{
				LanguageCode: pulumi.String("string"),
				Text:         pulumi.String("string"),
			},
		},
		DefaultBannedPhraseMatchStrategy: pulumi.String("string"),
	},
	KnowledgeConnectorSettings: &diagflow.CxGenerativeSettingsKnowledgeConnectorSettingsArgs{
		Agent:                    pulumi.String("string"),
		AgentIdentity:            pulumi.String("string"),
		AgentScope:               pulumi.String("string"),
		Business:                 pulumi.String("string"),
		BusinessDescription:      pulumi.String("string"),
		DisableDataStoreFallback: pulumi.Bool(false),
	},
	LlmModelSettings: &diagflow.CxGenerativeSettingsLlmModelSettingsArgs{
		Model:      pulumi.String("string"),
		PromptText: pulumi.String("string"),
	},
	Parent: pulumi.String("string"),
})

    var cxGenerativeSettingsResource = new CxGenerativeSettings("cxGenerativeSettingsResource", CxGenerativeSettingsArgs.builder()
    .languageCode("string")
    .fallbackSettings(CxGenerativeSettingsFallbackSettingsArgs.builder()
        .promptTemplates(CxGenerativeSettingsFallbackSettingsPromptTemplateArgs.builder()
            .displayName("string")
            .frozen(false)
            .promptText("string")
            .build())
        .selectedPrompt("string")
        .build())
    .generativeSafetySettings(CxGenerativeSettingsGenerativeSafetySettingsArgs.builder()
        .bannedPhrases(CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArgs.builder()
            .languageCode("string")
            .text("string")
            .build())
        .defaultBannedPhraseMatchStrategy("string")
        .build())
    .knowledgeConnectorSettings(CxGenerativeSettingsKnowledgeConnectorSettingsArgs.builder()
        .agent("string")
        .agentIdentity("string")
        .agentScope("string")
        .business("string")
        .businessDescription("string")
        .disableDataStoreFallback(false)
        .build())
    .llmModelSettings(CxGenerativeSettingsLlmModelSettingsArgs.builder()
        .model("string")
        .promptText("string")
        .build())
    .parent("string")
    .build());

    cx_generative_settings_resource = gcp.diagflow.CxGenerativeSettings("cxGenerativeSettingsResource",
    language_code="string",
    fallback_settings={
        "prompt_templates": [{
            "display_name": "string",
            "frozen": False,
            "prompt_text": "string",
        }],
        "selected_prompt": "string",
    },
    generative_safety_settings={
        "banned_phrases": [{
            "language_code": "string",
            "text": "string",
        }],
        "default_banned_phrase_match_strategy": "string",
    },
    knowledge_connector_settings={
        "agent": "string",
        "agent_identity": "string",
        "agent_scope": "string",
        "business": "string",
        "business_description": "string",
        "disable_data_store_fallback": False,
    },
    llm_model_settings={
        "model": "string",
        "prompt_text": "string",
    },
    parent="string")

    const cxGenerativeSettingsResource = new gcp.diagflow.CxGenerativeSettings("cxGenerativeSettingsResource", {
    languageCode: "string",
    fallbackSettings: {
        promptTemplates: [{
            displayName: "string",
            frozen: false,
            promptText: "string",
        }],
        selectedPrompt: "string",
    },
    generativeSafetySettings: {
        bannedPhrases: [{
            languageCode: "string",
            text: "string",
        }],
        defaultBannedPhraseMatchStrategy: "string",
    },
    knowledgeConnectorSettings: {
        agent: "string",
        agentIdentity: "string",
        agentScope: "string",
        business: "string",
        businessDescription: "string",
        disableDataStoreFallback: false,
    },
    llmModelSettings: {
        model: "string",
        promptText: "string",
    },
    parent: "string",
});

    type: gcp:diagflow:CxGenerativeSettings
properties:
    fallbackSettings:
        promptTemplates:
            - displayName: string
              frozen: false
              promptText: string
        selectedPrompt: string
    generativeSafetySettings:
        bannedPhrases:
            - languageCode: string
              text: string
        defaultBannedPhraseMatchStrategy: string
    knowledgeConnectorSettings:
        agent: string
        agentIdentity: string
        agentScope: string
        business: string
        businessDescription: string
        disableDataStoreFallback: false
    languageCode: string
    llmModelSettings:
        model: string
        promptText: string
    parent: string

    CxGenerativeSettings 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 CxGenerativeSettings resource accepts the following input properties:

    LanguageCode string
    Language for this settings.
    FallbackSettings CxGenerativeSettingsFallbackSettings
    Settings for Generative Fallback. Structure is documented below.
    GenerativeSafetySettings CxGenerativeSettingsGenerativeSafetySettings
    Settings for Generative Safety. w Structure is documented below.
    KnowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettings
    Settings for knowledge connector. Structure is documented below.
    LlmModelSettings CxGenerativeSettingsLlmModelSettings
    LLM model settings. Structure is documented below.
    Parent string
    The agent to create a flow for. Format: projects//locations//agents/.
    LanguageCode string
    Language for this settings.
    FallbackSettings CxGenerativeSettingsFallbackSettingsArgs
    Settings for Generative Fallback. Structure is documented below.
    GenerativeSafetySettings CxGenerativeSettingsGenerativeSafetySettingsArgs
    Settings for Generative Safety. w Structure is documented below.
    KnowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettingsArgs
    Settings for knowledge connector. Structure is documented below.
    LlmModelSettings CxGenerativeSettingsLlmModelSettingsArgs
    LLM model settings. Structure is documented below.
    Parent string
    The agent to create a flow for. Format: projects//locations//agents/.
    languageCode String
    Language for this settings.
    fallbackSettings CxGenerativeSettingsFallbackSettings
    Settings for Generative Fallback. Structure is documented below.
    generativeSafetySettings CxGenerativeSettingsGenerativeSafetySettings
    Settings for Generative Safety. w Structure is documented below.
    knowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettings
    Settings for knowledge connector. Structure is documented below.
    llmModelSettings CxGenerativeSettingsLlmModelSettings
    LLM model settings. Structure is documented below.
    parent String
    The agent to create a flow for. Format: projects//locations//agents/.
    languageCode string
    Language for this settings.
    fallbackSettings CxGenerativeSettingsFallbackSettings
    Settings for Generative Fallback. Structure is documented below.
    generativeSafetySettings CxGenerativeSettingsGenerativeSafetySettings
    Settings for Generative Safety. w Structure is documented below.
    knowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettings
    Settings for knowledge connector. Structure is documented below.
    llmModelSettings CxGenerativeSettingsLlmModelSettings
    LLM model settings. Structure is documented below.
    parent string
    The agent to create a flow for. Format: projects//locations//agents/.
    language_code str
    Language for this settings.
    fallback_settings CxGenerativeSettingsFallbackSettingsArgs
    Settings for Generative Fallback. Structure is documented below.
    generative_safety_settings CxGenerativeSettingsGenerativeSafetySettingsArgs
    Settings for Generative Safety. w Structure is documented below.
    knowledge_connector_settings CxGenerativeSettingsKnowledgeConnectorSettingsArgs
    Settings for knowledge connector. Structure is documented below.
    llm_model_settings CxGenerativeSettingsLlmModelSettingsArgs
    LLM model settings. Structure is documented below.
    parent str
    The agent to create a flow for. Format: projects//locations//agents/.
    languageCode String
    Language for this settings.
    fallbackSettings Property Map
    Settings for Generative Fallback. Structure is documented below.
    generativeSafetySettings Property Map
    Settings for Generative Safety. w Structure is documented below.
    knowledgeConnectorSettings Property Map
    Settings for knowledge connector. Structure is documented below.
    llmModelSettings Property Map
    LLM model settings. Structure is documented below.
    parent String
    The agent to create a flow for. Format: projects//locations//agents/.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.

    Look up Existing CxGenerativeSettings Resource

    Get an existing CxGenerativeSettings 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?: CxGenerativeSettingsState, opts?: CustomResourceOptions): CxGenerativeSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        fallback_settings: Optional[CxGenerativeSettingsFallbackSettingsArgs] = None,
        generative_safety_settings: Optional[CxGenerativeSettingsGenerativeSafetySettingsArgs] = None,
        knowledge_connector_settings: Optional[CxGenerativeSettingsKnowledgeConnectorSettingsArgs] = None,
        language_code: Optional[str] = None,
        llm_model_settings: Optional[CxGenerativeSettingsLlmModelSettingsArgs] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None) -> CxGenerativeSettings
    func GetCxGenerativeSettings(ctx *Context, name string, id IDInput, state *CxGenerativeSettingsState, opts ...ResourceOption) (*CxGenerativeSettings, error)
    public static CxGenerativeSettings Get(string name, Input<string> id, CxGenerativeSettingsState? state, CustomResourceOptions? opts = null)
    public static CxGenerativeSettings get(String name, Output<String> id, CxGenerativeSettingsState state, CustomResourceOptions options)
    resources:  _:    type: gcp:diagflow:CxGenerativeSettings    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:
    FallbackSettings CxGenerativeSettingsFallbackSettings
    Settings for Generative Fallback. Structure is documented below.
    GenerativeSafetySettings CxGenerativeSettingsGenerativeSafetySettings
    Settings for Generative Safety. w Structure is documented below.
    KnowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettings
    Settings for knowledge connector. Structure is documented below.
    LanguageCode string
    Language for this settings.
    LlmModelSettings CxGenerativeSettingsLlmModelSettings
    LLM model settings. Structure is documented below.
    Name string
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    Parent string
    The agent to create a flow for. Format: projects//locations//agents/.
    FallbackSettings CxGenerativeSettingsFallbackSettingsArgs
    Settings for Generative Fallback. Structure is documented below.
    GenerativeSafetySettings CxGenerativeSettingsGenerativeSafetySettingsArgs
    Settings for Generative Safety. w Structure is documented below.
    KnowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettingsArgs
    Settings for knowledge connector. Structure is documented below.
    LanguageCode string
    Language for this settings.
    LlmModelSettings CxGenerativeSettingsLlmModelSettingsArgs
    LLM model settings. Structure is documented below.
    Name string
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    Parent string
    The agent to create a flow for. Format: projects//locations//agents/.
    fallbackSettings CxGenerativeSettingsFallbackSettings
    Settings for Generative Fallback. Structure is documented below.
    generativeSafetySettings CxGenerativeSettingsGenerativeSafetySettings
    Settings for Generative Safety. w Structure is documented below.
    knowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettings
    Settings for knowledge connector. Structure is documented below.
    languageCode String
    Language for this settings.
    llmModelSettings CxGenerativeSettingsLlmModelSettings
    LLM model settings. Structure is documented below.
    name String
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    parent String
    The agent to create a flow for. Format: projects//locations//agents/.
    fallbackSettings CxGenerativeSettingsFallbackSettings
    Settings for Generative Fallback. Structure is documented below.
    generativeSafetySettings CxGenerativeSettingsGenerativeSafetySettings
    Settings for Generative Safety. w Structure is documented below.
    knowledgeConnectorSettings CxGenerativeSettingsKnowledgeConnectorSettings
    Settings for knowledge connector. Structure is documented below.
    languageCode string
    Language for this settings.
    llmModelSettings CxGenerativeSettingsLlmModelSettings
    LLM model settings. Structure is documented below.
    name string
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    parent string
    The agent to create a flow for. Format: projects//locations//agents/.
    fallback_settings CxGenerativeSettingsFallbackSettingsArgs
    Settings for Generative Fallback. Structure is documented below.
    generative_safety_settings CxGenerativeSettingsGenerativeSafetySettingsArgs
    Settings for Generative Safety. w Structure is documented below.
    knowledge_connector_settings CxGenerativeSettingsKnowledgeConnectorSettingsArgs
    Settings for knowledge connector. Structure is documented below.
    language_code str
    Language for this settings.
    llm_model_settings CxGenerativeSettingsLlmModelSettingsArgs
    LLM model settings. Structure is documented below.
    name str
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    parent str
    The agent to create a flow for. Format: projects//locations//agents/.
    fallbackSettings Property Map
    Settings for Generative Fallback. Structure is documented below.
    generativeSafetySettings Property Map
    Settings for Generative Safety. w Structure is documented below.
    knowledgeConnectorSettings Property Map
    Settings for knowledge connector. Structure is documented below.
    languageCode String
    Language for this settings.
    llmModelSettings Property Map
    LLM model settings. Structure is documented below.
    name String
    The unique identifier of the generativeSettings. Format: projects//locations//agents//generativeSettings.
    parent String
    The agent to create a flow for. Format: projects//locations//agents/.

    Supporting Types

    CxGenerativeSettingsFallbackSettings, CxGenerativeSettingsFallbackSettingsArgs

    PromptTemplates List<CxGenerativeSettingsFallbackSettingsPromptTemplate>
    Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones. Structure is documented below.
    SelectedPrompt string
    Display name of the selected prompt.
    PromptTemplates []CxGenerativeSettingsFallbackSettingsPromptTemplate
    Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones. Structure is documented below.
    SelectedPrompt string
    Display name of the selected prompt.
    promptTemplates List<CxGenerativeSettingsFallbackSettingsPromptTemplate>
    Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones. Structure is documented below.
    selectedPrompt String
    Display name of the selected prompt.
    promptTemplates CxGenerativeSettingsFallbackSettingsPromptTemplate[]
    Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones. Structure is documented below.
    selectedPrompt string
    Display name of the selected prompt.
    prompt_templates Sequence[CxGenerativeSettingsFallbackSettingsPromptTemplate]
    Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones. Structure is documented below.
    selected_prompt str
    Display name of the selected prompt.
    promptTemplates List<Property Map>
    Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones. Structure is documented below.
    selectedPrompt String
    Display name of the selected prompt.

    CxGenerativeSettingsFallbackSettingsPromptTemplate, CxGenerativeSettingsFallbackSettingsPromptTemplateArgs

    DisplayName string
    Prompt name.
    Frozen bool
    If the flag is true, the prompt is frozen and cannot be modified by users.
    PromptText string
    Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
    DisplayName string
    Prompt name.
    Frozen bool
    If the flag is true, the prompt is frozen and cannot be modified by users.
    PromptText string
    Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
    displayName String
    Prompt name.
    frozen Boolean
    If the flag is true, the prompt is frozen and cannot be modified by users.
    promptText String
    Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
    displayName string
    Prompt name.
    frozen boolean
    If the flag is true, the prompt is frozen and cannot be modified by users.
    promptText string
    Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
    display_name str
    Prompt name.
    frozen bool
    If the flag is true, the prompt is frozen and cannot be modified by users.
    prompt_text str
    Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
    displayName String
    Prompt name.
    frozen Boolean
    If the flag is true, the prompt is frozen and cannot be modified by users.
    promptText String
    Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "

    CxGenerativeSettingsGenerativeSafetySettings, CxGenerativeSettingsGenerativeSafetySettingsArgs

    BannedPhrases List<CxGenerativeSettingsGenerativeSafetySettingsBannedPhrase>
    Banned phrases for generated text. Structure is documented below.
    DefaultBannedPhraseMatchStrategy string
    Optional. Default phrase match strategy for banned phrases. See PhraseMatchStrategy for valid values.
    BannedPhrases []CxGenerativeSettingsGenerativeSafetySettingsBannedPhrase
    Banned phrases for generated text. Structure is documented below.
    DefaultBannedPhraseMatchStrategy string
    Optional. Default phrase match strategy for banned phrases. See PhraseMatchStrategy for valid values.
    bannedPhrases List<CxGenerativeSettingsGenerativeSafetySettingsBannedPhrase>
    Banned phrases for generated text. Structure is documented below.
    defaultBannedPhraseMatchStrategy String
    Optional. Default phrase match strategy for banned phrases. See PhraseMatchStrategy for valid values.
    bannedPhrases CxGenerativeSettingsGenerativeSafetySettingsBannedPhrase[]
    Banned phrases for generated text. Structure is documented below.
    defaultBannedPhraseMatchStrategy string
    Optional. Default phrase match strategy for banned phrases. See PhraseMatchStrategy for valid values.
    banned_phrases Sequence[CxGenerativeSettingsGenerativeSafetySettingsBannedPhrase]
    Banned phrases for generated text. Structure is documented below.
    default_banned_phrase_match_strategy str
    Optional. Default phrase match strategy for banned phrases. See PhraseMatchStrategy for valid values.
    bannedPhrases List<Property Map>
    Banned phrases for generated text. Structure is documented below.
    defaultBannedPhraseMatchStrategy String
    Optional. Default phrase match strategy for banned phrases. See PhraseMatchStrategy for valid values.

    CxGenerativeSettingsGenerativeSafetySettingsBannedPhrase, CxGenerativeSettingsGenerativeSafetySettingsBannedPhraseArgs

    LanguageCode string
    Language code of the phrase.
    Text string
    Text input which can be used for prompt or banned phrases.
    LanguageCode string
    Language code of the phrase.
    Text string
    Text input which can be used for prompt or banned phrases.
    languageCode String
    Language code of the phrase.
    text String
    Text input which can be used for prompt or banned phrases.
    languageCode string
    Language code of the phrase.
    text string
    Text input which can be used for prompt or banned phrases.
    language_code str
    Language code of the phrase.
    text str
    Text input which can be used for prompt or banned phrases.
    languageCode String
    Language code of the phrase.
    text String
    Text input which can be used for prompt or banned phrases.

    CxGenerativeSettingsKnowledgeConnectorSettings, CxGenerativeSettingsKnowledgeConnectorSettingsArgs

    Agent string
    Name of the virtual agent. Used for LLM prompt. Can be left empty.
    AgentIdentity string
    Identity of the agent, e.g. "virtual agent", "AI assistant".
    AgentScope string
    Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
    Business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    BusinessDescription string
    Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".``
    DisableDataStoreFallback bool
    Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
    Agent string
    Name of the virtual agent. Used for LLM prompt. Can be left empty.
    AgentIdentity string
    Identity of the agent, e.g. "virtual agent", "AI assistant".
    AgentScope string
    Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
    Business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    BusinessDescription string
    Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".``
    DisableDataStoreFallback bool
    Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
    agent String
    Name of the virtual agent. Used for LLM prompt. Can be left empty.
    agentIdentity String
    Identity of the agent, e.g. "virtual agent", "AI assistant".
    agentScope String
    Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
    business String
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    businessDescription String
    Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".``
    disableDataStoreFallback Boolean
    Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
    agent string
    Name of the virtual agent. Used for LLM prompt. Can be left empty.
    agentIdentity string
    Identity of the agent, e.g. "virtual agent", "AI assistant".
    agentScope string
    Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
    business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    businessDescription string
    Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".``
    disableDataStoreFallback boolean
    Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
    agent str
    Name of the virtual agent. Used for LLM prompt. Can be left empty.
    agent_identity str
    Identity of the agent, e.g. "virtual agent", "AI assistant".
    agent_scope str
    Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
    business str
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    business_description str
    Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".``
    disable_data_store_fallback bool
    Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
    agent String
    Name of the virtual agent. Used for LLM prompt. Can be left empty.
    agentIdentity String
    Identity of the agent, e.g. "virtual agent", "AI assistant".
    agentScope String
    Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
    business String
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    businessDescription String
    Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".``
    disableDataStoreFallback Boolean
    Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.

    CxGenerativeSettingsLlmModelSettings, CxGenerativeSettingsLlmModelSettingsArgs

    Model string
    The selected LLM model.
    PromptText string
    The custom prompt to use.
    Model string
    The selected LLM model.
    PromptText string
    The custom prompt to use.
    model String
    The selected LLM model.
    promptText String
    The custom prompt to use.
    model string
    The selected LLM model.
    promptText string
    The custom prompt to use.
    model str
    The selected LLM model.
    prompt_text str
    The custom prompt to use.
    model String
    The selected LLM model.
    promptText String
    The custom prompt to use.

    Import

    GenerativeSettings can be imported using any of these accepted formats:

    • {{parent}}/generativeSettings

    • {{parent}}

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

    $ pulumi import gcp:diagflow/cxGenerativeSettings:CxGenerativeSettings default {{parent}}/generativeSettings

    $ pulumi import gcp:diagflow/cxGenerativeSettings:CxGenerativeSettings default {{parent}}

    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 v8.39.0 published on Tuesday, Jul 22, 2025 by Pulumi
    pulumi/pulumi-gcp