Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3
  6. getAgent

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v3.getAgent

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
pulumi/pulumi-google-native

    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:

    AgentId string
    Location string
    Project string
    AgentId string
    Location string
    Project string
    agentId String
    location String
    project String
    agentId string
    location string
    project string
    agentId String
    location String
    project String

    getAgent Result

    The following output properties are available:

    AdvancedSettings Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3AdvancedSettingsResponse

    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.

    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.

    Description string

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

    DisplayName string

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

    EnableSpellCorrection bool

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

    EnableStackdriverLogging bool

    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/.

    SecuritySettings string

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

    SpeechToTextSettings Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse

    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).

    TextToSpeechSettings Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse

    Settings on instructing the speech synthesizer on how to generate the output audio content.

    TimeZone string

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

    AdvancedSettings GoogleCloudDialogflowCxV3AdvancedSettingsResponse

    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.

    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.

    Description string

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

    DisplayName string

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

    EnableSpellCorrection bool

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

    EnableStackdriverLogging bool

    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/.

    SecuritySettings string

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

    SpeechToTextSettings GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse

    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).

    TextToSpeechSettings GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse

    Settings on instructing the speech synthesizer on how to generate the output audio content.

    TimeZone string

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

    advancedSettings GoogleCloudDialogflowCxV3AdvancedSettingsResponse

    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.

    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.

    description String

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

    displayName String

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

    enableSpellCorrection Boolean

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

    enableStackdriverLogging Boolean

    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/.

    securitySettings String

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

    speechToTextSettings GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse

    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).

    textToSpeechSettings GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse

    Settings on instructing the speech synthesizer on how to generate the output audio content.

    timeZone String

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

    advancedSettings GoogleCloudDialogflowCxV3AdvancedSettingsResponse

    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.

    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.

    description string

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

    displayName string

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

    enableSpellCorrection boolean

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

    enableStackdriverLogging boolean

    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/.

    securitySettings string

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

    speechToTextSettings GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse

    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).

    textToSpeechSettings GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse

    Settings on instructing the speech synthesizer on how to generate the output audio content.

    timeZone string

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

    advanced_settings GoogleCloudDialogflowCxV3AdvancedSettingsResponse

    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_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.

    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_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.

    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_text_settings GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse

    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).

    text_to_speech_settings GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse

    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.

    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.

    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.

    description String

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

    displayName String

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

    enableSpellCorrection Boolean

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

    enableStackdriverLogging Boolean

    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/.

    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).

    textToSpeechSettings Property Map

    Settings on instructing the speech synthesizer on how to generate the output audio content.

    timeZone String

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

    Supporting Types

    GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse

    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.

    GoogleCloudDialogflowCxV3AdvancedSettingsResponse

    AudioExportGcsDestination Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3GcsDestinationResponse

    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level

    LoggingSettings Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse

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

    AudioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestinationResponse

    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level

    LoggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse

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

    audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestinationResponse

    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level

    loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse

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

    audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestinationResponse

    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level

    loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse

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

    audio_export_gcs_destination GoogleCloudDialogflowCxV3GcsDestinationResponse

    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 GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse

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

    audioExportGcsDestination Property Map

    If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level

    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.

    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

    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.

    GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse

    SynthesizeSpeechConfigs Dictionary<string, string>

    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.

    SynthesizeSpeechConfigs map[string]string

    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.

    synthesizeSpeechConfigs Map<String,String>

    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.

    synthesizeSpeechConfigs {[key: string]: string}

    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_configs Mapping[str, str]

    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.

    synthesizeSpeechConfigs Map<String>

    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-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
    pulumi/pulumi-google-native