@@ -44,7 +44,9 @@ import Network.Google.Vision.Types.Sum
4444-- NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) ==
4545-- NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) ==
4646-- NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) ==
47−-- NormalizeLatLng(-270.0, 10.0)
47+-- NormalizeLatLng(-270.0, 10.0) The code in
48+-- logs\/storage\/validator\/logs_validator_traits.cc treats this type as
49+-- if it were annotated as ST_LOCATION.
4850--
4951-- /See:/ 'latLng' smart constructor.
5052data LatLng = LatLng'
@@ -93,10 +95,10 @@ instance ToJSON LatLng where
9395 [("latitude" .=) <$> _llLatitude,
9496 ("longitude" .=) <$> _llLongitude])
9597
96−-- | The /Feature/ indicates what type of image detection task to perform.
97−-- Users describe the type of Google Cloud Vision API tasks to perform over
98−-- images by using /Feature/s. Features encode the Cloud Vision API
99−-- vertical to operate on and the number of top-scoring results to return.
98+-- | Users describe the type of Google Cloud Vision API tasks to perform over
99+-- images by using *Feature*s. Each Feature indicates a type of image
100+-- detection task to perform. Features encode the Cloud Vision API vertical
101+-- to operate on and the number of top-scoring results to return.
100102--
101103-- /See:/ 'feature' smart constructor.
102104data Feature = Feature'
@@ -239,7 +241,7 @@ instance ToJSON Status where
239241 ("code" .=) <$> _sCode,
240242 ("message" .=) <$> _sMessage])
241243
242−-- | Arbitrary name\/value pair.
244+-- | A \`Property\` consists of a user-supplied name\/value pair.
243245--
244246-- /See:/ 'property' smart constructor.
245247data Property = Property'
@@ -286,7 +288,7 @@ instance ToJSON Property where
286288--
287289-- /See:/ 'image' smart constructor.
288290data Image = Image'
289− { _iContent :: !(Maybe Base64)
291+ { _iContent :: !(Maybe Bytes)
290292 , _iSource :: !(Maybe ImageSource)
291293 } deriving (Eq,Show,Data,Typeable,Generic)
292294
@@ -311,11 +313,11 @@ image =
311313iContent :: Lens' Image (Maybe ByteString)
312314iContent
313315 = lens _iContent (\ s a -> s{_iContent = a}) .
314− mapping _Base64
316+ mapping _Bytes
315317
316−-- | Google Cloud Storage image location. If both \'content\' and \'source\'
317−-- are filled for an image, \'content\' takes precedence and it will be
318−-- used for performing the image annotation request.
318+-- | Google Cloud Storage image location. If both \`content\` and \`source\`
319+-- are provided for an image, \`content\` takes precedence and is used to
320+-- perform the image annotation request.
319321iSource :: Lens' Image (Maybe ImageSource)
320322iSource = lens _iSource (\ s a -> s{_iSource = a})
321323
@@ -333,9 +335,9 @@ instance ToJSON Image where
333335 ("source" .=) <$> _iSource])
334336
335337-- | A face-specific landmark (for example, a face feature). Landmark
336−-- positions may fall outside the bounds of the image when the face is near
337−-- one or more edges of the image. Therefore it is NOT guaranteed that 0
338−-- \<= x \< width or 0 \<= y \< height.
338+-- positions may fall outside the bounds of the image if the face is near
339+-- one or more edges of the image. Therefore it is NOT guaranteed that \`0
340+-- \<= x \< width\` or \`0 \<= y \< height\`.
339341--
340342-- /See:/ 'landmark' smart constructor.
341343data Landmark = Landmark'
@@ -600,7 +602,7 @@ locationInfo =
600602 { _liLatLng = Nothing
601603 }
602604
603−-- | Lat - long location coordinates.
605+-- | lat\/long location coordinates.
604606liLatLng :: Lens' LocationInfo (Maybe LatLng)
605607liLatLng = lens _liLatLng (\ s a -> s{_liLatLng = a})
606608
@@ -685,8 +687,8 @@ instance ToJSON BatchAnnotateImagesRequest where
685687 = object
686688 (catMaybes [("requests" .=) <$> _bairRequests])
687689
688−-- | Color information consists of RGB channels, score and fraction of image
689−-- the color occupies in the image.
690+-- | Color information consists of RGB channels, score, and the fraction of
691+-- the image that the color occupies in the image.
690692--
691693-- /See:/ 'colorInfo' smart constructor.
692694data ColorInfo = ColorInfo'
@@ -723,8 +725,8 @@ ciScore
723725 = lens _ciScore (\ s a -> s{_ciScore = a}) .
724726 mapping _Coerce
725727
726−-- | Stores the fraction of pixels the color occupies in the image. Value in
727−-- range [0, 1].
728+-- | The fraction of pixels the color occupies in the image. Value in range
729+-- [0, 1].
728730ciPixelFraction :: Lens' ColorInfo (Maybe Double)
729731ciPixelFraction
730732 = lens _ciPixelFraction
@@ -794,7 +796,7 @@ annotateImageResponse =
794796 , _airImagePropertiesAnnotation = Nothing
795797 }
796798
797−-- | If present, logo detection completed successfully.
799+-- | If present, logo detection has completed successfully.
798800airLogoAnnotations :: Lens' AnnotateImageResponse [EntityAnnotation]
799801airLogoAnnotations
800802 = lens _airLogoAnnotations
@@ -802,7 +804,7 @@ airLogoAnnotations
802804 . _Default
803805 . _Coerce
804806
805−-- | If present, label detection completed successfully.
807+-- | If present, label detection has completed successfully.
806808airLabelAnnotations :: Lens' AnnotateImageResponse [EntityAnnotation]
807809airLabelAnnotations
808810 = lens _airLabelAnnotations
@@ -810,7 +812,7 @@ airLabelAnnotations
810812 . _Default
811813 . _Coerce
812814
813−-- | If present, face detection completed successfully.
815+-- | If present, face detection has completed successfully.
814816airFaceAnnotations :: Lens' AnnotateImageResponse [FaceAnnotation]
815817airFaceAnnotations
816818 = lens _airFaceAnnotations
@@ -819,18 +821,18 @@ airFaceAnnotations
819821 . _Coerce
820822
821823-- | If set, represents the error message for the operation. Note that
822−-- filled-in mage annotations are guaranteed to be correct, even when
823−-- 'error' is non-empty.
824+-- filled-in image annotations are guaranteed to be correct, even when
825+-- \`error\` is set.
824826airError :: Lens' AnnotateImageResponse (Maybe Status)
825827airError = lens _airError (\ s a -> s{_airError = a})
826828
827−-- | If present, safe-search annotation completed successfully.
829+-- | If present, safe-search annotation has completed successfully.
828830airSafeSearchAnnotation :: Lens' AnnotateImageResponse (Maybe SafeSearchAnnotation)
829831airSafeSearchAnnotation
830832 = lens _airSafeSearchAnnotation
831833 (\ s a -> s{_airSafeSearchAnnotation = a})
832834
833−-- | If present, landmark detection completed successfully.
835+-- | If present, landmark detection has completed successfully.
834836airLandmarkAnnotations :: Lens' AnnotateImageResponse [EntityAnnotation]
835837airLandmarkAnnotations
836838 = lens _airLandmarkAnnotations
@@ -838,7 +840,7 @@ airLandmarkAnnotations
838840 . _Default
839841 . _Coerce
840842
841−-- | If present, text (OCR) detection completed successfully.
843+-- | If present, text (OCR) detection has completed successfully.
842844airTextAnnotations :: Lens' AnnotateImageResponse [EntityAnnotation]
843845airTextAnnotations
844846 = lens _airTextAnnotations
@@ -882,7 +884,7 @@ instance ToJSON AnnotateImageResponse where
882884 ("imagePropertiesAnnotation" .=) <$>
883885 _airImagePropertiesAnnotation])
884886
885−-- | Stores image properties (e.g. dominant colors).
887+-- | Stores image properties, such as dominant colors.
886888--
887889-- /See:/ 'imageProperties' smart constructor.
888890newtype ImageProperties = ImageProperties'
@@ -994,8 +996,8 @@ faceAnnotation =
994996 , _faLandmarks = Nothing
995997 }
996998
997−-- | Pitch angle. Indicates the upwards\/downwards angle that the face is
998−-- pointing relative to the image\'s horizontal plane. Range [-180,180].
999+-- | Pitch angle, which indicates the upwards\/downwards angle that the face
1000+-- is pointing relative to the image\'s horizontal plane. Range [-180,180].
9991001faTiltAngle :: Lens' FaceAnnotation (Maybe Double)
10001002faTiltAngle
10011003 = lens _faTiltAngle (\ s a -> s{_faTiltAngle = a}) .
@@ -1008,12 +1010,12 @@ faBlurredLikelihood
10081010 (\ s a -> s{_faBlurredLikelihood = a})
10091011
10101012-- | The bounding polygon around the face. The coordinates of the bounding
1011−-- box are in the original image\'s scale, as returned in ImageParams. The
1012−-- bounding box is computed to \"frame\" the face in accordance with human
1013−-- expectations. It is based on the landmarker results. Note that one or
1014−-- more x and\/or y coordinates may not be generated in the BoundingPoly
1015−-- (the polygon will be unbounded) if only a partial face appears in the
1016−-- image to be annotated.
1013+-- box are in the original image\'s scale, as returned in \`ImageParams\`.
1014+-- The bounding box is computed to \"frame\" the face in accordance with
1015+-- human expectations. It is based on the landmarker results. Note that one
1016+-- or more x and\/or y coordinates may not be generated in the
1017+-- \`BoundingPoly\` (the polygon will be unbounded) if only a partial face
1018+-- appears in the image to be annotated.
10171019faBoundingPoly :: Lens' FaceAnnotation (Maybe BoundingPoly)
10181020faBoundingPoly
10191021 = lens _faBoundingPoly
@@ -1032,17 +1034,17 @@ faLandmarkingConfidence
10321034 (\ s a -> s{_faLandmarkingConfidence = a})
10331035 . mapping _Coerce
10341036
1035−-- | Yaw angle. Indicates the leftward\/rightward angle that the face is
1036−-- pointing, relative to the vertical plane perpendicular to the image.
1037+-- | Yaw angle, which indicates the leftward\/rightward angle that the face
1038+-- is pointing relative to the vertical plane perpendicular to the image.
10371039-- Range [-180,180].
10381040faPanAngle :: Lens' FaceAnnotation (Maybe Double)
10391041faPanAngle
10401042 = lens _faPanAngle (\ s a -> s{_faPanAngle = a}) .
10411043 mapping _Coerce
10421044
1043−-- | Roll angle. Indicates the amount of clockwise\/anti-clockwise rotation
1044−-- of the face relative to the image vertical, about the axis perpendicular
1045−-- to the face. Range [-180,180].
1045+-- | Roll angle, which indicates the amount of clockwise\/anti-clockwise
1046+-- rotation of the face relative to the image vertical about the axis
1047+-- perpendicular to the face. Range [-180,180].
10461048faRollAngle :: Lens' FaceAnnotation (Maybe Double)
10471049faRollAngle
10481050 = lens _faRollAngle (\ s a -> s{_faRollAngle = a}) .
@@ -1054,12 +1056,12 @@ faUnderExposedLikelihood
10541056 = lens _faUnderExposedLikelihood
10551057 (\ s a -> s{_faUnderExposedLikelihood = a})
10561058
1057−-- | This bounding polygon is tighter than the previous 'boundingPoly', and
1058−-- encloses only the skin part of the face. Typically, it is used to
1059−-- eliminate the face from any image analysis that detects the \"amount of
1060−-- skin\" visible in an image. It is not based on the landmarker results,
1061−-- only on the initial face detection, hence the 'fd' (face detection)
1062−-- prefix.
1059+-- | The \`fd_bounding_poly\` bounding polygon is tighter than the
1060+-- \`boundingPoly\`, and encloses only the skin part of the face.
1061+-- Typically, it is used to eliminate the face from any image analysis that
1062+-- detects the \"amount of skin\" visible in an image. It is not based on
1063+-- the landmarker results, only on the initial face detection, hence the
1064+-- 'fd' (face detection) prefix.
10631065faFdBoundingPoly :: Lens' FaceAnnotation (Maybe BoundingPoly)
10641066faFdBoundingPoly
10651067 = lens _faFdBoundingPoly
@@ -1204,21 +1206,21 @@ eaScore
12041206 mapping _Coerce
12051207
12061208-- | The relevancy of the ICA (Image Content Annotation) label to the image.
1207−-- For example, the relevancy of \'tower\' to an image containing \'Eiffel
1208−-- Tower\' is likely higher than an image containing a distant towering
1209−-- building, though the confidence that there is a tower may be the same.
1210−-- Range [0, 1].
1209+-- For example, the relevancy of \"tower\" is likely higher to an image
1210+-- containing the detected \"Eiffel Tower\" than to an image containing a
1211+-- detected distant towering building, even though the confidence that
1212+-- there is a tower in each image may be the same. Range [0, 1].
12111213eaTopicality :: Lens' EntityAnnotation (Maybe Double)
12121214eaTopicality
12131215 = lens _eaTopicality (\ s a -> s{_eaTopicality = a})
12141216 . mapping _Coerce
12151217
12161218-- | The language code for the locale in which the entity textual
1217−-- 'description' (next field) is expressed.
1219+-- \`description\` is expressed.
12181220eaLocale :: Lens' EntityAnnotation (Maybe Text)
12191221eaLocale = lens _eaLocale (\ s a -> s{_eaLocale = a})
12201222
1221−-- | Image region to which this entity belongs. Not filled currently for
1223+-- | Image region to which this entity belongs. Currently not produced for
12221224-- \`LABEL_DETECTION\` features. For \`TEXT_DETECTION\` (OCR),
12231225-- \`boundingPoly\`s are produced for the entire text detected in an image
12241226-- region, followed by \`boundingPoly\`s for each word within the detected
@@ -1229,38 +1231,38 @@ eaBoundingPoly
12291231 (\ s a -> s{_eaBoundingPoly = a})
12301232
12311233-- | The accuracy of the entity detection in an image. For example, for an
1232−-- image containing \'Eiffel Tower,\' this field represents the confidence
1233−-- that there is a tower in the query image. Range [0, 1].
1234+-- image in which the \"Eiffel Tower\" entity is detected, this field
1235+-- represents the confidence that there is a tower in the query image.
1236+-- Range [0, 1].
12341237eaConfidence :: Lens' EntityAnnotation (Maybe Double)
12351238eaConfidence
12361239 = lens _eaConfidence (\ s a -> s{_eaConfidence = a})
12371240 . mapping _Coerce
12381241
1239−-- | Opaque entity ID. Some IDs might be available in Knowledge Graph(KG).
1240−-- For more details on KG please see:
1241−-- https:\/\/developers.google.com\/knowledge-graph\/
1242+-- | Opaque entity ID. Some IDs may be available in [Google Knowledge Graph
1243+-- Search API](https:\/\/developers.google.com\/knowledge-graph\/).
12421244eaMid :: Lens' EntityAnnotation (Maybe Text)
12431245eaMid = lens _eaMid (\ s a -> s{_eaMid = a})
12441246
12451247-- | The location information for the detected entity. Multiple
1246−-- 'LocationInfo' elements can be present since one location may indicate
1247−-- the location of the scene in the query image, and another the location
1248−-- of the place where the query image was taken. Location information is
1249−-- usually present for landmarks.
1248+-- \`LocationInfo\` elements can be present because one location may
1249+-- indicate the location of the scene in the image, and another location
1250+-- may indicate the location of the place where the image was taken.
1251+-- Location information is usually present for landmarks.
12501252eaLocations :: Lens' EntityAnnotation [LocationInfo]
12511253eaLocations
12521254 = lens _eaLocations (\ s a -> s{_eaLocations = a}) .
12531255 _Default
12541256 . _Coerce
12551257
1256−-- | Entity textual description, expressed in its 'locale' language.
1258+-- | Entity textual description, expressed in its \`locale\` language.
12571259eaDescription :: Lens' EntityAnnotation (Maybe Text)
12581260eaDescription
12591261 = lens _eaDescription
12601262 (\ s a -> s{_eaDescription = a})
12611263
1262−-- | Some entities can have additional optional 'Property' fields. For
1263−-- example a different kind of score or string that qualifies the entity.
1264+-- | Some entities may have optional user-supplied \`Property\` (name\/value)
1265+-- fields, such a score or string that qualifies the entity.
12641266eaProperties :: Lens' EntityAnnotation [Property]
12651267eaProperties
12661268 = lens _eaProperties (\ s a -> s{_eaProperties = a})
@@ -1375,10 +1377,11 @@ imageSource =
13751377 { _isGcsImageURI = Nothing
13761378 }
13771379
1378−-- | Google Cloud Storage image URI. It must be in the following form:
1379−-- \`gs:\/\/bucket_name\/object_name\`. For more details, please see:
1380−-- https:\/\/cloud.google.com\/storage\/docs\/reference-uris. NOTE: Cloud
1381−-- Storage object versioning is not supported!
1380+-- | Google Cloud Storage image URI, which must be in the following form:
1381+-- \`gs:\/\/bucket_name\/object_name\` (for details, see [Google Cloud
1382+-- Storage Request
1383+-- URIs](https:\/\/cloud.google.com\/storage\/docs\/reference-uris)). NOTE:
1384+-- Cloud Storage object versioning is not supported.
13821385isGcsImageURI :: Lens' ImageSource (Maybe Text)
13831386isGcsImageURI
13841387 = lens _isGcsImageURI
@@ -1394,9 +1397,6 @@ instance ToJSON ImageSource where
13941397 = object
13951398 (catMaybes [("gcsImageUri" .=) <$> _isGcsImageURI])
13961399
1397−-- | Set of features pertaining to the image, computed by various computer
1398−-- vision methods over safe-search verticals (for example, adult, spoof,
1399−-- medical, violence).
14001400--
14011401-- /See:/ 'safeSearchAnnotation' smart constructor.
14021402data SafeSearchAnnotation = SafeSearchAnnotation'
@@ -1427,16 +1427,16 @@ safeSearchAnnotation =
14271427 , _ssaViolence = Nothing
14281428 }
14291429
1430−-- | Spoof likelihood. The likelihood that an obvious modification was made
1431−-- to the image\'s canonical version to make it appear funny or offensive.
1430+-- | Spoof likelihood. The likelihood that an modification was made to the
1431+-- image\'s canonical version to make it appear funny or offensive.
14321432ssaSpoof :: Lens' SafeSearchAnnotation (Maybe SafeSearchAnnotationSpoof)
14331433ssaSpoof = lens _ssaSpoof (\ s a -> s{_ssaSpoof = a})
14341434
1435−-- | Represents the adult contents likelihood for the image.
1435+-- | Represents the adult content likelihood for the image.
14361436ssaAdult :: Lens' SafeSearchAnnotation (Maybe SafeSearchAnnotationAdult)
14371437ssaAdult = lens _ssaAdult (\ s a -> s{_ssaAdult = a})
14381438
1439−-- | Likelihood this is a medical image.
1439+-- | Likelihood that this is a medical image.
14401440ssaMedical :: Lens' SafeSearchAnnotation (Maybe SafeSearchAnnotationMedical)
14411441ssaMedical
14421442 = lens _ssaMedical (\ s a -> s{_ssaMedical = a})
@@ -1464,7 +1464,7 @@ instance ToJSON SafeSearchAnnotation where
14641464 ("medical" .=) <$> _ssaMedical,
14651465 ("violence" .=) <$> _ssaViolence])
14661466
1467−-- | Image context.
1467+-- | Image context and\/or feature-specific parameters.
14681468--
14691469-- /See:/ 'imageContext' smart constructor.
14701470data ImageContext = ImageContext'
@@ -1495,7 +1495,7 @@ imageContext =
14951495-- results (although it will be a significant hindrance if the hint is
14961496-- wrong). Text detection returns an error if one or more of the specified
14971497-- languages is not one of the [supported
1498−-- languages](\/translate\/v2\/translate-reference#supported_languages).
1498+-- languages](\/vision\/docs\/languages).
14991499icLanguageHints :: Lens' ImageContext [Text]
15001500icLanguageHints
15011501 = lens _icLanguageHints
@@ -1503,7 +1503,7 @@ icLanguageHints
15031503 . _Default
15041504 . _Coerce
15051505
1506−-- | Lat\/long rectangle that specifies the location of the image.
1506+-- | lat\/long rectangle that specifies the location of the image.
15071507icLatLongRect :: Lens' ImageContext (Maybe LatLongRect)
15081508icLatLongRect
15091509 = lens _icLatLongRect
@@ -1543,7 +1543,7 @@ dominantColorsAnnotation =
15431543 { _dcaColors = Nothing
15441544 }
15451545
1546−-- | RGB color values, with their score and pixel fraction.
1546+-- | RGB color values with their score and pixel fraction.
15471547dcaColors :: Lens' DominantColorsAnnotation [ColorInfo]
15481548dcaColors
15491549 = lens _dcaColors (\ s a -> s{_dcaColors = a}) .
@@ -1561,7 +1561,7 @@ instance ToJSON DominantColorsAnnotation where
15611561 toJSON DominantColorsAnnotation'{..}
15621562 = object (catMaybes [("colors" .=) <$> _dcaColors])
15631563
1564−-- | Rectangle determined by min and max LatLng pairs.
1564+-- | Rectangle determined by min and max \`LatLng\` pairs.
15651565--
15661566-- /See:/ 'latLongRect' smart constructor.
15671567data LatLongRect = LatLongRect'