blob: 8d84265cea341b152c0de4531b9ca9c449d4385b [file] [log] [blame]
yoshi-code-bot815c1ac2021-11-15 23:24:17 -08001<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="speech_v1.html">Cloud Speech-to-Text API</a> . <a href="speech_v1.projects.html">projects</a> . <a href="speech_v1.projects.locations.html">locations</a> . <a href="speech_v1.projects.locations.customClasses.html">customClasses</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, x__xgafv=None)</a></code></p>
82<p class="firstline">Create a custom class.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Delete a custom class.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Get a custom class.</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">List custom classes.</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, x__xgafv=None)</a></code></p>
97<p class="firstline">Update a custom class.</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, x__xgafv=None)</code>
106 <pre>Create a custom class.
107
108Args:
109 parent: string, Required. The parent resource where this custom class will be created. Format: {api_version}/projects/{project}/locations/{location}/customClasses (required)
110 body: object, The request body.
111 The object takes the form of:
112
113{ # Message sent by the client for the `CreateCustomClass` method.
114 &quot;customClass&quot;: { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases. # Required. The custom class to create.
115 &quot;customClassId&quot;: &quot;A String&quot;, # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
116 &quot;items&quot;: [ # A collection of class items.
117 { # An item of the class.
118 &quot;value&quot;: &quot;A String&quot;, # The class item&#x27;s value.
119 },
120 ],
121 &quot;name&quot;: &quot;A String&quot;, # The resource name of the custom class.
122 },
123 &quot;customClassId&quot;: &quot;A String&quot;, # Required. The ID to use for the custom class, which will become the final component of the custom class&#x27; resource name. This value should be 4-63 characters, and valid characters are /a-z-/.
124}
125
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131Returns:
132 An object of the form:
133
134 { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
135 &quot;customClassId&quot;: &quot;A String&quot;, # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
136 &quot;items&quot;: [ # A collection of class items.
137 { # An item of the class.
138 &quot;value&quot;: &quot;A String&quot;, # The class item&#x27;s value.
139 },
140 ],
141 &quot;name&quot;: &quot;A String&quot;, # The resource name of the custom class.
142}</pre>
143</div>
144
145<div class="method">
146 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
147 <pre>Delete a custom class.
148
149Args:
150 name: string, Required. The name of the custom class to delete. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} (required)
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
159 { # 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 `{}`.
160}</pre>
161</div>
162
163<div class="method">
164 <code class="details" id="get">get(name, x__xgafv=None)</code>
165 <pre>Get a custom class.
166
167Args:
168 name: string, Required. The name of the custom class to retrieve. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} (required)
169 x__xgafv: string, V1 error format.
170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
173
174Returns:
175 An object of the form:
176
177 { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
178 &quot;customClassId&quot;: &quot;A String&quot;, # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
179 &quot;items&quot;: [ # A collection of class items.
180 { # An item of the class.
181 &quot;value&quot;: &quot;A String&quot;, # The class item&#x27;s value.
182 },
183 ],
184 &quot;name&quot;: &quot;A String&quot;, # The resource name of the custom class.
185}</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
190 <pre>List custom classes.
191
192Args:
193 parent: string, Required. The parent, which owns this collection of custom classes. Format: {api_version}/projects/{project}/locations/{location}/customClasses (required)
194 pageSize: integer, The maximum number of custom classes to return. The service may return fewer than this value. If unspecified, at most 50 custom classes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
195 pageToken: string, A page token, received from a previous `ListCustomClass` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomClass` must match the call that provided the page token.
196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201Returns:
202 An object of the form:
203
204 { # Message returned to the client by the `ListCustomClasses` method.
205 &quot;customClasses&quot;: [ # The custom classes.
206 { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
207 &quot;customClassId&quot;: &quot;A String&quot;, # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
208 &quot;items&quot;: [ # A collection of class items.
209 { # An item of the class.
210 &quot;value&quot;: &quot;A String&quot;, # The class item&#x27;s value.
211 },
212 ],
213 &quot;name&quot;: &quot;A String&quot;, # The resource name of the custom class.
214 },
215 ],
216 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
217}</pre>
218</div>
219
220<div class="method">
221 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
222 <pre>Retrieves the next page of results.
223
224Args:
225 previous_request: The request for the previous page. (required)
226 previous_response: The response from the request for the previous page. (required)
227
228Returns:
229 A request object that you can call &#x27;execute()&#x27; on to request the next
230 page. Returns None if there are no more items in the collection.
231 </pre>
232</div>
233
234<div class="method">
235 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
236 <pre>Update a custom class.
237
238Args:
239 name: string, The resource name of the custom class. (required)
240 body: object, The request body.
241 The object takes the form of:
242
243{ # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
244 &quot;customClassId&quot;: &quot;A String&quot;, # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
245 &quot;items&quot;: [ # A collection of class items.
246 { # An item of the class.
247 &quot;value&quot;: &quot;A String&quot;, # The class item&#x27;s value.
248 },
249 ],
250 &quot;name&quot;: &quot;A String&quot;, # The resource name of the custom class.
251}
252
253 updateMask: string, The list of fields to be updated.
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259Returns:
260 An object of the form:
261
262 { # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
263 &quot;customClassId&quot;: &quot;A String&quot;, # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
264 &quot;items&quot;: [ # A collection of class items.
265 { # An item of the class.
266 &quot;value&quot;: &quot;A String&quot;, # The class item&#x27;s value.
267 },
268 ],
269 &quot;name&quot;: &quot;A String&quot;, # The resource name of the custom class.
270}</pre>
271</div>
272
273</body></html>