Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+gogol@gmail.com> Toni Cebrián <toni@tonicebrian.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Vision.Files.Annotate

Contents

Resource
- Constructing a Request

Description

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

See: Cloud Vision API Reference for vision.files.annotate.

Synopsis

type VisionFilesAnnotateResource = "v1p2beta1" :> ("files:annotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest :> Post '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse))))))))
data VisionFilesAnnotate = VisionFilesAnnotate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- payload :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVisionFilesAnnotate :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest -> VisionFilesAnnotate

Resource

type VisionFilesAnnotateResource = "v1p2beta1" :> ("files:annotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest :> Post '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse)))))))) Source #

A resource alias for vision.files.annotate method which the VisionFilesAnnotate request conforms to.

Constructing a Request

data VisionFilesAnnotate Source #

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

See: newVisionFilesAnnotate smart constructor.

Constructors

VisionFilesAnnotate
Fields xgafv :: Maybe Xgafv V1 error format. accessToken :: Maybe Text OAuth access token. callback :: Maybe Text JSONP payload :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest Multipart request metadata. uploadType :: Maybe Text Legacy upload protocol for media (e.g. "media", "multipart"). uploadProtocol :: Maybe Text Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic VisionFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Files.Annotate

Associated Types

type Rep VisionFilesAnnotate

Instance details

Defined in Gogol.Vision.Files.Annotate

type Rep VisionFilesAnnotate = D1 ('MetaData "VisionFilesAnnotate" "Gogol.Vision.Files.Annotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionFilesAnnotate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: VisionFilesAnnotate -> Rep VisionFilesAnnotate x #

to :: Rep VisionFilesAnnotate x -> VisionFilesAnnotate #

Show VisionFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Files.Annotate

Methods

showsPrec :: Int -> VisionFilesAnnotate -> ShowS #

show :: VisionFilesAnnotate -> String #

showList :: [VisionFilesAnnotate] -> ShowS #

Eq VisionFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Files.Annotate

Methods

(==) :: VisionFilesAnnotate -> VisionFilesAnnotate -> Bool #

(/=) :: VisionFilesAnnotate -> VisionFilesAnnotate -> Bool #

GoogleRequest VisionFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Files.Annotate

Associated Types

type Rs VisionFilesAnnotate
Instance details Defined in Gogol.Vision.Files.Annotate type Rs VisionFilesAnnotate = GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse
type Scopes VisionFilesAnnotate
Instance details Defined in Gogol.Vision.Files.Annotate type Scopes VisionFilesAnnotate = '[CloudPlatform'FullControl, CloudVision'FullControl]