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

Bu Sun Kim

715bd7f

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_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

</p>

80

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

81

82

83

<code><a href="dialogflow_v2beta1.projects.knowledgeBases.html">knowledgeBases()</a></code>

84

</p>

85

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

86

87

Dan O'Meara

dd49464

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

[diff] [blame]

88

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

89

</p>

90

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

91

92

Bu Sun Kim

715bd7f

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

[diff] [blame]

93

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

94

</p>

95

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

96

97

98

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

99

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

100

101

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

102

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

Dan O'Meara

dd49464

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

[diff] [blame]

103

104

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

105

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

106

<h3>Method Details</h3>

107

108

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

109

<pre>Deletes the specified agent.

110

111

Args:

112

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

Dan O'Meara

dd49464

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

[diff] [blame]

113

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

114

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

121

122

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

123

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

124

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

125

#

126

# service Foo {

127

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

128

# }

129

#

130

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

}</pre>

</div>

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

136

<pre>Retrieves the specified agent.

137

138

Args:

139

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

Dan O'Meara

dd49464

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

[diff] [blame]

140

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

141

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

148

Bu Sun Kim

d059ad8

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

[diff] [blame]

149

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

150

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

151

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

152

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

153

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

154

# conversations required for your system.

155

#

156

# For more information about agents, see the

157

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

158

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

159

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

160

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

161

# America/New_York, Europe/Paris.

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

# [Language

173

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

174

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

175

# set by the `Update` method.

176

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

177

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

178

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

179

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

180

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

181

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

182

# follow the specified API version.

183

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

184

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

185

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

186

# [Web

187

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

188

# integration.

189

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

190

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

191

# `default_language_code`).

192

"A String",

193

],

194

}</pre>

Dan O'Meara

dd49464

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>

199

<pre>Creates/updates the specified agent.

200

201

Args:

202

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

203

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

204

body: object, The request body.

205

The object takes the form of:

206

Bu Sun Kim

d059ad8

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

[diff] [blame]

207

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

208

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

209

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

210

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

211

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

212

# conversations required for your system.

213

#

214

# For more information about agents, see the

215

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

216

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

217

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

218

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

219

# America/New_York, Europe/Paris.

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

# [Language

231

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

232

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

233

# set by the `Update` method.

234

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

235

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

236

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

237

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

238

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

239

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

240

# follow the specified API version.

241

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

242

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

243

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

244

# [Web

245

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

246

# integration.

247

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

248

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

249

# `default_language_code`).

250

"A String",

251

],

252

}

Dan O'Meara

dd49464

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

[diff] [blame]

253

254

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

255

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

262

Bu Sun Kim

d059ad8

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

[diff] [blame]

263

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

264

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

265

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

266

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

267

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

268

# conversations required for your system.

269

#

270

# For more information about agents, see the

271

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

272

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

273

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

274

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

275

# America/New_York, Europe/Paris.

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

# [Language

287

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

288

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

289

# set by the `Update` method.

290

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

291

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

292

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

293

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

294

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

295

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

296

# follow the specified API version.

297

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

298

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

299

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

300

# [Web

301

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

302

# integration.

303

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

304

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

305

# `default_language_code`).

306

"A String",

307

],

308

}</pre>

Bu Sun Kim

715bd7f

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

[diff] [blame]

309

</div>

310

311

</body></html>