Index
Agents(interface)AnswerRecords(interface)Contexts(interface)ConversationProfiles(interface)Conversations(interface)Documents(interface)EncryptionSpecService(interface)EntityTypes(interface)Environments(interface)Fulfillments(interface)Generators(interface)Intents(interface)KnowledgeBases(interface)Participants(interface)SessionEntityTypes(interface)Sessions(interface)SipTrunks(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.KnowledgeAssistFeedback(message)AgentAssistantFeedback.KnowledgeSearchFeedback(message)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)BargeInConfig(message)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)CloudConversationDebuggingInfo(message)CompileSuggestionRequest(message) (deprecated)CompileSuggestionResponse(message) (deprecated)CompleteConversationRequest(message)Connection(message)Connection.CertificateState(enum)Connection.ErrorDetails(message)Connection.State(enum)Context(message)Conversation(message)Conversation.ConversationStage(enum)Conversation.LifecycleState(enum)ConversationContext(message)ConversationEvent(message)ConversationEvent.Type(enum)ConversationPhoneNumber(message)ConversationProfile(message)CreateContextRequest(message)CreateConversationProfileRequest(message)CreateConversationRequest(message)CreateDocumentRequest(message)CreateEntityTypeRequest(message)CreateEnvironmentRequest(message)CreateGeneratorRequest(message)CreateIntentRequest(message)CreateKnowledgeBaseRequest(message)CreateMessageRequest(message)CreateParticipantRequest(message)CreateSessionEntityTypeRequest(message)CreateSipTrunkRequest(message)CreateVersionRequest(message)DeleteAgentRequest(message)DeleteAllContextsRequest(message)DeleteContextRequest(message)DeleteConversationProfileRequest(message)DeleteDocumentRequest(message)DeleteEntityTypeRequest(message)DeleteEnvironmentRequest(message)DeleteGeneratorRequest(message)DeleteIntentRequest(message)DeleteKnowledgeBaseRequest(message)DeleteSessionEntityTypeRequest(message)DeleteSipTrunkRequest(message)DeleteVersionRequest(message)DetectIntentRequest(message)DetectIntentResponse(message)DialogflowAssistAnswer(message)Document(message)Document.KnowledgeType(enum)Document.ReloadStatus(message)Document.State(enum)DtmfParameters(message)EncryptionSpec(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)FewShotExample(message)Fulfillment(message)Fulfillment.Feature(message)Fulfillment.Feature.Type(enum)Fulfillment.GenericWebService(message)GcsDestination(message)GcsSource(message)GcsSources(message)GenerateStatelessSuggestionRequest(message)GenerateStatelessSuggestionResponse(message)GenerateStatelessSummaryRequest(message)GenerateStatelessSummaryRequest.MinimalConversation(message)GenerateStatelessSummaryResponse(message)GenerateStatelessSummaryResponse.Summary(message)Generator(message)GeneratorSuggestion(message)GetAgentRequest(message)GetAnswerRecordRequest(message)GetContextRequest(message)GetConversationProfileRequest(message)GetConversationRequest(message)GetDocumentRequest(message)GetEncryptionSpecRequest(message)GetEntityTypeRequest(message)GetEnvironmentHistoryRequest(message)GetEnvironmentRequest(message)GetFulfillmentRequest(message)GetGeneratorRequest(message)GetIntentRequest(message)GetKnowledgeBaseRequest(message)GetParticipantRequest(message)GetSessionEntityTypeRequest(message)GetSipTrunkRequest(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.DialogflowQuerySource.HumanAgentSideConfig(message)HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource(message)HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource(message)HumanAgentAssistantConfig.SuggestionQueryConfig.Sections(message)HumanAgentAssistantConfig.SuggestionQueryConfig.Sections.SectionType(enum)HumanAgentAssistantConfig.SuggestionTriggerSettings(message)HumanAgentAssistantEvent(message)HumanAgentHandoffConfig(message)HumanAgentHandoffConfig.LivePersonConfig(message)HumanAgentHandoffConfig.SalesforceLiveAgentConfig(message)ImportAgentRequest(message)ImportDocumentTemplate(message)ImportDocumentsRequest(message)ImportDocumentsResponse(message)InferenceParameter(message)InitializeEncryptionSpecMetadata(message)InitializeEncryptionSpecRequest(message)InitializeEncryptionSpecResponse(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)IntentInput(message)IntentSuggestion(message)IntentView(enum)KnowledgeAnswers(message)KnowledgeAnswers.Answer(message)KnowledgeAnswers.Answer.MatchConfidenceLevel(enum)KnowledgeAssistAnswer(message)KnowledgeAssistAnswer.KnowledgeAnswer(message)KnowledgeAssistAnswer.KnowledgeAnswer.FaqSource(message)KnowledgeAssistAnswer.KnowledgeAnswer.GenerativeSource(message)KnowledgeAssistAnswer.KnowledgeAnswer.GenerativeSource.Snippet(message)KnowledgeAssistAnswer.SuggestedQuery(message)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)ListGeneratorsRequest(message)ListGeneratorsResponse(message)ListIntentsRequest(message)ListIntentsResponse(message)ListKnowledgeBasesRequest(message)ListKnowledgeBasesResponse(message)ListMessagesRequest(message)ListMessagesResponse(message)ListParticipantsRequest(message)ListParticipantsResponse(message)ListSessionEntityTypesRequest(message)ListSessionEntityTypesResponse(message)ListSipTrunksRequest(message)ListSipTrunksResponse(message)ListSuggestionsRequest(message) (deprecated)ListSuggestionsResponse(message) (deprecated)ListVersionsRequest(message)ListVersionsResponse(message)LoggingConfig(message)Message(message)MessageAnnotation(message)MessageEntry(message)MessageEntry.Role(enum)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)SearchKnowledgeAnswer(message)SearchKnowledgeAnswer.AnswerSource(message)SearchKnowledgeAnswer.AnswerType(enum)SearchKnowledgeRequest(message)SearchKnowledgeRequest.QuerySource(enum)SearchKnowledgeRequest.SearchConfig(message)SearchKnowledgeRequest.SearchConfig.BoostSpecs(message)SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec(message)SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec(message)SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec(message)SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType(enum)SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint(message)SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType(enum)SearchKnowledgeRequest.SearchConfig.FilterSpecs(message)SearchKnowledgeResponse(message)Sentiment(message)SentimentAnalysisRequestConfig(message)SentimentAnalysisResult(message)SessionEntityType(message)SessionEntityType.EntityOverrideMode(enum)SetAgentRequest(message)SetSuggestionFeatureConfigOperationMetadata(message)SetSuggestionFeatureConfigRequest(message)SipTrunk(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)SuggestDialogflowAssistsResponse(message)SuggestFaqAnswersRequest(message)SuggestFaqAnswersResponse(message)SuggestKnowledgeAssistRequest(message)SuggestKnowledgeAssistResponse(message)SuggestSmartRepliesRequest(message)SuggestSmartRepliesResponse(message)Suggestion(message) (deprecated)Suggestion.Article(message)Suggestion.FaqAnswer(message)SuggestionFeature(message)SuggestionFeature.Type(enum)SuggestionInput(message)SuggestionResult(message)SummarizationContext(message)SummarizationSection(message)SummarizationSection.Type(enum)SummarizationSectionList(message)SummarySuggestion(message)SummarySuggestion.SummarySection(message)SynthesizeSpeechConfig(message)TelephonyDtmf(enum)TelephonyDtmfEvents(message)TextInput(message)TextToSpeechSettings(message)TrainAgentRequest(message)TriggerEvent(enum)UpdateAnswerRecordRequest(message)UpdateContextRequest(message)UpdateConversationProfileRequest(message)UpdateDocumentRequest(message)UpdateEntityTypeRequest(message)UpdateEnvironmentRequest(message)UpdateFulfillmentRequest(message)UpdateGeneratorRequest(message)UpdateIntentRequest(message)UpdateKnowledgeBaseRequest(message)UpdateParticipantRequest(message)UpdateSessionEntityTypeRequest(message)UpdateSipTrunkRequest(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
|
| GenerateStatelessSuggestion |
|---|
|
Generates and returns a suggestion for a conversation that does not have a resource created for it.
|
| GenerateStatelessSummary |
|---|
|
Generates and returns a summary for a conversation that does not have a resource created for it.
|
| 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.
|
| SearchKnowledge |
|---|
|
Get answers for the given query based on knowledge documents.
|
| SuggestConversationSummary |
|---|
|
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.
|
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
|
EncryptionSpecService
Manages encryption spec settings for Dialogflow and Agent Assist.
| GetEncryptionSpec |
|---|
|
Gets location-level encryption key specification.
|
| InitializeEncryptionSpec |
|---|
|
Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
|
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.
|
Generators
Generator Service for LLM powered Agent Assist. This service manages the configurations of user owned Generators, such as description, context and instruction, input/output format, etc. The generator resources will be used inside a conversation and will be triggered by TriggerEvent to query LLM for answers.
| CreateGenerator |
|---|
|
Creates a generator.
|
| DeleteGenerator |
|---|
|
Deletes a generator.
|
| GetGenerator |
|---|
|
Retrieves a generator.
|
| ListGenerators |
|---|
|
Lists generators.
|
| UpdateGenerator |
|---|
|
Updates a generator.
|
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 |
|---|
|
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.
|
| CompileSuggestion |
|---|
|
Deprecated. use Gets suggestions for a participant based on specific historical messages. Note that
|
| CreateParticipant |
|---|
|
Creates a new participant in a conversation.
|
| GetParticipant |
|---|
|
Retrieves a conversation participant.
|
| ListParticipants |
|---|
|
Returns the list of all participants in the specified conversation.
|
| ListSuggestions |
|---|
|
Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See 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
|
| StreamingAnalyzeContent |
|---|
|
Adds a text (e.g., chat) or audio (e.g., phone recording) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST). The top-level message sent to the client by the server is Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.
|
| SuggestArticles |
|---|
|
Gets suggested articles for a participant based on specific historical messages. Note that
|
| SuggestFaqAnswers |
|---|
|
Gets suggested faq answers for a participant based on specific historical messages.
|
| SuggestKnowledgeAssist |
|---|
|
Gets knowledge assist suggestions based on historical messages.
|
| SuggestSmartReplies |
|---|
|
Gets smart replies for a participant based on specific historical messages.
|
| UpdateParticipant |
|---|
|
Updates the specified participant.
|
SessionEntityTypes
Service for managing SessionEntityTypes.
| CreateSessionEntityType |
|---|
|
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.
|
| DeleteSessionEntityType |
|---|
|
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.
|
| GetSessionEntityType |
|---|
|
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.
|
| ListSessionEntityTypes |
|---|
|
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.
|
| UpdateSessionEntityType |
|---|
|
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.
|
Sessions
A service used for session interactions.
For more information, see the API interactions guide.
| DetectIntent |
|---|
|
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. If you might use Agent Assist or other CCAI products now or in the future, consider using Note: Always use agent versions for production traffic. See Versions and environments.
|
| StreamingDetectIntent |
|---|
|
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). If you might use Agent Assist or other CCAI products now or in the future, consider using Note: Always use agent versions for production traffic. See Versions and environments.
|
SipTrunks
Service for managing SipTrunks.
| CreateSipTrunk |
|---|
|
Creates a SipTrunk for a specified location.
|
| DeleteSipTrunk |
|---|
|
Deletes a specified SipTrunk.
|
| GetSipTrunk |
|---|
|
Retrieves the specified SipTrunk.
|
| ListSipTrunks |
|---|
|
Returns a list of SipTrunks in the specified location.
|
| UpdateSipTrunk |
|---|
|
Updates the specified SipTrunk.
|
Versions
Service for managing Versions.
| CreateVersion |
|---|
|
Creates an agent version. The new version points to the agent instance in the "default" environment.
|
| DeleteVersion |
|---|
|
Delete the specified agent version.
|
| GetVersion |
|---|
|
Retrieves the specified agent version.
|
| ListVersions |
|---|
|
Returns the list of all versions of the specified agent.
|
| UpdateVersion |
|---|
|
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.
|
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 |
Required. The project of this agent. Format: |
display_ |
Required. The name of this agent. |
default_ |
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 |
supported_ |
Optional. The list of all languages supported by this agent (except for the |
time_ |
Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris. |
description |
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. |
avatar_ |
Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration. |
enable_ |
Optional. Determines whether this agent should log conversation queries. |
match_mode |
Optional. Determines how intents are detected from user queries. |
classification_ |
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_ |
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 |
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 |
Trial Edition, previously known as Standard Edition. |
TIER_ENTERPRISE |
Essentials Edition, previously known as Enterprise Essential Edition. |
TIER_ENTERPRISE_PLUS |
Essentials Edition (same as TIER_ENTERPRISE), previously known as Enterprise Plus Edition. |
AgentAssistantFeedback
Detail feedback of Agent Assistant result.
| Fields | |
|---|---|
answer_ |
Optional. Whether or not the suggested answer is relevant. For example:
|
document_ |
Optional. Whether or not the information in the document is correct. For example:
|
document_ |
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, |
summarization_ |
Feedback for conversation summarization. |
knowledge_ |
Optional. Feedback for knowledge search. |
knowledge_ |
Optional. Feedback for knowledge assist. |
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. |
KnowledgeAssistFeedback
Feedback for knowledge assist.
| Fields | |
|---|---|
answer_ |
Whether the suggested answer was copied by the human agent. If the value is set to be true, |
clicked_ |
The URIs clicked by the human agent. The value is appended for each |
KnowledgeSearchFeedback
Feedback for knowledge search.
| Fields | |
|---|---|
answer_ |
Whether the answer was copied by the human agent or not. If the value is set to be true, |
clicked_ |
The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, |
SummarizationFeedback
Feedback for conversation summarization.
| Fields | |
|---|---|
start_ |
Timestamp when composing of the summary starts. |
submit_ |
Timestamp when the summary was submitted. |
summary_ |
Text of actual submitted summary. |
text_ |
Optional. Actual text sections of 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_ |
Output only. The article suggestion answer. |
faq_ |
Output only. The FAQ answer. |
dialogflow_ |
Output only. The Dialogflow assist answer. |
AnalyzeContentRequest
The request message for Participants.AnalyzeContent.
| Fields | |
|---|---|
participant |
Required. The name of the participant this text comes from. Format: Authorization requires the following IAM permission on the specified resource
|
reply_ |
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_ |
Parameters for a Dialogflow virtual-agent query. |
assist_ |
Parameters for a human assist query. |
cx_ |
Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Note: this field should only be used if you are connecting to a Dialogflow CX agent. |
cx_ |
The unique identifier of the CX page to override the If Note: this field should only be used if you are connecting to a Dialogflow CX agent. |
message_ |
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_ |
A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a |
Union field input. Required. The input content. input can be only one of the following: |
|
text_ |
The natural language text to be processed. |
audio_ |
The natural language speech audio to be processed. |
event_ |
An input event to send to Dialogflow. |
suggestion_ |
An input representing the selection of a suggestion. |
intent_ |
The intent to be triggered on V3 agent. |
AnalyzeContentResponse
The response message for Participants.AnalyzeContent.
| Fields | |
|---|---|
reply_ |
Output only. The output text content. This field is set if the automated agent responded with text to show to the user. |
reply_ |
Optional. The audio data bytes encoded as specified in the request. This field is set if:
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_ |
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 |
message |
Output only. Message analyzed by CCAI. |
human_ |
The suggestions for most recent human agent. The order is the same as Note that any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult. |
end_ |
The suggestions for end user. The order is the same as Same as human_agent_suggestion_results, any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult. |
dtmf_ |
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 |
Required. A part of a message possibly annotated with an entity. |
entity_ |
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_ |
Optional. The Dialogflow system entity formatted value of this message part. For example for a system entity of type
{
"amount": 5,
"currency": "USD"
}
|
AnswerFeedback
Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.
| Fields | |
|---|---|
correctness_ |
The correctness level of the specific answer. |
clicked |
Indicates whether the answer/item was clicked by the human agent or not. Default to false. For knowledge search, the answer record is considered to be clicked if the answer was copied or any URI was clicked. |
click_ |
Time when the answer/item was clicked. |
displayed |
Indicates whether the answer/item was displayed to the human agent in the agent desktop UI. Default to false. |
display_ |
Time when the answer/item was displayed. |
Union field detail_feedback. Normally, detail feedback is provided when answer is not fully correct. detail_feedback can be only one of the following: |
|
agent_ |
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:
DetectIntentintent matchingDetectIntentknowledge
Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated.
A typical workflow for customers provide feedback to an answer is:
- For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers,
AnswerRecord.nameare returned to the customers. - The customer uses the
AnswerRecord.nameto call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.
| Fields | |
|---|---|
name |
The unique identifier of this answer record. Required for |
answer_ |
Optional. The AnswerFeedback for this record. You can set this with |
Union field record. Output only. The record for this answer. record can be only one of the following: |
|
agent_ |
Output only. The record for human agent assistant. |
ArticleAnswer
Represents article answer.
| Fields | |
|---|---|
title |
The article title. |
uri |
The article URI. |
snippets[] |
Output only. Article snippets. |
metadata |
A map that contains metadata about the answer and the document from which it originates. |
answer_ |
The name of answer record, in the format of "projects/ |
AssistQueryParameters
Represents the parameters of human assist query.
| Fields | |
|---|---|
documents_ |
Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their |
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. |
AUDIO_ENCODING_ALAW |
8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law. |
AudioInput
Represents the natural language speech audio to be processed.
| Fields | |
|---|---|
config |
Required. Instructs the speech recognizer how to process the speech audio. |
audio |
Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. |
AutomatedAgentConfig
Defines the Automated Agent to connect to a conversation.
| Fields | |
|---|---|
agent |
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
|
session_ |
Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day. |
AutomatedAgentReply
Represents a response from an automated agent.
| Fields | |
|---|---|
response_ |
Response messages from the automated agent. |
match_ |
The confidence of the match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
parameters |
The collection of current parameters at the time of this response. |
cx_session_parameters |
The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use |
automated_ |
AutomatedAgentReply type. |
allow_ |
Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled. |
cx_ |
The unique identifier of the current Dialogflow CX conversation page. Format: |
call_ |
The auth code for accessing Call Companion UI. |
Union field response. Required. response can be only one of the following: |
|
detect_ |
Response of the Dialogflow |
Union field match. Info on the query match for the automated agent response. match can be only one of the following: |
|
intent |
Name of the intent if an intent is matched for the query. For a V2 query, the value format is |
event |
Event name if an event is triggered for the query. |
AutomatedAgentReplyType
Represents different automated agent reply types.
| Enums | |
|---|---|
AUTOMATED_AGENT_REPLY_TYPE_UNSPECIFIED |
Not specified. This should never happen. |
PARTIAL |
Partial reply. e.g. Aggregated responses in a Fulfillment that enables return_partial_response can be returned as partial reply. WARNING: partial reply is not eligible for barge-in. |
FINAL |
Final reply. |
BargeInConfig
Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request.
The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases:
No barge-in phase: which goes first and during which speech detection should not be carried out.
Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase.
The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio.
The flow goes like below:
--> Time
without speech detection | utterance only | utterance or no-speech event
| |
+-------------+ | +------------+ | +---------------+
----------+ no barge-in +-|-+ barge-in +-|-+ normal period +-----------
+-------------+ | +------------+ | +---------------+
No-speech event is a response with END_OF_UTTERANCE without any transcript following up.
| Fields | |
|---|---|
no_ |
Duration that is not eligible for barge-in at the beginning of the input audio. |
total_ |
Total duration for the playback at the beginning of the input audio. |
BatchCreateEntitiesRequest
The request message for EntityTypes.BatchCreateEntities.
| Fields | |
|---|---|
parent |
Required. The name of the entity type to create entities in. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
entities[] |
Required. The entities to create. |
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
BatchCreateMessagesRequest
The request message for [Conversations.BatchCreateMessagesRequest][].
| Fields | |
|---|---|
parent |
Required. Resource identifier of the conversation to create message. Format: Authorization requires the following IAM permission on the specified resource
|
requests[] |
Required. A maximum of 300 messages can be created in a batch. [CreateMessageRequest.message.send_time][] is required. All created messages will have identical |
BatchCreateMessagesResponse
The request message for [Conversations.BatchCreateMessagesResponse][].
| Fields | |
|---|---|
messages[] |
Messages created. |
BatchDeleteEntitiesRequest
The request message for EntityTypes.BatchDeleteEntities.
| Fields | |
|---|---|
parent |
Required. The name of the entity type to delete entries for. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
entity_ |
Required. The reference |
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
BatchDeleteEntityTypesRequest
The request message for EntityTypes.BatchDeleteEntityTypes.
| Fields | |
|---|---|
parent |
Required. The name of the agent to delete all entities types for. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
entity_ |
Required. The names entity types to delete. All names must point to the same agent as |
BatchDeleteIntentsRequest
The request message for Intents.BatchDeleteIntents.
| Fields | |
|---|---|
parent |
Required. The name of the agent to delete all entities types for. Supported formats:
Authorization requires the following IAM permission on the specified resource
|
intents[] |
Required. The collection of intents to delete. Only intent |
BatchUpdateEntitiesRequest
The request message for EntityTypes.BatchUpdateEntities.
| Fields | |
|---|---|
parent |
Required. The name of the entity type to update or create entities in. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
entities[] |
Required. The entities to update or create. |
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
update_ |
Optional. The mask to control which fields get updated. |
BatchUpdateEntityTypesRequest
The request message for EntityTypes.BatchUpdateEntityTypes.
| Fields | |
|---|---|
parent |
Required. The name of the agent to update or create entity types in. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
update_ |
Optional. The mask to control which fields get updated. |
Union field For each entity type in the batch:
|
|
entity_ |
The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://". |
entity_ |
The collection of entity types to update or create. |
BatchUpdateEntityTypesResponse
The response message for EntityTypes.BatchUpdateEntityTypes.
| Fields | |
|---|---|
entity_ |
The collection of updated or created entity types. |
BatchUpdateIntentsRequest
The request message for Intents.BatchUpdateIntents.
| Fields | |
|---|---|
parent |
Required. The name of the agent to update or create intents in. Supported formats:
Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
update_ |
Optional. The mask to control which fields get updated. |
intent_ |
Optional. The resource view to apply to the returned intent. |
Union field For each intent in the batch:
|
|
intent_ |
The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://". |
intent_ |
The collection of intents to update or create. |
BatchUpdateIntentsResponse
The response message for Intents.BatchUpdateIntents.
| Fields | |
|---|---|
intents[] |
The collection of updated or created intents. |
ClearSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] operation.
| Fields | |
|---|---|
conversation_ |
The resource name of the conversation profile. Format: |
participant_ |
Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used. |
suggestion_ |
Required. The type of the suggestion feature to remove. |
create_ |
Timestamp whe the request was created. The time is measured on server side. |
ClearSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.ClearFeature][].
| Fields | |
|---|---|
conversation_ |
Required. The Conversation Profile to add or update the suggestion feature config. Format: |
participant_ |
Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used. |
suggestion_ |
Required. The type of the suggestion feature to remove. |
CloudConversationDebuggingInfo
Cloud conversation info for easier debugging. It will get populated in StreamingDetectIntentResponse or StreamingAnalyzeContentResponse when the flag enable_debugging_info is set to true in corresponding requests.
| Fields | |
|---|---|
audio_ |
Number of input audio data chunks in streaming requests. |
result_ |
Time offset of the end of speech utterance relative to the beginning of the first audio chunk. |
first_ |
Duration of first audio chunk. |
single_ |
Whether client used single utterance mode. |
speech_ |
Time offsets of the speech partial results relative to the beginning of the stream. |
speech_ |
Time offsets of the speech final results (is_final=true) relative to the beginning of the stream. |
partial_ |
Total number of partial responses. |
speaker_ |
Time offset of Speaker ID stream close time relative to the Speech stream close time in milliseconds. Only meaningful for conversations involving passive verification. |
bargein_ |
Whether a barge-in event is triggered in this request. |
speech_ |
Whether speech uses single utterance mode. |
dtmf_ |
Time offsets of the DTMF partial results relative to the beginning of the stream. |
dtmf_ |
Time offsets of the DTMF final results relative to the beginning of the stream. |
single_ |
Time offset of the end-of-single-utterance signal relative to the beginning of the stream. |
no_ |
No speech timeout settings for the stream. |
endpointing_ |
Speech endpointing timeout settings for the stream. |
is_ |
Whether the streaming terminates with an injected text query. |
client_ |
Client half close time in terms of input audio duration. |
client_ |
Client half close time in terms of API streaming duration. |
CompileSuggestionRequest
The request message for Participants.CompileSuggestion.
| Fields | |
|---|---|
parent |
Required. The name of the participant to fetch suggestion for. Format: Authorization requires the following IAM permission on the specified resource
|
latest_ |
Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: |
context_ |
Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. If zero or less than zero, 20 is used. |
CompileSuggestionResponse
The response message for Participants.CompileSuggestion.
| Fields | |
|---|---|
suggestion |
The compiled suggestion. |
latest_ |
The name of the latest conversation message used to compile suggestion for. Format: |
context_ |
Number of messages prior to and including |
CompleteConversationRequest
The request message for Conversations.CompleteConversation.
| Fields | |
|---|---|
name |
Required. Resource identifier of the conversation to close. Format: Authorization requires the following IAM permission on the specified resource
|
Connection
Represents a connection for SIP Trunk.
| Fields | |
|---|---|
connection_ |
Output only. The unique identifier of the SIP Trunk connection. |
state |
Output only. State of the connection. |
update_ |
Output only. When the connection status changed. |
error_ |
Output only. The error details for the connection. Only populated when authentication errors occur. |
CertificateState
The state of Sip Trunk certificate authentication.
| Enums | |
|---|---|
CERTIFICATE_STATE_UNSPECIFIED |
Certificate state is not specified. |
CERTIFICATE_VALID |
Certificate is valid. |
CERTIFICATE_INVALID |
Catch all for any error not specified. |
CERTIFICATE_EXPIRED |
Certificate leaf node has expired. |
CERTIFICATE_HOSTNAME_NOT_FOUND |
There is no hostname defined to authenticate in SipTrunkingServer. |
CERTIFICATE_UNAUTHENTICATED |
No path found from the leaf certificate to any root. |
CERTIFICATE_TRUST_STORE_NOT_FOUND |
Trust store does not exist. |
CERTIFICATE_HOSTNAME_INVALID_FORMAT |
Hostname has invalid format. |
CERTIFICATE_QUOTA_EXCEEDED |
Certificate has exhausted its quota. |
ErrorDetails
The error details of Sip Trunk connection authentication.
| Fields | |
|---|---|
certificate_ |
Output only. The status of the certificate authentication. |
error_ |
The error message provided from SIP trunking auth service |
State
The state of Sip Trunk connection.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
SIP Trunk connection state is Not specified. |
CONNECTED |
SIP Trunk connection is connected. |
DISCONNECTED |
SIP Trunk connection is disconnected. |
AUTHENTICATION_FAILED |
SIP Trunk connection has authentication error. |
KEEPALIVE |
SIP Trunk connection is keepalive. |
Context
Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent.
Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts.
For more information about context, see the Contexts guide.
| Fields | |
|---|---|
name |
Required. The unique identifier of the context. Supported formats: - The If The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names:
|
lifespan_ |
Optional. The number of conversational query requests after which the context expires. The default is |
parameters |
Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
|
Conversation
Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
| Fields | |
|---|---|
name |
Output only. Identifier. The unique identifier of this conversation. Format: |
lifecycle_ |
Output only. The current state of the Conversation. |
conversation_ |
Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: |
phone_ |
Output only. Required if the conversation is to be connected over telephony. |
conversation_ |
Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to |
start_ |
Output only. The time the conversation was started. |
end_ |
Output only. The time the conversation was finished. |
ConversationStage
Enumeration of the different conversation stages a conversation can be in. Reference: https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
| Enums | |
|---|---|
CONVERSATION_STAGE_UNSPECIFIED |
Unknown. Should never be used after a conversation is successfully created. |
VIRTUAL_AGENT_STAGE |
The conversation should return virtual agent responses into the conversation. |
HUMAN_ASSIST_STAGE |
The conversation should not provide responses, just listen and provide suggestions. |
LifecycleState
Enumeration of the completion status of the conversation.
| Enums | |
|---|---|
LIFECYCLE_STATE_UNSPECIFIED |
Unknown. |
IN_PROGRESS |
Conversation is currently open for media analysis. |
COMPLETED |
Conversation has been completed. |
ConversationContext
Context of the conversation, including transcripts.
| Fields | |
|---|---|
message_ |
Optional. List of message transcripts in the conversation. |
ConversationEvent
Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.
| Fields | |
|---|---|
conversation |
Required. The unique identifier of the conversation this notification refers to. Format: |
type |
Required. The type of the event that this notification refers to. |
error_ |
Optional. More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL. |
Union field payload. Payload of conversation event. payload can be only one of the following: |
|
new_ |
Payload of NEW_MESSAGE event. |
Type
Enumeration of the types of events available.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Type not set. |
CONVERSATION_STARTED |
A new conversation has been opened. This is fired when a telephone call is answered, or a conversation is created via the API. |
CONVERSATION_FINISHED |
An existing conversation has closed. This is fired when a telephone call is terminated, or a conversation is closed via the API. |
HUMAN_INTERVENTION_NEEDED |
An existing conversation has received notification from Dialogflow that human intervention is required. |
NEW_MESSAGE |
An existing conversation has received a new message, either from API or telephony. It is configured in ConversationProfile.new_message_event_notification_config |
UNRECOVERABLE_ERROR |
Unrecoverable error during a telephone call. In general non-recoverable errors only occur if something was misconfigured in the ConversationProfile corresponding to the call. After a non-recoverable error, Dialogflow may stop responding. We don't fire this event:
|
ConversationPhoneNumber
Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.
| Fields | |
|---|---|
phone_ |
Output only. The phone number to connect to this conversation. |
ConversationProfile
Defines the services to connect to incoming Dialogflow conversations.
| Fields | |
|---|---|
name |
The unique identifier of this conversation profile. Format: |
display_ |
Required. Human readable name for this profile. Max length 1024 bytes. |
create_ |
Output only. Create time of the conversation profile. |
update_ |
Output only. Update time of the conversation profile. |
automated_ |
Configuration for an automated agent to use with this profile. |
human_ |
Configuration for agent assistance to use with this profile. |
human_ |
Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access. |
notification_ |
Configuration for publishing conversation lifecycle events. |
logging_ |
Configuration for logging conversation lifecycle events. |
new_ |
Configuration for publishing new message events. Event will be sent in format of |
stt_ |
Settings for speech transcription. |
language_ |
Language code for the conversation profile. If not specified, the language is en-US. Language at ConversationProfile should be set for all non en-us languages. This should be a BCP-47 language tag. Example: "en-US". |
time_ |
The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York. |
security_ |
Name of the CX SecuritySettings reference for the agent. Format: |
tts_ |
Configuration for Text-to-Speech synthesization. Used by Phone Gateway to specify synthesization options. If agent defines synthesization options as well, agent settings overrides the option here. |
CreateContextRequest
The request message for Contexts.CreateContext.
| Fields | |
|---|---|
parent |
Required. The session to create a context for. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
context |
Required. The context to create. |
CreateConversationProfileRequest
The request message for ConversationProfiles.CreateConversationProfile.
| Fields | |
|---|---|
parent |
Required. The project to create a conversation profile for. Format: Authorization requires the following IAM permission on the specified resource
|
conversation_ |
Required. The conversation profile to create. |
CreateConversationRequest
The request message for Conversations.CreateConversation.
| Fields | |
|---|---|
parent |
Required. Resource identifier of the project creating the conversation. Format: Authorization requires the following IAM permission on the specified resource
|
conversation |
Required. The conversation to create. |
conversation_ |
Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula |
CreateDocumentRequest
Request message for Documents.CreateDocument.
| Fields | |
|---|---|
parent |
Required. The knowledge base to create a document for. Format: Authorization requires the following IAM permission on the specified resource
|
document |
Required. The document to create. |
import_ |
Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI. |
CreateEntityTypeRequest
The request message for EntityTypes.CreateEntityType.
| Fields | |
|---|---|
parent |
Required. The agent to create a entity type for. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
entity_ |
Required. The entity type to create. |
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
CreateEnvironmentRequest
The request message for Environments.CreateEnvironment.
| Fields | |
|---|---|
parent |
Required. The agent to create an environment for. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
environment |
Required. The environment to create. |
environment_ |
Required. The unique id of the new environment. |
CreateGeneratorRequest
Request message of CreateGenerator.
| Fields | |
|---|---|
parent |
Required. The project/location to create generator for. Format: |
generator |
Required. The generator to create. |
generator_ |
Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula |
CreateIntentRequest
The request message for Intents.CreateIntent.
| Fields | |
|---|---|
parent |
Required. The agent to create a intent for. Supported formats:
Authorization requires the following IAM permission on the specified resource
|
intent |
Required. The intent to create. |
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
intent_ |
Optional. The resource view to apply to the returned intent. |
CreateKnowledgeBaseRequest
Request message for KnowledgeBases.CreateKnowledgeBase.
| Fields | |
|---|---|
parent |
Required. The project to create a knowledge base for. Format: Authorization requires the following IAM permission on the specified resource
|
knowledge_ |
Required. The knowledge base to create. |
CreateMessageRequest
The request message to create one Message. Currently it is only used in BatchCreateMessagesRequest.
| Fields | |
|---|---|
parent |
Required. Resource identifier of the conversation to create message. Format: Authorization requires the following IAM permission on the specified resource
|
message |
Required. The message to create. |
CreateParticipantRequest
The request message for Participants.CreateParticipant.
| Fields | |
|---|---|
parent |
Required. Resource identifier of the conversation adding the participant. Format: Authorization requires the following IAM permission on the specified resource
|
participant |
Required. The participant to create. |
CreateSessionEntityTypeRequest
The request message for SessionEntityTypes.CreateSessionEntityType.
| Fields | |
|---|---|
parent |
Required. The session to create a session entity type for. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
session_ |
Required. The session entity type to create. |
CreateSipTrunkRequest
The request message for SipTrunks.CreateSipTrunk.
| Fields | |
|---|---|
parent |
Required. The location to create a SIP trunk for. Format: Authorization requires the following IAM permission on the specified resource
|
sip_ |
Required. The SIP trunk to create. |
CreateVersionRequest
The request message for Versions.CreateVersion.
| Fields | |
|---|---|
parent |
Required. The agent to create a version for. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
version |
Required. The version to create. |
DeleteAgentRequest
The request message for Agents.DeleteAgent.
| Fields | |
|---|---|
parent |
Required. The project that the agent to delete is associated with. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteAllContextsRequest
The request message for Contexts.DeleteAllContexts.
| Fields | |
|---|---|
parent |
Required. The name of the session to delete all contexts from. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
DeleteContextRequest
The request message for Contexts.DeleteContext.
| Fields | |
|---|---|
name |
Required. The name of the context to delete. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
DeleteConversationProfileRequest
The request message for ConversationProfiles.DeleteConversationProfile.
This operation fails if the conversation profile is still referenced from a phone number.
| Fields | |
|---|---|
name |
Required. The name of the conversation profile to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteDocumentRequest
Request message for Documents.DeleteDocument.
| Fields | |
|---|---|
name |
Required. The name of the document to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteEntityTypeRequest
The request message for EntityTypes.DeleteEntityType.
| Fields | |
|---|---|
name |
Required. The name of the entity type to delete. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
DeleteEnvironmentRequest
The request message for Environments.DeleteEnvironment.
| Fields | |
|---|---|
name |
Required. The name of the environment to delete. / Format: - Authorization requires the following IAM permission on the specified resource
|
DeleteGeneratorRequest
Request of DeleteGenerator.
| Fields | |
|---|---|
name |
Required. The generator resource name to delete. Format: |
DeleteIntentRequest
The request message for Intents.DeleteIntent.
| Fields | |
|---|---|
name |
Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Supported formats:
Authorization requires the following IAM permission on the specified resource
|
DeleteKnowledgeBaseRequest
Request message for KnowledgeBases.DeleteKnowledgeBase.
| Fields | |
|---|---|
name |
Required. The name of the knowledge base to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted. |
DeleteSessionEntityTypeRequest
The request message for SessionEntityTypes.DeleteSessionEntityType.
| Fields | |
|---|---|
name |
Required. The name of the entity type to delete. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
DeleteSipTrunkRequest
The request message for SipTrunks.DeleteSipTrunk.
| Fields | |
|---|---|
name |
Required. The name of the SIP trunk to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteVersionRequest
The request message for Versions.DeleteVersion.
| Fields | |
|---|---|
name |
Required. The name of the version to delete. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
DetectIntentRequest
The request to detect user's intent.
| Fields | |
|---|---|
session |
Required. The name of the session this query is sent to. Supported formats: - If Note: Always use agent versions for production traffic. See Versions and environments. Authorization requires the following IAM permission on the specified resource
|
query_ |
The parameters of this query. |
query_ |
Required. The input specification. It can be set to:
|
output_ |
Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated. |
output_ |
Mask for If unspecified or empty, |
input_ |
The natural language speech audio to be processed. This field should be populated iff |
DetectIntentResponse
The message returned from the DetectIntent method.
| Fields | |
|---|---|
response_ |
The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. |
query_ |
The selected results of the conversational query or event processing. See |
alternative_ |
If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing |
webhook_ |
Specifies the status of the webhook request. |
output_ |
The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the 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. |
output_ |
The config used by the speech synthesizer to generate the output audio. |
DialogflowAssistAnswer
Represents a Dialogflow assist answer.
| Fields | |
|---|---|
answer_ |
The name of answer record, in the format of "projects/ |
Union field result. Result from DetectIntent for one matched intent. result can be only one of the following: |
|
query_ |
Result from v2 agent. |
intent_ |
An intent suggestion generated from conversation. |
Document
A knowledge document to be used by a KnowledgeBase.
For more information, see the knowledge base guide.
Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.
| Fields | |
|---|---|
name |
Optional. The document resource name. The name must be empty when creating a document. Format: |
display_ |
Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails. |
mime_ |
Required. The MIME type of this document. |
knowledge_ |
Required. The knowledge type of document content. |
enable_ |
Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see Reload status can be tracked in If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling |
latest_ |
Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded. |
metadata |
Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a |
state |
Output only. The current state of the document. |
Union field source. The source of this document. source can be only one of the following: |
|
content_ |
The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the |
content |
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead. |
raw_ |
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. |
KnowledgeType
The knowledge type of document content.
| Enums | |
|---|---|
KNOWLEDGE_TYPE_UNSPECIFIED |
The type is unspecified or arbitrary. |
FAQ |
The document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately. |
EXTRACTIVE_QA |
Documents for which unstructured text is extracted and used for question answering. |
ARTICLE_SUGGESTION |
The entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow. |
AGENT_FACING_SMART_REPLY |
The document contains agent-facing Smart Reply entries. |
SMART_REPLY |
The legacy enum for agent-facing smart reply feature. |
ReloadStatus
The status of a reload attempt.
| Fields | |
|---|---|
time |
Output only. The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded. |
status |
Output only. The status of a reload attempt or the initial load. |
State
Possible states of the document
| Enums | |
|---|---|
STATE_UNSPECIFIED |
The document state is unspecified. |
CREATING |
The document creation is in progress. |
ACTIVE |
The document is active and ready to use. |
UPDATING |
The document updation is in progress. |
RELOADING |
The document is reloading. |
DELETING |
The document deletion is in progress. |
DtmfParameters
The message in the response that indicates the parameters of DTMF.
| Fields | |
|---|---|
accepts_ |
Indicates whether DTMF input can be handled in the next request. |
EncryptionSpec
A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
| Fields | |
|---|---|
name |
Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec |
kms_ |
Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: |
EntityType
Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.
Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent.
For more information, see the Entity guide.
| Fields | |
|---|---|
name |
The unique identifier of the entity type. Required for |
display_ |
Required. The name of the entity type. |
kind |
Required. Indicates the kind of entity type. |
auto_ |
Optional. Indicates whether the entity type can be automatically expanded. |
entities[] |
Optional. The collection of entity entries associated with the entity type. |
enable_ |
Optional. Enables fuzzy entity extraction during classification. |
AutoExpansionMode
Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).
| Enums | |
|---|---|
AUTO_EXPANSION_MODE_UNSPECIFIED |
Auto expansion disabled for the entity. |
AUTO_EXPANSION_MODE_DEFAULT |
Allows an agent to recognize values that have not been explicitly listed in the entity. |
Entity
An entity entry for an associated entity type.
| Fields | |
|---|---|
value |
Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For
For
|
synonyms[] |
Required. A collection of value synonyms. For example, if the entity type is vegetable, and For
|
Kind
Represents kinds of entities.
| Enums | |
|---|---|
KIND_UNSPECIFIED |
Not specified. This value should be never used. |
KIND_MAP |
Map entity types allow mapping of a group of synonyms to a reference value. |
KIND_LIST |
List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases). |
KIND_REGEXP |
Regexp entity types allow to specify regular expressions in entries values. |
EntityTypeBatch
This message is a wrapper around a collection of entity types.
| Fields | |
|---|---|
entity_ |
A collection of entity types. |
Environment
You can create multiple versions of your agent and publish them to separate environments.
When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.
When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc.
For more information, see the versions and environments guide.
| Fields | |
|---|---|
name |
Output only. The unique identifier of this agent environment. Supported formats: - |
description |
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. |
agent_ |
Optional. The agent version loaded into this environment. Supported formats: - |
state |
Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. |
update_ |
Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. |
text_ |
Optional. Text to speech settings for this environment. |
fulfillment |
Optional. The fulfillment settings to use for this environment. |
State
Represents an environment state. When an environment is pointed to a new agent version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Not specified. This value is not used. |
STOPPED |
Stopped. |
LOADING |
Loading. |
RUNNING |
Running. |
EnvironmentHistory
The response message for Environments.GetEnvironmentHistory.
| Fields | |
|---|---|
parent |
Output only. The name of the environment this history is for. Supported formats: - |
entries[] |
Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Output only. Token to retrieve the next page of results, or empty if there are no more results in the list. |
Entry
Represents an environment history entry.
| Fields | |
|---|---|
agent_ |
The agent version loaded into this environment history entry. |
description |
The developer-provided description for this environment history entry. |
create_ |
The creation time of this environment history entry. |
EventInput
Events allow for matching intents by event name instead of the natural language input. For instance, input <event: { name: "welcome_event",
parameters: { name: "Sam" } }> can trigger a personalized welcome response. The parameter name may be used by the agent in the response: "Hello #welcome_event.name! What can I do for you today?".
| Fields | |
|---|---|
name |
Required. The unique identifier of the event. |
parameters |
The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
|
language_ |
Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. This field is ignored when used in the context of a |
ExportAgentRequest
The request message for Agents.ExportAgent.
| Fields | |
|---|---|
parent |
Required. The project that the agent to export is associated with. Format: Authorization requires the following IAM permission on the specified resource
|
agent_ |
Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control. |
ExportAgentResponse
The response message for Agents.ExportAgent.
| Fields | |
|---|---|
Union field agent. The exported agent. agent can be only one of the following: |
|
agent_ |
The URI to a file containing the exported agent. This field is populated only if |
agent_ |
Zip compressed raw byte content for agent. |
ExportOperationMetadata
Metadata related to the Export Data Operations (e.g. ExportDocument).
| Fields | |
|---|---|
exported_ |
Cloud Storage file path of the exported data. |
FaqAnswer
Represents answer from "frequently asked questions".
| Fields | |
|---|---|
answer |
The piece of text from the |
confidence |
The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). |
question |
The corresponding FAQ question. |
source |
Indicates which Knowledge Document this answer was extracted from. Format: |
metadata |
A map that contains metadata about the answer and the document from which it originates. |
answer_ |
The name of answer record, in the format of "projects/ |
FewShotExample
Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
| Fields | |
|---|---|
conversation_ |
Optional. Conversation transcripts. |
extra_ |
Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains "@price", and ingested data has <"price", "10"> |
output |
Required. Example output of the model. |
Union field instruction_list. Instruction list of this few_shot example. instruction_list can be only one of the following: |
|
summarization_ |
Summarization sections. |
Fulfillment
By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.
For more information, see the fulfillment guide.
| Fields | |
|---|---|
name |
Required. The unique identifier of the fulfillment. Supported formats:
This field is not used for Fulfillment in an Environment. |
display_ |
The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. |
enabled |
Whether fulfillment is enabled. |
features[] |
The field defines whether the fulfillment is enabled for certain features. |
Union field fulfillment. Required. The fulfillment configuration. fulfillment can be only one of the following: |
|
generic_ |
Configuration for a generic web service. |
Feature
Whether fulfillment is enabled for the specific feature.
| Fields | |
|---|---|
type |
The type of the feature that enabled for fulfillment. |
Type
The type of the feature.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Feature type not specified. |
SMALLTALK |
Fulfillment is enabled for SmallTalk. |
GenericWebService
Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications:
- Basic authentication with username and password.
- Authentication with additional authentication headers.
More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.
| Fields | |
|---|---|
uri |
Required. The fulfillment URI for receiving POST requests. It must use https protocol. |
username |
The user name for HTTP Basic authentication. |
password |
The password for HTTP Basic authentication. |
request_ |
The HTTP request headers to send together with fulfillment requests. |
is_cloud_function |
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. |
GcsDestination
Google Cloud Storage location for the output.
| Fields | |
|---|---|
uri |
Required. The Google Cloud Storage URIs for the output. A URI is of the form: |
GcsSource
Google Cloud Storage location for single input.
| Fields | |
|---|---|
uri |
Required. The Google Cloud Storage URIs for the inputs. A URI is of the form: |
GcsSources
Google Cloud Storage locations for the inputs.
| Fields | |
|---|---|
uris[] |
Required. Google Cloud Storage URIs for the inputs. A URI is of the form: |
GenerateStatelessSuggestionRequest
The request message for Conversations.GenerateStatelessSuggestion.
| Fields | |
|---|---|
parent |
Required. The parent resource to charge for the Suggestion's generation. Format: |
conversation_ |
Optional. Context of the conversation, including transcripts. |
trigger_ |
Optional. A list of trigger events. Generator will be triggered only if it's trigger event is included here. |
Union field generator_resource. Generator. generator_resource can be only one of the following: |
|
generator |
Uncreated generator. It should be a complete generator that includes all information about the generator. |
generator_ |
The resource name of the existing created generator. Format: |
GenerateStatelessSuggestionResponse
The response message for Conversations.GenerateStatelessSuggestion.
| Fields | |
|---|---|
generator_ |
Required. Generated suggestion for a conversation. |
GenerateStatelessSummaryRequest
The request message for Conversations.GenerateStatelessSummary.
| Fields | |
|---|---|
stateless_ |
Required. The conversation to suggest a summary for. |
conversation_ |
Required. A ConversationProfile containing information required for Summary generation. Required fields: {language_code, security_settings} Optional fields: {agent_assistant_config} |
latest_ |
Optional. The name of the latest conversation message used as context for generating a Summary. If empty, the latest message of the conversation will be used. The format is specific to the user and the names of the messages provided. |
max_ |
Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000. |
MinimalConversation
The minimum amount of information required to generate a Summary without having a Conversation resource created.
| Fields | |
|---|---|
messages[] |
Required. The messages that the Summary will be generated from. It is expected that this message content is already redacted and does not contain any PII. Required fields: {content, language_code, participant, participant_role} Optional fields: {send_time} If send_time is not provided, then the messages must be provided in chronological order. |
parent |
Required. The parent resource to charge for the Summary's generation. Format: |
GenerateStatelessSummaryResponse
The response message for Conversations.GenerateStatelessSummary.
| Fields | |
|---|---|
summary |
Generated summary. |
latest_ |
The name of the latest conversation message used as context for compiling suggestion. The format is specific to the user and the names of the messages provided. |
context_ |
Number of messages prior to and including [last_conversation_message][] used to compile the suggestion. It may be smaller than the [GenerateStatelessSummaryRequest.context_size][] field in the request if there weren't that many messages in the conversation. |
Summary
Generated summary for a conversation.
| Fields | |
|---|---|
text |
The summary content that is concatenated into one string. |
text_ |
The summary content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value. |
baseline_ |
The baseline model version used to generate this summary. It is empty if a baseline model was not used to generate this summary. |
Generator
LLM generator.
| Fields | |
|---|---|
name |
Output only. Identifier. The resource name of the generator. Format: |
description |
Optional. Human readable description of the generator. |
inference_ |
Optional. Inference parameters for this generator. |
trigger_ |
Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation. |
create_ |
Output only. Creation time of this generator. |
update_ |
Output only. Update time of this generator. |
Union field context. Required. Input context of the generator. context can be only one of the following: |
|
summarization_ |
Input of Summarization feature. |
GeneratorSuggestion
Suggestion generated using a Generator.
| Fields | |
|---|---|
Union field suggestion. The suggestion could be one of the many types suggestion can be only one of the following: |
|
summary_ |
Optional. Suggested summary. |
GetAgentRequest
The request message for Agents.GetAgent.
| Fields | |
|---|---|
parent |
Required. The project that the agent to fetch is associated with. Format: Authorization requires the following IAM permission on the specified resource
|
GetAnswerRecordRequest
Request message for AnswerRecords.GetAnswerRecord.
| Fields | |
|---|---|
name |
Required. The name of the answer record to retrieve. Format: Authorization requires the following IAM permission on the specified resource
|
GetContextRequest
The request message for Contexts.GetContext.
| Fields | |
|---|---|
name |
Required. The name of the context. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
GetConversationProfileRequest
The request message for ConversationProfiles.GetConversationProfile.
| Fields | |
|---|---|
name |
Required. The resource name of the conversation profile. Format: Authorization requires the following IAM permission on the specified resource
|
GetConversationRequest
The request message for Conversations.GetConversation.
| Fields | |
|---|---|
name |
Required. The name of the conversation. Format: Authorization requires the following IAM permission on the specified resource
|
GetDocumentRequest
Request message for Documents.GetDocument.
| Fields | |
|---|---|
name |
Required. The name of the document to retrieve. Format Authorization requires the following IAM permission on the specified resource
|
GetEncryptionSpecRequest
The request to get location-level encryption specification.
| Fields | |
|---|---|
name |
Required. The name of the encryption spec resource to get. |
GetEntityTypeRequest
The request message for EntityTypes.GetEntityType.
| Fields | |
|---|---|
name |
Required. The name of the entity type. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
GetEnvironmentHistoryRequest
The request message for Environments.GetEnvironmentHistory.
| Fields | |
|---|---|
parent |
Required. The name of the environment to retrieve history for. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
GetEnvironmentRequest
The request message for Environments.GetEnvironment.
| Fields | |
|---|---|
name |
Required. The name of the environment. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
GetFulfillmentRequest
The request message for Fulfillments.GetFulfillment.
| Fields | |
|---|---|
name |
Required. The name of the fulfillment. Supported formats:
Authorization requires the following IAM permission on the specified resource
|
GetGeneratorRequest
Request message of GetGenerator.
| Fields | |
|---|---|
name |
Required. The generator resource name to retrieve. Format: |
GetIntentRequest
The request message for Intents.GetIntent.
| Fields | |
|---|---|
name |
Required. The name of the intent. Supported formats:
Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
intent_ |
Optional. The resource view to apply to the returned intent. |
GetKnowledgeBaseRequest
Request message for KnowledgeBases.GetKnowledgeBase.
| Fields | |
|---|---|
name |
Required. The name of the knowledge base to retrieve. Format Authorization requires the following IAM permission on the specified resource
|
GetParticipantRequest
The request message for Participants.GetParticipant.
| Fields | |
|---|---|
name |
Required. The name of the participant. Format: Authorization requires the following IAM permission on the specified resource
|
GetSessionEntityTypeRequest
The request message for SessionEntityTypes.GetSessionEntityType.
| Fields | |
|---|---|
name |
Required. The name of the session entity type. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
GetSipTrunkRequest
The request message for SipTrunks.GetSipTrunk.
| Fields | |
|---|---|
name |
Required. The name of the SIP trunk to delete. Format: Authorization requires the following IAM permission on the specified resource
|
GetValidationResultRequest
The request message for Agents.GetValidationResult.
| Fields | |
|---|---|
parent |
Required. The project that the agent is associated with. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language for which you want a validation result. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. |
GetVersionRequest
The request message for Versions.GetVersion.
| Fields | |
|---|---|
name |
Required. The name of the version. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
HumanAgentAssistantConfig
Defines the Human Agent Assistant to connect to a conversation.
| Fields | |
|---|---|
notification_ |
Pub/Sub topic on which to publish new agent assistant events. |
human_ |
Configuration for agent assistance of human agent participant. |
end_ |
Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. |
message_ |
Configuration for message analysis. |
ConversationModelConfig
Custom conversation models used in agent assist feature.
Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.
| Fields | |
|---|---|
model |
Conversation model resource name. Format: |
baseline_ |
Version of current baseline model. It will be ignored if |
ConversationProcessConfig
Config to process conversation.
| Fields | |
|---|---|
recent_ |
Number of recent non-small-talk sentences to use as context for article and FAQ suggestion |
MessageAnalysisConfig
Configuration for analyses to run on each conversation message.
| Fields | |
|---|---|
enable_ |
Enable entity extraction in conversation messages on agent assist stage. If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access. |
enable_ |
Enable sentiment analysis in conversation messages on agent assist stage. If unspecified, defaults to false. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral: https://cloud.google.com/natural-language/docs/basics#sentiment_analysis For |
SuggestionConfig
Detail human agent assistant config.
| Fields | |
|---|---|
feature_ |
Configuration of different suggestion features. One feature can have only one config. |
group_ |
If If |
generators[] |
Optional. List of various generator resource names used in the conversation profile. |
disable_ |
Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST |
SuggestionFeatureConfig
Config for suggestion features.
| Fields | |
|---|---|
suggestion_ |
The suggestion feature. |
enable_ |
Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. |
disable_ |
Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. |
enable_ |
Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST |
enable_ |
Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. |
enable_ |
Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST |
suggestion_ |
Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field. |
query_ |
Configs of query. |
conversation_ |
Configs of custom conversation model. |
conversation_ |
Configs for processing conversation. |
SuggestionQueryConfig
Config for suggestion query.
| Fields | |
|---|---|
max_ |
Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. |
confidence_ |
Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. |
context_ |
Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. |
sections |
Optional. The customized sections chosen to return when requesting a summary of a conversation. |
context_ |
Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. |
Union field query_source. Source of query. query_source can be only one of the following: |
|
knowledge_ |
Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ. |
document_ |
Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. |
dialogflow_ |
Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. |
ContextFilterSettings
Settings that determine how to filter recent conversation context when generating suggestions.
| Fields | |
|---|---|
drop_ |
If set to true, the last message from virtual agent (hand off message) and the message before it (trigger message of hand off) are dropped. |
drop_ |
If set to true, all messages from virtual agent are dropped. |
drop_ |
If set to true, all messages from ivr stage are dropped. |
DialogflowQuerySource
Dialogflow source setting.
Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.
| Fields | |
|---|---|
agent |
Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: |
human_ |
The Dialogflow assist configuration for human agent. |
HumanAgentSideConfig
The configuration used for human agent side Dialogflow assist suggestion.
| Fields | |
|---|---|
agent |
Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: |
DocumentQuerySource
Document source settings.
Supported features: SMART_REPLY, SMART_COMPOSE.
| Fields | |
|---|---|
documents[] |
Required. Knowledge documents to query from. Format: |
KnowledgeBaseQuerySource
Knowledge base source settings.
Supported features: ARTICLE_SUGGESTION, FAQ.
| Fields | |
|---|---|
knowledge_ |
Required. Knowledge bases to query. Format: |
Sections
Custom sections to return when requesting a summary of a conversation. This is only supported when baseline_model_version == '2.0'.
Supported features: CONVERSATION_SUMMARIZATION, CONVERSATION_SUMMARIZATION_VOICE.
| Fields | |
|---|---|
section_ |
The selected sections chosen to return when requesting a summary of a conversation. A duplicate selected section will be treated as a single selected section. If section types are not provided, the default will be {SITUATION, ACTION, RESULT}. |
SectionType
Selectable sections to return when requesting a summary of a conversation.
| Enums | |
|---|---|
SECTION_TYPE_UNSPECIFIED |
Undefined section type, does not return anything. |
SITUATION |
What the customer needs help with or has question about. Section name: "situation". |
ACTION |
What the agent does to help the customer. Section name: "action". |
RESOLUTION |
Result of the customer service. A single word describing the result of the conversation. Section name: "resolution". |
REASON_FOR_CANCELLATION |
Reason for cancellation if the customer requests for a cancellation. "N/A" otherwise. Section name: "reason_for_cancellation". |
CUSTOMER_SATISFACTION |
"Unsatisfied" or "Satisfied" depending on the customer's feelings at the end of the conversation. Section name: "customer_satisfaction". |
ENTITIES |
Key entities extracted from the conversation, such as ticket number, order number, dollar amount, etc. Section names are prefixed by "entities/". |
SuggestionTriggerSettings
Settings of suggestion trigger.
| Fields | |
|---|---|
no_ |
Do not trigger if last utterance is small talk. |
only_ |
Only trigger suggestion if participant role of last utterance is END_USER. |
HumanAgentAssistantEvent
Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation.
| Fields | |
|---|---|
conversation |
The conversation this notification refers to. Format: |
participant |
The participant that the suggestion is compiled for. And This field is used to call |
suggestion_ |
The suggestion results payload that this notification refers to. It will only be set when |
HumanAgentHandoffConfig
Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation.
Currently, this feature is not general available, please contact Google to get access.
| Fields | |
|---|---|
Union field agent_service. Required. Specifies which agent service to connect for human agent handoff. agent_service can be only one of the following: |
|
live_ |
Uses LivePerson. |
salesforce_ |
Uses Salesforce Live Agent. |
LivePersonConfig
Configuration specific to LivePerson.
| Fields | |
|---|---|
account_ |
Required. Account number of the LivePerson account to connect. This is the account number you input at the login page. |
SalesforceLiveAgentConfig
Configuration specific to Salesforce Live Agent.
| Fields | |
|---|---|
organization_ |
Required. The organization ID of the Salesforce account. |
deployment_ |
Required. Live Agent deployment ID. |
button_ |
Required. Live Agent chat button ID. |
endpoint_ |
Required. Domain of the Live Agent endpoint for this agent. You can find the endpoint URL in the |
ImportAgentRequest
The request message for Agents.ImportAgent.
| Fields | |
|---|---|
parent |
Required. The project that the agent to import is associated with. Format: Authorization requires the following IAM permission on the specified resource
|
Union field agent. Required. The agent to import. agent can be only one of the following: |
|
agent_ |
The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://". Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control. |
agent_ |
Zip compressed raw byte content for agent. |
ImportDocumentTemplate
The template used for importing documents.
| Fields | |
|---|---|
mime_ |
Required. The MIME type of the document. |
knowledge_ |
Required. The knowledge type of document content. |
metadata |
Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a |
ImportDocumentsRequest
Request message for Documents.ImportDocuments.
| Fields | |
|---|---|
parent |
Required. The knowledge base to import documents into. Format: Authorization requires the following IAM permission on the specified resource
|
document_ |
Required. Document template used for importing all the documents. |
import_ |
Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI. |
Union field If the source captures multiple objects, then multiple documents will be created, one corresponding to each object, and all of these documents will be created using the same document template. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. |
|
gcs_ |
Optional. The Google Cloud Storage location for the documents. The path can include a wildcard. These URIs may have the forms |
ImportDocumentsResponse
Response message for Documents.ImportDocuments.
| Fields | |
|---|---|
warnings[] |
Includes details about skipped documents or any other warnings. |
InferenceParameter
The parameters of inference.
| Fields | |
|---|---|
max_ |
Optional. Maximum number of the output tokens for the generator. |
temperature |
Optional. Controls the randomness of LLM predictions. Low temperature = less random. High temperature = more random. If unset (or 0), uses a default value of 0. |
top_ |
Optional. Top-k changes how the model selects tokens for output. A top-k of 1 means the selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature). For each token selection step, the top K tokens with the highest probabilities are sampled. Then tokens are further filtered based on topP with the final token selected using temperature sampling. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [1, 40], default to 40. |
top_ |
Optional. Top-p changes how the model selects tokens for output. Tokens are selected from most K (see topK parameter) probable to least until the sum of their probabilities equals the top-p value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-p value is 0.5, then the model will select either A or B as the next token (using temperature) and doesn't consider C. The default top-p value is 0.95. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [0.0, 1.0], default to 0.95. |
InitializeEncryptionSpecMetadata
Metadata for initializing a location-level encryption specification.
| Fields | |
|---|---|
request |
Output only. The original request for initialization. |
InitializeEncryptionSpecRequest
The request to initialize a location-level encryption specification.
| Fields | |
|---|---|
encryption_ |
Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. |
InitializeEncryptionSpecResponse
This type has no fields.
The response to initialize a location-level encryption specification.
InputAudioConfig
Instructs the speech recognizer on how to process the audio content.
| Fields | |
|---|---|
audio_ |
Required. Audio encoding of the audio content to process. |
sample_ |
Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details. |
language_ |
Required. The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
enable_ |
If |
phrase_hints[] |
A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details. This field is deprecated. Please use |
speech_ |
Context information to assist speech recognition. See the Cloud Speech documentation for more details. |
model |
Optional. Which Speech model to select for the given request. For more information, see Speech models. |
model_ |
Which variant of the |
single_ |
If |
disable_ |
Only used in |
barge_ |
Configuration of barge-in behavior during the streaming of input audio. |
enable_ |
Enable automatic punctuation option at the speech backend. |
default_ |
If set, use this no-speech timeout when the agent does not provide a no-speech timeout itself. |
phrase_ |
A collection of phrase set resources to use for speech adaptation. |
opt_ |
If |
InputTextConfig
Defines the language used in the input text.
| Fields | |
|---|---|
language_ |
Required. The language of this conversational query. See Language Support for a list of the currently supported language codes. |
Intent
An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.
For more information, see the intent guide.
| Fields | |
|---|---|
name |
Optional. The unique identifier of this intent. Required for
|
display_ |
Required. The name of this intent. |
webhook_ |
Optional. Indicates whether webhooks are enabled for the intent. |
priority |
Optional. The priority of this intent. Higher numbers represent higher priorities.
|
is_ |
Optional. Indicates whether this is a fallback intent. |
ml_enabled |
Optional. Indicates whether Machine Learning is enabled for the intent. Note: If
|
ml_ |
Optional. Indicates whether Machine Learning is disabled for the intent. Note: If |
live_ |
Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false. |
end_ |
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. |
input_ |
Optional. The list of context names required for this intent to be triggered. Formats:
|
events[] |
Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters. |
training_ |
Optional. The collection of examples that the agent is trained on. |
action |
Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. |
output_ |
Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the |
reset_ |
Optional. Indicates whether to delete all contexts in the current session when this intent is matched. |
parameters[] |
Optional. The collection of parameters associated with the intent. |
messages[] |
Optional. The collection of rich messages corresponding to the |
default_ |
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). |
root_ |
Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: |
parent_ |
Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with It identifies the parent followup intent. Format: |
followup_ |
Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. |
FollowupIntentInfo
Represents a single followup intent in the chain.
| Fields | |
|---|---|
followup_ |
The unique identifier of the followup intent. Format: |
parent_ |
The unique identifier of the followup intent's parent. Format: |
Message
Corresponds to the Response field in the Dialogflow console.
| Fields | |
|---|---|
platform |
Optional. The platform that this message is intended for. |
Union field message. Required. The rich response message. message can be only one of the following: |
|
text |
Returns a text response. |
image |
Displays an image. |
quick_ |
Displays quick replies. |
card |
Displays a card. |
payload |
A custom platform-specific response. |
simple_ |
Returns a voice or text-only response for Actions on Google. |
basic_ |
Displays a basic card for Actions on Google. |
suggestions |
Displays suggestion chips for Actions on Google. |
link_ |
Displays a link out suggestion chip for Actions on Google. |
list_ |
Displays a list card for Actions on Google. |
carousel_ |
Displays a carousel card for Actions on Google. |
telephony_ |
Plays audio from a file in Telephony Gateway. |
telephony_ |
Synthesizes speech in Telephony Gateway. |
telephony_ |
Transfers the call in Telephony Gateway. |
rbm_ |
Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging. |
rbm_ |
Standalone Rich Business Messaging (RBM) rich card response. |
rbm_ |
Rich Business Messaging (RBM) carousel rich card response. |
browse_ |
Browse carousel card for Actions on Google. |
table_ |
Table card for Actions on Google. |
media_ |
The media content card for Actions on Google. |
BasicCard
The basic card message. Useful for displaying information.
| Fields | |
|---|---|
title |
Optional. The title of the card. |
subtitle |
Optional. The subtitle of the card. |
formatted_ |
Required, unless image is present. The body text of the card. |
image |
Optional. The image for the card. |
buttons[] |
Optional. The collection of card buttons. |
Button
The button object that appears at the bottom of a card.
| Fields | |
|---|---|
title |
Required. The title of the button. |
open_ |
Required. Action to take when a user taps on the button. |
OpenUriAction
Opens the given URI.
| Fields | |
|---|---|
uri |
Required. The HTTP or HTTPS scheme URI. |
BrowseCarouselCard
Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel
| Fields | |
|---|---|
items[] |
Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten. |
image_ |
Optional. Settings for displaying the image. Applies to every image in |
BrowseCarouselCardItem
Browsing carousel tile
| Fields | |
|---|---|
open_ |
Required. Action to present to the user. |
title |
Required. Title of the carousel item. Maximum of two lines of text. |
description |
Optional. Description of the carousel item. Maximum of four lines of text. |
image |
Optional. Hero image for the carousel item. |
footer |
Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text. |
OpenUrlAction
Actions on Google action to open a given url.
| Fields | |
|---|---|
url |
Required. URL |
url_ |
Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser. |
UrlTypeHint
Type of the URI.
| Enums | |
|---|---|
URL_TYPE_HINT_UNSPECIFIED |
Unspecified |
AMP_ACTION |
Url would be an amp action |
AMP_CONTENT |
URL that points directly to AMP content, or to a canonical URL which refers to AMP content via . |
ImageDisplayOptions
Image display options for Actions on Google. This should be used for when the image's aspect ratio does not match the image container's aspect ratio.
| Enums | |
|---|---|
IMAGE_DISPLAY_OPTIONS_UNSPECIFIED |
Fill the gaps between the image and the image container with gray bars. |
GRAY |
Fill the gaps between the image and the image container with gray bars. |
WHITE |
Fill the gaps between the image and the image container with white bars. |
CROPPED |
Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to "Zoom Mode" on a widescreen TV when playing a 4:3 video. |
BLURRED_BACKGROUND |
Pad the gaps between image and image frame with a blurred copy of the same image. |
Card
The card response message.
| Fields | |
|---|---|
title |
Optional. The title of the card. |
subtitle |
Optional. The subtitle of the card. |
image_ |
Optional. The public URI to an image file for the card. |
buttons[] |
Optional. The collection of card buttons. |
Button
Optional. Contains information about a button.
| Fields | |
|---|---|
text |
Optional. The text to show on the button. |
postback |
Optional. The text to send back to the Dialogflow API or a URI to open. |
CarouselSelect
The card for presenting a carousel of options to select from.
| Fields | |
|---|---|
items[] |
Required. Carousel items. |
Item
An item in the carousel.
| Fields | |
|---|---|
info |
Required. Additional info about the option item. |
title |
Required. Title of the carousel item. |
description |
Optional. The body text of the card. |
image |
Optional. The image to display. |
ColumnProperties
Column properties for TableCard.
| Fields | |
|---|---|
header |
Required. Column heading. |
horizontal_ |
Optional. Defines text alignment for all cells in this column. |
HorizontalAlignment
Text alignments within a cell.
| Enums | |
|---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED |
Text is aligned to the leading edge of the column. |
LEADING |
Text is aligned to the leading edge of the column. |
CENTER |
Text is centered in the column. |
TRAILING |
Text is aligned to the trailing edge of the column. |
Image
The image response message.
| Fields | |
|---|---|
image_ |
Optional. The public URI to an image file. |
accessibility_ |
A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect. |
LinkOutSuggestion
The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
| Fields | |
|---|---|
destination_ |
Required. The name of the app or site this chip is linking to. |
uri |
Required. The URI of the app or site to open when the user taps the suggestion chip. |
ListSelect
The card for presenting a list of options to select from.
| Fields | |
|---|---|
title |
Optional. The overall title of the list. |
items[] |
Required. List items. |
subtitle |
Optional. Subtitle of the list. |
Item
An item in the list.
| Fields | |
|---|---|
info |
Required. Additional information about this option. |
title |
Required. The title of the list item. |
description |
Optional. The main text describing the item. |
image |
Optional. The image to display. |
MediaContent
The media content card for Actions on Google.
| Fields | |
|---|---|
media_ |
Optional. What type of media is the content (ie "audio"). |
media_ |
Required. List of media objects. |
ResponseMediaObject
Response media object for media content card.
| Fields | |
|---|---|
name |
Required. Name of media card. |
description |
Optional. Description of media card. |
content_ |
Required. Url where the media is stored. |
Union field image. Image to show with the media card. image can be only one of the following: |
|
large_ |
Optional. Image to display above media content. |
icon |
Optional. Icon to display above media content. |
ResponseMediaType
Format of response media type.
| Enums | |
|---|---|
RESPONSE_MEDIA_TYPE_UNSPECIFIED |
Unspecified. |
AUDIO |
Response media type is audio. |
Platform
Represents different platforms that a rich message can be intended for.
| Enums | |
|---|---|
PLATFORM_UNSPECIFIED |
Not specified. |
FACEBOOK |
Facebook. |
SLACK |
Slack. |
TELEGRAM |
Telegram. |
KIK |
Kik. |
SKYPE |
Skype. |
LINE |
Line. |
VIBER |
Viber. |
ACTIONS_ON_GOOGLE |
Google Assistant See Dialogflow webhook format |
TELEPHONY |
Telephony Gateway. |
GOOGLE_HANGOUTS |
Google Hangouts. |
QuickReplies
The quick replies response message.
| Fields | |
|---|---|
title |
Optional. The title of the collection of quick replies. |
quick_ |
Optional. The collection of quick replies. |
RbmCardContent
Rich Business Messaging (RBM) Card content
| Fields | |
|---|---|
title |
Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set. |
description |
Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set. |
media |
Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card. |
suggestions[] |
Optional. List of suggestions to include in the card. |
RbmMedia
Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported:
Image Types
- image/jpeg
- image/jpg'
- image/gif
- image/png
Video Types
- video/h263
- video/m4v
- video/mp4
- video/mpeg
- video/mpeg4
- video/webm
| Fields | |
|---|---|
file_ |
Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL. |
thumbnail_ |
Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button. |
height |
Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored. |
Height
Media height
| Enums | |
|---|---|
HEIGHT_UNSPECIFIED |
Not specified. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. Not available for rich card carousels when the card width is set to small. |
RbmCarouselCard
Carousel Rich Business Messaging (RBM) rich card.
Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions.
If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.
| Fields | |
|---|---|
card_ |
Required. The width of the cards in the carousel. |
card_ |
Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10. |
CardWidth
The width of the cards in the carousel.
| Enums | |
|---|---|
CARD_WIDTH_UNSPECIFIED |
Not specified. |
SMALL |
120 DP. Note that tall media cannot be used. |
MEDIUM |
232 DP. |
RbmStandaloneCard
Standalone Rich Business Messaging (RBM) rich card.
Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions.
You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.
| Fields | |
|---|---|
card_ |
Required. Orientation of the card. |
thumbnail_ |
Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout. |
card_ |
Required. Card content. |
CardOrientation
Orientation of the card.
| Enums | |
|---|---|
CARD_ORIENTATION_UNSPECIFIED |
Not specified. |
HORIZONTAL |
Horizontal layout. |
VERTICAL |
Vertical layout. |
ThumbnailImageAlignment
Thumbnail preview alignment for standalone cards with horizontal layout.
| Enums | |
|---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
Not specified. |
LEFT |
Thumbnail preview is left-aligned. |
RIGHT |
Thumbnail preview is right-aligned. |
RbmSuggestedAction
Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card.
| Fields | |
|---|---|
text |
Text to display alongside the action. |
postback_ |
Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic. |
Union field action. Action that needs to be triggered. action can be only one of the following: |
|
dial |
Suggested client side action: Dial a phone number |
open_ |
Suggested client side action: Open a URI on device |
share_ |
Suggested client side action: Share user location |
RbmSuggestedActionDial
Opens the user's default dialer app with the specified phone number but does not dial automatically.
| Fields | |
|---|---|
phone_ |
Required. The phone number to fill in the default dialer app. This field should be in E.164 format. An example of a correctly formatted phone number: +15556767888. |
RbmSuggestedActionOpenUri
Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI.
| Fields | |
|---|---|
uri |
Required. The uri to open on the user device |
RbmSuggestedReply
Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.
| Fields | |
|---|---|
text |
Suggested reply text. |
postback_ |
Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic. |
RbmSuggestion
Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).
| Fields | |
|---|---|
Union field suggestion. Predefined suggested response or action for user to choose suggestion can be only one of the following: |
|
reply |
Predefined replies for user to select instead of typing |
action |
Predefined client side actions that user can choose |
RbmText
Rich Business Messaging (RBM) text response with suggestions.
| Fields | |
|---|---|
text |
Required. Text sent and displayed to the user. |
rbm_ |
Optional. One or more suggestions to show to the user. |
SelectItemInfo
Additional info about the select item for when it is triggered in a dialog.
| Fields | |
|---|---|
key |
Required. A unique key that will be sent back to the agent if this response is given. |
synonyms[] |
Optional. A list of synonyms that can also be used to trigger this item in dialog. |
SimpleResponse
The simple response message containing speech or text.
| Fields | |
|---|---|
text_ |
One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. |
ssml |
One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. |
display_ |
Optional. The text to display. |
SimpleResponses
The collection of simple response candidates. This message in QueryResult.fulfillment_messages and WebhookResponse.fulfillment_messages should contain only one SimpleResponse.
| Fields | |
|---|---|
simple_ |
Required. The list of simple responses. |
Suggestion
The suggestion chip message that the user can tap to quickly post a reply to the conversation.
| Fields | |
|---|---|
title |
Required. The text shown the in the suggestion chip. |
Suggestions
The collection of suggestions.
| Fields | |
|---|---|
suggestions[] |
Required. The list of suggested replies. |
TableCard
Table card for Actions on Google.
| Fields | |
|---|---|
title |
Required. Title of the card. |
subtitle |
Optional. Subtitle to the title. |
image |
Optional. Image which should be displayed on the card. |
column_ |
Optional. Display properties for the columns in this table. |
rows[] |
Optional. Rows in this table of data. |
buttons[] |
Optional. List of buttons for the card. |
TableCardCell
Cell of TableCardRow.
| Fields | |
|---|---|
text |
Required. Text in this cell. |
TableCardRow
Row of TableCard.
| Fields | |
|---|---|
cells[] |
Optional. List of cells that make up this row. |
divider_ |
Optional. Whether to add a visual divider after this row. |
TelephonyPlayAudio
Plays audio from a file in Telephony Gateway.
| Fields | |
|---|---|
audio_ |
Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the For audio from other sources, consider using the |
TelephonySynthesizeSpeech
Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway.
Telephony Gateway takes the synthesizer settings from DetectIntentResponse.output_audio_config which can either be set at request-level or can come from the agent-level synthesizer config.
| Fields | |
|---|---|
Union field source. Required. The source to be synthesized. source can be only one of the following: |
|
text |
The raw text to be synthesized. |
ssml |
The SSML to be synthesized. For more information, see SSML. |
TelephonyTransferCall
Transfers the call in Telephony Gateway.
| Fields | |
|---|---|
phone_ |
Required. The phone number to transfer the call to in E.164 format. We currently only allow transferring to US numbers (+1xxxyyyzzzz). |
Text
The text response message.
| Fields | |
|---|---|
text[] |
Optional. The collection of the agent's responses. |
Parameter
Represents intent parameters.
| Fields | |
|---|---|
name |
The unique identifier of this parameter. |
display_ |
Required. The name of the parameter. |
value |
Optional. The definition of the parameter value. It can be:
|
default_ |
Optional. The default value to use when the |
entity_ |
Optional. The name of the entity type, prefixed with |
mandatory |
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. |
prompts[] |
Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter. |
is_ |
Optional. Indicates whether the parameter represents a list of values. |
TrainingPhrase
Represents an example that the agent is trained on.
| Fields | |
|---|---|
name |
Output only. The unique identifier of this training phrase. |
type |
Required. The type of the training phrase. |
parts[] |
Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:
|
times_ |
Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. |
Part
Represents a part of a training phrase.
| Fields | |
|---|---|
text |
Required. The text for this part. |
entity_ |
Optional. The entity type name prefixed with |
alias |
Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. |
user_ |
Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. |
Type
Represents different types of training phrases.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Not specified. This value should never be used. |
EXAMPLE |
Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types. |
TEMPLATE |
Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Note: Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases in template mode, they will be removed during training and it can cause a drop in agent performance. |
WebhookState
Represents the different states that webhooks can be in.
| Enums | |
|---|---|
WEBHOOK_STATE_UNSPECIFIED |
Webhook is disabled in the agent and in the intent. |
WEBHOOK_STATE_ENABLED |
Webhook is enabled in the agent and in the intent. |
WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING |
Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook. |
IntentBatch
This message is a wrapper around a collection of intents.
| Fields | |
|---|---|
intents[] |
A collection of intents. |
IntentInput
Represents the intent to trigger programmatically rather than as a result of natural language processing. The intent input is only used for V3 agent.
| Fields | |
|---|---|
intent |
Required. The unique identifier of the intent in V3 agent. Format: |
language_ |
Required. The language of this conversational query. See Language Support for a list of the currently supported language codes. |
IntentSuggestion
Represents an intent suggestion.
| Fields | |
|---|---|
display_ |
The display name of the intent. |
description |
Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
Union field intent. The name of the intent. intent can be only one of the following: |
|
intent_ |
The unique identifier of this |
IntentView
Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response by default.
| Enums | |
|---|---|
INTENT_VIEW_UNSPECIFIED |
Training phrases field is not populated in the response. |
INTENT_VIEW_FULL |
All fields are populated. |
KnowledgeAnswers
Represents the result of querying a Knowledge base.
| Fields | |
|---|---|
answers[] |
A list of answers from Knowledge Connector. |
Answer
An answer from Knowledge Connector.
| Fields | |
|---|---|
source |
Indicates which Knowledge Document this answer was extracted from. Format: |
faq_ |
The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise. |
answer |
The piece of text from the |
match_ |
The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given |
match_ |
The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using |
MatchConfidenceLevel
Represents the system's confidence that this knowledge answer is a good match for this conversational query.
| Enums | |
|---|---|
MATCH_CONFIDENCE_LEVEL_UNSPECIFIED |
Not specified. |
LOW |
Indicates that the confidence is low. |
MEDIUM |
Indicates our confidence is medium. |
HIGH |
Indicates our confidence is high. |
KnowledgeAssistAnswer
Represents a Knowledge Assist answer.
| Fields | |
|---|---|
suggested_ |
The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. |
suggested_ |
The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. |
answer_ |
The name of the answer record. Format: |
KnowledgeAnswer
Represents an answer from Knowledge. Currently supports FAQ and Generative answers.
| Fields | |
|---|---|
answer_ |
The piece of text from the |
Union field source. Source of result. source can be only one of the following: |
|
faq_ |
Populated if the prediction came from FAQ. |
generative_ |
Populated if the prediction was Generative. |
FaqSource
Details about source of FAQ answer.
| Fields | |
|---|---|
question |
The corresponding FAQ question. |
GenerativeSource
Details about source of Generative answer.
| Fields | |
|---|---|
snippets[] |
All snippets used for this Generative Prediction, with their source URI and data. |
Snippet
Snippet Source for a Generative Prediction.
| Fields | |
|---|---|
uri |
URI the data is sourced from. |
text |
Text taken from that URI. |
title |
Title of the document. |
metadata |
Metadata of the document. |
SuggestedQuery
Represents a suggested query.
| Fields | |
|---|---|
query_ |
Suggested query text. |
KnowledgeBase
A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input.
For more information, see the knowledge base guide.
Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.
| Fields | |
|---|---|
name |
The knowledge base resource name. The name must be empty when creating a knowledge base. Format: |
display_ |
Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails. |
language_ |
Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, this is populated for all non en-us languages. If not populated, the default language en-us applies. |
KnowledgeOperationMetadata
Metadata in google::longrunning::Operation for Knowledge operations.
| Fields | |
|---|---|
state |
Required. Output only. The current state of this operation. |
knowledge_ |
The name of the knowledge base interacted with during the operation. |
Union field operation_metadata. Additional metadata for the Knowledge operation. operation_metadata can be only one of the following: |
|
export_ |
Metadata for the Export Data Operation such as the destination of export. |
State
States of the operation.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
State unspecified. |
PENDING |
The operation has been created. |
RUNNING |
The operation is currently running. |
DONE |
The operation is done, either cancelled or completed. |
ListAnswerRecordsRequest
Request message for AnswerRecords.ListAnswerRecords.
| Fields | |
|---|---|
parent |
Required. The project to list all answer records for in reverse chronological order. Format: Authorization requires the following IAM permission on the specified resource
|
filter |
Optional. Filters to restrict results to specific answer records. For more information about filtering, see API Filtering. |
page_ |
Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100. |
page_ |
Optional. The |
ListAnswerRecordsResponse
Response message for AnswerRecords.ListAnswerRecords.
| Fields | |
|---|---|
answer_ |
The list of answer records. |
next_ |
A token to retrieve next page of results. Or empty if there are no more results. Pass this value in the |
ListContextsRequest
The request message for Contexts.ListContexts.
| Fields | |
|---|---|
parent |
Required. The session to list all contexts from. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListContextsResponse
The response message for Contexts.ListContexts.
| Fields | |
|---|---|
contexts[] |
The list of contexts. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListConversationProfilesRequest
The request message for ConversationProfiles.ListConversationProfiles.
| Fields | |
|---|---|
parent |
Required. The project to list all conversation profiles from. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
The next_page_token value returned from a previous list request. |
ListConversationProfilesResponse
The response message for ConversationProfiles.ListConversationProfiles.
| Fields | |
|---|---|
conversation_ |
The list of project conversation profiles. There is a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListConversationsRequest
The request message for Conversations.ListConversations.
| Fields | |
|---|---|
parent |
Required. The project from which to list all conversation. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
filter |
Optional. A filter expression that filters conversations listed in the response. Only
For more information about filtering, see API Filtering. |
ListConversationsResponse
The response message for Conversations.ListConversations.
| Fields | |
|---|---|
conversations[] |
The list of conversations. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListDocumentsRequest
Request message for Documents.ListDocuments.
| Fields | |
|---|---|
parent |
Required. The knowledge base to list all documents for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 10 and at most 100. |
page_ |
The next_page_token value returned from a previous list request. |
filter |
The filter expression used to filter documents returned by the list method. The expression has the following syntax: The following fields and operators are supported:
Examples:
For more information about filtering, see API Filtering. |
ListDocumentsResponse
Response message for Documents.ListDocuments.
| Fields | |
|---|---|
documents[] |
The list of documents. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListEntityTypesRequest
The request message for EntityTypes.ListEntityTypes.
| Fields | |
|---|---|
parent |
Required. The agent to list all entity types from. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListEntityTypesResponse
The response message for EntityTypes.ListEntityTypes.
| Fields | |
|---|---|
entity_ |
The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListEnvironmentsRequest
The request message for Environments.ListEnvironments.
| Fields | |
|---|---|
parent |
Required. The agent to list all environments from. Format: - Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListEnvironmentsResponse
The response message for Environments.ListEnvironments.
| Fields | |
|---|---|
environments[] |
The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListGeneratorsRequest
Request message of ListGenerators.
| Fields | |
|---|---|
parent |
Required. The project/location to list generators for. Format: |
page_ |
Optional. Maximum number of conversation models to return in a single page. Default to 10. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListGeneratorsResponse
Response of ListGenerators.
| Fields | |
|---|---|
generators[] |
List of generators retrieved. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListIntentsRequest
The request message for Intents.ListIntents.
| Fields | |
|---|---|
parent |
Required. The agent to list all intents from. Format: Alternatively, you can specify the environment to list intents for. Format: Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
intent_ |
Optional. The resource view to apply to the returned intent. |
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListIntentsResponse
The response message for Intents.ListIntents.
| Fields | |
|---|---|
intents[] |
The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListKnowledgeBasesRequest
Request message for KnowledgeBases.ListKnowledgeBases.
| Fields | |
|---|---|
parent |
Required. The project to list of knowledge bases for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
The maximum number of items to return in a single page. By default 10 and at most 100. |
page_ |
The next_page_token value returned from a previous list request. |
filter |
The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: The following fields and operators are supported:
Examples:
Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering. |
ListKnowledgeBasesResponse
Response message for KnowledgeBases.ListKnowledgeBases.
| Fields | |
|---|---|
knowledge_ |
The list of knowledge bases. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListMessagesRequest
The request message for Conversations.ListMessages.
| Fields | |
|---|---|
parent |
Required. The name of the conversation to list messages for. Format: Authorization requires the following IAM permission on the specified resource
|
filter |
Optional. Filter on message fields. Currently predicates on For more information about filtering, see API Filtering. |
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListMessagesResponse
The response message for Conversations.ListMessages.
| Fields | |
|---|---|
messages[] |
Required. The list of messages. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Optional. Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListParticipantsRequest
The request message for Participants.ListParticipants.
| Fields | |
|---|---|
parent |
Required. The conversation to list all participants from. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListParticipantsResponse
The response message for Participants.ListParticipants.
| Fields | |
|---|---|
participants[] |
The list of participants. There is a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results or empty if there are no more results in the list. |
ListSessionEntityTypesRequest
The request message for SessionEntityTypes.ListSessionEntityTypes.
| Fields | |
|---|---|
parent |
Required. The session to list all session entity types from. Supported formats: - If Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListSessionEntityTypesResponse
The response message for SessionEntityTypes.ListSessionEntityTypes.
| Fields | |
|---|---|
session_ |
The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListSipTrunksRequest
The request message for SipTrunks.ListSipTrunks.
| Fields | |
|---|---|
parent |
Required. The location to list SIP trunks from. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListSipTrunksResponse
The response message for SipTrunks.ListSipTrunks.
| Fields | |
|---|---|
sip_ |
The list of SIP trunks. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
ListSuggestionsRequest
The request message for Participants.ListSuggestions.
| Fields | |
|---|---|
parent |
Required. The name of the participant to fetch suggestions for. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. The default value is 100; the maximum value is 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
filter |
Optional. Filter on suggestions fields. Currently predicates on For more information about filtering, see API Filtering. |
ListSuggestionsResponse
The response message for Participants.ListSuggestions.
| Fields | |
|---|---|
suggestions[] |
Required. The list of suggestions. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Optional. Token to retrieve the next page of results or empty if there are no more results in the list. |
ListVersionsRequest
The request message for Versions.ListVersions.
| Fields | |
|---|---|
parent |
Required. The agent to list all versions from. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
ListVersionsResponse
The response message for Versions.ListVersions.
| Fields | |
|---|---|
versions[] |
The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
LoggingConfig
Defines logging behavior for conversation lifecycle events.
| Fields | |
|---|---|
enable_ |
Whether to log conversation events like |
Message
Represents a message posted into a conversation.
| Fields | |
|---|---|
name |
Optional. The unique identifier of the message. Format: |
content |
Required. The message content. |
response_ |
Optional. Automated agent responses. |
language_ |
Optional. The message language. This should be a BCP-47 language tag. Example: "en-US". |
participant |
Output only. The participant that sends this message. |
participant_ |
Output only. The role of the participant. |
create_ |
Output only. The time when the message was created in Contact Center AI. |
send_ |
Optional. The time when the message was sent. |
message_ |
Output only. The annotation for the message. |
sentiment_ |
Output only. The sentiment analysis result for the message. |
MessageAnnotation
Represents the result of annotation for the message.
| Fields | |
|---|---|
parts[] |
Optional. The collection of annotated message parts ordered by their position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text]. |
contain_ |
Required. Indicates whether the text message contains entities. |
MessageEntry
Represents a message entry of a conversation.
| Fields | |
|---|---|
role |
Optional. Participant role of the message. |
text |
Optional. Transcript content of the message. |
language_ |
Optional. The language of the text. See Language Support for a list of the currently supported language codes. |
create_ |
Optional. Create time of the message entry. |
Role
Enumeration of the roles a participant can play in a conversation.
| Enums | |
|---|---|
ROLE_UNSPECIFIED |
Participant role not set. |
HUMAN_AGENT |
Participant is a human agent. |
AUTOMATED_AGENT |
Participant is an automated agent, such as a Dialogflow agent. |
END_USER |
Participant is an end user that has called or chatted with Dialogflow services. |
NotificationConfig
Defines notification behavior.
| Fields | |
|---|---|
topic |
Name of the Pub/Sub topic to publish conversation events like For telephony integration to receive notification, make sure either this topic is in the same project as the conversation or you grant For chat integration to receive notification, make sure API caller has been granted the Format: |
message_ |
Format of message. |
MessageFormat
Format of cloud pub/sub message.
| Enums | |
|---|---|
MESSAGE_FORMAT_UNSPECIFIED |
If it is unspecified, PROTO will be used. |
PROTO |
Pub/Sub message will be serialized proto. |
JSON |
Pub/Sub message will be json. |
OriginalDetectIntentRequest
Represents the contents of the original request that was passed to the [Streaming]DetectIntent call.
| Fields | |
|---|---|
source |
The source of this request, e.g., |
version |
Optional. The version of the protocol used for this request. This field is AoG-specific. |
payload |
Optional. This field is set to the value of the In particular, for the Dialogflow Phone Gateway integration, this field has the form: {
"telephony": {
"caller_id": "+18558363987"
}
}Note: The caller ID field ( |
OutputAudio
Represents the natural language speech audio to be played to the end user.
| Fields | |
|---|---|
config |
Required. Instructs the speech synthesizer how to generate the speech audio. |
audio |
Required. The natural language speech audio. |
OutputAudioConfig
Instructs the speech synthesizer how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.
| Fields | |
|---|---|
audio_ |
Required. Audio encoding of the synthesized audio content. |
sample_ |
The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
synthesize_ |
Configuration of how speech should be synthesized. |
OutputAudioEncoding
Audio encoding of the output audio format in Text-To-Speech.
| Enums | |
|---|---|
OUTPUT_AUDIO_ENCODING_UNSPECIFIED |
Not specified. |
OUTPUT_AUDIO_ENCODING_LINEAR_16 |
Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. |
OUTPUT_AUDIO_ENCODING_MP3 |
MP3 audio at 32kbps. |
OUTPUT_AUDIO_ENCODING_MP3_64_KBPS |
MP3 audio at 64kbps. |
OUTPUT_AUDIO_ENCODING_OGG_OPUS |
Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate. |
OUTPUT_AUDIO_ENCODING_MULAW |
8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
OUTPUT_AUDIO_ENCODING_ALAW |
8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law. |
Participant
Represents a conversation participant (human agent, virtual agent, end-user).
| Fields | |
|---|---|
name |
Optional. The unique identifier of this participant. Format: |
role |
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. |
obfuscated_ |
Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows:
Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note:
|
documents_ |
Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their |
Role
Enumeration of the roles a participant can play in a conversation.
| Enums | |
|---|---|
ROLE_UNSPECIFIED |
Participant role not set. |
HUMAN_AGENT |
Participant is a human agent. |
AUTOMATED_AGENT |
Participant is an automated agent, such as a Dialogflow agent. |
END_USER |
Participant is an end user that has called or chatted with Dialogflow services. |
QueryInput
Represents the query input. It can contain either:
An audio config which instructs the speech recognizer how to process the speech audio.
A conversational query in the form of text.
An event that specifies which intent to trigger.
| Fields | |
|---|---|
Union field input. Required. The input specification. input can be only one of the following: |
|
audio_ |
Instructs the speech recognizer how to process the speech audio. |
text |
The natural language text to be processed. |
event |
The event to be processed. |
dtmf |
The DTMF digits used to invoke intent and fill in parameter value. |
QueryParameters
Represents the parameters of the conversational query.
| Fields | |
|---|---|
time_ |
The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used. |
geo_ |
The geo location of this conversational query. |
contexts[] |
The collection of contexts to be activated before this query is executed. |
reset_ |
Specifies whether to delete all contexts in the current session before the new ones are activated. |
session_ |
Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. |
payload |
This field can be used to pass custom data to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the |
knowledge_ |
KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: |
sentiment_ |
Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Essentials Edition agents. |
sub_ |
For mega agent query, directly specify which sub agents to query. If any specified sub agent is not linked to the mega agent, an error will be returned. If empty, Dialogflow will decide which sub agents to query. If specified for a non-mega-agent query, will be silently ignored. |
webhook_ |
This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc. |
platform |
The platform of the virtual agent response messages. If not empty, only emits messages from this platform in the response. Valid values are the enum names of |
QueryResult
Represents the result of conversational query or event processing.
| Fields | |
|---|---|
query_ |
The original conversational query text:
|
language_ |
The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes. |
speech_ |
The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. |
action |
The action name from the matched intent. |
parameters |
The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
|
all_ |
This field is set to:
|
cancels_ |
Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation. |
fulfillment_ |
The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, |
fulfillment_ |
The collection of rich messages to present to the user. |
webhook_ |
If the query was fulfilled by a webhook call, this field is set to the value of the |
webhook_ |
If the query was fulfilled by a webhook call, this field is set to the value of the |
output_ |
The collection of output contexts. If applicable, |
intent |
The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: |
intent_ |
The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are |
diagnostic_ |
Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain:
|
sentiment_ |
The sentiment analysis result, which depends on the |
knowledge_ |
The result from Knowledge Connector (if any), ordered by decreasing |
ReloadDocumentRequest
Request message for Documents.ReloadDocument.
| Fields | |
|---|---|
name |
Required. The name of the document to reload. Format: |
import_ |
Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI. |
Union field Optional. If provided, the service will load the contents from the source and update document in the knowledge base. Reloading from a new document source is allowed for smart messaging documents only. If you want to update the source for other document types, please delete the existing document and create a new one instead. |
|
gcs_ |
The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
ResponseMessage
Response messages from an automated agent.
| Fields | |
|---|---|
Union field message. Required. The rich response message. message can be only one of the following: |
|
text |
Returns a text response. |
payload |
Returns a response containing a custom, platform-specific payload. |
live_ |
Hands off conversation to a live agent. |
end_ |
A signal that indicates the interaction with the Dialogflow agent has ended. |
mixed_ |
An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. |
telephony_ |
A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
EndInteraction
This type has no fields.
Indicates that interaction with the Dialogflow agent has ended.
LiveAgentHandoff
Indicates that the conversation should be handed off to a human agent.
Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.
You may set this, for example:
- In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation.
- In a webhook response when you determine that the customer issue can only be handled by a human.
| Fields | |
|---|---|
metadata |
Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
MixedAudio
Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.
| Fields | |
|---|---|
segments[] |
Segments this audio response is composed of. |
Segment
Represents one segment of audio.
| Fields | |
|---|---|
allow_ |
Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
Union field content. Content of the segment. content can be only one of the following: |
|
audio |
Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
uri |
Client-specific URI that points to an audio clip accessible to the client. |
TelephonyTransferCall
Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
| Fields | |
|---|---|
Union field endpoint. Endpoint to transfer the call to. endpoint can be only one of the following: |
|
phone_ |
Transfer the call to a phone number in E.164 format. |
sip_ |
Transfer the call to a SIP endpoint. |
Text
The text response message.
| Fields | |
|---|---|
text[] |
A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. |
RestoreAgentRequest
The request message for Agents.RestoreAgent.
| Fields | |
|---|---|
parent |
Required. The project that the agent to restore is associated with. Format: Authorization requires the following IAM permission on the specified resource
|
Union field agent. Required. The agent to restore. agent can be only one of the following: |
|
agent_ |
The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://". Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control. |
agent_ |
Zip compressed raw byte content for agent. |
SearchAgentsRequest
The request message for Agents.SearchAgents.
| Fields | |
|---|---|
parent |
Required. The project to list agents from. Format: Authorization requires the following IAM permission on the specified resource
|
page_ |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
page_ |
Optional. The next_page_token value returned from a previous list request. |
SearchAgentsResponse
The response message for Agents.SearchAgents.
| Fields | |
|---|---|
agents[] |
The list of agents. There will be a maximum number of items returned based on the page_size field in the request. |
next_ |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
SearchKnowledgeAnswer
Represents a SearchKnowledge answer.
| Fields | |
|---|---|
answer |
The piece of text from the knowledge base documents that answers the search query |
answer_ |
The type of the answer. |
answer_ |
All sources used to generate the answer. |
answer_ |
The name of the answer record. Format: |
AnswerSource
The sources of the answers.
| Fields | |
|---|---|
title |
The title of the article. |
uri |
The URI of the article. |
snippet |
The relevant snippet of the article. |
metadata |
Metadata associated with the article. |
AnswerType
The type of the answer.
| Enums | |
|---|---|
ANSWER_TYPE_UNSPECIFIED |
The answer has a unspecified type. |
FAQ |
The answer is from FAQ documents. |
GENERATIVE |
The answer is from generative model. |
INTENT |
The answer is from intent matching. |
SearchKnowledgeRequest
The request message for Conversations.SearchKnowledge.
| Fields | |
|---|---|
parent |
Required. The parent resource contains the conversation profile Format: 'projects/ |
query |
Required. The natural language text query for knowledge search. |
conversation_ |
Required. The conversation profile used to configure the search. Format: |
session_ |
Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate |
conversation |
Optional. The conversation (between human agent and end user) where the search request is triggered. Format: |
latest_ |
Optional. The name of the latest conversation message when the request is triggered. Format: |
query_ |
Optional. The source of the query in the request. |
end_ |
Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: |
search_ |
Optional. Configuration specific to search queries with data stores. |
exact_ |
Optional. Whether to search the query exactly without query rewrite. |
QuerySource
The source of the query. We use QuerySource to distinguish queries directly entered by agents and suggested queries from Participants.SuggestKnowledgeAssist. If SUGGESTED_QUERY source is specified, we will treat it as a continuation of a SuggestKnowledgeAssist call.
| Enums | |
|---|---|
QUERY_SOURCE_UNSPECIFIED |
Unknown query source. |
AGENT_QUERY |
The query is from agents. |
SUGGESTED_QUERY |
The query is a suggested query from Participants.SuggestKnowledgeAssist. |
SearchConfig
Configuration specific to search queries with data stores.
| Fields | |
|---|---|
boost_ |
Optional. Boost specifications for data stores. |
filter_ |
Optional. Filter specification for data store queries. |
BoostSpecs
Boost specifications for data stores.
| Fields | |
|---|---|
data_ |
Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: |
spec[] |
Optional. A list of boosting specifications. |
BoostSpec
Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
| Fields | |
|---|---|
condition_ |
Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. |
ConditionBoostSpec
Boost applies to documents which match a condition.
| Fields | |
|---|---|
condition |
Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples:
|
boost |
Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
boost_ |
Optional. Complex specification for custom ranking based on customer defined attribute value. |
BoostControlSpec
Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
| Fields | |
|---|---|
field_ |
Optional. The name of the field whose value will be used to determine the boost amount. |
attribute_ |
Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). |
interpolation_ |
Optional. The interpolation type to be applied to connect the control points listed below. |
control_ |
Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. |
AttributeType
The attribute(or function) for which the custom ranking is to be applied.
| Enums | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
Unspecified AttributeType. |
NUMERICAL |
The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. |
FRESHNESS |
For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD][T[nH][nM][nS]]. E.g. 5D, 3DT12H30M, T24H. |
ControlPoint
The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
| Fields | |
|---|---|
attribute_ |
Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD |
boost_ |
Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. |
InterpolationType
The interpolation type to be applied. Default will be linear (Piecewise Linear).
| Enums | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
Interpolation type is unspecified. In this case, it defaults to Linear. |
LINEAR |
Piecewise linear interpolation will be applied. |
FilterSpecs
Filter specification for data store queries.
| Fields | |
|---|---|
data_ |
Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. |
filter |
Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax |
SearchKnowledgeResponse
The response message for Conversations.SearchKnowledge.
| Fields | |
|---|---|
answers[] |
Most relevant snippets extracted from articles in the given knowledge base, ordered by confidence. |
rewritten_ |
The rewritten query used to search knowledge. |
Sentiment
The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.
| Fields | |
|---|---|
score |
Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). |
magnitude |
A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). |
SentimentAnalysisRequestConfig
Configures the types of sentiment analysis to perform.
| Fields | |
|---|---|
analyze_ |
Instructs the service to perform sentiment analysis on |
SentimentAnalysisResult
The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For [Participants.DetectIntent][], it needs to be configured in DetectIntentRequest.query_params. For [Participants.StreamingDetectIntent][], it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config
| Fields | |
|---|---|
query_ |
The sentiment analysis result for |
SessionEntityType
A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.
For more information, see the session entity guide.
| Fields | |
|---|---|
name |
Required. The unique identifier of this session entity type. Supported formats: - If |
entity_ |
Required. Indicates whether the additional data should override or supplement the custom entity type definition. |
entities[] |
Required. The collection of entities associated with this session entity type. |
EntityOverrideMode
The types of modifications for a session entity type.
| Enums | |
|---|---|
ENTITY_OVERRIDE_MODE_UNSPECIFIED |
Not specified. This value should be never used. |
ENTITY_OVERRIDE_MODE_OVERRIDE |
The collection of session entities overrides the collection of entities in the corresponding custom entity type. |
ENTITY_OVERRIDE_MODE_SUPPLEMENT |
The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to |
SetAgentRequest
The request message for Agents.SetAgent.
| Fields | |
|---|---|
agent |
Required. The agent to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Optional. The mask to control which fields get updated. |
SetSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] operation.
| Fields | |
|---|---|
conversation_ |
The resource name of the conversation profile. Format: |
participant_ |
Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used. |
suggestion_ |
Required. The type of the suggestion feature to add or update. |
create_ |
Timestamp whe the request was created. The time is measured on server side. |
SetSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.SetSuggestionFeature][].
| Fields | |
|---|---|
conversation_ |
Required. The Conversation Profile to add or update the suggestion feature config. Format: |
participant_ |
Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used. |
suggestion_ |
Required. The suggestion feature config to add or update. |
SipTrunk
SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service.
| Fields | |
|---|---|
name |
Identifier. The unique identifier of the SIP trunk. Format: |
expected_ |
Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. |
connections[] |
Output only. Connections of the SIP trunk. |
display_ |
Optional. Human readable alias for this trunk. |
SmartReplyAnswer
Represents a smart reply answer.
| Fields | |
|---|---|
reply |
The content of the reply. |
confidence |
Smart reply confidence. The system's confidence score that this reply is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain). |
answer_ |
The name of answer record, in the format of "projects/ |
SpeechContext
Hints for the speech recognizer to help with recognition in a specific conversation state.
| Fields | |
|---|---|
phrases[] |
Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. This list can be used to:
See the Cloud Speech documentation for usage limits. |
boost |
Optional. Boost for this context compared to other contexts:
Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search. |
SpeechModelVariant
Variant of the specified Speech model to use.
See the Cloud Speech documentation for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.
| Enums | |
|---|---|
SPEECH_MODEL_VARIANT_UNSPECIFIED |
No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
USE_BEST_AVAILABLE |
Use the best available variant of the [Speech model][InputAudioConfig.model] that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
USE_STANDARD |
Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
USE_ENHANCED |
Use an enhanced model variant:
The Cloud Speech documentation describes which models have enhanced variants.
|
SpeechToTextConfig
Configures speech transcription for ConversationProfile.
| Fields | |
|---|---|
speech_ |
The speech model used in speech to text. |
model |
Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:
Leave this field unspecified to use Agent Speech settings for model selection. |
phrase_ |
List of names of Cloud Speech phrase sets that are used for transcription. |
audio_ |
Audio encoding of the audio content to process. |
sample_ |
Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details. |
language_ |
The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
enable_ |
If |
use_ |
Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. |
SpeechWordInfo
Information for a word recognized by the speech recognizer.
| Fields | |
|---|---|
word |
The word this info is for. |
start_ |
Time offset relative to the beginning of the audio that corresponds to the start of the spoken word. This is an experimental feature and the accuracy of the time offset can vary. |
end_ |
Time offset relative to the beginning of the audio that corresponds to the end of the spoken word. This is an experimental feature and the accuracy of the time offset can vary. |
confidence |
The Speech confidence between 0.0 and 1.0 for this word. A higher number indicates an estimated greater likelihood that the recognized word is correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be fully stable over time for the same audio input. Users should also not rely on it to always be provided. |
SsmlVoiceGender
Gender of the voice as described in SSML voice element.
| Enums | |
|---|---|
SSML_VOICE_GENDER_UNSPECIFIED |
An unspecified gender, which means that the client doesn't care which gender the selected voice will have. |
SSML_VOICE_GENDER_MALE |
A male voice. |
SSML_VOICE_GENDER_FEMALE |
A female voice. |
SSML_VOICE_GENDER_NEUTRAL |
A gender-neutral voice. |
StreamingAnalyzeContentRequest
The top-level message sent by the client to the Participants.StreamingAnalyzeContent method.
Multiple request messages should be sent in order:
The first message must contain
participant, [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] and optionallyquery_params. If you want to receive an audio response, it should also containreply_audio_config. The message must not contain [input][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input].If [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to
audio_config, all subsequent messages must containinput_audioto continue with Speech recognition. If you decide to rather analyze text input after you already started Speech recognition, please send a message withStreamingAnalyzeContentRequest.input_text.
However, note that:
* Dialogflow will bill you for the audio so far.
* Dialogflow discards all Speech recognition results in favor of the
text input.
- If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to
StreamingAnalyzeContentRequest.text_config, then the second message must contain onlyinput_text. Moreover, you must not send more than two messages.
After you sent all input, you must half-close or abort the request stream.
| Fields | |
|---|---|
participant |
Required. The name of the participant this text comes from. Format: Authorization requires the following IAM permission on the specified resource
|
reply_ |
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 StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled. |
query_ |
Parameters for a Dialogflow virtual-agent query. |
assist_ |
Parameters for a human assist query. |
cx_ |
Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Note: this field should only be used if you are connecting to a Dialogflow CX agent. |
cx_ |
The unique identifier of the CX page to override the If Note: this field should only be used if you are connecting to a Dialogflow CX agent. |
enable_ |
Optional. Enable full bidirectional streaming. You can keep streaming the audio until timeout, and there's no need to half close the stream to get the response. Restrictions:
InvalidArgument Error will be returned if the one of restriction checks failed. You can find more details in https://cloud.google.com/agent-assist/docs/extended-streaming |
enable_ |
Enable partial virtual agent responses. If this flag is not enabled, response stream still contains only one final response even if some |
enable_ |
if true, |
Union field config. Required. The input config. config can be only one of the following: |
|
audio_ |
Instructs the speech recognizer how to process the speech audio. |
text_ |
The natural language text to be processed. |
Union field input. Required. The input. input can be only one of the following: |
|
input_ |
The input audio content to be recognized. Must be sent if |
input_ |
The UTF-8 encoded natural language text to be processed. Must be sent if |
input_ |
The DTMF digits used to invoke intent and fill in parameter value. This input is ignored if the previous response indicated that DTMF input is not accepted. |
input_ |
The intent to be triggered on V3 agent. Format: |
input_ |
The input event name. This can only be sent once and would cancel the ongoing speech recognition if any. |
StreamingAnalyzeContentResponse
The top-level message returned from the StreamingAnalyzeContent method.
Multiple response messages can be returned in order:
If the input was set to streaming audio, the first one or more messages contain
recognition_result. Eachrecognition_resultrepresents a more complete transcript of what the user said. The lastrecognition_resulthasis_finalset totrue.In virtual agent stage: if
enable_partial_automated_agent_replyis true, the following N (currently 1 <= N <= 4) messages containautomated_agent_replyand optionallyreply_audioreturned by the virtual agent. The first (N-1)automated_agent_replys will haveautomated_agent_reply_typeset toPARTIAL. The lastautomated_agent_replyhasautomated_agent_reply_typeset toFINAL. Ifenable_partial_automated_agent_replyis not enabled, response stream only contains the final reply.
In human assist stage: the following N (N >= 1) messages contain
`human_agent_suggestion_results`, `end_user_suggestion_results` or
`message`.
| Fields | |
|---|---|
recognition_ |
The result of speech recognition. |
reply_ |
Optional. The output text content. This field is set if an automated agent responded with a text for the user. |
reply_ |
Optional. The audio data bytes encoded as specified in the request. This field is set if:
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_ |
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 |
message |
Output only. Message analyzed by CCAI. |
human_ |
The suggestions for most recent human agent. The order is the same as |
end_ |
The suggestions for end user. The order is the same as |
dtmf_ |
Indicates the parameters of DTMF. |
debugging_ |
Debugging info that would get populated when |
StreamingDetectIntentRequest
The top-level message sent by the client to the Sessions.StreamingDetectIntent method.
Multiple request messages should be sent in order:
- The first message must contain
session,query_inputplus optionallyquery_params. If the client wants to receive an audio response, it should also containoutput_audio_config. The message must not containinput_audio. - If
query_inputwas set toquery_input.audio_config, all subsequent messages must containinput_audioto continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message withquery_input.text.
However, note that:
* Dialogflow will bill you for the audio duration so far.
* Dialogflow discards all Speech recognition results in favor of the
input text.
* Dialogflow will use the language code from the first message.
After you sent all input, you must half-close or abort the request stream.
| Fields | |
|---|---|
session |
Required. The name of the session the query is sent to. Supported formats: - If For more information, see the API interactions guide. Note: Always use agent versions for production traffic. See Versions and environments. Authorization requires the following IAM permission on the specified resource
|
query_ |
The parameters of this query. |
query_ |
Required. The input specification. It can be set to:
|
single_utterance |
DEPRECATED. Please use |
output_ |
Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated. |
output_ |
Mask for If unspecified or empty, |
input_ |
The input audio content to be recognized. Must be sent if |
enable_ |
If true, |
StreamingDetectIntentResponse
The top-level message returned from the StreamingDetectIntent method.
Multiple response messages can be returned in order:
If the
StreamingDetectIntentRequest.input_audiofield was set, therecognition_resultfield is populated for one or more messages. See theStreamingRecognitionResultmessage for details about the result message sequence.The next message contains
response_id,query_result,alternative_query_resultsand optionallywebhook_statusif a WebHook was called.If
output_audio_configwas specified in the request or agent-level speech synthesizer is configured, all subsequent messages containoutput_audioandoutput_audio_config.
| Fields | |
|---|---|
response_ |
The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. |
recognition_ |
The result of speech recognition. |
query_ |
The selected results of the conversational query or event processing. See |
alternative_ |
If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing |
webhook_ |
Specifies the status of the webhook request. |
output_ |
The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the 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. |
output_ |
The config used by the speech synthesizer to generate the output audio. |
debugging_ |
Debugging info that would get populated when |
StreamingRecognitionResult
Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.
While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript.
If StreamingDetectIntentRequest.query_input.audio_config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to `END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript.
The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.
In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.
Num | transcript | message_type | is_final
--- | ----------------------- | ----------------------- | --------
1 | "tube" | TRANSCRIPT | false
2 | "to be a" | TRANSCRIPT | false
3 | "to be" | TRANSCRIPT | false
4 | "to be or not to be" | TRANSCRIPT | true
5 | "that's" | TRANSCRIPT | false
6 | "that is | TRANSCRIPT | false
7 | unset | END_OF_SINGLE_UTTERANCE | unset
8 | " that is the question" | TRANSCRIPT | true
Concatenating the finalized transcripts with is_final set to true, the complete utterance becomes "to be or not to be that is the question".
| Fields | |
|---|---|
message_ |
Type of the result message. |
transcript |
Transcript text representing the words that the user spoke. Populated if and only if |
is_ |
If |
confidence |
The Speech confidence between 0.0 and 1.0 for the current portion of audio. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is typically only provided if |
stability |
An estimate of the likelihood that the speech recognizer will not change its guess about this interim recognition result:
|
speech_ |
Word-specific information for the words recognized by Speech in |
speech_ |
Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for |
language_ |
Detected language code for the transcript. |
dtmf_ |
DTMF digits. Populated if and only if |
MessageType
Type of the response message.
| Enums | |
|---|---|
MESSAGE_TYPE_UNSPECIFIED |
Not specified. Should never be used. |
TRANSCRIPT |
Message contains a (possibly partial) transcript. |
DTMF_DIGITS |
Message contains DTMF digits. |
END_OF_SINGLE_UTTERANCE |
This event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if single_utterance was set to true, and is not used otherwise. |
PARTIAL_DTMF_DIGITS |
Message contains DTMF digits. Before a message with DTMF_DIGITS is sent, a message with PARTIAL_DTMF_DIGITS may be sent with DTMF digits collected up to the time of sending, which represents an intermediate result. |
SubAgent
Contains basic configuration for a sub-agent.
| Fields | |
|---|---|
project |
Required. The project of this agent. Format: |
environment |
Optional. The unique identifier ( |
SuggestArticlesRequest
The request message for Participants.SuggestArticles.
| Fields | |
|---|---|
parent |
Required. The name of the participant to fetch suggestion for. Format: Authorization requires the following IAM permission on the specified resource
|
latest_ |
Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: |
context_ |
Optional. Max number of messages prior to and including |
assist_ |
Optional. Parameters for a human assist query. |
SuggestArticlesResponse
The response message for Participants.SuggestArticles.
| Fields | |
|---|---|
article_ |
Output only. Articles ordered by score in descending order. |
latest_ |
The name of the latest conversation message used to compile suggestion for. Format: |
context_ |
Number of messages prior to and including |
SuggestConversationSummaryRequest
The request message for Conversations.SuggestConversationSummary.
| Fields | |
|---|---|
conversation |
Required. The conversation to fetch suggestion for. Format: |
latest_ |
Optional. The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used. Format: |
context_ |
Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000. |
assist_ |
Optional. Parameters for a human assist query. Only used for POC/demo purpose. |
SuggestConversationSummaryResponse
The response message for Conversations.SuggestConversationSummary.
| Fields | |
|---|---|
summary |
Generated summary. |
latest_ |
The name of the latest conversation message used as context for compiling suggestion. Format: |
context_ |
Number of messages prior to and including [last_conversation_message][] used to compile the suggestion. It may be smaller than the [SuggestSummaryRequest.context_size][] field in the request if there weren't that many messages in the conversation. |
Summary
Generated summary for a conversation.
| Fields | |
|---|---|
text |
The summary content that is concatenated into one string. |
text_ |
The summary content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value. |
answer_ |
The name of the answer record. Format: "projects/ |
baseline_ |
The baseline model version used to generate this summary. It is empty if a baseline model was not used to generate this summary. |
SuggestDialogflowAssistsResponse
The response message for Participants.SuggestDialogflowAssists.
| Fields | |
|---|---|
dialogflow_ |
Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction. |
latest_ |
The name of the latest conversation message used to suggest answer. Format: |
context_ |
Number of messages prior to and including |
SuggestFaqAnswersRequest
The request message for Participants.SuggestFaqAnswers.
| Fields | |
|---|---|
parent |
Required. The name of the participant to fetch suggestion for. Format: Authorization requires the following IAM permission on the specified resource
|
latest_ |
Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: |
context_ |
Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50. |
assist_ |
Optional. Parameters for a human assist query. |
SuggestFaqAnswersResponse
The request message for Participants.SuggestFaqAnswers.
| Fields | |
|---|---|
faq_ |
Output only. Answers extracted from FAQ documents. |
latest_ |
The name of the latest conversation message used to compile suggestion for. Format: |
context_ |
Number of messages prior to and including |
SuggestKnowledgeAssistRequest
The request message for Participants.SuggestKnowledgeAssist.
| Fields | |
|---|---|
parent |
Required. The name of the participant to fetch suggestions for. Format: Authorization requires the following IAM permission on the specified resource
|
latest_ |
Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: |
context_ |
Optional. Max number of messages prior to and including |
previous_ |
Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation. |
SuggestKnowledgeAssistResponse
The response message for Participants.SuggestKnowledgeAssist.
| Fields | |
|---|---|
knowledge_ |
Output only. Knowledge Assist suggestion. |
latest_ |
The name of the latest conversation message used to compile suggestion for. Format: |
context_ |
Number of messages prior to and including |
SuggestSmartRepliesRequest
The request message for Participants.SuggestSmartReplies.
| Fields | |
|---|---|
parent |
Required. The name of the participant to fetch suggestion for. Format: Authorization requires the following IAM permission on the specified resource
|
current_ |
The current natural language text segment to compile suggestion for. This provides a way for user to get follow up smart reply suggestion after a smart reply selection, without sending a text message. |
latest_ |
The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: |
context_ |
Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50. |
SuggestSmartRepliesResponse
The response message for Participants.SuggestSmartReplies.
| Fields | |
|---|---|
smart_ |
Output only. Multiple reply options provided by smart reply service. The order is based on the rank of the model prediction. The maximum number of the returned replies is set in SmartReplyConfig. |
latest_ |
The name of the latest conversation message used to compile suggestion for. Format: |
context_ |
Number of messages prior to and including |
Suggestion
Represents a suggestion for a human agent.
| Fields | |
|---|---|
name |
Output only. The name of this suggestion. Format: |
articles[] |
Output only. Articles ordered by score in descending order. |
faq_ |
Output only. Answers extracted from FAQ documents. |
create_ |
Output only. The time the suggestion was created. |
latest_ |
Output only. Latest message used as context to compile this suggestion. Format: |
Article
Represents suggested article.
| Fields | |
|---|---|
title |
Output only. The article title. |
uri |
Output only. The article URI. |
snippets[] |
Output only. Article snippets. |
metadata |
Output only. A map that contains metadata about the answer and the document from which it originates. |
answer_ |
Output only. The name of answer record, in the format of "projects/ |
FaqAnswer
Represents suggested answer from "frequently asked questions".
| Fields | |
|---|---|
answer |
Output only. The piece of text from the |
confidence |
The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). |
question |
Output only. The corresponding FAQ question. |
source |
Output only. Indicates which Knowledge Document this answer was extracted from. Format: |
metadata |
Output only. A map that contains metadata about the answer and the document from which it originates. |
answer_ |
Output only. The name of answer record, in the format of "projects/ |
SuggestionFeature
The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.
| Fields | |
|---|---|
type |
Type of Human Agent Assistant API feature to request. |
Type
Defines the type of Human Agent Assistant feature.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Unspecified feature type. |
ARTICLE_SUGGESTION |
Run article suggestion model for chat. |
FAQ |
Run FAQ model. |
SMART_REPLY |
Run smart reply model for chat. |
DIALOGFLOW_ASSIST |
Run Dialogflow assist model for chat, which will return automated agent response as suggestion. |
CONVERSATION_SUMMARIZATION |
Run conversation summarization model for chat. |
KNOWLEDGE_SEARCH |
Run knowledge search with text input from agent or text generated query. |
KNOWLEDGE_ASSIST |
Run knowledge assist with automatic query generation. |
SuggestionInput
Represents the selection of a suggestion.
| Fields | |
|---|---|
answer_ |
Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: |
text_ |
Optional. If the customer edited the suggestion before using it, include the revised text here. |
parameters |
In Dialogflow assist for v3, the user can submit a form by sending a Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
|
intent_ |
The intent to be triggered on V3 agent. |
SuggestionResult
One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.
| Fields | |
|---|---|
Union field suggestion_response. Different type of suggestion response. suggestion_response can be only one of the following: |
|
error |
Error status if the request failed. |
suggest_ |
SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. |
suggest_ |
SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. |
suggest_ |
SuggestFaqAnswersResponse if request is for FAQ_ANSWER. |
suggest_ |
SuggestSmartRepliesResponse if request is for SMART_REPLY. |
suggest_ |
SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST. |
suggest_ |
SuggestDialogflowAssistsResponse if request is for ENTITY_EXTRACTION. |
SummarizationContext
Summarization context that customer can configure.
| Fields | |
|---|---|
summarization_ |
Optional. List of sections. Note it contains both predefined section sand customer defined sections. |
few_ |
Optional. List of few shot examples. |
version |
Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"]. |
output_ |
Optional. The target language of the generated summary. The language code for conversation will be used if this field is empty. Supported 2.0 and later versions. |
SummarizationSection
Represents the section of summarization.
| Fields | |
|---|---|
key |
Optional. Name of the section, for example, "situation". |
definition |
Optional. Definition of the section, for example, "what the customer needs help with or has question about." |
type |
Optional. Type of the summarization section. |
Type
Type enum of the summarization sections.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Undefined section type, does not return anything. |
SITUATION |
What the customer needs help with or has question about. Section name: "situation". |
ACTION |
What the agent does to help the customer. Section name: "action". |
RESOLUTION |
Result of the customer service. A single word describing the result of the conversation. Section name: "resolution". |
REASON_FOR_CANCELLATION |
Reason for cancellation if the customer requests for a cancellation. "N/A" otherwise. Section name: "reason_for_cancellation". |
CUSTOMER_SATISFACTION |
"Unsatisfied" or "Satisfied" depending on the customer's feelings at the end of the conversation. Section name: "customer_satisfaction". |
ENTITIES |
Key entities extracted from the conversation, such as ticket number, order number, dollar amount, etc. Section names are prefixed by "entities/". |
CUSTOMER_DEFINED |
Customer defined sections. |
SummarizationSectionList
List of summarization sections.
| Fields | |
|---|---|
summarization_ |
Optional. Summarization sections. |
SummarySuggestion
Suggested summary of the conversation.
| Fields | |
|---|---|
summary_ |
Required. All the parts of generated summary. |
SummarySection
A component of the generated summary.
| Fields | |
|---|---|
section |
Required. Name of the section. |
summary |
Required. Summary text for the section. |
SynthesizeSpeechConfig
Configuration of how speech should be synthesized.
| Fields | |
|---|---|
speaking_ |
Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
pitch |
Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
volume_ |
Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
effects_ |
Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
voice |
Optional. The desired voice of the synthesized audio. |
TelephonyDtmf
DTMF digit in Telephony Gateway.
| Enums | |
|---|---|
TELEPHONY_DTMF_UNSPECIFIED |
Not specified. This value may be used to indicate an absent digit. |
DTMF_ONE |
Number: '1'. |
DTMF_TWO |
Number: '2'. |
DTMF_THREE |
Number: '3'. |
DTMF_FOUR |
Number: '4'. |
DTMF_FIVE |
Number: '5'. |
DTMF_SIX |
Number: '6'. |
DTMF_SEVEN |
Number: '7'. |
DTMF_EIGHT |
Number: '8'. |
DTMF_NINE |
Number: '9'. |
DTMF_ZERO |
Number: '0'. |
DTMF_A |
Letter: 'A'. |
DTMF_B |
Letter: 'B'. |
DTMF_C |
Letter: 'C'. |
DTMF_D |
Letter: 'D'. |
DTMF_STAR |
Asterisk/star: '*'. |
DTMF_POUND |
Pound/diamond/hash/square/gate/octothorpe: '#'. |
TelephonyDtmfEvents
A wrapper of repeated TelephonyDtmf digits.
| Fields | |
|---|---|
dtmf_ |
A sequence of TelephonyDtmf digits. |
TextInput
Represents the natural language text to be processed.
| Fields | |
|---|---|
text |
Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. |
language_ |
Required. The language of this conversational query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
TextToSpeechSettings
Instructs the speech synthesizer on how to generate the output audio content.
| Fields | |
|---|---|
enable_ |
Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained. |
output_ |
Required. Audio encoding of the synthesized audio content. |
sample_ |
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
synthesize_ |
Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig. |
TrainAgentRequest
The request message for Agents.TrainAgent.
| Fields | |
|---|---|
parent |
Required. The project that the agent to train is associated with. Format: Authorization requires the following IAM permission on the specified resource
|
TriggerEvent
The event that triggers the generator and LLM execution.
| Enums | |
|---|---|
TRIGGER_EVENT_UNSPECIFIED |
Default value for TriggerEvent. |
END_OF_UTTERANCE |
Triggers when each chat message or voice utterance ends. |
MANUAL_CALL |
Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions. |
UpdateAnswerRecordRequest
Request message for AnswerRecords.UpdateAnswerRecord.
| Fields | |
|---|---|
answer_ |
Required. Answer record to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. |
UpdateContextRequest
The request message for Contexts.UpdateContext.
| Fields | |
|---|---|
context |
Required. The context to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Optional. The mask to control which fields get updated. |
UpdateConversationProfileRequest
The request message for ConversationProfiles.UpdateConversationProfile.
| Fields | |
|---|---|
conversation_ |
Required. The conversation profile to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields to update. |
UpdateDocumentRequest
Request message for Documents.UpdateDocument.
| Fields | |
|---|---|
document |
Required. The document to update. |
update_ |
Optional. Not specified means |
UpdateEntityTypeRequest
The request message for EntityTypes.UpdateEntityType.
| Fields | |
|---|---|
entity_ |
Required. The entity type to update. Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
update_ |
Optional. The mask to control which fields get updated. |
UpdateEnvironmentRequest
The request message for Environments.UpdateEnvironment.
| Fields | |
|---|---|
environment |
Required. The environment to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. |
allow_ |
Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = |
UpdateFulfillmentRequest
The request message for Fulfillments.UpdateFulfillment.
| Fields | |
|---|---|
fulfillment |
Required. The fulfillment to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdateGeneratorRequest
Request of UpdateGenerator.
| Fields | |
|---|---|
generator |
Required. The generator to update. The name field of generator is to identify the generator to update. |
update_ |
Optional. The list of fields to update. |
UpdateIntentRequest
The request message for Intents.UpdateIntent.
| Fields | |
|---|---|
intent |
Required. The intent to update. Authorization requires the following IAM permission on the specified resource
|
language_ |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data. |
update_ |
Optional. The mask to control which fields get updated. |
intent_ |
Optional. The resource view to apply to the returned intent. |
UpdateKnowledgeBaseRequest
Request message for KnowledgeBases.UpdateKnowledgeBase.
| Fields | |
|---|---|
knowledge_ |
Required. The knowledge base to update. |
update_ |
Optional. Not specified means |
UpdateParticipantRequest
The request message for Participants.UpdateParticipant.
| Fields | |
|---|---|
participant |
Required. The participant to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to specify which fields to update. |
UpdateSessionEntityTypeRequest
The request message for SessionEntityTypes.UpdateSessionEntityType.
| Fields | |
|---|---|
session_ |
Required. The session entity type to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Optional. The mask to control which fields get updated. |
UpdateSipTrunkRequest
The request message for SipTrunks.UpdateSipTrunk.
| Fields | |
|---|---|
sip_ |
Required. The SipTrunk to update. Authorization requires the following IAM permission on the specified resource
|
update_ |
Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
UpdateVersionRequest
The request message for Versions.UpdateVersion.
| Fields | |
|---|---|
version |
Required. The version to update. Supported formats: - Authorization requires the following IAM permission on the specified resource
|
update_ |
Required. The mask to control which fields get updated. |
ValidationError
Represents a single validation error.
| Fields | |
|---|---|
severity |
The severity of the error. |
entries[] |
The names of the entries that the error is associated with. Format:
|
error_ |
The detailed error message. |
Severity
Represents a level of severity.
| Enums | |
|---|---|
SEVERITY_UNSPECIFIED |
Not specified. This value should never be used. |
INFO |
The agent doesn't follow Dialogflow best practices. |
WARNING |
The agent may not behave as expected. |
ERROR |
The agent may experience partial failures. |
CRITICAL |
The agent may completely fail. |
ValidationResult
Represents the output of agent validation.
| Fields | |
|---|---|
validation_ |
Contains all validation errors. |
Version
You can create multiple versions of your agent and publish them to separate environments.
When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.
When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc.
For more information, see the versions and environments guide.
| Fields | |
|---|---|
name |
Output only. The unique identifier of this agent version. Supported formats: - |
description |
Optional. The developer-provided description of this version. |
version_ |
Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods. |
create_ |
Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods. |
status |
Output only. The status of this version. This field is read-only and cannot be set by create and update methods. |
VersionStatus
The status of a version.
| Enums | |
|---|---|
VERSION_STATUS_UNSPECIFIED |
Not specified. This value is not used. |
IN_PROGRESS |
Version is not ready to serve (e.g. training is in progress). |
READY |
Version is ready to serve. |
FAILED |
Version training failed. |
VoiceSelectionParams
Description of which voice to use for speech synthesis.
| Fields | |
|---|---|
name |
Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and For the list of available voices, please refer to Supported voices and languages. |
ssml_ |
Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and |
WebhookRequest
The request message for a webhook call.
| Fields | |
|---|---|
session |
The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Supported formats: - |
response_ |
The unique identifier of the response. Contains the same value as |
query_ |
The result of the conversational query or event processing. Contains the same value as |
alternative_ |
Alternative query results from KnowledgeService. |
original_ |
Optional. The contents of the original request that was passed to |
WebhookResponse
The response message for a webhook call.
This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:
- Use
""for empty strings - Use
{}ornullfor empty objects - Use
[]ornullfor empty arrays
For more information, see the Protocol Buffers Language Guide.
| Fields | |
|---|---|
fulfillment_ |
Optional. The text response message intended for the end-user. It is recommended to use |
fulfillment_ |
Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate |
source |
Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate |
payload |
Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate |
output_ |
Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate |
followup_ |
Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the |
live_ |
Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false. |
end_ |
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. |
session_ |
Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using |