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)
• AssistQueryParameters (message)
• AudioEncoding (enum)
• AudioInput (message)
• AutomatedAgentConfig (message)
• AutomatedAgentReply (message)
• AutomatedAgentReply.AutomatedAgentReplyType (enum)
• BatchCreateEntitiesRequest (message)
• BatchCreateMessagesRequest (message)
• BatchCreateMessagesResponse (message)
• BatchDeleteEntitiesRequest (message)
• BatchDeleteEntityTypesRequest (message)
• BatchDeleteIntentsRequest (message)
• BatchUpdateEntitiesRequest (message)
• BatchUpdateEntityTypesRequest (message)
• BatchUpdateEntityTypesResponse (message)
• BatchUpdateIntentsRequest (message)
• BatchUpdateIntentsResponse (message)
• ClearSuggestionFeatureConfigOperationMetadata (message)
• ClearSuggestionFeatureConfigRequest (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)
• Document.State (enum)
• 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)
• ExportOperationMetadata (message)
• FaqAnswer (message)
• Fulfillment (message)
• Fulfillment.Feature (message)
• Fulfillment.Feature.Type (enum)
• Fulfillment.GenericWebService (message)
• GcsDestination (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.ConversationProcessConfig (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)
• InputTextConfig (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.MixedAudio (message)
• ResponseMessage.MixedAudio.Segment (message)
• ResponseMessage.TelephonyTransferCall (message)
• ResponseMessage.Text (message)
• RestoreAgentRequest (message)
• SearchAgentsRequest (message)
• SearchAgentsResponse (message)
• Sentiment (message)
• SentimentAnalysisRequestConfig (message)
• SentimentAnalysisResult (message)
• SessionEntityType (message)
• SessionEntityType.EntityOverrideMode (enum)
• SetAgentRequest (message)
• SetSuggestionFeatureConfigOperationMetadata (message)
• SetSuggestionFeatureConfigRequest (message)
• SmartReplyAnswer (message)
• SpeechContext (message)
• SpeechModelVariant (enum)
• SpeechToTextConfig (message)
• SpeechWordInfo (message)
• SsmlVoiceGender (enum)
• StreamingAnalyzeContentRequest (message)
• StreamingAnalyzeContentResponse (message)
• StreamingDetectIntentRequest (message)
• StreamingDetectIntentResponse (message)
• StreamingRecognitionResult (message)
• StreamingRecognitionResult.MessageType (enum)
• SubAgent (message)
• SuggestArticlesRequest (message)
• SuggestArticlesResponse (message)
• SuggestConversationSummaryRequest (message)
• SuggestConversationSummaryResponse (message)
• SuggestConversationSummaryResponse.Summary (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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation. 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.

ClearSuggestionFeatureConfig

rpc ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest) returns (Operation) Clears a suggestion feature from a conversation profile for the given participant role. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: ClearSuggestionFeatureConfigOperationMetadata response: ConversationProfile 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.

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.

SetSuggestionFeatureConfig

rpc SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest) returns (Operation) Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: SetSuggestionFeatureConfigOperationMetadata response: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected. 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.

SuggestConversationSummary

rpc SuggestConversationSummary(SuggestConversationSummaryRequest) returns (SuggestConversationSummaryResponse) Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: KnowledgeOperationMetadata response: 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: KnowledgeOperationMetadata response: An Empty message 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: KnowledgeOperationMetadata response: ImportDocumentsResponse 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: KnowledgeOperationMetadata response: 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.

UpdateDocument

rpc UpdateDocument(UpdateDocumentRequest) returns (Operation) Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: KnowledgeOperationMetadata response: 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: BatchUpdateEntityTypesResponse Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: metadata: An empty Struct message response: BatchUpdateIntentsResponse Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. 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. Note: You should always train an agent prior to sending it queries. See the training documentation. 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