blob: c65f6d92046ba3bff17b100ed634000bdc1d07cb [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<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_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.intents.html">intents</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#create">create(parent, body=None, languageCode=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates an intent in the specified agent.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes the specified intent.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, languageCode=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves the specified intent.</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, intentView=None, languageCode=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Returns the list of all intents in the specified agent.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, languageCode=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates the specified intent.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="create">create(parent, body=None, languageCode=None, x__xgafv=None)</code>
106 <pre>Creates an intent in the specified agent.
107
108Args:
109 parent: string, Required. The agent to create an intent for. Format: `projects//locations//agents/`. (required)
110 body: object, The request body.
111 The object takes the form of:
112
113{ # An intent represents a user&#x27;s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
114 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the intent, unique within the agent.
115 &quot;priority&quot;: 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
116 &quot;isFallback&quot;: True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
117 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
118 &quot;trainingPhrases&quot;: [ # The collection of training phrases the agent is trained on to identify the intent.
119 { # Represents an example that the agent is trained on to identify the intent.
120 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier of the training phrase.
121 &quot;repeatCount&quot;: 42, # Indicates how many times this example was added to the intent.
122 &quot;parts&quot;: [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
123 { # Represents a part of a training phrase.
124 &quot;parameterId&quot;: &quot;A String&quot;, # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
125 &quot;text&quot;: &quot;A String&quot;, # Required. The text for this part.
126 },
127 ],
128 },
129 ],
130 &quot;parameters&quot;: [ # The collection of parameters associated with the intent.
131 { # Represents an intent parameter.
132 &quot;redact&quot;: True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
133 &quot;entityType&quot;: &quot;A String&quot;, # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
134 &quot;id&quot;: &quot;A String&quot;, # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
135 &quot;isList&quot;: True or False, # Indicates whether the parameter represents a list of values.
136 },
137 ],
138}
139
140 languageCode: string, The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` If not specified, the agent&#x27;s default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # An intent represents a user&#x27;s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
150 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the intent, unique within the agent.
151 &quot;priority&quot;: 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
152 &quot;isFallback&quot;: True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
153 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
154 &quot;trainingPhrases&quot;: [ # The collection of training phrases the agent is trained on to identify the intent.
155 { # Represents an example that the agent is trained on to identify the intent.
156 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier of the training phrase.
157 &quot;repeatCount&quot;: 42, # Indicates how many times this example was added to the intent.
158 &quot;parts&quot;: [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
159 { # Represents a part of a training phrase.
160 &quot;parameterId&quot;: &quot;A String&quot;, # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
161 &quot;text&quot;: &quot;A String&quot;, # Required. The text for this part.
162 },
163 ],
164 },
165 ],
166 &quot;parameters&quot;: [ # The collection of parameters associated with the intent.
167 { # Represents an intent parameter.
168 &quot;redact&quot;: True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
169 &quot;entityType&quot;: &quot;A String&quot;, # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
170 &quot;id&quot;: &quot;A String&quot;, # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
171 &quot;isList&quot;: True or False, # Indicates whether the parameter represents a list of values.
172 },
173 ],
174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
179 <pre>Deletes the specified intent.
180
181Args:
182 name: string, Required. The name of the intent to delete. Format: `projects//locations//agents//intents/`. (required)
183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
187
188Returns:
189 An object of the form:
190
191 { # 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 `{}`.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="get">get(name, languageCode=None, x__xgafv=None)</code>
197 <pre>Retrieves the specified intent.
198
199Args:
200 name: string, Required. The name of the intent. Format: `projects//locations//agents//intents/`. (required)
201 languageCode: string, The language to retrieve the intent for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent&#x27;s default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
202 x__xgafv: string, V1 error format.
203 Allowed values
204 1 - v1 error format
205 2 - v2 error format
206
207Returns:
208 An object of the form:
209
210 { # An intent represents a user&#x27;s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
211 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the intent, unique within the agent.
212 &quot;priority&quot;: 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
213 &quot;isFallback&quot;: True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
214 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
215 &quot;trainingPhrases&quot;: [ # The collection of training phrases the agent is trained on to identify the intent.
216 { # Represents an example that the agent is trained on to identify the intent.
217 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier of the training phrase.
218 &quot;repeatCount&quot;: 42, # Indicates how many times this example was added to the intent.
219 &quot;parts&quot;: [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
220 { # Represents a part of a training phrase.
221 &quot;parameterId&quot;: &quot;A String&quot;, # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
222 &quot;text&quot;: &quot;A String&quot;, # Required. The text for this part.
223 },
224 ],
225 },
226 ],
227 &quot;parameters&quot;: [ # The collection of parameters associated with the intent.
228 { # Represents an intent parameter.
229 &quot;redact&quot;: True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
230 &quot;entityType&quot;: &quot;A String&quot;, # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
231 &quot;id&quot;: &quot;A String&quot;, # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
232 &quot;isList&quot;: True or False, # Indicates whether the parameter represents a list of values.
233 },
234 ],
235 }</pre>
236</div>
237
238<div class="method">
239 <code class="details" id="list">list(parent, pageSize=None, intentView=None, languageCode=None, pageToken=None, x__xgafv=None)</code>
240 <pre>Returns the list of all intents in the specified agent.
241
242Args:
243 parent: string, Required. The agent to list all intents for. Format: `projects//locations//agents/`. (required)
244 pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
245 intentView: string, The resource view to apply to the returned intent.
246 Allowed values
247 INTENT_VIEW_UNSPECIFIED - Not specified. Treated as INTENT_VIEW_FULL.
248 INTENT_VIEW_PARTIAL - Training phrases field is not populated in the response.
249 INTENT_VIEW_FULL - All fields are populated.
250 languageCode: string, The language to list intents for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent&#x27;s default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
251 pageToken: string, The next_page_token value returned from a previous list request.
252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
256
257Returns:
258 An object of the form:
259
260 { # The response message for Intents.ListIntents.
261 &quot;intents&quot;: [ # The list of intents. There will be a maximum number of items returned based on the page_size field in the request.
262 { # An intent represents a user&#x27;s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
263 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the intent, unique within the agent.
264 &quot;priority&quot;: 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
265 &quot;isFallback&quot;: True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
266 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
267 &quot;trainingPhrases&quot;: [ # The collection of training phrases the agent is trained on to identify the intent.
268 { # Represents an example that the agent is trained on to identify the intent.
269 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier of the training phrase.
270 &quot;repeatCount&quot;: 42, # Indicates how many times this example was added to the intent.
271 &quot;parts&quot;: [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
272 { # Represents a part of a training phrase.
273 &quot;parameterId&quot;: &quot;A String&quot;, # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
274 &quot;text&quot;: &quot;A String&quot;, # Required. The text for this part.
275 },
276 ],
277 },
278 ],
279 &quot;parameters&quot;: [ # The collection of parameters associated with the intent.
280 { # Represents an intent parameter.
281 &quot;redact&quot;: True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
282 &quot;entityType&quot;: &quot;A String&quot;, # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
283 &quot;id&quot;: &quot;A String&quot;, # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
284 &quot;isList&quot;: True or False, # Indicates whether the parameter represents a list of values.
285 },
286 ],
287 },
288 ],
289 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
290 }</pre>
291</div>
292
293<div class="method">
294 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
295 <pre>Retrieves the next page of results.
296
297Args:
298 previous_request: The request for the previous page. (required)
299 previous_response: The response from the request for the previous page. (required)
300
301Returns:
302 A request object that you can call &#x27;execute()&#x27; on to request the next
303 page. Returns None if there are no more items in the collection.
304 </pre>
305</div>
306
307<div class="method">
308 <code class="details" id="patch">patch(name, body=None, updateMask=None, languageCode=None, x__xgafv=None)</code>
309 <pre>Updates the specified intent.
310
311Args:
312 name: string, The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. (required)
313 body: object, The request body.
314 The object takes the form of:
315
316{ # An intent represents a user&#x27;s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
317 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the intent, unique within the agent.
318 &quot;priority&quot;: 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
319 &quot;isFallback&quot;: True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
320 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
321 &quot;trainingPhrases&quot;: [ # The collection of training phrases the agent is trained on to identify the intent.
322 { # Represents an example that the agent is trained on to identify the intent.
323 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier of the training phrase.
324 &quot;repeatCount&quot;: 42, # Indicates how many times this example was added to the intent.
325 &quot;parts&quot;: [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
326 { # Represents a part of a training phrase.
327 &quot;parameterId&quot;: &quot;A String&quot;, # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
328 &quot;text&quot;: &quot;A String&quot;, # Required. The text for this part.
329 },
330 ],
331 },
332 ],
333 &quot;parameters&quot;: [ # The collection of parameters associated with the intent.
334 { # Represents an intent parameter.
335 &quot;redact&quot;: True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
336 &quot;entityType&quot;: &quot;A String&quot;, # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
337 &quot;id&quot;: &quot;A String&quot;, # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
338 &quot;isList&quot;: True or False, # Indicates whether the parameter represents a list of values.
339 },
340 ],
341}
342
343 updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
344 languageCode: string, The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` If not specified, the agent&#x27;s default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
345 x__xgafv: string, V1 error format.
346 Allowed values
347 1 - v1 error format
348 2 - v2 error format
349
350Returns:
351 An object of the form:
352
353 { # An intent represents a user&#x27;s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
354 &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the intent, unique within the agent.
355 &quot;priority&quot;: 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
356 &quot;isFallback&quot;: True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
357 &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
358 &quot;trainingPhrases&quot;: [ # The collection of training phrases the agent is trained on to identify the intent.
359 { # Represents an example that the agent is trained on to identify the intent.
360 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier of the training phrase.
361 &quot;repeatCount&quot;: 42, # Indicates how many times this example was added to the intent.
362 &quot;parts&quot;: [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.
363 { # Represents a part of a training phrase.
364 &quot;parameterId&quot;: &quot;A String&quot;, # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
365 &quot;text&quot;: &quot;A String&quot;, # Required. The text for this part.
366 },
367 ],
368 },
369 ],
370 &quot;parameters&quot;: [ # The collection of parameters associated with the intent.
371 { # Represents an intent parameter.
372 &quot;redact&quot;: True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.
373 &quot;entityType&quot;: &quot;A String&quot;, # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
374 &quot;id&quot;: &quot;A String&quot;, # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
375 &quot;isList&quot;: True or False, # Indicates whether the parameter represents a list of values.
376 },
377 ],
378 }</pre>
379</div>
380
381</body></html>