Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).
- REST Resource: v2beta1.projects
- REST Resource: v2beta1.projects.agent
- REST Resource: v2beta1.projects.agent.entityTypes
- REST Resource: v2beta1.projects.agent.entityTypes.entities
- REST Resource: v2beta1.projects.agent.environments
- REST Resource: v2beta1.projects.agent.environments.intents
- REST Resource: v2beta1.projects.agent.environments.users.sessions
- REST Resource: v2beta1.projects.agent.environments.users.sessions.contexts
- REST Resource: v2beta1.projects.agent.environments.users.sessions.entityTypes
- REST Resource: v2beta1.projects.agent.intents
- REST Resource: v2beta1.projects.agent.knowledgeBases
- REST Resource: v2beta1.projects.agent.knowledgeBases.documents
- REST Resource: v2beta1.projects.agent.sessions
- REST Resource: v2beta1.projects.agent.sessions.contexts
- REST Resource: v2beta1.projects.agent.sessions.entityTypes
- REST Resource: v2beta1.projects.agent.versions
- REST Resource: v2beta1.projects.answerRecords
- REST Resource: v2beta1.projects.conversationProfiles
- REST Resource: v2beta1.projects.conversations
- REST Resource: v2beta1.projects.conversations.messages
- REST Resource: v2beta1.projects.conversations.participants
- REST Resource: v2beta1.projects.conversations.participants.suggestions
- REST Resource: v2beta1.projects.conversations.suggestions
- REST Resource: v2beta1.projects.generators
- REST Resource: v2beta1.projects.knowledgeBases
- REST Resource: v2beta1.projects.knowledgeBases.documents
- REST Resource: v2beta1.projects.locations
- REST Resource: v2beta1.projects.locations.agent
- REST Resource: v2beta1.projects.locations.agent.entityTypes
- REST Resource: v2beta1.projects.locations.agent.entityTypes.entities
- REST Resource: v2beta1.projects.locations.agent.environments
- REST Resource: v2beta1.projects.locations.agent.environments.intents
- REST Resource: v2beta1.projects.locations.agent.environments.users.sessions
- REST Resource: v2beta1.projects.locations.agent.environments.users.sessions.contexts
- REST Resource: v2beta1.projects.locations.agent.environments.users.sessions.entityTypes
- REST Resource: v2beta1.projects.locations.agent.intents
- REST Resource: v2beta1.projects.locations.agent.sessions
- REST Resource: v2beta1.projects.locations.agent.sessions.contexts
- REST Resource: v2beta1.projects.locations.agent.sessions.entityTypes
- REST Resource: v2beta1.projects.locations.agent.versions
- REST Resource: v2beta1.projects.locations.answerRecords
- REST Resource: v2beta1.projects.locations.conversationProfiles
- REST Resource: v2beta1.projects.locations.conversations
- REST Resource: v2beta1.projects.locations.conversations.messages
- REST Resource: v2beta1.projects.locations.conversations.participants
- REST Resource: v2beta1.projects.locations.conversations.participants.suggestions
- REST Resource: v2beta1.projects.locations.conversations.suggestions
- REST Resource: v2beta1.projects.locations.encryptionSpec
- REST Resource: v2beta1.projects.locations.generators
- REST Resource: v2beta1.projects.locations.generators.evaluations
- REST Resource: v2beta1.projects.locations.knowledgeBases
- REST Resource: v2beta1.projects.locations.knowledgeBases.documents
- REST Resource: v2beta1.projects.locations.operations
- REST Resource: v2beta1.projects.locations.phoneNumbers
- REST Resource: v2beta1.projects.locations.sipTrunks
- REST Resource: v2beta1.projects.locations.statelessSuggestion
- REST Resource: v2beta1.projects.locations.suggestions
- REST Resource: v2beta1.projects.locations.tools
- REST Resource: v2beta1.projects.operations
- REST Resource: v2beta1.projects.phoneNumbers
- REST Resource: v2beta1.projects.suggestions
Service: dialogflow.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoints and all URIs below are relative to these service endpoints:
- https://dialogflow.googleapis.com
- https://asia-northeast1-dialogflow.googleapis.com
- https://australia-southeast1-dialogflow.googleapis.com
- https://europe-west1-dialogflow.googleapis.com
- https://europe-west2-dialogflow.googleapis.com
REST Resource: v2beta1.projects
| Methods | |
|---|---|
| deleteAgent | DELETE /v2beta1/{parent=projects/*}/agentDeletes the specified agent. | 
| getAgent | GET /v2beta1/{parent=projects/*}/agentRetrieves the specified agent. | 
| setAgent | POST /v2beta1/{agent.parent=projects/*}/agentCreates/updates the specified agent. | 
REST Resource: v2beta1.projects.agent
| Methods | |
|---|---|
| export | POST /v2beta1/{parent=projects/*}/agent:exportExports the specified agent to a ZIP file. | 
| getFulfillment | GET /v2beta1/{name=projects/*/agent/fulfillment}Retrieves the fulfillment. | 
| getValidationResult | GET /v2beta1/{parent=projects/*}/agent/validationResultGets agent validation result. | 
| import | POST /v2beta1/{parent=projects/*}/agent:importImports the specified agent from a ZIP file. | 
| restore | POST /v2beta1/{parent=projects/*}/agent:restoreRestores the specified agent from a ZIP file. | 
| search | GET /v2beta1/{parent=projects/*}/agent:searchReturns the list of agents. | 
| train | POST /v2beta1/{parent=projects/*}/agent:trainTrains the specified agent. | 
| updateFulfillment | PATCH /v2beta1/{fulfillment.name=projects/*/agent/fulfillment}Updates the fulfillment. | 
REST Resource: v2beta1.projects.agent.entityTypes
| Methods | |
|---|---|
| batchDelete | POST /v2beta1/{parent=projects/*/agent}/entityTypes:batchDeleteDeletes entity types in the specified agent. | 
| batchUpdate | POST /v2beta1/{parent=projects/*/agent}/entityTypes:batchUpdateUpdates/Creates multiple entity types in the specified agent. | 
| create | POST /v2beta1/{parent=projects/*/agent}/entityTypesCreates an entity type in the specified agent. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/entityTypes/*}Deletes the specified entity type. | 
| get | GET /v2beta1/{name=projects/*/agent/entityTypes/*}Retrieves the specified entity type. | 
| list | GET /v2beta1/{parent=projects/*/agent}/entityTypesReturns the list of all entity types in the specified agent. | 
| patch | PATCH /v2beta1/{entityType.name=projects/*/agent/entityTypes/*}Updates the specified entity type. | 
REST Resource: v2beta1.projects.agent.entityTypes.entities
| Methods | |
|---|---|
| batchCreate | POST /v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchCreateCreates multiple new entities in the specified entity type. | 
| batchDelete | POST /v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchDeleteDeletes entities in the specified entity type. | 
| batchUpdate | POST /v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchUpdateUpdates or creates multiple entities in the specified entity type. | 
REST Resource: v2beta1.projects.agent.environments
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent}/environmentsCreates an agent environment. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/environments/*}Deletes the specified agent environment. | 
| get | GET /v2beta1/{name=projects/*/agent/environments/*}Retrieves the specified agent environment. | 
| getHistory | GET /v2beta1/{parent=projects/*/agent/environments/*}/historyGets the history of the specified environment. | 
| list | GET /v2beta1/{parent=projects/*/agent}/environmentsReturns the list of all non-draft environments of the specified agent. | 
| patch | PATCH /v2beta1/{environment.name=projects/*/agent/environments/*}Updates the specified agent environment. | 
REST Resource: v2beta1.projects.agent.environments.intents
| Methods | |
|---|---|
| list | GET /v2beta1/{parent=projects/*/agent/environments/*}/intentsReturns the list of all intents in the specified agent. | 
REST Resource: v2beta1.projects.agent.environments.users.sessions
| Methods | |
|---|---|
| deleteContexts | DELETE /v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/contextsDeletes all active contexts in the specified session. | 
| detectIntent | POST /v2beta1/{session=projects/*/agent/environments/*/users/*/sessions/*}:detectIntentProcesses a natural language query and returns structured, actionable data as a result. | 
REST Resource: v2beta1.projects.agent.environments.users.sessions.contexts
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/contextsCreates a context. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/contexts/*}Deletes the specified context. | 
| get | GET /v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/contexts/*}Retrieves the specified context. | 
| list | GET /v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/contextsReturns the list of all contexts in the specified session. | 
| patch | PATCH /v2beta1/{context.name=projects/*/agent/environments/*/users/*/sessions/*/contexts/*}Updates the specified context. | 
REST Resource: v2beta1.projects.agent.environments.users.sessions.entityTypes
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/entityTypesCreates a session entity type. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/entityTypes/*}Deletes the specified session entity type. | 
| get | GET /v2beta1/{name=projects/*/agent/environments/*/users/*/sessions/*/entityTypes/*}Retrieves the specified session entity type. | 
| list | GET /v2beta1/{parent=projects/*/agent/environments/*/users/*/sessions/*}/entityTypesReturns the list of all session entity types in the specified session. | 
| patch | PATCH /v2beta1/{sessionEntityType.name=projects/*/agent/environments/*/users/*/sessions/*/entityTypes/*}Updates the specified session entity type. | 
REST Resource: v2beta1.projects.agent.intents
| Methods | |
|---|---|
| batchDelete | POST /v2beta1/{parent=projects/*/agent}/intents:batchDeleteDeletes intents in the specified agent. | 
| batchUpdate | POST /v2beta1/{parent=projects/*/agent}/intents:batchUpdateUpdates/Creates multiple intents in the specified agent. | 
| create | POST /v2beta1/{parent=projects/*/agent}/intentsCreates an intent in the specified agent. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/intents/*}Deletes the specified intent and its direct or indirect followup intents. | 
| get | GET /v2beta1/{name=projects/*/agent/intents/*}Retrieves the specified intent. | 
| list | GET /v2beta1/{parent=projects/*/agent}/intentsReturns the list of all intents in the specified agent. | 
| patch | PATCH /v2beta1/{intent.name=projects/*/agent/intents/*}Updates the specified intent. | 
REST Resource: v2beta1.projects.agent.knowledgeBases
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent}/knowledgeBasesCreates a knowledge base. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/knowledgeBases/*}Deletes the specified knowledge base. | 
| get | GET /v2beta1/{name=projects/*/agent/knowledgeBases/*}Retrieves the specified knowledge base. | 
| list | GET /v2beta1/{parent=projects/*/agent}/knowledgeBasesReturns the list of all knowledge bases of the specified agent. | 
| patch | PATCH /v2beta1/{knowledgeBase.name=projects/*/agent/knowledgeBases/*}Updates the specified knowledge base. | 
REST Resource: v2beta1.projects.agent.knowledgeBases.documents
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent/knowledgeBases/*}/documentsCreates a new document. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}Deletes the specified document. | 
| get | GET /v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}Retrieves the specified document. | 
| list | GET /v2beta1/{parent=projects/*/agent/knowledgeBases/*}/documentsReturns the list of all documents of the knowledge base. | 
| patch | PATCH /v2beta1/{document.name=projects/*/agent/knowledgeBases/*/documents/*}Updates the specified document. | 
| reload | POST /v2beta1/{name=projects/*/agent/knowledgeBases/*/documents/*}:reloadReloads the specified document from its specified source, content_uri or content. | 
REST Resource: v2beta1.projects.agent.sessions
| Methods | |
|---|---|
| deleteContexts | DELETE /v2beta1/{parent=projects/*/agent/sessions/*}/contextsDeletes all active contexts in the specified session. | 
| detectIntent | POST /v2beta1/{session=projects/*/agent/sessions/*}:detectIntentProcesses a natural language query and returns structured, actionable data as a result. | 
REST Resource: v2beta1.projects.agent.sessions.contexts
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent/sessions/*}/contextsCreates a context. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/sessions/*/contexts/*}Deletes the specified context. | 
| get | GET /v2beta1/{name=projects/*/agent/sessions/*/contexts/*}Retrieves the specified context. | 
| list | GET /v2beta1/{parent=projects/*/agent/sessions/*}/contextsReturns the list of all contexts in the specified session. | 
| patch | PATCH /v2beta1/{context.name=projects/*/agent/sessions/*/contexts/*}Updates the specified context. | 
REST Resource: v2beta1.projects.agent.sessions.entityTypes
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent/sessions/*}/entityTypesCreates a session entity type. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/sessions/*/entityTypes/*}Deletes the specified session entity type. | 
| get | GET /v2beta1/{name=projects/*/agent/sessions/*/entityTypes/*}Retrieves the specified session entity type. | 
| list | GET /v2beta1/{parent=projects/*/agent/sessions/*}/entityTypesReturns the list of all session entity types in the specified session. | 
| patch | PATCH /v2beta1/{sessionEntityType.name=projects/*/agent/sessions/*/entityTypes/*}Updates the specified session entity type. | 
REST Resource: v2beta1.projects.agent.versions
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/agent}/versionsCreates an agent version. | 
| delete | DELETE /v2beta1/{name=projects/*/agent/versions/*}Delete the specified agent version. | 
| get | GET /v2beta1/{name=projects/*/agent/versions/*}Retrieves the specified agent version. | 
| list | GET /v2beta1/{parent=projects/*/agent}/versionsReturns the list of all versions of the specified agent. | 
| patch | PATCH /v2beta1/{version.name=projects/*/agent/versions/*}Updates the specified agent version. | 
REST Resource: v2beta1.projects.answerRecords
| Methods | |
|---|---|
| get  | GET /v2beta1/{name=projects/*/answerRecords/*}Deprecated. | 
| list | GET /v2beta1/{parent=projects/*}/answerRecordsReturns the list of all answer records in the specified project in reverse chronological order. | 
| patch | PATCH /v2beta1/{answerRecord.name=projects/*/answerRecords/*}Updates the specified answer record. | 
REST Resource: v2beta1.projects.conversationProfiles
| Methods | |
|---|---|
| clearSuggestionFeatureConfig | POST /v2beta1/{conversationProfile=projects/*/conversationProfiles/*}:clearSuggestionFeatureConfigClears a suggestion feature from a conversation profile for the given participant role. | 
| create | POST /v2beta1/{parent=projects/*}/conversationProfilesCreates a conversation profile in the specified project. | 
| delete | DELETE /v2beta1/{name=projects/*/conversationProfiles/*}Deletes the specified conversation profile. | 
| get | GET /v2beta1/{name=projects/*/conversationProfiles/*}Retrieves the specified conversation profile. | 
| list | GET /v2beta1/{parent=projects/*}/conversationProfilesReturns the list of all conversation profiles in the specified project. | 
| patch | PATCH /v2beta1/{conversationProfile.name=projects/*/conversationProfiles/*}Updates the specified conversation profile. | 
| setSuggestionFeatureConfig | POST /v2beta1/{conversationProfile=projects/*/conversationProfiles/*}:setSuggestionFeatureConfigAdds or updates a suggestion feature in a conversation profile. | 
REST Resource: v2beta1.projects.conversations
| Methods | |
|---|---|
| complete | POST /v2beta1/{name=projects/*/conversations/*}:completeCompletes the specified conversation. | 
| create | POST /v2beta1/{parent=projects/*}/conversationsCreates a new conversation. | 
| get | GET /v2beta1/{name=projects/*/conversations/*}Retrieves the specific conversation. | 
| list | GET /v2beta1/{parent=projects/*}/conversationsReturns the list of all conversations in the specified project. | 
REST Resource: v2beta1.projects.conversations.messages
| Methods | |
|---|---|
| batchCreate | POST /v2beta1/{parent=projects/*/conversations/*}/messages:batchCreateBatch ingests messages to conversation. | 
| list | GET /v2beta1/{parent=projects/*/conversations/*}/messagesLists messages that belong to a given conversation. | 
REST Resource: v2beta1.projects.conversations.participants
| Methods | |
|---|---|
| analyzeContent | POST /v2beta1/{participant=projects/*/conversations/*/participants/*}:analyzeContentAdds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. | 
| create | POST /v2beta1/{parent=projects/*/conversations/*}/participantsCreates a new participant in a conversation. | 
| get | GET /v2beta1/{name=projects/*/conversations/*/participants/*}Retrieves a conversation participant. | 
| list | GET /v2beta1/{parent=projects/*/conversations/*}/participantsReturns the list of all participants in the specified conversation. | 
| patch | PATCH /v2beta1/{participant.name=projects/*/conversations/*/participants/*}Updates the specified participant. | 
REST Resource: v2beta1.projects.conversations.participants.suggestions
| Methods | |
|---|---|
| compile  | POST /v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:compileDeprecated. | 
| list  | GET /v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestionsDeprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. | 
| suggestArticles | POST /v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestArticlesGets suggested articles for a participant based on specific historical messages. | 
| suggestFaqAnswers | POST /v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestFaqAnswersGets suggested faq answers for a participant based on specific historical messages. | 
| suggestKnowledgeAssist | POST /v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestKnowledgeAssistGets knowledge assist suggestions based on historical messages. | 
| suggestSmartReplies | POST /v2beta1/{parent=projects/*/conversations/*/participants/*}/suggestions:suggestSmartRepliesGets smart replies for a participant based on specific historical messages. | 
REST Resource: v2beta1.projects.conversations.suggestions
| Methods | |
|---|---|
| generate | POST /v2beta1/{conversation=projects/*/conversations/*}/suggestions:generateGenerates all the suggestions using generators configured in the conversation profile. | 
| searchKnowledge | POST /v2beta1/{conversation=projects/*/conversations/*}/suggestions:searchKnowledgeGet answers for the given query based on knowledge documents. | 
| suggestConversationSummary | POST /v2beta1/{conversation=projects/*/conversations/*}/suggestions:suggestConversationSummarySuggest summary for a conversation based on specific historical messages. | 
REST Resource: v2beta1.projects.generators
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*}/generatorsCreates a generator. | 
| list | GET /v2beta1/{parent=projects/*}/generatorsLists generators. | 
REST Resource: v2beta1.projects.knowledgeBases
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*}/knowledgeBasesCreates a knowledge base. | 
| delete | DELETE /v2beta1/{name=projects/*/knowledgeBases/*}Deletes the specified knowledge base. | 
| get | GET /v2beta1/{name=projects/*/knowledgeBases/*}Retrieves the specified knowledge base. | 
| list | GET /v2beta1/{parent=projects/*}/knowledgeBasesReturns the list of all knowledge bases of the specified agent. | 
| patch | PATCH /v2beta1/{knowledgeBase.name=projects/*/knowledgeBases/*}Updates the specified knowledge base. | 
REST Resource: v2beta1.projects.knowledgeBases.documents
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/knowledgeBases/*}/documentsCreates a new document. | 
| delete | DELETE /v2beta1/{name=projects/*/knowledgeBases/*/documents/*}Deletes the specified document. | 
| get | GET /v2beta1/{name=projects/*/knowledgeBases/*/documents/*}Retrieves the specified document. | 
| import | POST /v2beta1/{parent=projects/*/knowledgeBases/*}/documents:importCreate documents by importing data from external sources. | 
| list | GET /v2beta1/{parent=projects/*/knowledgeBases/*}/documentsReturns the list of all documents of the knowledge base. | 
| patch | PATCH /v2beta1/{document.name=projects/*/knowledgeBases/*/documents/*}Updates the specified document. | 
| reload | POST /v2beta1/{name=projects/*/knowledgeBases/*/documents/*}:reloadReloads the specified document from its specified source, content_uri or content. | 
REST Resource: v2beta1.projects.locations
| Methods | |
|---|---|
| deleteAgent | DELETE /v2beta1/{parent=projects/*/locations/*}/agentDeletes the specified agent. | 
| get | GET /v2beta1/{name=projects/*/locations/*}Gets information about a location. | 
| getAgent | GET /v2beta1/{parent=projects/*/locations/*}/agentRetrieves the specified agent. | 
| getEncryptionSpec | GET /v2beta1/{name=projects/*/locations/*/encryptionSpec}Gets location-level encryption key specification. | 
| list | GET /v2beta1/{name=projects/*}/locationsLists information about the supported locations for this service. | 
| setAgent | POST /v2beta1/{agent.parent=projects/*/locations/*}/agentCreates/updates the specified agent. | 
REST Resource: v2beta1.projects.locations.agent
| Methods | |
|---|---|
| export | POST /v2beta1/{parent=projects/*/locations/*}/agent:exportExports the specified agent to a ZIP file. | 
| getFulfillment | GET /v2beta1/{name=projects/*/locations/*/agent/fulfillment}Retrieves the fulfillment. | 
| getValidationResult | GET /v2beta1/{parent=projects/*/locations/*}/agent/validationResultGets agent validation result. | 
| import | POST /v2beta1/{parent=projects/*/locations/*}/agent:importImports the specified agent from a ZIP file. | 
| restore | POST /v2beta1/{parent=projects/*/locations/*}/agent:restoreRestores the specified agent from a ZIP file. | 
| search | GET /v2beta1/{parent=projects/*/locations/*}/agent:searchReturns the list of agents. | 
| train | POST /v2beta1/{parent=projects/*/locations/*}/agent:trainTrains the specified agent. | 
| updateFulfillment | PATCH /v2beta1/{fulfillment.name=projects/*/locations/*/agent/fulfillment}Updates the fulfillment. | 
REST Resource: v2beta1.projects.locations.agent.entityTypes
| Methods | |
|---|---|
| batchDelete | POST /v2beta1/{parent=projects/*/locations/*/agent}/entityTypes:batchDeleteDeletes entity types in the specified agent. | 
| batchUpdate | POST /v2beta1/{parent=projects/*/locations/*/agent}/entityTypes:batchUpdateUpdates/Creates multiple entity types in the specified agent. | 
| create | POST /v2beta1/{parent=projects/*/locations/*/agent}/entityTypesCreates an entity type in the specified agent. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/entityTypes/*}Deletes the specified entity type. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/entityTypes/*}Retrieves the specified entity type. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent}/entityTypesReturns the list of all entity types in the specified agent. | 
| patch | PATCH /v2beta1/{entityType.name=projects/*/locations/*/agent/entityTypes/*}Updates the specified entity type. | 
REST Resource: v2beta1.projects.locations.agent.entityTypes.entities
| Methods | |
|---|---|
| batchCreate | POST /v2beta1/{parent=projects/*/locations/*/agent/entityTypes/*}/entities:batchCreateCreates multiple new entities in the specified entity type. | 
| batchDelete | POST /v2beta1/{parent=projects/*/locations/*/agent/entityTypes/*}/entities:batchDeleteDeletes entities in the specified entity type. | 
| batchUpdate | POST /v2beta1/{parent=projects/*/locations/*/agent/entityTypes/*}/entities:batchUpdateUpdates or creates multiple entities in the specified entity type. | 
REST Resource: v2beta1.projects.locations.agent.environments
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/agent}/environmentsCreates an agent environment. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/environments/*}Deletes the specified agent environment. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/environments/*}Retrieves the specified agent environment. | 
| getHistory | GET /v2beta1/{parent=projects/*/locations/*/agent/environments/*}/historyGets the history of the specified environment. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent}/environmentsReturns the list of all non-draft environments of the specified agent. | 
| patch | PATCH /v2beta1/{environment.name=projects/*/locations/*/agent/environments/*}Updates the specified agent environment. | 
REST Resource: v2beta1.projects.locations.agent.environments.intents
| Methods | |
|---|---|
| list | GET /v2beta1/{parent=projects/*/locations/*/agent/environments/*}/intentsReturns the list of all intents in the specified agent. | 
REST Resource: v2beta1.projects.locations.agent.environments.users.sessions
| Methods | |
|---|---|
| deleteContexts | DELETE /v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/contextsDeletes all active contexts in the specified session. | 
| detectIntent | POST /v2beta1/{session=projects/*/locations/*/agent/environments/*/users/*/sessions/*}:detectIntentProcesses a natural language query and returns structured, actionable data as a result. | 
REST Resource: v2beta1.projects.locations.agent.environments.users.sessions.contexts
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/contextsCreates a context. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/contexts/*}Deletes the specified context. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/contexts/*}Retrieves the specified context. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/contextsReturns the list of all contexts in the specified session. | 
| patch | PATCH /v2beta1/{context.name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/contexts/*}Updates the specified context. | 
REST Resource: v2beta1.projects.locations.agent.environments.users.sessions.entityTypes
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/entityTypesCreates a session entity type. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/entityTypes/*}Deletes the specified session entity type. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/entityTypes/*}Retrieves the specified session entity type. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent/environments/*/users/*/sessions/*}/entityTypesReturns the list of all session entity types in the specified session. | 
| patch | PATCH /v2beta1/{sessionEntityType.name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/entityTypes/*}Updates the specified session entity type. | 
REST Resource: v2beta1.projects.locations.agent.intents
| Methods | |
|---|---|
| batchDelete | POST /v2beta1/{parent=projects/*/locations/*/agent}/intents:batchDeleteDeletes intents in the specified agent. | 
| batchUpdate | POST /v2beta1/{parent=projects/*/locations/*/agent}/intents:batchUpdateUpdates/Creates multiple intents in the specified agent. | 
| create | POST /v2beta1/{parent=projects/*/locations/*/agent}/intentsCreates an intent in the specified agent. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/intents/*}Deletes the specified intent and its direct or indirect followup intents. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/intents/*}Retrieves the specified intent. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent}/intentsReturns the list of all intents in the specified agent. | 
| patch | PATCH /v2beta1/{intent.name=projects/*/locations/*/agent/intents/*}Updates the specified intent. | 
REST Resource: v2beta1.projects.locations.agent.sessions
| Methods | |
|---|---|
| deleteContexts | DELETE /v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/contextsDeletes all active contexts in the specified session. | 
| detectIntent | POST /v2beta1/{session=projects/*/locations/*/agent/sessions/*}:detectIntentProcesses a natural language query and returns structured, actionable data as a result. | 
REST Resource: v2beta1.projects.locations.agent.sessions.contexts
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/contextsCreates a context. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/sessions/*/contexts/*}Deletes the specified context. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/sessions/*/contexts/*}Retrieves the specified context. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/contextsReturns the list of all contexts in the specified session. | 
| patch | PATCH /v2beta1/{context.name=projects/*/locations/*/agent/sessions/*/contexts/*}Updates the specified context. | 
REST Resource: v2beta1.projects.locations.agent.sessions.entityTypes
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/entityTypesCreates a session entity type. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/sessions/*/entityTypes/*}Deletes the specified session entity type. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/sessions/*/entityTypes/*}Retrieves the specified session entity type. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent/sessions/*}/entityTypesReturns the list of all session entity types in the specified session. | 
| patch | PATCH /v2beta1/{sessionEntityType.name=projects/*/locations/*/agent/sessions/*/entityTypes/*}Updates the specified session entity type. | 
REST Resource: v2beta1.projects.locations.agent.versions
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/agent}/versionsCreates an agent version. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/agent/versions/*}Delete the specified agent version. | 
| get | GET /v2beta1/{name=projects/*/locations/*/agent/versions/*}Retrieves the specified agent version. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/agent}/versionsReturns the list of all versions of the specified agent. | 
| patch | PATCH /v2beta1/{version.name=projects/*/locations/*/agent/versions/*}Updates the specified agent version. | 
REST Resource: v2beta1.projects.locations.answerRecords
| Methods | |
|---|---|
| get  | GET /v2beta1/{name=projects/*/locations/*/answerRecords/*}Deprecated. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/answerRecordsReturns the list of all answer records in the specified project in reverse chronological order. | 
| patch | PATCH /v2beta1/{answerRecord.name=projects/*/locations/*/answerRecords/*}Updates the specified answer record. | 
REST Resource: v2beta1.projects.locations.conversationProfiles
| Methods | |
|---|---|
| clearSuggestionFeatureConfig | POST /v2beta1/{conversationProfile=projects/*/locations/*/conversationProfiles/*}:clearSuggestionFeatureConfigClears a suggestion feature from a conversation profile for the given participant role. | 
| create | POST /v2beta1/{parent=projects/*/locations/*}/conversationProfilesCreates a conversation profile in the specified project. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/conversationProfiles/*}Deletes the specified conversation profile. | 
| get | GET /v2beta1/{name=projects/*/locations/*/conversationProfiles/*}Retrieves the specified conversation profile. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/conversationProfilesReturns the list of all conversation profiles in the specified project. | 
| patch | PATCH /v2beta1/{conversationProfile.name=projects/*/locations/*/conversationProfiles/*}Updates the specified conversation profile. | 
| setSuggestionFeatureConfig | POST /v2beta1/{conversationProfile=projects/*/locations/*/conversationProfiles/*}:setSuggestionFeatureConfigAdds or updates a suggestion feature in a conversation profile. | 
REST Resource: v2beta1.projects.locations.conversations
| Methods | |
|---|---|
| complete | POST /v2beta1/{name=projects/*/locations/*/conversations/*}:completeCompletes the specified conversation. | 
| create | POST /v2beta1/{parent=projects/*/locations/*}/conversationsCreates a new conversation. | 
| get | GET /v2beta1/{name=projects/*/locations/*/conversations/*}Retrieves the specific conversation. | 
| ingestContextReferences | POST /v2beta1/{conversation=projects/*/locations/*/conversations/*}:ingestContextReferencesData ingestion API. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/conversationsReturns the list of all conversations in the specified project. | 
REST Resource: v2beta1.projects.locations.conversations.messages
| Methods | |
|---|---|
| batchCreate | POST /v2beta1/{parent=projects/*/locations/*/conversations/*}/messages:batchCreateBatch ingests messages to conversation. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/conversations/*}/messagesLists messages that belong to a given conversation. | 
REST Resource: v2beta1.projects.locations.conversations.participants
| Methods | |
|---|---|
| analyzeContent | POST /v2beta1/{participant=projects/*/locations/*/conversations/*/participants/*}:analyzeContentAdds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. | 
| create | POST /v2beta1/{parent=projects/*/locations/*/conversations/*}/participantsCreates a new participant in a conversation. | 
| get | GET /v2beta1/{name=projects/*/locations/*/conversations/*/participants/*}Retrieves a conversation participant. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/conversations/*}/participantsReturns the list of all participants in the specified conversation. | 
| patch | PATCH /v2beta1/{participant.name=projects/*/locations/*/conversations/*/participants/*}Updates the specified participant. | 
REST Resource: v2beta1.projects.locations.conversations.participants.suggestions
| Methods | |
|---|---|
| suggestArticles | POST /v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestArticlesGets suggested articles for a participant based on specific historical messages. | 
| suggestFaqAnswers | POST /v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestFaqAnswersGets suggested faq answers for a participant based on specific historical messages. | 
| suggestKnowledgeAssist | POST /v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestKnowledgeAssistGets knowledge assist suggestions based on historical messages. | 
| suggestSmartReplies | POST /v2beta1/{parent=projects/*/locations/*/conversations/*/participants/*}/suggestions:suggestSmartRepliesGets smart replies for a participant based on specific historical messages. | 
REST Resource: v2beta1.projects.locations.conversations.suggestions
| Methods | |
|---|---|
| generate | POST /v2beta1/{conversation=projects/*/locations/*/conversations/*}/suggestions:generateGenerates all the suggestions using generators configured in the conversation profile. | 
| searchKnowledge | POST /v2beta1/{conversation=projects/*/locations/*/conversations/*}/suggestions:searchKnowledgeGet answers for the given query based on knowledge documents. | 
| suggestConversationSummary | POST /v2beta1/{conversation=projects/*/locations/*/conversations/*}/suggestions:suggestConversationSummarySuggest summary for a conversation based on specific historical messages. | 
REST Resource: v2beta1.projects.locations.encryptionSpec
| Methods | |
|---|---|
| initialize | POST /v2beta1/{encryptionSpec.name=projects/*/locations/*/encryptionSpec}:initializeInitializes a location-level encryption key specification. | 
REST Resource: v2beta1.projects.locations.generators
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*}/generatorsCreates a generator. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/generators/*}Deletes a generator. | 
| get | GET /v2beta1/{name=projects/*/locations/*/generators/*}Retrieves a generator. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/generatorsLists generators. | 
| patch | PATCH /v2beta1/{generator.name=projects/*/locations/*/generators/*}Updates a generator. | 
REST Resource: v2beta1.projects.locations.generators.evaluations
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/generators/*}/evaluationsCreates evaluation of a generator. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/generators/*/evaluations/*}Deletes an evaluation of generator. | 
| get | GET /v2beta1/{name=projects/*/locations/*/generators/*/evaluations/*}Gets an evaluation of generator. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/generators/*}/evaluationsLists evaluations of generator. | 
REST Resource: v2beta1.projects.locations.knowledgeBases
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*}/knowledgeBasesCreates a knowledge base. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/knowledgeBases/*}Deletes the specified knowledge base. | 
| get | GET /v2beta1/{name=projects/*/locations/*/knowledgeBases/*}Retrieves the specified knowledge base. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/knowledgeBasesReturns the list of all knowledge bases of the specified agent. | 
| patch | PATCH /v2beta1/{knowledgeBase.name=projects/*/locations/*/knowledgeBases/*}Updates the specified knowledge base. | 
REST Resource: v2beta1.projects.locations.knowledgeBases.documents
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documentsCreates a new document. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}Deletes the specified document. | 
| get | GET /v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}Retrieves the specified document. | 
| import | POST /v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documents:importCreate documents by importing data from external sources. | 
| list | GET /v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documentsReturns the list of all documents of the knowledge base. | 
| patch | PATCH /v2beta1/{document.name=projects/*/locations/*/knowledgeBases/*/documents/*}Updates the specified document. | 
| reload | POST /v2beta1/{name=projects/*/locations/*/knowledgeBases/*/documents/*}:reloadReloads the specified document from its specified source, content_uri or content. | 
REST Resource: v2beta1.projects.locations.operations
| Methods | |
|---|---|
| cancel | POST /v2beta1/{name=projects/*/locations/*/operations/*}:cancelStarts asynchronous cancellation on a long-running operation. | 
| get | GET /v2beta1/{name=projects/*/locations/*/operations/*}Gets the latest state of a long-running operation. | 
| list | GET /v2beta1/{name=projects/*/locations/*}/operationsLists operations that match the specified filter in the request. | 
REST Resource: v2beta1.projects.locations.phoneNumbers
| Methods | |
|---|---|
| delete | DELETE /v2beta1/{name=projects/*/locations/*/phoneNumbers/*}Requests deletion of a PhoneNumber. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/phoneNumbersReturns the list of all phone numbers in the specified project. | 
| patch | PATCH /v2beta1/{phoneNumber.name=projects/*/locations/*/phoneNumbers/*}Updates the specified PhoneNumber. | 
| undelete | POST /v2beta1/{name=projects/*/locations/*/phoneNumbers/*}:undeleteCancels the deletion request for a PhoneNumber. | 
REST Resource: v2beta1.projects.locations.sipTrunks
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*}/sipTrunksCreates a SipTrunk for a specified location. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/sipTrunks/*}Deletes a specified SipTrunk. | 
| get | GET /v2beta1/{name=projects/*/locations/*/sipTrunks/*}Retrieves the specified SipTrunk. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/sipTrunksReturns a list of SipTrunks in the specified location. | 
| patch | PATCH /v2beta1/{sipTrunk.name=projects/*/locations/*/sipTrunks/*}Updates the specified SipTrunk. | 
REST Resource: v2beta1.projects.locations.statelessSuggestion
| Methods | |
|---|---|
| generate | POST /v2beta1/{parent=projects/*/locations/*}/statelessSuggestion:generateGenerates and returns a suggestion for a conversation that does not have a resource created for it. | 
REST Resource: v2beta1.projects.locations.suggestions
| Methods | |
|---|---|
| generateStatelessSummary | POST /v2beta1/{statelessConversation.parent=projects/*/locations/*}/suggestions:generateStatelessSummaryGenerates and returns a summary for a conversation that does not have a resource created for it. | 
| searchKnowledge | POST /v2beta1/{parent=projects/*/locations/*}/suggestions:searchKnowledgeGet answers for the given query based on knowledge documents. | 
REST Resource: v2beta1.projects.locations.tools
| Methods | |
|---|---|
| create | POST /v2beta1/{parent=projects/*/locations/*}/toolsCreates a tool. | 
| delete | DELETE /v2beta1/{name=projects/*/locations/*/tools/*}Deletes a tool. | 
| get | GET /v2beta1/{name=projects/*/locations/*/tools/*}Retrieves a tool. | 
| list | GET /v2beta1/{parent=projects/*/locations/*}/toolsLists tools. | 
| patch | PATCH /v2beta1/{tool.name=projects/*/locations/*/tools/*}Updates a tool. | 
REST Resource: v2beta1.projects.operations
| Methods | |
|---|---|
| cancel | POST /v2beta1/{name=projects/*/operations/*}:cancelStarts asynchronous cancellation on a long-running operation. | 
| get | GET /v2beta1/{name=projects/*/operations/*}Gets the latest state of a long-running operation. | 
| list | GET /v2beta1/{name=projects/*}/operationsLists operations that match the specified filter in the request. | 
REST Resource: v2beta1.projects.phoneNumbers
| Methods | |
|---|---|
| delete | DELETE /v2beta1/{name=projects/*/phoneNumbers/*}Requests deletion of a PhoneNumber. | 
| list | GET /v2beta1/{parent=projects/*}/phoneNumbersReturns the list of all phone numbers in the specified project. | 
| patch | PATCH /v2beta1/{phoneNumber.name=projects/*/phoneNumbers/*}Updates the specified PhoneNumber. | 
| undelete | POST /v2beta1/{name=projects/*/phoneNumbers/*}:undeleteCancels the deletion request for a PhoneNumber. | 
REST Resource: v2beta1.projects.suggestions
| Methods | |
|---|---|
| generateStatelessSummary | POST /v2beta1/{statelessConversation.parent=projects/*}/suggestions:generateStatelessSummaryGenerates and returns a summary for a conversation that does not have a resource created for it. | 
| searchKnowledge | POST /v2beta1/{parent=projects/*}/suggestions:searchKnowledgeGet answers for the given query based on knowledge documents. |