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.Images.Annotate

Contents

Resource
- Constructing a Request

Description

Run image detection and annotation for a batch of images.

See: Cloud Vision API Reference for vision.projects.images.annotate.

Synopsis

type VisionProjectsImagesAnnotateResource = "v1p2beta1" :> (Capture "parent" Text :> ("images:annotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest :> Post '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse)))))))))
data VisionProjectsImagesAnnotate = VisionProjectsImagesAnnotate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- parent :: Text
- payload :: GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVisionProjectsImagesAnnotate :: Text -> GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest -> VisionProjectsImagesAnnotate

Resource

type VisionProjectsImagesAnnotateResource = "v1p2beta1" :> (Capture "parent" Text :> ("images:annotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest :> Post '[JSON] GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse))))))))) Source #

A resource alias for vision.projects.images.annotate method which the VisionProjectsImagesAnnotate request conforms to.

Constructing a Request

data VisionProjectsImagesAnnotate Source #

Run image detection and annotation for a batch of images.

See: newVisionProjectsImagesAnnotate smart constructor.

Constructors

VisionProjectsImagesAnnotate

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 :: GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest
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 VisionProjectsImagesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

Associated Types

type Rep VisionProjectsImagesAnnotate

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

type Rep VisionProjectsImagesAnnotate = D1 ('MetaData "VisionProjectsImagesAnnotate" "Gogol.Vision.Projects.Images.Annotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsImagesAnnotate" '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 GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: VisionProjectsImagesAnnotate -> Rep VisionProjectsImagesAnnotate x #

to :: Rep VisionProjectsImagesAnnotate x -> VisionProjectsImagesAnnotate #

Show VisionProjectsImagesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

Methods

showsPrec :: Int -> VisionProjectsImagesAnnotate -> ShowS #

show :: VisionProjectsImagesAnnotate -> String #

showList :: [VisionProjectsImagesAnnotate] -> ShowS #

Eq VisionProjectsImagesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

Methods

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

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

GoogleRequest VisionProjectsImagesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

Associated Types

type Rs VisionProjectsImagesAnnotate
Instance details Defined in Gogol.Vision.Projects.Images.Annotate type Rs VisionProjectsImagesAnnotate = GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse
type Scopes VisionProjectsImagesAnnotate
Instance details Defined in Gogol.Vision.Projects.Images.Annotate type Scopes VisionProjectsImagesAnnotate = '[CloudPlatform'FullControl, CloudVision'FullControl]

Methods

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

type Rep VisionProjectsImagesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

type Rep VisionProjectsImagesAnnotate = D1 ('MetaData "VisionProjectsImagesAnnotate" "Gogol.Vision.Projects.Images.Annotate" "gogol-vision-1.0.0-5I8flikCegP9Y27tYWivCE" 'False) (C1 ('MetaCons "VisionProjectsImagesAnnotate" '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 GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

type Rs VisionProjectsImagesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

type Rs VisionProjectsImagesAnnotate = GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse

type Scopes VisionProjectsImagesAnnotate Source #

Instance details

Defined in Gogol.Vision.Projects.Images.Annotate

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

newVisionProjectsImagesAnnotate 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`.
-> GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest	Multipart request metadata. See `payload`.
-> VisionProjectsImagesAnnotate

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