Method: projects.locations.agent.intents.batchUpdate

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:

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

HTTP request

POST https://{endpoint}/v2beta1/{parent=projects/*/locations/*/agent}/intents:batchUpdate

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the agent to update or create intents in. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.intents.batchUpdate

Request body

The request body contains data with the following structure:

JSON representation
{
  "languageCode": string,
  "updateMask": string,
  "intentView": enum (IntentView),

  // Union field intent_batch can be only one of the following:
  "intentBatchUri": string,
  "intentBatchInline": {
    object (IntentBatch)
  }
  // End of list of possible types for union field intent_batch.
}
Fields
languageCode

string

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

string (FieldMask format)

Optional. The mask to control which fields get updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

intentView

enum (IntentView)

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

Union field intent_batch. Required. The source of the intent batch.

For each intent in the batch:

  • If name is specified, we update an existing intent.
  • If name is not specified, we create a new intent. intent_batch can be only one of the following:
intentBatchUri

string

The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

intentBatchInline

object (IntentBatch)

The collection of intents to update or create.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.