1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.locations.html">locations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="dialogflow_v2.projects.locations.agent.html">agent()</a></code> 79</p> 80<p class="firstline">Returns the agent Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="dialogflow_v2.projects.locations.answerRecords.html">answerRecords()</a></code> 84</p> 85<p class="firstline">Returns the answerRecords Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="dialogflow_v2.projects.locations.conversationProfiles.html">conversationProfiles()</a></code> 89</p> 90<p class="firstline">Returns the conversationProfiles Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="dialogflow_v2.projects.locations.conversations.html">conversations()</a></code> 94</p> 95<p class="firstline">Returns the conversations Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="dialogflow_v2.projects.locations.knowledgeBases.html">knowledgeBases()</a></code> 99</p> 100<p class="firstline">Returns the knowledgeBases Resource.</p> 101 102<p class="toc_element"> 103 <code><a href="dialogflow_v2.projects.locations.operations.html">operations()</a></code> 104</p> 105<p class="firstline">Returns the operations Resource.</p> 106 107<p class="toc_element"> 108 <code><a href="#close">close()</a></code></p> 109<p class="firstline">Close httplib2 connections.</p> 110<p class="toc_element"> 111 <code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p> 112<p class="firstline">Deletes the specified agent.</p> 113<p class="toc_element"> 114 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 115<p class="firstline">Gets information about a location.</p> 116<p class="toc_element"> 117 <code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p> 118<p class="firstline">Retrieves the specified agent.</p> 119<p class="toc_element"> 120 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Lists information about the supported locations for this service.</p> 122<p class="toc_element"> 123 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 124<p class="firstline">Retrieves the next page of results.</p> 125<p class="toc_element"> 126 <code><a href="#setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).</p> 128<h3>Method Details</h3> 129<div class="method"> 130 <code class="details" id="close">close()</code> 131 <pre>Close httplib2 connections.</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code> 136 <pre>Deletes the specified agent. 137 138Args: 139 parent: string, Required. The project that the agent to delete is associated with. Format: `projects/`. (required) 140 x__xgafv: string, V1 error format. 141 Allowed values 142 1 - v1 error format 143 2 - v2 error format 144 145Returns: 146 An object of the form: 147 148 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 149}</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="get">get(name, x__xgafv=None)</code> 154 <pre>Gets information about a location. 155 156Args: 157 name: string, Resource name for the location. (required) 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # A resource that represents Google Cloud Platform location. 167 "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". 168 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} 169 "a_key": "A String", 170 }, 171 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. 172 "metadata": { # Service-specific metadata. For example the available capacity at the given location. 173 "a_key": "", # Properties of the object. Contains field @type with type URL. 174 }, 175 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` 176}</pre> 177</div> 178 179<div class="method"> 180 <code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code> 181 <pre>Retrieves the specified agent. 182 183Args: 184 parent: string, Required. The project that the agent to fetch is associated with. Format: `projects/`. (required) 185 x__xgafv: string, V1 error format. 186 Allowed values 187 1 - v1 error format 188 2 - v2 error format 189 190Returns: 191 An object of the form: 192 193 { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). 194 "apiVersion": "A String", # 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. 195 "avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. 196 "classificationThreshold": 3.14, # 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. 197 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. 198 "description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. 199 "displayName": "A String", # Required. The name of this agent. 200 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries. 201 "matchMode": "A String", # Optional. Determines how intents are detected from user queries. 202 "parent": "A String", # Required. The project of this agent. Format: `projects/`. 203 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`). 204 "A String", 205 ], 206 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. 207 "timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. 208}</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 213 <pre>Lists information about the supported locations for this service. 214 215Args: 216 name: string, The resource that owns the locations collection, if applicable. (required) 217 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). 218 pageSize: integer, The maximum number of results to return. If not set, the service selects a default. 219 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. 220 x__xgafv: string, V1 error format. 221 Allowed values 222 1 - v1 error format 223 2 - v2 error format 224 225Returns: 226 An object of the form: 227 228 { # The response message for Locations.ListLocations. 229 "locations": [ # A list of locations that matches the specified filter in the request. 230 { # A resource that represents Google Cloud Platform location. 231 "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". 232 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} 233 "a_key": "A String", 234 }, 235 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. 236 "metadata": { # Service-specific metadata. For example the available capacity at the given location. 237 "a_key": "", # Properties of the object. Contains field @type with type URL. 238 }, 239 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` 240 }, 241 ], 242 "nextPageToken": "A String", # The standard List next-page token. 243}</pre> 244</div> 245 246<div class="method"> 247 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 248 <pre>Retrieves the next page of results. 249 250Args: 251 previous_request: The request for the previous page. (required) 252 previous_response: The response from the request for the previous page. (required) 253 254Returns: 255 A request object that you can call 'execute()' on to request the next 256 page. Returns None if there are no more items in the collection. 257 </pre> 258</div> 259 260<div class="method"> 261 <code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code> 262 <pre>Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training). 263 264Args: 265 parent: string, Required. The project of this agent. Format: `projects/`. (required) 266 body: object, The request body. 267 The object takes the form of: 268 269{ # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). 270 "apiVersion": "A String", # 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. 271 "avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. 272 "classificationThreshold": 3.14, # 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. 273 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. 274 "description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. 275 "displayName": "A String", # Required. The name of this agent. 276 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries. 277 "matchMode": "A String", # Optional. Determines how intents are detected from user queries. 278 "parent": "A String", # Required. The project of this agent. Format: `projects/`. 279 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`). 280 "A String", 281 ], 282 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. 283 "timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. 284} 285 286 updateMask: string, Optional. The mask to control which fields get updated. 287 x__xgafv: string, V1 error format. 288 Allowed values 289 1 - v1 error format 290 2 - v2 error format 291 292Returns: 293 An object of the form: 294 295 { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). 296 "apiVersion": "A String", # 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. 297 "avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. 298 "classificationThreshold": 3.14, # 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. 299 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. 300 "description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. 301 "displayName": "A String", # Required. The name of this agent. 302 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries. 303 "matchMode": "A String", # Optional. Determines how intents are detected from user queries. 304 "parent": "A String", # Required. The project of this agent. Format: `projects/`. 305 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`). 306 "A String", 307 ], 308 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. 309 "timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. 310}</pre> 311</div> 312 313</body></html>