Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

getAgent

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/v3beta1: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.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse

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.V3Beta1.Outputs.GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsResponse

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

TimeZone string

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

AdvancedSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse

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 GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsResponse

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

TimeZone string

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

advancedSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse

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 GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsResponse

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

timeZone String

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

advancedSettings GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse

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 GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsResponse

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

timeZone string

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

advanced_settings GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse

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 GoogleCloudDialogflowCxV3beta1SpeechToTextSettingsResponse

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

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

timeZone String

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

Supporting Types

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.

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