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.