Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7700bbffda386345cc4426ef413fc643f6368ef4 / . / docs / dyn / dialogflow_v2.projects.html
blob: 3c53618cb39eb4b07b054ec890d6f6ec3f088dc1 [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">
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]83 <code><a href="dialogflow_v2.projects.answerRecords.html">answerRecords()</a></code>
84</p>
85<p class="firstline">Returns the answerRecords Resource.</p>
86
87<p class="toc_element">
88 <code><a href="dialogflow_v2.projects.conversationProfiles.html">conversationProfiles()</a></code>
89</p>
90<p class="firstline">Returns the conversationProfiles Resource.</p>
91
92<p class="toc_element">
93 <code><a href="dialogflow_v2.projects.conversations.html">conversations()</a></code>
94</p>
95<p class="firstline">Returns the conversations Resource.</p>
96
97<p class="toc_element">
98 <code><a href="dialogflow_v2.projects.knowledgeBases.html">knowledgeBases()</a></code>
99</p>
100<p class="firstline">Returns the knowledgeBases Resource.</p>
101
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 <code><a href="dialogflow_v2.projects.locations.html">locations()</a></code>
104</p>
105<p class="firstline">Returns the locations Resource.</p>
106
107<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 <code><a href="dialogflow_v2.projects.operations.html">operations()</a></code>
109</p>
110<p class="firstline">Returns the operations Resource.</p>
111
112<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]113 <code><a href="#close">close()</a></code></p>
114<p class="firstline">Close httplib2 connections.</p>
115<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 <code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p>
117<p class="firstline">Deletes the specified agent.</p>
118<p class="toc_element">
119 <code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p>
120<p class="firstline">Retrieves the specified agent.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121<p class="toc_element">
122 <code><a href="#setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</a></code></p>
123<p class="firstline">Creates/updates the specified agent.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124<h3>Method Details</h3>
125<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 <code class="details" id="close">close()</code>
127 <pre>Close httplib2 connections.</pre>
128</div>
129
130<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 <code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code>
132 <pre>Deletes the specified agent.
133
134Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 parent: string, Required. The project that the agent to delete is associated with. Format: `projects/`. (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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]144 { # 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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]145}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146</div>
147
148<div class="method">
149 <code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code>
150 <pre>Retrieves the specified agent.
151
152Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]153 parent: string, Required. The project that the agent to fetch is associated with. Format: `projects/`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162 { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]163 &quot;apiVersion&quot;: &quot;A String&quot;, # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
164 &quot;avatarUri&quot;: &quot;A String&quot;, # Optional. The URI of the agent&#x27;s avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
165 &quot;classificationThreshold&quot;: 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
166 &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
167 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
168 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of this agent.
169 &quot;enableLogging&quot;: True or False, # Optional. Determines whether this agent should log conversation queries.
170 &quot;matchMode&quot;: &quot;A String&quot;, # Optional. Determines how intents are detected from user queries.
171 &quot;parent&quot;: &quot;A String&quot;, # Required. The project of this agent. Format: `projects/`.
172 &quot;supportedLanguageCodes&quot;: [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
173 &quot;A String&quot;,
174 ],
175 &quot;tier&quot;: &quot;A String&quot;, # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
176 &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
177}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]178</div>
179
180<div class="method">
181 <code class="details" id="setAgent">setAgent(parent, body=None, updateMask=None, x__xgafv=None)</code>
182 <pre>Creates/updates the specified agent.
183
184Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]185 parent: string, Required. The project of this agent. Format: `projects/`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]186 body: object, The request body.
187 The object takes the form of:
188
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]189{ # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]190 &quot;apiVersion&quot;: &quot;A String&quot;, # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
191 &quot;avatarUri&quot;: &quot;A String&quot;, # Optional. The URI of the agent&#x27;s avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
192 &quot;classificationThreshold&quot;: 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
193 &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
194 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
195 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of this agent.
196 &quot;enableLogging&quot;: True or False, # Optional. Determines whether this agent should log conversation queries.
197 &quot;matchMode&quot;: &quot;A String&quot;, # Optional. Determines how intents are detected from user queries.
198 &quot;parent&quot;: &quot;A String&quot;, # Required. The project of this agent. Format: `projects/`.
199 &quot;supportedLanguageCodes&quot;: [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
200 &quot;A String&quot;,
201 ],
202 &quot;tier&quot;: &quot;A String&quot;, # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
203 &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
204}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]205
206 updateMask: string, Optional. The mask to control which fields get updated.
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212Returns:
213 An object of the form:
214
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]215 { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]216 &quot;apiVersion&quot;: &quot;A String&quot;, # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
217 &quot;avatarUri&quot;: &quot;A String&quot;, # Optional. The URI of the agent&#x27;s avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
218 &quot;classificationThreshold&quot;: 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
219 &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
220 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
221 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of this agent.
222 &quot;enableLogging&quot;: True or False, # Optional. Determines whether this agent should log conversation queries.
223 &quot;matchMode&quot;: &quot;A String&quot;, # Optional. Determines how intents are detected from user queries.
224 &quot;parent&quot;: &quot;A String&quot;, # Required. The project of this agent. Format: `projects/`.
225 &quot;supportedLanguageCodes&quot;: [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
226 &quot;A String&quot;,
227 ],
228 &quot;tier&quot;: &quot;A String&quot;, # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
229 &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
230}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231</div>
232
233</body></html>