Class: Azure::CognitiveServices::ContentModerator::V1_0::ListManagementImageLists
- Inherits:
-
Object
- Object
- Azure::CognitiveServices::ContentModerator::V1_0::ListManagementImageLists
- Includes:
- MsRestAzure
- Defined in:
- lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb
Overview
You use the API to scan your content as it is generated. Content Moderator then processes your content and sends the results along with relevant information either back to your systems or to the built-in review tool. You can use this information to take decisions e.g. take it down, send to human judge, etc.
When using the API, images need to have a minimum of 128 pixels and a maximum file size of 4MB. Text can be at most 1024 characters long. If the content passed to the text API or the image API exceeds the size limits, the API will return an error code that informs about the issue.
Instance Attribute Summary collapse
-
#client ⇒ ContentModeratorClient
readonly
Reference to the ContentModeratorClient.
Instance Method Summary collapse
-
#create(content_type, body, custom_headers: nil) ⇒ ImageList
Creates an image list.
-
#create_async(content_type, body, custom_headers: nil) ⇒ Concurrent::Promise
Creates an image list.
-
#create_with_http_info(content_type, body, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates an image list.
-
#delete(list_id, custom_headers: nil) ⇒ String
Deletes image list with the list Id equal to list Id passed.
-
#delete_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise
Deletes image list with the list Id equal to list Id passed.
-
#delete_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes image list with the list Id equal to list Id passed.
-
#get_all_image_lists(custom_headers: nil) ⇒ Array
Gets all the Image Lists.
-
#get_all_image_lists_async(custom_headers: nil) ⇒ Concurrent::Promise
Gets all the Image Lists.
-
#get_all_image_lists_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all the Image Lists.
-
#get_details(list_id, custom_headers: nil) ⇒ ImageList
Returns the details of the image list with list Id equal to list Id passed.
-
#get_details_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise
Returns the details of the image list with list Id equal to list Id passed.
-
#get_details_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Returns the details of the image list with list Id equal to list Id passed.
-
#initialize(client) ⇒ ListManagementImageLists
constructor
Creates and initializes a new instance of the ListManagementImageLists class.
-
#refresh_index_method(list_id, custom_headers: nil) ⇒ RefreshIndex
Refreshes the index of the list with list Id equal to list Id passed.
-
#refresh_index_method_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise
Refreshes the index of the list with list Id equal to list Id passed.
-
#refresh_index_method_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Refreshes the index of the list with list Id equal to list Id passed.
-
#update(list_id, content_type, body, custom_headers: nil) ⇒ ImageList
Updates an image list with list Id equal to list Id passed.
-
#update_async(list_id, content_type, body, custom_headers: nil) ⇒ Concurrent::Promise
Updates an image list with list Id equal to list Id passed.
-
#update_with_http_info(list_id, content_type, body, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates an image list with list Id equal to list Id passed.
Constructor Details
#initialize(client) ⇒ ListManagementImageLists
Creates and initializes a new instance of the ListManagementImageLists class.
27 28 29 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 27 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ ContentModeratorClient (readonly)
Returns reference to the ContentModeratorClient.
32 33 34 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 32 def client @client end |
Instance Method Details
#create(content_type, body, custom_headers: nil) ⇒ ImageList
Creates an image list.
will be added to the HTTP request.
328 329 330 331 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 328 def create(content_type, body, custom_headers:nil) response = create_async(content_type, body, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_async(content_type, body, custom_headers: nil) ⇒ Concurrent::Promise
Creates an image list.
to the HTTP request.
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 357 def create_async(content_type, body, custom_headers:nil) fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil? fail ArgumentError, 'content_type is nil' if content_type.nil? fail ArgumentError, 'body is nil' if body.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['Content-Type'] = content_type unless content_type.nil? request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? # Serialize Request request_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::Body.mapper() request_content = @client.serialize(request_mapper, body) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'contentmoderator/lists/v1.0/imagelists' request_url = @base_url || @client.base_url request_url = request_url.gsub('{Endpoint}', @client.endpoint) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::ImageList.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#create_with_http_info(content_type, body, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates an image list.
will be added to the HTTP request.
343 344 345 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 343 def create_with_http_info(content_type, body, custom_headers:nil) create_async(content_type, body, custom_headers:custom_headers).value! end |
#delete(list_id, custom_headers: nil) ⇒ String
Deletes image list with the list Id equal to list Id passed.
will be added to the HTTP request.
130 131 132 133 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 130 def delete(list_id, custom_headers:nil) response = delete_async(list_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#delete_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise
Deletes image list with the list Id equal to list Id passed.
to the HTTP request.
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 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 157 def delete_async(list_id, custom_headers:nil) fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil? fail ArgumentError, 'list_id is nil' if list_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'contentmoderator/lists/v1.0/imagelists/{listId}' request_url = @base_url || @client.base_url request_url = request_url.gsub('{Endpoint}', @client.endpoint) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'listId' => list_id}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:delete, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = { client_side_validation: true, required: false, serialized_name: 'parsed_response', type: { name: 'String' } } result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#delete_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes image list with the list Id equal to list Id passed.
will be added to the HTTP request.
144 145 146 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 144 def delete_with_http_info(list_id, custom_headers:nil) delete_async(list_id, custom_headers:custom_headers).value! end |
#get_all_image_lists(custom_headers: nil) ⇒ Array
Gets all the Image Lists.
will be added to the HTTP request.
424 425 426 427 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 424 def get_all_image_lists(custom_headers:nil) response = get_all_image_lists_async(custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_all_image_lists_async(custom_headers: nil) ⇒ Concurrent::Promise
Gets all the Image Lists.
to the HTTP request.
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 449 def get_all_image_lists_async(custom_headers:nil) fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'contentmoderator/lists/v1.0/imagelists' request_url = @base_url || @client.base_url request_url = request_url.gsub('{Endpoint}', @client.endpoint) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = { client_side_validation: true, required: false, serialized_name: 'parsed_response', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'ImageListElementType', type: { name: 'Composite', class_name: 'ImageList' } } } } result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_all_image_lists_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all the Image Lists.
will be added to the HTTP request.
437 438 439 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 437 def get_all_image_lists_with_http_info(custom_headers:nil) get_all_image_lists_async(custom_headers:custom_headers).value! end |
#get_details(list_id, custom_headers: nil) ⇒ ImageList
Returns the details of the image list with list Id equal to list Id passed.
will be added to the HTTP request.
43 44 45 46 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 43 def get_details(list_id, custom_headers:nil) response = get_details_async(list_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_details_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise
Returns the details of the image list with list Id equal to list Id passed.
to the HTTP request.
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 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 70 def get_details_async(list_id, custom_headers:nil) fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil? fail ArgumentError, 'list_id is nil' if list_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'contentmoderator/lists/v1.0/imagelists/{listId}' request_url = @base_url || @client.base_url request_url = request_url.gsub('{Endpoint}', @client.endpoint) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'listId' => list_id}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::ImageList.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_details_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Returns the details of the image list with list Id equal to list Id passed.
will be added to the HTTP request.
57 58 59 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 57 def get_details_with_http_info(list_id, custom_headers:nil) get_details_async(list_id, custom_headers:custom_headers).value! end |
#refresh_index_method(list_id, custom_headers: nil) ⇒ RefreshIndex
Refreshes the index of the list with list Id equal to list Id passed.
will be added to the HTTP request.
523 524 525 526 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 523 def refresh_index_method(list_id, custom_headers:nil) response = refresh_index_method_async(list_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#refresh_index_method_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise
Refreshes the index of the list with list Id equal to list Id passed.
to the HTTP request.
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 550 def refresh_index_method_async(list_id, custom_headers:nil) fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil? fail ArgumentError, 'list_id is nil' if list_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'contentmoderator/lists/v1.0/imagelists/{listId}/RefreshIndex' request_url = @base_url || @client.base_url request_url = request_url.gsub('{Endpoint}', @client.endpoint) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'listId' => list_id}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::RefreshIndex.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#refresh_index_method_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Refreshes the index of the list with list Id equal to list Id passed.
will be added to the HTTP request.
537 538 539 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 537 def refresh_index_method_with_http_info(list_id, custom_headers:nil) refresh_index_method_async(list_id, custom_headers:custom_headers).value! end |
#update(list_id, content_type, body, custom_headers: nil) ⇒ ImageList
Updates an image list with list Id equal to list Id passed.
will be added to the HTTP request.
226 227 228 229 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 226 def update(list_id, content_type, body, custom_headers:nil) response = update_async(list_id, content_type, body, custom_headers:custom_headers).value! response.body unless response.nil? end |
#update_async(list_id, content_type, body, custom_headers: nil) ⇒ Concurrent::Promise
Updates an image list with list Id equal to list Id passed.
to the HTTP request.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 257 def update_async(list_id, content_type, body, custom_headers:nil) fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil? fail ArgumentError, 'list_id is nil' if list_id.nil? fail ArgumentError, 'content_type is nil' if content_type.nil? fail ArgumentError, 'body is nil' if body.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['Content-Type'] = content_type unless content_type.nil? request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? # Serialize Request request_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::Body.mapper() request_content = @client.serialize(request_mapper, body) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'contentmoderator/lists/v1.0/imagelists/{listId}' request_url = @base_url || @client.base_url request_url = request_url.gsub('{Endpoint}', @client.endpoint) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'listId' => list_id}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::ImageList.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#update_with_http_info(list_id, content_type, body, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates an image list with list Id equal to list Id passed.
will be added to the HTTP request.
242 243 244 |
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image_lists.rb', line 242 def update_with_http_info(list_id, content_type, body, custom_headers:nil) update_async(list_id, content_type, body, custom_headers:custom_headers).value! end |