Batch Update

Updates/Creates multiple entity types in the specified agent

11 variables
11 variables

Updates/Creates multiple entity types in the specified agent.

Operation <response: BatchUpdateEntityTypesResponse>

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View, manage and query your Dialogflow agents

Input

This building block consumes 11 input parameters

  = Parameter name
  = Format

parent STRING Required

Required. The name of the agent to update or create entity types in. Format: projects/<Project ID>/agent

languageCode STRING

Optional. The language of entity synonyms defined in entity_types. 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

updateMask ANY

Optional. The mask to control which fields get updated

entityTypeBatchUri STRING

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

entityTypeBatchInline OBJECT

This message is a wrapper around a collection of entity types

entityTypeBatchInline.entityTypes[] OBJECT

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries

entityTypeBatchInline.entityTypes[].name STRING

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>

entityTypeBatchInline.entityTypes[].displayName STRING

Required. The name of the entity type

entityTypeBatchInline.entityTypes[].kind ENUMERATION

Required. Indicates the kind of entity type

entityTypeBatchInline.entityTypes[].autoExpansionMode ENUMERATION

Optional. Indicates whether the entity type can be automatically expanded

entityTypeBatchInline.entityTypes[].entities[] OBJECT

An entity entry for an associated entity type

Output

This building block provides 11 output parameters

  = Parameter name
  = Format

response OBJECT

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

response.customKey.value ANY

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

name STRING

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}

error OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide

error.code INTEGER

The status code, which should be an enum value of google.rpc.Code

error.message STRING

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client

error.details[] OBJECT

error.details[].customKey.value ANY

metadata OBJECT

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any

metadata.customKey.value ANY

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any

done BOOLEAN

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available