/
azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.yml
251 lines (238 loc) · 8.13 KB
/
azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
### YamlMime:PythonClass
uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations
name: ListManagementTermListsOperations
fullName: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations
module: azure.cognitiveservices.vision.contentmoderator.operations
inheritances:
- builtins.object
summary: ListManagementTermListsOperations operations.
constructor:
syntax: ListManagementTermListsOperations(client, config, serializer, deserializer)
parameters:
- name: client
description: Client for service requests.
isRequired: true
- name: config
description: Configuration of service client.
isRequired: true
- name: serializer
description: An object model serializer.
isRequired: true
- name: deserializer
description: An object model deserializer.
isRequired: true
methods:
- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.create
name: create
summary: Creates a Term List.
signature: create(content_type, body, custom_headers=None, raw=False, **operation_config)
parameters:
- name: content_type
description: The content type.
isRequired: true
types:
- <xref:str>
- name: body
description: Schema of the body.
isRequired: true
types:
- <xref:azure.cognitiveservices.vision.contentmoderator.models.Body>
- name: custom_headers
description: headers that will be added to the request
defaultValue: None
types:
- <xref:dict>
- name: raw
description: 'returns the direct response alongside the
deserialized response'
defaultValue: 'False'
types:
- <xref:bool>
- name: operation_config
description: '*Operation configuration
overrides*.'
isRequired: true
return:
description: TermList or ClientRawResponse if raw=true
types:
- <xref:azure.cognitiveservices.vision.contentmoderator.models.TermList>
- <xref:msrest.pipeline.ClientRawResponse>
exceptions:
- type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException
- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.delete
name: delete
summary: Deletes term list with the list Id equal to list Id passed.
signature: delete(list_id, custom_headers=None, raw=False, **operation_config)
parameters:
- name: list_id
description: List Id of the image list.
isRequired: true
types:
- <xref:str>
- name: custom_headers
description: headers that will be added to the request
defaultValue: None
types:
- <xref:dict>
- name: raw
description: 'returns the direct response alongside the
deserialized response'
defaultValue: 'False'
types:
- <xref:bool>
- name: operation_config
description: '*Operation configuration
overrides*.'
isRequired: true
return:
description: str or ClientRawResponse if raw=true
types:
- <xref:str>
- <xref:msrest.pipeline.ClientRawResponse>
exceptions:
- type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException
- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.get_all_term_lists
name: get_all_term_lists
summary: gets all the Term Lists.
signature: get_all_term_lists(custom_headers=None, raw=False, **operation_config)
parameters:
- name: custom_headers
description: headers that will be added to the request
defaultValue: None
types:
- <xref:dict>
- name: raw
description: 'returns the direct response alongside the
deserialized response'
defaultValue: 'False'
types:
- <xref:bool>
- name: operation_config
description: '*Operation configuration
overrides*.'
isRequired: true
return:
description: list or ClientRawResponse if raw=true
types:
- <xref:list>[<xref:azure.cognitiveservices.vision.contentmoderator.models.TermList>]
- <xref:msrest.pipeline.ClientRawResponse>
exceptions:
- type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException
- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.get_details
name: get_details
summary: 'Returns list Id details of the term list with list Id equal to list Id
passed.'
signature: get_details(list_id, custom_headers=None, raw=False, **operation_config)
parameters:
- name: list_id
description: List Id of the image list.
isRequired: true
types:
- <xref:str>
- name: custom_headers
description: headers that will be added to the request
defaultValue: None
types:
- <xref:dict>
- name: raw
description: 'returns the direct response alongside the
deserialized response'
defaultValue: 'False'
types:
- <xref:bool>
- name: operation_config
description: '*Operation configuration
overrides*.'
isRequired: true
return:
description: TermList or ClientRawResponse if raw=true
types:
- <xref:azure.cognitiveservices.vision.contentmoderator.models.TermList>
- <xref:msrest.pipeline.ClientRawResponse>
exceptions:
- type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException
- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.refresh_index_method
name: refresh_index_method
summary: Refreshes the index of the list with list Id equal to list ID passed.
signature: refresh_index_method(list_id, language, custom_headers=None, raw=False,
**operation_config)
parameters:
- name: list_id
description: List Id of the image list.
isRequired: true
types:
- <xref:str>
- name: language
description: Language of the terms.
isRequired: true
types:
- <xref:str>
- name: custom_headers
description: headers that will be added to the request
defaultValue: None
types:
- <xref:dict>
- name: raw
description: 'returns the direct response alongside the
deserialized response'
defaultValue: 'False'
types:
- <xref:bool>
- name: operation_config
description: '*Operation configuration
overrides*.'
isRequired: true
return:
description: RefreshIndex or ClientRawResponse if raw=true
types:
- <xref:azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex>
- <xref:msrest.pipeline.ClientRawResponse>
exceptions:
- type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException
- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.update
name: update
summary: Updates an Term List.
signature: update(list_id, content_type, body, custom_headers=None, raw=False, **operation_config)
parameters:
- name: list_id
description: List Id of the image list.
isRequired: true
types:
- <xref:str>
- name: content_type
description: The content type.
isRequired: true
types:
- <xref:str>
- name: body
description: Schema of the body.
isRequired: true
types:
- <xref:azure.cognitiveservices.vision.contentmoderator.models.Body>
- name: custom_headers
description: headers that will be added to the request
defaultValue: None
types:
- <xref:dict>
- name: raw
description: 'returns the direct response alongside the
deserialized response'
defaultValue: 'False'
types:
- <xref:bool>
- name: operation_config
description: '*Operation configuration
overrides*.'
isRequired: true
return:
description: TermList or ClientRawResponse if raw=true
types:
- <xref:azure.cognitiveservices.vision.contentmoderator.models.TermList>
- <xref:msrest.pipeline.ClientRawResponse>
exceptions:
- type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException
attributes:
- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.models
name: models
signature: models = <module 'azure.cognitiveservices.vision.contentmoderator.models'
from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\vision\\contentmoderator\\models\\__init__.py'>