Package-level declarations

Types

Link copied to clipboard
data class GetContextResult(val lifespanCount: Int, val name: String, val parameters: Map<String, String>)
Link copied to clipboard
data class GetConversationProfileResult(val automatedAgentConfig: GoogleCloudDialogflowV2beta1AutomatedAgentConfigResponse, val createTime: String, val displayName: String, val humanAgentAssistantConfig: GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigResponse, val humanAgentHandoffConfig: GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigResponse, val languageCode: String, val loggingConfig: GoogleCloudDialogflowV2beta1LoggingConfigResponse, val name: String, val newMessageEventNotificationConfig: GoogleCloudDialogflowV2beta1NotificationConfigResponse, val notificationConfig: GoogleCloudDialogflowV2beta1NotificationConfigResponse, val securitySettings: String, val sttConfig: GoogleCloudDialogflowV2beta1SpeechToTextConfigResponse, val timeZone: String, val ttsConfig: GoogleCloudDialogflowV2beta1SynthesizeSpeechConfigResponse, val updateTime: String)
Link copied to clipboard
data class GetConversationResult(val conversationProfile: String, val conversationStage: String, val endTime: String, val lifecycleState: String, val name: String, val phoneNumber: GoogleCloudDialogflowV2beta1ConversationPhoneNumberResponse, val startTime: String)
Link copied to clipboard
data class GetDocumentResult(val content: String, val contentUri: String, val displayName: String, val enableAutoReload: Boolean, val knowledgeTypes: List<String>, val latestReloadStatus: GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse, val metadata: Map<String, String>, val mimeType: String, val name: String, val rawContent: String, val state: String)
Link copied to clipboard
data class GetEntityTypeResult(val autoExpansionMode: String, val displayName: String, val enableFuzzyExtraction: Boolean, val entities: List<GoogleCloudDialogflowV2beta1EntityTypeEntityResponse>, val kind: String, val name: String)
Link copied to clipboard
data class GetEnvironmentResult(val agentVersion: String, val description: String, val fulfillment: GoogleCloudDialogflowV2beta1FulfillmentResponse, val name: String, val state: String, val textToSpeechSettings: GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse, val updateTime: String)
Link copied to clipboard
data class GetIntentResult(val action: String, val defaultResponsePlatforms: List<String>, val displayName: String, val endInteraction: Boolean, val events: List<String>, val followupIntentInfo: List<GoogleCloudDialogflowV2beta1IntentFollowupIntentInfoResponse>, val inputContextNames: List<String>, val isFallback: Boolean, val liveAgentHandoff: Boolean, val messages: List<GoogleCloudDialogflowV2beta1IntentMessageResponse>, val mlDisabled: Boolean, val mlEnabled: Boolean, val name: String, val outputContexts: List<GoogleCloudDialogflowV2beta1ContextResponse>, val parameters: List<GoogleCloudDialogflowV2beta1IntentParameterResponse>, val parentFollowupIntentName: String, val priority: Int, val resetContexts: Boolean, val rootFollowupIntentName: String, val trainingPhrases: List<GoogleCloudDialogflowV2beta1IntentTrainingPhraseResponse>, val webhookState: String)
Link copied to clipboard
data class GetKnowledgeBaseResult(val displayName: String, val languageCode: String, val name: String)
Link copied to clipboard
data class GetParticipantResult(val documentsMetadataFilters: Map<String, String>, val name: String, val obfuscatedExternalUserId: String, val role: String)
Link copied to clipboard
data class GetSessionEntityTypeResult(val entities: List<GoogleCloudDialogflowV2beta1EntityTypeEntityResponse>, val entityOverrideMode: String, val name: String)
Link copied to clipboard
data class GetVersionResult(val createTime: String, val description: String, val name: String, val status: String, val versionNumber: Int)

Defines the Automated Agent to connect to a conversation.

data class GoogleCloudDialogflowV2beta1ContextResponse(val lifespanCount: Int, val name: String, val parameters: Map<String, String>)

Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the Contexts guide.

Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.

The status of a reload attempt.

An entity entry for an associated entity type.

Whether fulfillment is enabled for the specific feature.

data class GoogleCloudDialogflowV2beta1FulfillmentGenericWebServiceResponse(val isCloudFunction: Boolean, val password: String, val requestHeaders: Map<String, String>, val uri: String, val username: String)

Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.

By default, your agent responds to a matched intent with a static response. As an alternative, 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. For more information, see the fulfillment guide.

Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.

data class GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigMessageAnalysisConfigResponse(val enableEntityExtraction: Boolean, val enableSentimentAnalysis: Boolean)

Configuration for analyses to run on each conversation message.

data class GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettingsResponse(val dropHandoffMessages: Boolean, val dropIvrMessages: Boolean, val dropVirtualAgentMessages: Boolean)

Settings that determine how to filter recent conversation context when generating suggestions.

Configuration specific to LivePerson (https://www.liveperson.com).

Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access.

data class GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigSalesforceLiveAgentConfigResponse(val buttonId: String, val deploymentId: String, val endpointDomain: String, val organizationId: String)

Configuration specific to Salesforce Live Agent.

data class GoogleCloudDialogflowV2beta1IntentFollowupIntentInfoResponse(val followupIntentName: String, val parentFollowupIntentName: String)

Represents a single followup intent in the chain.

The basic card message. Useful for displaying information.

Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel

Optional. Contains information about a button.

The card response message.

data class GoogleCloudDialogflowV2beta1IntentMessageColumnPropertiesResponse(val header: String, val horizontalAlignment: String)

Column properties for TableCard.

data class GoogleCloudDialogflowV2beta1IntentMessageImageResponse(val accessibilityText: String, val imageUri: String)

The image response message.

The suggestion chip message that allows the user to jump out to the app or website associated with this agent.

The card for presenting a list of options to select from.

The quick replies response message.

data class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMediaResponse(val fileUri: String, val height: String, val thumbnailUri: String)

Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm

Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.

Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.

Opens the user's default dialer app with the specified phone number but does not dial automatically.

Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI.

Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.

Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).

Rich Business Messaging (RBM) text response with suggestions.

data class GoogleCloudDialogflowV2beta1IntentMessageResponse(val basicCard: GoogleCloudDialogflowV2beta1IntentMessageBasicCardResponse, val browseCarouselCard: GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardResponse, val card: GoogleCloudDialogflowV2beta1IntentMessageCardResponse, val carouselSelect: GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectResponse, val image: GoogleCloudDialogflowV2beta1IntentMessageImageResponse, val linkOutSuggestion: GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestionResponse, val listSelect: GoogleCloudDialogflowV2beta1IntentMessageListSelectResponse, val mediaContent: GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponse, val payload: Map<String, String>, val platform: String, val quickReplies: GoogleCloudDialogflowV2beta1IntentMessageQuickRepliesResponse, val rbmCarouselRichCard: GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCardResponse, val rbmStandaloneRichCard: GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCardResponse, val rbmText: GoogleCloudDialogflowV2beta1IntentMessageRbmTextResponse, val simpleResponses: GoogleCloudDialogflowV2beta1IntentMessageSimpleResponsesResponse, val suggestions: GoogleCloudDialogflowV2beta1IntentMessageSuggestionsResponse, val tableCard: GoogleCloudDialogflowV2beta1IntentMessageTableCardResponse, val telephonyPlayAudio: GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudioResponse, val telephonySynthesizeSpeech: GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeechResponse, val telephonyTransferCall: GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCallResponse, val text: GoogleCloudDialogflowV2beta1IntentMessageTextResponse)

Corresponds to the Response field in the Dialogflow console.

Additional info about the select item for when it is triggered in a dialog.

data class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponseResponse(val displayText: String, val ssml: String, val textToSpeech: String)

The simple response message containing speech or text.

The collection of simple response candidates. This message in QueryResult.fulfillment_messages and WebhookResponse.fulfillment_messages should contain only one SimpleResponse.

The suggestion chip message that the user can tap to quickly post a reply to the conversation.

Plays audio from a file in Telephony Gateway.

Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from DetectIntentResponse.output_audio_config which can either be set at request-level or can come from the agent-level synthesizer config.

Transfers the call in Telephony Gateway.

The text response message.

data class GoogleCloudDialogflowV2beta1IntentParameterResponse(val defaultValue: String, val displayName: String, val entityTypeDisplayName: String, val isList: Boolean, val mandatory: Boolean, val name: String, val prompts: List<String>, val value: String)

Represents intent parameters.

data class GoogleCloudDialogflowV2beta1IntentTrainingPhrasePartResponse(val alias: String, val entityType: String, val text: String, val userDefined: Boolean)

Represents a part of a training phrase.

Represents an example that the agent is trained on.

data class GoogleCloudDialogflowV2beta1LoggingConfigResponse(val enableStackdriverLogging: Boolean)

Defines logging behavior for conversation lifecycle events.

data class GoogleCloudDialogflowV2beta1NotificationConfigResponse(val messageFormat: String, val topic: String)

Defines notification behavior.

data class GoogleCloudDialogflowV2beta1SpeechToTextConfigResponse(val model: String, val speechModelVariant: String)

Configures speech transcription for ConversationProfile.

The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

data class GoogleCloudDialogflowV2beta1SynthesizeSpeechConfigResponse(val effectsProfileId: List<String>, val pitch: Double, val speakingRate: Double, val voice: GoogleCloudDialogflowV2beta1VoiceSelectionParamsResponse, val volumeGainDb: Double)

Configuration of how speech should be synthesized.

data class GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse(val enableTextToSpeech: Boolean, val outputAudioEncoding: String, val sampleRateHertz: Int, val synthesizeSpeechConfigs: Map<String, String>)

Instructs the speech synthesizer on how to generate the output audio content.

Description of which voice to use for speech synthesis.

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.