Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / dialogflow_v2.projects.html
blob: f50f48373709e3e81efac2ca76c8e4c862d7832d [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">
83 <code><a href="dialogflow_v2.projects.operations.html">operations()</a></code>
84</p>
85<p class="firstline">Returns the operations Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#deleteAgent">deleteAgent(parent, x__xgafv=None)</a></code></p>
89<p class="firstline">Deletes the specified agent.</p>
90<p class="toc_element">
91 <code><a href="#getAgent">getAgent(parent, x__xgafv=None)</a></code></p>
92<p class="firstline">Retrieves the specified agent.</p>
93<h3>Method Details</h3>
94<div class="method">
95 <code class="details" id="deleteAgent">deleteAgent(parent, x__xgafv=None)</code>
96 <pre>Deletes the specified agent.
97
98Args:
99 parent: string, Required. The project that the agent to delete is associated with.
100Format: `projects/<Project ID>`. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # A generic empty message that you can re-use to avoid defining duplicated
110 # empty messages in your APIs. A typical example is to use it as the request
111 # or the response type of an API method. For instance:
112 #
113 # service Foo {
114 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
115 # }
116 #
117 # The JSON representation for `Empty` is empty JSON object `{}`.
118 }</pre>
119</div>
120
121<div class="method">
122 <code class="details" id="getAgent">getAgent(parent, x__xgafv=None)</code>
123 <pre>Retrieves the specified agent.
124
125Args:
126 parent: string, Required. The project that the agent to fetch is associated with.
127Format: `projects/<Project ID>`. (required)
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
136 { # Represents a conversational agent.
137 "avatarUri": "A String", # Optional. The URI of the agent's avatar.
138 # Avatars are used throughout the Dialogflow console and in the self-hosted
139 # [Web
140 # Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo)
141 # integration.
142 "displayName": "A String", # Required. The name of this agent.
143 "description": "A String", # Optional. The description of this agent.
144 # The maximum length is 500 characters. If exceeded, the request is rejected.
145 "parent": "A String", # Required. The project of this agent.
146 # Format: `projects/<Project ID>`.
147 "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See
148 # [Language
149 # Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
150 # for a list of the currently supported language codes. This field cannot be
151 # set by the `Update` method.
152 "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,
153 # V2 API is assumed. Clients are free to query different service endpoints
154 # for different API versions. However, bots connectors and webhook calls will
155 # follow the specified API version.
156 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
157 "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
158 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the
159 # `default_language_code`).
160 "A String",
161 ],
162 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
163 "timeZone": "A String", # Required. The time zone of this agent from the
164 # [time zone database](https://www.iana.org/time-zones), e.g.,
165 # America/New_York, Europe/Paris.
166 "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in
167 # matched natural language inputs for your agent, you can tune the machine
168 # learning classification threshold. If the returned score value is less than
169 # the threshold value, then a fallback intent will be triggered or, if there
170 # are no fallback intents defined, no intent will be triggered. The score
171 # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
172 # If set to 0.0, the default of 0.3 is used.
173 }</pre>
174</div>
175
176</body></html>