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