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.Projects.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.projects.files.annotate.

Synopsis

type VisionProjectsFilesAnnotateResource = "v1p2beta1" :> (Capture "parent" Text :> ("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 VisionProjectsFilesAnnotate = VisionProjectsFilesAnnotate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- parent :: Text
- payload :: GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVisionProjectsFilesAnnotate :: Text -> GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest -> VisionProjectsFilesAnnotate

Resource

type VisionProjectsFilesAnnotateResource = "v1p2beta1" :> (Capture "parent" Text :> ("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.projects.files.annotate method which the VisionProjectsFilesAnnotate request conforms to.

Constructing a Request

data VisionProjectsFilesAnnotate 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: newVisionProjectsFilesAnnotate smart constructor.

Constructors

VisionProjectsFilesAnnotate

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
parent :: Text
Optional. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no parent is specified, a region will be chosen automatically. Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union. Example: projects/project-A/locations/eu.
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 VisionProjectsFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

Associated Types

type Rep VisionProjectsFilesAnnotate

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

type Rep VisionProjectsFilesAnnotate = D1 ('MetaData "VisionProjectsFilesAnnotate" "Gogol.Vision.Projects.Files.Annotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsFilesAnnotate" '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 "parent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 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 :: VisionProjectsFilesAnnotate -> Rep VisionProjectsFilesAnnotate x #

to :: Rep VisionProjectsFilesAnnotate x -> VisionProjectsFilesAnnotate #

Show VisionProjectsFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

Methods

showsPrec :: Int -> VisionProjectsFilesAnnotate -> ShowS #

show :: VisionProjectsFilesAnnotate -> String #

showList :: [VisionProjectsFilesAnnotate] -> ShowS #

Eq VisionProjectsFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

Methods

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

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

GoogleRequest VisionProjectsFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

Associated Types

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

Methods

requestClient :: VisionProjectsFilesAnnotate -> GClient (Rs VisionProjectsFilesAnnotate) #

type Rep VisionProjectsFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

type Rep VisionProjectsFilesAnnotate = D1 ('MetaData "VisionProjectsFilesAnnotate" "Gogol.Vision.Projects.Files.Annotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsFilesAnnotate" '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 "parent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 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))))))

type Rs VisionProjectsFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

type Rs VisionProjectsFilesAnnotate = GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse

type Scopes VisionProjectsFilesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Files.Annotate

type Scopes VisionProjectsFilesAnnotate = '[CloudPlatform'FullControl, CloudVision'FullControl]

newVisionProjectsFilesAnnotate Source #

Arguments

:: Text	Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. See `parent`.
-> GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest	Multipart request metadata. See `payload`.
-> VisionProjectsFilesAnnotate

Creates a value of VisionProjectsFilesAnnotate with the minimum fields required to make a request.