Google Native

Pulumi Official
Package maintained by Pulumi
v0.19.1 published on Tuesday, May 24, 2022 by Pulumi

Agent

Creates an agent in the specified location. Note: You should always train a flow prior to sending it queries. See the training documentation.

Create a Agent Resource

new Agent(name: string, args: AgentArgs, opts?: CustomResourceOptions);
@overload
def Agent(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          advanced_settings: Optional[GoogleCloudDialogflowCxV3beta1AdvancedSettingsArgs] = 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,
          locked: Optional[bool] = None,
          name: Optional[str] = None,
          project: Optional[str] = None,
          security_settings: Optional[str] = None,
          speech_to_text_settings: Optional[GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsArgs] = None,
          start_flow: Optional[str] = None,
          supported_language_codes: Optional[Sequence[str]] = None,
          time_zone: Optional[str] = None)
@overload
def Agent(resource_name: str,
          args: AgentArgs,
          opts: Optional[ResourceOptions] = None)
func NewAgent(ctx *Context, name string, args AgentArgs, opts ...ResourceOption) (*Agent, error)
public Agent(string name, AgentArgs args, CustomResourceOptions? opts = null)
public Agent(String name, AgentArgs args)
public Agent(String name, AgentArgs args, CustomResourceOptions options)
type: google-native:dialogflow/v3beta1:Agent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AgentArgs
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 AgentArgs
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 AgentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AgentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AgentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DefaultLanguageCode string

Immutable. 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 set by the Agents.UpdateAgent method.

DisplayName string

The human-readable name of the agent, unique within the location.

TimeZone string

The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

AdvancedSettings Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1AdvancedSettingsArgs

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

AvatarUri string

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Description string

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

EnableSpellCorrection bool

Indicates if automatic spell correction is enabled in detect intent requests.

EnableStackdriverLogging bool

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

Location string
Locked bool

Indiciates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.

Name string

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

Project string
SecuritySettings string

Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

SpeechToTextSettings Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsArgs

Speech recognition related settings.

StartFlow string

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

SupportedLanguageCodes List<string>

The list of all languages supported by the agent (except for the default_language_code).

DefaultLanguageCode string

Immutable. 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 set by the Agents.UpdateAgent method.

DisplayName string

The human-readable name of the agent, unique within the location.

TimeZone string

The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

AdvancedSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsArgs

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

AvatarUri string

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Description string

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

EnableSpellCorrection bool

Indicates if automatic spell correction is enabled in detect intent requests.

EnableStackdriverLogging bool

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

Location string
Locked bool

Indiciates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.

Name string

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

Project string
SecuritySettings string

Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

SpeechToTextSettings GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsArgs

Speech recognition related settings.

StartFlow string

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

SupportedLanguageCodes []string

The list of all languages supported by the agent (except for the default_language_code).

defaultLanguageCode String

Immutable. 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 set by the Agents.UpdateAgent method.

displayName String

The human-readable name of the agent, unique within the location.

timeZone String

The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

advancedSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsArgs

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

avatarUri String

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

description String

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

enableSpellCorrection Boolean

Indicates if automatic spell correction is enabled in detect intent requests.

enableStackdriverLogging Boolean

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

location String
locked Boolean

Indiciates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.

name String

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

project String
securitySettings String

Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

speechToTextSettings GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsArgs

Speech recognition related settings.

startFlow String

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

supportedLanguageCodes List<String>

The list of all languages supported by the agent (except for the default_language_code).

defaultLanguageCode string

Immutable. 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 set by the Agents.UpdateAgent method.

displayName string

The human-readable name of the agent, unique within the location.

timeZone string

The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

advancedSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsArgs

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

avatarUri string

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

description string

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

enableSpellCorrection boolean

Indicates if automatic spell correction is enabled in detect intent requests.

enableStackdriverLogging boolean

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

location string
locked boolean

Indiciates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.

name string

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

project string
securitySettings string

Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

speechToTextSettings GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsArgs

Speech recognition related settings.

startFlow string

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

supportedLanguageCodes string[]

The list of all languages supported by the agent (except for the default_language_code).

default_language_code str

Immutable. 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 set by the Agents.UpdateAgent method.

display_name str

The human-readable name of the agent, unique within the location.

time_zone str

The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

advanced_settings GoogleCloudDialogflowCxV3beta1AdvancedSettingsArgs

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

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 the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

enable_spell_correction bool

Indicates if automatic spell correction is enabled in detect intent requests.

enable_stackdriver_logging bool

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

location str
locked bool

Indiciates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.

name str

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

project str
security_settings str

Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

speech_to_text_settings GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsArgs

Speech recognition related settings.

start_flow str

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

supported_language_codes Sequence[str]

The list of all languages supported by the agent (except for the default_language_code).

defaultLanguageCode String

Immutable. 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 set by the Agents.UpdateAgent method.

displayName String

The human-readable name of the agent, unique within the location.

timeZone String

The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

advancedSettings Property Map

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

avatarUri String

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

description String

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

enableSpellCorrection Boolean

Indicates if automatic spell correction is enabled in detect intent requests.

enableStackdriverLogging Boolean

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

location String
locked Boolean

Indiciates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.

name String

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

project String
securitySettings String

Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

speechToTextSettings Property Map

Speech recognition related settings.

startFlow String

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.

supportedLanguageCodes List<String>

The list of all languages supported by the agent (except for the default_language_code).

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

GoogleCloudDialogflowCxV3beta1AdvancedSettings

LoggingSettings Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

LoggingSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

loggingSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

loggingSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

logging_settings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

loggingSettings Property Map

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings

EnableInteractionLogging bool

If true, DF Interaction logging is currently enabled.

EnableStackdriverLogging bool

If true, StackDriver logging is currently enabled.

EnableInteractionLogging bool

If true, DF Interaction logging is currently enabled.

EnableStackdriverLogging bool

If true, StackDriver logging is currently enabled.

enableInteractionLogging Boolean

If true, DF Interaction logging is currently enabled.

enableStackdriverLogging Boolean

If true, StackDriver logging is currently enabled.

enableInteractionLogging boolean

If true, DF Interaction logging is currently enabled.

enableStackdriverLogging boolean

If true, StackDriver logging is currently enabled.

enable_interaction_logging bool

If true, DF Interaction logging is currently enabled.

enable_stackdriver_logging bool

If true, StackDriver logging is currently enabled.

enableInteractionLogging Boolean

If true, DF Interaction logging is currently enabled.

enableStackdriverLogging Boolean

If true, StackDriver logging is currently enabled.

GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponse

EnableInteractionLogging bool

If true, DF Interaction logging is currently enabled.

EnableStackdriverLogging bool

If true, StackDriver logging is currently enabled.

EnableInteractionLogging bool

If true, DF Interaction logging is currently enabled.

EnableStackdriverLogging bool

If true, StackDriver logging is currently enabled.

enableInteractionLogging Boolean

If true, DF Interaction logging is currently enabled.

enableStackdriverLogging Boolean

If true, StackDriver logging is currently enabled.

enableInteractionLogging boolean

If true, DF Interaction logging is currently enabled.

enableStackdriverLogging boolean

If true, StackDriver logging is currently enabled.

enable_interaction_logging bool

If true, DF Interaction logging is currently enabled.

enable_stackdriver_logging bool

If true, StackDriver logging is currently enabled.

enableInteractionLogging Boolean

If true, DF Interaction logging is currently enabled.

enableStackdriverLogging Boolean

If true, StackDriver logging is currently enabled.

GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse

LoggingSettings Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponse

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

LoggingSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponse

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

loggingSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponse

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

loggingSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponse

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

logging_settings GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponse

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

loggingSettings Property Map

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

GoogleCloudDialogflowCxV3beta1SpeechToTextSettings

EnableSpeechAdaptation bool

Whether to use speech adaptation for speech recognition.

EnableSpeechAdaptation bool

Whether to use speech adaptation for speech recognition.

enableSpeechAdaptation Boolean

Whether to use speech adaptation for speech recognition.

enableSpeechAdaptation boolean

Whether to use speech adaptation for speech recognition.

enable_speech_adaptation bool

Whether to use speech adaptation for speech recognition.

enableSpeechAdaptation Boolean

Whether to use speech adaptation for speech recognition.

GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsResponse

EnableSpeechAdaptation bool

Whether to use speech adaptation for speech recognition.

EnableSpeechAdaptation bool

Whether to use speech adaptation for speech recognition.

enableSpeechAdaptation Boolean

Whether to use speech adaptation for speech recognition.

enableSpeechAdaptation boolean

Whether to use speech adaptation for speech recognition.

enable_speech_adaptation bool

Whether to use speech adaptation for speech recognition.

enableSpeechAdaptation Boolean

Whether to use speech adaptation for speech recognition.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0