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)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)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 |
---|
Deletes the specified agent.
|
ExportAgent |
---|
Exports the specified agent to a ZIP file. This method is a long-running operation. The returned
|
GetAgent |
---|
Retrieves the specified agent.
|
GetValidationResult |
---|
Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.
|
ImportAgent |
---|
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 This method is a long-running operation. The returned
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.
|
RestoreAgent |
---|
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 This method is a long-running operation. The returned
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.
|
SearchAgents |
---|
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.
|
SetAgent |
---|
Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.
|
TrainAgent |
---|
Trains the specified agent. This method is a long-running operation. The returned
Note: You should always train an agent prior to sending it queries. See the training documentation.
|
AnswerRecords
Service for managing AnswerRecords
.
GetAnswerRecord |
---|
Deprecated. Retrieves a specific answer record.
|
ListAnswerRecords |
---|
Returns the list of all answer records in the specified project in reverse chronological order.
|
UpdateAnswerRecord |
---|
Updates the specified answer record.
|
Contexts
Service for managing Contexts
.
CreateContext |
---|
Creates a context. If the specified context already exists, overrides the context.
|
DeleteAllContexts |
---|
Deletes all active contexts in the specified session.
|
DeleteContext |
---|
Deletes the specified context.
|
GetContext |
---|
Retrieves the specified context.
|
ListContexts |
---|
Returns the list of all contexts in the specified session.
|
UpdateContext |
---|
Updates the specified context.
|
ConversationProfiles
Service for managing ConversationProfiles
.
ClearSuggestionFeatureConfig |
---|
Clears a suggestion feature from a conversation profile for the given participant role. This method is a long-running operation. The returned
|
CreateConversationProfile |
---|
Creates a conversation profile in the specified project. [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via
|
DeleteConversationProfile |
---|
Deletes the specified conversation profile.
|
GetConversationProfile |
---|
Retrieves the specified conversation profile.
|
ListConversationProfiles |
---|
Returns the list of all conversation profiles in the specified project.
|
SetSuggestionFeatureConfig |
---|
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
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.
|
UpdateConversationProfile |
---|
Updates the specified conversation profile. [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via
|
Conversations
Service for managing Conversations
.
BatchCreateMessages |
---|
Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.
|
CompleteConversation |
---|
Completes the specified conversation. Finished conversations are purged from the database after 30 days.
|
CreateConversation |
---|
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
|
GetConversation |
---|
Retrieves the specific conversation.
|
ListConversations |
---|
Returns the list of all conversations in the specified project.
|
ListMessages |
---|
Lists messages that belong to a given conversation.
|
Documents
Service for managing knowledge Documents
.
CreateDocument |
---|
Creates a new document. This method is a long-running operation. The returned
Note: The
|
DeleteDocument |
---|
Deletes the specified document. This method is a long-running operation. The returned
Note: The
|
GetDocument |
---|
Retrieves the specified document. Note: The
|
ImportDocuments |
---|
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
|
ListDocuments |
---|
Returns the list of all documents of the knowledge base. Note: The
|
ReloadDocument |
---|
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 This method is a long-running operation. The returned
Note: The
|
UpdateDocument |
---|
Updates the specified document. This method is a long-running operation. The returned
Note: The
|
EntityTypes
Service for managing EntityTypes
.
BatchCreateEntities |
---|
Creates multiple new entities in the specified entity type. This method is a long-running operation. The returned
Note: You should always train an agent prior to sending it queries. See the training documentation.
|
BatchDeleteEntities |
---|
Deletes entities in the specified entity type. This method is a long-running operation. The returned
Note: You should always train an agent prior to sending it queries. See the training documentation.
|
BatchDeleteEntityTypes |
---|
Deletes entity types in the specified agent. This method is a long-running operation. The returned
Note: You should always train an agent prior to sending it queries. See the training documentation.
|
BatchUpdateEntities |
---|
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
|
BatchUpdateEntityTypes |
---|
Updates/Creates multiple entity types in the specified agent. This method is a long-running operation. The returned
Note: You should always train an agent prior to sending it queries. See the training documentation.
|
CreateEntityType |
---|
Creates an entity type in the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.
|
DeleteEntityType |
---|
Deletes the specified entity type. Note: You should always train an agent prior to sending it queries. See the training documentation.
|
GetEntityType |
---|
Retrieves the specified entity type.
|
ListEntityTypes |
---|
Returns the list of all entity types in the specified agent.
|
UpdateEntityType |
---|
Updates the specified entity type. Note: You should always train an agent prior to sending it queries. See the training documentation.
|
Environments
Service for managing Environments
.
CreateEnvironment |
---|
Creates an agent environment.
|
DeleteEnvironment |
---|
Deletes the specified agent environment.
|
GetEnvironment |
---|
Retrieves the specified agent environment.
|
GetEnvironmentHistory |
---|
Gets the history of the specified environment.
|
ListEnvironments |
---|
Returns the list of all non-draft environments of the specified agent.
|
UpdateEnvironment |
---|
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
|
Fulfillments
Service for managing Fulfillments
.
GetFulfillment |
---|
Retrieves the fulfillment.
|
UpdateFulfillment |
---|
Updates the fulfillment.
|
Intents
Service for managing Intents
.
BatchDeleteIntents |
---|
Deletes intents in the specified agent. This method is a long-running operation. The returned
Note: You should always train an agent prior to sending it queries. See the training documentation.
|
BatchUpdateIntents |
---|
Updates/Creates multiple intents in the specified agent. This method is a long-running operation. The returned
Note: You should always train an agent prior to sending it queries. See the training documentation.
|
CreateIntent |
---|
Creates an intent in the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.
|
DeleteIntent |
---|
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.
|
GetIntent |
---|
Retrieves the specified intent.
|
ListIntents |
---|
Returns the list of all intents in the specified agent.
|
UpdateIntent |
---|
Updates the specified intent. Note: You should always train an agent prior to sending it queries. See the training documentation.
|
KnowledgeBases
Service for managing KnowledgeBases
.
CreateKnowledgeBase |
---|
Creates a knowledge base. Note: The
|
DeleteKnowledgeBase |
---|
Deletes the specified knowledge base. Note: The
|
GetKnowledgeBase |
---|
Retrieves the specified knowledge base. Note: The
|
ListKnowledgeBases |
---|
Returns the list of all knowledge bases of the specified agent. Note: The
|
UpdateKnowledgeBase |
---|
Updates the specified knowledge base. Note: The
|
Participants
Service for managing Participants
.
AnalyzeContent |
---|
< |