From c3ebc7aafd345dcbb7d4b5157207e721a5b93a59 Mon Sep 17 00:00:00 2001 From: Azure SDK for Python bot Date: Wed, 18 Jul 2018 19:18:34 +0000 Subject: [PATCH] Generated from d796a072098d20051200552d7cbd6608587ffd23 Enable Computer Vision Client to customize endpoint. --- .../vision/computervision/__init__.py | 4 +- ...ision_api.py => computer_vision_client.py} | 78 ++++++++----------- .../vision/computervision/models/__init__.py | 4 +- ...ums.py => computer_vision_client_enums.py} | 16 ---- .../vision/computervision/version.py | 2 +- 5 files changed, 38 insertions(+), 66 deletions(-) rename azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/{computer_vision_api.py => computer_vision_client.py} (94%) rename azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/{computer_vision_api_enums.py => computer_vision_client_enums.py} (84%) diff --git a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/__init__.py b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/__init__.py index 13baf4710282..4c65cab27d1b 100644 --- a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/__init__.py +++ b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/__init__.py @@ -9,10 +9,10 @@ # regenerated. # -------------------------------------------------------------------------- -from .computer_vision_api import ComputerVisionAPI +from .computer_vision_client import ComputerVisionClient from .version import VERSION -__all__ = ['ComputerVisionAPI'] +__all__ = ['ComputerVisionClient'] __version__ = VERSION diff --git a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/computer_vision_api.py b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/computer_vision_client.py similarity index 94% rename from azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/computer_vision_api.py rename to azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/computer_vision_client.py index e6999202c26b..f163cb2d4020 100644 --- a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/computer_vision_api.py +++ b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/computer_vision_client.py @@ -17,63 +17,53 @@ from . import models -class ComputerVisionAPIConfiguration(Configuration): - """Configuration for ComputerVisionAPI +class ComputerVisionClientConfiguration(Configuration): + """Configuration for ComputerVisionClient Note that all parameters used to create this instance are saved as instance attributes. - :param azure_region: Supported Azure regions for Cognitive Services - endpoints. Possible values include: 'westus', 'westeurope', - 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', - 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', - 'brazilsouth' - :type azure_region: str or - ~azure.cognitiveservices.vision.computervision.models.AzureRegions + :param endpoint: Supported Cognitive Services endpoints + :type endpoint: str :param credentials: Subscription credentials which uniquely identify client subscription. :type credentials: None """ def __init__( - self, azure_region, credentials): + self, endpoint, credentials): - if azure_region is None: - raise ValueError("Parameter 'azure_region' must not be None.") + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") if credentials is None: raise ValueError("Parameter 'credentials' must not be None.") - base_url = 'https://{AzureRegion}.api.cognitive.microsoft.com/vision/v2.0' + base_url = '{Endpoint}/vision/v2.0' - super(ComputerVisionAPIConfiguration, self).__init__(base_url) + super(ComputerVisionClientConfiguration, self).__init__(base_url) self.add_user_agent('azure-cognitiveservices-vision-computervision/{}'.format(VERSION)) - self.azure_region = azure_region + self.endpoint = endpoint self.credentials = credentials -class ComputerVisionAPI(SDKClient): +class ComputerVisionClient(SDKClient): """The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively. :ivar config: Configuration for client. - :vartype config: ComputerVisionAPIConfiguration - - :param azure_region: Supported Azure regions for Cognitive Services - endpoints. Possible values include: 'westus', 'westeurope', - 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', - 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', - 'brazilsouth' - :type azure_region: str or - ~azure.cognitiveservices.vision.computervision.models.AzureRegions + :vartype config: ComputerVisionClientConfiguration + + :param endpoint: Supported Cognitive Services endpoints + :type endpoint: str :param credentials: Subscription credentials which uniquely identify client subscription. :type credentials: None """ def __init__( - self, azure_region, credentials): + self, endpoint, credentials): - self.config = ComputerVisionAPIConfiguration(azure_region, credentials) - super(ComputerVisionAPI, self).__init__(self.config.credentials, self.config) + self.config = ComputerVisionClientConfiguration(endpoint, credentials) + super(ComputerVisionClient, self).__init__(self.config.credentials, self.config) client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} self.api_version = '2.0' @@ -105,7 +95,7 @@ def list_models( # Construct URL url = self.list_models.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -190,7 +180,7 @@ def analyze_image( # Construct URL url = self.analyze_image.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -273,7 +263,7 @@ def generate_thumbnail( # Construct URL url = self.generate_thumbnail.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -354,7 +344,7 @@ def recognize_printed_text( # Construct URL url = self.recognize_printed_text.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -433,7 +423,7 @@ def describe_image( # Construct URL url = self.describe_image.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -509,7 +499,7 @@ def tag_image( # Construct URL url = self.tag_image.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -585,7 +575,7 @@ def analyze_image_by_domain( # Construct URL url = self.analyze_image_by_domain.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True), + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True), 'model': self._serialize.url("model", model, 'str') } url = self._client.format_url(url, **path_format_arguments) @@ -652,7 +642,7 @@ def recognize_text( # Construct URL url = self.recognize_text.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -709,7 +699,7 @@ def get_text_operation_result( # Construct URL url = self.get_text_operation_result.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True), + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True), 'operationId': self._serialize.url("operation_id", operation_id, 'str') } url = self._client.format_url(url, **path_format_arguments) @@ -794,7 +784,7 @@ def analyze_image_in_stream( # Construct URL url = self.analyze_image_in_stream.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -875,7 +865,7 @@ def generate_thumbnail_in_stream( # Construct URL url = self.generate_thumbnail_in_stream.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -959,7 +949,7 @@ def recognize_printed_text_in_stream( # Construct URL url = self.recognize_printed_text_in_stream.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -1041,7 +1031,7 @@ def describe_image_in_stream( # Construct URL url = self.describe_image_in_stream.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -1120,7 +1110,7 @@ def tag_image_in_stream( # Construct URL url = self.tag_image_in_stream.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) @@ -1199,7 +1189,7 @@ def analyze_image_by_domain_in_stream( # Construct URL url = self.analyze_image_by_domain_in_stream.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True), + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True), 'model': self._serialize.url("model", model, 'str') } url = self._client.format_url(url, **path_format_arguments) @@ -1269,7 +1259,7 @@ def recognize_text_in_stream( # Construct URL url = self.recognize_text_in_stream.metadata['url'] path_format_arguments = { - 'AzureRegion': self._serialize.url("self.config.azure_region", self.config.azure_region, 'AzureRegions', skip_quote=True) + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) } url = self._client.format_url(url, **path_format_arguments) diff --git a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/__init__.py b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/__init__.py index 001e34518c57..8f036444cccf 100644 --- a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/__init__.py +++ b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/__init__.py @@ -73,14 +73,13 @@ from .tag_result import TagResult from .computer_vision_error import ComputerVisionError, ComputerVisionErrorException from .image_url import ImageUrl -from .computer_vision_api_enums import ( +from .computer_vision_client_enums import ( TextOperationStatusCodes, Gender, ComputerVisionErrorCodes, VisualFeatureTypes, OcrLanguages, TextRecognitionMode, - AzureRegions, Details, ) @@ -122,6 +121,5 @@ 'VisualFeatureTypes', 'OcrLanguages', 'TextRecognitionMode', - 'AzureRegions', 'Details', ] diff --git a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/computer_vision_api_enums.py b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/computer_vision_client_enums.py similarity index 84% rename from azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/computer_vision_api_enums.py rename to azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/computer_vision_client_enums.py index 66fb4dc38436..c97e56a9787a 100644 --- a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/computer_vision_api_enums.py +++ b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/models/computer_vision_client_enums.py @@ -91,22 +91,6 @@ class TextRecognitionMode(str, Enum): printed = "Printed" -class AzureRegions(str, Enum): - - westus = "westus" - westeurope = "westeurope" - southeastasia = "southeastasia" - eastus2 = "eastus2" - westcentralus = "westcentralus" - westus2 = "westus2" - eastus = "eastus" - southcentralus = "southcentralus" - northeurope = "northeurope" - eastasia = "eastasia" - australiaeast = "australiaeast" - brazilsouth = "brazilsouth" - - class Details(str, Enum): celebrities = "Celebrities" diff --git a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/version.py b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/version.py index 9bd1dfac7ecb..63f83465c874 100644 --- a/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/version.py +++ b/azure-cognitiveservices-vision-computervision/azure/cognitiveservices/vision/computervision/version.py @@ -9,5 +9,5 @@ # regenerated. # -------------------------------------------------------------------------- -VERSION = "0.2.0" +VERSION = "2.0"