Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. CxAgent
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.diagflow.CxAgent

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 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-`,
        },
        dtmfSettings: {
            enabled: true,
            maxDigits: 1,
            finishDigit: "#",
        },
    },
    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",
                },
            },
        }),
    },
});

    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-"),
        },
        "dtmf_settings": {
            "enabled": True,
            "max_digits": 1,
            "finish_digit": "#",
        },
    },
    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",
                },
            },
        }),
    })

    package main

import (
	"encoding/json"
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/diagflow"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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),
				},
				DtmfSettings: &diagflow.CxAgentAdvancedSettingsDtmfSettingsArgs{
					Enabled:     pulumi.Bool(true),
					MaxDigits:   pulumi.Int(1),
					FinishDigit: pulumi.String("#"),
				},
			},
			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),
			},
		})
		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-"),
            },
            DtmfSettings = new Gcp.Diagflow.Inputs.CxAgentAdvancedSettingsDtmfSettingsArgs
            {
                Enabled = true,
                MaxDigits = 1,
                FinishDigit = "#",
            },
        },
        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",
                    },
                },
            }),
        },
    });

});

    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.CxAgentAdvancedSettingsDtmfSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentGitIntegrationSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentGitIntegrationSettingsGithubSettingsArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentTextToSpeechSettingsArgs;
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())
                .dtmfSettings(CxAgentAdvancedSettingsDtmfSettingsArgs.builder()
                    .enabled(true)
                    .maxDigits(1)
                    .finishDigit("#")
                    .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())
            .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-
        dtmfSettings:
          enabled: true
          maxDigits: 1
          finishDigit: '#'
      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

    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,
            display_name: Optional[str] = None,
            time_zone: Optional[str] = None,
            default_language_code: Optional[str] = None,
            location: Optional[str] = None,
            enable_stackdriver_logging: Optional[bool] = None,
            enable_spell_correction: Optional[bool] = None,
            advanced_settings: Optional[CxAgentAdvancedSettingsArgs] = None,
            git_integration_settings: Optional[CxAgentGitIntegrationSettingsArgs] = None,
            description: Optional[str] = None,
            project: Optional[str] = None,
            security_settings: Optional[str] = None,
            speech_to_text_settings: Optional[CxAgentSpeechToTextSettingsArgs] = None,
            supported_language_codes: Optional[Sequence[str]] = None,
            text_to_speech_settings: Optional[CxAgentTextToSpeechSettingsArgs] = None,
            avatar_uri: Optional[str] = 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()
{
    DisplayName = "string",
    TimeZone = "string",
    DefaultLanguageCode = "string",
    Location = "string",
    EnableStackdriverLogging = 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,
        },
    },
    GitIntegrationSettings = new Gcp.Diagflow.Inputs.CxAgentGitIntegrationSettingsArgs
    {
        GithubSettings = new Gcp.Diagflow.Inputs.CxAgentGitIntegrationSettingsGithubSettingsArgs
        {
            AccessToken = "string",
            Branches = new[]
            {
                "string",
            },
            DisplayName = "string",
            RepositoryUri = "string",
            TrackingBranch = "string",
        },
    },
    Description = "string",
    Project = "string",
    SecuritySettings = "string",
    SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
    {
        EnableSpeechAdaptation = false,
    },
    SupportedLanguageCodes = new[]
    {
        "string",
    },
    TextToSpeechSettings = new Gcp.Diagflow.Inputs.CxAgentTextToSpeechSettingsArgs
    {
        SynthesizeSpeechConfigs = "string",
    },
    AvatarUri = "string",
});

    example, err := diagflow.NewCxAgent(ctx, "cxAgentResource", &diagflow.CxAgentArgs{
	DisplayName:              pulumi.String("string"),
	TimeZone:                 pulumi.String("string"),
	DefaultLanguageCode:      pulumi.String("string"),
	Location:                 pulumi.String("string"),
	EnableStackdriverLogging: 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),
		},
	},
	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"),
		},
	},
	Description:      pulumi.String("string"),
	Project:          pulumi.String("string"),
	SecuritySettings: pulumi.String("string"),
	SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
		EnableSpeechAdaptation: pulumi.Bool(false),
	},
	SupportedLanguageCodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	TextToSpeechSettings: &diagflow.CxAgentTextToSpeechSettingsArgs{
		SynthesizeSpeechConfigs: pulumi.String("string"),
	},
	AvatarUri: pulumi.String("string"),
})

    var cxAgentResource = new CxAgent("cxAgentResource", CxAgentArgs.builder()
    .displayName("string")
    .timeZone("string")
    .defaultLanguageCode("string")
    .location("string")
    .enableStackdriverLogging(false)
    .enableSpellCorrection(false)
    .advancedSettings(CxAgentAdvancedSettingsArgs.builder()
        .audioExportGcsDestination(CxAgentAdvancedSettingsAudioExportGcsDestinationArgs.builder()
            .uri("string")
            .build())
        .dtmfSettings(CxAgentAdvancedSettingsDtmfSettingsArgs.builder()
            .enabled(false)
            .finishDigit("string")
            .maxDigits(0)
            .build())
        .build())
    .gitIntegrationSettings(CxAgentGitIntegrationSettingsArgs.builder()
        .githubSettings(CxAgentGitIntegrationSettingsGithubSettingsArgs.builder()
            .accessToken("string")
            .branches("string")
            .displayName("string")
            .repositoryUri("string")
            .trackingBranch("string")
            .build())
        .build())
    .description("string")
    .project("string")
    .securitySettings("string")
    .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
        .enableSpeechAdaptation(false)
        .build())
    .supportedLanguageCodes("string")
    .textToSpeechSettings(CxAgentTextToSpeechSettingsArgs.builder()
        .synthesizeSpeechConfigs("string")
        .build())
    .avatarUri("string")
    .build());

    cx_agent_resource = gcp.diagflow.CxAgent("cxAgentResource",
    display_name="string",
    time_zone="string",
    default_language_code="string",
    location="string",
    enable_stackdriver_logging=False,
    enable_spell_correction=False,
    advanced_settings={
        "audioExportGcsDestination": {
            "uri": "string",
        },
        "dtmfSettings": {
            "enabled": False,
            "finishDigit": "string",
            "maxDigits": 0,
        },
    },
    git_integration_settings={
        "githubSettings": {
            "accessToken": "string",
            "branches": ["string"],
            "displayName": "string",
            "repositoryUri": "string",
            "trackingBranch": "string",
        },
    },
    description="string",
    project="string",
    security_settings="string",
    speech_to_text_settings={
        "enableSpeechAdaptation": False,
    },
    supported_language_codes=["string"],
    text_to_speech_settings={
        "synthesizeSpeechConfigs": "string",
    },
    avatar_uri="string")

    const cxAgentResource = new gcp.diagflow.CxAgent("cxAgentResource", {
    displayName: "string",
    timeZone: "string",
    defaultLanguageCode: "string",
    location: "string",
    enableStackdriverLogging: false,
    enableSpellCorrection: false,
    advancedSettings: {
        audioExportGcsDestination: {
            uri: "string",
        },
        dtmfSettings: {
            enabled: false,
            finishDigit: "string",
            maxDigits: 0,
        },
    },
    gitIntegrationSettings: {
        githubSettings: {
            accessToken: "string",
            branches: ["string"],
            displayName: "string",
            repositoryUri: "string",
            trackingBranch: "string",
        },
    },
    description: "string",
    project: "string",
    securitySettings: "string",
    speechToTextSettings: {
        enableSpeechAdaptation: false,
    },
    supportedLanguageCodes: ["string"],
    textToSpeechSettings: {
        synthesizeSpeechConfigs: "string",
    },
    avatarUri: "string",
});

    type: gcp:diagflow:CxAgent
properties:
    advancedSettings:
        audioExportGcsDestination:
            uri: string
        dtmfSettings:
            enabled: false
            finishDigit: string
            maxDigits: 0
    avatarUri: string
    defaultLanguageCode: string
    description: string
    displayName: string
    enableSpellCorrection: false
    enableStackdriverLogging: false
    gitIntegrationSettings:
        githubSettings:
            accessToken: string
            branches:
                - string
            displayName: string
            repositoryUri: string
            trackingBranch: string
    location: string
    project: string
    securitySettings: string
    speechToTextSettings:
        enableSpeechAdaptation: false
    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

    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.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    Description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    GitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. 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.
    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.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    Description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    GitIntegrationSettings CxAgentGitIntegrationSettingsArgs
    Git integration settings for this agent. 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.
    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.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    description String
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    gitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. 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.
    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.
    avatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    description string
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enableSpellCorrection boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging boolean
    Determines whether this agent should log conversation queries.
    gitIntegrationSettings CxAgentGitIntegrationSettings
    Git integration settings for this agent. 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.
    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.
    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.
    description str
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enable_spell_correction bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    enable_stackdriver_logging bool
    Determines whether this agent should log conversation queries.
    git_integration_settings CxAgentGitIntegrationSettingsArgs
    Git integration settings for this agent. 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.
    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.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    description String
    The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    gitIntegrationSettings Property Map
    Git integration settings for this agent. 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.
    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.
    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.
    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.
    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.
    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.
    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.
    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,
        avatar_uri: Optional[str] = None,
        default_language_code: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enable_spell_correction: Optional[bool] = None,
        enable_stackdriver_logging: Optional[bool] = None,
        git_integration_settings: Optional[CxAgentGitIntegrationSettingsArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        security_settings: Optional[str] = None,
        speech_to_text_settings: Optional[CxAgentSpeechToTextSettingsArgs] = None,
        start_flow: 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)
    Resource lookup is not supported in YAML
    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.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    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.
    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.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    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.

    Name string
    The unique identifier of the agent.
    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.
    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/.
    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.
    AvatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    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.
    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.
    EnableSpellCorrection bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    EnableStackdriverLogging bool
    Determines whether this agent should log conversation queries.
    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.

    Name string
    The unique identifier of the agent.
    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.
    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/.
    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.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    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.
    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.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    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.

    name String
    The unique identifier of the agent.
    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.
    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/.
    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.
    avatarUri string
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    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.
    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.
    enableSpellCorrection boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging boolean
    Determines whether this agent should log conversation queries.
    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.

    name string
    The unique identifier of the agent.
    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.
    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/.
    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.
    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.
    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.
    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_spell_correction bool
    Indicates if automatic spell correction is enabled in detect intent requests.
    enable_stackdriver_logging bool
    Determines whether this agent should log conversation queries.
    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.

    name str
    The unique identifier of the agent.
    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_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/.
    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.
    avatarUri String
    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
    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.
    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.
    enableSpellCorrection Boolean
    Indicates if automatic spell correction is enabled in detect intent requests.
    enableStackdriverLogging Boolean
    Determines whether this agent should log conversation queries.
    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.

    name String
    The unique identifier of the agent.
    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.
    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/.
    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.
    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.
    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.
    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.
    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.
    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.

    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.

    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.

    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 Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp