Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dialogflow_v2.projects.html
blob: c27edbc52c6ab76f27d0cdd1969ddb2f01a0c869 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
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<p class="toc_element">
Dan O'Mearadd494642020-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<p class="toc_element">
Bu Sun Kim715bd7f2019-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<p class="toc_element">
93 <code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p>
94<p class="firstline">Deletes the specified agent.</p>
95<p class="toc_element">
96 <code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p>
97<p class="firstline">Retrieves the specified agent.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98<p class="toc_element">
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code>
104 <pre>Deletes the specified agent.
105
106Args:
107 parent: string, Required. The project that the agent to delete is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108Format: `projects/&lt;Project ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 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 `{}`.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code>
131 <pre>Retrieves the specified agent.
132
133Args:
134 parent: string, Required. The project that the agent to fetch is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135Format: `projects/&lt;Project ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 { # Represents a conversational agent.
145 "avatarUri": "A String", # Optional. The URI of the agent's avatar.
146 # Avatars are used throughout the Dialogflow console and in the self-hosted
147 # [Web
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148 # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 # integration.
150 "displayName": "A String", # Required. The name of this agent.
151 "description": "A String", # Optional. The description of this agent.
152 # The maximum length is 500 characters. If exceeded, the request is rejected.
153 "parent": "A String", # Required. The project of this agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 # Format: `projects/&lt;Project ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
156 # [Language
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
158 # for a list of the currently supported language codes. This field cannot be
159 # set by the `Update` method.
160 "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
161 # V2 API is assumed. Clients are free to query different service endpoints
162 # for different API versions. However, bots connectors and webhook calls will
163 # follow the specified API version.
164 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
165 "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
166 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
167 # `default_language_code`).
168 "A String",
169 ],
170 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
171 "timeZone": "A String", # Required. The time zone of this agent from the
172 # [time zone database](https://www.iana.org/time-zones), e.g.,
173 # America/New_York, Europe/Paris.
174 "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
175 # matched natural language inputs for your agent, you can tune the machine
176 # learning classification threshold. If the returned score value is less than
177 # the threshold value, then a fallback intent will be triggered or, if there
178 # are no fallback intents defined, no intent will be triggered. The score
179 # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
180 # If set to 0.0, the default of 0.3 is used.
181 }</pre>
182</div>
183
184<div class="method">
185 <code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code>
186 <pre>Creates/updates the specified agent.
187
188Args:
189 parent: string, Required. The project of this agent.
190Format: `projects/&lt;Project ID&gt;`. (required)
191 body: object, The request body.
192 The object takes the form of:
193
194{ # Represents a conversational agent.
195 "avatarUri": "A String", # Optional. The URI of the agent's avatar.
196 # Avatars are used throughout the Dialogflow console and in the self-hosted
197 # [Web
198 # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
199 # integration.
200 "displayName": "A String", # Required. The name of this agent.
201 "description": "A String", # Optional. The description of this agent.
202 # The maximum length is 500 characters. If exceeded, the request is rejected.
203 "parent": "A String", # Required. The project of this agent.
204 # Format: `projects/&lt;Project ID&gt;`.
205 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
206 # [Language
207 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
208 # for a list of the currently supported language codes. This field cannot be
209 # set by the `Update` method.
210 "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
211 # V2 API is assumed. Clients are free to query different service endpoints
212 # for different API versions. However, bots connectors and webhook calls will
213 # follow the specified API version.
214 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
215 "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
216 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
217 # `default_language_code`).
218 "A String",
219 ],
220 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
221 "timeZone": "A String", # Required. The time zone of this agent from the
222 # [time zone database](https://www.iana.org/time-zones), e.g.,
223 # America/New_York, Europe/Paris.
224 "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
225 # matched natural language inputs for your agent, you can tune the machine
226 # learning classification threshold. If the returned score value is less than
227 # the threshold value, then a fallback intent will be triggered or, if there
228 # are no fallback intents defined, no intent will be triggered. The score
229 # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
230 # If set to 0.0, the default of 0.3 is used.
231 }
232
233 updateMask: string, Optional. The mask to control which fields get updated.
234 x__xgafv: string, V1 error format.
235 Allowed values
236 1 - v1 error format
237 2 - v2 error format
238
239Returns:
240 An object of the form:
241
242 { # Represents a conversational agent.
243 "avatarUri": "A String", # Optional. The URI of the agent's avatar.
244 # Avatars are used throughout the Dialogflow console and in the self-hosted
245 # [Web
246 # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
247 # integration.
248 "displayName": "A String", # Required. The name of this agent.
249 "description": "A String", # Optional. The description of this agent.
250 # The maximum length is 500 characters. If exceeded, the request is rejected.
251 "parent": "A String", # Required. The project of this agent.
252 # Format: `projects/&lt;Project ID&gt;`.
253 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
254 # [Language
255 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 # for a list of the currently supported language codes. This field cannot be
257 # set by the `Update` method.
258 "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
259 # V2 API is assumed. Clients are free to query different service endpoints
260 # for different API versions. However, bots connectors and webhook calls will
261 # follow the specified API version.
262 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
263 "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
264 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
265 # `default_language_code`).
266 "A String",
267 ],
268 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
269 "timeZone": "A String", # Required. The time zone of this agent from the
270 # [time zone database](https://www.iana.org/time-zones), e.g.,
271 # America/New_York, Europe/Paris.
272 "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
273 # matched natural language inputs for your agent, you can tune the machine
274 # learning classification threshold. If the returned score value is less than
275 # the threshold value, then a fallback intent will be triggered or, if there
276 # are no fallback intents defined, no intent will be triggered. The score
277 # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
278 # If set to 0.0, the default of 0.3 is used.
279 }</pre>
280</div>
281
282</body></html>