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