Package google.cloud.dialogflow.v2beta1

Index

• Agents (interface)
• AnswerRecords (interface)
• Contexts (interface)
• ConversationProfiles (interface)
• Conversations (interface)
• Documents (interface)
• EntityTypes (interface)
• Environments (interface)
• Fulfillments (interface)
• Intents (interface)
• KnowledgeBases (interface)
• Participants (interface)
• SessionEntityTypes (interface)
• Sessions (interface)
• Versions (interface)
• Agent (message)
• Agent.ApiVersion (enum)
• Agent.MatchMode (enum)
• Agent.Tier (enum)
• AgentAssistantFeedback (message)
• AgentAssistantFeedback.AnswerRelevance (enum)
• AgentAssistantFeedback.DocumentCorrectness (enum)
• AgentAssistantFeedback.DocumentEfficiency (enum)
• AgentAssistantFeedback.SummarizationFeedback (message)
• AgentAssistantRecord (message)
• AnalyzeContentRequest (message)
• AnalyzeContentResponse (message)
• AnnotatedMessagePart (message)
• AnswerFeedback (message)
• AnswerFeedback.CorrectnessLevel (enum)
• AnswerRecord (message)
• ArticleAnswer (message)
• AudioEncoding (enum)
• AutomatedAgentConfig (message)
• AutomatedAgentReply (message)
• BatchCreateEntitiesRequest (message)
• BatchCreateMessagesRequest (message)
• BatchCreateMessagesResponse (message)
• BatchDeleteEntitiesRequest (message)
• BatchDeleteEntityTypesRequest (message)
• BatchDeleteIntentsRequest (message)
• BatchUpdateEntitiesRequest (message)
• BatchUpdateEntityTypesRequest (message)
• BatchUpdateEntityTypesResponse (message)
• BatchUpdateIntentsRequest (message)
• BatchUpdateIntentsResponse (message)
• CompileSuggestionRequest (message) (deprecated)
• CompileSuggestionResponse (message) (deprecated)
• CompleteConversationRequest (message)
• Context (message)
• Conversation (message)
• Conversation.ConversationStage (enum)
• Conversation.LifecycleState (enum)
• ConversationEvent (message)
• ConversationEvent.Type (enum)
• ConversationPhoneNumber (message)
• ConversationProfile (message)
• CreateContextRequest (message)
• CreateConversationProfileRequest (message)
• CreateConversationRequest (message)
• CreateDocumentRequest (message)
• CreateEntityTypeRequest (message)
• CreateEnvironmentRequest (message)
• CreateIntentRequest (message)
• CreateKnowledgeBaseRequest (message)
• CreateMessageRequest (message)
• CreateParticipantRequest (message)
• CreateSessionEntityTypeRequest (message)
• CreateVersionRequest (message)
• DeleteAgentRequest (message)
• DeleteAllContextsRequest (message)
• DeleteContextRequest (message)
• DeleteConversationProfileRequest (message)
• DeleteDocumentRequest (message)
• DeleteEntityTypeRequest (message)
• DeleteEnvironmentRequest (message)
• DeleteIntentRequest (message)
• DeleteKnowledgeBaseRequest (message)
• DeleteSessionEntityTypeRequest (message)
• DeleteVersionRequest (message)
• DetectIntentRequest (message)
• DetectIntentResponse (message)
• Document (message)
• Document.KnowledgeType (enum)
• Document.ReloadStatus (message)
• DtmfParameters (message)
• EntityType (message)
• EntityType.AutoExpansionMode (enum)
• EntityType.Entity (message)
• EntityType.Kind (enum)
• EntityTypeBatch (message)
• Environment (message)
• Environment.State (enum)
• EnvironmentHistory (message)
• EnvironmentHistory.Entry (message)
• EventInput (message)
• ExportAgentRequest (message)
• ExportAgentResponse (message)
• FaqAnswer (message)
• Fulfillment (message)
• Fulfillment.Feature (message)
• Fulfillment.Feature.Type (enum)
• Fulfillment.GenericWebService (message)
• GcsSource (message)
• GcsSources (message)
• GetAgentRequest (message)
• GetAnswerRecordRequest (message)
• GetContextRequest (message)
• GetConversationProfileRequest (message)
• GetConversationRequest (message)
• GetDocumentRequest (message)
• GetEntityTypeRequest (message)
• GetEnvironmentHistoryRequest (message)
• GetEnvironmentRequest (message)
• GetFulfillmentRequest (message)
• GetIntentRequest (message)
• GetKnowledgeBaseRequest (message)
• GetParticipantRequest (message)
• GetSessionEntityTypeRequest (message)
• GetValidationResultRequest (message)
• GetVersionRequest (message)
• HumanAgentAssistantConfig (message)
• HumanAgentAssistantConfig.ConversationModelConfig (message)
• HumanAgentAssistantConfig.MessageAnalysisConfig (message)
• HumanAgentAssistantConfig.SuggestionConfig (message)
• HumanAgentAssistantConfig.SuggestionFeatureConfig (message)
• HumanAgentAssistantConfig.SuggestionQueryConfig (message)
• HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings (message)
• HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource (message)
• HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource (message)
• HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource (message)
• HumanAgentAssistantConfig.SuggestionTriggerSettings (message)
• HumanAgentAssistantEvent (message)
• HumanAgentHandoffConfig (message)
• HumanAgentHandoffConfig.LivePersonConfig (message)
• HumanAgentHandoffConfig.SalesforceLiveAgentConfig (message)
• ImportAgentRequest (message)
• ImportDocumentTemplate (message)
• ImportDocumentsRequest (message)
• ImportDocumentsResponse (message)
• InputAudioConfig (message)
• Intent (message)
• Intent.FollowupIntentInfo (message)
• Intent.Message (message)
• Intent.Message.BasicCard (message)
• Intent.Message.BasicCard.Button (message)
• Intent.Message.BasicCard.Button.OpenUriAction (message)
• Intent.Message.BrowseCarouselCard (message)
• Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem (message)
• Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction (message)
• Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction.UrlTypeHint (enum)
• Intent.Message.BrowseCarouselCard.ImageDisplayOptions (enum)
• Intent.Message.Card (message)
• Intent.Message.Card.Button (message)
• Intent.Message.CarouselSelect (message)
• Intent.Message.CarouselSelect.Item (message)
• Intent.Message.ColumnProperties (message)
• Intent.Message.ColumnProperties.HorizontalAlignment (enum)
• Intent.Message.Image (message)
• Intent.Message.LinkOutSuggestion (message)
• Intent.Message.ListSelect (message)
• Intent.Message.ListSelect.Item (message)
• Intent.Message.MediaContent (message)
• Intent.Message.MediaContent.ResponseMediaObject (message)
• Intent.Message.MediaContent.ResponseMediaType (enum)
• Intent.Message.Platform (enum)
• Intent.Message.QuickReplies (message)
• Intent.Message.RbmCardContent (message)
• Intent.Message.RbmCardContent.RbmMedia (message)
• Intent.Message.RbmCardContent.RbmMedia.Height (enum)
• Intent.Message.RbmCarouselCard (message)
• Intent.Message.RbmCarouselCard.CardWidth (enum)
• Intent.Message.RbmStandaloneCard (message)
• Intent.Message.RbmStandaloneCard.CardOrientation (enum)
• Intent.Message.RbmStandaloneCard.ThumbnailImageAlignment (enum)
• Intent.Message.RbmSuggestedAction (message)
• Intent.Message.RbmSuggestedAction.RbmSuggestedActionDial (message)
• Intent.Message.RbmSuggestedAction.RbmSuggestedActionOpenUri (message)
• Intent.Message.RbmSuggestedAction.RbmSuggestedActionShareLocation (message)
• Intent.Message.RbmSuggestedReply (message)
• Intent.Message.RbmSuggestion (message)
• Intent.Message.RbmText (message)
• Intent.Message.SelectItemInfo (message)
• Intent.Message.SimpleResponse (message)
• Intent.Message.SimpleResponses (message)
• Intent.Message.Suggestion (message)
• Intent.Message.Suggestions (message)
• Intent.Message.TableCard (message)
• Intent.Message.TableCardCell (message)
• Intent.Message.TableCardRow (message)
• Intent.Message.TelephonyPlayAudio (message)
• Intent.Message.TelephonySynthesizeSpeech (message)
• Intent.Message.TelephonyTransferCall (message)
• Intent.Message.Text (message)
• Intent.Parameter (message)
• Intent.TrainingPhrase (message)
• Intent.TrainingPhrase.Part (message)
• Intent.TrainingPhrase.Type (enum)
• Intent.WebhookState (enum)
• IntentBatch (message)
• IntentView (enum)
• KnowledgeAnswers (message)
• KnowledgeAnswers.Answer (message)
• KnowledgeAnswers.Answer.MatchConfidenceLevel (enum)
• KnowledgeBase (message)
• KnowledgeOperationMetadata (message)
• KnowledgeOperationMetadata.State (enum)
• ListAnswerRecordsRequest (message)
• ListAnswerRecordsResponse (message)
• ListContextsRequest (message)
• ListContextsResponse (message)
• ListConversationProfilesRequest (message)
• ListConversationProfilesResponse (message)
• ListConversationsRequest (message)
• ListConversationsResponse (message)
• ListDocumentsRequest (message)
• ListDocumentsResponse (message)
• ListEntityTypesRequest (message)
• ListEntityTypesResponse (message)
• ListEnvironmentsRequest (message)
• ListEnvironmentsResponse (message)
• ListIntentsRequest (message)
• ListIntentsResponse (message)
• ListKnowledgeBasesRequest (message)
• ListKnowledgeBasesResponse (message)
• ListMessagesRequest (message)
• ListMessagesResponse (message)
• ListParticipantsRequest (message)
• ListParticipantsResponse (message)
• ListSessionEntityTypesRequest (message)
• ListSessionEntityTypesResponse (message)
• ListSuggestionsRequest (message) (deprecated)
• ListSuggestionsResponse (message) (deprecated)
• ListVersionsRequest (message)
• ListVersionsResponse (message)
• LoggingConfig (message)
• Message (message)
• MessageAnnotation (message)
• NotificationConfig (message)
• NotificationConfig.MessageFormat (enum)
• OriginalDetectIntentRequest (message)
• OutputAudio (message)
• OutputAudioConfig (message)
• OutputAudioEncoding (enum)
• Participant (message)
• Participant.Role (enum)
• QueryInput (message)
• QueryParameters (message)
• QueryResult (message)
• ReloadDocumentRequest (message)
• ResponseMessage (message)
• ResponseMessage.EndInteraction (message)
• ResponseMessage.LiveAgentHandoff (message)
• ResponseMessage.Text (message)
• RestoreAgentRequest (message)
• SearchAgentsRequest (message)
• SearchAgentsResponse (message)
• Sentiment (message)
• SentimentAnalysisRequestConfig (message)
• SentimentAnalysisResult (message)
• SessionEntityType (message)
• SessionEntityType.EntityOverrideMode (enum)
• SetAgentRequest (message)
• SmartReplyAnswer (message)
• SpeechContext (message)
• SpeechModelVariant (enum)
• SpeechToTextConfig (message)
• SpeechWordInfo (message)
• SsmlVoiceGender (enum)
• StreamingDetectIntentRequest (message)
• StreamingDetectIntentResponse (message)
• StreamingRecognitionResult (message)
• StreamingRecognitionResult.MessageType (enum)
• SubAgent (message)
• SuggestArticlesRequest (message)
• SuggestArticlesResponse (message)
• SuggestFaqAnswersRequest (message)
• SuggestFaqAnswersResponse (message)
• SuggestSmartRepliesRequest (message)
• SuggestSmartRepliesResponse (message)
• Suggestion (message) (deprecated)
• Suggestion.Article (message)
• Suggestion.FaqAnswer (message)
• SuggestionFeature (message)
• SuggestionFeature.Type (enum)
• SuggestionResult (message)
• SynthesizeSpeechConfig (message)
• TelephonyDtmf (enum)
• TelephonyDtmfEvents (message)
• TextInput (message)
• TextToSpeechSettings (message)
• TrainAgentRequest (message)
• UpdateAnswerRecordRequest (message)
• UpdateContextRequest (message)
• UpdateConversationProfileRequest (message)
• UpdateDocumentRequest (message)
• UpdateEntityTypeRequest (message)
• UpdateEnvironmentRequest (message)
• UpdateFulfillmentRequest (message)
• UpdateIntentRequest (message)
• UpdateKnowledgeBaseRequest (message)
• UpdateParticipantRequest (message)
• UpdateSessionEntityTypeRequest (message)
• UpdateVersionRequest (message)
• ValidationError (message)
• ValidationError.Severity (enum)
• ValidationResult (message)
• Version (message)
• Version.VersionStatus (enum)
• VoiceSelectionParams (message)
• WebhookRequest (message)
• WebhookResponse (message)

Agents

Service for managing Agents.

DeleteAgent
rpc DeleteAgent(DeleteAgentRequest) returns (Empty) Deletes the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ExportAgent
rpc ExportAgent(ExportAgentRequest) returns (Operation) Exports the specified agent to a ZIP file. Operation <response: ExportAgentResponse> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetAgent
rpc GetAgent(GetAgentRequest) returns (Agent) Retrieves the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetValidationResult

rpc GetValidationResult(GetValidationResultRequest) returns (ValidationResult) Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ImportAgent

rpc ImportAgent(ImportAgentRequest) returns (Operation) Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation <response: google.protobuf.Empty> An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

RestoreAgent

rpc RestoreAgent(RestoreAgentRequest) returns (Operation) Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation <response: google.protobuf.Empty> An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SearchAgents

rpc SearchAgents(SearchAgentsRequest) returns (SearchAgentsResponse) Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SetAgent
rpc SetAgent(SetAgentRequest) returns (Agent) Creates/updates the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

TrainAgent
rpc TrainAgent(TrainAgentRequest) returns (Operation) Trains the specified agent. Operation <response: google.protobuf.Empty> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

AnswerRecords

Service for managing AnswerRecords.

GetAnswerRecord
This item is deprecated! rpc GetAnswerRecord(GetAnswerRecordRequest) returns (AnswerRecord) Deprecated. Retrieves a specific answer record. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListAnswerRecords
rpc ListAnswerRecords(ListAnswerRecordsRequest) returns (ListAnswerRecordsResponse) Returns the list of all answer records in the specified project in reverse chronological order. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateAnswerRecord
rpc UpdateAnswerRecord(UpdateAnswerRecordRequest) returns (AnswerRecord) Updates the specified answer record. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Contexts

Service for managing Contexts.

CreateContext
rpc CreateContext(CreateContextRequest) returns (Context) Creates a context. If the specified context already exists, overrides the context. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteAllContexts
rpc DeleteAllContexts(DeleteAllContextsRequest) returns (Empty) Deletes all active contexts in the specified session. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteContext
rpc DeleteContext(DeleteContextRequest) returns (Empty) Deletes the specified context. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetContext
rpc GetContext(GetContextRequest) returns (Context) Retrieves the specified context. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListContexts
rpc ListContexts(ListContextsRequest) returns (ListContextsResponse) Returns the list of all contexts in the specified session. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateContext
rpc UpdateContext(UpdateContextRequest) returns (Context) Updates the specified context. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ConversationProfiles

Service for managing ConversationProfiles.

CreateConversationProfile

rpc CreateConversationProfile(CreateConversationProfileRequest) returns (ConversationProfile) Creates a conversation profile in the specified project. [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via GetConversationProfile API. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteConversationProfile
rpc DeleteConversationProfile(DeleteConversationProfileRequest) returns (Empty) Deletes the specified conversation profile. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetConversationProfile
rpc GetConversationProfile(GetConversationProfileRequest) returns (ConversationProfile) Retrieves the specified conversation profile. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListConversationProfiles
rpc ListConversationProfiles(ListConversationProfilesRequest) returns (ListConversationProfilesResponse) Returns the list of all conversation profiles in the specified project. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateConversationProfile

rpc UpdateConversationProfile(UpdateConversationProfileRequest) returns (ConversationProfile) Updates the specified conversation profile. [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via GetConversationProfile API. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Conversations

Service for managing Conversations.

BatchCreateMessages

rpc BatchCreateMessages(BatchCreateMessagesRequest) returns (BatchCreateMessagesResponse) Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CompleteConversation
rpc CompleteConversation(CompleteConversationRequest) returns (Conversation) Completes the specified conversation. Finished conversations are purged from the database after 30 days. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CreateConversation

rpc CreateConversation(CreateConversationRequest) returns (Conversation) Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetConversation
rpc GetConversation(GetConversationRequest) returns (Conversation) Retrieves the specific conversation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListConversations
rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) Returns the list of all conversations in the specified project. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) Lists messages that belong to a given conversation. messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Documents

Service for managing knowledge Documents.

CreateDocument

rpc CreateDocument(CreateDocumentRequest) returns (Operation) Creates a new document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteDocument

rpc DeleteDocument(DeleteDocumentRequest) returns (Operation) Deletes the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document) Retrieves the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation) Create documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListDocuments

rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) Returns the list of all documents of the knowledge base. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ReloadDocument

rpc ReloadDocument(ReloadDocumentRequest) returns (Operation) Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the import_gcs_custom_metadata field is set to true in the request. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateDocument

rpc UpdateDocument(UpdateDocumentRequest) returns (Operation) Updates the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

EntityTypes

Service for managing EntityTypes.

BatchCreateEntities
rpc BatchCreateEntities(BatchCreateEntitiesRequest) returns (Operation) Creates multiple new entities in the specified entity type. Operation <response: google.protobuf.Empty> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

BatchDeleteEntities
rpc BatchDeleteEntities(BatchDeleteEntitiesRequest) returns (Operation) Deletes entities in the specified entity type. Operation <response: google.protobuf.Empty> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

BatchDeleteEntityTypes
rpc BatchDeleteEntityTypes(BatchDeleteEntityTypesRequest) returns (Operation) Deletes entity types in the specified agent. Operation <response: google.protobuf.Empty> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

BatchUpdateEntities

rpc BatchUpdateEntities(BatchUpdateEntitiesRequest) returns (Operation) Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation <response: google.protobuf.Empty> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

BatchUpdateEntityTypes

rpc BatchUpdateEntityTypes(BatchUpdateEntityTypesRequest) returns (Operation) Updates/Creates multiple entity types in the specified agent. Operation <response: BatchUpdateEntityTypesResponse> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CreateEntityType
rpc CreateEntityType(CreateEntityTypeRequest) returns (EntityType) Creates an entity type in the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteEntityType
rpc DeleteEntityType(DeleteEntityTypeRequest) returns (Empty) Deletes the specified entity type. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetEntityType
rpc GetEntityType(GetEntityTypeRequest) returns (EntityType) Retrieves the specified entity type. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListEntityTypes
rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse) Returns the list of all entity types in the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateEntityType
rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType) Updates the specified entity type. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Environments

Service for managing Environments.

CreateEnvironment
rpc CreateEnvironment(CreateEnvironmentRequest) returns (Environment) Creates an agent environment. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteEnvironment
rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Empty) Deletes the specified agent environment. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetEnvironment
rpc GetEnvironment(GetEnvironmentRequest) returns (Environment) Retrieves the specified agent environment. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetEnvironmentHistory
rpc GetEnvironmentHistory(GetEnvironmentHistoryRequest) returns (EnvironmentHistory) Gets the history of the specified environment. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListEnvironments
rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) Returns the list of all non-draft environments of the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateEnvironment

rpc UpdateEnvironment(UpdateEnvironmentRequest) returns (Environment) Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.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. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Fulfillments

Service for managing Fulfillments.

GetFulfillment
rpc GetFulfillment(GetFulfillmentRequest) returns (Fulfillment) Retrieves the fulfillment. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateFulfillment
rpc UpdateFulfillment(UpdateFulfillmentRequest) returns (Fulfillment) Updates the fulfillment. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Intents

Service for managing Intents.

BatchDeleteIntents
rpc BatchDeleteIntents(BatchDeleteIntentsRequest) returns (Operation) Deletes intents in the specified agent. Operation <response: google.protobuf.Empty> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

BatchUpdateIntents
rpc BatchUpdateIntents(BatchUpdateIntentsRequest) returns (Operation) Updates/Creates multiple intents in the specified agent. Operation <response: BatchUpdateIntentsResponse> Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CreateIntent
rpc CreateIntent(CreateIntentRequest) returns (Intent) Creates an intent in the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteIntent
rpc DeleteIntent(DeleteIntentRequest) returns (Empty) Deletes the specified intent and its direct or indirect followup intents. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetIntent
rpc GetIntent(GetIntentRequest) returns (Intent) Retrieves the specified intent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListIntents
rpc ListIntents(ListIntentsRequest) returns (ListIntentsResponse) Returns the list of all intents in the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateIntent
rpc UpdateIntent(UpdateIntentRequest) returns (Intent) Updates the specified intent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

KnowledgeBases

Service for managing KnowledgeBases.

CreateKnowledgeBase

rpc CreateKnowledgeBase(CreateKnowledgeBaseRequest) returns (KnowledgeBase) Creates a knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteKnowledgeBase

rpc DeleteKnowledgeBase(DeleteKnowledgeBaseRequest) returns (Empty) Deletes the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetKnowledgeBase

rpc GetKnowledgeBase(GetKnowledgeBaseRequest) returns (KnowledgeBase) Retrieves the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListKnowledgeBases

rpc ListKnowledgeBases(ListKnowledgeBasesRequest) returns (ListKnowledgeBasesResponse) Returns the list of all knowledge bases of the specified agent. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateKnowledgeBase

rpc UpdateKnowledgeBase(UpdateKnowledgeBaseRequest) returns (KnowledgeBase) Updates the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Participants

Service for managing Participants.

AnalyzeContent

rpc AnalyzeContent(AnalyzeContentRequest) returns (AnalyzeContentResponse) Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CompileSuggestion

This item is deprecated! rpc CompileSuggestion(CompileSuggestionRequest) returns (CompileSuggestionResponse) Deprecated. use SuggestArticles and SuggestFaqAnswers instead. Gets suggestions for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

CreateParticipant
rpc CreateParticipant(CreateParticipantRequest) returns (Participant) Creates a new participant in a conversation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetParticipant
rpc GetParticipant(GetParticipantRequest) returns (Participant) Retrieves a conversation participant. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListParticipants
rpc ListParticipants(ListParticipantsRequest) returns (ListParticipantsResponse) Returns the list of all participants in the specified conversation. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListSuggestions

This item is deprecated! rpc ListSuggestions(ListSuggestionsRequest) returns (ListSuggestionsResponse) Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01. Retrieves suggestions for live agents. This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SuggestArticles

rpc SuggestArticles(SuggestArticlesRequest) returns (SuggestArticlesResponse) Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SuggestFaqAnswers
rpc SuggestFaqAnswers(SuggestFaqAnswersRequest) returns (SuggestFaqAnswersResponse) Gets suggested faq answers for a participant based on specific historical messages. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SuggestSmartReplies
rpc SuggestSmartReplies(SuggestSmartRepliesRequest) returns (SuggestSmartRepliesResponse) Gets smart replies for a participant based on specific historical messages. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateParticipant
rpc UpdateParticipant(UpdateParticipantRequest) returns (Participant) Updates the specified participant. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

SessionEntityTypes

Service for managing SessionEntityTypes.

CreateSessionEntityType

rpc CreateSessionEntityType(CreateSessionEntityTypeRequest) returns (SessionEntityType) Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteSessionEntityType

rpc DeleteSessionEntityType(DeleteSessionEntityTypeRequest) returns (Empty) Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetSessionEntityType

rpc GetSessionEntityType(GetSessionEntityTypeRequest) returns (SessionEntityType) Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListSessionEntityTypes

rpc ListSessionEntityTypes(ListSessionEntityTypesRequest) returns (ListSessionEntityTypesResponse) Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateSessionEntityType

rpc UpdateSessionEntityType(UpdateSessionEntityTypeRequest) returns (SessionEntityType) Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Sessions

A service used for session interactions.

For more information, see the API interactions guide.

DetectIntent

rpc DetectIntent(DetectIntentRequest) returns (DetectIntentResponse) Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

StreamingDetectIntent

rpc StreamingDetectIntent(StreamingDetectIntentRequest) returns (StreamingDetectIntentResponse) Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST). Note: Always use agent versions for production traffic. See Versions and environments. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

Versions

Service for managing Versions.

CreateVersion
rpc CreateVersion(CreateVersionRequest) returns (Version) Creates an agent version. The new version points to the agent instance in the "default" environment. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

DeleteVersion
rpc DeleteVersion(DeleteVersionRequest) returns (Empty) Delete the specified agent version. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

GetVersion
rpc GetVersion(GetVersionRequest) returns (Version) Retrieves the specified agent version. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

ListVersions
rpc ListVersions(ListVersionsRequest) returns (ListVersionsResponse) Returns the list of all versions of the specified agent. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

UpdateVersion

rpc UpdateVersion(UpdateVersionRequest) returns (Version) Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/dialogflow For more information, see the Authentication Overview.

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.

Fields
parent	string Required. The project of this agent. Format: projects/<Project ID> or projects/<Project ID>/locations/<Location ID>
display_name	string Required. The name of this agent.
default_language_code	string Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Update method.
supported_language_codes[]	string Optional. The list of all languages supported by this agent (except for the default_language_code).
time_zone	string Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
description	string Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
avatar_uri	string Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
enable_logging	bool Optional. Determines whether this agent should log conversation queries.
match_mode (deprecated)	MatchMode This item is deprecated! Optional. Determines how intents are detected from user queries.
classification_threshold	float Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
api_version	ApiVersion Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
tier	Tier Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

ApiVersion

API version for the agent.

Enums
API_VERSION_UNSPECIFIED	Not specified.
API_VERSION_V1	Legacy V1 API.
API_VERSION_V2	V2 API.
API_VERSION_V2_BETA_1	V2beta1 API.

MatchMode

Match mode determines how intents are detected from user queries.

Enums
MATCH_MODE_UNSPECIFIED	Not specified.
MATCH_MODE_HYBRID	Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.
MATCH_MODE_ML_ONLY	Can be used for agents with a large number of examples in intents, especially the ones using @sys.any or very large custom entities.

Tier

Represents the agent tier.

Enums
TIER_UNSPECIFIED	Not specified. This value should never be used.
TIER_STANDARD	Standard tier.
TIER_ENTERPRISE	Enterprise tier (Essentials).
TIER_ENTERPRISE_PLUS	Enterprise tier (Plus).

AgentAssistantFeedback

Detail feedback of Agent Assistant result.

Fields
answer_relevance	AnswerRelevance Optional. Whether or not the suggested answer is relevant. For example: Query: "Can I change my mailing address?" Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." answer_relevance: AnswerRelevance.IRRELEVANT
document_correctness	DocumentCorrectness Optional. Whether or not the information in the document is correct. For example: Query: "Can I return the package in 2 days once received?" Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." Ground truth: "No return or exchange is allowed."
document_efficiency	DocumentEfficiency Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.
summarization_feedback	SummarizationFeedback Feedback for conversation summarization.

AnswerRelevance

Relevance of an answer.

Enums
ANSWER_RELEVANCE_UNSPECIFIED	Answer relevance unspecified.
IRRELEVANT	Answer is irrelevant to query.
RELEVANT	Answer is relevant to query.

DocumentCorrectness

Correctness of document.

Enums
DOCUMENT_CORRECTNESS_UNSPECIFIED	Document correctness unspecified.
INCORRECT	Information in document is incorrect.
CORRECT	Information in document is correct.

DocumentEfficiency

Efficiency of document.

Enums
DOCUMENT_EFFICIENCY_UNSPECIFIED	Document efficiency unspecified.
INEFFICIENT	Document is inefficient.
EFFICIENT	Document is efficient.

SummarizationFeedback

Feedback for conversation summarization.

Fields
start_timestamp	Timestamp Timestamp when composing of the summary starts.
submit_timestamp	Timestamp Timestamp when the summary was submitted.
summary_text	string Text of actual submitted summary.

AgentAssistantRecord

Represents a record of a human agent assistant answer.

Fields
Union field answer. Output only. The agent assistant answer. answer can be only one of the following:
article_suggestion_answer	ArticleAnswer Output only. The article suggestion answer.
faq_answer	FaqAnswer Output only. The FAQ answer.

AnalyzeContentRequest

The request message for Participants.AnalyzeContent.

Fields
participant	string Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>. Authorization requires the following IAM permission on the specified resource participant: dialogflow.participants.analyzeContent
reply_audio_config	OutputAudioConfig Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.
query_params	QueryParameters Parameters for a Dialogflow virtual-agent query.
message_send_time	Timestamp Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant. Given two messages under the same participant: - If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant. - If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later. If the value is not provided, a new request will always be regarded as a new message without any de-duplication.
request_id	string A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.
Union field input. Required. The input content. input can be only one of the following:
text_input	TextInput The natural language text to be processed.
event_input	EventInput An input event to send to Dialogflow.

AnalyzeContentResponse

The response message for Participants.AnalyzeContent.

Fields
reply_text	string Output only. The output text content. This field is set if the automated agent responded with text to show to the user.
reply_audio	OutputAudio Optional. The audio data bytes encoded as specified in the request. This field is set if: reply_audio_config was specified in the request, or The automated agent responded with audio to play to the user. In such case, reply_audio.config contains settings used to synthesize the speech. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.
automated_agent_reply	AutomatedAgentReply Optional. Only set if a Dialogflow automated agent has responded. Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] and [AutomatedAgentReply.detect_intent_response.output_audio_config][] are always empty, use reply_audio instead.
message	Message Output only. Message analyzed by CCAI.
human_agent_suggestion_results[]	SuggestionResult The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.
end_user_suggestion_results[]	SuggestionResult The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.
dtmf_parameters	DtmfParameters Indicates the parameters of DTMF.

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.

Fields
text	string Required. A part of a message possibly annotated with an entity.
entity_type	string Optional. The Dialogflow system entity type of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity.
formatted_value	Value Optional. The Dialogflow system entity formatted value of this message part. For example for a system entity of type @sys.unit-currency, this may contain: { "amount": 5, "currency": "USD" }

AnswerFeedback

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

Fields
correctness_level	CorrectnessLevel The correctness level of the specific answer.
clicked	bool Indicates whether the answer/item was clicked by the human agent or not. Default to false.
click_time	Timestamp Time when the answer/item was clicked.
displayed	bool Indicates whether the answer/item was displayed to the human agent in the agent desktop UI. Default to false.
display_time	Timestamp Time when the answer/item was displayed.
agent_assistant_detail_feedback	AgentAssistantFeedback Optional. Detail feedback of agent assistant suggestions.

CorrectnessLevel

The correctness level of an answer.

Enums
CORRECTNESS_LEVEL_UNSPECIFIED	Correctness level unspecified.
NOT_CORRECT	Answer is totally wrong.
PARTIALLY_CORRECT	Answer is partially correct.
FULLY_CORRECT	Answer is fully correct.

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:

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

Fields
name	string The unique identifier of this answer record. Required for AnswerRecords.UpdateAnswerRecord method. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.
answer_feedback	AnswerFeedback Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer.
agent_assistant_record	AgentAssistantRecord Output only. The record for human agent assistant.

ArticleAnswer

Represents article answer.

Fields
title	string The article title.
uri	string The article URI.
snippets[]	string Output only. Article snippets.
metadata	map<string, string> A map that contains metadata about the answer and the document from which it originates.
answer_record	string The name of answer record, in the format of "projects//locations//answerRecords/"

AudioEncoding

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

Enums
AUDIO_ENCODING_UNSPECIFIED	Not specified.
AUDIO_ENCODING_LINEAR_16	Uncompressed 16-bit signed little-endian samples (Linear PCM).
AUDIO_ENCODING_FLAC	FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported.
AUDIO_ENCODING_MULAW	8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
AUDIO_ENCODING_AMR	Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000.
AUDIO_ENCODING_AMR_WB	Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000.
AUDIO_ENCODING_OGG_OPUS	Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000.
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE	Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000.

AutomatedAgentConfig

Defines the Automated Agent to connect to a conversation.

Fields

agent

string Required. ID of the Dialogflow agent environment to use. This project needs to either be the same project as the conversation or you need to grant service-<Conversation Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API Service Agent role in this project. For ES agents, use format: projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used. Refer to DetectIntentRequest for more details. For CX agents, use format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used.

AutomatedAgentReply

Represents a response from an automated agent.

Fields
response_messages[]	ResponseMessage Response messages from the automated agent.
cx_session_parameters	Struct The collection of current Dialogflow CX agent session parameters at the time of this response.
detect_intent_response	DetectIntentResponse Response of the Dialogflow Sessions.DetectIntent call.
Union field match. Info on the query match for the automated agent response. match can be only one of the following:
intent	string Name of the intent if an intent is matched for the query. For a V2 query, the value format is projects/<Project ID>/locations/ <Location ID>/agent/intents/<Intent ID>. For a V3 query, the value format is projects/<Project ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>.
event	string Event name if an event is triggered for the query.

BatchCreateEntitiesRequest

The request message for EntityTypes.BatchCreateEntities.

Fields<