Method: projects.locations.agents.entityTypes.get

Retrieves the specified entity type.

HTTP request

GET https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/entityTypes/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the entity type. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

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

  • dialogflow.entityTypes.get

Query parameters

Parameters
languageCode

string

The language to retrieve the entity type for. The following fields are language dependent:

  • EntityType.entities.value
  • EntityType.entities.synonyms
  • EntityType.excluded_phrases.value

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.

Request body

The request body must be empty.

Response body

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

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.