gcp.diagflow.CxAgent
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 Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var fullAgent = new Gcp.Diagflow.CxAgent("fullAgent", new()
{
AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
DefaultLanguageCode = "en",
Description = "Example description.",
DisplayName = "dialogflowcx-agent",
EnableSpellCorrection = true,
EnableStackdriverLogging = true,
Location = "global",
SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
{
EnableSpeechAdaptation = true,
},
SupportedLanguageCodes = new[]
{
"fr",
"de",
"es",
},
TimeZone = "America/New_York",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/diagflow"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := diagflow.NewCxAgent(ctx, "fullAgent", &diagflow.CxAgentArgs{
AvatarUri: pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"),
DefaultLanguageCode: pulumi.String("en"),
Description: pulumi.String("Example description."),
DisplayName: pulumi.String("dialogflowcx-agent"),
EnableSpellCorrection: pulumi.Bool(true),
EnableStackdriverLogging: pulumi.Bool(true),
Location: pulumi.String("global"),
SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
EnableSpeechAdaptation: pulumi.Bool(true),
},
SupportedLanguageCodes: pulumi.StringArray{
pulumi.String("fr"),
pulumi.String("de"),
pulumi.String("es"),
},
TimeZone: pulumi.String("America/New_York"),
})
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.diagflow.CxAgent;
import com.pulumi.gcp.diagflow.CxAgentArgs;
import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
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 fullAgent = new CxAgent("fullAgent", CxAgentArgs.builder()
.avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
.defaultLanguageCode("en")
.description("Example description.")
.displayName("dialogflowcx-agent")
.enableSpellCorrection(true)
.enableStackdriverLogging(true)
.location("global")
.speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
.enableSpeechAdaptation(true)
.build())
.supportedLanguageCodes(
"fr",
"de",
"es")
.timeZone("America/New_York")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
full_agent = gcp.diagflow.CxAgent("fullAgent",
avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
default_language_code="en",
description="Example description.",
display_name="dialogflowcx-agent",
enable_spell_correction=True,
enable_stackdriver_logging=True,
location="global",
speech_to_text_settings=gcp.diagflow.CxAgentSpeechToTextSettingsArgs(
enable_speech_adaptation=True,
),
supported_language_codes=[
"fr",
"de",
"es",
],
time_zone="America/New_York")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const fullAgent = new gcp.diagflow.CxAgent("fullAgent", {
avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
defaultLanguageCode: "en",
description: "Example description.",
displayName: "dialogflowcx-agent",
enableSpellCorrection: true,
enableStackdriverLogging: true,
location: "global",
speechToTextSettings: {
enableSpeechAdaptation: true,
},
supportedLanguageCodes: [
"fr",
"de",
"es",
],
timeZone: "America/New_York",
});
resources:
fullAgent:
type: gcp:diagflow:CxAgent
properties:
avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
defaultLanguageCode: en
description: Example description.
displayName: dialogflowcx-agent
enableSpellCorrection: true
enableStackdriverLogging: true
location: global
speechToTextSettings:
enableSpeechAdaptation: true
supportedLanguageCodes:
- fr
- de
- es
timeZone: America/New_York
Create CxAgent Resource
new CxAgent(name: string, args: CxAgentArgs, opts?: CustomResourceOptions);
@overload
def CxAgent(resource_name: str,
opts: Optional[ResourceOptions] = 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,
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,
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.
- 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.
- 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 List<string>Codes The list of all languages supported by this agent (except for the default_language_code).
- 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.
- 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.
- 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).
- 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.
- 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.
- 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 List<String>Codes The list of all languages supported by this agent (except for the default_language_code).
- 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.
- 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.
- 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 string[]Codes The list of all languages supported by this agent (except for the default_language_code).
- 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.
- 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.
- 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).
- 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.
- 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.
- 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).
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,
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,
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,
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.
- 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.
- 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 List<string>Codes The list of all languages supported by this agent (except for the default_language_code).
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- 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.
- 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).
- Time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- 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.
- 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 List<String>Codes The list of all languages supported by this agent (except for the default_language_code).
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- 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.
- 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 string[]Codes The list of all languages supported by this agent (except for the default_language_code).
- time
Zone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- 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.
- 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).
- time_
zone str The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- 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.
- 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).
- time
Zone String The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
Supporting Types
CxAgentSpeechToTextSettings
- 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.
Import
Agent can be imported using any of these accepted formats
$ 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-beta
Terraform Provider.