- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Returns the list of all entity types in the specified agent.
HTTP request
GET https://{endpoint}/v3/{parent=projects/*/locations/*/agents/*}/entityTypes
Where {endpoint}
is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The agent to list all entity types for. Format: Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
languageCode |
The language to list entity types for. The following fields are language dependent:
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. |
pageSize |
The maximum number of items to return in a single page. By default 100 and at most 1000. |
pageToken |
The nextPageToken value returned from a previous list request. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
The response message for EntityTypes.ListEntityTypes
.
JSON representation |
---|
{
"entityTypes": [
{
object ( |
Fields | |
---|---|
entityTypes[] |
The list of entity types. There will be a maximum number of items returned based on the pageSize field in the request. |
nextPageToken |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
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.