Search
|
|||||
|
|
||||
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
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 3 input parameters
| Name | Format | Description |
|---|---|---|
parent Required |
STRING |
Required. The project to list agents from.
Format: |
pageToken |
STRING |
Optional. The next_page_token value returned from a previous list request |
pageSize |
INTEGER |
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000 |
= Parameter name
= Format
|
parent STRING Required Required. The project to list agents from.
Format: |
|
pageToken STRING Optional. The next_page_token value returned from a previous list request |
|
pageSize INTEGER Optional. The maximum number of items to return in a single page. By default 100 and at most 1000 |
Output
This building block provides 14 output parameters
| Name | Format | Description |
|---|---|---|
agents[] |
OBJECT |
Represents a conversational agent |
agents[].description |
STRING |
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected |
agents[].parent |
STRING |
Required. The project of this agent.
Format: |
agents[].supportedLanguageCodes[] |
STRING |
|
agents[].avatarUri |
STRING |
Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration |
agents[].defaultLanguageCode |
STRING |
Required. The default language of the agent as a language tag. See
Language
Support
for a list of the currently supported language codes. This field cannot be
set by the |
agents[].tier |
ENUMERATION |
Optional. The agent tier. If not specified, TIER_STANDARD is assumed |
agents[].displayName |
STRING |
Required. The name of this agent |
agents[].matchMode |
ENUMERATION |
Optional. Determines how intents are detected from user queries |
agents[].enableLogging |
BOOLEAN |
Optional. Determines whether this agent should log conversation queries |
agents[].apiVersion |
ENUMERATION |
Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version |
agents[].classificationThreshold |
FLOAT |
Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used |
agents[].timeZone |
STRING |
Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris |
nextPageToken |
STRING |
Token to retrieve the next page of results, or empty if there are no more results in the list |
= Parameter name
= Format
|
agents[] OBJECT Represents a conversational agent |
|
agents[].description STRING Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected |
|
agents[].parent STRING Required. The project of this agent.
Format: |
|
agents[].supportedLanguageCodes[] STRING |
|
agents[].avatarUri STRING Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration |
|
agents[].defaultLanguageCode STRING Required. The default language of the agent as a language tag. See
Language
Support
for a list of the currently supported language codes. This field cannot be
set by the |
|
agents[].tier ENUMERATION Optional. The agent tier. If not specified, TIER_STANDARD is assumed |
|
agents[].displayName STRING Required. The name of this agent |
|
agents[].matchMode ENUMERATION Optional. Determines how intents are detected from user queries |
|
agents[].enableLogging BOOLEAN Optional. Determines whether this agent should log conversation queries |
|
agents[].apiVersion ENUMERATION Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version |
|
agents[].classificationThreshold FLOAT Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used |
|
agents[].timeZone STRING Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris |
|
nextPageToken STRING Token to retrieve the next page of results, or empty if there are no more results in the list |