pulumi-google-native-kotlin/com.pulumi.googlenative.dialogflow.v3.kotlin.outputs

Package-level declarations

Types

Link copied to clipboard
data class GetAgentResult(val advancedSettings: GoogleCloudDialogflowCxV3AdvancedSettingsResponse, val avatarUri: String, val defaultLanguageCode: String, val description: String, val displayName: String, val enableSpellCorrection: Boolean, val enableStackdriverLogging: Boolean, val locked: Boolean, val name: String, val securitySettings: String, val speechToTextSettings: GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse, val startFlow: String, val supportedLanguageCodes: List<String>, val textToSpeechSettings: GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse, val timeZone: String)
Link copied to clipboard
data class GetEntityTypeResult(val autoExpansionMode: String, val displayName: String, val enableFuzzyExtraction: Boolean, val entities: List<GoogleCloudDialogflowCxV3EntityTypeEntityResponse>, val excludedPhrases: List<GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse>, val kind: String, val name: String, val redact: Boolean)
Link copied to clipboard
data class GetEnvironmentResult(val description: String, val displayName: String, val name: String, val testCasesConfig: GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse, val updateTime: String, val versionConfigs: List<GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse>, val webhookConfig: GoogleCloudDialogflowCxV3EnvironmentWebhookConfigResponse)
Link copied to clipboard
data class GetExperimentResult(val createTime: String, val definition: GoogleCloudDialogflowCxV3ExperimentDefinitionResponse, val description: String, val displayName: String, val endTime: String, val experimentLength: String, val lastUpdateTime: String, val name: String, val result: GoogleCloudDialogflowCxV3ExperimentResultResponse, val rolloutConfig: GoogleCloudDialogflowCxV3RolloutConfigResponse, val rolloutFailureReason: String, val rolloutState: GoogleCloudDialogflowCxV3RolloutStateResponse, val startTime: String, val state: String, val variantsHistory: List<GoogleCloudDialogflowCxV3VariantsHistoryResponse>)
Link copied to clipboard
data class GetFlowResult(val description: String, val displayName: String, val eventHandlers: List<GoogleCloudDialogflowCxV3EventHandlerResponse>, val name: String, val nluSettings: GoogleCloudDialogflowCxV3NluSettingsResponse, val transitionRouteGroups: List<String>, val transitionRoutes: List<GoogleCloudDialogflowCxV3TransitionRouteResponse>)
Link copied to clipboard
data class GetIntentResult(val description: String, val displayName: String, val isFallback: Boolean, val labels: Map<String, String>, val name: String, val parameters: List<GoogleCloudDialogflowCxV3IntentParameterResponse>, val priority: Int, val trainingPhrases: List<GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse>)
Link copied to clipboard
data class GetPageResult(val displayName: String, val entryFulfillment: GoogleCloudDialogflowCxV3FulfillmentResponse, val eventHandlers: List<GoogleCloudDialogflowCxV3EventHandlerResponse>, val form: GoogleCloudDialogflowCxV3FormResponse, val name: String, val transitionRouteGroups: List<String>, val transitionRoutes: List<GoogleCloudDialogflowCxV3TransitionRouteResponse>)
Link copied to clipboard
data class GetSecuritySettingResult(val audioExportSettings: GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse, val deidentifyTemplate: String, val displayName: String, val insightsExportSettings: GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse, val inspectTemplate: String, val name: String, val purgeDataTypes: List<String>, val redactionScope: String, val redactionStrategy: String, val retentionWindowDays: Int)
Link copied to clipboard
data class GetSessionEntityTypeResult(val entities: List<GoogleCloudDialogflowCxV3EntityTypeEntityResponse>, val entityOverrideMode: String, val name: String)
Link copied to clipboard
data class GetTestCaseResult(val creationTime: String, val displayName: String, val lastTestResult: GoogleCloudDialogflowCxV3TestCaseResultResponse, val name: String, val notes: String, val tags: List<String>, val testCaseConversationTurns: List<GoogleCloudDialogflowCxV3ConversationTurnResponse>, val testConfig: GoogleCloudDialogflowCxV3TestConfigResponse)
Link copied to clipboard
data class GetTransitionRouteGroupResult(val displayName: String, val name: String, val transitionRoutes: List<GoogleCloudDialogflowCxV3TransitionRouteResponse>)
Link copied to clipboard
data class GetVersionResult(val createTime: String, val description: String, val displayName: String, val name: String, val nluSettings: GoogleCloudDialogflowCxV3NluSettingsResponse, val state: String)
Link copied to clipboard
data class GetWebhookResult(val disabled: Boolean, val displayName: String, val genericWebService: GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse, val name: String, val serviceDirectory: GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse, val timeout: String)
data class GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse(val enableInteractionLogging: Boolean, val enableStackdriverLogging: Boolean)

Define behaviors on logging.

data class GoogleCloudDialogflowCxV3AdvancedSettingsResponse(val audioExportGcsDestination: GoogleCloudDialogflowCxV3GcsDestinationResponse, val loggingSettings: GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettingsResponse)

Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.

data class GoogleCloudDialogflowCxV3AudioInputResponse(val audio: String, val config: GoogleCloudDialogflowCxV3InputAudioConfigResponse)

Represents the natural speech audio to be processed.

data class GoogleCloudDialogflowCxV3ConversationTurnResponse(val userInput: GoogleCloudDialogflowCxV3ConversationTurnUserInputResponse, val virtualAgentOutput: GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutputResponse)

One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.

data class GoogleCloudDialogflowCxV3ConversationTurnUserInputResponse(val enableSentimentAnalysis: Boolean, val injectedParameters: Map<String, String>, val input: GoogleCloudDialogflowCxV3QueryInputResponse, val isWebhookEnabled: Boolean)

The input from the human user.

data class GoogleCloudDialogflowCxV3DtmfInputResponse(val digits: String, val finishDigit: String)

Represents the input for dtmf event.

data class GoogleCloudDialogflowCxV3EntityTypeEntityResponse(val synonyms: List<String>, val value: String)

An entity entry for an associated entity type.

data class GoogleCloudDialogflowCxV3EntityTypeExcludedPhraseResponse(val value: String)

An excluded entity phrase that should not be matched.

data class GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse(val enableContinuousRun: Boolean, val enablePredeploymentRun: Boolean, val testCases: List<String>)

The configuration for continuous tests.

data class GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse(val version: String)

Configuration for the version.

data class GoogleCloudDialogflowCxV3EventHandlerResponse(val event: String, val name: String, val targetFlow: String, val targetPage: String, val triggerFulfillment: GoogleCloudDialogflowCxV3FulfillmentResponse)

An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a trigger_fulfillment associated with the event, it will be called. * If there is a target_page associated with the event, the session will transition into the specified page. * If there is a target_flow associated with the event, the session will transition into the specified flow.

data class GoogleCloudDialogflowCxV3EventInputResponse(val event: String)

Represents the event to trigger.

data class GoogleCloudDialogflowCxV3ExperimentDefinitionResponse(val condition: String, val versionVariants: GoogleCloudDialogflowCxV3VersionVariantsResponse)

Definition of the experiment.

data class GoogleCloudDialogflowCxV3ExperimentResultConfidenceIntervalResponse(val confidenceLevel: Double, val lowerBound: Double, val ratio: Double, val upperBound: Double)

A confidence interval is a range of possible values for the experiment objective you are trying to measure.

data class GoogleCloudDialogflowCxV3ExperimentResultMetricResponse(val confidenceInterval: GoogleCloudDialogflowCxV3ExperimentResultConfidenceIntervalResponse, val count: Double, val countType: String, val ratio: Double, val type: String)

Metric and corresponding confidence intervals.

data class GoogleCloudDialogflowCxV3ExperimentResultResponse(val lastUpdateTime: String, val versionMetrics: List<GoogleCloudDialogflowCxV3ExperimentResultVersionMetricsResponse>)

The inference result which includes an objective metric to optimize and the confidence interval.

data class GoogleCloudDialogflowCxV3ExperimentResultVersionMetricsResponse(val metrics: List<GoogleCloudDialogflowCxV3ExperimentResultMetricResponse>, val sessionCount: Int, val version: String)

Version variant and associated metrics.

data class GoogleCloudDialogflowCxV3FormParameterFillBehaviorResponse(val initialPromptFulfillment: GoogleCloudDialogflowCxV3FulfillmentResponse, val repromptEventHandlers: List<GoogleCloudDialogflowCxV3EventHandlerResponse>)

Configuration for how the filling of a parameter should be handled.

data class GoogleCloudDialogflowCxV3FormParameterResponse(val defaultValue: Any, val displayName: String, val entityType: String, val fillBehavior: GoogleCloudDialogflowCxV3FormParameterFillBehaviorResponse, val isList: Boolean, val redact: Boolean, val required: Boolean)

Represents a form parameter.

Link copied to clipboard
data class GoogleCloudDialogflowCxV3FormResponse(val parameters: List<GoogleCloudDialogflowCxV3FormParameterResponse>)

A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.

data class GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseResponse(val caseContent: List<GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContentResponse>, val condition: String)

Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.

data class GoogleCloudDialogflowCxV3FulfillmentConditionalCasesResponse(val cases: List<GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseResponse>)

A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.

data class GoogleCloudDialogflowCxV3FulfillmentResponse(val conditionalCases: List<GoogleCloudDialogflowCxV3FulfillmentConditionalCasesResponse>, val messages: List<GoogleCloudDialogflowCxV3ResponseMessageResponse>, val returnPartialResponses: Boolean, val setParameterActions: List<GoogleCloudDialogflowCxV3FulfillmentSetParameterActionResponse>, val tag: String, val webhook: String)

A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.

data class GoogleCloudDialogflowCxV3FulfillmentSetParameterActionResponse(val parameter: String, val value: Any)

Setting a parameter value.

data class GoogleCloudDialogflowCxV3GcsDestinationResponse(val uri: String)

Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.

data class GoogleCloudDialogflowCxV3InputAudioConfigResponse(val audioEncoding: String, val enableWordInfo: Boolean, val model: String, val modelVariant: String, val phraseHints: List<String>, val sampleRateHertz: Int, val singleUtterance: Boolean)

Instructs the speech recognizer on how to process the audio content.

data class GoogleCloudDialogflowCxV3IntentInputResponse(val intent: String)

Represents the intent to trigger programmatically rather than as a result of natural language processing.

data class GoogleCloudDialogflowCxV3IntentParameterResponse(val entityType: String, val isList: Boolean, val redact: Boolean)

Represents an intent parameter.

Link copied to clipboard
data class GoogleCloudDialogflowCxV3IntentResponse(val description: String, val displayName: String, val isFallback: Boolean, val labels: Map<String, String>, val name: String, val parameters: List<GoogleCloudDialogflowCxV3IntentParameterResponse>, val priority: Int, val trainingPhrases: List<GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse>)

An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.

data class GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse(val parameterId: String, val text: String)

Represents a part of a training phrase.

data class GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse(val parts: List<GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse>, val repeatCount: Int)

Represents an example that the agent is trained on to identify the intent.

data class GoogleCloudDialogflowCxV3NluSettingsResponse(val classificationThreshold: Double, val modelTrainingMode: String, val modelType: String)

Settings related to NLU.

Link copied to clipboard
data class GoogleCloudDialogflowCxV3PageResponse(val displayName: String, val entryFulfillment: GoogleCloudDialogflowCxV3FulfillmentResponse, val eventHandlers: List<GoogleCloudDialogflowCxV3EventHandlerResponse>, val form: GoogleCloudDialogflowCxV3FormResponse, val name: String, val transitionRouteGroups: List<String>, val transitionRoutes: List<GoogleCloudDialogflowCxV3TransitionRouteResponse>)

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the Page guide.

data class GoogleCloudDialogflowCxV3QueryInputResponse(val audio: GoogleCloudDialogflowCxV3AudioInputResponse, val dtmf: GoogleCloudDialogflowCxV3DtmfInputResponse, val event: GoogleCloudDialogflowCxV3EventInputResponse, val intent: GoogleCloudDialogflowCxV3IntentInputResponse, val languageCode: String, val text: GoogleCloudDialogflowCxV3TextInputResponse)

Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value.

data class GoogleCloudDialogflowCxV3ResponseMessageConversationSuccessResponse(val metadata: Map<String, String>)

Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.

class GoogleCloudDialogflowCxV3ResponseMessageEndInteractionResponse

Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.

data class GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoffResponse(val metadata: Map<String, String>)

Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.

data class GoogleCloudDialogflowCxV3ResponseMessageMixedAudioResponse(val segments: List<GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegmentResponse>)

Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.

data class GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegmentResponse(val allowPlaybackInterruption: Boolean, val audio: String, val uri: String)

Represents one segment of audio.

data class GoogleCloudDialogflowCxV3ResponseMessageOutputAudioTextResponse(val allowPlaybackInterruption: Boolean, val ssml: String, val text: String)

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

data class GoogleCloudDialogflowCxV3ResponseMessagePlayAudioResponse(val allowPlaybackInterruption: Boolean, val audioUri: String)

Specifies an audio clip to be played by the client as part of the response.

data class GoogleCloudDialogflowCxV3ResponseMessageResponse(val channel: String, val conversationSuccess: GoogleCloudDialogflowCxV3ResponseMessageConversationSuccessResponse, val endInteraction: GoogleCloudDialogflowCxV3ResponseMessageEndInteractionResponse, val liveAgentHandoff: GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoffResponse, val mixedAudio: GoogleCloudDialogflowCxV3ResponseMessageMixedAudioResponse, val outputAudioText: GoogleCloudDialogflowCxV3ResponseMessageOutputAudioTextResponse, val payload: Map<String, String>, val playAudio: GoogleCloudDialogflowCxV3ResponseMessagePlayAudioResponse, val telephonyTransferCall: GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCallResponse, val text: GoogleCloudDialogflowCxV3ResponseMessageTextResponse)

Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

data class GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCallResponse(val phoneNumber: String)

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.

data class GoogleCloudDialogflowCxV3ResponseMessageTextResponse(val allowPlaybackInterruption: Boolean, val text: List<String>)

The text response message.

data class GoogleCloudDialogflowCxV3RolloutConfigResponse(val failureCondition: String, val rolloutCondition: String, val rolloutSteps: List<GoogleCloudDialogflowCxV3RolloutConfigRolloutStepResponse>)

The configuration for auto rollout.

data class GoogleCloudDialogflowCxV3RolloutConfigRolloutStepResponse(val displayName: String, val minDuration: String, val trafficPercent: Int)

A single rollout step with specified traffic allocation.

data class GoogleCloudDialogflowCxV3RolloutStateResponse(val startTime: String, val step: String, val stepIndex: Int)

State of the auto-rollout process.

data class GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse(val audioExportPattern: String, val audioFormat: String, val enableAudioRedaction: Boolean, val gcsBucket: String)

Settings for exporting audio.

data class GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse(val enableInsightsExport: Boolean)

Settings for exporting conversations to Insights.

data class GoogleCloudDialogflowCxV3SpeechToTextSettingsResponse(val enableSpeechAdaptation: Boolean)

Settings related to speech recognition.

data class GoogleCloudDialogflowCxV3TestCaseResultResponse(val conversationTurns: List<GoogleCloudDialogflowCxV3ConversationTurnResponse>, val environment: String, val name: String, val testResult: String, val testTime: String)

Represents a result from running a test case in an agent environment.

data class GoogleCloudDialogflowCxV3TestConfigResponse(val flow: String, val page: String, val trackingParameters: List<String>)

Represents configurations for a test case.

data class GoogleCloudDialogflowCxV3TestRunDifferenceResponse(val description: String, val type: String)

The description of differences between original and replayed agent output.

data class GoogleCloudDialogflowCxV3TextInputResponse(val text: String)

Represents the natural language text to be processed.

data class GoogleCloudDialogflowCxV3TextToSpeechSettingsResponse(val synthesizeSpeechConfigs: Map<String, String>)

Settings related to speech synthesizing.

data class GoogleCloudDialogflowCxV3TransitionRouteResponse(val condition: String, val intent: String, val name: String, val targetFlow: String, val targetPage: String, val triggerFulfillment: GoogleCloudDialogflowCxV3FulfillmentResponse)

A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a trigger_fulfillment associated with the transition, it will be called. * If there is a target_page associated with the transition, the session will transition into the specified page. * If there is a target_flow associated with the transition, the session will transition into the specified flow.

data class GoogleCloudDialogflowCxV3VariantsHistoryResponse(val updateTime: String, val versionVariants: GoogleCloudDialogflowCxV3VersionVariantsResponse)

The history of variants update.

data class GoogleCloudDialogflowCxV3VersionVariantsVariantResponse(val isControlGroup: Boolean, val trafficAllocation: Double, val version: String)

A single flow version with specified traffic allocation.

data class GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse(val allowedCaCerts: List<String>, val httpMethod: String, val parameterMapping: Map<String, String>, val password: String, val requestBody: String, val requestHeaders: Map<String, String>, val uri: String, val username: String, val webhookType: String)

Represents configuration for a generic web service.

Link copied to clipboard
data class GoogleCloudDialogflowCxV3WebhookResponse(val disabled: Boolean, val displayName: String, val genericWebService: GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse, val name: String, val serviceDirectory: GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse, val timeout: String)

Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

Link copied to clipboard
data class GoogleRpcStatusResponse(val code: Int, val details: List<Map<String, String>>, val message: String)

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.