View Source GoogleApi.Dialogflow.V2.Api.Projects (google_api_dialogflow v0.78.0)

API calls for all endpoints tagged Projects.

Summary

Functions

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.

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.

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

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

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.

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.

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

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

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

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 continues 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 an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

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

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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

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.

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

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

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

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

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

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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

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.

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

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportConversationDataOperationMetadata - response: ImportConversationDataOperationResponse

Returns the list of all conversation datasets in the specified project and location.

Creates a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationModelOperationMetadata - response: ConversationModel

Deletes a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationModelOperationMetadata - response: An Empty message

Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployConversationModelOperationMetadata - response: An Empty message

Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: UndeployConversationModelOperationMetadata - response: An Empty message

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

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.

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

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

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.

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

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.

Returns the list of all conversations in the specified project.

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 > [first item's create_time of previous request] and empty page_token.

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.

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

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

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

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Creates 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

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

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

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

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.

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.

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

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

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.

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.

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

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

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

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 continues 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 an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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

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.

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

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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

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.

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

Creates a new conversation dataset. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationDatasetOperationMetadata - response: ConversationDataset

Deletes the specified conversation dataset. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationDatasetOperationMetadata - response: An Empty message

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportConversationDataOperationMetadata - response: ImportConversationDataOperationResponse

Returns the list of all conversation datasets in the specified project and location.

Creates a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationModelOperationMetadata - response: ConversationModel

Deletes a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationModelOperationMetadata - response: An Empty message

Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployConversationModelOperationMetadata - response: An Empty message

Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: UndeployConversationModelOperationMetadata - response: An Empty message

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

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.

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

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

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.

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

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.

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 > [first item's create_time of previous request] and empty page_token.

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.

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

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

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

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Creates 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

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

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

Lists information about the supported locations for this service.

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.

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.

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

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

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

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.

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.

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

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

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

Functions

Link to this function

dialogflow_projects_agent_entity_types_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to delete all entities types for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to update or create entity types in. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create a entity type for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type to delete. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_entities_batch_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_entities_batch_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the entity type to create entities in. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchCreateEntitiesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_entities_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_entities_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the entity type to delete entries for. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchDeleteEntitiesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_entities_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_entities_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the entity type to update or create entities in. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchUpdateEntitiesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified entity type.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEntityTypesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all entity types from. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEntityTypesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_entity_types_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an agent environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create an environment for. Supported formats: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :environmentId (type: String.t) - Required. The unique id of the new environment.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified agent environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the environment to delete. / Format: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified agent environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_get_history(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_get_history(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EnvironmentHistory.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the history of the specified environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the environment to retrieve history for. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EnvironmentHistory{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_intents_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_intents_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all intents in the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all intents from. Format: projects//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects//locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEnvironmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all environments from. Format: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEnvironmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 continues 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 an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :allowLoadToDraftAndDiscardChanges (type: boolean()) - Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = -).
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_contexts_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_contexts_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a context for. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_contexts_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_contexts_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context to delete. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_contexts_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_contexts_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_contexts_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_contexts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_contexts_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_contexts_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of the context. Format: projects//agent/sessions//contexts/, or projects//agent/environments//users//sessions//contexts/. The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: __system_counters__ *_id_dialog_context `_dialog_params_size`
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_delete_contexts(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_delete_contexts(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes all active contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the session to delete all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_detect_intent(connection, session, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_detect_intent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • session (type: String.t) - Required. The name of the session this query is sent to. Format: projects//agent/sessions/, or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters. For more information, see the API interactions guide. Note: Always use agent versions for production traffic. See Versions and environments.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_entity_types_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a session entity type for. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_entity_types_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type to delete. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_entity_types_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_entity_types_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the session entity type. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_entity_types_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all session entity types from. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_environments_users_sessions_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_environments_users_sessions_entity_types_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. ` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. *optional_params(*type:*keyword()) - Optional parameters *:"$.xgafv"(*type:*String.t) - V1 error format. *:access_token(*type:*String.t) - OAuth access token. *:alt(*type:*String.t) - Data format for response. *:callback(*type:*String.t) - JSONP *:fields(*type:*String.t) - Selector specifying which fields to include in a partial response. *:key(*type:*String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. *:oauth_token(*type:*String.t) - OAuth 2.0 token for the current user. *:prettyPrint(*type:*boolean()) - Returns response with indentations and line breaks. *:quotaUser(*type:*String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. *:uploadType(*type:*String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). *:upload_protocol(*type:*String.t) - Upload protocol for media (e.g. "raw", "multipart"). *:updateMask(*type:*String.t) - Optional. The mask to control which fields get updated. *:body(*type:*GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure
Link to this function

dialogflow_projects_agent_export(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_export(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to export is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ExportAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_get_fulfillment(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_get_fulfillment(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the fulfillment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the fulfillment. Format: projects//agent/fulfillment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_get_validation_result(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_get_validation_result(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ValidationResult.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language for which you want a validation result. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ValidationResult{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_import(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_import(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to import is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ImportAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_intents_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_intents_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to delete all entities types for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchDeleteIntentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_intents_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_intents_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to update or create intents in. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchUpdateIntentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_intents_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_intents_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create a intent for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_intents_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_intents_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects//agent/intents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_intents_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_intents_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified intent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the intent. Format: projects//agent/intents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_intents_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_intents_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all intents in the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all intents from. Format: projects//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects//locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_intents_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_intents_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects//agent/intents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to create a knowledge base for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the knowledge base to delete. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :force (type: boolean()) - Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_documents_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_documents_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to create a document for. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_documents_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_documents_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to delete. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_documents_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_documents_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified document.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to retrieve. Format projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_documents_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_documents_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListDocumentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all documents of the knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to list all documents for. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: knowledge_types with has(:) operator display_name with has(:) operator state with equals(=) operator Examples: "knowledge_types:FAQ" matches documents with FAQ knowledge type. "display_name:customer" matches documents whose display name contains "customer". "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 10 and at most 100.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListDocumentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_documents_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_documents_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_documents_reload(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_documents_reload(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to reload. Format: projects//locations//knowledgeBases//documents/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ReloadDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the knowledge base to retrieve. Format projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListKnowledgeBasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list of knowledge bases for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: display_name with has(:) operator language_code with equals(=) operator Examples: 'language_code=en-us' matches knowledge bases with en-us language code. 'display_name:articles' matches knowledge bases whose display name contains "articles". 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 10 and at most 100.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListKnowledgeBasesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_knowledge_bases_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_knowledge_bases_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_restore(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_restore(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to restore is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2RestoreAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_search(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchAgentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list agents from. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchAgentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_contexts_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_contexts_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a context for. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_contexts_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_contexts_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context to delete. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_contexts_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_contexts_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_contexts_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_contexts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_contexts_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_contexts_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of the context. Format: projects//agent/sessions//contexts/, or projects//agent/environments//users//sessions//contexts/. The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: __system_counters__ *_id_dialog_context `_dialog_params_size`
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_delete_contexts(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_delete_contexts(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes all active contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the session to delete all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_detect_intent(connection, session, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_detect_intent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • session (type: String.t) - Required. The name of the session this query is sent to. Format: projects//agent/sessions/, or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters. For more information, see the API interactions guide. Note: Always use agent versions for production traffic. See Versions and environments.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_entity_types_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a session entity type for. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_entity_types_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type to delete. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_entity_types_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_entity_types_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the session entity type. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_entity_types_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all session entity types from. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_sessions_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_sessions_entity_types_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. ` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. *optional_params(*type:*keyword()) - Optional parameters *:"$.xgafv"(*type:*String.t) - V1 error format. *:access_token(*type:*String.t) - OAuth access token. *:alt(*type:*String.t) - Data format for response. *:callback(*type:*String.t) - JSONP *:fields(*type:*String.t) - Selector specifying which fields to include in a partial response. *:key(*type:*String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. *:oauth_token(*type:*String.t) - OAuth 2.0 token for the current user. *:prettyPrint(*type:*boolean()) - Returns response with indentations and line breaks. *:quotaUser(*type:*String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. *:uploadType(*type:*String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). *:upload_protocol(*type:*String.t) - Upload protocol for media (e.g. "raw", "multipart"). *:updateMask(*type:*String.t) - Optional. The mask to control which fields get updated. *:body(*type:*GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure
Link to this function

dialogflow_projects_agent_train(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_train(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to train is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2TrainAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_update_fulfillment(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_update_fulfillment(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the fulfillment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_versions_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_versions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create a version for. Supported formats: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_versions_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_versions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete the specified agent version.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the version to delete. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_versions_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_versions_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified agent version.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the version. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_versions_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_versions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListVersionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all versions of the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all versions from. Supported formats: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListVersionsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_agent_versions_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_agent_versions_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Output only. The unique identifier of this agent version. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_answer_records_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_answer_records_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListAnswerRecordsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list all answer records for in reverse chronological order. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.
    • :pageToken (type: String.t) - Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListAnswerRecordsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_answer_records_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_answer_records_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnswerRecord.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified answer record.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The unique identifier of this answer record. Format: projects//locations//answerRecords/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnswerRecord.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnswerRecord{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_datasets_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_datasets_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationDataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified conversation dataset.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation dataset to retrieve. Format: projects//locations//conversationDatasets/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationDataset{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_datasets_import_conversation_data(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_datasets_import_conversation_data(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportConversationDataOperationMetadata - response: ImportConversationDataOperationResponse

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Dataset resource name. Format: projects//locations//conversationDatasets/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ImportConversationDataRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_datasets_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_datasets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationDatasetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all conversation datasets in the specified project and location.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project and location name to list all conversation datasets for. Format: projects//locations/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationDatasetsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationModelOperationMetadata - response: ConversationModel

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - The project to create conversation model for. Format: projects/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationModelOperationMetadata - response: An Empty message

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to delete. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_deploy(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_deploy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployConversationModelOperationMetadata - response: An Empty message

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to deploy. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DeployConversationModelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_evaluations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_evaluations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModelEvaluation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an evaluation of conversation model.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model evaluation resource name. Format: projects//conversationModels//evaluations/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModelEvaluation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_evaluations_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_evaluations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelEvaluationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists evaluations of a conversation model.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The conversation model resource name. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelEvaluationsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModel.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets conversation model.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to retrieve. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModel{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists conversation models.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list all conversation models for. Format: projects/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_models_undeploy(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_models_undeploy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: UndeployConversationModelOperationMetadata - response: An Empty message

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to undeploy. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2UndeployConversationModelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_profiles_clear_suggestion_feature_config(connection, conversation_profile, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_profiles_clear_suggestion_feature_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation_profile (type: String.t) - Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ClearSuggestionFeatureConfigRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_profiles_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_profiles_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to create a conversation profile for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_profiles_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_profiles_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified conversation profile.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the conversation profile to delete. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_profiles_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_profiles_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified conversation profile.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the conversation profile. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_profiles_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_profiles_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationProfilesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list all conversation profiles from. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationProfilesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_profiles_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_profiles_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The unique identifier of this conversation profile. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversation_profiles_set_suggestion_feature_config(connection, conversation_profile, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversation_profiles_set_suggestion_feature_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation_profile (type: String.t) - Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SetSuggestionFeatureConfigRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_complete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_complete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource identifier of the conversation to close. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2CompleteConversationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource identifier of the project creating the conversation. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :conversationId (type: String.t) - Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specific conversation.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the conversation. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all conversations in the specified project.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project from which to list all conversation. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either =,!=, >, or <. - To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND). - For clarity, expressions can be enclosed in parentheses. Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations: lifecycle_state = "COMPLETED" For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_messages_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_messages_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListMessagesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 > [first item's create_time of previous request] and empty page_token.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the conversation to list messages for. Format: projects//locations//conversations/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter on message fields. Currently predicates on create_time and create_time_epoch_microseconds are supported. create_time only support milliseconds accuracy. E.g., create_time_epoch_microseconds > 1551790877964485 or create_time > 2017-01-15T01:30:15.01Z. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListMessagesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_analyze_content(connection, participant, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_analyze_content(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnalyzeContentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • participant (type: String.t) - Required. The name of the participant this text comes from. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnalyzeContentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnalyzeContentResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new participant in a conversation.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource identifier of the conversation adding the participant. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a conversation participant.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the participant. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListParticipantsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all participants in the specified conversation.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The conversation to list all participants from. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListParticipantsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified participant.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to specify which fields to update.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_suggestions_suggest_articles(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_suggestions_suggest_articles(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestArticlesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestArticlesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestArticlesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_suggestions_suggest_faq_answers(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_suggestions_suggest_faq_answers(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestFaqAnswersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestFaqAnswersRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestFaqAnswersResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_participants_suggestions_suggest_smart_replies(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_participants_suggestions_suggest_smart_replies(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestSmartRepliesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestSmartRepliesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestSmartRepliesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_suggestions_search_knowledge(connection, conversation, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_suggestions_search_knowledge(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get answers for the given query based on knowledge documents.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation (type: String.t) - The conversation (between human agent and end user) where the search request is triggered. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_conversations_suggestions_suggest_conversation_summary(connection, conversation, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_conversations_suggestions_suggest_conversation_summary(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestConversationSummaryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation (type: String.t) - Required. The conversation to fetch suggestion for. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestConversationSummaryRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestConversationSummaryResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_delete_agent(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_delete_agent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to delete is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_get_agent(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_get_agent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to fetch is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to create a knowledge base for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the knowledge base to delete. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :force (type: boolean()) - Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to create a document for. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to delete. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_export(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_export(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to export. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ExportDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified document.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to retrieve. Format projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_import(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_import(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates 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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to import documents into. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ImportDocumentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListDocumentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all documents of the knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to list all documents for. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: knowledge_types with has(:) operator display_name with has(:) operator state with equals(=) operator Examples: "knowledge_types:FAQ" matches documents with FAQ knowledge type. "display_name:customer" matches documents whose display name contains "customer". "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 10 and at most 100.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListDocumentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_documents_reload(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_documents_reload(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to reload. Format: projects//locations//knowledgeBases//documents/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ReloadDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the knowledge base to retrieve. Format projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListKnowledgeBasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list of knowledge bases for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: display_name with has(:) operator language_code with equals(=) operator Examples: 'language_code=en-us' matches knowledge bases with en-us language code. 'display_name:articles' matches knowledge bases whose display name contains "articles". 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 10 and at most 100.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListKnowledgeBasesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_knowledge_bases_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_knowledge_bases_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to delete all entities types for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to update or create entity types in. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create a entity type for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type to delete. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_entities_batch_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_entities_batch_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the entity type to create entities in. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchCreateEntitiesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_entities_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_entities_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the entity type to delete entries for. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchDeleteEntitiesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_entities_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_entities_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the entity type to update or create entities in. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchUpdateEntitiesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified entity type.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEntityTypesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all entity types from. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEntityTypesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_entity_types_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an agent environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create an environment for. Supported formats: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :environmentId (type: String.t) - Required. The unique id of the new environment.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified agent environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the environment to delete. / Format: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified agent environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_get_history(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_get_history(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EnvironmentHistory.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the history of the specified environment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the environment to retrieve history for. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2EnvironmentHistory{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_intents_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_intents_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all intents in the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all intents from. Format: projects//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects//locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEnvironmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all environments from. Format: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListEnvironmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 continues 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 an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :allowLoadToDraftAndDiscardChanges (type: boolean()) - Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = -).
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Environment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_contexts_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_contexts_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a context for. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_contexts_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_contexts_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context to delete. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_contexts_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_contexts_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_contexts_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_contexts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_contexts_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_contexts_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of the context. Format: projects//agent/sessions//contexts/, or projects//agent/environments//users//sessions//contexts/. The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: __system_counters__ *_id_dialog_context `_dialog_params_size`
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_delete_contexts(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_delete_contexts(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes all active contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the session to delete all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_detect_intent(connection, session, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_detect_intent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • session (type: String.t) - Required. The name of the session this query is sent to. Format: projects//agent/sessions/, or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters. For more information, see the API interactions guide. Note: Always use agent versions for production traffic. See Versions and environments.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_entity_types_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a session entity type for. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_entity_types_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type to delete. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_entity_types_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_entity_types_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the session entity type. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_entity_types_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all session entity types from. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_environments_users_sessions_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_environments_users_sessions_entity_types_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. ` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. *optional_params(*type:*keyword()) - Optional parameters *:"$.xgafv"(*type:*String.t) - V1 error format. *:access_token(*type:*String.t) - OAuth access token. *:alt(*type:*String.t) - Data format for response. *:callback(*type:*String.t) - JSONP *:fields(*type:*String.t) - Selector specifying which fields to include in a partial response. *:key(*type:*String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. *:oauth_token(*type:*String.t) - OAuth 2.0 token for the current user. *:prettyPrint(*type:*boolean()) - Returns response with indentations and line breaks. *:quotaUser(*type:*String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. *:uploadType(*type:*String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). *:upload_protocol(*type:*String.t) - Upload protocol for media (e.g. "raw", "multipart"). *:updateMask(*type:*String.t) - Optional. The mask to control which fields get updated. *:body(*type:*GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure
Link to this function

dialogflow_projects_locations_agent_export(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_export(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to export is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ExportAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_get_fulfillment(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_get_fulfillment(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the fulfillment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the fulfillment. Format: projects//agent/fulfillment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_get_validation_result(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_get_validation_result(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ValidationResult.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - Optional. The language for which you want a validation result. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ValidationResult{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_import(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_import(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to import is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ImportAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_intents_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_intents_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to delete all entities types for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchDeleteIntentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_intents_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_intents_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the agent to update or create intents in. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2BatchUpdateIntentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_intents_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_intents_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create a intent for. Format: projects//agent.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_intents_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_intents_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects//agent/intents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_intents_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_intents_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified intent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the intent. Format: projects//agent/intents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_intents_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_intents_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all intents in the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all intents from. Format: projects//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects//locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListIntentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_intents_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_intents_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects//agent/intents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :intentView (type: String.t) - Optional. The resource view to apply to the returned intent.
    • :languageCode (type: String.t) - Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Intent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_restore(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_restore(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to restore is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2RestoreAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_search(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchAgentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list agents from. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchAgentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_contexts_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_contexts_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a context for. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_contexts_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_contexts_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context to delete. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_contexts_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_contexts_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the context. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_contexts_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_contexts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListContextsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_contexts_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_contexts_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified context.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of the context. Format: projects//agent/sessions//contexts/, or projects//agent/environments//users//sessions//contexts/. The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: __system_counters__ *_id_dialog_context `_dialog_params_size`
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Context{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_delete_contexts(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_delete_contexts(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes all active contexts in the specified session.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the session to delete all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_detect_intent(connection, session, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_detect_intent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • session (type: String.t) - Required. The name of the session this query is sent to. Format: projects//agent/sessions/, or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters. For more information, see the API interactions guide. Note: Always use agent versions for production traffic. See Versions and environments.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DetectIntentResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_entity_types_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to create a session entity type for. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_entity_types_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entity type to delete. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_entity_types_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_entity_types_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the session entity type. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_entity_types_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The session to list all session entity types from. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListSessionEntityTypesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_sessions_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_sessions_entity_types_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. ` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. *optional_params(*type:*keyword()) - Optional parameters *:"$.xgafv"(*type:*String.t) - V1 error format. *:access_token(*type:*String.t) - OAuth access token. *:alt(*type:*String.t) - Data format for response. *:callback(*type:*String.t) - JSONP *:fields(*type:*String.t) - Selector specifying which fields to include in a partial response. *:key(*type:*String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. *:oauth_token(*type:*String.t) - OAuth 2.0 token for the current user. *:prettyPrint(*type:*boolean()) - Returns response with indentations and line breaks. *:quotaUser(*type:*String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. *:uploadType(*type:*String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). *:upload_protocol(*type:*String.t) - Upload protocol for media (e.g. "raw", "multipart"). *:updateMask(*type:*String.t) - Optional. The mask to control which fields get updated. *:body(*type:*GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SessionEntityType.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure
Link to this function

dialogflow_projects_locations_agent_train(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_train(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to train is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2TrainAgentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_update_fulfillment(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_update_fulfillment(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the fulfillment.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Fulfillment{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_versions_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_versions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to create a version for. Supported formats: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_versions_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_versions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete the specified agent version.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the version to delete. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_versions_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_versions_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified agent version.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the version. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_versions_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_versions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListVersionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all versions of the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The agent to list all versions from. Supported formats: - projects//agent - projects//locations//agent
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListVersionsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_agent_versions_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_agent_versions_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Output only. The unique identifier of this agent version. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Version{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_answer_records_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_answer_records_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListAnswerRecordsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list all answer records for in reverse chronological order. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.
    • :pageToken (type: String.t) - Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListAnswerRecordsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_answer_records_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_answer_records_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnswerRecord.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified answer record.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The unique identifier of this answer record. Format: projects//locations//answerRecords/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnswerRecord.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnswerRecord{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_datasets_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_datasets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new conversation dataset. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationDatasetOperationMetadata - response: ConversationDataset

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to create conversation dataset for. Format: projects//locations/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationDataset.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_datasets_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_datasets_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified conversation dataset. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationDatasetOperationMetadata - response: An Empty message

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation dataset to delete. Format: projects//locations//conversationDatasets/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_datasets_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_datasets_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationDataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified conversation dataset.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation dataset to retrieve. Format: projects//locations//conversationDatasets/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationDataset{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_datasets_import_conversation_data(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_datasets_import_conversation_data(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportConversationDataOperationMetadata - response: ImportConversationDataOperationResponse

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Dataset resource name. Format: projects//locations//conversationDatasets/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ImportConversationDataRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_datasets_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_datasets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationDatasetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all conversation datasets in the specified project and location.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project and location name to list all conversation datasets for. Format: projects//locations/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationDatasetsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationModelOperationMetadata - response: ConversationModel

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - The project to create conversation model for. Format: projects/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationModelOperationMetadata - response: An Empty message

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to delete. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_deploy(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_deploy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployConversationModelOperationMetadata - response: An Empty message

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to deploy. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2DeployConversationModelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_evaluations_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_evaluations_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates evaluation of a conversation model.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The conversation model resource name. Format: projects//locations//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2CreateConversationModelEvaluationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_evaluations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_evaluations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModelEvaluation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an evaluation of conversation model.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model evaluation resource name. Format: projects//conversationModels//evaluations/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModelEvaluation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_evaluations_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_evaluations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelEvaluationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists evaluations of a conversation model.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The conversation model resource name. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelEvaluationsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModel.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets conversation model.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to retrieve. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationModel{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists conversation models.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list all conversation models for. Format: projects/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationModelsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_models_undeploy(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_models_undeploy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: UndeployConversationModelOperationMetadata - response: An Empty message

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The conversation model to undeploy. Format: projects//conversationModels/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2UndeployConversationModelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_profiles_clear_suggestion_feature_config(connection, conversation_profile, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_profiles_clear_suggestion_feature_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation_profile (type: String.t) - Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ClearSuggestionFeatureConfigRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_profiles_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_profiles_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to create a conversation profile for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_profiles_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_profiles_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified conversation profile.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the conversation profile to delete. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_profiles_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_profiles_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified conversation profile.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the conversation profile. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_profiles_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_profiles_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationProfilesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list all conversation profiles from. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationProfilesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_profiles_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_profiles_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The unique identifier of this conversation profile. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to control which fields to update.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ConversationProfile{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversation_profiles_set_suggestion_feature_config(connection, conversation_profile, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversation_profiles_set_suggestion_feature_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation_profile (type: String.t) - Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SetSuggestionFeatureConfigRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_complete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_complete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource identifier of the conversation to close. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2CompleteConversationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource identifier of the project creating the conversation. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :conversationId (type: String.t) - Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specific conversation.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the conversation. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Conversation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all conversations in the specified project.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project from which to list all conversation. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either =,!=, >, or <. - To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND). - For clarity, expressions can be enclosed in parentheses. Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations: lifecycle_state = "COMPLETED" For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListConversationsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_messages_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_messages_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListMessagesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 > [first item's create_time of previous request] and empty page_token.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the conversation to list messages for. Format: projects//locations//conversations/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter on message fields. Currently predicates on create_time and create_time_epoch_microseconds are supported. create_time only support milliseconds accuracy. E.g., create_time_epoch_microseconds > 1551790877964485 or create_time > 2017-01-15T01:30:15.01Z. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListMessagesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_analyze_content(connection, participant, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_analyze_content(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnalyzeContentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • participant (type: String.t) - Required. The name of the participant this text comes from. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnalyzeContentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2AnalyzeContentResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new participant in a conversation.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource identifier of the conversation adding the participant. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a conversation participant.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the participant. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListParticipantsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all participants in the specified conversation.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The conversation to list all participants from. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListParticipantsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified participant.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The mask to specify which fields to update.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Participant{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_suggestions_suggest_articles(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_suggestions_suggest_articles(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestArticlesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestArticlesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestArticlesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_suggestions_suggest_faq_answers(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_suggestions_suggest_faq_answers(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestFaqAnswersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestFaqAnswersRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestFaqAnswersResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_participants_suggestions_suggest_smart_replies(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_participants_suggestions_suggest_smart_replies(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestSmartRepliesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestSmartRepliesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestSmartRepliesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_suggestions_search_knowledge(connection, conversation, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_suggestions_search_knowledge(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get answers for the given query based on knowledge documents.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation (type: String.t) - The conversation (between human agent and end user) where the search request is triggered. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_conversations_suggestions_suggest_conversation_summary(connection, conversation, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_conversations_suggestions_suggest_conversation_summary(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestConversationSummaryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • conversation (type: String.t) - Required. The conversation to fetch suggestion for. Format: projects//locations//conversations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestConversationSummaryRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SuggestConversationSummaryResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_delete_agent(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_delete_agent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to delete is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudLocationLocation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about a location.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Resource name for the location.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudLocationLocation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_get_agent(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_get_agent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified agent.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project that the agent to fetch is associated with. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to create a knowledge base for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the knowledge base to delete. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :force (type: boolean()) - Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to create a document for. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to delete. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_export(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_export(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to export. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ExportDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified document.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to retrieve. Format projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_import(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_import(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates 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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to import documents into. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ImportDocumentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListDocumentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all documents of the knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The knowledge base to list all documents for. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: knowledge_types with has(:) operator display_name with has(:) operator state with equals(=) operator Examples: "knowledge_types:FAQ" matches documents with FAQ knowledge type. "display_name:customer" matches documents whose display name contains "customer". "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 10 and at most 100.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListDocumentsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Document.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_documents_reload(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_documents_reload(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to reload. Format: projects//locations//knowledgeBases//documents/
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ReloadDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the knowledge base to retrieve. Format projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListKnowledgeBasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to list of knowledge bases for. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: display_name with has(:) operator language_code with equals(=) operator Examples: 'language_code=en-us' matches knowledge bases with en-us language code. 'display_name:articles' matches knowledge bases whose display name contains "articles". 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.
    • :pageSize (type: integer()) - The maximum number of items to return in a single page. By default 10 and at most 100.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2ListKnowledgeBasesResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_knowledge_bases_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_knowledge_bases_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified knowledge base.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects//locations//knowledgeBases/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2KnowledgeBase{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudLocationListLocationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists information about the supported locations for this service.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The resource that owns the locations collection, if applicable.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
    • :pageSize (type: integer()) - The maximum number of results to return. If not set, the service selects a default.
    • :pageToken (type: String.t) - A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudLocationListLocationsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource to be cancelled.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_operations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleLongrunningListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation's parent resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The standard list filter.
    • :pageSize (type: integer()) - The standard list page size.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningListOperationsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_set_agent(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_set_agent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project of this agent. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_suggestions_generate_stateless_summary(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_suggestions_generate_stateless_summary(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2GenerateStatelessSummaryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource to charge for the Summary's generation. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2GenerateStatelessSummaryRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2GenerateStatelessSummaryResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_locations_suggestions_search_knowledge(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_locations_suggestions_search_knowledge(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get answers for the given query based on knowledge documents.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - The parent resource contains the conversation profile Format: 'projects/' or projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource to be cancelled.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_operations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_operations_list(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_operations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleLongrunningListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation's parent resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The standard list filter.
    • :pageSize (type: integer()) - The standard list page size.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleLongrunningListOperationsResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_set_agent(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_set_agent(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project of this agent. Format: projects/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields get updated.
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2Agent{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_suggestions_generate_stateless_summary(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_suggestions_generate_stateless_summary(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2GenerateStatelessSummaryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource to charge for the Summary's generation. Format: projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2GenerateStatelessSummaryRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2GenerateStatelessSummaryResponse{}} on success
  • {:error, info} on failure
Link to this function

dialogflow_projects_suggestions_search_knowledge(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec dialogflow_projects_suggestions_search_knowledge(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get answers for the given query based on knowledge documents.

Parameters

  • connection (type: GoogleApi.Dialogflow.V2.Connection.t) - Connection to server
  • parent (type: String.t) - The parent resource contains the conversation profile Format: 'projects/' or projects//locations/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeResponse{}} on success
  • {:error, info} on failure