Namespace Google.Apis.Dialogflow.v2beta1

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.EntityTypesResource.BatchUpdateRequest

Updates/Creates multiple entity types in the specified agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: BatchUpdateEntityTypesResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.EntityTypesResource.CreateRequest

Creates an entity type in the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.EntityTypesResource.DeleteRequest

Deletes the specified entity type. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.EntityTypesResource.EntitiesResource

The "entities" collection of methods.

ProjectsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchCreateRequest

Creates multiple new entities in the specified entity type. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchDeleteRequest

Deletes entities in the specified entity type. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

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. Note: You should always train an agent prior to sending it queries. See the training documentation. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message

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. Note: You should always train an agent prior to sending it queries. See the training documentation.

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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: ExportAgentResponse

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.IntentsResource

The "intents" collection of methods.

ProjectsResource.AgentResource.IntentsResource.BatchDeleteRequest

Deletes intents in the specified agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.IntentsResource.BatchUpdateRequest

Updates/Creates multiple intents in the specified agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: BatchUpdateIntentsResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.IntentsResource.CreateRequest

Creates an intent in the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.IntentsResource.DeleteRequest

Deletes the specified intent and its direct or indirect followup intents. Note: You should always train an agent prior to sending it queries. See the training documentation.

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. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.AgentResource.KnowledgeBasesResource

The "knowledgeBases" collection of methods.

ProjectsResource.AgentResource.KnowledgeBasesResource.CreateRequest

Creates a knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.AgentResource.KnowledgeBasesResource.DeleteRequest

Deletes the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource

The "documents" collection of methods.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.CreateRequest

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: An Empty message Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.GetRequest

Retrieves the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.ListRequest

Returns the list of all documents of the knowledge base. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.AgentResource.KnowledgeBasesResource.DocumentsResource.PatchRequest

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the import_gcs_custom_metadata field is set to true in the request. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.AgentResource.KnowledgeBasesResource.GetRequest

Retrieves the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.AgentResource.KnowledgeBasesResource.ListRequest

Returns the list of all knowledge bases of the specified agent. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.AgentResource.KnowledgeBasesResource.PatchRequest

Updates the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

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.GetRequest

Deprecated. Retrieves a specific answer record.

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.ClearSuggestionFeatureConfigRequest

Clears a suggestion feature from a conversation profile for the given participant role. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ClearSuggestionFeatureConfigOperationMetadata - response: ConversationProfile

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.ConversationProfilesResource.SetSuggestionFeatureConfigRequest

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: SetSuggestionFeatureConfigOperationMetadata - response: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

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.BatchCreateRequest

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

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 &gt; [first item'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.CompileRequest

Deprecated. use SuggestArticles and SuggestFaqAnswers instead. Gets suggestions for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.ListRequest

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01. Retrieves suggestions for live agents. This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds &gt; [first item's create_time of previous request] and empty page_token.

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestArticlesRequest

Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestFaqAnswersRequest

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

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestKnowledgeAssistRequest

Gets knowledge assist suggestions based on historical messages.

ProjectsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestSmartRepliesRequest

Gets smart replies for a participant based on specific historical messages.

ProjectsResource.ConversationsResource.SuggestionsResource

The "suggestions" collection of methods.

ProjectsResource.ConversationsResource.SuggestionsResource.GenerateRequest

Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.

ProjectsResource.ConversationsResource.SuggestionsResource.SearchKnowledgeRequest

Get answers for the given query based on knowledge documents.

ProjectsResource.ConversationsResource.SuggestionsResource.SuggestConversationSummaryRequest

Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

ProjectsResource.DeleteAgentRequest

Deletes the specified agent.

ProjectsResource.GeneratorsResource

The "generators" collection of methods.

ProjectsResource.GeneratorsResource.CreateRequest

Creates a generator.

ProjectsResource.GeneratorsResource.ListRequest

Lists generators.

ProjectsResource.GetAgentRequest

Retrieves the specified agent.

ProjectsResource.KnowledgeBasesResource

The "knowledgeBases" collection of methods.

ProjectsResource.KnowledgeBasesResource.CreateRequest

Creates a knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.KnowledgeBasesResource.DeleteRequest

Deletes the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.KnowledgeBasesResource.DocumentsResource

The "documents" collection of methods.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.CreateRequest

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata

  • response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata

  • response: An Empty message Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.GetRequest

Retrieves the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.ImportRequest

Create documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

ProjectsResource.KnowledgeBasesResource.DocumentsResource.ListRequest

Returns the list of all documents of the knowledge base. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.KnowledgeBasesResource.DocumentsResource.PatchRequest

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata

  • response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the import_gcs_custom_metadata field is set to true in the request. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata

  • response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.KnowledgeBasesResource.GetRequest

Retrieves the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.KnowledgeBasesResource.ListRequest

Returns the list of all knowledge bases of the specified agent. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.KnowledgeBasesResource.PatchRequest

Updates the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.BatchUpdateRequest

Updates/Creates multiple entity types in the specified agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: BatchUpdateEntityTypesResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.CreateRequest

Creates an entity type in the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.DeleteRequest

Deletes the specified entity type. Note: You should always train an agent prior to sending it queries. See the training documentation.

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

ProjectsResource.LocationsResource.AgentResource.EntityTypesResource.EntitiesResource.BatchDeleteRequest

Deletes entities in the specified entity type. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

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. Note: You should always train an agent prior to sending it queries. See the training documentation. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

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. Note: You should always train an agent prior to sending it queries. See the training documentation.

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.IntentsResource

The "intents" collection of methods.

ProjectsResource.LocationsResource.AgentResource.EnvironmentsResource.IntentsResource.ListRequest

Returns the list of all intents in the specified agent.

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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: ExportAgentResponse

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.AgentResource.IntentsResource

The "intents" collection of methods.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.BatchDeleteRequest

Deletes intents in the specified agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.BatchUpdateRequest

Updates/Creates multiple intents in the specified agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: BatchUpdateIntentsResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.CreateRequest

Creates an intent in the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.AgentResource.IntentsResource.DeleteRequest

Deletes the specified intent and its direct or indirect followup intents. Note: You should always train an agent prior to sending it queries. See the training documentation.

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. Note: You should always train an agent prior to sending it queries. See the training documentation.

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. 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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

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.GetRequest

Deprecated. Retrieves a specific answer record.

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.ClearSuggestionFeatureConfigRequest

Clears a suggestion feature from a conversation profile for the given participant role. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ClearSuggestionFeatureConfigOperationMetadata - response: ConversationProfile

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.ConversationProfilesResource.SetSuggestionFeatureConfigRequest

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: SetSuggestionFeatureConfigOperationMetadata - response: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

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.IngestContextReferencesRequest

Data ingestion API. Ingests context references for an existing 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.BatchCreateRequest

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

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 &gt; [first item'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. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestFaqAnswersRequest

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

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestKnowledgeAssistRequest

Gets knowledge assist suggestions based on historical messages.

ProjectsResource.LocationsResource.ConversationsResource.ParticipantsResource.SuggestionsResource.SuggestSmartRepliesRequest

Gets smart replies for a participant based on specific historical messages.

ProjectsResource.LocationsResource.ConversationsResource.SuggestionsResource

The "suggestions" collection of methods.

ProjectsResource.LocationsResource.ConversationsResource.SuggestionsResource.GenerateRequest

Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.

ProjectsResource.LocationsResource.ConversationsResource.SuggestionsResource.SearchKnowledgeRequest

Get answers for the given query based on knowledge documents.

ProjectsResource.LocationsResource.ConversationsResource.SuggestionsResource.SuggestConversationSummaryRequest

Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

ProjectsResource.LocationsResource.DeleteAgentRequest

Deletes the specified agent.

ProjectsResource.LocationsResource.EncryptionSpecResource

The "encryptionSpec" collection of methods.

ProjectsResource.LocationsResource.EncryptionSpecResource.InitializeRequest

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

ProjectsResource.LocationsResource.GeneratorsResource

The "generators" collection of methods.

ProjectsResource.LocationsResource.GeneratorsResource.CreateRequest

Creates a generator.

ProjectsResource.LocationsResource.GeneratorsResource.DeleteRequest

Deletes a generator.

ProjectsResource.LocationsResource.GeneratorsResource.GetRequest

Retrieves a generator.

ProjectsResource.LocationsResource.GeneratorsResource.ListRequest

Lists generators.

ProjectsResource.LocationsResource.GeneratorsResource.PatchRequest

Updates a generator.

ProjectsResource.LocationsResource.GetAgentRequest

Retrieves the specified agent.

ProjectsResource.LocationsResource.GetEncryptionSpecRequest

Gets location-level encryption key specification.

ProjectsResource.LocationsResource.GetRequest

Gets information about a location.

ProjectsResource.LocationsResource.KnowledgeBasesResource

The "knowledgeBases" collection of methods.

ProjectsResource.LocationsResource.KnowledgeBasesResource.CreateRequest

Creates a knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DeleteRequest

Deletes the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource

The "documents" collection of methods.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.CreateRequest

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: An Empty message Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.GetRequest

Retrieves the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.ImportRequest

Create documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.ListRequest

Returns the list of all documents of the knowledge base. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.LocationsResource.KnowledgeBasesResource.DocumentsResource.PatchRequest

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the import_gcs_custom_metadata field is set to true in the request. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

ProjectsResource.LocationsResource.KnowledgeBasesResource.GetRequest

Retrieves the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.LocationsResource.KnowledgeBasesResource.ListRequest

Returns the list of all knowledge bases of the specified agent. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.LocationsResource.KnowledgeBasesResource.PatchRequest

Updates the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

ProjectsResource.LocationsResource.ListRequest

Lists information about the supported locations for this service.

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.

ProjectsResource.LocationsResource.PhoneNumbersResource

The "phoneNumbers" collection of methods.

ProjectsResource.LocationsResource.PhoneNumbersResource.DeleteRequest

Requests deletion of a PhoneNumber. The PhoneNumber is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a PhoneNumber in the ACTIVE state.

ProjectsResource.LocationsResource.PhoneNumbersResource.ListRequest

Returns the list of all phone numbers in the specified project.

ProjectsResource.LocationsResource.PhoneNumbersResource.PatchRequest

Updates the specified PhoneNumber.

ProjectsResource.LocationsResource.PhoneNumbersResource.UndeleteRequest

Cancels the deletion request for a PhoneNumber. This method may only be called on a PhoneNumber in the DELETE_REQUESTED state.

ProjectsResource.LocationsResource.SetAgentRequest

Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.LocationsResource.SipTrunksResource

The "sipTrunks" collection of methods.

ProjectsResource.LocationsResource.SipTrunksResource.CreateRequest

Creates a SipTrunk for a specified location.

ProjectsResource.LocationsResource.SipTrunksResource.DeleteRequest

Deletes a specified SipTrunk.

ProjectsResource.LocationsResource.SipTrunksResource.GetRequest

Retrieves the specified SipTrunk.

ProjectsResource.LocationsResource.SipTrunksResource.ListRequest

Returns a list of SipTrunks in the specified location.

ProjectsResource.LocationsResource.SipTrunksResource.PatchRequest

Updates the specified SipTrunk.

ProjectsResource.LocationsResource.StatelessSuggestionResource

The "statelessSuggestion" collection of methods.

ProjectsResource.LocationsResource.StatelessSuggestionResource.GenerateRequest

Generates and returns a suggestion for a conversation that does not have a resource created for it.

ProjectsResource.LocationsResource.SuggestionsResource

The "suggestions" collection of methods.

ProjectsResource.LocationsResource.SuggestionsResource.GenerateStatelessSummaryRequest

Generates and returns a summary for a conversation that does not have a resource created for it.

ProjectsResource.LocationsResource.SuggestionsResource.SearchKnowledgeRequest

Get answers for the given query based on knowledge documents.

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.

ProjectsResource.PhoneNumbersResource

The "phoneNumbers" collection of methods.

ProjectsResource.PhoneNumbersResource.DeleteRequest

Requests deletion of a PhoneNumber. The PhoneNumber is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a PhoneNumber in the ACTIVE state.

ProjectsResource.PhoneNumbersResource.ListRequest

Returns the list of all phone numbers in the specified project.

ProjectsResource.PhoneNumbersResource.PatchRequest

Updates the specified PhoneNumber.

ProjectsResource.PhoneNumbersResource.UndeleteRequest

Cancels the deletion request for a PhoneNumber. This method may only be called on a PhoneNumber in the DELETE_REQUESTED state.

ProjectsResource.SetAgentRequest

Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation.

ProjectsResource.SuggestionsResource

The "suggestions" collection of methods.

ProjectsResource.SuggestionsResource.GenerateStatelessSummaryRequest

Generates and returns a summary for a conversation that does not have a resource created for it.

ProjectsResource.SuggestionsResource.SearchKnowledgeRequest

Get answers for the given query based on knowledge documents.

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.EnvironmentsResource.IntentsResource.ListRequest.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.