Google Cloud Dialogflow v2 API - Namespace Google.Cloud.Dialogflow.V2 (4.8.0)

Classes

Agent

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.

For more information about agents, see the Agent guide.

Agent.Types

Container for nested types declared in the Agent message type.

AgentAssistantFeedback

Detail feedback of Agent Assist result.

AgentAssistantFeedback.Types

Container for nested types declared in the AgentAssistantFeedback message type.

AgentAssistantFeedback.Types.SummarizationFeedback

Feedback for conversation summarization.

AgentAssistantRecord

Represents a record of a human agent assist answer.

AgentName

Resource name for the Agent resource.

Agents

Service for managing [Agents][google.cloud.dialogflow.v2.Agent].

Agents.AgentsBase

Base class for server-side implementations of Agents

Agents.AgentsClient

Client for Agents

AgentsClient

Agents client wrapper, for convenient use.

AgentsClientBuilder

Builder class for AgentsClient to provide simple configuration of credentials, endpoint etc.

AgentsClientImpl

Agents client wrapper implementation, for convenient use.

AgentsSettings

Settings for AgentsClient instances.

AnalyzeContentRequest

The request message for [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].

AnalyzeContentResponse

The response message for [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].

AnnotatedMessagePart

Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.

AnswerFeedback

Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.

AnswerFeedback.Types

Container for nested types declared in the AnswerFeedback message type.

AnswerRecord

Answer records are records to manage answer history and feedbacks for Dialogflow.

Currently, answer record includes:

human agent assistant article suggestion
human agent assistant faq article

It doesn't include:

DetectIntent intent matching
DetectIntent knowledge

Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated.

A typical workflow for customers provide feedback to an answer is:

For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, [AnswerRecord.name][google.cloud.dialogflow.v2.AnswerRecord.name] are returned to the customers.
The customer uses the [AnswerRecord.name][google.cloud.dialogflow.v2.AnswerRecord.name] to call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.

AnswerRecordName

Resource name for the AnswerRecord resource.

AnswerRecords

Service for managing [AnswerRecords][google.cloud.dialogflow.v2.AnswerRecord].

AnswerRecords.AnswerRecordsBase

Base class for server-side implementations of AnswerRecords

AnswerRecords.AnswerRecordsClient

Client for AnswerRecords

AnswerRecordsClient

AnswerRecords client wrapper, for convenient use.

AnswerRecordsClientBuilder

Builder class for AnswerRecordsClient to provide simple configuration of credentials, endpoint etc.

AnswerRecordsClientImpl

AnswerRecords client wrapper implementation, for convenient use.

AnswerRecordsSettings

Settings for AnswerRecordsClient instances.

ArticleAnswer

Represents article answer.

ArticleSuggestionModelMetadata

Metadata for article suggestion models.

AssistQueryParameters

Represents the parameters of human assist query.

AutomatedAgentConfig

Defines the Automated Agent to connect to a conversation.

AutomatedAgentReply

Represents a response from an automated agent.

AutomatedAgentReply.Types

Container for nested types declared in the AutomatedAgentReply message type.

BatchCreateEntitiesRequest

The request message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2.EntityTypes.BatchCreateEntities].

BatchDeleteEntitiesRequest

The request message for [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2.EntityTypes.BatchDeleteEntities].

BatchDeleteEntityTypesRequest

The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchDeleteEntityTypes].

BatchDeleteIntentsRequest

The request message for [Intents.BatchDeleteIntents][google.cloud.dialogflow.v2.Intents.BatchDeleteIntents].

BatchUpdateEntitiesRequest

The request message for [EntityTypes.BatchUpdateEntities][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntities].

BatchUpdateEntityTypesRequest

The request message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes].

BatchUpdateEntityTypesResponse

The response message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes].

BatchUpdateIntentsRequest

BatchUpdateIntentsResponse

The response message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents].

ClearSuggestionFeatureConfigOperationMetadata

Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] operation.

ClearSuggestionFeatureConfigRequest

The request message for [ConversationProfiles.ClearFeature][].

CompleteConversationRequest

The request message for [Conversations.CompleteConversation][google.cloud.dialogflow.v2.Conversations.CompleteConversation].

Context

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.

ContextName

Resource name for the Context resource.

Contexts

Service for managing [Contexts][google.cloud.dialogflow.v2.Context].

Contexts.ContextsBase

Base class for server-side implementations of Contexts

Contexts.ContextsClient

Client for Contexts

ContextsClient

Contexts client wrapper, for convenient use.

ContextsClientBuilder

Builder class for ContextsClient to provide simple configuration of credentials, endpoint etc.

ContextsClientImpl

Contexts client wrapper implementation, for convenient use.

ContextsSettings

Settings for ContextsClient instances.

Conversation

Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

Conversation.Types

Container for nested types declared in the Conversation message type.

ConversationDataset

Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).

ConversationDatasetName

Resource name for the ConversationDataset resource.

ConversationDatasets

Conversation datasets.

Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.

ConversationDatasets.ConversationDatasetsBase

Base class for server-side implementations of ConversationDatasets

ConversationDatasets.ConversationDatasetsClient

Client for ConversationDatasets

ConversationDatasetsClient

ConversationDatasets client wrapper, for convenient use.

ConversationDatasetsClientBuilder

Builder class for ConversationDatasetsClient to provide simple configuration of credentials, endpoint etc.

ConversationDatasetsClientImpl

ConversationDatasets client wrapper implementation, for convenient use.

ConversationDatasetsSettings

Settings for ConversationDatasetsClient instances.

ConversationEvent

Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.

ConversationEvent.Types

Container for nested types declared in the ConversationEvent message type.

ConversationInfo

Represents metadata of a conversation.

ConversationModel

Represents a conversation model.

ConversationModel.Types

Container for nested types declared in the ConversationModel message type.

ConversationModelEvaluation

Represents evaluation result of a conversation model.

ConversationModelEvaluationName

Resource name for the ConversationModelEvaluation resource.

ConversationModelName

Resource name for the ConversationModel resource.

ConversationModels

Manages a collection of models for human agent assistant.

ConversationModels.ConversationModelsBase

Base class for server-side implementations of ConversationModels

ConversationModels.ConversationModelsClient

Client for ConversationModels

ConversationModelsClient

ConversationModels client wrapper, for convenient use.

ConversationModelsClientBuilder

Builder class for ConversationModelsClient to provide simple configuration of credentials, endpoint etc.

ConversationModelsClientImpl

ConversationModels client wrapper implementation, for convenient use.

ConversationModelsSettings

Settings for ConversationModelsClient instances.

ConversationName

Resource name for the Conversation resource.

ConversationPhoneNumber

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

ConversationProfile

Defines the services to connect to incoming Dialogflow conversations.

ConversationProfileName

Resource name for the ConversationProfile resource.

ConversationProfiles

Service for managing [ConversationProfiles][google.cloud.dialogflow.v2.ConversationProfile].

ConversationProfiles.ConversationProfilesBase

Base class for server-side implementations of ConversationProfiles

ConversationProfiles.ConversationProfilesClient

Client for ConversationProfiles

ConversationProfilesClient

ConversationProfiles client wrapper, for convenient use.

ConversationProfilesClientBuilder

Builder class for ConversationProfilesClient to provide simple configuration of credentials, endpoint etc.

ConversationProfilesClientImpl

ConversationProfiles client wrapper implementation, for convenient use.

ConversationProfilesSettings

Settings for ConversationProfilesClient instances.

Conversations

Service for managing [Conversations][google.cloud.dialogflow.v2.Conversation].

Conversations.ConversationsBase

Base class for server-side implementations of Conversations

Conversations.ConversationsClient

Client for Conversations

ConversationsClient

Conversations client wrapper, for convenient use.

ConversationsClientBuilder

Builder class for ConversationsClient to provide simple configuration of credentials, endpoint etc.

ConversationsClientImpl

Conversations client wrapper implementation, for convenient use.

ConversationsSettings

Settings for ConversationsClient instances.

CreateContextRequest

The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2.Contexts.CreateContext].

CreateConversationDatasetOperationMetadata

Metadata for [ConversationDatasets][CreateConversationDataset].

CreateConversationDatasetRequest

The request message for [ConversationDatasets.CreateConversationDataset][google.cloud.dialogflow.v2.ConversationDatasets.CreateConversationDataset].

CreateConversationModelEvaluationOperationMetadata

Metadata for a [ConversationModels.CreateConversationModelEvaluation][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModelEvaluation] operation.

CreateConversationModelEvaluationOperationMetadata.Types

Container for nested types declared in the CreateConversationModelEvaluationOperationMetadata message type.

CreateConversationModelEvaluationRequest

The request message for [ConversationModels.CreateConversationModelEvaluation][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModelEvaluation]

CreateConversationModelOperationMetadata

Metadata for a [ConversationModels.CreateConversationModel][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModel] operation.

CreateConversationModelOperationMetadata.Types

Container for nested types declared in the CreateConversationModelOperationMetadata message type.

CreateConversationModelRequest

The request message for [ConversationModels.CreateConversationModel][google.cloud.dialogflow.v2.ConversationModels.CreateConversationModel]

CreateConversationProfileRequest

The request message for [ConversationProfiles.CreateConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.CreateConversationProfile].

CreateConversationRequest

The request message for [Conversations.CreateConversation][google.cloud.dialogflow.v2.Conversations.CreateConversation].

CreateDocumentRequest

Request message for [Documents.CreateDocument][google.cloud.dialogflow.v2.Documents.CreateDocument].

CreateEntityTypeRequest

The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2.EntityTypes.CreateEntityType].

CreateEnvironmentRequest

The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.v2.Environments.CreateEnvironment].

CreateIntentRequest

The request message for [Intents.CreateIntent][google.cloud.dialogflow.v2.Intents.CreateIntent].

CreateKnowledgeBaseRequest

Request message for [KnowledgeBases.CreateKnowledgeBase][google.cloud.dialogflow.v2.KnowledgeBases.CreateKnowledgeBase].

CreateParticipantRequest

The request message for [Participants.CreateParticipant][google.cloud.dialogflow.v2.Participants.CreateParticipant].

CreateSessionEntityTypeRequest

The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.CreateSessionEntityType].

CreateVersionRequest

The request message for [Versions.CreateVersion][google.cloud.dialogflow.v2.Versions.CreateVersion].

CXSecuritySettingsName

Resource name for the CXSecuritySettings resource.

DeleteAgentRequest

The request message for [Agents.DeleteAgent][google.cloud.dialogflow.v2.Agents.DeleteAgent].

DeleteAllContextsRequest

The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2.Contexts.DeleteAllContexts].

DeleteContextRequest

The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2.Contexts.DeleteContext].

DeleteConversationDatasetOperationMetadata

Metadata for [ConversationDatasets][DeleteConversationDataset].

DeleteConversationDatasetRequest

The request message for [ConversationDatasets.DeleteConversationDataset][google.cloud.dialogflow.v2.ConversationDatasets.DeleteConversationDataset].

DeleteConversationModelOperationMetadata

Metadata for a [ConversationModels.DeleteConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeleteConversationModel] operation.

DeleteConversationModelRequest

The request message for [ConversationModels.DeleteConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeleteConversationModel]

DeleteConversationProfileRequest

The request message for [ConversationProfiles.DeleteConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.DeleteConversationProfile].

This operation fails if the conversation profile is still referenced from a phone number.

DeleteDocumentRequest

Request message for [Documents.DeleteDocument][google.cloud.dialogflow.v2.Documents.DeleteDocument].

DeleteEntityTypeRequest

The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.v2.EntityTypes.DeleteEntityType].

DeleteEnvironmentRequest

The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.v2.Environments.DeleteEnvironment].

DeleteIntentRequest

The request message for [Intents.DeleteIntent][google.cloud.dialogflow.v2.Intents.DeleteIntent].

DeleteKnowledgeBaseRequest

Request message for [KnowledgeBases.DeleteKnowledgeBase][google.cloud.dialogflow.v2.KnowledgeBases.DeleteKnowledgeBase].

DeleteSessionEntityTypeRequest

The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.DeleteSessionEntityType].

DeleteVersionRequest

The request message for [Versions.DeleteVersion][google.cloud.dialogflow.v2.Versions.DeleteVersion].

DeployConversationModelOperationMetadata

Metadata for a [ConversationModels.DeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeployConversationModel] operation.

DeployConversationModelRequest

The request message for [ConversationModels.DeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.DeployConversationModel]

DetectIntentRequest

The request to detect user's intent.

DetectIntentResponse

The message returned from the DetectIntent method.

Document

A knowledge document to be used by a [KnowledgeBase][google.cloud.dialogflow.v2.KnowledgeBase].

For more information, see the knowledge base guide.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Document.Types

Container for nested types declared in the Document message type.

Document.Types.ReloadStatus

The status of a reload attempt.

DocumentName

Resource name for the Document resource.

Documents

Service for managing knowledge [Documents][google.cloud.dialogflow.v2.Document].

Documents.DocumentsBase

Base class for server-side implementations of Documents

Documents.DocumentsClient

Client for Documents

DocumentsClient

Documents client wrapper, for convenient use.

DocumentsClientBuilder

Builder class for DocumentsClient to provide simple configuration of credentials, endpoint etc.

DocumentsClientImpl

Documents client wrapper implementation, for convenient use.

DocumentsSettings

Settings for DocumentsClient instances.

DtmfParameters

The message in the response that indicates the parameters of DTMF.

EntityType

Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.

Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent.

For more information, see the Entity guide.

EntityType.Types

Container for nested types declared in the EntityType message type.

EntityType.Types.Entity

An entity entry for an associated entity type.

EntityTypeBatch

This message is a wrapper around a collection of entity types.

EntityTypeName

Resource name for the EntityType resource.

EntityTypes

Service for managing [EntityTypes][google.cloud.dialogflow.v2.EntityType].

EntityTypes.EntityTypesBase

Base class for server-side implementations of EntityTypes

EntityTypes.EntityTypesClient

Client for EntityTypes

EntityTypesClient

EntityTypes client wrapper, for convenient use.

EntityTypesClientBuilder

Builder class for EntityTypesClient to provide simple configuration of credentials, endpoint etc.

EntityTypesClientImpl

EntityTypes client wrapper implementation, for convenient use.

EntityTypesSettings

Settings for EntityTypesClient instances.

Environment

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.

For more information, see the versions and environments guide.

Environment.Types

Container for nested types declared in the Environment message type.

EnvironmentHistory

The response message for [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2.Environments.GetEnvironmentHistory].

EnvironmentHistory.Types

Container for nested types declared in the EnvironmentHistory message type.

EnvironmentHistory.Types.Entry

Represents an environment history entry.

EnvironmentName

Resource name for the Environment resource.

Environments

Service for managing [Environments][google.cloud.dialogflow.v2.Environment].

Environments.EnvironmentsBase

Base class for server-side implementations of Environments

Environments.EnvironmentsClient

Client for Environments

EnvironmentsClient

Environments client wrapper, for convenient use.

EnvironmentsClientBuilder

Builder class for EnvironmentsClient to provide simple configuration of credentials, endpoint etc.

EnvironmentsClientImpl

Environments client wrapper implementation, for convenient use.

EnvironmentsSettings

Settings for EnvironmentsClient instances.

EvaluationConfig

The configuration for model evaluation.

EvaluationConfig.Types

Container for nested types declared in the EvaluationConfig message type.

EvaluationConfig.Types.SmartComposeConfig

Smart compose specific configuration for evaluation job.

EvaluationConfig.Types.SmartReplyConfig

Smart reply specific configuration for evaluation job.

EventInput

Events allow for matching intents by event name instead of the natural language input. For instance, input <event: { name: "welcome_event", parameters: { name: "Sam" } }> can trigger a personalized welcome response. The parameter name may be used by the agent in the response: "Hello #welcome_event.name! What can I do for you today?".

ExportAgentRequest

The request message for [Agents.ExportAgent][google.cloud.dialogflow.v2.Agents.ExportAgent].

ExportAgentResponse

The response message for [Agents.ExportAgent][google.cloud.dialogflow.v2.Agents.ExportAgent].

ExportDocumentRequest

Request message for [Documents.ExportDocument][google.cloud.dialogflow.v2.Documents.ExportDocument].

ExportOperationMetadata

Metadata related to the Export Data Operations (e.g. ExportDocument).

FaqAnswer

Represents answer from "frequently asked questions".

Fulfillment

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.

Fulfillment.Types

Container for nested types declared in the Fulfillment message type.

Fulfillment.Types.Feature

Whether fulfillment is enabled for the specific feature.

Fulfillment.Types.Feature.Types

Container for nested types declared in the Feature message type.

Fulfillment.Types.GenericWebService

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.

FulfillmentName

Resource name for the Fulfillment resource.

Fulfillments

Service for managing [Fulfillments][google.cloud.dialogflow.v2.Fulfillment].

Fulfillments.FulfillmentsBase

Base class for server-side implementations of Fulfillments

Fulfillments.FulfillmentsClient

Client for Fulfillments

FulfillmentsClient

Fulfillments client wrapper, for convenient use.

FulfillmentsClientBuilder

Builder class for FulfillmentsClient to provide simple configuration of credentials, endpoint etc.

FulfillmentsClientImpl

Fulfillments client wrapper implementation, for convenient use.

FulfillmentsSettings

Settings for FulfillmentsClient instances.

GcsDestination

Google Cloud Storage location for the output.

GcsSources

Google Cloud Storage location for the inputs.

GetAgentRequest

The request message for [Agents.GetAgent][google.cloud.dialogflow.v2.Agents.GetAgent].

GetContextRequest

The request message for [Contexts.GetContext][google.cloud.dialogflow.v2.Contexts.GetContext].

GetConversationDatasetRequest

The request message for [ConversationDatasets.GetConversationDataset][google.cloud.dialogflow.v2.ConversationDatasets.GetConversationDataset].

GetConversationModelEvaluationRequest

The request message for [ConversationModels.GetConversationModelEvaluation][google.cloud.dialogflow.v2.ConversationModels.GetConversationModelEvaluation]

GetConversationModelRequest

The request message for [ConversationModels.GetConversationModel][google.cloud.dialogflow.v2.ConversationModels.GetConversationModel]

GetConversationProfileRequest

The request message for [ConversationProfiles.GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile].

GetConversationRequest

The request message for [Conversations.GetConversation][google.cloud.dialogflow.v2.Conversations.GetConversation].

GetDocumentRequest

Request message for [Documents.GetDocument][google.cloud.dialogflow.v2.Documents.GetDocument].

GetEntityTypeRequest

The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.v2.EntityTypes.GetEntityType].

GetEnvironmentHistoryRequest

The request message for [Environments.GetEnvironmentHistory][google.cloud.dialogflow.v2.Environments.GetEnvironmentHistory].

GetEnvironmentRequest

The request message for [Environments.GetEnvironment][google.cloud.dialogflow.v2.Environments.GetEnvironment].

GetFulfillmentRequest

The request message for [Fulfillments.GetFulfillment][google.cloud.dialogflow.v2.Fulfillments.GetFulfillment].

GetIntentRequest

The request message for [Intents.GetIntent][google.cloud.dialogflow.v2.Intents.GetIntent].

GetKnowledgeBaseRequest

Request message for [KnowledgeBases.GetKnowledgeBase][google.cloud.dialogflow.v2.KnowledgeBases.GetKnowledgeBase].

GetParticipantRequest

The request message for [Participants.GetParticipant][google.cloud.dialogflow.v2.Participants.GetParticipant].

GetSessionEntityTypeRequest

The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.GetSessionEntityType].

GetValidationResultRequest

The request message for [Agents.GetValidationResult][google.cloud.dialogflow.v2.Agents.GetValidationResult].

GetVersionRequest

The request message for [Versions.GetVersion][google.cloud.dialogflow.v2.Versions.GetVersion].

HumanAgentAssistantConfig

Defines the Human Agent Assist to connect to a conversation.

HumanAgentAssistantConfig.Types

Container for nested types declared in the HumanAgentAssistantConfig message type.

HumanAgentAssistantConfig.Types.ConversationModelConfig

Custom conversation models used in agent assist feature.

Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.

HumanAgentAssistantConfig.Types.ConversationProcessConfig

Config to process conversation.

HumanAgentAssistantConfig.Types.MessageAnalysisConfig

Configuration for analyses to run on each conversation message.

HumanAgentAssistantConfig.Types.SuggestionConfig

Detail human agent assistant config.

HumanAgentAssistantConfig.Types.SuggestionFeatureConfig

Config for suggestion features.

HumanAgentAssistantConfig.Types.SuggestionQueryConfig

Config for suggestion query.

HumanAgentAssistantConfig.Types.SuggestionQueryConfig.Types

Container for nested types declared in the SuggestionQueryConfig message type.

HumanAgentAssistantConfig.Types.SuggestionQueryConfig.Types.ContextFilterSettings

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

HumanAgentAssistantConfig.Types.SuggestionQueryConfig.Types.DialogflowQuerySource

Dialogflow source setting.

Supported feature: DIALOGFLOW_ASSIST.

HumanAgentAssistantConfig.Types.SuggestionQueryConfig.Types.DocumentQuerySource

Document source settings.

Supported features: SMART_REPLY, SMART_COMPOSE.

HumanAgentAssistantConfig.Types.SuggestionQueryConfig.Types.KnowledgeBaseQuerySource

Knowledge base source settings.

Supported features: ARTICLE_SUGGESTION, FAQ.

HumanAgentAssistantConfig.Types.SuggestionTriggerSettings

Settings of suggestion trigger.

HumanAgentAssistantEvent

Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.

HumanAgentHandoffConfig

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.

HumanAgentHandoffConfig.Types

Container for nested types declared in the HumanAgentHandoffConfig message type.

HumanAgentHandoffConfig.Types.LivePersonConfig

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

HumanAgentHandoffConfig.Types.SalesforceLiveAgentConfig

Configuration specific to Salesforce Live Agent.

ImportAgentRequest

The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2.Agents.ImportAgent].

ImportConversationDataOperationMetadata

Metadata for a [ConversationDatasets.ImportConversationData][google.cloud.dialogflow.v2.ConversationDatasets.ImportConversationData] operation.

ImportConversationDataOperationResponse

Response used for [ConversationDatasets.ImportConversationData][google.cloud.dialogflow.v2.ConversationDatasets.ImportConversationData] long running operation.

ImportConversationDataRequest

The request message for [ConversationDatasets.ImportConversationData][google.cloud.dialogflow.v2.ConversationDatasets.ImportConversationData].

ImportDocumentsRequest

Request message for [Documents.ImportDocuments][google.cloud.dialogflow.v2.Documents.ImportDocuments].

ImportDocumentsResponse

Response message for [Documents.ImportDocuments][google.cloud.dialogflow.v2.Documents.ImportDocuments].

ImportDocumentTemplate

The template used for importing documents.

InputAudioConfig

Instructs the speech recognizer how to process the audio content.

InputConfig

Represents the configuration of importing a set of conversation files in Google Cloud Storage.

InputDataset

InputDataset used to create model or do evaluation. NextID:5

InputTextConfig

Defines the language used in the input text.

Intent

An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.

For more information, see the intent guide.

Intent.Types

Container for nested types declared in the Intent message type.

Intent.Types.FollowupIntentInfo

Represents a single followup intent in the chain.

Intent.Types.Message

A rich response message. Corresponds to the intent Response field in the Dialogflow console. For more information, see Rich response messages.

Intent.Types.Message.Types

Container for nested types declared in the Message message type.

Intent.Types.Message.Types.BasicCard

The basic card message. Useful for displaying information.

Intent.Types.Message.Types.BasicCard.Types

Container for nested types declared in the BasicCard message type.

Intent.Types.Message.Types.BasicCard.Types.Button

The button object that appears at the bottom of a card.

Intent.Types.Message.Types.BasicCard.Types.Button.Types

Container for nested types declared in the Button message type.

Intent.Types.Message.Types.BasicCard.Types.Button.Types.OpenUriAction

Opens the given URI.

Intent.Types.Message.Types.BrowseCarouselCard

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

Intent.Types.Message.Types.BrowseCarouselCard.Types

Container for nested types declared in the BrowseCarouselCard message type.

Intent.Types.Message.Types.BrowseCarouselCard.Types.BrowseCarouselCardItem

Browsing carousel tile

Intent.Types.Message.Types.BrowseCarouselCard.Types.BrowseCarouselCardItem.Types

Container for nested types declared in the BrowseCarouselCardItem message type.

Intent.Types.Message.Types.BrowseCarouselCard.Types.BrowseCarouselCardItem.Types.OpenUrlAction

Actions on Google action to open a given url.

Intent.Types.Message.Types.BrowseCarouselCard.Types.BrowseCarouselCardItem.Types.OpenUrlAction.Types

Container for nested types declared in the OpenUrlAction message type.

Intent.Types.Message.Types.Card

The card response message.

Intent.Types.Message.Types.Card.Types

Container for nested types declared in the Card message type.

Intent.Types.Message.Types.Card.Types.Button

Contains information about a button.

Intent.Types.Message.Types.CarouselSelect

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

Intent.Types.Message.Types.CarouselSelect.Types

Container for nested types declared in the CarouselSelect message type.

Intent.Types.Message.Types.CarouselSelect.Types.Item

An item in the carousel.

Intent.Types.Message.Types.ColumnProperties

Column properties for [TableCard][google.cloud.dialogflow.v2.Intent.Message.TableCard].

Intent.Types.Message.Types.ColumnProperties.Types

Container for nested types declared in the ColumnProperties message type.

Intent.Types.Message.Types.Image

The image response message.

Intent.Types.Message.Types.LinkOutSuggestion

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

Intent.Types.Message.Types.ListSelect

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

Intent.Types.Message.Types.ListSelect.Types

Container for nested types declared in the ListSelect message type.

Intent.Types.Message.Types.ListSelect.Types.Item

An item in the list.

Intent.Types.Message.Types.MediaContent

The media content card for Actions on Google.

Intent.Types.Message.Types.MediaContent.Types

Container for nested types declared in the MediaContent message type.

Intent.Types.Message.Types.MediaContent.Types.ResponseMediaObject

Response media object for media content card.

Intent.Types.Message.Types.QuickReplies

The quick replies response message.

Intent.Types.Message.Types.SelectItemInfo

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

Intent.Types.Message.Types.SimpleResponse

The simple response message containing speech or text.

Intent.Types.Message.Types.SimpleResponses

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

Intent.Types.Message.Types.Suggestion

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

Intent.Types.Message.Types.Suggestions

The collection of suggestions.

Intent.Types.Message.Types.TableCard

Table card for Actions on Google.

Intent.Types.Message.Types.TableCardCell

Cell of [TableCardRow][google.cloud.dialogflow.v2.Intent.Message.TableCardRow].

Intent.Types.Message.Types.TableCardRow

Row of [TableCard][google.cloud.dialogflow.v2.Intent.Message.TableCard].

Intent.Types.Message.Types.Text

The text response message.

Intent.Types.Parameter

Represents intent parameters.

Intent.Types.TrainingPhrase

Represents an example that the agent is trained on.

Intent.Types.TrainingPhrase.Types

Container for nested types declared in the TrainingPhrase message type.

Intent.Types.TrainingPhrase.Types.Part

Represents a part of a training phrase.

IntentBatch

This message is a wrapper around a collection of intents.

IntentName

Resource name for the Intent resource.

Intents

Service for managing [Intents][google.cloud.dialogflow.v2.Intent].

Intents.IntentsBase

Base class for server-side implementations of Intents

Intents.IntentsClient

Client for Intents

IntentsClient

Intents client wrapper, for convenient use.

IntentsClientBuilder

Builder class for IntentsClient to provide simple configuration of credentials, endpoint etc.

IntentsClientImpl

Intents client wrapper implementation, for convenient use.

IntentsSettings

Settings for IntentsClient instances.

KnowledgeBase

A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input.

For more information, see the knowledge base guide.

Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

KnowledgeBaseName

Resource name for the KnowledgeBase resource.

KnowledgeBases

Service for managing [KnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBase].

KnowledgeBases.KnowledgeBasesBase

Base class for server-side implementations of KnowledgeBases

KnowledgeBases.KnowledgeBasesClient

Client for KnowledgeBases

KnowledgeBasesClient

KnowledgeBases client wrapper, for convenient use.

KnowledgeBasesClientBuilder

Builder class for KnowledgeBasesClient to provide simple configuration of credentials, endpoint etc.

KnowledgeBasesClientImpl

KnowledgeBases client wrapper implementation, for convenient use.

KnowledgeBasesSettings

Settings for KnowledgeBasesClient instances.

KnowledgeOperationMetadata

Metadata in google::longrunning::Operation for Knowledge operations.

KnowledgeOperationMetadata.Types

Container for nested types declared in the KnowledgeOperationMetadata message type.

ListAnswerRecordsRequest

Request message for [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2.AnswerRecords.ListAnswerRecords].

ListAnswerRecordsResponse

Response message for [AnswerRecords.ListAnswerRecords][google.cloud.dialogflow.v2.AnswerRecords.ListAnswerRecords].

ListContextsRequest

The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2.Contexts.ListContexts].

ListContextsResponse

The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2.Contexts.ListContexts].

ListConversationDatasetsRequest

The request message for [ConversationDatasets.ListConversationDatasets][google.cloud.dialogflow.v2.ConversationDatasets.ListConversationDatasets].

ListConversationDatasetsResponse

The response message for [ConversationDatasets.ListConversationDatasets][google.cloud.dialogflow.v2.ConversationDatasets.ListConversationDatasets].

ListConversationModelEvaluationsRequest

The request message for [ConversationModels.ListConversationModelEvaluations][google.cloud.dialogflow.v2.ConversationModels.ListConversationModelEvaluations]

ListConversationModelEvaluationsResponse

The response message for [ConversationModels.ListConversationModelEvaluations][google.cloud.dialogflow.v2.ConversationModels.ListConversationModelEvaluations]

ListConversationModelsRequest

The request message for [ConversationModels.ListConversationModels][google.cloud.dialogflow.v2.ConversationModels.ListConversationModels]

ListConversationModelsResponse

The response message for [ConversationModels.ListConversationModels][google.cloud.dialogflow.v2.ConversationModels.ListConversationModels]

ListConversationProfilesRequest

The request message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2.ConversationProfiles.ListConversationProfiles].

ListConversationProfilesResponse

The response message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2.ConversationProfiles.ListConversationProfiles].

ListConversationsRequest

The request message for [Conversations.ListConversations][google.cloud.dialogflow.v2.Conversations.ListConversations].

ListConversationsResponse

The response message for [Conversations.ListConversations][google.cloud.dialogflow.v2.Conversations.ListConversations].

ListDocumentsRequest

Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2.Documents.ListDocuments].

ListDocumentsResponse

Response message for [Documents.ListDocuments][google.cloud.dialogflow.v2.Documents.ListDocuments].

ListEntityTypesRequest

The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.EntityTypes.ListEntityTypes].

ListEntityTypesResponse

The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.EntityTypes.ListEntityTypes].

ListEnvironmentsRequest

The request message for [Environments.ListEnvironments][google.cloud.dialogflow.v2.Environments.ListEnvironments].

ListEnvironmentsResponse

The response message for [Environments.ListEnvironments][google.cloud.dialogflow.v2.Environments.ListEnvironments].

ListIntentsRequest

The request message for [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].

ListIntentsResponse

The response message for [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].

ListKnowledgeBasesRequest

Request message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBases.ListKnowledgeBases].

ListKnowledgeBasesResponse

Response message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBases.ListKnowledgeBases].

ListMessagesRequest

The request message for [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages].

ListMessagesResponse

The response message for [Conversations.ListMessages][google.cloud.dialogflow.v2.Conversations.ListMessages].

ListParticipantsRequest

The request message for [Participants.ListParticipants][google.cloud.dialogflow.v2.Participants.ListParticipants].

ListParticipantsResponse

The response message for [Participants.ListParticipants][google.cloud.dialogflow.v2.Participants.ListParticipants].

ListSessionEntityTypesRequest

The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityTypes.ListSessionEntityTypes].

ListSessionEntityTypesResponse

The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityTypes.ListSessionEntityTypes].

ListVersionsRequest

The request message for [Versions.ListVersions][google.cloud.dialogflow.v2.Versions.ListVersions].

ListVersionsResponse

The response message for [Versions.ListVersions][google.cloud.dialogflow.v2.Versions.ListVersions].

LoggingConfig

Defines logging behavior for conversation lifecycle events.

Message

Represents a message posted into a conversation.

MessageAnnotation

Represents the result of annotation for the message.

MessageName

Resource name for the Message resource.

ModelName

Resource name for the Model resource.

NotificationConfig

Defines notification behavior.

NotificationConfig.Types

Container for nested types declared in the NotificationConfig message type.

OriginalDetectIntentRequest

Represents the contents of the original request that was passed to the [Streaming]DetectIntent call.

OutputAudio

Represents the natural language speech audio to be played to the end user.

OutputAudioConfig

Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.

Participant

Represents a conversation participant (human agent, virtual agent, end-user).

Participant.Types

Container for nested types declared in the Participant message type.

ParticipantName

Resource name for the Participant resource.

Participants

Service for managing [Participants][google.cloud.dialogflow.v2.Participant].

Participants.ParticipantsBase

Base class for server-side implementations of Participants

Participants.ParticipantsClient

Client for Participants

ParticipantsClient

Participants client wrapper, for convenient use.

ParticipantsClient.StreamingAnalyzeContentStream

Bidirectional streaming methods for StreamingAnalyzeContent(CallSettings, BidirectionalStreamingSettings).

ParticipantsClientBuilder

Builder class for ParticipantsClient to provide simple configuration of credentials, endpoint etc.

ParticipantsClientImpl

Participants client wrapper implementation, for convenient use.

ParticipantsSettings

Settings for ParticipantsClient instances.

PhraseSetName

Resource name for the PhraseSet resource.

QueryInput

Represents the query input. It can contain either:

An audio config which instructs the speech recognizer how to process the speech audio.
A conversational query in the form of text,.
An event that specifies which intent to trigger.

QueryParameters

Represents the parameters of the conversational query.

QueryResult

Represents the result of conversational query or event processing.

ReloadDocumentRequest

Request message for [Documents.ReloadDocument][google.cloud.dialogflow.v2.Documents.ReloadDocument].

RestoreAgentRequest

The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2.Agents.RestoreAgent].

SearchAgentsRequest

The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].

SearchAgentsResponse

The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].

Sentiment

The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.

SentimentAnalysisRequestConfig

Configures the types of sentiment analysis to perform.

SentimentAnalysisResult

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For [Participants.DetectIntent][], it needs to be configured in [DetectIntentRequest.query_params][google.cloud.dialogflow.v2.DetectIntentRequest.query_params]. For [Participants.StreamingDetectIntent][], it needs to be configured in [StreamingDetectIntentRequest.query_params][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_params]. And for [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent] and [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent], it needs to be configured in [ConversationProfile.human_agent_assistant_config][google.cloud.dialogflow.v2.ConversationProfile.human_agent_assistant_config]

SessionEntityType

A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the session entity guide.

SessionEntityType.Types

Container for nested types declared in the SessionEntityType message type.

SessionEntityTypeName

Resource name for the SessionEntityType resource.

SessionEntityTypes

Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityType].

SessionEntityTypes.SessionEntityTypesBase

Base class for server-side implementations of SessionEntityTypes

SessionEntityTypes.SessionEntityTypesClient

Client for SessionEntityTypes

SessionEntityTypesClient

SessionEntityTypes client wrapper, for convenient use.

SessionEntityTypesClientBuilder

Builder class for SessionEntityTypesClient to provide simple configuration of credentials, endpoint etc.

SessionEntityTypesClientImpl

SessionEntityTypes client wrapper implementation, for convenient use.

SessionEntityTypesSettings

Settings for SessionEntityTypesClient instances.

SessionName

Resource name for the Session resource.

Sessions

A service used for session interactions.

For more information, see the API interactions guide.

Sessions.SessionsBase

Base class for server-side implementations of Sessions

Sessions.SessionsClient

Client for Sessions

SessionsClient

Sessions client wrapper, for convenient use.

SessionsClient.StreamingDetectIntentStream

Bidirectional streaming methods for StreamingDetectIntent(CallSettings, BidirectionalStreamingSettings).

SessionsClientBuilder

Builder class for SessionsClient to provide simple configuration of credentials, endpoint etc.

SessionsClientImpl

Sessions client wrapper implementation, for convenient use.

SessionsSettings

Settings for SessionsClient instances.

SetAgentRequest

The request message for [Agents.SetAgent][google.cloud.dialogflow.v2.Agents.SetAgent].

SetSuggestionFeatureConfigOperationMetadata

Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] operation.

SetSuggestionFeatureConfigRequest

The request message for [ConversationProfiles.SetSuggestionFeature][].

SmartReplyAnswer

Represents a smart reply answer.

SmartReplyMetrics

The evaluation metrics for smart reply model.

SmartReplyMetrics.Types

Container for nested types declared in the SmartReplyMetrics message type.

SmartReplyMetrics.Types.TopNMetrics

Evaluation metrics when retrieving n smart replies with the model.

SmartReplyModelMetadata

Metadata for smart reply models.

SpeechContext

Hints for the speech recognizer to help with recognition in a specific conversation state.

SpeechToTextConfig

Configures speech transcription for [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile].

SpeechWordInfo

Information for a word recognized by the speech recognizer.

StreamingAnalyzeContentRequest

The top-level message sent by the client to the [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent] method.

Multiple request messages should be sent in order:

The first message must contain [participant][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.participant], [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] and optionally [query_params][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.query_params]. If you want to receive an audio response, it should also contain [reply_audio_config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.reply_audio_config]. The message must not contain [input][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input].
If [config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message was set to [audio_config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.audio_config], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input_audio] to continue with Speech recognition. However, note that:

Dialogflow will bill you for the audio so far.
Dialogflow discards all Speech recognition results in favor of the text input.

If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.config] in the first message was set to [StreamingAnalyzeContentRequest.text_config][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.text_config], then the second message must contain only [input_text][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.input_text]. Moreover, you must not send more than two messages.

After you sent all input, you must half-close or abort the request stream.

StreamingAnalyzeContentResponse

The top-level message returned from the StreamingAnalyzeContent method.

Multiple response messages can be returned in order:

If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.
In virtual agent stage: if enable_partial_automated_agent_reply is true, the following N (currently 1 <= N <= 4) messages contain automated_agent_reply and optionally reply_audio returned by the virtual agent. The first (N-1) automated_agent_replys will have automated_agent_reply_type set to PARTIAL. The last automated_agent_reply has automated_agent_reply_type set to FINAL. If enable_partial_automated_agent_reply is not enabled, response stream only contains the final reply.

In human assist stage: the following N (N >= 1) messages contain human_agent_suggestion_results, end_user_suggestion_results or message.

StreamingDetectIntentRequest

The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent] method.

Multiple request messages should be sent in order:

The first message must contain [session][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]. The message must not contain [input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio].
If [query_input][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_input] was set to [query_input.audio_config][google.cloud.dialogflow.v2.InputAudioConfig], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio] to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with [query_input.text][google.cloud.dialogflow.v2.QueryInput.text].

However, note that:

Dialogflow will bill you for the audio duration so far.
Dialogflow discards all Speech recognition results in favor of the input text.
Dialogflow will use the language code from the first message.

After you sent all input, you must half-close or abort the request stream.

StreamingDetectIntentResponse

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

If the StreamingDetectIntentRequest.input_audio field was set, the recognition_result field is populated for one or more messages. See the [StreamingRecognitionResult][google.cloud.dialogflow.v2.StreamingRecognitionResult] message for details about the result message sequence.
The next message contains response_id, query_result and optionally webhook_status if a WebHook was called.

StreamingRecognitionResult

Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.

While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript.

If StreamingDetectIntentRequest.query_input.audio_config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to `END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript.

The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.

In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.

Num | transcript              | message_type            | is_final
--- | ----------------------- | ----------------------- | --------
1   | &quot;tube&quot;                  | TRANSCRIPT              | false
2   | &quot;to be a&quot;               | TRANSCRIPT              | false
3   | &quot;to be&quot;                 | TRANSCRIPT              | false
4   | &quot;to be or not to be&quot;    | TRANSCRIPT              | true
5   | &quot;that&apos;s&quot;                | TRANSCRIPT              | false
6   | &quot;that is                | TRANSCRIPT              | false
7   | unset                   | END_OF_SINGLE_UTTERANCE | unset
8   | &quot; that is the question&quot; | TRANSCRIPT              | true

Concatenating the finalized transcripts with is_final set to true, the complete utterance becomes "to be or not to be that is the question".

StreamingRecognitionResult.Types

Container for nested types declared in the StreamingRecognitionResult message type.

SuggestArticlesRequest

The request message for [Participants.SuggestArticles][google.cloud.dialogflow.v2.Participants.SuggestArticles].

SuggestArticlesResponse

The response message for [Participants.SuggestArticles][google.cloud.dialogflow.v2.Participants.SuggestArticles].

SuggestConversationSummaryRequest

The request message for [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2.Conversations.SuggestConversationSummary].

SuggestConversationSummaryResponse

The response message for [Conversations.SuggestConversationSummary][google.cloud.dialogflow.v2.Conversations.SuggestConversationSummary].

SuggestConversationSummaryResponse.Types

Container for nested types declared in the SuggestConversationSummaryResponse message type.

SuggestConversationSummaryResponse.Types.Summary

Generated summary for a conversation.

SuggestFaqAnswersRequest

The request message for [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2.Participants.SuggestFaqAnswers].

SuggestFaqAnswersResponse

The request message for [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2.Participants.SuggestFaqAnswers].

SuggestionFeature

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.

SuggestionFeature.Types

Container for nested types declared in the SuggestionFeature message type.

SuggestionResult

One response of different type of suggestion response which is used in the response of [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent] and [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent], as well as [HumanAgentAssistantEvent][google.cloud.dialogflow.v2.HumanAgentAssistantEvent].

SuggestSmartRepliesRequest

The request message for [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2.Participants.SuggestSmartReplies].

SuggestSmartRepliesResponse

The response message for [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2.Participants.SuggestSmartReplies].

SynthesizeSpeechConfig

Configuration of how speech should be synthesized.

TelephonyDtmfEvents

A wrapper of repeated TelephonyDtmf digits.

TextInput

============================================================================ Auxiliary proto messages.

Represents the natural language text to be processed.

TextToSpeechSettings

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

TrainAgentRequest

The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent].

UndeployConversationModelOperationMetadata

Metadata for a [ConversationModels.UndeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.UndeployConversationModel] operation.

UndeployConversationModelRequest

The request message for [ConversationModels.UndeployConversationModel][google.cloud.dialogflow.v2.ConversationModels.UndeployConversationModel]

UpdateAnswerRecordRequest

Request message for [AnswerRecords.UpdateAnswerRecord][google.cloud.dialogflow.v2.AnswerRecords.UpdateAnswerRecord].

UpdateContextRequest

The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2.Contexts.UpdateContext].

UpdateConversationProfileRequest

The request message for [ConversationProfiles.UpdateConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.UpdateConversationProfile].

UpdateDocumentRequest

Request message for [Documents.UpdateDocument][google.cloud.dialogflow.v2.Documents.UpdateDocument].

UpdateEntityTypeRequest

The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes.UpdateEntityType].

UpdateEnvironmentRequest

The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.v2.Environments.UpdateEnvironment].

UpdateFulfillmentRequest

The request message for [Fulfillments.UpdateFulfillment][google.cloud.dialogflow.v2.Fulfillments.UpdateFulfillment].

UpdateIntentRequest

The request message for [Intents.UpdateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent].

UpdateKnowledgeBaseRequest

Request message for [KnowledgeBases.UpdateKnowledgeBase][google.cloud.dialogflow.v2.KnowledgeBases.UpdateKnowledgeBase].

UpdateParticipantRequest

The request message for [Participants.UpdateParticipant][google.cloud.dialogflow.v2.Participants.UpdateParticipant].

UpdateSessionEntityTypeRequest

The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.UpdateSessionEntityType].

UpdateVersionRequest

The request message for [Versions.UpdateVersion][google.cloud.dialogflow.v2.Versions.UpdateVersion].

ValidationError

Represents a single validation error.

ValidationError.Types

Container for nested types declared in the ValidationError message type.

ValidationResult

Represents the output of agent validation.

Version

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.

testing
development
production
etc.

For more information, see the versions and environments guide.

Version.Types

Container for nested types declared in the Version message type.

VersionName

Resource name for the Version resource.

Versions

Service for managing [Versions][google.cloud.dialogflow.v2.Version].

Versions.VersionsBase

Base class for server-side implementations of Versions

Versions.VersionsClient

Client for Versions

VersionsClient

Versions client wrapper, for convenient use.

VersionsClientBuilder

Builder class for VersionsClient to provide simple configuration of credentials, endpoint etc.

VersionsClientImpl

Versions client wrapper implementation, for convenient use.

VersionsSettings

Settings for VersionsClient instances.

VoiceSelectionParams

Description of which voice to use for speech synthesis.

WebhookRequest

The request message for a webhook call.

WebhookResponse

The response message for a webhook call.

This response is validated by the Dialogflow server. If validation fails, an error will be returned in the [QueryResult.diagnostic_info][google.cloud.dialogflow.v2.QueryResult.diagnostic_info] field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:

Use "" for empty strings
Use {} or null for empty objects
Use [] or null for empty arrays

For more information, see the Protocol Buffers Language Guide.

Enums

Agent.Types.ApiVersion

API version for the agent.

Agent.Types.MatchMode

Match mode determines how intents are detected from user queries.

Agent.Types.Tier

Represents the agent tier.

AgentAssistantFeedback.Types.AnswerRelevance

Relevance of an answer.

AgentAssistantFeedback.Types.DocumentCorrectness

Correctness of document.

AgentAssistantFeedback.Types.DocumentEfficiency

Efficiency of document.

AgentAssistantRecord.AnswerOneofCase

Enum of possible cases for the "answer" oneof.

AgentName.ResourceNameType

The possible contents of AgentName.

AnalyzeContentRequest.InputOneofCase

Enum of possible cases for the "input" oneof.

AnswerFeedback.DetailFeedbackOneofCase

Enum of possible cases for the "detail_feedback" oneof.

AnswerFeedback.Types.CorrectnessLevel

The correctness level of an answer.

AnswerRecord.RecordOneofCase

Enum of possible cases for the "record" oneof.

AnswerRecordName.ResourceNameType

The possible contents of AnswerRecordName.

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.

AutomatedAgentReply.Types.AutomatedAgentReplyType

Represents different automated agent reply types.

BatchUpdateEntityTypesRequest.EntityTypeBatchOneofCase

Enum of possible cases for the "entity_type_batch" oneof.

BatchUpdateIntentsRequest.IntentBatchOneofCase

Enum of possible cases for the "intent_batch" oneof.

ContextName.ResourceNameType

The possible contents of ContextName.

Conversation.Types.ConversationStage

Enumeration of the different conversation stages a conversation can be in. Reference: https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages

Conversation.Types.LifecycleState

Enumeration of the completion status of the conversation.

ConversationDatasetName.ResourceNameType

The possible contents of ConversationDatasetName.

ConversationEvent.PayloadOneofCase

Enum of possible cases for the "payload" oneof.

ConversationEvent.Types.Type

Enumeration of the types of events available.

ConversationModel.ModelMetadataOneofCase

Enum of possible cases for the "model_metadata" oneof.

ConversationModel.Types.ModelType

Model type.

ConversationModel.Types.State

State of the model.

ConversationModelEvaluation.MetricsOneofCase

Enum of possible cases for the "metrics" oneof.

ConversationModelEvaluationName.ResourceNameType

The possible contents of ConversationModelEvaluationName.

ConversationModelName.ResourceNameType

The possible contents of ConversationModelName.

ConversationName.ResourceNameType

The possible contents of ConversationName.

ConversationProfileName.ResourceNameType

The possible contents of ConversationProfileName.

CreateConversationModelEvaluationOperationMetadata.Types.State

State of CreateConversationModel operation.

CreateConversationModelOperationMetadata.Types.State

State of CreateConversationModel operation.

CXSecuritySettingsName.ResourceNameType

The possible contents of CXSecuritySettingsName.

Document.SourceOneofCase

Enum of possible cases for the "source" oneof.

Document.Types.KnowledgeType

The knowledge type of document content.

Document.Types.State

Possible states of the document

DocumentName.ResourceNameType

The possible contents of DocumentName.

EntityType.Types.AutoExpansionMode

Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).

EntityType.Types.Kind

Represents kinds of entities.

EntityTypeName.ResourceNameType

The possible contents of EntityTypeName.

Environment.Types.State

Represents an environment state. When an environment is pointed to a new agent version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state.

EnvironmentName.ResourceNameType

The possible contents of EnvironmentName.

EvaluationConfig.ModelSpecificConfigOneofCase

Enum of possible cases for the "model_specific_config" oneof.

ExportAgentResponse.AgentOneofCase

Enum of possible cases for the "agent" oneof.

ExportDocumentRequest.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

Fulfillment.FulfillmentOneofCase

Enum of possible cases for the "fulfillment" oneof.

Fulfillment.Types.Feature.Types.Type

The type of the feature.

FulfillmentName.ResourceNameType

The possible contents of FulfillmentName.

HumanAgentAssistantConfig.Types.SuggestionQueryConfig.QuerySourceOneofCase

Enum of possible cases for the "query_source" oneof.

HumanAgentHandoffConfig.AgentServiceOneofCase

Enum of possible cases for the "agent_service" oneof.

ImportAgentRequest.AgentOneofCase

Enum of possible cases for the "agent" oneof.

ImportDocumentsRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

InputConfig.SourceOneofCase

Enum of possible cases for the "source" oneof.

Intent.Types.Message.MessageOneofCase

Enum of possible cases for the "message" oneof.

Intent.Types.Message.Types.BrowseCarouselCard.Types.BrowseCarouselCardItem.Types.OpenUrlAction.Types.UrlTypeHint

Type of the URI.

Intent.Types.Message.Types.BrowseCarouselCard.Types.ImageDisplayOptions

Image display options for Actions on Google. This should be used for when the image's aspect ratio does not match the image container's aspect ratio.

Intent.Types.Message.Types.ColumnProperties.Types.HorizontalAlignment

Text alignments within a cell.

Intent.Types.Message.Types.MediaContent.Types.ResponseMediaObject.ImageOneofCase

Enum of possible cases for the "image" oneof.

Intent.Types.Message.Types.MediaContent.Types.ResponseMediaType

Format of response media type.

Intent.Types.Message.Types.Platform

The rich response message integration platform. See Integrations.

Intent.Types.TrainingPhrase.Types.Type

Represents different types of training phrases.

Intent.Types.WebhookState

Represents the different states that webhooks can be in.

IntentName.ResourceNameType

The possible contents of IntentName.

IntentView

Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response by default.

KnowledgeBaseName.ResourceNameType

The possible contents of KnowledgeBaseName.

KnowledgeOperationMetadata.OperationMetadataOneofCase

Enum of possible cases for the "operation_metadata" oneof.

KnowledgeOperationMetadata.Types.State

States of the operation.

MessageName.ResourceNameType

The possible contents of MessageName.

ModelName.ResourceNameType

The possible contents of ModelName.

NotificationConfig.Types.MessageFormat

Format of cloud pub/sub message.

OutputAudioEncoding

Audio encoding of the output audio format in Text-To-Speech.

Participant.Types.Role

Enumeration of the roles a participant can play in a conversation.

ParticipantName.ResourceNameType

The possible contents of ParticipantName.

PhraseSetName.ResourceNameType

The possible contents of PhraseSetName.

QueryInput.InputOneofCase

Enum of possible cases for the "input" oneof.

ReloadDocumentRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

RestoreAgentRequest.AgentOneofCase

Enum of possible cases for the "agent" oneof.

SessionEntityType.Types.EntityOverrideMode

The types of modifications for a session entity type.

SessionEntityTypeName.ResourceNameType

The possible contents of SessionEntityTypeName.

SessionName.ResourceNameType

The possible contents of SessionName.

SpeechModelVariant

Variant of the specified [Speech model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.

See the Cloud Speech documentation for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.