Source code for azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations

# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------

from msrest.pipeline import ClientRawResponse

from .. import models


[docs]class ListManagementTermOperations(object): """ListManagementTermOperations operations. :param client: Client for service requests. :param config: Configuration of service client. :param serializer: An object model serializer. :param deserializer: An object model deserializer. """ models = models def __init__(self, client, config, serializer, deserializer): self._client = client self._serialize = serializer self._deserialize = deserializer self.config = config
[docs] def add_term( self, list_id, term, language, custom_headers=None, raw=False, **operation_config): """Add a term to the term list with list Id equal to list Id passed. :param list_id: List Id of the image list. :type list_id: str :param term: Term to be deleted :type term: str :param language: Language of the terms. :type language: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the deserialized response :param operation_config: :ref:`Operation configuration overrides<msrest:optionsforoperations>`. :return: object or ClientRawResponse if raw=true :rtype: object or ~msrest.pipeline.ClientRawResponse :raises: :class:`APIErrorException<azure.cognitiveservices.vision.contentmoderator.models.APIErrorException>` """ # Construct URL url = '/contentmoderator/lists/v1.0/termlists/{listId}/terms/{term}' path_format_arguments = { 'baseUrl': self._serialize.url("self.config.base_url_parameter", self.config.base_url_parameter, 'str', skip_quote=True), 'listId': self._serialize.url("list_id", list_id, 'str'), 'term': self._serialize.url("term", term, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['language'] = self._serialize.query("language", language, 'str') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; charset=utf-8' if custom_headers: header_parameters.update(custom_headers) # Construct and send request request = self._client.post(url, query_parameters) response = self._client.send(request, header_parameters, stream=False, **operation_config) if response.status_code not in [201]: raise models.APIErrorException(self._deserialize, response) deserialized = None if response.status_code == 201: deserialized = self._deserialize('object', response) if raw: client_raw_response = ClientRawResponse(deserialized, response) return client_raw_response return deserialized
[docs] def delete_term( self, list_id, term, language, custom_headers=None, raw=False, **operation_config): """Deletes a term from the list with list Id equal to the list Id passed. :param list_id: List Id of the image list. :type list_id: str :param term: Term to be deleted :type term: str :param language: Language of the terms. :type language: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the deserialized response :param operation_config: :ref:`Operation configuration overrides<msrest:optionsforoperations>`. :return: str or ClientRawResponse if raw=true :rtype: str or ~msrest.pipeline.ClientRawResponse :raises: :class:`APIErrorException<azure.cognitiveservices.vision.contentmoderator.models.APIErrorException>` """ # Construct URL url = '/contentmoderator/lists/v1.0/termlists/{listId}/terms/{term}' path_format_arguments = { 'baseUrl': self._serialize.url("self.config.base_url_parameter", self.config.base_url_parameter, 'str', skip_quote=True), 'listId': self._serialize.url("list_id", list_id, 'str'), 'term': self._serialize.url("term", term, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['language'] = self._serialize.query("language", language, 'str') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; charset=utf-8' if custom_headers: header_parameters.update(custom_headers) # Construct and send request request = self._client.delete(url, query_parameters) response = self._client.send(request, header_parameters, stream=False, **operation_config) if response.status_code not in [204]: raise models.APIErrorException(self._deserialize, response) deserialized = None if response.status_code == 204: deserialized = self._deserialize('str', response) if raw: client_raw_response = ClientRawResponse(deserialized, response) return client_raw_response return deserialized
[docs] def get_all_terms( self, list_id, language, offset=None, limit=None, custom_headers=None, raw=False, **operation_config): """Gets all terms from the list with list Id equal to the list Id passed. :param list_id: List Id of the image list. :type list_id: str :param language: Language of the terms. :type language: str :param offset: The pagination start index. :type offset: int :param limit: The max limit. :type limit: int :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the deserialized response :param operation_config: :ref:`Operation configuration overrides<msrest:optionsforoperations>`. :return: Terms or ClientRawResponse if raw=true :rtype: ~azure.cognitiveservices.vision.contentmoderator.models.Terms or ~msrest.pipeline.ClientRawResponse :raises: :class:`APIErrorException<azure.cognitiveservices.vision.contentmoderator.models.APIErrorException>` """ # Construct URL url = '/contentmoderator/lists/v1.0/termlists/{listId}/terms' path_format_arguments = { 'baseUrl': self._serialize.url("self.config.base_url_parameter", self.config.base_url_parameter, 'str', skip_quote=True), 'listId': self._serialize.url("list_id", list_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['language'] = self._serialize.query("language", language, 'str') if offset is not None: query_parameters['offset'] = self._serialize.query("offset", offset, 'int') if limit is not None: query_parameters['limit'] = self._serialize.query("limit", limit, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; charset=utf-8' if custom_headers: header_parameters.update(custom_headers) # Construct and send request request = self._client.get(url, query_parameters) response = self._client.send(request, header_parameters, stream=False, **operation_config) if response.status_code not in [200]: raise models.APIErrorException(self._deserialize, response) deserialized = None if response.status_code == 200: deserialized = self._deserialize('Terms', response) if raw: client_raw_response = ClientRawResponse(deserialized, response) return client_raw_response return deserialized
[docs] def delete_all_terms( self, list_id, language, custom_headers=None, raw=False, **operation_config): """Deletes all terms from the list with list Id equal to the list Id passed. :param list_id: List Id of the image list. :type list_id: str :param language: Language of the terms. :type language: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the deserialized response :param operation_config: :ref:`Operation configuration overrides<msrest:optionsforoperations>`. :return: str or ClientRawResponse if raw=true :rtype: str or ~msrest.pipeline.ClientRawResponse :raises: :class:`APIErrorException<azure.cognitiveservices.vision.contentmoderator.models.APIErrorException>` """ # Construct URL url = '/contentmoderator/lists/v1.0/termlists/{listId}/terms' path_format_arguments = { 'baseUrl': self._serialize.url("self.config.base_url_parameter", self.config.base_url_parameter, 'str', skip_quote=True), 'listId': self._serialize.url("list_id", list_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['language'] = self._serialize.query("language", language, 'str') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; charset=utf-8' if custom_headers: header_parameters.update(custom_headers) # Construct and send request request = self._client.delete(url, query_parameters) response = self._client.send(request, header_parameters, stream=False, **operation_config) if response.status_code not in [204]: raise models.APIErrorException(self._deserialize, response) deserialized = None if response.status_code == 204: deserialized = self._deserialize('str', response) if raw: client_raw_response = ClientRawResponse(deserialized, response) return client_raw_response return deserialized