class Azure::CognitiveServices::ContentModerator::V1_0::ListManagementTerm

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.

Attributes

client[R]

@return [ContentModeratorClient] reference to the ContentModeratorClient

Private Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the ListManagementTerm class. @param client service class for accessing basic functionality.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 27
def initialize(client)
  @client = client
end

Private Instance Methods

add_term(list_id, term, language, custom_headers:nil) click to toggle source

Add a term to the term list with list Id equal to list Id passed.

@param list_id [String] List Id of the image list. @param term [String] Term to be deleted @param language [String] Language of the terms. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Object] operation results.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 45
def add_term(list_id, term, language, custom_headers:nil)
  response = add_term_async(list_id, term, language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
add_term_async(list_id, term, language, custom_headers:nil) click to toggle source

Add a term to the term list with list Id equal to list Id passed.

@param list_id [String] List Id of the image list. @param term [String] Term to be deleted @param language [String] Language of the terms. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 76
def add_term_async(list_id, term, language, 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, 'term is nil' if term.nil?
  fail ArgumentError, 'language is nil' if language.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/termlists/{listId}/terms/{term}'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id,'term' => term},
      query_params: {'language' => language},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 201
      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?

    result
  end

  promise.execute
end
add_term_with_http_info(list_id, term, language, custom_headers:nil) click to toggle source

Add a term to the term list with list Id equal to list Id passed.

@param list_id [String] List Id of the image list. @param term [String] Term to be deleted @param language [String] Language of the terms. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 61
def add_term_with_http_info(list_id, term, language, custom_headers:nil)
  add_term_async(list_id, term, language, custom_headers:custom_headers).value!
end
delete_all_terms(list_id, language, custom_headers:nil) click to toggle source

Deletes all terms from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param language [String] Language of the terms. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [String] operation results.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 331
def delete_all_terms(list_id, language, custom_headers:nil)
  response = delete_all_terms_async(list_id, language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
delete_all_terms_async(list_id, language, custom_headers:nil) click to toggle source

Deletes all terms from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param language [String] Language of the terms. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 360
def delete_all_terms_async(list_id, language, 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, 'language is nil' if language.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/termlists/{listId}/terms'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id},
      query_params: {'language' => language},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 204
      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 == 204
      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.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end
delete_all_terms_with_http_info(list_id, language, custom_headers:nil) click to toggle source

Deletes all terms from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param language [String] Language of the terms. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 346
def delete_all_terms_with_http_info(list_id, language, custom_headers:nil)
  delete_all_terms_async(list_id, language, custom_headers:custom_headers).value!
end
delete_term(list_id, term, language, custom_headers:nil) click to toggle source

Deletes a term from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param term [String] Term to be deleted @param language [String] Language of the terms. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [String] operation results.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 131
def delete_term(list_id, term, language, custom_headers:nil)
  response = delete_term_async(list_id, term, language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
delete_term_async(list_id, term, language, custom_headers:nil) click to toggle source

Deletes a term from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param term [String] Term to be deleted @param language [String] Language of the terms. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 162
def delete_term_async(list_id, term, language, 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, 'term is nil' if term.nil?
  fail ArgumentError, 'language is nil' if language.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/termlists/{listId}/terms/{term}'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id,'term' => term},
      query_params: {'language' => language},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 204
      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 == 204
      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.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end
delete_term_with_http_info(list_id, term, language, custom_headers:nil) click to toggle source

Deletes a term from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param term [String] Term to be deleted @param language [String] Language of the terms. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 147
def delete_term_with_http_info(list_id, term, language, custom_headers:nil)
  delete_term_async(list_id, term, language, custom_headers:custom_headers).value!
end
get_all_terms(list_id, language, offset:nil, limit:nil, custom_headers:nil) click to toggle source

Gets all terms from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param language [String] Language of the terms. @param offset [Integer] The pagination start index. @param limit [Integer] The max limit. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Terms] operation results.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 235
def get_all_terms(list_id, language, offset:nil, limit:nil, custom_headers:nil)
  response = get_all_terms_async(list_id, language, offset:offset, limit:limit, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_all_terms_async(list_id, language, offset:nil, limit:nil, custom_headers:nil) click to toggle source

Gets all terms from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param language [String] Language of the terms. @param offset [Integer] The pagination start index. @param limit [Integer] The max limit. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 268
def get_all_terms_async(list_id, language, offset:nil, limit:nil, 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, 'language is nil' if language.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/termlists/{listId}/terms'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id},
      query_params: {'language' => language,'offset' => offset,'limit' => limit},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  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::Terms.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end
get_all_terms_with_http_info(list_id, language, offset:nil, limit:nil, custom_headers:nil) click to toggle source

Gets all terms from the list with list Id equal to the list Id passed.

@param list_id [String] List Id of the image list. @param language [String] Language of the terms. @param offset [Integer] The pagination start index. @param limit [Integer] The max limit. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_term.rb, line 252
def get_all_terms_with_http_info(list_id, language, offset:nil, limit:nil, custom_headers:nil)
  get_all_terms_async(list_id, language, offset:offset, limit:limit, custom_headers:custom_headers).value!
end