Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.dialogflow/v3.getAgent
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Retrieves the specified agent.
Using getAgent
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentResult>
def get_agent(agent_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAgentResult
def get_agent_output(agent_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAgentResult]
func LookupAgent(ctx *Context, args *LookupAgentArgs, opts ...InvokeOption) (*LookupAgentResult, error)
func LookupAgentOutput(ctx *Context, args *LookupAgentOutputArgs, opts ...InvokeOption) LookupAgentResultOutput
> Note: This function is named LookupAgent
in the Go SDK.
public static class GetAgent
{
public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:dialogflow/v3:getAgent
arguments:
# arguments dictionary
The following arguments are supported:
getAgent Result
The following output properties are available:
- Advanced
Settings Pulumi.Google Native. Dialogflow. V3. Outputs. Google Cloud Dialogflow Cx V3Advanced Settings Response Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
- 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 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.
- Description string
The description of the 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 Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
- Locked bool
Indicates 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/
.- Security
Settings string Name of the SecuritySettings reference for the agent. Format:
projects//locations//securitySettings/
.- Speech
To Pulumi.Text Settings Google Native. Dialogflow. V3. Outputs. Google Cloud Dialogflow Cx V3Speech To Text Settings Response Speech recognition related settings.
- Start
Flow 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/
.- Supported
Language List<string>Codes The list of all languages supported by the agent (except for the
default_language_code
).- Text
To Pulumi.Speech Settings Google Native. Dialogflow. V3. Outputs. Google Cloud Dialogflow Cx V3Text To Speech Settings Response Settings on instructing the speech synthesizer on how to generate the output audio content.
- Time
Zone string The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Advanced
Settings GoogleCloud Dialogflow Cx V3Advanced Settings Response Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
- 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 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.
- Description string
The description of the 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 Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
- Locked bool
Indicates 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/
.- Security
Settings string Name of the SecuritySettings reference for the agent. Format:
projects//locations//securitySettings/
.- Speech
To GoogleText Settings Cloud Dialogflow Cx V3Speech To Text Settings Response Speech recognition related settings.
- Start
Flow 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/
.- Supported
Language []stringCodes The list of all languages supported by the agent (except for the
default_language_code
).- Text
To GoogleSpeech Settings Cloud Dialogflow Cx V3Text To Speech Settings Response Settings on instructing the speech synthesizer on how to generate the output audio content.
- Time
Zone string The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced
Settings GoogleCloud Dialogflow Cx V3Advanced Settings Response Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
- 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 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.
- description String
The description of the 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 Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
- locked Boolean
Indicates 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/
.- security
Settings String Name of the SecuritySettings reference for the agent. Format:
projects//locations//securitySettings/
.- speech
To GoogleText Settings Cloud Dialogflow Cx V3Speech To Text Settings Response Speech recognition related settings.
- start
Flow 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/
.- supported
Language List<String>Codes The list of all languages supported by the agent (except for the
default_language_code
).- text
To GoogleSpeech Settings Cloud Dialogflow Cx V3Text To Speech Settings Response Settings on instructing the speech synthesizer on how to generate the output audio content.
- time
Zone String The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced
Settings GoogleCloud Dialogflow Cx V3Advanced Settings Response Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
- 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 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.
- description string
The description of the 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 Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
- locked boolean
Indicates 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/
.- security
Settings string Name of the SecuritySettings reference for the agent. Format:
projects//locations//securitySettings/
.- speech
To GoogleText Settings Cloud Dialogflow Cx V3Speech To Text Settings Response Speech recognition related settings.
- start
Flow 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/
.- supported
Language string[]Codes The list of all languages supported by the agent (except for the
default_language_code
).- text
To GoogleSpeech Settings Cloud Dialogflow Cx V3Text To Speech Settings Response Settings on instructing the speech synthesizer on how to generate the output audio content.
- time
Zone string The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
- advanced_
settings GoogleCloud Dialogflow Cx V3Advanced Settings Response 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.
- default_
language_ strcode 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.
- description str
The description of the 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 Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
- locked bool
Indicates 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/
.- security_
settings str Name of the SecuritySettings reference for the agent. Format:
projects//locations//securitySettings/
.- speech_
to_ Googletext_ settings Cloud Dialogflow Cx V3Speech To Text Settings Response 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_ Sequence[str]codes The list of all languages supported by the agent (except for the
default_language_code
).- text_
to_ Googlespeech_ settings Cloud Dialogflow Cx V3Text To Speech Settings Response Settings on instructing the speech synthesizer on how to generate the output audio content.
- time_
zone str The time zone of the 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.
- 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 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.
- description String
The description of the 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 Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
- locked Boolean
Indicates 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/
.- security
Settings String Name of the SecuritySettings reference for the agent. Format:
projects//locations//securitySettings/
.- speech
To Property MapText Settings Speech recognition related settings.
- start
Flow 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/
.- supported
Language List<String>Codes The list of all languages supported by the agent (except for the
default_language_code
).- text
To Property MapSpeech Settings Settings on instructing the speech synthesizer on how to generate the output audio content.
- time
Zone String The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
Supporting Types
GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse
- Enable
Interaction boolLogging If true, DF Interaction logging is currently enabled.
- Enable
Stackdriver boolLogging If true, StackDriver logging is currently enabled.
- Enable
Interaction boolLogging If true, DF Interaction logging is currently enabled.
- Enable
Stackdriver boolLogging If true, StackDriver logging is currently enabled.
- enable
Interaction BooleanLogging If true, DF Interaction logging is currently enabled.
- enable
Stackdriver BooleanLogging If true, StackDriver logging is currently enabled.
- enable
Interaction booleanLogging If true, DF Interaction logging is currently enabled.
- enable
Stackdriver booleanLogging If true, StackDriver logging is currently enabled.
- enable_
interaction_ boollogging If true, DF Interaction logging is currently enabled.
- enable_
stackdriver_ boollogging If true, StackDriver logging is currently enabled.
- enable
Interaction BooleanLogging If true, DF Interaction logging is currently enabled.
- enable
Stackdriver BooleanLogging If true, StackDriver logging is currently enabled.
GoogleCloudDialogflowCxV3AdvancedSettingsResponse
- Audio
Export Pulumi.Gcs Destination Google Native. Dialogflow. V3. Inputs. Google Cloud Dialogflow Cx V3Gcs Destination Response If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- Logging
Settings Pulumi.Google Native. Dialogflow. V3. Inputs. Google Cloud Dialogflow Cx V3Advanced Settings Logging Settings Response Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
- Audio
Export GoogleGcs Destination Cloud Dialogflow Cx V3Gcs Destination Response If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- Logging
Settings GoogleCloud Dialogflow Cx V3Advanced Settings Logging Settings Response Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
- audio
Export GoogleGcs Destination Cloud Dialogflow Cx V3Gcs Destination Response If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- logging
Settings GoogleCloud Dialogflow Cx V3Advanced Settings Logging Settings Response Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
- audio
Export GoogleGcs Destination Cloud Dialogflow Cx V3Gcs Destination Response If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- logging
Settings GoogleCloud Dialogflow Cx V3Advanced Settings Logging Settings Response Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
- audio_
export_ Googlegcs_ destination Cloud Dialogflow Cx V3Gcs Destination Response If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- logging_
settings GoogleCloud Dialogflow Cx V3Advanced Settings Logging Settings Response Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
- 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
- logging
Settings Property Map Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
GoogleCloudDialogflowCxV3GcsDestinationResponse
- Uri string
The Google Cloud Storage URI for the exported objects. A URI is of the form:
gs://bucket/object-name-or-prefix
Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
- Uri string
The Google Cloud Storage URI for the exported objects. A URI is of the form:
gs://bucket/object-name-or-prefix
Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
- uri String
The Google Cloud Storage URI for the exported objects. A URI is of the form:
gs://bucket/object-name-or-prefix
Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
- uri string
The Google Cloud Storage URI for the exported objects. A URI is of the form:
gs://bucket/object-name-or-prefix
Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
- uri str
The Google Cloud Storage URI for the exported objects. A URI is of the form:
gs://bucket/object-name-or-prefix
Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
- uri String
The Google Cloud Storage URI for the exported objects. A URI is of the form:
gs://bucket/object-name-or-prefix
Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse
- 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.
GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse
- Synthesize
Speech Dictionary<string, string>Configs Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The synthesize configuration used in phone gateway. - You no longer need to specify OutputAudioConfig.synthesize_speech_config when invoking API calls. Your agent will use the pre-configured options for speech synthesizing.
- Synthesize
Speech map[string]stringConfigs Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The synthesize configuration used in phone gateway. - You no longer need to specify OutputAudioConfig.synthesize_speech_config when invoking API calls. Your agent will use the pre-configured options for speech synthesizing.
- synthesize
Speech Map<String,String>Configs Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The synthesize configuration used in phone gateway. - You no longer need to specify OutputAudioConfig.synthesize_speech_config when invoking API calls. Your agent will use the pre-configured options for speech synthesizing.
- synthesize
Speech {[key: string]: string}Configs Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The synthesize configuration used in phone gateway. - You no longer need to specify OutputAudioConfig.synthesize_speech_config when invoking API calls. Your agent will use the pre-configured options for speech synthesizing.
- synthesize_
speech_ Mapping[str, str]configs Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The synthesize configuration used in phone gateway. - You no longer need to specify OutputAudioConfig.synthesize_speech_config when invoking API calls. Your agent will use the pre-configured options for speech synthesizing.
- synthesize
Speech Map<String>Configs Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The synthesize configuration used in phone gateway. - You no longer need to specify OutputAudioConfig.synthesize_speech_config when invoking API calls. Your agent will use the pre-configured options for speech synthesizing.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.