Index
Agents
(interface)AnswerRecords
(interface)Contexts
(interface)ConversationProfiles
(interface)Conversations
(interface)Documents
(interface)EntityTypes
(interface)Environments
(interface)Fulfillments
(interface)Intents
(interface)KnowledgeBases
(interface)Participants
(interface)SessionEntityTypes
(interface)Sessions
(interface)Agent
(message)Agent.ApiVersion
(enum)Agent.MatchMode
(enum)Agent.Tier
(enum)AgentAssistantFeedback
(message)AgentAssistantFeedback.AnswerRelevance
(enum)AgentAssistantFeedback.DocumentCorrectness
(enum)AgentAssistantFeedback.DocumentEfficiency
(enum)AgentAssistantFeedback.SummarizationFeedback
(message)AgentAssistantRecord
(message)AnalyzeContentRequest
(message)AnalyzeContentResponse
(message)AnnotatedMessagePart
(message)AnswerFeedback
(message)AnswerFeedback.CorrectnessLevel
(enum)AnswerRecord
(message)ArticleAnswer
(message)AudioEncoding
(enum)AutomatedAgentConfig
(message)AutomatedAgentReply
(message)BatchCreateEntitiesRequest
(message)BatchCreateMessagesRequest
(message)BatchCreateMessagesResponse
(message)BatchDeleteEntitiesRequest
(message)BatchDeleteEntityTypesRequest
(message)BatchDeleteIntentsRequest
(message)BatchUpdateEntitiesRequest
(message)BatchUpdateEntityTypesRequest
(message)BatchUpdateEntityTypesResponse
(message)BatchUpdateIntentsRequest
(message)BatchUpdateIntentsResponse
(message)CompileSuggestionRequest
(message) (deprecated)CompileSuggestionResponse
(message) (deprecated)CompleteConversationRequest
(message)Context
(message)Conversation
(message)Conversation.ConversationStage
(enum)Conversation.LifecycleState
(enum)ConversationEvent
(message)ConversationEvent.Type
(enum)ConversationPhoneNumber
(message)ConversationProfile
(message)CreateContextRequest
(message)CreateConversationProfileRequest
(message)CreateConversationRequest
(message)CreateDocumentRequest
(message)CreateEntityTypeRequest
(message)CreateIntentRequest
(message)CreateKnowledgeBaseRequest
(message)CreateMessageRequest
(message)CreateParticipantRequest
(message)CreateSessionEntityTypeRequest
(message)DeleteAgentRequest
(message)DeleteAllContextsRequest
(message)DeleteContextRequest
(message)DeleteConversationProfileRequest
(message)DeleteDocumentRequest
(message)DeleteEntityTypeRequest
(message)DeleteIntentRequest
(message)DeleteKnowledgeBaseRequest
(message)DeleteSessionEntityTypeRequest
(message)DetectIntentRequest
(message)DetectIntentResponse
(message)Document
(message)Document.KnowledgeType
(enum)Document.ReloadStatus
(message)DtmfParameters
(message)EntityType
(message)EntityType.AutoExpansionMode
(enum)EntityType.Entity
(message)EntityType.Kind
(enum)EntityTypeBatch
(message)Environment
(message)Environment.State
(enum)EventInput
(message)ExportAgentRequest
(message)ExportAgentResponse
(message)FaqAnswer
(message)Fulfillment
(message)Fulfillment.Feature
(message)Fulfillment.Feature.Type
(enum)Fulfillment.GenericWebService
(message)GcsSource
(message)GcsSources
(message)GetAgentRequest
(message)GetAnswerRecordRequest
(message)GetContextRequest
(message)GetConversationProfileRequest
(message)GetConversationRequest
(message)GetDocumentRequest
(message)GetEntityTypeRequest
(message)GetFulfillmentRequest
(message)GetIntentRequest
(message)GetKnowledgeBaseRequest
(message)GetParticipantRequest
(message)GetSessionEntityTypeRequest
(message)GetValidationResultRequest
(message)HumanAgentAssistantConfig
(message)HumanAgentAssistantConfig.ConversationModelConfig
(message)HumanAgentAssistantConfig.MessageAnalysisConfig
(message)HumanAgentAssistantConfig.SuggestionConfig
(message)HumanAgentAssistantConfig.SuggestionFeatureConfig
(message)HumanAgentAssistantConfig.SuggestionQueryConfig
(message)HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings
(message)HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource
(message)HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource
(message)HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource
(message)HumanAgentAssistantConfig.SuggestionTriggerSettings
(message)HumanAgentAssistantEvent
(message)HumanAgentHandoffConfig
(message)HumanAgentHandoffConfig.LivePersonConfig
(message)HumanAgentHandoffConfig.SalesforceLiveAgentConfig
(message)ImportAgentRequest
(message)ImportDocumentTemplate
(message)ImportDocumentsRequest
(message)ImportDocumentsResponse
(message)InputAudioConfig
(message)Intent
(message)Intent.FollowupIntentInfo
(message)Intent.Message
(message)Intent.Message.BasicCard
(message)Intent.Message.BasicCard.Button
(message)Intent.Message.BasicCard.Button.OpenUriAction
(message)Intent.Message.BrowseCarouselCard
(message)Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem
(message)Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction
(message)Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction.UrlTypeHint
(enum)Intent.Message.BrowseCarouselCard.ImageDisplayOptions
(enum)Intent.Message.Card
(message)Intent.Message.Card.Button
(message)Intent.Message.CarouselSelect
(message)Intent.Message.CarouselSelect.Item
(message)Intent.Message.ColumnProperties
(message)Intent.Message.ColumnProperties.HorizontalAlignment
(enum)Intent.Message.Image
(message)Intent.Message.LinkOutSuggestion
(message)Intent.Message.ListSelect
(message)Intent.Message.ListSelect.Item
(message)Intent.Message.MediaContent
(message)Intent.Message.MediaContent.ResponseMediaObject
(message)Intent.Message.MediaContent.ResponseMediaType
(enum)Intent.Message.Platform
(enum)Intent.Message.QuickReplies
(message)Intent.Message.RbmCardContent
(message)Intent.Message.RbmCardContent.RbmMedia
(message)Intent.Message.RbmCardContent.RbmMedia.Height
(enum)Intent.Message.RbmCarouselCard
(message)Intent.Message.RbmCarouselCard.CardWidth
(enum)Intent.Message.RbmStandaloneCard
(message)Intent.Message.RbmStandaloneCard.CardOrientation
(enum)Intent.Message.RbmStandaloneCard.ThumbnailImageAlignment
(enum)Intent.Message.RbmSuggestedAction
(message)Intent.Message.RbmSuggestedAction.RbmSuggestedActionDial
(message)Intent.Message.RbmSuggestedAction.RbmSuggestedActionOpenUri
(message)Intent.Message.RbmSuggestedAction.RbmSuggestedActionShareLocation
(message)Intent.Message.RbmSuggestedReply
(message)Intent.Message.RbmSuggestion
(message)Intent.Message.RbmText
(message)Intent.Message.SelectItemInfo
(message)Intent.Message.SimpleResponse
(message)Intent.Message.SimpleResponses
(message)Intent.Message.Suggestion
(message)Intent.Message.Suggestions
(message)Intent.Message.TableCard
(message)Intent.Message.TableCardCell
(message)Intent.Message.TableCardRow
(message)Intent.Message.TelephonyPlayAudio
(message)Intent.Message.TelephonySynthesizeSpeech
(message)Intent.Message.TelephonyTransferCall
(message)Intent.Message.Text
(message)Intent.Parameter
(message)Intent.TrainingPhrase
(message)Intent.TrainingPhrase.Part
(message)Intent.TrainingPhrase.Type
(enum)Intent.WebhookState
(enum)IntentBatch
(message)IntentView
(enum)KnowledgeAnswers
(message)KnowledgeAnswers.Answer
(message)KnowledgeAnswers.Answer.MatchConfidenceLevel
(enum)KnowledgeBase
(message)KnowledgeOperationMetadata
(message)KnowledgeOperationMetadata.State
(enum)ListAnswerRecordsRequest
(message)ListAnswerRecordsResponse
(message)ListContextsRequest
(message)ListContextsResponse
(message)ListConversationProfilesRequest
(message)ListConversationProfilesResponse
(message)ListConversationsRequest
(message)ListConversationsResponse
(message)ListDocumentsRequest
(message)ListDocumentsResponse
(message)ListEntityTypesRequest
(message)ListEntityTypesResponse
(message)ListEnvironmentsRequest
(message)ListEnvironmentsResponse
(message)ListIntentsRequest
(message)ListIntentsResponse
(message)ListKnowledgeBasesRequest
(message)ListKnowledgeBasesResponse
(message)ListMessagesRequest
(message)ListMessagesResponse
(message)ListParticipantsRequest
(message)ListParticipantsResponse
(message)ListSessionEntityTypesRequest
(message)ListSessionEntityTypesResponse
(message)ListSuggestionsRequest
(message) (deprecated)ListSuggestionsResponse
(message) (deprecated)LoggingConfig
(message)Message
(message)MessageAnnotation
(message)NotificationConfig
(message)NotificationConfig.MessageFormat
(enum)OriginalDetectIntentRequest
(message)OutputAudio
(message)OutputAudioConfig
(message)OutputAudioEncoding
(enum)Participant
(message)Participant.Role
(enum)QueryInput
(message)QueryParameters
(message)QueryResult
(message)ReloadDocumentRequest
(message)ResponseMessage
(message)ResponseMessage.EndInteraction
(message)ResponseMessage.LiveAgentHandoff
(message)ResponseMessage.Text
(message)RestoreAgentRequest
(message)SearchAgentsRequest
(message)SearchAgentsResponse
(message)Sentiment
(message)SentimentAnalysisRequestConfig
(message)SentimentAnalysisResult
(message)SessionEntityType
(message)SessionEntityType.EntityOverrideMode
(enum)SetAgentRequest
(message)SmartReplyAnswer
(message)SpeechContext
(message)SpeechModelVariant
(enum)SpeechToTextConfig
(message)SpeechWordInfo
(message)SsmlVoiceGender
(enum)StreamingDetectIntentRequest
(message)StreamingDetectIntentResponse
(message)StreamingRecognitionResult
(message)StreamingRecognitionResult.MessageType
(enum)SubAgent
(message)SuggestArticlesRequest
(message)SuggestArticlesResponse
(message)SuggestFaqAnswersRequest
(message)SuggestFaqAnswersResponse
(message)SuggestSmartRepliesRequest
(message)SuggestSmartRepliesResponse
(message)Suggestion
(message) (deprecated)Suggestion.Article
(message)Suggestion.FaqAnswer
(message)SuggestionFeature
(message)SuggestionFeature.Type
(enum)SuggestionResult
(message)SynthesizeSpeechConfig
(message)TelephonyDtmf
(enum)TelephonyDtmfEvents
(message)TextInput
(message)TextToSpeechSettings
(message)TrainAgentRequest
(message)UpdateAnswerRecordRequest
(message)UpdateContextRequest
(message)UpdateConversationProfileRequest
(message)UpdateDocumentRequest
(message)UpdateEntityTypeRequest
(message)UpdateFulfillmentRequest
(message)UpdateIntentRequest
(message)UpdateKnowledgeBaseRequest
(message)UpdateParticipantRequest
(message)UpdateSessionEntityTypeRequest
(message)ValidationError
(message)ValidationError.Severity
(enum)ValidationResult
(message)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. Operation <response:
|
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 Operation <response:
|
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 Operation <response:
|
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.
|
TrainAgent | |
---|---|
Trains the specified agent. Operation <response:
|
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
.
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.
|
UpdateConversationProfile | |
---|---|
Updates the specified conversation profile. [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via
|
Conversations
Service for managing Conversations
.
BatchCreateMessages | |
---|---|
Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.
|
CompleteConversation | |
---|---|
Completes the specified conversation. Finished conversations are purged from the database after 30 days.
|
CreateConversation | |
---|---|
Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If
|
GetConversation | |
---|---|
Retrieves the specific conversation.
|
ListConversations | |
---|---|
Returns the list of all conversations in the specified project.
|
ListMessages | |
---|---|
Lists messages that belong to a given conversation.
|
Documents
Service for managing knowledge Documents
.
CreateDocument | |
---|---|
Creates a new document. Note: The
|
DeleteDocument | |
---|---|
Deletes the specified document. Note: The
|
GetDocument | |
---|---|
Retrieves the specified document. Note: The
|
ImportDocuments | |
---|---|
Create documents by importing data from external sources.
|
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 Note: The
|
UpdateDocument | |
---|---|
Updates the specified document. Note: The
|
EntityTypes
Service for managing EntityTypes
.
BatchCreateEntities | |
---|---|
Creates multiple new entities in the specified entity type. Operation <response:
|
BatchDeleteEntities | |
---|---|
Deletes entities in the specified entity type. Operation <response:
|
BatchDeleteEntityTypes | |
---|---|
Deletes entity types in the specified agent. Operation <response:
|
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. Operation <response:
|
BatchUpdateEntityTypes | |
---|---|
Updates/Creates multiple entity types in the specified agent. Operation <response:
|
CreateEntityType | |
---|---|
Creates an entity type in the specified agent.
|
DeleteEntityType | |
---|---|
Deletes the specified entity type.
|
GetEntityType | |
---|---|
Retrieves the specified entity type.
|
ListEntityTypes | |
---|---|
Returns the list of all entity types in the specified agent.
|
UpdateEntityType | |
---|---|
Updates the specified entity type.
|
Environments
Service for managing Environments
.
ListEnvironments | |
---|---|
Returns the list of all non-draft environments of the specified agent.
|
Fulfillments
Service for managing Fulfillments
.
GetFulfillment | |
---|---|
Retrieves the fulfillment.
|
UpdateFulfillment | |
---|---|
Updates the fulfillment.
|
Intents
Service for managing Intents
.
BatchDeleteIntents | |
---|---|
Deletes intents in the specified agent. Operation <response:
|
BatchUpdateIntents | |
---|---|
Updates/Creates multiple intents in the specified agent. Operation <response:
|
CreateIntent | |
---|---|
Creates an intent in the specified agent.
|
DeleteIntent | |
---|---|
Deletes the specified intent and its direct or indirect followup intents.
|
GetIntent | |
---|---|
Retrieves the specified intent.
|
ListIntents | |
---|---|
Returns the list of all intents in the specified agent.
|
UpdateIntent | |
---|---|
Updates the specified intent.
|
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
|
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.
|
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. 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). Note: Always use agent versions for production traffic. See Versions and environments.
|
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_name |
Required. The name of this agent. |
default_language_code |
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_language_codes[] |
Optional. The list of all languages supported by this agent (except for the |
time_zone |
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_uri |
Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration. |
enable_logging |
Optional. Determines whether this agent should log conversation queries. |
match_mode |
Optional. Determines how intents are detected from user queries. |
classification_threshold |
Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. |
api_version |
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 |
Standard tier. |
TIER_ENTERPRISE |
Enterprise tier (Essentials). |
TIER_ENTERPRISE_PLUS |
Enterprise tier (Plus). |
AgentAssistantFeedback
Detail feedback of Agent Assistant result.
Fields | |
---|---|
answer_relevance |
Optional. Whether or not the suggested answer is relevant. For example:
|
document_correctness |
Optional. Whether or not the information in the document is correct. For example:
|
document_efficiency |
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 |
Feedback for conversation summarization. |
AnswerRelevance
Relevance of an answer.
Enums | |
---|---|
ANSWER_RELEVANCE_UNSPECIFIED |
Answer relevance unspecified. |
IRRELEVANT |
Answer is irrelevant to query. |
RELEVANT |
Answer is relevant to query. |
DocumentCorrectness
Correctness of document.
Enums | |
---|---|
DOCUMENT_CORRECTNESS_UNSPECIFIED |
Document correctness unspecified. |
INCORRECT |
Information in document is incorrect. |
CORRECT |
Information in document is correct. |
DocumentEfficiency
Efficiency of document.
Enums | |
---|---|
DOCUMENT_EFFICIENCY_UNSPECIFIED |
Document efficiency unspecified. |
INEFFICIENT |
Document is inefficient. |
EFFICIENT |
Document is efficient. |
SummarizationFeedback
Feedback for conversation summarization.
Fields | |
---|---|
start_timestamp |
Timestamp when composing of the summary starts. |
submit_timestamp |
Timestamp when the summary was submitted. |
summary_text |
Text of actual submitted summary. |
AgentAssistantRecord
Represents a record of a human agent assistant answer.
Fields | ||
---|---|---|
Union field answer . Output only. The agent assistant answer. answer can be only one of the following: |
||
article_suggestion_answer |
Output only. The article suggestion answer. |
|
faq_answer |
Output only. The FAQ 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_audio_config |
Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled. |
|
query_params |
Parameters for a Dialogflow virtual-agent query. |
|
message_send_time |
Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant. Given two messages under the same participant: - If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant. - If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later. If the value is not provided, a new request will always be regarded as a new message without any de-duplication. |
|
request_id |
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_input |
The natural language text to be processed. |
|
event_input |
An input event to send to Dialogflow. |
AnalyzeContentResponse
The response message for Participants.AnalyzeContent
.
Fields | |
---|---|
reply_text |
Output only. The output text content. This field is set if the automated agent responded with text to show to the user. |
reply_audio |
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_agent_reply |
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_agent_suggestion_results[] |
The suggestions for most recent human agent. The order is the same as |
end_user_suggestion_results[] |
The suggestions for end user. The order is the same as |
dtmf_parameters |
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_type |
Optional. The Dialogflow system entity type of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity. |
formatted_value |
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_level |
The correctness level of the specific answer. |
clicked |
Indicates whether the answer/item was clicked by the human agent or not. Default to false. |
click_time |
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 |
Time when the answer/item was displayed. |
agent_assistant_detail_feedback |
Optional. Detail feedback of agent assistant suggestions. |
CorrectnessLevel
The correctness level of an answer.
Enums | |
---|---|
CORRECTNESS_LEVEL_UNSPECIFIED |
Correctness level unspecified. |
NOT_CORRECT |
Answer is totally wrong. |
PARTIALLY_CORRECT |
Answer is partially correct. |
FULLY_CORRECT |
Answer is fully correct. |
AnswerRecord
Answer records are records to manage answer history and feedbacks for Dialogflow.
Currently, answer record includes:
- human agent assistant article suggestion
- human agent assistant faq article
It doesn't include:
DetectIntent
intent matchingDetectIntent
knowledge
Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated.
A typical workflow for customers provide feedback to an answer is:
- For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers,
AnswerRecord.name
are returned to the customers. - The customer uses the
AnswerRecord.name
to call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.
Fields | |
---|---|
name |
The unique identifier of this answer record. Required for |
answer_feedback |
Optional. The AnswerFeedback for this record. You can set this with |
agent_assistant_record |
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_record |
The name of answer record, in the format of "projects/ |
AudioEncoding
Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.
Enums | |
---|---|
AUDIO_ENCODING_UNSPECIFIED |
Not specified. |
AUDIO_ENCODING_LINEAR_16 |
Uncompressed 16-bit signed little-endian samples (Linear PCM). |
AUDIO_ENCODING_FLAC |
FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16 . FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
AUDIO_ENCODING_MULAW |
8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
AUDIO_ENCODING_AMR |
Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
AUDIO_ENCODING_AMR_WB |
Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
AUDIO_ENCODING_OGG_OPUS |
Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE |
Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte . It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
AutomatedAgentConfig
Defines the Automated Agent to connect to a conversation.
Fields | |
---|---|
agent |
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
|
AutomatedAgentReply
Represents a response from an automated agent.
Fields | ||
---|---|---|
response_messages[] |
Response messages from the automated agent. |
|
cx_session_parameters |
The collection of current Dialogflow CX agent session parameters at the time of this response. |
|
detect_intent_response |
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. |
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_code |
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 1000 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_values[] |
Required. The reference |
language_code |
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_type_names[] |
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_code |
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_mask |
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_code |
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_mask |
Optional. The mask to control which fields get updated. |
|
Union field For each entity type in the batch:
|
||
entity_type_batch_uri |
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_type_batch_inline |
The collection of entity types to update or create. |
BatchUpdateEntityTypesResponse
The response message for EntityTypes.BatchUpdateEntityTypes
.
Fields | |
---|---|
entity_types[] |
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_code |
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_mask |
Optional. The mask to control which fields get updated. |
|
intent_view |
Optional. The resource view to apply to the returned intent. |
|
Union field For each intent in the batch:
|
||
intent_batch_uri |
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_batch_inline |
The collection of intents to update or create. |