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

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.

Container for nested types declared in the Agent message type.

Detail feedback of Agent Assist result.

Container for nested types declared in the AgentAssistantFeedback message type.

Represents a record of a human agent assist answer.

Resource name for the Agent resource.

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

Base class for server-side implementations of Agents

Client for Agents

Agents client wrapper, for convenient use.

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

Agents client wrapper implementation, for convenient use.

Settings for AgentsClient instances.

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

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

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.

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

Container for nested types declared in the AnswerFeedback message type.

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:

1. 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.
2. 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.

Resource name for the AnswerRecord resource.

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

Base class for server-side implementations of AnswerRecords

Client for AnswerRecords

AnswerRecords client wrapper, for convenient use.

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

AnswerRecords client wrapper implementation, for convenient use.

Settings for AnswerRecordsClient instances.

Represents article answer.

Metadata for article suggestion models.

Represents the parameters of human assist query.

Defines the Automated Agent to connect to a conversation.

Represents a response from an automated agent.

Container for nested types declared in the AutomatedAgentReply message type.

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

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

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

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

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

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

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

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

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

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

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

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.

Resource name for the Context resource.

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

Base class for server-side implementations of Contexts

Client for Contexts

Contexts client wrapper, for convenient use.

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

Contexts client wrapper implementation, for convenient use.

Settings for ContextsClient instances.

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.

Container for nested types declared in the Conversation message type.

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

Resource name for the ConversationDataset resource.

Conversation datasets.

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

Base class for server-side implementations of ConversationDatasets

Client for ConversationDatasets

ConversationDatasets client wrapper, for convenient use.

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

ConversationDatasets client wrapper implementation, for convenient use.

Settings for ConversationDatasetsClient instances.

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

Container for nested types declared in the ConversationEvent message type.

Represents metadata of a conversation.

Represents a conversation model.

Container for nested types declared in the ConversationModel message type.

Represents evaluation result of a conversation model.

Resource name for the ConversationModelEvaluation resource.

Resource name for the ConversationModel resource.

Manages a collection of models for human agent assistant.

Base class for server-side implementations of ConversationModels

Client for ConversationModels

ConversationModels client wrapper, for convenient use.

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

ConversationModels client wrapper implementation, for convenient use.

Settings for ConversationModelsClient instances.

Resource name for the Conversation resource.

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

Defines the services to connect to incoming Dialogflow conversations.

Resource name for the ConversationProfile resource.

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

Base class for server-side implementations of ConversationProfiles

Client for ConversationProfiles

ConversationProfiles client wrapper, for convenient use.

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

ConversationProfiles client wrapper implementation, for convenient use.

Settings for ConversationProfilesClient instances.

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

Base class for server-side implementations of Conversations

Client for Conversations

Conversations client wrapper, for convenient use.

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

Conversations client wrapper implementation, for convenient use.

Settings for ConversationsClient instances.

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

Metadata for [ConversationDatasets][CreateConversationDataset].

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

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

Container for nested types declared in the CreateConversationModelEvaluationOperationMetadata message type.

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

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

Container for nested types declared in the CreateConversationModelOperationMetadata message type.

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

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

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

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

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

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

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

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

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

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

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

Resource name for the CXSecuritySettings resource.

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

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

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

Metadata for [ConversationDatasets][DeleteConversationDataset].

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

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

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

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.

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

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

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

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

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

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

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

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

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

The request to detect user's intent.

The message returned from the DetectIntent method.

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.

Container for nested types declared in the Document message type.

The status of a reload attempt.

Resource name for the Document resource.

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

Base class for server-side implementations of Documents

Client for Documents

Documents client wrapper, for convenient use.

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

Documents client wrapper implementation, for convenient use.

Settings for DocumentsClient instances.

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

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.

Container for nested types declared in the EntityType message type.

An entity entry for an associated entity type.

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

Resource name for the EntityType resource.

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

Base class for server-side implementations of EntityTypes

Client for EntityTypes

EntityTypes client wrapper, for convenient use.

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

EntityTypes client wrapper implementation, for convenient use.

Settings for EntityTypesClient instances.

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.

Container for nested types declared in the Environment message type.

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

Container for nested types declared in the EnvironmentHistory message type.

Represents an environment history entry.

Resource name for the Environment resource.

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

Base class for server-side implementations of Environments

Client for Environments

Environments client wrapper, for convenient use.

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

Environments client wrapper implementation, for convenient use.

Settings for EnvironmentsClient instances.

The configuration for model evaluation.

Container for nested types declared in the EvaluationConfig message type.

Smart compose specific configuration for evaluation job.

Smart reply specific configuration for evaluation job.

Events allow for matching intents by event name instead of the natural language input. For instance, input <event: { name: &quot;welcome_event&quot;, parameters: { name: &quot;Sam&quot; } }> 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?".

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

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

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

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

Represents answer from "frequently asked questions".

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.

Container for nested types declared in the Fulfillment message type.

Whether fulfillment is enabled for the specific feature.

Container for nested types declared in the Feature message type.

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.

Resource name for the Fulfillment resource.

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

Base class for server-side implementations of Fulfillments

Client for Fulfillments

Fulfillments client wrapper, for convenient use.

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

Fulfillments client wrapper implementation, for convenient use.

Settings for FulfillmentsClient instances.

Google Cloud Storage location for the output.

Google Cloud Storage location for the inputs.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Defines the Human Agent Assist to connect to a conversation.

Container for nested types declared in the HumanAgentAssistantConfig message type.

Custom conversation models used in agent assist feature.

Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.

Config to process conversation.

Configuration for analyses to run on each conversation message.

Detail human agent assistant config.

Config for suggestion features.

Config for suggestion query.

Container for nested types declared in the SuggestionQueryConfig message type.

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

Dialogflow source setting.

Supported feature: DIALOGFLOW_ASSIST.

Document source settings.

Supported features: SMART_REPLY, SMART_COMPOSE.

Knowledge base source settings.

Supported features: ARTICLE_SUGGESTION, FAQ.

Settings of suggestion trigger.

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

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.

Container for nested types declared in the HumanAgentHandoffConfig message type.

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

Configuration specific to Salesforce Live Agent.

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

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

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

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

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

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

The template used for importing documents.

Instructs the speech recognizer how to process the audio content.

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

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

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.

Container for nested types declared in the Intent message type.

Represents a single followup intent in the chain.

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

Container for nested types declared in the Message message type.

The basic card message. Useful for displaying information.

Container for nested types declared in the BasicCard message type.

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

Container for nested types declared in the Button message type.

Opens the given URI.

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

Container for nested types declared in the BrowseCarouselCard message type.

Browsing carousel tile

Container for nested types declared in the BrowseCarouselCardItem message type.

Actions on Google action to open a given url.

Container for nested types declared in the OpenUrlAction message type.

The card response message.

Container for nested types declared in the Card message type.

Contains information about a button.

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

Container for nested types declared in the CarouselSelect message type.

An item in the carousel.

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

Container for nested types declared in the ColumnProperties message type.

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.

Container for nested types declared in the ListSelect message type.

An item in the list.

The media content card for Actions on Google.

Container for nested types declared in the MediaContent message type.

Response media object for media content card.

The quick replies response message.

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

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.

The collection of suggestions.

Table card for Actions on Google.

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

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

The text response message.

Represents intent parameters.

Represents an example that the agent is trained on.

Container for nested types declared in the TrainingPhrase message type.

Represents a part of a training phrase.

This message is a wrapper around a collection of intents.

Resource name for the Intent resource.

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

Base class for server-side implementations of Intents

Client for Intents

Intents client wrapper, for convenient use.

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

Intents client wrapper implementation, for convenient use.

Settings for IntentsClient instances.

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.

Resource name for the KnowledgeBase resource.

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

Base class for server-side implementations of KnowledgeBases

Client for KnowledgeBases

KnowledgeBases client wrapper, for convenient use.

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

KnowledgeBases client wrapper implementation, for convenient use.

Settings for KnowledgeBasesClient instances.

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

Container for nested types declared in the KnowledgeOperationMetadata message type.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Defines logging behavior for conversation lifecycle events.

Represents a message posted into a conversation.

Represents the result of annotation for the message.

Resource name for the Message resource.

Resource name for the Model resource.

Defines notification behavior.

Container for nested types declared in the NotificationConfig message type.

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

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

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.

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

Container for nested types declared in the Participant message type.

Resource name for the Participant resource.

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

Base class for server-side implementations of Participants

Client for Participants

Participants client wrapper, for convenient use.

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

Participants client wrapper implementation, for convenient use.

Settings for ParticipantsClient instances.

Resource name for the PhraseSet resource.

Represents the query input. It can contain either:

1. An audio config which instructs the speech recognizer how to process the speech audio.

2. A conversational query in the form of text,.

3. An event that specifies which intent to trigger.

Represents the parameters of the conversational query.

Represents the result of conversational query or event processing.

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

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

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

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

The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.

Configures the types of sentiment analysis to perform.

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]

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.

Container for nested types declared in the SessionEntityType message type.

Resource name for the SessionEntityType resource.

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

Base class for server-side implementations of SessionEntityTypes

Client for SessionEntityTypes

SessionEntityTypes client wrapper, for convenient use.

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

SessionEntityTypes client wrapper implementation, for convenient use.

Settings for SessionEntityTypesClient instances.

Resource name for the Session resource.

A service used for session interactions.

For more information, see the API interactions guide.

Base class for server-side implementations of Sessions

Client for Sessions

Sessions client wrapper, for convenient use.

Bidirectional streaming methods for StreamingDetectIntent(CallSettings, BidirectionalStreamingSettings).

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

Sessions client wrapper implementation, for convenient use.

Settings for SessionsClient instances.

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

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

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

Represents a smart reply answer.

The evaluation metrics for smart reply model.

Container for nested types declared in the SmartReplyMetrics message type.

Evaluation metrics when retrieving n smart replies with the model.

Metadata for smart reply models.

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

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

Information for a word recognized by the speech recognizer.

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:

1. 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].
2. 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.

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

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

2. The next message contains response_id, query_result and optionally webhook_status if a WebHook was called.

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   | "tube"                  | TRANSCRIPT              | false
2   | "to be a"               | TRANSCRIPT              | false
3   | "to be"                 | TRANSCRIPT              | false
4   | "to be or not to be"    | TRANSCRIPT              | true
5   | "that's"                | TRANSCRIPT              | false
6   | "that is                | TRANSCRIPT              | false
7   | unset                   | END_OF_SINGLE_UTTERANCE | unset
8   | " that is the question" | 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".

Container for nested types declared in the StreamingRecognitionResult message type.

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

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

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

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

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.

Container for nested types declared in the SuggestionFeature message type.

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

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

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

Configuration of how speech should be synthesized.

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

Represents the natural language text to be processed.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Represents a single validation error.

Container for nested types declared in the ValidationError message type.

Represents the output of agent validation.

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.

Container for nested types declared in the Version message type.

Resource name for the Version resource.

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

Base class for server-side implementations of Versions

Client for Versions

Versions client wrapper, for convenient use.

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

Versions client wrapper implementation, for convenient use.

Settings for VersionsClient instances.

Description of which voice to use for speech synthesis.

The request message for a webhook call.

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.

API version for the agent.

Match mode determines how intents are detected from user queries.

Represents the agent tier.

Relevance of an answer.

Correctness of document.

Efficiency of document.

Enum of possible cases for the "answer" oneof.

The possible contents of AgentName.

Enum of possible cases for the "input" oneof.

Enum of possible cases for the "detail_feedback" oneof.

The correctness level of an answer.

Enum of possible cases for the "record" oneof.

The possible contents of AnswerRecordName.

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

Represents different automated agent reply types.

Enum of possible cases for the "entity_type_batch" oneof.

Enum of possible cases for the "intent_batch" oneof.

The possible contents of ContextName.

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

Enumeration of the completion status of the conversation.

The possible contents of ConversationDatasetName.

Enum of possible cases for the "payload" oneof.

Enumeration of the types of events available.

Enum of possible cases for the "model_metadata" oneof.

Model type.

State of the model.

Enum of possible cases for the "metrics" oneof.

The possible contents of ConversationModelEvaluationName.

The possible contents of ConversationModelName.

The possible contents of ConversationName.

The possible contents of ConversationProfileName.

State of CreateConversationModel operation.

State of CreateConversationModel operation.

The possible contents of CXSecuritySettingsName.

Enum of possible cases for the "source" oneof.

The knowledge type of document content.

Possible states of the document

The possible contents of DocumentName.

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

Represents kinds of entities.

The possible contents of EntityTypeName.

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.

The possible contents of EnvironmentName.

Enum of possible cases for the "model_specific_config" oneof.

Enum of possible cases for the "agent" oneof.

Enum of possible cases for the "destination" oneof.

Enum of possible cases for the "fulfillment" oneof.

The type of the feature.

The possible contents of FulfillmentName.

Enum of possible cases for the "query_source" oneof.

Enum of possible cases for the "agent_service" oneof.

Enum of possible cases for the "agent" oneof.

Enum of possible cases for the "source" oneof.

Enum of possible cases for the "source" oneof.

Enum of possible cases for the "message" oneof.

Type of the URI.

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.

Text alignments within a cell.

Enum of possible cases for the "image" oneof.

Format of response media type.

The rich response message integration platform. See Integrations.

Represents different types of training phrases.

Represents the different states that webhooks can be in.

The possible contents of IntentName.

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.

The possible contents of KnowledgeBaseName.

Enum of possible cases for the "operation_metadata" oneof.

States of the operation.

The possible contents of MessageName.

The possible contents of ModelName.

Format of cloud pub/sub message.

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

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

The possible contents of ParticipantName.

The possible contents of PhraseSetName.

Enum of possible cases for the "input" oneof.

Enum of possible cases for the "source" oneof.

Enum of possible cases for the "agent" oneof.

The types of modifications for a session entity type.

The possible contents of SessionEntityTypeName.

The possible contents of SessionName.

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.

Gender of the voice as described in SSML voice element.

Type of the response message.

Defines the type of Human Agent Assistant feature.

Enum of possible cases for the "suggestion_response" oneof.

Represents a level of severity.

The status of a version.

The possible contents of VersionName.