1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. CxAgent
Google Cloud v9.3.0 published on Tuesday, Oct 7, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.diagflow.CxAgent

Deploy with Pulumi
gcp logo
Google Cloud v9.3.0 published on Tuesday, Oct 7, 2025 by Pulumi
pulumi/pulumi-gcp

    Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

    To get more information about Agent, see:

    Example Usage

    Dialogflowcx Agent Full

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

const bucket = new gcp.storage.Bucket("bucket", {
    name: "dialogflowcx-bucket",
    location: "US",
    uniformBucketLevelAccess: true,
});
const fullAgent = new gcp.diagflow.CxAgent("full_agent", {
    displayName: "dialogflowcx-agent",
    location: "global",
    defaultLanguageCode: "en",
    supportedLanguageCodes: [
        "fr",
        "de",
        "es",
    ],
    timeZone: "America/New_York",
    description: "Example description.",
    avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
    enableStackdriverLogging: true,
    enableSpellCorrection: true,
    speechToTextSettings: {
        enableSpeechAdaptation: true,
    },
    advancedSettings: {
        audioExportGcsDestination: {
            uri: pulumi.interpolate`${bucket.url}/prefix-`,
        },
        speechSettings: {
            endpointerSensitivity: 30,
            noSpeechTimeout: "3.500s",
            useTimeoutBasedEndpointing: true,
            models: {
                name: "wrench",
                mass: "1.3kg",
                count: "3",
            },
        },
        dtmfSettings: {
            enabled: true,
            maxDigits: 1,
            finishDigit: "#",
        },
        loggingSettings: {
            enableStackdriverLogging: true,
            enableInteractionLogging: true,
            enableConsentBasedRedaction: true,
        },
    },
    gitIntegrationSettings: {
        githubSettings: {
            displayName: "Github Repo",
            repositoryUri: "https://api.github.com/repos/githubtraining/hellogitworld",
            trackingBranch: "main",
            accessToken: "secret-token",
            branches: ["main"],
        },
    },
    textToSpeechSettings: {
        synthesizeSpeechConfigs: JSON.stringify({
            en: {
                voice: {
                    name: "en-US-Neural2-A",
                },
            },
            fr: {
                voice: {
                    name: "fr-CA-Neural2-A",
                },
            },
        }),
    },
    genAppBuilderSettings: {
        engine: "projects/-/locations/-/collections/-/engines/-",
    },
    startPlaybook: "projects/-/locations/-/agents/-/playbooks/00000000-0000-0000-0000-000000000000",
    enableMultiLanguageTraining: false,
    locked: false,
    answerFeedbackSettings: {
        enableAnswerFeedback: false,
    },
    clientCertificateSettings: {
        passphrase: "projects/example-proj/secrets/example-secret/versions/example-version",
        privateKey: "projects/example-proj/secrets/example-secret/versions/example-version",
        sslCertificate: `-----BEGIN CERTIFICATE-----
MIIDdDCCAlygAwIBAgIJANg0gKeB5LKmMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYD
VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
aXNjbzEZMBcGA1UECgwQR2l0SHViLCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50
IFRlYW0xGTAXBgNVBAMMEGdvdnN0YWNrLmdpdGh1Yi5pbzAeFw0yMDA1MDUxNzM2
MzVaFw0zMDA1MDMxNzM2MzVaMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2Fs
aWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEZMBcGA1UECgwQR2l0SHVi
LCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50IFRlYW0xGTAXBgNVBAMMEGdvdnN0
YWNrLmdpdGh1Yi5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5P
4d9qWZPjZ2eA4eYV2Q8Z3Zp4g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6AgMBAAGjggEaMIIBFjAdBgNVHQ4EFgQUCneA9H8fC+tC
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
-----END CERTIFICATE-----
`,
    },
    personalizationSettings: {
        defaultEndUserMetadata: "{\"example-key\": \"example-value\"}",
    },
});

    import pulumi
import json
import pulumi_gcp as gcp

bucket = gcp.storage.Bucket("bucket",
    name="dialogflowcx-bucket",
    location="US",
    uniform_bucket_level_access=True)
full_agent = gcp.diagflow.CxAgent("full_agent",
    display_name="dialogflowcx-agent",
    location="global",
    default_language_code="en",
    supported_language_codes=[
        "fr",
        "de",
        "es",
    ],
    time_zone="America/New_York",
    description="Example description.",
    avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
    enable_stackdriver_logging=True,
    enable_spell_correction=True,
    speech_to_text_settings={
        "enable_speech_adaptation": True,
    },
    advanced_settings={
        "audio_export_gcs_destination": {
            "uri": bucket.url.apply(lambda url: f"{url}/prefix-"),
        },
        "speech_settings": {
            "endpointer_sensitivity": 30,
            "no_speech_timeout": "3.500s",
            "use_timeout_based_endpointing": True,
            "models": {
                "name": "wrench",
                "mass": "1.3kg",
                "count": "3",
            },
        },
        "dtmf_settings": {
            "enabled": True,
            "max_digits": 1,
            "finish_digit": "#",
        },
        "logging_settings": {
            "enable_stackdriver_logging": True,
            "enable_interaction_logging": True,
            "enable_consent_based_redaction": True,
        },
    },
    git_integration_settings={
        "github_settings": {
            "display_name": "Github Repo",
            "repository_uri": "https://api.github.com/repos/githubtraining/hellogitworld",
            "tracking_branch": "main",
            "access_token": "secret-token",
            "branches": ["main"],
        },
    },
    text_to_speech_settings={
        "synthesize_speech_configs": json.dumps({
            "en": {
                "voice": {
                    "name": "en-US-Neural2-A",
                },
            },
            "fr": {
                "voice": {
                    "name": "fr-CA-Neural2-A",
                },
            },
        }),
    },
    gen_app_builder_settings={
        "engine": "projects/-/locations/-/collections/-/engines/-",
    },
    start_playbook="projects/-/locations/-/agents/-/playbooks/00000000-0000-0000-0000-000000000000",
    enable_multi_language_training=False,
    locked=False,
    answer_feedback_settings={
        "enable_answer_feedback": False,
    },
    client_certificate_settings={
        "passphrase": "projects/example-proj/secrets/example-secret/versions/example-version",
        "private_key": "projects/example-proj/secrets/example-secret/versions/example-version",
        "ssl_certificate": """-----BEGIN CERTIFICATE-----
MIIDdDCCAlygAwIBAgIJANg0gKeB5LKmMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYD
VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
aXNjbzEZMBcGA1UECgwQR2l0SHViLCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50
IFRlYW0xGTAXBgNVBAMMEGdvdnN0YWNrLmdpdGh1Yi5pbzAeFw0yMDA1MDUxNzM2
MzVaFw0zMDA1MDMxNzM2MzVaMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2Fs
aWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEZMBcGA1UECgwQR2l0SHVi
LCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50IFRlYW0xGTAXBgNVBAMMEGdvdnN0
YWNrLmdpdGh1Yi5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5P
4d9qWZPjZ2eA4eYV2Q8Z3Zp4g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6AgMBAAGjggEaMIIBFjAdBgNVHQ4EFgQUCneA9H8fC+tC
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
-----END CERTIFICATE-----
""",
    },
    personalization_settings={
        "default_end_user_metadata": "{\"example-key\": \"example-value\"}",
    })

    package main

import (
	"encoding/json"
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/diagflow"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
			Name:                     pulumi.String("dialogflowcx-bucket"),
			Location:                 pulumi.String("US"),
			UniformBucketLevelAccess: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"en": map[string]interface{}{
				"voice": map[string]interface{}{
					"name": "en-US-Neural2-A",
				},
			},
			"fr": map[string]interface{}{
				"voice": map[string]interface{}{
					"name": "fr-CA-Neural2-A",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = diagflow.NewCxAgent(ctx, "full_agent", &diagflow.CxAgentArgs{
			DisplayName:         pulumi.String("dialogflowcx-agent"),
			Location:            pulumi.String("global"),
			DefaultLanguageCode: pulumi.String("en"),
			SupportedLanguageCodes: pulumi.StringArray{
				pulumi.String("fr"),
				pulumi.String("de"),
				pulumi.String("es"),
			},
			TimeZone:                 pulumi.String("America/New_York"),
			Description:              pulumi.String("Example description."),
			AvatarUri:                pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"),
			EnableStackdriverLogging: pulumi.Bool(true),
			EnableSpellCorrection:    pulumi.Bool(true),
			SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
				EnableSpeechAdaptation: pulumi.Bool(true),
			},
			AdvancedSettings: &diagflow.CxAgentAdvancedSettingsArgs{
				AudioExportGcsDestination: &diagflow.CxAgentAdvancedSettingsAudioExportGcsDestinationArgs{
					Uri: bucket.Url.ApplyT(func(url string) (string, error) {
						return fmt.Sprintf("%v/prefix-", url), nil
					}).(pulumi.StringOutput),
				},
				SpeechSettings: &diagflow.CxAgentAdvancedSettingsSpeechSettingsArgs{
					EndpointerSensitivity:      pulumi.Int(30),
					NoSpeechTimeout:            pulumi.String("3.500s"),
					UseTimeoutBasedEndpointing: pulumi.Bool(true),
					Models: pulumi.StringMap{
						"name":  pulumi.String("wrench"),
						"mass":  pulumi.String("1.3kg"),
						"count": pulumi.String("3"),
					},
				},
				DtmfSettings: &diagflow.CxAgentAdvancedSettingsDtmfSettingsArgs{
					Enabled:     pulumi.Bool(true),
					MaxDigits:   pulumi.Int(1),
					FinishDigit: pulumi.String("#"),
				},
				LoggingSettings: &diagflow.CxAgentAdvancedSettingsLoggingSettingsArgs{
					EnableStackdriverLogging:    pulumi.Bool(true),
					EnableInteractionLogging:    pulumi.Bool(true),
					EnableConsentBasedRedaction: pulumi.Bool(true),
				},
			},
			GitIntegrationSettings: &diagflow.CxAgentGitIntegrationSettingsArgs{
				GithubSettings: &diagflow.CxAgentGitIntegrationSettingsGithubSettingsArgs{
					DisplayName:    pulumi.String("Github Repo"),
					RepositoryUri:  pulumi.String("https://api.github.com/repos/githubtraining/hellogitworld"),
					TrackingBranch: pulumi.String("main"),
					AccessToken:    pulumi.String("secret-token"),
					Branches: pulumi.StringArray{
						pulumi.String("main"),
					},
				},
			},
			TextToSpeechSettings: &diagflow.CxAgentTextToSpeechSettingsArgs{
				SynthesizeSpeechConfigs: pulumi.String(json0),
			},
			GenAppBuilderSettings: &diagflow.CxAgentGenAppBuilderSettingsArgs{
				Engine: pulumi.String("projects/-/locations/-/collections/-/engines/-"),
			},
			StartPlaybook:               pulumi.String("projects/-/locations/-/agents/-/playbooks/00000000-0000-0000-0000-000000000000"),
			EnableMultiLanguageTraining: pulumi.Bool(false),
			Locked:                      pulumi.Bool(false),
			AnswerFeedbackSettings: &diagflow.CxAgentAnswerFeedbackSettingsArgs{
				EnableAnswerFeedback: pulumi.Bool(false),
			},
			ClientCertificateSettings: &diagflow.CxAgentClientCertificateSettingsArgs{
				Passphrase: pulumi.String("projects/example-proj/secrets/example-secret/versions/example-version"),
				PrivateKey: pulumi.String("projects/example-proj/secrets/example-secret/versions/example-version"),
				SslCertificate: pulumi.String(`-----BEGIN CERTIFICATE-----
MIIDdDCCAlygAwIBAgIJANg0gKeB5LKmMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYD
VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
aXNjbzEZMBcGA1UECgwQR2l0SHViLCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50
IFRlYW0xGTAXBgNVBAMMEGdvdnN0YWNrLmdpdGh1Yi5pbzAeFw0yMDA1MDUxNzM2
MzVaFw0zMDA1MDMxNzM2MzVaMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2Fs
aWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEZMBcGA1UECgwQR2l0SHVi
LCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50IFRlYW0xGTAXBgNVBAMMEGdvdnN0
YWNrLmdpdGh1Yi5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5P
4d9qWZPjZ2eA4eYV2Q8Z3Zp4g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6AgMBAAGjggEaMIIBFjAdBgNVHQ4EFgQUCneA9H8fC+tC
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
-----END CERTIFICATE-----
`),
			},
			PersonalizationSettings: &diagflow.CxAgentPersonalizationSettingsArgs{
				DefaultEndUserMetadata: pulumi.String("{\"example-key\": \"example-value\"}"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var bucket = new Gcp.Storage.Bucket("bucket", new()
    {
        Name = "dialogflowcx-bucket",
        Location = "US",
        UniformBucketLevelAccess = true,
    });

    var fullAgent = new Gcp.Diagflow.CxAgent("full_agent", new()
    {
        DisplayName = "dialogflowcx-agent",
        Location = "global",
        DefaultLanguageCode = "en",
        SupportedLanguageCodes = new[]
        {
            "fr",
            "de",
            "es",
        },
        TimeZone = "America/New_York",
        Description = "Example description.",
        AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
        EnableStackdriverLogging = true,
        EnableSpellCorrection = true,
        SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
        {
            EnableSpeechAdaptation = true,
        },
        AdvancedSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsArgs
        {
            AudioExportGcsDestination = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsAudioExportGcsDestinationArgs
            {
                Uri = bucket.Url.Apply(url => $"{url}/prefix-"),
            },
            SpeechSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsSpeechSettingsArgs
            {
                EndpointerSensitivity = 30,
                NoSpeechTimeout = "3.500s",
                UseTimeoutBasedEndpointing = true,
                Models = 
                {
                    { "name", "wrench" },
                    { "mass", "1.3kg" },
                    { "count", "3" },
                },
            },
            DtmfSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsDtmfSettingsArgs
            {
                Enabled = true,
                MaxDigits = 1,
                FinishDigit = "#",
            },
            LoggingSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsLoggingSettingsArgs
            {
                EnableStackdriverLogging = true,
                EnableInteractionLogging = true,
                EnableConsentBasedRedaction = true,
            },
        },
        GitIntegrationSettings = new Gcp.Diagflow.Inputs.CxAgentGitIntegrationSettingsArgs
        {
            GithubSettings = new Gcp.Diagflow.Inputs.CxAgentGitIntegrationSettingsGithubSettingsArgs
            {
                DisplayName = "Github Repo",
                RepositoryUri = "https://api.github.com/repos/githubtraining/hellogitworld",
                TrackingBranch = "main",
                AccessToken = "secret-token",
                Branches = new[]
                {
                    "main",
                },
            },
        },
        TextToSpeechSettings = new Gcp.Diagflow.Inputs.CxAgentTextToSpeechSettingsArgs
        {
            SynthesizeSpeechConfigs = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["en"] = new Dictionary<string, object?>
                {
                    ["voice"] = new Dictionary<string, object?>
                    {
                        ["name"] = "en-US-Neural2-A",
                    },
                },
                ["fr"] = new Dictionary<string, object?>
                {
                    ["voice"] = new Dictionary<string, object?>
                    {
                        ["name"] = "fr-CA-Neural2-A",
                    },
                },
            }),
        },
        GenAppBuilderSettings = new Gcp.Diagflow.Inputs.CxAgentGenAppBuilderSettingsArgs
        {
            Engine = "projects/-/locations/-/collections/-/engines/-",
        },
        StartPlaybook = "projects/-/locations/-/agents/-/playbooks/00000000-0000-0000-0000-000000000000",
        EnableMultiLanguageTraining = false,
        Locked = false,
        AnswerFeedbackSettings = new Gcp.Diagflow.Inputs.CxAgentAnswerFeedbackSettingsArgs
        {
            EnableAnswerFeedback = false,
        },
        ClientCertificateSettings = new Gcp.Diagflow.Inputs.CxAgentClientCertificateSettingsArgs
        {
            Passphrase = "projects/example-proj/secrets/example-secret/versions/example-version",
            PrivateKey = "projects/example-proj/secrets/example-secret/versions/example-version",
            SslCertificate = @"-----BEGIN CERTIFICATE-----
MIIDdDCCAlygAwIBAgIJANg0gKeB5LKmMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYD
VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
aXNjbzEZMBcGA1UECgwQR2l0SHViLCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50
IFRlYW0xGTAXBgNVBAMMEGdvdnN0YWNrLmdpdGh1Yi5pbzAeFw0yMDA1MDUxNzM2
MzVaFw0zMDA1MDMxNzM2MzVaMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2Fs
aWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEZMBcGA1UECgwQR2l0SHVi
LCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50IFRlYW0xGTAXBgNVBAMMEGdvdnN0
YWNrLmdpdGh1Yi5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5P
4d9qWZPjZ2eA4eYV2Q8Z3Zp4g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6AgMBAAGjggEaMIIBFjAdBgNVHQ4EFgQUCneA9H8fC+tC
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
-----END CERTIFICATE-----
",
        },
        PersonalizationSettings = new Gcp.Diagflow.Inputs.CxAgentPersonalizationSettingsArgs
        {
            DefaultEndUserMetadata = "{\"example-key\": \"example-value\"}",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.diagflow.CxAgent;
import com.pulumi.gcp.diagflow.CxAgentArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentAdvancedSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentAdvancedSettingsAudioExportGcsDestinationArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentAdvancedSettingsSpeechSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentAdvancedSettingsDtmfSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentAdvancedSettingsLoggingSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentGitIntegrationSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentGitIntegrationSettingsGithubSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentTextToSpeechSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentGenAppBuilderSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentAnswerFeedbackSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentClientCertificateSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentPersonalizationSettingsArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 bucket = new Bucket("bucket", BucketArgs.builder()
            .name("dialogflowcx-bucket")
            .location("US")
            .uniformBucketLevelAccess(true)
            .build());

        var fullAgent = new CxAgent("fullAgent", CxAgentArgs.builder()
            .displayName("dialogflowcx-agent")
            .location("global")
            .defaultLanguageCode("en")
            .supportedLanguageCodes(            
                "fr",
                "de",
                "es")
            .timeZone("America/New_York")
            .description("Example description.")
            .avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
            .enableStackdriverLogging(true)
            .enableSpellCorrection(true)
            .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
                .enableSpeechAdaptation(true)
                .build())
            .advancedSettings(CxAgentAdvancedSettingsArgs.builder()
                .audioExportGcsDestination(CxAgentAdvancedSettingsAudioExportGcsDestinationArgs.builder()
                    .uri(bucket.url().applyValue(_url -> String.format("%s/prefix-", _url)))
                    .build())
                .speechSettings(CxAgentAdvancedSettingsSpeechSettingsArgs.builder()
                    .endpointerSensitivity(30)
                    .noSpeechTimeout("3.500s")
                    .useTimeoutBasedEndpointing(true)
                    .models(Map.ofEntries(
                        Map.entry("name", "wrench"),
                        Map.entry("mass", "1.3kg"),
                        Map.entry("count", "3")
                    ))
                    .build())
                .dtmfSettings(CxAgentAdvancedSettingsDtmfSettingsArgs.builder()
                    .enabled(true)
                    .maxDigits(1)
                    .finishDigit("#")
                    .build())
                .loggingSettings(CxAgentAdvancedSettingsLoggingSettingsArgs.builder()
                    .enableStackdriverLogging(true)
                    .enableInteractionLogging(true)
                    .enableConsentBasedRedaction(true)
                    .build())
                .build())
            .gitIntegrationSettings(CxAgentGitIntegrationSettingsArgs.builder()
                .githubSettings(CxAgentGitIntegrationSettingsGithubSettingsArgs.builder()
                    .displayName("Github Repo")
                    .repositoryUri("https://api.github.com/repos/githubtraining/hellogitworld")
                    .trackingBranch("main")
                    .accessToken("secret-token")
                    .branches("main")
                    .build())
                .build())
            .textToSpeechSettings(CxAgentTextToSpeechSettingsArgs.builder()
                .synthesizeSpeechConfigs(serializeJson(
                    jsonObject(
                        jsonProperty("en", jsonObject(
                            jsonProperty("voice", jsonObject(
                                jsonProperty("name", "en-US-Neural2-A")
                            ))
                        )),
                        jsonProperty("fr", jsonObject(
                            jsonProperty("voice", jsonObject(
                                jsonProperty("name", "fr-CA-Neural2-A")
                            ))
                        ))
                    )))
                .build())
            .genAppBuilderSettings(CxAgentGenAppBuilderSettingsArgs.builder()
                .engine("projects/-/locations/-/collections/-/engines/-")
                .build())
            .startPlaybook("projects/-/locations/-/agents/-/playbooks/00000000-0000-0000-0000-000000000000")
            .enableMultiLanguageTraining(false)
            .locked(false)
            .answerFeedbackSettings(CxAgentAnswerFeedbackSettingsArgs.builder()
                .enableAnswerFeedback(false)
                .build())
            .clientCertificateSettings(CxAgentClientCertificateSettingsArgs.builder()
                .passphrase("projects/example-proj/secrets/example-secret/versions/example-version")
                .privateKey("projects/example-proj/secrets/example-secret/versions/example-version")
                .sslCertificate("""
-----BEGIN CERTIFICATE-----
MIIDdDCCAlygAwIBAgIJANg0gKeB5LKmMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYD
VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
aXNjbzEZMBcGA1UECgwQR2l0SHViLCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50
IFRlYW0xGTAXBgNVBAMMEGdvdnN0YWNrLmdpdGh1Yi5pbzAeFw0yMDA1MDUxNzM2
MzVaFw0zMDA1MDMxNzM2MzVaMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2Fs
aWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEZMBcGA1UECgwQR2l0SHVi
LCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50IFRlYW0xGTAXBgNVBAMMEGdvdnN0
YWNrLmdpdGh1Yi5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5P
4d9qWZPjZ2eA4eYV2Q8Z3Zp4g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6AgMBAAGjggEaMIIBFjAdBgNVHQ4EFgQUCneA9H8fC+tC
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
-----END CERTIFICATE-----
                """)
                .build())
            .personalizationSettings(CxAgentPersonalizationSettingsArgs.builder()
                .defaultEndUserMetadata("{\"example-key\": \"example-value\"}")
                .build())
            .build());

    }
}

    resources:
  bucket:
    type: gcp:storage:Bucket
    properties:
      name: dialogflowcx-bucket
      location: US
      uniformBucketLevelAccess: true
  fullAgent:
    type: gcp:diagflow:CxAgent
    name: full_agent
    properties:
      displayName: dialogflowcx-agent
      location: global
      defaultLanguageCode: en
      supportedLanguageCodes:
        - fr
        - de
        - es
      timeZone: America/New_York
      description: Example description.
      avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
      enableStackdriverLogging: true
      enableSpellCorrection: true
      speechToTextSettings:
        enableSpeechAdaptation: true
      advancedSettings:
        audioExportGcsDestination:
          uri: ${bucket.url}/prefix-
        speechSettings:
          endpointerSensitivity: 30
          noSpeechTimeout: 3.500s
          useTimeoutBasedEndpointing: true
          models:
            name: wrench
            mass: 1.3kg
            count: '3'
        dtmfSettings:
          enabled: true
          maxDigits: 1
          finishDigit: '#'
        loggingSettings:
          enableStackdriverLogging: true
          enableInteractionLogging: true
          enableConsentBasedRedaction: true
      gitIntegrationSettings:
        githubSettings:
          displayName: Github Repo
          repositoryUri: https://api.github.com/repos/githubtraining/hellogitworld
          trackingBranch: main
          accessToken: secret-token
          branches:
            - main
      textToSpeechSettings:
        synthesizeSpeechConfigs:
          fn::toJSON:
            en:
              voice:
                name: en-US-Neural2-A
            fr:
              voice:
                name: fr-CA-Neural2-A
      genAppBuilderSettings:
        engine: projects/-/locations/-/collections/-/engines/-
      startPlaybook: projects/-/locations/-/agents/-/playbooks/00000000-0000-0000-0000-000000000000
      enableMultiLanguageTraining: false
      locked: false
      answerFeedbackSettings:
        enableAnswerFeedback: false
      clientCertificateSettings:
        passphrase: projects/example-proj/secrets/example-secret/versions/example-version
        privateKey: projects/example-proj/secrets/example-secret/versions/example-version
        sslCertificate: |
          -----BEGIN CERTIFICATE-----
          MIIDdDCCAlygAwIBAgIJANg0gKeB5LKmMA0GCSqGSIb3DQEBCwUAMIGSMQswCQYD
          VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
          aXNjbzEZMBcGA1UECgwQR2l0SHViLCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50
          IFRlYW0xGTAXBgNVBAMMEGdvdnN0YWNrLmdpdGh1Yi5pbzAeFw0yMDA1MDUxNzM2
          MzVaFw0zMDA1MDMxNzM2MzVaMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2Fs
          aWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEZMBcGA1UECgwQR2l0SHVi
          LCBJbmMuMRkwFwYDVQQLDBBHb3Zlcm5tZW50IFRlYW0xGTAXBgNVBAMMEGdvdnN0
          YWNrLmdpdGh1Yi5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5P
          4d9qWZPjZ2eA4eYV2Q8Z3Zp4g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          g8e6g8e6g8e6g8e6g8e6AgMBAAGjggEaMIIBFjAdBgNVHQ4EFgQUCneA9H8fC+tC
          g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6g8e6
          -----END CERTIFICATE-----          
      personalizationSettings:
        defaultEndUserMetadata: '{"example-key": "example-value"}'

    Create CxAgent Resource

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

    Constructor syntax

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

@overload
def CxAgent(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            default_language_code: Optional[str] = None,
            time_zone: Optional[str] = None,
            location: Optional[str] = None,
            display_name: Optional[str] = None,
            enable_stackdriver_logging: Optional[bool] = None,
            avatar_uri: Optional[str] = None,
            description: Optional[str] = None,
            client_certificate_settings: Optional[CxAgentClientCertificateSettingsArgs] = None,
            enable_multi_language_training: Optional[bool] = None,
            enable_spell_correction: Optional[bool] = None,
            advanced_settings: Optional[CxAgentAdvancedSettingsArgs] = None,
            gen_app_builder_settings: Optional[CxAgentGenAppBuilderSettingsArgs] = None,
            git_integration_settings: Optional[CxAgentGitIntegrationSettingsArgs] = None,
            delete_chat_engine_on_destroy: Optional[bool] = None,
            locked: Optional[bool] = None,
            personalization_settings: Optional[CxAgentPersonalizationSettingsArgs] = None,
            project: Optional[str] = None,
            security_settings: Optional[str] = None,
            speech_to_text_settings: Optional[CxAgentSpeechToTextSettingsArgs] = None,
            start_playbook: Optional[str] = None,
            supported_language_codes: Optional[Sequence[str]] = None,
            text_to_speech_settings: Optional[CxAgentTextToSpeechSettingsArgs] = None,
            answer_feedback_settings: Optional[CxAgentAnswerFeedbackSettingsArgs] = None)
    func NewCxAgent(ctx *Context, name string, args CxAgentArgs, opts ...ResourceOption) (*CxAgent, error)
    public CxAgent(string name, CxAgentArgs args, CustomResourceOptions? opts = null)
    public CxAgent(String name, CxAgentArgs args)
public CxAgent(String name, CxAgentArgs args, CustomResourceOptions options)

    type: gcp:diagflow:CxAgent
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 CxAgentArgs
    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 CxAgentArgs
    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 CxAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CxAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CxAgentArgs
    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 cxAgentResource = new Gcp.Diagflow.CxAgent("cxAgentResource", new()
{
    DefaultLanguageCode = "string",
    TimeZone = "string",
    Location = "string",
    DisplayName = "string",
    AvatarUri = "string",
    Description = "string",
    ClientCertificateSettings = new Gcp.Diagflow.Inputs.CxAgentClientCertificateSettingsArgs
    {
        PrivateKey = "string",
        SslCertificate = "string",
        Passphrase = "string",
    },
    EnableMultiLanguageTraining = false,
    EnableSpellCorrection = false,
    AdvancedSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsArgs
    {
        AudioExportGcsDestination = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsAudioExportGcsDestinationArgs
        {
            Uri = "string",
        },
        DtmfSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsDtmfSettingsArgs
        {
            Enabled = false,
            FinishDigit = "string",
            MaxDigits = 0,
        },
        LoggingSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsLoggingSettingsArgs
        {
            EnableConsentBasedRedaction = false,
            EnableInteractionLogging = false,
            EnableStackdriverLogging = false,
        },
        SpeechSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsSpeechSettingsArgs
        {
            EndpointerSensitivity = 0,
            Models = 
            {
                { "string", "string" },
            },
            NoSpeechTimeout = "string",
            UseTimeoutBasedEndpointing = false,
        },
    },
    GenAppBuilderSettings = new Gcp.Diagflow.Inputs.CxAgentGenAppBuilderSettingsArgs
    {
        Engine = "string",
    },
    GitIntegrationSettings = new Gcp.Diagflow.Inputs.CxAgentGitIntegrationSettingsArgs
    {
        GithubSettings = new Gcp.Diagflow.Inputs.CxAgentGitIntegrationSettingsGithubSettingsArgs
        {
            AccessToken = "string",
            Branches = new[]
            {
                "string",
            },
            DisplayName = "string",
            RepositoryUri = "string",
            TrackingBranch = "string",
        },
    },
    DeleteChatEngineOnDestroy = false,
    Locked = false,
    PersonalizationSettings = new Gcp.Diagflow.Inputs.CxAgentPersonalizationSettingsArgs
    {
        DefaultEndUserMetadata = "string",
    },
    Project = "string",
    SecuritySettings = "string",
    SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
    {
        EnableSpeechAdaptation = false,
    },
    StartPlaybook = "string",
    SupportedLanguageCodes = new[]
    {
        "string",
    },
    TextToSpeechSettings = new Gcp.Diagflow.Inputs.CxAgentTextToSpeechSettingsArgs
    {
        SynthesizeSpeechConfigs = "string",
    },
    AnswerFeedbackSettings = new Gcp.Diagflow.Inputs.CxAgentAnswerFeedbackSettingsArgs
    {
        EnableAnswerFeedback = false,
    },
});

    example, err := diagflow.NewCxAgent(ctx, "cxAgentResource", &diagflow.CxAgentArgs{
	DefaultLanguageCode: pulumi.String("string"),
	TimeZone:            pulumi.String("string"),
	Location:            pulumi.String("string"),
	DisplayName:         pulumi.String("string"),
	AvatarUri:           pulumi.String("string"),
	Description:         pulumi.String("string"),
	ClientCertificateSettings: &diagflow.CxAgentClientCertificateSettingsArgs{
		PrivateKey:     pulumi.String("string"),
		SslCertificate: pulumi.String("string"),
		Passphrase:     pulumi.String("string"),
	},
	EnableMultiLanguageTraining: pulumi.Bool(false),
	EnableSpellCorrection:       pulumi.Bool(false),
	AdvancedSettings: &diagflow.CxAgentAdvancedSettingsArgs{
		AudioExportGcsDestination: &diagflow.CxAgentAdvancedSettingsAudioExportGcsDestinationArgs{
			Uri: pulumi.String("string"),
		},
		DtmfSettings: &diagflow.CxAgentAdvancedSettingsDtmfSettingsArgs{
			Enabled:     pulumi.Bool(false),
			FinishDigit: pulumi.String("string"),
			MaxDigits:   pulumi.Int(0),
		},
		LoggingSettings: &diagflow.CxAgentAdvancedSettingsLoggingSettingsArgs{
			EnableConsentBasedRedaction: pulumi.Bool(false),
			EnableInteractionLogging:    pulumi.Bool(false),
			EnableStackdriverLogging:    pulumi.Bool(false),
		},
		SpeechSettings: &diagflow.CxAgentAdvancedSettingsSpeechSettingsArgs{
			EndpointerSensitivity: pulumi.Int(0),
			Models: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			NoSpeechTimeout:            pulumi.String("string"),
			UseTimeoutBasedEndpointing: pulumi.Bool(false),
		},
	},
	GenAppBuilderSettings: &diagflow.CxAgentGenAppBuilderSettingsArgs{
		Engine: pulumi.String("string"),
	},
	GitIntegrationSettings: &diagflow.CxAgentGitIntegrationSettingsArgs{
		GithubSettings: &diagflow.CxAgentGitIntegrationSettingsGithubSettingsArgs{
			AccessToken: pulumi.String("string"),
			Branches: pulumi.StringArray{
				pulumi.String("string"),
			},
			DisplayName:    pulumi.String("string"),
			RepositoryUri:  pulumi.String("string"),
			TrackingBranch: pulumi.String("string"),
		},
	},
	DeleteChatEngineOnDestroy: pulumi.Bool(false),
	Locked:                    pulumi.Bool(false),
	PersonalizationSettings: &diagflow.CxAgentPersonalizationSettingsArgs{
		DefaultEndUserMetadata: pulumi.String("string"),
	},
	Project:          pulumi.String("string"),
	SecuritySettings: pulumi.String("string"),
	SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
		EnableSpeechAdaptation: pulumi.Bool(false),
	},
	StartPlaybook: pulumi.String("string"),
	SupportedLanguageCodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	TextToSpeechSettings: &diagflow.CxAgentTextToSpeechSettingsArgs{
		SynthesizeSpeechConfigs: pulumi.String("string"),
	},
	AnswerFeedbackSettings: &diagflow.CxAgentAnswerFeedbackSettingsArgs{
		EnableAnswerFeedback: pulumi.Bool(false),
	},
})

    var cxAgentResource = new CxAgent("cxAgentResource", CxAgentArgs.builder()
    .defaultLanguageCode("string")
    .timeZone("string")
    .location("string")
    .displayName("string")
    .avatarUri("string")
    .description("string")
    .clientCertificateSettings(CxAgentClientCertificateSettingsArgs.builder()
        .privateKey("string")
        .sslCertificate("string")
        .passphrase("string")
        .build())
    .enableMultiLanguageTraining(false)
    .enableSpellCorrection(false)
    .advancedSettings(CxAgentAdvancedSettingsArgs.builder()
        .audioExportGcsDestination(CxAgentAdvancedSettingsAudioExportGcsDestinationArgs.builder()
            .uri("string")
            .build())
        .dtmfSettings(CxAgentAdvancedSettingsDtmfSettingsArgs.builder()
            .enabled(false)
            .finishDigit("string")
            .maxDigits(0)
            .build())
        .loggingSettings(CxAgentAdvancedSettingsLoggingSettingsArgs.builder()
            .enableConsentBasedRedaction(false)
            .enableInteractionLogging(false)
            .enableStackdriverLogging(false)
            .build())
        .speechSettings(CxAgentAdvancedSettingsSpeechSettingsArgs.builder()
            .endpointerSensitivity(0)
            .models(Map.of("string", "string"))
            .noSpeechTimeout("string")
            .useTimeoutBasedEndpointing(false)
            .build())
        .build())
    .genAppBuilderSettings(CxAgentGenAppBuilderSettingsArgs.builder()
        .engine("string")
        .build())
    .gitIntegrationSettings(CxAgentGitIntegrationSettingsArgs.builder()
        .githubSettings(CxAgentGitIntegrationSettingsGithubSettingsArgs.builder()
            .accessToken("string")
            .branches("string")
            .displayName("string")
            .repositoryUri("string")
            .trackingBranch("string")
            .build())
        .build())
    .deleteChatEngineOnDestroy(false)
    .locked(false)
    .personalizationSettings(CxAgentPersonalizationSettingsArgs.builder()
        .defaultEndUserMetadata("string")
        .build())
    .project("string")
    .securitySettings("string")
    .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
        .enableSpeechAdaptation(false)
        .build())
    .startPlaybook("string")
    .supportedLanguageCodes("string")
    .textToSpeechSettings(CxAgentTextToSpeechSettingsArgs.builder()
        .synthesizeSpeechConfigs("string")
        .build())
    .answerFeedbackSettings(CxAgentAnswerFeedbackSettingsArgs.builder()
        .enableAnswerFeedback(false)
        .build())
    .build());

    cx_agent_resource = gcp.diagflow.CxAgent("cxAgentResource",
    default_language_code="string",
    time_zone="string",
    location="string",
    display_name="string",
    avatar_uri="string",
    description="string",
    client_certificate_settings={
        "private_key": "string",
        "ssl_certificate": "string",
        "passphrase": "string",
    },
    enable_multi_language_training=False,
    enable_spell_correction=False,
    advanced_settings={
        "audio_export_gcs_destination": {
            "uri": "string",
        },
        "dtmf_settings": {
            "enabled": False,
            "finish_digit": "string",
            "max_digits": 0,
        },
        "logging_settings": {
            "enable_consent_based_redaction": False,
            "enable_interaction_logging": False,
            "enable_stackdriver_logging": False,
        },
        "speech_settings": {
            "endpointer_sensitivity": 0,
            "models": {
                "string": "string",
            },
            "no_speech_timeout": "string",
            "use_timeout_based_endpointing": False,
        },
    },
    gen_app_builder_settings={
        "engine": "string",
    },
    git_integration_settings={
        "github_settings": {
            "access_token": "string",
            "branches": ["string"],
            "display_name": "string",
            "repository_uri": "string",
            "tracking_branch": "string",
        },
    },
    delete_chat_engine_on_destroy=False,
    locked=False,
    personalization_settings={
        "default_end_user_metadata": "string",
    },
    project="string",
    security_settings="string",
    speech_to_text_settings={
        "enable_speech_adaptation": False,
    },
    start_playbook="string",
    supported_language_codes=["string"],
    text_to_speech_settings={
        "synthesize_speech_configs": "string",
    },
    answer_feedback_settings={
        "enable_answer_feedback": False,
    })

    const cxAgentResource = new gcp.diagflow.CxAgent("cxAgentResource", {
    defaultLanguageCode: "string",
    timeZone: "string",
    location: "string",
    displayName: "string",
    avatarUri: "string",
    description: "string",
    clientCertificateSettings: {
        privateKey: "string",
        sslCertificate: "string",
        passphrase: "string",
    },
    enableMultiLanguageTraining: false,
    enableSpellCorrection: false,
    advancedSettings: {
        audioExportGcsDestination: {
            uri: "string",
        },
        dtmfSettings: {
            enabled: false,
            finishDigit: "string",
            maxDigits: 0,
        },
        loggingSettings: {
            enableConsentBasedRedaction: false,
            enableInteractionLogging: false,
            enableStackdriverLogging: false,
        },
        speechSettings: {
            endpointerSensitivity: 0,
            models: {
                string: "string",
            },
            noSpeechTimeout: "string",
            useTimeoutBasedEndpointing: false,
        },
    },
    genAppBuilderSettings: {
        engine: "string",
    },
    gitIntegrationSettings: {
        githubSettings: {
            accessToken: "string",
            branches: ["string"],
            displayName: "string",
            repositoryUri: "string",
            trackingBranch: "string",
        },
    },
    deleteChatEngineOnDestroy: false,
    locked: false,
    personalizationSettings: {
        defaultEndUserMetadata: "string",
    },
    project: "string",
    securitySettings: "string",
    speechToTextSettings: {
        enableSpeechAdaptation: false,
    },
    startPlaybook: "string",
    supportedLanguageCodes: ["string"],
    textToSpeechSettings: {
        synthesizeSpeechConfigs: "string",
    },
    answerFeedbackSettings: {
        enableAnswerFeedback: false,
    },
});

    type: gcp:diagflow:CxAgent
properties:
    advancedSettings:
        audioExportGcsDestination:
            uri: string
        dtmfSettings:
            enabled: false
            finishDigit: string
            maxDigits: 0
        loggingSettings:
            enableConsentBasedRedaction: false
            enableInteractionLogging: false
            enableStackdriverLogging: false
        speechSettings:
            endpointerSensitivity: 0
            models:
                string: string
            noSpeechTimeout: string
            useTimeoutBasedEndpointing: false
    answerFeedbackSettings:
        enableAnswerFeedback: false
    avatarUri: string
    clientCertificateSettings:
        passphrase: string
        privateKey: string
        sslCertificate: string
    defaultLanguageCode: string
    deleteChatEngineOnDestroy: false
    description: string
    displayName: string
    enableMultiLanguageTraining: false
    enableSpellCorrection: false
    genAppBuilderSettings:
        engine: string
    gitIntegrationSettings:
        githubSettings:
            accessToken: string
            branches:
                - string
            displayName: string
            repositoryUri: string
            trackingBranch: string
    location: string
    locked: false
    personalizationSettings:
        defaultEndUserMetadata: string
    project: string
    securitySettings: string
    speechToTextSettings:
        enableSpeechAdaptation: false
    startPlaybook: string
    supportedLanguageCodes:
        - string
    textToSpeechSettings:
        synthesizeSpeechConfigs: string
    timeZone: string

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

    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    DisplayName string
    The human-readable name of the agent, unique within the location.
    Location string

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    AdvancedSettings CxAgentAdvancedSettings
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    AnswerFeedbackSettings CxAgentAnswerFeedbackSettings
    Answer feedback collection settings. Structure is documented below.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    ClientCertificateSettings CxAgentClientCertificateSettings
    Settings for custom client certificates. Structure is documented below.
    DeleteChatEngineOnDestroy bool
    Description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    EnableMultiLanguageTraining bool
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    GenAppBuilderSettings CxAgentGenAppBuilderSettings
    Gen App Builder-related agent-level settings. Structure is documented below.
    GitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. Structure is documented below.
    Locked bool
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    PersonalizationSettings CxAgentPersonalizationSettings
    Settings for end user personalization. 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.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    SpeechToTextSettings CxAgentSpeechToTextSettings
    Settings related to speech recognition. Structure is documented below.
    StartPlaybook string
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    SupportedLanguageCodes List<string>
    The list of all languages supported by this agent (except for the default_language_code).
    TextToSpeechSettings CxAgentTextToSpeechSettings
    Settings related to speech synthesizing. Structure is documented below.
    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    DisplayName string
    The human-readable name of the agent, unique within the location.
    Location string

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    AdvancedSettings CxAgentAdvancedSettingsArgs
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    AnswerFeedbackSettings CxAgentAnswerFeedbackSettingsArgs
    Answer feedback collection settings. Structure is documented below.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    ClientCertificateSettings CxAgentClientCertificateSettingsArgs
    Settings for custom client certificates. Structure is documented below.
    DeleteChatEngineOnDestroy bool
    Description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    EnableMultiLanguageTraining bool
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    GenAppBuilderSettings CxAgentGenAppBuilderSettingsArgs
    Gen App Builder-related agent-level settings. Structure is documented below.
    GitIntegrationSettings CxAgentGitIntegrationSettingsArgs
    Git integration settings for this agent. Structure is documented below.
    Locked bool
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    PersonalizationSettings CxAgentPersonalizationSettingsArgs
    Settings for end user personalization. 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.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    SpeechToTextSettings CxAgentSpeechToTextSettingsArgs
    Settings related to speech recognition. Structure is documented below.
    StartPlaybook string
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    SupportedLanguageCodes []string
    The list of all languages supported by this agent (except for the default_language_code).
    TextToSpeechSettings CxAgentTextToSpeechSettingsArgs
    Settings related to speech synthesizing. Structure is documented below.
    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    displayName String
    The human-readable name of the agent, unique within the location.
    location String

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    timeZone String
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advancedSettings CxAgentAdvancedSettings
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answerFeedbackSettings CxAgentAnswerFeedbackSettings
    Answer feedback collection settings. Structure is documented below.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    clientCertificateSettings CxAgentClientCertificateSettings
    Settings for custom client certificates. Structure is documented below.
    deleteChatEngineOnDestroy Boolean
    description String
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enableMultiLanguageTraining Boolean
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    genAppBuilderSettings CxAgentGenAppBuilderSettings
    Gen App Builder-related agent-level settings. Structure is documented below.
    gitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. Structure is documented below.
    locked Boolean
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    personalizationSettings CxAgentPersonalizationSettings
    Settings for end user personalization. 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.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speechToTextSettings CxAgentSpeechToTextSettings
    Settings related to speech recognition. Structure is documented below.
    startPlaybook String
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supportedLanguageCodes List<String>
    The list of all languages supported by this agent (except for the default_language_code).
    textToSpeechSettings CxAgentTextToSpeechSettings
    Settings related to speech synthesizing. Structure is documented below.
    defaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    displayName string
    The human-readable name of the agent, unique within the location.
    location string

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    timeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advancedSettings CxAgentAdvancedSettings
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answerFeedbackSettings CxAgentAnswerFeedbackSettings
    Answer feedback collection settings. Structure is documented below.
    avatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    clientCertificateSettings CxAgentClientCertificateSettings
    Settings for custom client certificates. Structure is documented below.
    deleteChatEngineOnDestroy boolean
    description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enableMultiLanguageTraining boolean
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enableSpellCorrection boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging boolean

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    genAppBuilderSettings CxAgentGenAppBuilderSettings
    Gen App Builder-related agent-level settings. Structure is documented below.
    gitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. Structure is documented below.
    locked boolean
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    personalizationSettings CxAgentPersonalizationSettings
    Settings for end user personalization. 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.
    securitySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speechToTextSettings CxAgentSpeechToTextSettings
    Settings related to speech recognition. Structure is documented below.
    startPlaybook string
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supportedLanguageCodes string[]
    The list of all languages supported by this agent (except for the default_language_code).
    textToSpeechSettings CxAgentTextToSpeechSettings
    Settings related to speech synthesizing. Structure is documented below.
    default_language_code str
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    display_name str
    The human-readable name of the agent, unique within the location.
    location str

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    time_zone str
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advanced_settings CxAgentAdvancedSettingsArgs
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answer_feedback_settings CxAgentAnswerFeedbackSettingsArgs
    Answer feedback collection settings. Structure is documented below.
    avatar_uri str
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    client_certificate_settings CxAgentClientCertificateSettingsArgs
    Settings for custom client certificates. Structure is documented below.
    delete_chat_engine_on_destroy bool
    description str
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enable_multi_language_training bool
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enable_spell_correction bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    enable_stackdriver_logging bool

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    gen_app_builder_settings CxAgentGenAppBuilderSettingsArgs
    Gen App Builder-related agent-level settings. Structure is documented below.
    git_integration_settings CxAgentGitIntegrationSettingsArgs
    Git integration settings for this agent. Structure is documented below.
    locked bool
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    personalization_settings CxAgentPersonalizationSettingsArgs
    Settings for end user personalization. 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.
    security_settings str
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speech_to_text_settings CxAgentSpeechToTextSettingsArgs
    Settings related to speech recognition. Structure is documented below.
    start_playbook str
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supported_language_codes Sequence[str]
    The list of all languages supported by this agent (except for the default_language_code).
    text_to_speech_settings CxAgentTextToSpeechSettingsArgs
    Settings related to speech synthesizing. Structure is documented below.
    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    displayName String
    The human-readable name of the agent, unique within the location.
    location String

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    timeZone String
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advancedSettings Property Map
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answerFeedbackSettings Property Map
    Answer feedback collection settings. Structure is documented below.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    clientCertificateSettings Property Map
    Settings for custom client certificates. Structure is documented below.
    deleteChatEngineOnDestroy Boolean
    description String
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enableMultiLanguageTraining Boolean
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    genAppBuilderSettings Property Map
    Gen App Builder-related agent-level settings. Structure is documented below.
    gitIntegrationSettings Property Map
    Git integration settings for this agent. Structure is documented below.
    locked Boolean
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    personalizationSettings Property Map
    Settings for end user personalization. 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.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speechToTextSettings Property Map
    Settings related to speech recognition. Structure is documented below.
    startPlaybook String
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supportedLanguageCodes List<String>
    The list of all languages supported by this agent (except for the default_language_code).
    textToSpeechSettings Property Map
    Settings related to speech synthesizing. Structure is documented below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the agent.
    SatisfiesPzi bool
    A read only boolean field reflecting Zone Isolation status of the agent.
    SatisfiesPzs bool
    A read only boolean field reflecting Zone Separation status of the agent.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of the agent.
    SatisfiesPzi bool
    A read only boolean field reflecting Zone Isolation status of the agent.
    SatisfiesPzs bool
    A read only boolean field reflecting Zone Separation status of the agent.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the agent.
    satisfiesPzi Boolean
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfiesPzs Boolean
    A read only boolean field reflecting Zone Separation status of the agent.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique identifier of the agent.
    satisfiesPzi boolean
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfiesPzs boolean
    A read only boolean field reflecting Zone Separation status of the agent.
    startFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique identifier of the agent.
    satisfies_pzi bool
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfies_pzs bool
    A read only boolean field reflecting Zone Separation status of the agent.
    start_flow str
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of the agent.
    satisfiesPzi Boolean
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfiesPzs Boolean
    A read only boolean field reflecting Zone Separation status of the agent.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

    Look up Existing CxAgent Resource

    Get an existing CxAgent 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?: CxAgentState, opts?: CustomResourceOptions): CxAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advanced_settings: Optional[CxAgentAdvancedSettingsArgs] = None,
        answer_feedback_settings: Optional[CxAgentAnswerFeedbackSettingsArgs] = None,
        avatar_uri: Optional[str] = None,
        client_certificate_settings: Optional[CxAgentClientCertificateSettingsArgs] = None,
        default_language_code: Optional[str] = None,
        delete_chat_engine_on_destroy: Optional[bool] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enable_multi_language_training: Optional[bool] = None,
        enable_spell_correction: Optional[bool] = None,
        enable_stackdriver_logging: Optional[bool] = None,
        gen_app_builder_settings: Optional[CxAgentGenAppBuilderSettingsArgs] = None,
        git_integration_settings: Optional[CxAgentGitIntegrationSettingsArgs] = None,
        location: Optional[str] = None,
        locked: Optional[bool] = None,
        name: Optional[str] = None,
        personalization_settings: Optional[CxAgentPersonalizationSettingsArgs] = None,
        project: Optional[str] = None,
        satisfies_pzi: Optional[bool] = None,
        satisfies_pzs: Optional[bool] = None,
        security_settings: Optional[str] = None,
        speech_to_text_settings: Optional[CxAgentSpeechToTextSettingsArgs] = None,
        start_flow: Optional[str] = None,
        start_playbook: Optional[str] = None,
        supported_language_codes: Optional[Sequence[str]] = None,
        text_to_speech_settings: Optional[CxAgentTextToSpeechSettingsArgs] = None,
        time_zone: Optional[str] = None) -> CxAgent
    func GetCxAgent(ctx *Context, name string, id IDInput, state *CxAgentState, opts ...ResourceOption) (*CxAgent, error)
    public static CxAgent Get(string name, Input<string> id, CxAgentState? state, CustomResourceOptions? opts = null)
    public static CxAgent get(String name, Output<String> id, CxAgentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:diagflow:CxAgent    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:
    AdvancedSettings CxAgentAdvancedSettings
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    AnswerFeedbackSettings CxAgentAnswerFeedbackSettings
    Answer feedback collection settings. Structure is documented below.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    ClientCertificateSettings CxAgentClientCertificateSettings
    Settings for custom client certificates. Structure is documented below.
    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    DeleteChatEngineOnDestroy bool
    Description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    DisplayName string
    The human-readable name of the agent, unique within the location.
    EnableMultiLanguageTraining bool
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    GenAppBuilderSettings CxAgentGenAppBuilderSettings
    Gen App Builder-related agent-level settings. Structure is documented below.
    GitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. Structure is documented below.
    Location string

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    Locked bool
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    Name string
    The unique identifier of the agent.
    PersonalizationSettings CxAgentPersonalizationSettings
    Settings for end user personalization. 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.
    SatisfiesPzi bool
    A read only boolean field reflecting Zone Isolation status of the agent.
    SatisfiesPzs bool
    A read only boolean field reflecting Zone Separation status of the agent.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    SpeechToTextSettings CxAgentSpeechToTextSettings
    Settings related to speech recognition. Structure is documented below.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    StartPlaybook string
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    SupportedLanguageCodes List<string>
    The list of all languages supported by this agent (except for the default_language_code).
    TextToSpeechSettings CxAgentTextToSpeechSettings
    Settings related to speech synthesizing. Structure is documented below.
    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    AdvancedSettings CxAgentAdvancedSettingsArgs
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    AnswerFeedbackSettings CxAgentAnswerFeedbackSettingsArgs
    Answer feedback collection settings. Structure is documented below.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    ClientCertificateSettings CxAgentClientCertificateSettingsArgs
    Settings for custom client certificates. Structure is documented below.
    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    DeleteChatEngineOnDestroy bool
    Description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    DisplayName string
    The human-readable name of the agent, unique within the location.
    EnableMultiLanguageTraining bool
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    GenAppBuilderSettings CxAgentGenAppBuilderSettingsArgs
    Gen App Builder-related agent-level settings. Structure is documented below.
    GitIntegrationSettings CxAgentGitIntegrationSettingsArgs
    Git integration settings for this agent. Structure is documented below.
    Location string

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    Locked bool
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    Name string
    The unique identifier of the agent.
    PersonalizationSettings CxAgentPersonalizationSettingsArgs
    Settings for end user personalization. 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.
    SatisfiesPzi bool
    A read only boolean field reflecting Zone Isolation status of the agent.
    SatisfiesPzs bool
    A read only boolean field reflecting Zone Separation status of the agent.
    SecuritySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    SpeechToTextSettings CxAgentSpeechToTextSettingsArgs
    Settings related to speech recognition. Structure is documented below.
    StartFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    StartPlaybook string
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    SupportedLanguageCodes []string
    The list of all languages supported by this agent (except for the default_language_code).
    TextToSpeechSettings CxAgentTextToSpeechSettingsArgs
    Settings related to speech synthesizing. Structure is documented below.
    TimeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advancedSettings CxAgentAdvancedSettings
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answerFeedbackSettings CxAgentAnswerFeedbackSettings
    Answer feedback collection settings. Structure is documented below.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    clientCertificateSettings CxAgentClientCertificateSettings
    Settings for custom client certificates. Structure is documented below.
    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    deleteChatEngineOnDestroy Boolean
    description String
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    displayName String
    The human-readable name of the agent, unique within the location.
    enableMultiLanguageTraining Boolean
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    genAppBuilderSettings CxAgentGenAppBuilderSettings
    Gen App Builder-related agent-level settings. Structure is documented below.
    gitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. Structure is documented below.
    location String

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    locked Boolean
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    name String
    The unique identifier of the agent.
    personalizationSettings CxAgentPersonalizationSettings
    Settings for end user personalization. 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.
    satisfiesPzi Boolean
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfiesPzs Boolean
    A read only boolean field reflecting Zone Separation status of the agent.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speechToTextSettings CxAgentSpeechToTextSettings
    Settings related to speech recognition. Structure is documented below.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    startPlaybook String
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supportedLanguageCodes List<String>
    The list of all languages supported by this agent (except for the default_language_code).
    textToSpeechSettings CxAgentTextToSpeechSettings
    Settings related to speech synthesizing. Structure is documented below.
    timeZone String
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advancedSettings CxAgentAdvancedSettings
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answerFeedbackSettings CxAgentAnswerFeedbackSettings
    Answer feedback collection settings. Structure is documented below.
    avatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    clientCertificateSettings CxAgentClientCertificateSettings
    Settings for custom client certificates. Structure is documented below.
    defaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    deleteChatEngineOnDestroy boolean
    description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    displayName string
    The human-readable name of the agent, unique within the location.
    enableMultiLanguageTraining boolean
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enableSpellCorrection boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging boolean

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    genAppBuilderSettings CxAgentGenAppBuilderSettings
    Gen App Builder-related agent-level settings. Structure is documented below.
    gitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. Structure is documented below.
    location string

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    locked boolean
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    name string
    The unique identifier of the agent.
    personalizationSettings CxAgentPersonalizationSettings
    Settings for end user personalization. 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.
    satisfiesPzi boolean
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfiesPzs boolean
    A read only boolean field reflecting Zone Separation status of the agent.
    securitySettings string
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speechToTextSettings CxAgentSpeechToTextSettings
    Settings related to speech recognition. Structure is documented below.
    startFlow string
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    startPlaybook string
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supportedLanguageCodes string[]
    The list of all languages supported by this agent (except for the default_language_code).
    textToSpeechSettings CxAgentTextToSpeechSettings
    Settings related to speech synthesizing. Structure is documented below.
    timeZone string
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advanced_settings CxAgentAdvancedSettingsArgs
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answer_feedback_settings CxAgentAnswerFeedbackSettingsArgs
    Answer feedback collection settings. Structure is documented below.
    avatar_uri str
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    client_certificate_settings CxAgentClientCertificateSettingsArgs
    Settings for custom client certificates. Structure is documented below.
    default_language_code str
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    delete_chat_engine_on_destroy bool
    description str
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    display_name str
    The human-readable name of the agent, unique within the location.
    enable_multi_language_training bool
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enable_spell_correction bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    enable_stackdriver_logging bool

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    gen_app_builder_settings CxAgentGenAppBuilderSettingsArgs
    Gen App Builder-related agent-level settings. Structure is documented below.
    git_integration_settings CxAgentGitIntegrationSettingsArgs
    Git integration settings for this agent. Structure is documented below.
    location str

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    locked bool
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    name str
    The unique identifier of the agent.
    personalization_settings CxAgentPersonalizationSettingsArgs
    Settings for end user personalization. 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.
    satisfies_pzi bool
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfies_pzs bool
    A read only boolean field reflecting Zone Separation status of the agent.
    security_settings str
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speech_to_text_settings CxAgentSpeechToTextSettingsArgs
    Settings related to speech recognition. Structure is documented below.
    start_flow str
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    start_playbook str
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supported_language_codes Sequence[str]
    The list of all languages supported by this agent (except for the default_language_code).
    text_to_speech_settings CxAgentTextToSpeechSettingsArgs
    Settings related to speech synthesizing. Structure is documented below.
    time_zone str
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
    advancedSettings Property Map
    Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.
    answerFeedbackSettings Property Map
    Answer feedback collection settings. Structure is documented below.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    clientCertificateSettings Property Map
    Settings for custom client certificates. Structure is documented below.
    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.
    deleteChatEngineOnDestroy Boolean
    description String
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    displayName String
    The human-readable name of the agent, unique within the location.
    enableMultiLanguageTraining Boolean
    Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean

    (Optional, Deprecated) Determines whether this agent should log conversation queries.

    Warning: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    Deprecated: enable_stackdriver_logging is deprecated and will be removed in a future major release. Please use advanced_settings.logging_settings.enable_stackdriver_logginginstead.

    genAppBuilderSettings Property Map
    Gen App Builder-related agent-level settings. Structure is documented below.
    gitIntegrationSettings Property Map
    Git integration settings for this agent. Structure is documented below.
    location String

    The name of the location this agent is located in.

    Note: The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only configure location settings via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings.

    locked Boolean
    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [agents.restore][].
    name String
    The unique identifier of the agent.
    personalizationSettings Property Map
    Settings for end user personalization. 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.
    satisfiesPzi Boolean
    A read only boolean field reflecting Zone Isolation status of the agent.
    satisfiesPzs Boolean
    A read only boolean field reflecting Zone Separation status of the agent.
    securitySettings String
    Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
    speechToTextSettings Property Map
    Settings related to speech recognition. Structure is documented below.
    startFlow String
    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
    startPlaybook String
    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
    supportedLanguageCodes List<String>
    The list of all languages supported by this agent (except for the default_language_code).
    textToSpeechSettings Property Map
    Settings related to speech synthesizing. Structure is documented below.
    timeZone String
    The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

    Supporting Types

    CxAgentAdvancedSettings, CxAgentAdvancedSettingsArgs

    AudioExportGcsDestination CxAgentAdvancedSettingsAudioExportGcsDestination
    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

    • Agent level
    • Flow level Structure is documented below.
    DtmfSettings CxAgentAdvancedSettingsDtmfSettings
    Define behaviors for DTMF (dual tone multi frequency). DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    LoggingSettings CxAgentAdvancedSettingsLoggingSettings
    Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels:

    • Agent level Structure is documented below.
    SpeechSettings CxAgentAdvancedSettingsSpeechSettings
    Settings for speech to text detection. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    AudioExportGcsDestination CxAgentAdvancedSettingsAudioExportGcsDestination
    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

    • Agent level
    • Flow level Structure is documented below.
    DtmfSettings CxAgentAdvancedSettingsDtmfSettings
    Define behaviors for DTMF (dual tone multi frequency). DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    LoggingSettings CxAgentAdvancedSettingsLoggingSettings
    Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels:

    • Agent level Structure is documented below.
    SpeechSettings CxAgentAdvancedSettingsSpeechSettings
    Settings for speech to text detection. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    audioExportGcsDestination CxAgentAdvancedSettingsAudioExportGcsDestination
    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

    • Agent level
    • Flow level Structure is documented below.
    dtmfSettings CxAgentAdvancedSettingsDtmfSettings
    Define behaviors for DTMF (dual tone multi frequency). DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    loggingSettings CxAgentAdvancedSettingsLoggingSettings
    Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels:

    • Agent level Structure is documented below.
    speechSettings CxAgentAdvancedSettingsSpeechSettings
    Settings for speech to text detection. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    audioExportGcsDestination CxAgentAdvancedSettingsAudioExportGcsDestination
    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

    • Agent level
    • Flow level Structure is documented below.
    dtmfSettings CxAgentAdvancedSettingsDtmfSettings
    Define behaviors for DTMF (dual tone multi frequency). DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    loggingSettings CxAgentAdvancedSettingsLoggingSettings
    Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels:

    • Agent level Structure is documented below.
    speechSettings CxAgentAdvancedSettingsSpeechSettings
    Settings for speech to text detection. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    audio_export_gcs_destination CxAgentAdvancedSettingsAudioExportGcsDestination
    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

    • Agent level
    • Flow level Structure is documented below.
    dtmf_settings CxAgentAdvancedSettingsDtmfSettings
    Define behaviors for DTMF (dual tone multi frequency). DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    logging_settings CxAgentAdvancedSettingsLoggingSettings
    Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels:

    • Agent level Structure is documented below.
    speech_settings CxAgentAdvancedSettingsSpeechSettings
    Settings for speech to text detection. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    audioExportGcsDestination Property Map
    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

    • Agent level
    • Flow level Structure is documented below.
    dtmfSettings Property Map
    Define behaviors for DTMF (dual tone multi frequency). DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.
    loggingSettings Property Map
    Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels:

    • Agent level Structure is documented below.
    speechSettings Property Map
    Settings for speech to text detection. Exposed at the following levels:

    • Agent level
    • Flow level
    • Page level
    • Parameter level Structure is documented below.

    CxAgentAdvancedSettingsAudioExportGcsDestination, CxAgentAdvancedSettingsAudioExportGcsDestinationArgs

    Uri string
    The Google Cloud Storage URI for the exported objects. Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. Format: gs://bucket/object-name-or-prefix
    Uri string
    The Google Cloud Storage URI for the exported objects. Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. Format: gs://bucket/object-name-or-prefix
    uri String
    The Google Cloud Storage URI for the exported objects. Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. Format: gs://bucket/object-name-or-prefix
    uri string
    The Google Cloud Storage URI for the exported objects. Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. Format: gs://bucket/object-name-or-prefix
    uri str
    The Google Cloud Storage URI for the exported objects. Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. Format: gs://bucket/object-name-or-prefix
    uri String
    The Google Cloud Storage URI for the exported objects. Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. Format: gs://bucket/object-name-or-prefix

    CxAgentAdvancedSettingsDtmfSettings, CxAgentAdvancedSettingsDtmfSettingsArgs

    Enabled bool
    If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
    FinishDigit string
    The digit that terminates a DTMF digit sequence.
    MaxDigits int
    Max length of DTMF digits.
    Enabled bool
    If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
    FinishDigit string
    The digit that terminates a DTMF digit sequence.
    MaxDigits int
    Max length of DTMF digits.
    enabled Boolean
    If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
    finishDigit String
    The digit that terminates a DTMF digit sequence.
    maxDigits Integer
    Max length of DTMF digits.
    enabled boolean
    If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
    finishDigit string
    The digit that terminates a DTMF digit sequence.
    maxDigits number
    Max length of DTMF digits.
    enabled bool
    If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
    finish_digit str
    The digit that terminates a DTMF digit sequence.
    max_digits int
    Max length of DTMF digits.
    enabled Boolean
    If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
    finishDigit String
    The digit that terminates a DTMF digit sequence.
    maxDigits Number
    Max length of DTMF digits.

    CxAgentAdvancedSettingsLoggingSettings, CxAgentAdvancedSettingsLoggingSettingsArgs

    EnableConsentBasedRedaction bool
    Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.
    EnableInteractionLogging bool
    Enables DF Interaction logging.
    EnableStackdriverLogging bool
    Enables Google Cloud Logging.
    EnableConsentBasedRedaction bool
    Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.
    EnableInteractionLogging bool
    Enables DF Interaction logging.
    EnableStackdriverLogging bool
    Enables Google Cloud Logging.
    enableConsentBasedRedaction Boolean
    Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.
    enableInteractionLogging Boolean
    Enables DF Interaction logging.
    enableStackdriverLogging Boolean
    Enables Google Cloud Logging.
    enableConsentBasedRedaction boolean
    Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.
    enableInteractionLogging boolean
    Enables DF Interaction logging.
    enableStackdriverLogging boolean
    Enables Google Cloud Logging.
    enable_consent_based_redaction bool
    Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.
    enable_interaction_logging bool
    Enables DF Interaction logging.
    enable_stackdriver_logging bool
    Enables Google Cloud Logging.
    enableConsentBasedRedaction Boolean
    Enables consent-based end-user input redaction, if true, a pre-defined session parameter $session.params.conversation-redaction will be used to determine if the utterance should be redacted.
    enableInteractionLogging Boolean
    Enables DF Interaction logging.
    enableStackdriverLogging Boolean
    Enables Google Cloud Logging.

    CxAgentAdvancedSettingsSpeechSettings, CxAgentAdvancedSettingsSpeechSettingsArgs

    EndpointerSensitivity int
    Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
    Models Dictionary<string, string>
    Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    NoSpeechTimeout string
    Timeout before detecting no speech. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    UseTimeoutBasedEndpointing bool
    Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    EndpointerSensitivity int
    Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
    Models map[string]string
    Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    NoSpeechTimeout string
    Timeout before detecting no speech. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    UseTimeoutBasedEndpointing bool
    Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    endpointerSensitivity Integer
    Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
    models Map<String,String>
    Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    noSpeechTimeout String
    Timeout before detecting no speech. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    useTimeoutBasedEndpointing Boolean
    Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    endpointerSensitivity number
    Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
    models {[key: string]: string}
    Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    noSpeechTimeout string
    Timeout before detecting no speech. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    useTimeoutBasedEndpointing boolean
    Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    endpointer_sensitivity int
    Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
    models Mapping[str, str]
    Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    no_speech_timeout str
    Timeout before detecting no speech. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    use_timeout_based_endpointing bool
    Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    endpointerSensitivity Number
    Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
    models Map<String>
    Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see Speech models. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
    noSpeechTimeout String
    Timeout before detecting no speech. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    useTimeoutBasedEndpointing Boolean
    Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.

    CxAgentAnswerFeedbackSettings, CxAgentAnswerFeedbackSettingsArgs

    EnableAnswerFeedback bool
    If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
    EnableAnswerFeedback bool
    If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
    enableAnswerFeedback Boolean
    If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
    enableAnswerFeedback boolean
    If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
    enable_answer_feedback bool
    If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
    enableAnswerFeedback Boolean
    If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.

    CxAgentClientCertificateSettings, CxAgentClientCertificateSettingsArgs

    PrivateKey string
    The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
    SslCertificate string
    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
    Passphrase string
    The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}
    PrivateKey string
    The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
    SslCertificate string
    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
    Passphrase string
    The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}
    privateKey String
    The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
    sslCertificate String
    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
    passphrase String
    The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}
    privateKey string
    The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
    sslCertificate string
    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
    passphrase string
    The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}
    private_key str
    The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
    ssl_certificate str
    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
    passphrase str
    The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}
    privateKey String
    The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
    sslCertificate String
    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines.
    passphrase String
    The name of the SecretManager secret version resource storing the passphrase. 'passphrase' should be left unset if the private key is not encrypted. Format: projects/{project}/secrets/{secret}/versions/{version}

    CxAgentGenAppBuilderSettings, CxAgentGenAppBuilderSettingsArgs

    Engine string
    The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}
    Engine string
    The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}
    engine String
    The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}
    engine string
    The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}
    engine str
    The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}
    engine String
    The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}

    CxAgentGitIntegrationSettings, CxAgentGitIntegrationSettingsArgs

    GithubSettings CxAgentGitIntegrationSettingsGithubSettings
    Settings of integration with GitHub. Structure is documented below.
    GithubSettings CxAgentGitIntegrationSettingsGithubSettings
    Settings of integration with GitHub. Structure is documented below.
    githubSettings CxAgentGitIntegrationSettingsGithubSettings
    Settings of integration with GitHub. Structure is documented below.
    githubSettings CxAgentGitIntegrationSettingsGithubSettings
    Settings of integration with GitHub. Structure is documented below.
    github_settings CxAgentGitIntegrationSettingsGithubSettings
    Settings of integration with GitHub. Structure is documented below.
    githubSettings Property Map
    Settings of integration with GitHub. Structure is documented below.

    CxAgentGitIntegrationSettingsGithubSettings, CxAgentGitIntegrationSettingsGithubSettingsArgs

    AccessToken string
    The access token used to authenticate the access to the GitHub repository. Note: This property is sensitive and will not be displayed in the plan.
    Branches List<string>
    A list of branches configured to be used from Dialogflow.
    DisplayName string
    The unique repository display name for the GitHub repository.
    RepositoryUri string
    The GitHub repository URI related to the agent.
    TrackingBranch string
    The branch of the GitHub repository tracked for this agent.
    AccessToken string
    The access token used to authenticate the access to the GitHub repository. Note: This property is sensitive and will not be displayed in the plan.
    Branches []string
    A list of branches configured to be used from Dialogflow.
    DisplayName string
    The unique repository display name for the GitHub repository.
    RepositoryUri string
    The GitHub repository URI related to the agent.
    TrackingBranch string
    The branch of the GitHub repository tracked for this agent.
    accessToken String
    The access token used to authenticate the access to the GitHub repository. Note: This property is sensitive and will not be displayed in the plan.
    branches List<String>
    A list of branches configured to be used from Dialogflow.
    displayName String
    The unique repository display name for the GitHub repository.
    repositoryUri String
    The GitHub repository URI related to the agent.
    trackingBranch String
    The branch of the GitHub repository tracked for this agent.
    accessToken string
    The access token used to authenticate the access to the GitHub repository. Note: This property is sensitive and will not be displayed in the plan.
    branches string[]
    A list of branches configured to be used from Dialogflow.
    displayName string
    The unique repository display name for the GitHub repository.
    repositoryUri string
    The GitHub repository URI related to the agent.
    trackingBranch string
    The branch of the GitHub repository tracked for this agent.
    access_token str
    The access token used to authenticate the access to the GitHub repository. Note: This property is sensitive and will not be displayed in the plan.
    branches Sequence[str]
    A list of branches configured to be used from Dialogflow.
    display_name str
    The unique repository display name for the GitHub repository.
    repository_uri str
    The GitHub repository URI related to the agent.
    tracking_branch str
    The branch of the GitHub repository tracked for this agent.
    accessToken String
    The access token used to authenticate the access to the GitHub repository. Note: This property is sensitive and will not be displayed in the plan.
    branches List<String>
    A list of branches configured to be used from Dialogflow.
    displayName String
    The unique repository display name for the GitHub repository.
    repositoryUri String
    The GitHub repository URI related to the agent.
    trackingBranch String
    The branch of the GitHub repository tracked for this agent.

    CxAgentPersonalizationSettings, CxAgentPersonalizationSettingsArgs

    DefaultEndUserMetadata string
    Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. This field uses JSON data as a string. The value provided must be a valid JSON representation documented in Struct.
    DefaultEndUserMetadata string
    Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. This field uses JSON data as a string. The value provided must be a valid JSON representation documented in Struct.
    defaultEndUserMetadata String
    Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. This field uses JSON data as a string. The value provided must be a valid JSON representation documented in Struct.
    defaultEndUserMetadata string
    Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. This field uses JSON data as a string. The value provided must be a valid JSON representation documented in Struct.
    default_end_user_metadata str
    Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. This field uses JSON data as a string. The value provided must be a valid JSON representation documented in Struct.
    defaultEndUserMetadata String
    Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing. This field uses JSON data as a string. The value provided must be a valid JSON representation documented in Struct.

    CxAgentSpeechToTextSettings, CxAgentSpeechToTextSettingsArgs

    EnableSpeechAdaptation bool
    Whether to use speech adaptation for speech recognition.
    EnableSpeechAdaptation bool
    Whether to use speech adaptation for speech recognition.
    enableSpeechAdaptation Boolean
    Whether to use speech adaptation for speech recognition.
    enableSpeechAdaptation boolean
    Whether to use speech adaptation for speech recognition.
    enable_speech_adaptation bool
    Whether to use speech adaptation for speech recognition.
    enableSpeechAdaptation Boolean
    Whether to use speech adaptation for speech recognition.

    CxAgentTextToSpeechSettings, CxAgentTextToSpeechSettingsArgs

    SynthesizeSpeechConfigs string
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. These settings affect:

    • The phone gateway synthesize configuration set via Agent.text_to_speech_settings.
    • How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
    SynthesizeSpeechConfigs string
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. These settings affect:

    • The phone gateway synthesize configuration set via Agent.text_to_speech_settings.
    • How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
    synthesizeSpeechConfigs String
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. These settings affect:

    • The phone gateway synthesize configuration set via Agent.text_to_speech_settings.
    • How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
    synthesizeSpeechConfigs string
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. These settings affect:

    • The phone gateway synthesize configuration set via Agent.text_to_speech_settings.
    • How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
    synthesize_speech_configs str
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. These settings affect:

    • The phone gateway synthesize configuration set via Agent.text_to_speech_settings.
    • How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
    synthesizeSpeechConfigs String
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. These settings affect:

    • The phone gateway synthesize configuration set via Agent.text_to_speech_settings.
    • How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.

    Import

    Agent can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/agents/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

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

    $ pulumi import gcp:diagflow/cxAgent:CxAgent default projects/{{project}}/locations/{{location}}/agents/{{name}}

    $ pulumi import gcp:diagflow/cxAgent:CxAgent default {{project}}/{{location}}/{{name}}

    $ pulumi import gcp:diagflow/cxAgent:CxAgent default {{location}}/{{name}}

    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.3.0 published on Tuesday, Oct 7, 2025 by Pulumi
    pulumi/pulumi-gcp
      Meet Neo: Your AI Platform Teammate