Show / Hide Table of Contents

Namespace Google.Apis.Dialogflow.v2

Classes

DialogflowBaseServiceRequest<TResponse>

A base abstract class for Dialogflow requests.

DialogflowService

The Dialogflow Service.

DialogflowService.Scope

Available OAuth 2.0 scopes for use with the Dialogflow API.

DialogflowService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Dialogflow API.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.AgentResource

The "agent" collection of methods.

ProjectsResource.AgentResource.EntityTypesResource

The "entityTypes" collection of methods.

ProjectsResource.AgentResource.EntityTypesResource.BatchDeleteRequest

Deletes entity types in the specified agent. Operation

ProjectsResource.AgentResource.EntityTypesResource.BatchUpdateRequest

Updates/Creates multiple entity types in the specified agent. Operation

ProjectsResource.AgentResource.EntityTypesResource.CreateRequest

Creates an entity type in the specified agent.

ProjectsResource.AgentResource.EntityTypesResource.DeleteRequest

Deletes the specified entity type.

ProjectsResource.AgentResource.EntityTypesResource.EntitiesResource

The "entities" collection of methods.

ProjectsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchCreateRequest

Creates multiple new entities in the specified entity type. Operation

ProjectsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchDeleteRequest

Deletes entities in the specified entity type. Operation

ProjectsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchUpdateRequest

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation

ProjectsResource.AgentResource.EntityTypesResource.GetRequest

Retrieves the specified entity type.

ProjectsResource.AgentResource.EntityTypesResource.ListRequest

Returns the list of all entity types in the specified agent.

ProjectsResource.AgentResource.EntityTypesResource.PatchRequest

Updates the specified entity type.

ProjectsResource.AgentResource.EnvironmentsResource

The "environments" collection of methods.

ProjectsResource.AgentResource.EnvironmentsResource.CreateRequest

Creates an agent environment.

ProjectsResource.AgentResource.EnvironmentsResource.DeleteRequest

Deletes the specified agent environment.

ProjectsResource.AgentResource.EnvironmentsResource.GetHistoryRequest

Gets the history of the specified environment.

ProjectsResource.AgentResource.EnvironmentsResource.GetRequest

Retrieves the specified agent environment.

ProjectsResource.AgentResource.EnvironmentsResource.IntentsResource

The "intents" collection of methods.

ProjectsResource.AgentResource.EnvironmentsResource.IntentsResource.ListRequest

Returns the list of all intents in the specified agent.

ProjectsResource.AgentResource.EnvironmentsResource.ListRequest

Returns the list of all non-draft environments of the specified agent.

ProjectsResource.AgentResource.EnvironmentsResource.PatchRequest

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 environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource

The "users" collection of methods.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource

The "sessions" collection of methods.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource

The "contexts" collection of methods.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.CreateRequest

Creates a context. If the specified context already exists, overrides the context.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.DeleteRequest

Deletes the specified context.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.GetRequest

Retrieves the specified context.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.ListRequest

Returns the list of all contexts in the specified session.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.PatchRequest

Updates the specified context.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.DeleteContextsRequest

Deletes all active contexts in the specified session.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.DetectIntentRequest

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource

The "entityTypes" collection of methods.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.CreateRequest

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.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.DeleteRequest

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.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.GetRequest

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.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.ListRequest

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.

ProjectsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.PatchRequest

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.

ProjectsResource.AgentResource.ExportRequest

Exports the specified agent to a ZIP file. Operation

ProjectsResource.AgentResource.GetFulfillmentRequest

Retrieves the fulfillment.

ProjectsResource.AgentResource.GetValidationResultRequest

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

ProjectsResource.AgentResource.ImportRequest

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 ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.

ProjectsResource.AgentResource.IntentsResource

The "intents" collection of methods.

ProjectsResource.AgentResource.IntentsResource.BatchDeleteRequest

Deletes intents in the specified agent. Operation

ProjectsResource.AgentResource.IntentsResource.BatchUpdateRequest

Updates/Creates multiple intents in the specified agent. Operation

ProjectsResource.AgentResource.IntentsResource.CreateRequest

Creates an intent in the specified agent.

ProjectsResource.AgentResource.IntentsResource.DeleteRequest

Deletes the specified intent and its direct or indirect followup intents.

ProjectsResource.AgentResource.IntentsResource.GetRequest

Retrieves the specified intent.

ProjectsResource.AgentResource.IntentsResource.ListRequest

Returns the list of all intents in the specified agent.

ProjectsResource.AgentResource.IntentsResource.PatchRequest

Updates the specified intent.

ProjectsResource.AgentResource.KnowledgeBasesResource

The "knowledgeBases" collection of methods.

ProjectsResource.AgentResource.KnowledgeBasesResource.CreateRequest

Creates a knowledge base.

ProjectsResource.AgentResource.KnowledgeBasesResource.DeleteRequest

Deletes the specified knowledge base.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource

The "documents" collection of methods.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.CreateRequest

Creates a new document. Operation

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest

Deletes the specified document. Operation

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.GetRequest

Retrieves the specified document.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.ListRequest

Returns the list of all documents of the knowledge base.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.PatchRequest

Updates the specified document. Operation

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.ReloadRequest

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: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Operation

ProjectsResource.AgentResource.KnowledgeBasesResource.GetRequest

Retrieves the specified knowledge base.

ProjectsResource.AgentResource.KnowledgeBasesResource.ListRequest

Returns the list of all knowledge bases of the specified agent.

ProjectsResource.AgentResource.KnowledgeBasesResource.PatchRequest

Updates the specified knowledge base.

ProjectsResource.AgentResource.RestoreRequest

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 TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.

ProjectsResource.AgentResource.SearchRequest

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.

ProjectsResource.AgentResource.SessionsResource

The "sessions" collection of methods.

ProjectsResource.AgentResource.SessionsResource.ContextsResource

The "contexts" collection of methods.

ProjectsResource.AgentResource.SessionsResource.ContextsResource.CreateRequest

Creates a context. If the specified context already exists, overrides the context.

ProjectsResource.AgentResource.SessionsResource.ContextsResource.DeleteRequest

Deletes the specified context.

ProjectsResource.AgentResource.SessionsResource.ContextsResource.GetRequest

Retrieves the specified context.

ProjectsResource.AgentResource.SessionsResource.ContextsResource.ListRequest

Returns the list of all contexts in the specified session.

ProjectsResource.AgentResource.SessionsResource.ContextsResource.PatchRequest

Updates the specified context.

ProjectsResource.AgentResource.SessionsResource.DeleteContextsRequest

Deletes all active contexts in the specified session.

ProjectsResource.AgentResource.SessionsResource.DetectIntentRequest

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

ProjectsResource.AgentResource.SessionsResource.EntityTypesResource

The "entityTypes" collection of methods.

ProjectsResource.AgentResource.SessionsResource.EntityTypesResource.CreateRequest

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.

ProjectsResource.AgentResource.SessionsResource.EntityTypesResource.DeleteRequest

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.

ProjectsResource.AgentResource.SessionsResource.EntityTypesResource.GetRequest

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.

ProjectsResource.AgentResource.SessionsResource.EntityTypesResource.ListRequest

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.

ProjectsResource.AgentResource.SessionsResource.EntityTypesResource.PatchRequest

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.

ProjectsResource.AgentResource.TrainRequest

Trains the specified agent. Operation

ProjectsResource.AgentResource.UpdateFulfillmentRequest

Updates the fulfillment.

ProjectsResource.AgentResource.VersionsResource

The "versions" collection of methods.

ProjectsResource.AgentResource.VersionsResource.CreateRequest

Creates an agent version. The new version points to the agent instance in the "default" environment.

ProjectsResource.AgentResource.VersionsResource.DeleteRequest

Delete the specified agent version.

ProjectsResource.AgentResource.VersionsResource.GetRequest

Retrieves the specified agent version.

ProjectsResource.AgentResource.VersionsResource.ListRequest

Returns the list of all versions of the specified agent.

ProjectsResource.AgentResource.VersionsResource.PatchRequest

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.

ProjectsResource.AnswerRecordsResource

The "answerRecords" collection of methods.

ProjectsResource.AnswerRecordsResource.ListRequest

Returns the list of all answer records in the specified project in reverse chronological order.

ProjectsResource.AnswerRecordsResource.PatchRequest

Updates the specified answer record.

ProjectsResource.ConversationProfilesResource

The "conversationProfiles" collection of methods.

ProjectsResource.ConversationProfilesResource.CreateRequest

Creates a conversation profile in the specified project. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

ProjectsResource.ConversationProfilesResource.DeleteRequest

Deletes the specified conversation profile.

ProjectsResource.ConversationProfilesResource.GetRequest

Retrieves the specified conversation profile.

ProjectsResource.ConversationProfilesResource.ListRequest

Returns the list of all conversation profiles in the specified project.

ProjectsResource.ConversationProfilesResource.PatchRequest

Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

ProjectsResource.ConversationsResource

The "conversations" collection of methods.

ProjectsResource.ConversationsResource.CompleteRequest

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

ProjectsResource.ConversationsResource.CreateRequest

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 Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.

ProjectsResource.ConversationsResource.GetRequest

Retrieves the specific conversation.

ProjectsResource.ConversationsResource.ListRequest

Returns the list of all conversations in the specified project.

ProjectsResource.ConversationsResource.MessagesResource

The "messages" collection of methods.

ProjectsResource.ConversationsResource.MessagesResource.ListRequest

Lists messages that belong to a given conversation. messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds &amp;gt; [first item&apos;s create_time of previous request] and empty page_token.

ProjectsResource.ConversationsResource.ParticipantsResource

The "participants" collection of methods.

ProjectsResource.ConversationsResource.ParticipantsResource.AnalyzeContentRequest

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.

ProjectsResource.ConversationsResource.ParticipantsResource.CreateRequest

Creates a new participant in a conversation.

ProjectsResource.ConversationsResource.ParticipantsResource.GetRequest

Retrieves a conversation participant.

ProjectsResource.ConversationsResource.ParticipantsResource.ListRequest

Returns the list of all participants in the specified conversation.

ProjectsResource.ConversationsResource.ParticipantsResource.PatchRequest

Updates the specified participant.

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource

The "suggestions" collection of methods.

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestArticlesRequest

Gets suggested articles for a participant based on specific historical messages.

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestFaqAnswersRequest

Gets suggested faq answers for a participant based on specific historical messages.

ProjectsResource.DeleteAgentRequest

Deletes the specified agent.

ProjectsResource.GetAgentRequest

Retrieves the specified agent.

ProjectsResource.KnowledgeBasesResource

The "knowledgeBases" collection of methods.

ProjectsResource.KnowledgeBasesResource.CreateRequest

Creates a knowledge base.

ProjectsResource.KnowledgeBasesResource.DeleteRequest

Deletes the specified knowledge base.

ProjectsResource.KnowledgeBasesResource.DocumentsResource

The "documents" collection of methods.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.CreateRequest

Creates a new document. Operation

ProjectsResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest

Deletes the specified document. Operation

ProjectsResource.KnowledgeBasesResource.DocumentsResource.GetRequest

Retrieves the specified document.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.ListRequest

Returns the list of all documents of the knowledge base.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.PatchRequest

Updates the specified document. Operation

ProjectsResource.KnowledgeBasesResource.DocumentsResource.ReloadRequest

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: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Operation

ProjectsResource.KnowledgeBasesResource.GetRequest

Retrieves the specified knowledge base.

ProjectsResource.KnowledgeBasesResource.ListRequest

Returns the list of all knowledge bases of the specified agent.

ProjectsResource.KnowledgeBasesResource.PatchRequest

Updates the specified knowledge base.

ProjectsResource.LocationsResource

The "locations" collection of methods.

ProjectsResource.LocationsResource.AgentResource

The "agent" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource

The "entityTypes" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.BatchDeleteRequest

Deletes entity types in the specified agent. Operation

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.BatchUpdateRequest

Updates/Creates multiple entity types in the specified agent. Operation

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.CreateRequest

Creates an entity type in the specified agent.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.DeleteRequest

Deletes the specified entity type.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.EntitiesResource

The "entities" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchCreateRequest

Creates multiple new entities in the specified entity type. Operation

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchDeleteRequest

Deletes entities in the specified entity type. Operation

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchUpdateRequest

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.GetRequest

Retrieves the specified entity type.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.ListRequest

Returns the list of all entity types in the specified agent.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.PatchRequest

Updates the specified entity type.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource

The "environments" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.CreateRequest

Creates an agent environment.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.DeleteRequest

Deletes the specified agent environment.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.GetHistoryRequest

Gets the history of the specified environment.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.GetRequest

Retrieves the specified agent environment.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.ListRequest

Returns the list of all non-draft environments of the specified agent.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.PatchRequest

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 environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource

The "users" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource

The "sessions" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource

The "contexts" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.CreateRequest

Creates a context. If the specified context already exists, overrides the context.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.DeleteRequest

Deletes the specified context.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.GetRequest

Retrieves the specified context.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.ListRequest

Returns the list of all contexts in the specified session.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.ContextsResource.PatchRequest

Updates the specified context.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.DeleteContextsRequest

Deletes all active contexts in the specified session.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.DetectIntentRequest

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource

The "entityTypes" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.CreateRequest

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.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.DeleteRequest

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.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.GetRequest

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.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.ListRequest

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.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.UsersResource.SessionsResource.EntityTypesResource.PatchRequest

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.

ProjectsResource.LocationsResource.AgentResource.ExportRequest

Exports the specified agent to a ZIP file. Operation

ProjectsResource.LocationsResource.AgentResource.GetFulfillmentRequest

Retrieves the fulfillment.

ProjectsResource.LocationsResource.AgentResource.GetValidationResultRequest

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

ProjectsResource.LocationsResource.AgentResource.ImportRequest

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 ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.

ProjectsResource.LocationsResource.AgentResource.IntentsResource

The "intents" collection of methods.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.BatchDeleteRequest

Deletes intents in the specified agent. Operation

ProjectsResource.LocationsResource.AgentResource.IntentsResource.BatchUpdateRequest

Updates/Creates multiple intents in the specified agent. Operation

ProjectsResource.LocationsResource.AgentResource.IntentsResource.CreateRequest

Creates an intent in the specified agent.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.DeleteRequest

Deletes the specified intent and its direct or indirect followup intents.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.GetRequest

Retrieves the specified intent.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.ListRequest

Returns the list of all intents in the specified agent.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.PatchRequest

Updates the specified intent.

ProjectsResource.LocationsResource.AgentResource.RestoreRequest

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 TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.

ProjectsResource.LocationsResource.AgentResource.SearchRequest

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.

ProjectsResource.LocationsResource.AgentResource.SessionsResource

The "sessions" collection of methods.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.ContextsResource

The "contexts" collection of methods.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.ContextsResource.CreateRequest

Creates a context. If the specified context already exists, overrides the context.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.ContextsResource.DeleteRequest

Deletes the specified context.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.ContextsResource.GetRequest

Retrieves the specified context.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.ContextsResource.ListRequest

Returns the list of all contexts in the specified session.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.ContextsResource.PatchRequest

Updates the specified context.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.DeleteContextsRequest

Deletes all active contexts in the specified session.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.DetectIntentRequest

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.EntityTypesResource

The "entityTypes" collection of methods.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.EntityTypesResource.CreateRequest

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.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.EntityTypesResource.DeleteRequest

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.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.EntityTypesResource.GetRequest

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.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.EntityTypesResource.ListRequest

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.

ProjectsResource.LocationsResource.AgentResource.SessionsResource.EntityTypesResource.PatchRequest

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.

ProjectsResource.LocationsResource.AgentResource.TrainRequest

Trains the specified agent. Operation

ProjectsResource.LocationsResource.AgentResource.UpdateFulfillmentRequest

Updates the fulfillment.

ProjectsResource.LocationsResource.AgentResource.VersionsResource

The "versions" collection of methods.

ProjectsResource.LocationsResource.AgentResource.VersionsResource.CreateRequest

Creates an agent version. The new version points to the agent instance in the "default" environment.

ProjectsResource.LocationsResource.AgentResource.VersionsResource.DeleteRequest

Delete the specified agent version.

ProjectsResource.LocationsResource.AgentResource.VersionsResource.GetRequest

Retrieves the specified agent version.

ProjectsResource.LocationsResource.AgentResource.VersionsResource.ListRequest

Returns the list of all versions of the specified agent.

ProjectsResource.LocationsResource.AgentResource.VersionsResource.PatchRequest

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.

ProjectsResource.LocationsResource.AnswerRecordsResource

The "answerRecords" collection of methods.

ProjectsResource.LocationsResource.AnswerRecordsResource.ListRequest

Returns the list of all answer records in the specified project in reverse chronological order.

ProjectsResource.LocationsResource.AnswerRecordsResource.PatchRequest

Updates the specified answer record.

ProjectsResource.LocationsResource.ConversationProfilesResource

The "conversationProfiles" collection of methods.

ProjectsResource.LocationsResource.ConversationProfilesResource.CreateRequest

Creates a conversation profile in the specified project. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

ProjectsResource.LocationsResource.ConversationProfilesResource.DeleteRequest

Deletes the specified conversation profile.

ProjectsResource.LocationsResource.ConversationProfilesResource.GetRequest

Retrieves the specified conversation profile.

ProjectsResource.LocationsResource.ConversationProfilesResource.ListRequest

Returns the list of all conversation profiles in the specified project.

ProjectsResource.LocationsResource.ConversationProfilesResource.PatchRequest

Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

ProjectsResource.LocationsResource.ConversationsResource

The "conversations" collection of methods.

ProjectsResource.LocationsResource.ConversationsResource.CompleteRequest

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

ProjectsResource.LocationsResource.ConversationsResource.CreateRequest

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 Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.

ProjectsResource.LocationsResource.ConversationsResource.GetRequest

Retrieves the specific conversation.

ProjectsResource.LocationsResource.ConversationsResource.ListRequest

Returns the list of all conversations in the specified project.

ProjectsResource.LocationsResource.ConversationsResource.MessagesResource

The "messages" collection of methods.

ProjectsResource.LocationsResource.ConversationsResource.MessagesResource.ListRequest

Lists messages that belong to a given conversation. messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds &amp;gt; [first item&apos;s create_time of previous request] and empty page_token.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource

The "participants" collection of methods.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.AnalyzeContentRequest

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.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.CreateRequest

Creates a new participant in a conversation.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.GetRequest

Retrieves a conversation participant.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.ListRequest

Returns the list of all participants in the specified conversation.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.PatchRequest

Updates the specified participant.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.SuggestionsResource

The "suggestions" collection of methods.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestArticlesRequest

Gets suggested articles for a participant based on specific historical messages.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestFaqAnswersRequest

Gets suggested faq answers for a participant based on specific historical messages.

ProjectsResource.LocationsResource.DeleteAgentRequest

Deletes the specified agent.

ProjectsResource.LocationsResource.GetAgentRequest

Retrieves the specified agent.

ProjectsResource.LocationsResource.KnowledgeBasesResource

The "knowledgeBases" collection of methods.

ProjectsResource.LocationsResource.KnowledgeBasesResource.CreateRequest

Creates a knowledge base.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DeleteRequest

Deletes the specified knowledge base.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource

The "documents" collection of methods.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.CreateRequest

Creates a new document. Operation

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest

Deletes the specified document. Operation

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.GetRequest

Retrieves the specified document.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.ListRequest

Returns the list of all documents of the knowledge base.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.PatchRequest

Updates the specified document. Operation

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.ReloadRequest

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: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents. Operation

ProjectsResource.LocationsResource.KnowledgeBasesResource.GetRequest

Retrieves the specified knowledge base.

ProjectsResource.LocationsResource.KnowledgeBasesResource.ListRequest

Returns the list of all knowledge bases of the specified agent.

ProjectsResource.LocationsResource.KnowledgeBasesResource.PatchRequest

Updates the specified knowledge base.

ProjectsResource.LocationsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.OperationsResource.CancelRequest

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

ProjectsResource.LocationsResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.LocationsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as &quot;/v1/{name=users/*}/operations&quot; to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

ProjectsResource.LocationsResource.SetAgentRequest

Creates/updates the specified agent.

ProjectsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.OperationsResource.CancelRequest

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

ProjectsResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as &quot;/v1/{name=users/*}/operations&quot; to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

ProjectsResource.SetAgentRequest

Creates/updates the specified agent.

Enums

DialogflowBaseServiceRequest<TResponse>.AltEnum

Data format for response.

DialogflowBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

ProjectsResource.AgentResource.EnvironmentsResource.IntentsResource.ListRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.AgentResource.IntentsResource.CreateRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.AgentResource.IntentsResource.GetRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.AgentResource.IntentsResource.ListRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.AgentResource.IntentsResource.PatchRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.CreateRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.GetRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.ListRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.PatchRequest.IntentViewEnum

Optional. The resource view to apply to the returned intent.

In This Article
Back to top