Package-level declarations

Types

Link copied to clipboard
class Agent : KotlinCustomResource

A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. To get more information about Agent, see:

Link copied to clipboard
data class AgentArgs(val apiVersion: Output<String>? = null, val avatarUri: Output<String>? = null, val classificationThreshold: Output<Double>? = null, val defaultLanguageCode: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val enableLogging: Output<Boolean>? = null, val matchMode: Output<String>? = null, val project: Output<String>? = null, val supportedLanguageCodes: Output<List<String>>? = null, val tier: Output<String>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<AgentArgs>

A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. To get more information about Agent, see:

Link copied to clipboard

Builder for AgentArgs.

Link copied to clipboard
object AgentMapper : ResourceMapper<Agent>
Link copied to clipboard

Builder for Agent.

Link copied to clipboard
class CxAgent : KotlinCustomResource

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. To get more information about Agent, see:

Link copied to clipboard
data class CxAgentArgs(val advancedSettings: Output<CxAgentAdvancedSettingsArgs>? = null, val avatarUri: Output<String>? = null, val defaultLanguageCode: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val enableSpellCorrection: Output<Boolean>? = null, val enableStackdriverLogging: Output<Boolean>? = null, val gitIntegrationSettings: Output<CxAgentGitIntegrationSettingsArgs>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val securitySettings: Output<String>? = null, val speechToTextSettings: Output<CxAgentSpeechToTextSettingsArgs>? = null, val supportedLanguageCodes: Output<List<String>>? = null, val textToSpeechSettings: Output<CxAgentTextToSpeechSettingsArgs>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<CxAgentArgs>

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. To get more information about Agent, see:

Link copied to clipboard
Link copied to clipboard
object CxAgentMapper : ResourceMapper<CxAgent>
Link copied to clipboard
Link copied to clipboard
class CxEntityType : KotlinCustomResource

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. To get more information about EntityType, see:

Link copied to clipboard
data class CxEntityTypeArgs(val autoExpansionMode: Output<String>? = null, val displayName: Output<String>? = null, val enableFuzzyExtraction: Output<Boolean>? = null, val entities: Output<List<CxEntityTypeEntityArgs>>? = null, val excludedPhrases: Output<List<CxEntityTypeExcludedPhraseArgs>>? = null, val kind: Output<String>? = null, val languageCode: Output<String>? = null, val parent: Output<String>? = null, val redact: Output<Boolean>? = null) : ConvertibleToJava<CxEntityTypeArgs>

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. To get more information about EntityType, see:

Link copied to clipboard
Link copied to clipboard
object CxEntityTypeMapper : ResourceMapper<CxEntityType>
Link copied to clipboard
Link copied to clipboard
class CxEnvironment : KotlinCustomResource

Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc. To get more information about Environment, see:

Link copied to clipboard
data class CxEnvironmentArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val parent: Output<String>? = null, val versionConfigs: Output<List<CxEnvironmentVersionConfigArgs>>? = null) : ConvertibleToJava<CxEnvironmentArgs>

Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc. To get more information about Environment, see:

Link copied to clipboard
Link copied to clipboard
object CxEnvironmentMapper : ResourceMapper<CxEnvironment>
Link copied to clipboard
Link copied to clipboard
class CxFlow : KotlinCustomResource

Flows represents the conversation flows when you build your chatbot agent. To get more information about Flow, see:

Link copied to clipboard
data class CxFlowArgs(val advancedSettings: Output<CxFlowAdvancedSettingsArgs>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val eventHandlers: Output<List<CxFlowEventHandlerArgs>>? = null, val isDefaultStartFlow: Output<Boolean>? = null, val knowledgeConnectorSettings: Output<CxFlowKnowledgeConnectorSettingsArgs>? = null, val languageCode: Output<String>? = null, val nluSettings: Output<CxFlowNluSettingsArgs>? = null, val parent: Output<String>? = null, val transitionRouteGroups: Output<List<String>>? = null, val transitionRoutes: Output<List<CxFlowTransitionRouteArgs>>? = null) : ConvertibleToJava<CxFlowArgs>

Flows represents the conversation flows when you build your chatbot agent. To get more information about Flow, see:

Link copied to clipboard

Builder for CxFlowArgs.

Link copied to clipboard
object CxFlowMapper : ResourceMapper<CxFlow>
Link copied to clipboard

Builder for CxFlow.

Link copied to clipboard
class CxIntent : KotlinCustomResource

An intent represents a user's intent to interact with a conversational agent. To get more information about Intent, see:

Link copied to clipboard
data class CxIntentArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val isDefaultNegativeIntent: Output<Boolean>? = null, val isDefaultWelcomeIntent: Output<Boolean>? = null, val isFallback: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val languageCode: Output<String>? = null, val parameters: Output<List<CxIntentParameterArgs>>? = null, val parent: Output<String>? = null, val priority: Output<Int>? = null, val trainingPhrases: Output<List<CxIntentTrainingPhraseArgs>>? = null) : ConvertibleToJava<CxIntentArgs>

An intent represents a user's intent to interact with a conversational agent. To get more information about Intent, see:

Link copied to clipboard
Link copied to clipboard
object CxIntentMapper : ResourceMapper<CxIntent>
Link copied to clipboard
Link copied to clipboard
class CxPage : KotlinCustomResource

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. To get more information about Page, see:

Link copied to clipboard
data class CxPageArgs(val advancedSettings: Output<CxPageAdvancedSettingsArgs>? = null, val displayName: Output<String>? = null, val entryFulfillment: Output<CxPageEntryFulfillmentArgs>? = null, val eventHandlers: Output<List<CxPageEventHandlerArgs>>? = null, val form: Output<CxPageFormArgs>? = null, val knowledgeConnectorSettings: Output<CxPageKnowledgeConnectorSettingsArgs>? = null, val languageCode: Output<String>? = null, val parent: Output<String>? = null, val transitionRouteGroups: Output<List<String>>? = null, val transitionRoutes: Output<List<CxPageTransitionRouteArgs>>? = null) : ConvertibleToJava<CxPageArgs>

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. To get more information about Page, see:

Link copied to clipboard

Builder for CxPageArgs.

Link copied to clipboard
object CxPageMapper : ResourceMapper<CxPage>
Link copied to clipboard

Builder for CxPage.

Link copied to clipboard
class CxSecuritySettings : KotlinCustomResource

Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect. Multiple security settings can be configured in each location. Each agent can specify the security settings to apply, and each setting can be applied to multiple agents in the same project and location. To get more information about SecuritySettings, see:

Link copied to clipboard
data class CxSecuritySettingsArgs(val audioExportSettings: Output<CxSecuritySettingsAudioExportSettingsArgs>? = null, val deidentifyTemplate: Output<String>? = null, val displayName: Output<String>? = null, val insightsExportSettings: Output<CxSecuritySettingsInsightsExportSettingsArgs>? = null, val inspectTemplate: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val purgeDataTypes: Output<List<String>>? = null, val redactionScope: Output<String>? = null, val redactionStrategy: Output<String>? = null, val retentionStrategy: Output<String>? = null, val retentionWindowDays: Output<Int>? = null) : ConvertibleToJava<CxSecuritySettingsArgs>

Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect. Multiple security settings can be configured in each location. Each agent can specify the security settings to apply, and each setting can be applied to multiple agents in the same project and location. To get more information about SecuritySettings, see:

Link copied to clipboard
Link copied to clipboard
class CxTestCase : KotlinCustomResource

You can use the built-in test feature to uncover bugs and prevent regressions. A test execution verifies that agent responses have not changed for end-user inputs defined in the test case. To get more information about TestCase, see:

Link copied to clipboard
data class CxTestCaseArgs(val displayName: Output<String>? = null, val notes: Output<String>? = null, val parent: Output<String>? = null, val tags: Output<List<String>>? = null, val testCaseConversationTurns: Output<List<CxTestCaseTestCaseConversationTurnArgs>>? = null, val testConfig: Output<CxTestCaseTestConfigArgs>? = null) : ConvertibleToJava<CxTestCaseArgs>

You can use the built-in test feature to uncover bugs and prevent regressions. A test execution verifies that agent responses have not changed for end-user inputs defined in the test case. To get more information about TestCase, see:

Link copied to clipboard
Link copied to clipboard
object CxTestCaseMapper : ResourceMapper<CxTestCase>
Link copied to clipboard
Link copied to clipboard
class CxVersion : KotlinCustomResource

You can create multiple versions of your agent flows and deploy them to separate serving environments. When you edit a flow, you are editing a draft flow. At any point, you can save a draft flow as a flow version. A flow version is an immutable snapshot of your flow data and associated agent data like intents, entities, webhooks, pages, route groups, etc. To get more information about Version, see:

Link copied to clipboard
data class CxVersionArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val parent: Output<String>? = null) : ConvertibleToJava<CxVersionArgs>

You can create multiple versions of your agent flows and deploy them to separate serving environments. When you edit a flow, you are editing a draft flow. At any point, you can save a draft flow as a flow version. A flow version is an immutable snapshot of your flow data and associated agent data like intents, entities, webhooks, pages, route groups, etc. To get more information about Version, see:

Link copied to clipboard
Link copied to clipboard
object CxVersionMapper : ResourceMapper<CxVersion>
Link copied to clipboard
Link copied to clipboard
class CxWebhook : KotlinCustomResource

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. To get more information about Webhook, see:

Link copied to clipboard
data class CxWebhookArgs(val disabled: Output<Boolean>? = null, val displayName: Output<String>? = null, val enableSpellCorrection: Output<Boolean>? = null, val enableStackdriverLogging: Output<Boolean>? = null, val genericWebService: Output<CxWebhookGenericWebServiceArgs>? = null, val parent: Output<String>? = null, val securitySettings: Output<String>? = null, val serviceDirectory: Output<CxWebhookServiceDirectoryArgs>? = null, val timeout: Output<String>? = null) : ConvertibleToJava<CxWebhookArgs>

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. To get more information about Webhook, see:

Link copied to clipboard
Link copied to clipboard
object CxWebhookMapper : ResourceMapper<CxWebhook>
Link copied to clipboard
Link copied to clipboard
class EntityType : KotlinCustomResource

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. To get more information about EntityType, see:

Link copied to clipboard
data class EntityTypeArgs(val displayName: Output<String>? = null, val enableFuzzyExtraction: Output<Boolean>? = null, val entities: Output<List<EntityTypeEntityArgs>>? = null, val kind: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<EntityTypeArgs>

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. To get more information about EntityType, see:

Link copied to clipboard
Link copied to clipboard
object EntityTypeMapper : ResourceMapper<EntityType>
Link copied to clipboard
Link copied to clipboard
class Fulfillment : KotlinCustomResource

By default, your agent responds to a matched intent with a static response. If you're using one of the integration options, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. To get more information about Fulfillment, see:

Link copied to clipboard
data class FulfillmentArgs(val displayName: Output<String>? = null, val enabled: Output<Boolean>? = null, val features: Output<List<FulfillmentFeatureArgs>>? = null, val genericWebService: Output<FulfillmentGenericWebServiceArgs>? = null, val project: Output<String>? = null) : ConvertibleToJava<FulfillmentArgs>

By default, your agent responds to a matched intent with a static response. If you're using one of the integration options, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. To get more information about Fulfillment, see:

Link copied to clipboard
Link copied to clipboard
object FulfillmentMapper : ResourceMapper<Fulfillment>
Link copied to clipboard
Link copied to clipboard
class Intent : KotlinCustomResource

Represents a Dialogflow intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. To get more information about Intent, see:

Link copied to clipboard
data class IntentArgs(val action: Output<String>? = null, val defaultResponsePlatforms: Output<List<String>>? = null, val displayName: Output<String>? = null, val events: Output<List<String>>? = null, val inputContextNames: Output<List<String>>? = null, val isFallback: Output<Boolean>? = null, val mlDisabled: Output<Boolean>? = null, val parentFollowupIntentName: Output<String>? = null, val priority: Output<Int>? = null, val project: Output<String>? = null, val resetContexts: Output<Boolean>? = null, val webhookState: Output<String>? = null) : ConvertibleToJava<IntentArgs>

Represents a Dialogflow intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. To get more information about Intent, see:

Link copied to clipboard

Builder for IntentArgs.

Link copied to clipboard
object IntentMapper : ResourceMapper<Intent>
Link copied to clipboard

Builder for Intent.

Functions

Link copied to clipboard
fun agent(name: String): Agent
suspend fun agent(name: String, block: suspend AgentResourceBuilder.() -> Unit): Agent
Link copied to clipboard
fun cxAgent(name: String): CxAgent
suspend fun cxAgent(name: String, block: suspend CxAgentResourceBuilder.() -> Unit): CxAgent
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun cxFlow(name: String): CxFlow
suspend fun cxFlow(name: String, block: suspend CxFlowResourceBuilder.() -> Unit): CxFlow
Link copied to clipboard
suspend fun cxIntent(name: String, block: suspend CxIntentResourceBuilder.() -> Unit): CxIntent
Link copied to clipboard
fun cxPage(name: String): CxPage
suspend fun cxPage(name: String, block: suspend CxPageResourceBuilder.() -> Unit): CxPage
Link copied to clipboard
suspend fun cxTestCase(name: String, block: suspend CxTestCaseResourceBuilder.() -> Unit): CxTestCase
Link copied to clipboard
suspend fun cxVersion(name: String, block: suspend CxVersionResourceBuilder.() -> Unit): CxVersion
Link copied to clipboard
suspend fun cxWebhook(name: String, block: suspend CxWebhookResourceBuilder.() -> Unit): CxWebhook
Link copied to clipboard
suspend fun entityType(name: String, block: suspend EntityTypeResourceBuilder.() -> Unit): EntityType
Link copied to clipboard
suspend fun fulfillment(name: String, block: suspend FulfillmentResourceBuilder.() -> Unit): Fulfillment
Link copied to clipboard
fun intent(name: String): Intent
suspend fun intent(name: String, block: suspend IntentResourceBuilder.() -> Unit): Intent