Docs
Packagesgcp.diagflow.CxAgent
Explore with Pulumi AI
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:
- API documentation
- How-to Guides
Example Usage
Dialogflowcx Agent Full
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()
{
Location = "US",
UniformBucketLevelAccess = true,
});
var fullAgent = new Gcp.Diagflow.CxAgent("fullAgent", 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 main
import (
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/diagflow"
"github.com/pulumi/pulumi-gcp/sdk/v7/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{
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, "fullAgent", &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
})
}
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()
.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());
}
}
import pulumi
import json
import pulumi_gcp as gcp
bucket = gcp.storage.Bucket("bucket",
location="US",
uniform_bucket_level_access=True)
full_agent = gcp.diagflow.CxAgent("fullAgent",
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=gcp.diagflow.CxAgentSpeechToTextSettingsArgs(
enable_speech_adaptation=True,
),
advanced_settings=gcp.diagflow.CxAgentAdvancedSettingsArgs(
audio_export_gcs_destination=gcp.diagflow.CxAgentAdvancedSettingsAudioExportGcsDestinationArgs(
uri=bucket.url.apply(lambda url: f"{url}/prefix-"),
),
dtmf_settings=gcp.diagflow.CxAgentAdvancedSettingsDtmfSettingsArgs(
enabled=True,
max_digits=1,
finish_digit="#",
),
),
git_integration_settings=gcp.diagflow.CxAgentGitIntegrationSettingsArgs(
github_settings=gcp.diagflow.CxAgentGitIntegrationSettingsGithubSettingsArgs(
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=gcp.diagflow.CxAgentTextToSpeechSettingsArgs(
synthesize_speech_configs=json.dumps({
"en": {
"voice": {
"name": "en-US-Neural2-A",
},
},
"fr": {
"voice": {
"name": "fr-CA-Neural2-A",
},
},
}),
))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const bucket = new gcp.storage.Bucket("bucket", {
location: "US",
uniformBucketLevelAccess: true,
});
const fullAgent = new gcp.diagflow.CxAgent("fullAgent", {
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",
},
},
}),
},
});
resources:
bucket:
type: gcp:storage:Bucket
properties:
location: US
uniformBucketLevelAccess: true
fullAgent:
type: gcp:diagflow:CxAgent
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
new CxAgent(name: string, args: CxAgentArgs, opts?: CustomResourceOptions);@overload
def CxAgent(resource_name: 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,
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,
time_zone: Optional[str] = None)
@overload
def CxAgent(resource_name: str,
args: CxAgentArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Default
Language stringCode 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 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.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Advanced
Settings CxAgent Advanced Settings 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 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.
- Enable
Spell boolCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- Enable
Stackdriver boolLogging Determines whether this agent should log conversation queries.
- Git
Integration CxSettings Agent Git Integration Settings 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.
- Security
Settings string Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- Speech
To CxText Settings Agent Speech To Text Settings Settings related to speech recognition. Structure is documented below.
- Supported
Language List<string>Codes The list of all languages supported by this agent (except for the default_language_code).
- Text
To CxSpeech Settings Agent Text To Speech Settings Settings related to speech synthesizing. Structure is documented below.
- Default
Language stringCode 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 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.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Advanced
Settings CxAgent Advanced Settings Args 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 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.
- Enable
Spell boolCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- Enable
Stackdriver boolLogging Determines whether this agent should log conversation queries.
- Git
Integration CxSettings Agent Git Integration Settings Args 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.
- Security
Settings string Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- Speech
To CxText Settings Agent Speech To Text Settings Args Settings related to speech recognition. Structure is documented below.
- Supported
Language []stringCodes The list of all languages supported by this agent (except for the default_language_code).
- Text
To CxSpeech Settings Agent Text To Speech Settings Args Settings related to speech synthesizing. Structure is documented below.
- default
Language StringCode 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 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.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced
Settings CxAgent Advanced Settings 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 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.
- enable
Spell BooleanCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable
Stackdriver BooleanLogging Determines whether this agent should log conversation queries.
- git
Integration CxSettings Agent Git Integration Settings 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.
- security
Settings String Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- speech
To CxText Settings Agent Speech To Text Settings Settings related to speech recognition. Structure is documented below.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the default_language_code).
- text
To CxSpeech Settings Agent Text To Speech Settings Settings related to speech synthesizing. Structure is documented below.
- default
Language stringCode 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 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.
- time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced
Settings CxAgent Advanced Settings 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 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.
- enable
Spell booleanCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable
Stackdriver booleanLogging Determines whether this agent should log conversation queries.
- git
Integration CxSettings Agent Git Integration Settings 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.
- security
Settings string Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- speech
To CxText Settings Agent Speech To Text Settings Settings related to speech recognition. Structure is documented below.
- supported
Language string[]Codes The list of all languages supported by this agent (except for the default_language_code).
- text
To CxSpeech Settings Agent Text To Speech Settings Settings related to speech synthesizing. Structure is documented below.
- default_
language_ strcode 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 CxAgent Advanced Settings Args 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_ boolcorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable_
stackdriver_ boollogging Determines whether this agent should log conversation queries.
- git_
integration_ Cxsettings Agent Git Integration Settings Args 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_ Cxtext_ settings Agent Speech To Text Settings Args Settings related to speech recognition. Structure is documented below.
- supported_
language_ Sequence[str]codes The list of all languages supported by this agent (except for the default_language_code).
- text_
to_ Cxspeech_ settings Agent Text To Speech Settings Args Settings related to speech synthesizing. Structure is documented below.
- default
Language StringCode 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 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.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced
Settings 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.
- avatar
Uri 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.
- enable
Spell BooleanCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable
Stackdriver BooleanLogging Determines whether this agent should log conversation queries.
- git
Integration Property MapSettings 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.
- security
Settings String Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- speech
To Property MapText Settings Settings related to speech recognition. Structure is documented below.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the default_language_code).
- text
To Property MapSpeech Settings 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.
- Start
Flow 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.
- Start
Flow 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.
- start
Flow 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.
- start
Flow 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.
- start
Flow 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) -> CxAgentfunc 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.
- Advanced
Settings CxAgent Advanced Settings 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 string The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
- Default
Language stringCode 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.
- Display
Name string The human-readable name of the agent, unique within the location.
- Enable
Spell boolCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- Enable
Stackdriver boolLogging Determines whether this agent should log conversation queries.
- Git
Integration CxSettings Agent Git Integration Settings 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.
- Security
Settings string Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- Speech
To CxText Settings Agent Speech To Text Settings Settings related to speech recognition. Structure is documented below.
- Start
Flow 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/.
- Supported
Language List<string>Codes The list of all languages supported by this agent (except for the default_language_code).
- Text
To CxSpeech Settings Agent Text To Speech Settings Settings related to speech synthesizing. Structure is documented below.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Advanced
Settings CxAgent Advanced Settings Args 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 string The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
- Default
Language stringCode 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.
- Display
Name string The human-readable name of the agent, unique within the location.
- Enable
Spell boolCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- Enable
Stackdriver boolLogging Determines whether this agent should log conversation queries.
- Git
Integration CxSettings Agent Git Integration Settings Args 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.
- Security
Settings string Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- Speech
To CxText Settings Agent Speech To Text Settings Args Settings related to speech recognition. Structure is documented below.
- Start
Flow 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/.
- Supported
Language []stringCodes The list of all languages supported by this agent (except for the default_language_code).
- Text
To CxSpeech Settings Agent Text To Speech Settings Args Settings related to speech synthesizing. Structure is documented below.
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced
Settings CxAgent Advanced Settings 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 String The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
- default
Language StringCode 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.
- display
Name String The human-readable name of the agent, unique within the location.
- enable
Spell BooleanCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable
Stackdriver BooleanLogging Determines whether this agent should log conversation queries.
- git
Integration CxSettings Agent Git Integration Settings 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.
- security
Settings String Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- speech
To CxText Settings Agent Speech To Text Settings Settings related to speech recognition. Structure is documented below.
- start
Flow 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/.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the default_language_code).
- text
To CxSpeech Settings Agent Text To Speech Settings Settings related to speech synthesizing. Structure is documented below.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced
Settings CxAgent Advanced Settings 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 string The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
- default
Language stringCode 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.
- display
Name string The human-readable name of the agent, unique within the location.
- enable
Spell booleanCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable
Stackdriver booleanLogging Determines whether this agent should log conversation queries.
- git
Integration CxSettings Agent Git Integration Settings 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.
- security
Settings string Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- speech
To CxText Settings Agent Speech To Text Settings Settings related to speech recognition. Structure is documented below.
- start
Flow 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/.
- supported
Language string[]Codes The list of all languages supported by this agent (except for the default_language_code).
- text
To CxSpeech Settings Agent Text To Speech Settings Settings related to speech synthesizing. Structure is documented below.
- time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced_
settings CxAgent Advanced Settings Args 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_ strcode 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_ boolcorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable_
stackdriver_ boollogging Determines whether this agent should log conversation queries.
- git_
integration_ Cxsettings Agent Git Integration Settings Args 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_ Cxtext_ settings Agent Speech To Text Settings Args 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_ Sequence[str]codes The list of all languages supported by this agent (except for the default_language_code).
- text_
to_ Cxspeech_ settings Agent Text To Speech Settings Args 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.
- advanced
Settings 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.
- avatar
Uri String The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
- default
Language StringCode 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.
- display
Name String The human-readable name of the agent, unique within the location.
- enable
Spell BooleanCorrection Indicates if automatic spell correction is enabled in detect intent requests.
- enable
Stackdriver BooleanLogging Determines whether this agent should log conversation queries.
- git
Integration Property MapSettings 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.
- security
Settings String Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
- speech
To Property MapText Settings Settings related to speech recognition. Structure is documented below.
- start
Flow 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/.
- supported
Language List<String>Codes The list of all languages supported by this agent (except for the default_language_code).
- text
To Property MapSpeech Settings Settings related to speech synthesizing. Structure is documented below.
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
Supporting Types
CxAgentAdvancedSettings, CxAgentAdvancedSettingsArgs
- Audio
Export CxGcs Destination Agent Advanced Settings Audio Export Gcs Destination 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 CxAgent Advanced Settings Dtmf Settings 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 CxGcs Destination Agent Advanced Settings Audio Export Gcs Destination 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 CxAgent Advanced Settings Dtmf Settings 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 CxGcs Destination Agent Advanced Settings Audio Export Gcs Destination 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 CxAgent Advanced Settings Dtmf Settings 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 CxGcs Destination Agent Advanced Settings Audio Export Gcs Destination 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 CxAgent Advanced Settings Dtmf Settings 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_ Cxgcs_ destination Agent Advanced Settings Audio Export Gcs Destination 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 CxAgent Advanced Settings Dtmf Settings 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 Property MapGcs Destination 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 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).
- Finish
Digit string The digit that terminates a DTMF digit sequence.
- Max
Digits 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).
- Finish
Digit string 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).
- finish
Digit String The digit that terminates a DTMF digit sequence.
- max
Digits 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).
- finish
Digit string The digit that terminates a DTMF digit sequence.
- max
Digits 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).
- finish
Digit String The digit that terminates a DTMF digit sequence.
- max
Digits Number Max length of DTMF digits.
CxAgentGitIntegrationSettings, CxAgentGitIntegrationSettingsArgs
- Github
Settings CxAgent Git Integration Settings Github Settings Settings of integration with GitHub. Structure is documented below.
- Github
Settings CxAgent Git Integration Settings Github Settings Settings of integration with GitHub. Structure is documented below.
- github
Settings CxAgent Git Integration Settings Github Settings Settings of integration with GitHub. Structure is documented below.
- github
Settings CxAgent Git Integration Settings Github Settings Settings of integration with GitHub. Structure is documented below.
- github_
settings CxAgent Git Integration Settings Github Settings Settings of integration with GitHub. Structure is documented below.
- github
Settings Property Map Settings of integration with GitHub. Structure is documented below.
CxAgentGitIntegrationSettingsGithubSettings, CxAgentGitIntegrationSettingsGithubSettingsArgs
- Access
Token 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.
- Display
Name string The unique repository display name for the GitHub repository.
- Repository
Uri string The GitHub repository URI related to the agent.
- Tracking
Branch string The branch of the GitHub repository tracked for this agent.
- Access
Token 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.
- Display
Name string The unique repository display name for the GitHub repository.
- Repository
Uri string The GitHub repository URI related to the agent.
- Tracking
Branch string The branch of the GitHub repository tracked for this agent.
- access
Token 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.
- display
Name String The unique repository display name for the GitHub repository.
- repository
Uri String The GitHub repository URI related to the agent.
- tracking
Branch String The branch of the GitHub repository tracked for this agent.
- access
Token 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.
- display
Name string The unique repository display name for the GitHub repository.
- repository
Uri string The GitHub repository URI related to the agent.
- tracking
Branch 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.
- access
Token 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.
- display
Name String The unique repository display name for the GitHub repository.
- repository
Uri String The GitHub repository URI related to the agent.
- tracking
Branch String The branch of the GitHub repository tracked for this agent.
CxAgentSpeechToTextSettings, CxAgentSpeechToTextSettingsArgs
- Enable
Speech boolAdaptation Whether to use speech adaptation for speech recognition.
- Enable
Speech boolAdaptation Whether to use speech adaptation for speech recognition.
- enable
Speech BooleanAdaptation Whether to use speech adaptation for speech recognition.
- enable
Speech booleanAdaptation Whether to use speech adaptation for speech recognition.
- enable_
speech_ booladaptation Whether to use speech adaptation for speech recognition.
- enable
Speech BooleanAdaptation Whether to use speech adaptation for speech recognition.
CxAgentTextToSpeechSettings, CxAgentTextToSpeechSettingsArgs
- Synthesize
Speech stringConfigs 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_settingsonly applies ifOutputAudioConfig.synthesize_speech_configis not specified.
- Synthesize
Speech stringConfigs 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_settingsonly applies ifOutputAudioConfig.synthesize_speech_configis not specified.
- synthesize
Speech StringConfigs 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_settingsonly applies ifOutputAudioConfig.synthesize_speech_configis not specified.
- synthesize
Speech stringConfigs 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_settingsonly applies ifOutputAudioConfig.synthesize_speech_configis not specified.
- synthesize_
speech_ strconfigs 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_settingsonly applies ifOutputAudioConfig.synthesize_speech_configis not specified.
- synthesize
Speech StringConfigs 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_settingsonly applies ifOutputAudioConfig.synthesize_speech_configis not specified.
Import
Agent can be imported using any of these accepted formats* projects/{{project}}/locations/{{location}}/agents/{{name}} * {{project}}/{{location}}/{{name}} * {{location}}/{{name}} In Terraform v1.5.0 and later, use an import block to import Agent using one of the formats above. For exampletf import {
id = “projects/{{project}}/locations/{{location}}/agents/{{name}}”
to = google_dialogflow_cx_agent.default }
$ pulumi import gcp:diagflow/cxAgent:CxAgent When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), 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}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-betaTerraform Provider.