Blame - docs/dyn/dialogflow_v2.projects.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="dialogflow_v2.projects.agent.html">agent()</a></code>

79

</p>

80

<p class="firstline">Returns the agent Resource.</p>

81

82

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

83

<code><a href="dialogflow_v2.projects.locations.html">locations()</a></code>

84

</p>

85

<p class="firstline">Returns the locations Resource.</p>

86

87

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<code><a href="dialogflow_v2.projects.operations.html">operations()</a></code>

89

</p>

90

<p class="firstline">Returns the operations Resource.</p>

91

92

93

<code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p>

94

<p class="firstline">Deletes the specified agent.</p>

95

96

<code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p>

97

<p class="firstline">Retrieves the specified agent.</p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

98

99

<code><a href="#setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Creates/updates the specified agent.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

<h3>Method Details</h3>

102

103

<code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code>

104

<pre>Deletes the specified agent.

105

106

Args:

107

parent: string, Required. The project that the agent to delete is associated with.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

Format: `projects/<Project ID>`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

116

117

{ # A generic empty message that you can re-use to avoid defining duplicated

118

# empty messages in your APIs. A typical example is to use it as the request

119

# or the response type of an API method. For instance:

120

#

121

# service Foo {

122

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

123

# }

124

#

125

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code>

131

<pre>Retrieves the specified agent.

132

133

Args:

134

parent: string, Required. The project that the agent to fetch is associated with.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

135

Format: `projects/<Project ID>`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

136

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

143

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

144

{ # A Dialogflow agent is a virtual agent that handles conversations with your

145

# end-users. It is a natural language understanding module that understands the

146

# nuances of human language. Dialogflow translates end-user text or audio

147

# during a conversation to structured data that your apps and services can

148

# understand. You design and build a Dialogflow agent to handle the types of

149

# conversations required for your system.

150

#

151

# For more information about agents, see the

152

# [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

153

"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See

154

# [Language

155

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

156

# for a list of the currently supported language codes. This field cannot be

157

# set by the `Update` method.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

158

"timeZone": "A String", # Required. The time zone of this agent from the

159

# [time zone database](https://www.iana.org/time-zones), e.g.,

160

# America/New_York, Europe/Paris.

161

"description": "A String", # Optional. The description of this agent.

162

# The maximum length is 500 characters. If exceeded, the request is rejected.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

163

"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in

164

# matched natural language inputs for your agent, you can tune the machine

165

# learning classification threshold. If the returned score value is less than

166

# the threshold value, then a fallback intent will be triggered or, if there

167

# are no fallback intents defined, no intent will be triggered. The score

168

# values range from 0.0 (completely uncertain) to 1.0 (completely certain).

169

# If set to 0.0, the default of 0.3 is used.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

170

"parent": "A String", # Required. The project of this agent.

171

# Format: `projects/<Project ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

172

"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.

173

"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,

174

# V2 API is assumed. Clients are free to query different service endpoints

175

# for different API versions. However, bots connectors and webhook calls will

176

# follow the specified API version.

177

"displayName": "A String", # Required. The name of this agent.

178

"matchMode": "A String", # Optional. Determines how intents are detected from user queries.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

179

"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the

180

# `default_language_code`).

181

"A String",

182

],

183

"avatarUri": "A String", # Optional. The URI of the agent's avatar.

184

# Avatars are used throughout the Dialogflow console and in the self-hosted

185

# [Web

186

# Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)

187

# integration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

188

"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

189

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

<code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code>

194

<pre>Creates/updates the specified agent.

195

196

Args:

197

parent: string, Required. The project of this agent.

198

Format: `projects/<Project ID>`. (required)

199

body: object, The request body.

200

The object takes the form of:

201

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

202

{ # A Dialogflow agent is a virtual agent that handles conversations with your

203

# end-users. It is a natural language understanding module that understands the

204

# nuances of human language. Dialogflow translates end-user text or audio

205

# during a conversation to structured data that your apps and services can

206

# understand. You design and build a Dialogflow agent to handle the types of

207

# conversations required for your system.

208

#

209

# For more information about agents, see the

210

# [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

211

"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See

212

# [Language

213

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

214

# for a list of the currently supported language codes. This field cannot be

215

# set by the `Update` method.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

216

"timeZone": "A String", # Required. The time zone of this agent from the

217

# [time zone database](https://www.iana.org/time-zones), e.g.,

218

# America/New_York, Europe/Paris.

219

"description": "A String", # Optional. The description of this agent.

220

# The maximum length is 500 characters. If exceeded, the request is rejected.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

221

"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in

222

# matched natural language inputs for your agent, you can tune the machine

223

# learning classification threshold. If the returned score value is less than

224

# the threshold value, then a fallback intent will be triggered or, if there

225

# are no fallback intents defined, no intent will be triggered. The score

226

# values range from 0.0 (completely uncertain) to 1.0 (completely certain).

227

# If set to 0.0, the default of 0.3 is used.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

228

"parent": "A String", # Required. The project of this agent.

229

# Format: `projects/<Project ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

230

"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.

231

"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,

232

# V2 API is assumed. Clients are free to query different service endpoints

233

# for different API versions. However, bots connectors and webhook calls will

234

# follow the specified API version.

235

"displayName": "A String", # Required. The name of this agent.

236

"matchMode": "A String", # Optional. Determines how intents are detected from user queries.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

237

"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the

238

# `default_language_code`).

239

"A String",

240

],

241

"avatarUri": "A String", # Optional. The URI of the agent's avatar.

242

# Avatars are used throughout the Dialogflow console and in the self-hosted

243

# [Web

244

# Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)

245

# integration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

246

"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

247

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

248

249

updateMask: string, Optional. The mask to control which fields get updated.

250

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

257

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

258

{ # A Dialogflow agent is a virtual agent that handles conversations with your

259

# end-users. It is a natural language understanding module that understands the

260

# nuances of human language. Dialogflow translates end-user text or audio

261

# during a conversation to structured data that your apps and services can

262

# understand. You design and build a Dialogflow agent to handle the types of

263

# conversations required for your system.

264

#

265

# For more information about agents, see the

266

# [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

267

"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See

268

# [Language

269

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

270

# for a list of the currently supported language codes. This field cannot be

271

# set by the `Update` method.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

272

"timeZone": "A String", # Required. The time zone of this agent from the

273

# [time zone database](https://www.iana.org/time-zones), e.g.,

274

# America/New_York, Europe/Paris.

275

"description": "A String", # Optional. The description of this agent.

276

# The maximum length is 500 characters. If exceeded, the request is rejected.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

277

"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in

278

# matched natural language inputs for your agent, you can tune the machine

279

# learning classification threshold. If the returned score value is less than

280

# the threshold value, then a fallback intent will be triggered or, if there

281

# are no fallback intents defined, no intent will be triggered. The score

282

# values range from 0.0 (completely uncertain) to 1.0 (completely certain).

283

# If set to 0.0, the default of 0.3 is used.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

284

"parent": "A String", # Required. The project of this agent.

285

# Format: `projects/<Project ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

286

"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.

287

"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,

288

# V2 API is assumed. Clients are free to query different service endpoints

289

# for different API versions. However, bots connectors and webhook calls will

290

# follow the specified API version.

291

"displayName": "A String", # Required. The name of this agent.

292

"matchMode": "A String", # Optional. Determines how intents are detected from user queries.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

293

"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the

294

# `default_language_code`).

295

"A String",

296

],

297

"avatarUri": "A String", # Optional. The URI of the agent's avatar.

298

# Avatars are used throughout the Dialogflow console and in the self-hosted

299

# [Web

300

# Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)

301

# integration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

302

"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

303

}</pre>

Bu Sun Kim