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 252 253 254 255 256 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 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 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 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 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 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 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 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
|
# 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.service_client import SDKClient
from msrest import Configuration, Serializer, Deserializer
from .version import VERSION
from msrest.pipeline import ClientRawResponse
from msrest.exceptions import HttpOperationError
from . import models
class ComputerVisionAPIConfiguration(Configuration):
"""Configuration for ComputerVisionAPI
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 credentials: Subscription credentials which uniquely identify
client subscription.
:type credentials: None
"""
def __init__(
self, azure_region, credentials):
if azure_region is None:
raise ValueError("Parameter 'azure_region' 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'
super(ComputerVisionAPIConfiguration, self).__init__(base_url)
self.add_user_agent('azure-cognitiveservices-vision-computervision/{}'.format(VERSION))
self.azure_region = azure_region
self.credentials = credentials
class ComputerVisionAPI(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
:param credentials: Subscription credentials which uniquely identify
client subscription.
:type credentials: None
"""
def __init__(
self, azure_region, credentials):
self.config = ComputerVisionAPIConfiguration(azure_region, credentials)
super(ComputerVisionAPI, 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'
self._serialize = Serializer(client_models)
self._deserialize = Deserializer(client_models)
def list_models(
self, custom_headers=None, raw=False, **operation_config):
"""This operation returns the list of domain-specific models that are
supported by the Computer Vision API. Currently, the API only supports
one domain-specific model: a celebrity recognizer. A successful
response will be returned in JSON. If the request failed, the response
will contain an error code and a message to help understand what went
wrong.
: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: ListModelsResult or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.ListModelsResult
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
# 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.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ListModelsResult', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
list_models.metadata = {'url': '/models'}
def analyze_image(
self, url, visual_features=None, details=None, language="en", custom_headers=None, raw=False, **operation_config):
"""This operation extracts a rich set of visual features based on the
image content. Two input methods are supported -- (1) Uploading an
image or (2) specifying an image URL. Within your request, there is an
optional parameter to allow you to choose which features to return. By
default, image categories are returned in the response.
:param url: Publicly reachable URL of an image
:type url: str
:param visual_features: A string indicating what visual feature types
to return. Multiple values should be comma-separated. Valid visual
feature types include:Categories - categorizes image content according
to a taxonomy defined in documentation. Tags - tags the image with a
detailed list of words related to the image content. Description -
describes the image content with a complete English sentence. Faces -
detects if faces are present. If present, generate coordinates, gender
and age. ImageType - detects if image is clipart or a line drawing.
Color - determines the accent color, dominant color, and whether an
image is black&white.Adult - detects if the image is pornographic in
nature (depicts nudity or a sex act). Sexually suggestive content is
also detected.
:type visual_features: list[str or
~azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes]
:param details: A string indicating which domain-specific details to
return. Multiple values should be comma-separated. Valid visual
feature types include:Celebrities - identifies celebrities if detected
in the image.
:type details: list[str or
~azure.cognitiveservices.vision.computervision.models.Details]
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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: ImageAnalysis or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.ImageAnalysis or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
image_url = models.ImageUrl(url=url)
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if visual_features is not None:
query_parameters['visualFeatures'] = self._serialize.query("visual_features", visual_features, '[VisualFeatureTypes]', div=',')
if details is not None:
query_parameters['details'] = self._serialize.query("details", details, '[Details]', div=',')
if language is not None:
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 body
body_content = self._serialize.body(image_url, 'ImageUrl')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ImageAnalysis', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
analyze_image.metadata = {'url': '/analyze'}
def generate_thumbnail(
self, width, height, url, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config):
"""This operation generates a thumbnail image with the user-specified
width and height. By default, the service analyzes the image,
identifies the region of interest (ROI), and generates smart cropping
coordinates based on the ROI. Smart cropping helps when you specify an
aspect ratio that differs from that of the input image. A successful
response contains the thumbnail image binary. If the request failed,
the response contains an error code and a message to help determine
what went wrong.
:param width: Width of the thumbnail. It must be between 1 and 1024.
Recommended minimum of 50.
:type width: int
:param height: Height of the thumbnail. It must be between 1 and 1024.
Recommended minimum of 50.
:type height: int
:param url: Publicly reachable URL of an image
:type url: str
:param smart_cropping: Boolean flag for enabling smart cropping.
:type smart_cropping: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: object or ClientRawResponse if raw=true
:rtype: Generator or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`HttpOperationError<msrest.exceptions.HttpOperationError>`
"""
image_url = models.ImageUrl(url=url)
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['width'] = self._serialize.query("width", width, 'int', maximum=1023, minimum=1)
query_parameters['height'] = self._serialize.query("height", height, 'int', maximum=1023, minimum=1)
if smart_cropping is not None:
query_parameters['smartCropping'] = self._serialize.query("smart_cropping", smart_cropping, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(image_url, 'ImageUrl')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=True, **operation_config)
if response.status_code not in [200]:
raise HttpOperationError(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._client.stream_download(response, callback)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
generate_thumbnail.metadata = {'url': '/generateThumbnail'}
def recognize_printed_text(
self, url, detect_orientation=True, language="unk", custom_headers=None, raw=False, **operation_config):
"""Optical Character Recognition (OCR) detects printed text in an image
and extracts the recognized characters into a machine-usable character
stream. Upon success, the OCR results will be returned. Upon failure,
the error code together with an error message will be returned. The
error code can be one of InvalidImageUrl, InvalidImageFormat,
InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or
InternalServerError.
:param detect_orientation: Whether detect the text orientation in the
image. With detectOrientation=true the OCR service tries to detect the
image orientation and correct it before further processing (e.g. if
it's upside-down).
:type detect_orientation: bool
:param url: Publicly reachable URL of an image
:type url: str
:param language: The BCP-47 language code of the text to be detected
in the image. The default value is 'unk'. Possible values include:
'unk', 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de',
'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv',
'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'
:type language: str or
~azure.cognitiveservices.vision.computervision.models.OcrLanguages
: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: OcrResult or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.OcrResult or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
image_url = models.ImageUrl(url=url)
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['detectOrientation'] = self._serialize.query("detect_orientation", detect_orientation, 'bool')
if language is not None:
query_parameters['language'] = self._serialize.query("language", language, 'OcrLanguages')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(image_url, 'ImageUrl')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('OcrResult', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
recognize_printed_text.metadata = {'url': '/ocr'}
def describe_image(
self, url, max_candidates="1", language="en", custom_headers=None, raw=False, **operation_config):
"""This operation generates a description of an image in human readable
language with complete sentences. The description is based on a
collection of content tags, which are also returned by the operation.
More than one description can be generated for each image.
Descriptions are ordered by their confidence score. All descriptions
are in English. Two input methods are supported -- (1) Uploading an
image or (2) specifying an image URL.A successful response will be
returned in JSON. If the request failed, the response will contain an
error code and a message to help understand what went wrong.
:param url: Publicly reachable URL of an image
:type url: str
:param max_candidates: Maximum number of candidate descriptions to be
returned. The default is 1.
:type max_candidates: str
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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: ImageDescription or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.ImageDescription
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
image_url = models.ImageUrl(url=url)
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if max_candidates is not None:
query_parameters['maxCandidates'] = self._serialize.query("max_candidates", max_candidates, 'str')
if language is not None:
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 body
body_content = self._serialize.body(image_url, 'ImageUrl')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ImageDescription', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
describe_image.metadata = {'url': '/describe'}
def tag_image(
self, url, language="en", custom_headers=None, raw=False, **operation_config):
"""This operation generates a list of words, or tags, that are relevant to
the content of the supplied image. The Computer Vision API can return
tags based on objects, living beings, scenery or actions found in
images. Unlike categories, tags are not organized according to a
hierarchical classification system, but correspond to image content.
Tags may contain hints to avoid ambiguity or provide context, for
example the tag 'cello' may be accompanied by the hint 'musical
instrument'. All tags are in English.
:param url: Publicly reachable URL of an image
:type url: str
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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: TagResult or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.TagResult or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
image_url = models.ImageUrl(url=url)
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if language is not None:
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 body
body_content = self._serialize.body(image_url, 'ImageUrl')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('TagResult', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
tag_image.metadata = {'url': '/tag'}
def analyze_image_by_domain(
self, model, url, language="en", custom_headers=None, raw=False, **operation_config):
"""This operation recognizes content within an image by applying a
domain-specific model. The list of domain-specific models that are
supported by the Computer Vision API can be retrieved using the /models
GET request. Currently, the API only provides a single domain-specific
model: celebrities. Two input methods are supported -- (1) Uploading an
image or (2) specifying an image URL. A successful response will be
returned in JSON. If the request failed, the response will contain an
error code and a message to help understand what went wrong.
:param model: The domain-specific content to recognize.
:type model: str
:param url: Publicly reachable URL of an image
:type url: str
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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: DomainModelResults or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.DomainModelResults
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
image_url = models.ImageUrl(url=url)
# 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),
'model': self._serialize.url("model", model, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if language is not None:
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 body
body_content = self._serialize.body(image_url, 'ImageUrl')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DomainModelResults', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
analyze_image_by_domain.metadata = {'url': '/models/{model}/analyze'}
def recognize_text(
self, url, mode, custom_headers=None, raw=False, **operation_config):
"""Recognize Text operation. When you use the Recognize Text interface,
the response contains a field called 'Operation-Location'. The
'Operation-Location' field contains the URL that you must use for your
Get Recognize Text Operation Result operation.
:param mode: Type of text to recognize. Possible values include:
'Handwritten', 'Printed'
:type mode: str or
~azure.cognitiveservices.vision.computervision.models.TextRecognitionMode
:param url: Publicly reachable URL of an image
:type url: 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: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
image_url = models.ImageUrl(url=url)
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['mode'] = self._serialize.query("mode", mode, 'TextRecognitionMode')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(image_url, 'ImageUrl')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.ComputerVisionErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'Operation-Location': 'str',
})
return client_raw_response
recognize_text.metadata = {'url': '/recognizeText'}
def get_text_operation_result(
self, operation_id, custom_headers=None, raw=False, **operation_config):
"""This interface is used for getting text operation result. The URL to
this interface should be retrieved from 'Operation-Location' field
returned from Recognize Text interface.
:param operation_id: Id of the text operation returned in the response
of the 'Recognize Text'
:type operation_id: 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: TextOperationResult or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.TextOperationResult
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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),
'operationId': self._serialize.url("operation_id", operation_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
# 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.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('TextOperationResult', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_text_operation_result.metadata = {'url': '/textOperations/{operationId}'}
def analyze_image_in_stream(
self, image, visual_features=None, details=None, language="en", custom_headers=None, raw=False, callback=None, **operation_config):
"""This operation extracts a rich set of visual features based on the
image content.
:param image: An image stream.
:type image: Generator
:param visual_features: A string indicating what visual feature types
to return. Multiple values should be comma-separated. Valid visual
feature types include:Categories - categorizes image content according
to a taxonomy defined in documentation. Tags - tags the image with a
detailed list of words related to the image content. Description -
describes the image content with a complete English sentence. Faces -
detects if faces are present. If present, generate coordinates, gender
and age. ImageType - detects if image is clipart or a line drawing.
Color - determines the accent color, dominant color, and whether an
image is black&white.Adult - detects if the image is pornographic in
nature (depicts nudity or a sex act). Sexually suggestive content is
also detected.
:type visual_features: list[str or
~azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes]
:param details: A string indicating which domain-specific details to
return. Multiple values should be comma-separated. Valid visual
feature types include:Celebrities - identifies celebrities if detected
in the image. Possible values include: 'Celebrities', 'Landmarks'
:type details: str
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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 callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ImageAnalysis or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.ImageAnalysis or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if visual_features is not None:
query_parameters['visualFeatures'] = self._serialize.query("visual_features", visual_features, '[VisualFeatureTypes]', div=',')
if details is not None:
query_parameters['details'] = self._serialize.query("details", details, 'str')
if language is not None:
query_parameters['language'] = self._serialize.query("language", language, 'str')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/octet-stream'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._client.stream_upload(image, callback)
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ImageAnalysis', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
analyze_image_in_stream.metadata = {'url': '/analyze'}
def generate_thumbnail_in_stream(
self, width, height, image, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config):
"""This operation generates a thumbnail image with the user-specified
width and height. By default, the service analyzes the image,
identifies the region of interest (ROI), and generates smart cropping
coordinates based on the ROI. Smart cropping helps when you specify an
aspect ratio that differs from that of the input image. A successful
response contains the thumbnail image binary. If the request failed,
the response contains an error code and a message to help determine
what went wrong.
:param width: Width of the thumbnail. It must be between 1 and 1024.
Recommended minimum of 50.
:type width: int
:param height: Height of the thumbnail. It must be between 1 and 1024.
Recommended minimum of 50.
:type height: int
:param image: An image stream.
:type image: Generator
:param smart_cropping: Boolean flag for enabling smart cropping.
:type smart_cropping: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: object or ClientRawResponse if raw=true
:rtype: Generator or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`HttpOperationError<msrest.exceptions.HttpOperationError>`
"""
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['width'] = self._serialize.query("width", width, 'int', maximum=1023, minimum=1)
query_parameters['height'] = self._serialize.query("height", height, 'int', maximum=1023, minimum=1)
if smart_cropping is not None:
query_parameters['smartCropping'] = self._serialize.query("smart_cropping", smart_cropping, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/octet-stream'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._client.stream_upload(image, callback)
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=True, **operation_config)
if response.status_code not in [200]:
raise HttpOperationError(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._client.stream_download(response, callback)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
generate_thumbnail_in_stream.metadata = {'url': '/generateThumbnail'}
def recognize_printed_text_in_stream(
self, image, detect_orientation=True, language="unk", custom_headers=None, raw=False, callback=None, **operation_config):
"""Optical Character Recognition (OCR) detects printed text in an image
and extracts the recognized characters into a machine-usable character
stream. Upon success, the OCR results will be returned. Upon failure,
the error code together with an error message will be returned. The
error code can be one of InvalidImageUrl, InvalidImageFormat,
InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or
InternalServerError.
:param detect_orientation: Whether detect the text orientation in the
image. With detectOrientation=true the OCR service tries to detect the
image orientation and correct it before further processing (e.g. if
it's upside-down).
:type detect_orientation: bool
:param image: An image stream.
:type image: Generator
:param language: The BCP-47 language code of the text to be detected
in the image. The default value is 'unk'. Possible values include:
'unk', 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de',
'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv',
'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'
:type language: str or
~azure.cognitiveservices.vision.computervision.models.OcrLanguages
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: OcrResult or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.OcrResult or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if language is not None:
query_parameters['language'] = self._serialize.query("language", language, 'OcrLanguages')
query_parameters['detectOrientation'] = self._serialize.query("detect_orientation", detect_orientation, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/octet-stream'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._client.stream_upload(image, callback)
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('OcrResult', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
recognize_printed_text_in_stream.metadata = {'url': '/ocr'}
def describe_image_in_stream(
self, image, max_candidates="1", language="en", custom_headers=None, raw=False, callback=None, **operation_config):
"""This operation generates a description of an image in human readable
language with complete sentences. The description is based on a
collection of content tags, which are also returned by the operation.
More than one description can be generated for each image.
Descriptions are ordered by their confidence score. All descriptions
are in English. Two input methods are supported -- (1) Uploading an
image or (2) specifying an image URL.A successful response will be
returned in JSON. If the request failed, the response will contain an
error code and a message to help understand what went wrong.
:param image: An image stream.
:type image: Generator
:param max_candidates: Maximum number of candidate descriptions to be
returned. The default is 1.
:type max_candidates: str
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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 callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ImageDescription or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.ImageDescription
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if max_candidates is not None:
query_parameters['maxCandidates'] = self._serialize.query("max_candidates", max_candidates, 'str')
if language is not None:
query_parameters['language'] = self._serialize.query("language", language, 'str')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/octet-stream'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._client.stream_upload(image, callback)
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ImageDescription', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
describe_image_in_stream.metadata = {'url': '/describe'}
def tag_image_in_stream(
self, image, language="en", custom_headers=None, raw=False, callback=None, **operation_config):
"""This operation generates a list of words, or tags, that are relevant to
the content of the supplied image. The Computer Vision API can return
tags based on objects, living beings, scenery or actions found in
images. Unlike categories, tags are not organized according to a
hierarchical classification system, but correspond to image content.
Tags may contain hints to avoid ambiguity or provide context, for
example the tag 'cello' may be accompanied by the hint 'musical
instrument'. All tags are in English.
:param image: An image stream.
:type image: Generator
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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 callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: TagResult or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.TagResult or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if language is not None:
query_parameters['language'] = self._serialize.query("language", language, 'str')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/octet-stream'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._client.stream_upload(image, callback)
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('TagResult', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
tag_image_in_stream.metadata = {'url': '/tag'}
def analyze_image_by_domain_in_stream(
self, model, image, language="en", custom_headers=None, raw=False, callback=None, **operation_config):
"""This operation recognizes content within an image by applying a
domain-specific model. The list of domain-specific models that are
supported by the Computer Vision API can be retrieved using the /models
GET request. Currently, the API only provides a single domain-specific
model: celebrities. Two input methods are supported -- (1) Uploading an
image or (2) specifying an image URL. A successful response will be
returned in JSON. If the request failed, the response will contain an
error code and a message to help understand what went wrong.
:param model: The domain-specific content to recognize.
:type model: str
:param image: An image stream.
:type image: Generator
:param language: The desired language for output generation. If this
parameter is not specified, the default value is
"en".Supported languages:en - English, Default. es -
Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.
Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
: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 callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DomainModelResults or ClientRawResponse if raw=true
:rtype:
~azure.cognitiveservices.vision.computervision.models.DomainModelResults
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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),
'model': self._serialize.url("model", model, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if language is not None:
query_parameters['language'] = self._serialize.query("language", language, 'str')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/octet-stream'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._client.stream_upload(image, callback)
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ComputerVisionErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DomainModelResults', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
analyze_image_by_domain_in_stream.metadata = {'url': '/models/{model}/analyze'}
def recognize_text_in_stream(
self, image, mode, custom_headers=None, raw=False, callback=None, **operation_config):
"""Recognize Text operation. When you use the Recognize Text interface,
the response contains a field called 'Operation-Location'. The
'Operation-Location' field contains the URL that you must use for your
Get Recognize Text Operation Result operation.
:param image: An image stream.
:type image: Generator
:param mode: Type of text to recognize. Possible values include:
'Handwritten', 'Printed'
:type mode: str or
~azure.cognitiveservices.vision.computervision.models.TextRecognitionMode
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ComputerVisionErrorException<azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorException>`
"""
# 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)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['mode'] = self._serialize.query("mode", mode, 'TextRecognitionMode')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/octet-stream'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._client.stream_upload(image, callback)
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.ComputerVisionErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'Operation-Location': 'str',
})
return client_raw_response
recognize_text_in_stream.metadata = {'url': '/recognizeText'}
|