| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.locations.html">locations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="dialogflow_v2beta1.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_v2beta1.projects.locations.operations.html">operations()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the operations Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p> |
| 89 | <p class="firstline">Deletes the specified agent.</p> |
| 90 | <p class="toc_element"> |
| 91 | <code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p> |
| 92 | <p class="firstline">Retrieves the specified agent.</p> |
| 93 | <p class="toc_element"> |
| 94 | <code><a href="#setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 95 | <p class="firstline">Creates/updates the specified agent.</p> |
| 96 | <h3>Method Details</h3> |
| 97 | <div class="method"> |
| 98 | <code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code> |
| 99 | <pre>Deletes the specified agent. |
| 100 | |
| 101 | Args: |
| 102 | parent: string, Required. The project that the agent to delete is associated with. |
| 103 | Format: `projects/<Project ID>`. (required) |
| 104 | x__xgafv: string, V1 error format. |
| 105 | Allowed values |
| 106 | 1 - v1 error format |
| 107 | 2 - v2 error format |
| 108 | |
| 109 | Returns: |
| 110 | An object of the form: |
| 111 | |
| 112 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 113 | # empty messages in your APIs. A typical example is to use it as the request |
| 114 | # or the response type of an API method. For instance: |
| 115 | # |
| 116 | # service Foo { |
| 117 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 118 | # } |
| 119 | # |
| 120 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 121 | }</pre> |
| 122 | </div> |
| 123 | |
| 124 | <div class="method"> |
| 125 | <code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code> |
| 126 | <pre>Retrieves the specified agent. |
| 127 | |
| 128 | Args: |
| 129 | parent: string, Required. The project that the agent to fetch is associated with. |
| 130 | Format: `projects/<Project ID>`. (required) |
| 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
| 135 | |
| 136 | Returns: |
| 137 | An object of the form: |
| 138 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 139 | { # A Dialogflow agent is a virtual agent that handles conversations with your |
| 140 | # end-users. It is a natural language understanding module that understands the |
| 141 | # nuances of human language. Dialogflow translates end-user text or audio |
| 142 | # during a conversation to structured data that your apps and services can |
| 143 | # understand. You design and build a Dialogflow agent to handle the types of |
| 144 | # conversations required for your system. |
| 145 | # |
| 146 | # For more information about agents, see the |
| 147 | # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). |
| 148 | "displayName": "A String", # Required. The name of this agent. |
| 149 | "timeZone": "A String", # Required. The time zone of this agent from the |
| 150 | # [time zone database](https://www.iana.org/time-zones), e.g., |
| 151 | # America/New_York, Europe/Paris. |
| 152 | "parent": "A String", # Required. The project of this agent. |
| 153 | # Format: `projects/<Project ID>`. |
| 154 | "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in |
| 155 | # matched natural language inputs for your agent, you can tune the machine |
| 156 | # learning classification threshold. If the returned score value is less than |
| 157 | # the threshold value, then a fallback intent will be triggered or, if there |
| 158 | # are no fallback intents defined, no intent will be triggered. The score |
| 159 | # values range from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 160 | # If set to 0.0, the default of 0.3 is used. |
| 161 | "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See |
| 162 | # [Language |
| 163 | # Support](https://cloud.google.com/dialogflow/docs/reference/language) |
| 164 | # for a list of the currently supported language codes. This field cannot be |
| 165 | # set by the `Update` method. |
| 166 | "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries. |
| 167 | "description": "A String", # Optional. The description of this agent. |
| 168 | # The maximum length is 500 characters. If exceeded, the request is rejected. |
| 169 | "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, |
| 170 | # V2 API is assumed. Clients are free to query different service endpoints |
| 171 | # for different API versions. However, bots connectors and webhook calls will |
| 172 | # follow the specified API version. |
| 173 | "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. |
| 174 | "avatarUri": "A String", # Optional. The URI of the agent's avatar. |
| 175 | # Avatars are used throughout the Dialogflow console and in the self-hosted |
| 176 | # [Web |
| 177 | # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) |
| 178 | # integration. |
| 179 | "matchMode": "A String", # Optional. Determines how intents are detected from user queries. |
| 180 | "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the |
| 181 | # `default_language_code`). |
| 182 | "A String", |
| 183 | ], |
| 184 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 185 | </div> |
| 186 | |
| 187 | <div class="method"> |
| 188 | <code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code> |
| 189 | <pre>Creates/updates the specified agent. |
| 190 | |
| 191 | Args: |
| 192 | parent: string, Required. The project of this agent. |
| 193 | Format: `projects/<Project ID>`. (required) |
| 194 | body: object, The request body. |
| 195 | The object takes the form of: |
| 196 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 197 | { # A Dialogflow agent is a virtual agent that handles conversations with your |
| 198 | # end-users. It is a natural language understanding module that understands the |
| 199 | # nuances of human language. Dialogflow translates end-user text or audio |
| 200 | # during a conversation to structured data that your apps and services can |
| 201 | # understand. You design and build a Dialogflow agent to handle the types of |
| 202 | # conversations required for your system. |
| 203 | # |
| 204 | # For more information about agents, see the |
| 205 | # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). |
| 206 | "displayName": "A String", # Required. The name of this agent. |
| 207 | "timeZone": "A String", # Required. The time zone of this agent from the |
| 208 | # [time zone database](https://www.iana.org/time-zones), e.g., |
| 209 | # America/New_York, Europe/Paris. |
| 210 | "parent": "A String", # Required. The project of this agent. |
| 211 | # Format: `projects/<Project ID>`. |
| 212 | "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in |
| 213 | # matched natural language inputs for your agent, you can tune the machine |
| 214 | # learning classification threshold. If the returned score value is less than |
| 215 | # the threshold value, then a fallback intent will be triggered or, if there |
| 216 | # are no fallback intents defined, no intent will be triggered. The score |
| 217 | # values range from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 218 | # If set to 0.0, the default of 0.3 is used. |
| 219 | "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See |
| 220 | # [Language |
| 221 | # Support](https://cloud.google.com/dialogflow/docs/reference/language) |
| 222 | # for a list of the currently supported language codes. This field cannot be |
| 223 | # set by the `Update` method. |
| 224 | "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries. |
| 225 | "description": "A String", # Optional. The description of this agent. |
| 226 | # The maximum length is 500 characters. If exceeded, the request is rejected. |
| 227 | "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, |
| 228 | # V2 API is assumed. Clients are free to query different service endpoints |
| 229 | # for different API versions. However, bots connectors and webhook calls will |
| 230 | # follow the specified API version. |
| 231 | "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. |
| 232 | "avatarUri": "A String", # Optional. The URI of the agent's avatar. |
| 233 | # Avatars are used throughout the Dialogflow console and in the self-hosted |
| 234 | # [Web |
| 235 | # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) |
| 236 | # integration. |
| 237 | "matchMode": "A String", # Optional. Determines how intents are detected from user queries. |
| 238 | "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the |
| 239 | # `default_language_code`). |
| 240 | "A String", |
| 241 | ], |
| 242 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | |
| 244 | updateMask: string, Optional. The mask to control which fields get updated. |
| 245 | x__xgafv: string, V1 error format. |
| 246 | Allowed values |
| 247 | 1 - v1 error format |
| 248 | 2 - v2 error format |
| 249 | |
| 250 | Returns: |
| 251 | An object of the form: |
| 252 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 253 | { # A Dialogflow agent is a virtual agent that handles conversations with your |
| 254 | # end-users. It is a natural language understanding module that understands the |
| 255 | # nuances of human language. Dialogflow translates end-user text or audio |
| 256 | # during a conversation to structured data that your apps and services can |
| 257 | # understand. You design and build a Dialogflow agent to handle the types of |
| 258 | # conversations required for your system. |
| 259 | # |
| 260 | # For more information about agents, see the |
| 261 | # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). |
| 262 | "displayName": "A String", # Required. The name of this agent. |
| 263 | "timeZone": "A String", # Required. The time zone of this agent from the |
| 264 | # [time zone database](https://www.iana.org/time-zones), e.g., |
| 265 | # America/New_York, Europe/Paris. |
| 266 | "parent": "A String", # Required. The project of this agent. |
| 267 | # Format: `projects/<Project ID>`. |
| 268 | "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in |
| 269 | # matched natural language inputs for your agent, you can tune the machine |
| 270 | # learning classification threshold. If the returned score value is less than |
| 271 | # the threshold value, then a fallback intent will be triggered or, if there |
| 272 | # are no fallback intents defined, no intent will be triggered. The score |
| 273 | # values range from 0.0 (completely uncertain) to 1.0 (completely certain). |
| 274 | # If set to 0.0, the default of 0.3 is used. |
| 275 | "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See |
| 276 | # [Language |
| 277 | # Support](https://cloud.google.com/dialogflow/docs/reference/language) |
| 278 | # for a list of the currently supported language codes. This field cannot be |
| 279 | # set by the `Update` method. |
| 280 | "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries. |
| 281 | "description": "A String", # Optional. The description of this agent. |
| 282 | # The maximum length is 500 characters. If exceeded, the request is rejected. |
| 283 | "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, |
| 284 | # V2 API is assumed. Clients are free to query different service endpoints |
| 285 | # for different API versions. However, bots connectors and webhook calls will |
| 286 | # follow the specified API version. |
| 287 | "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. |
| 288 | "avatarUri": "A String", # Optional. The URI of the agent's avatar. |
| 289 | # Avatars are used throughout the Dialogflow console and in the self-hosted |
| 290 | # [Web |
| 291 | # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) |
| 292 | # integration. |
| 293 | "matchMode": "A String", # Optional. Determines how intents are detected from user queries. |
| 294 | "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the |
| 295 | # `default_language_code`). |
| 296 | "A String", |
| 297 | ], |
| 298 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 299 | </div> |
| 300 | |
| 301 | </body></html> |