Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Language.Documents.AnalyzeEntities

Contents

REST Resource
Creating a Request
Request Lenses

Description

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

See: Cloud Natural Language API Reference for language.documents.analyzeEntities.

Synopsis

type DocumentsAnalyzeEntitiesResource = "v1" :> ("documents:analyzeEntities" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] AnalyzeEntitiesRequest :> Post '[JSON] AnalyzeEntitiesResponse))))))))
documentsAnalyzeEntities :: AnalyzeEntitiesRequest -> DocumentsAnalyzeEntities
data DocumentsAnalyzeEntities
daeXgafv :: Lens' DocumentsAnalyzeEntities (Maybe Xgafv)
daeUploadProtocol :: Lens' DocumentsAnalyzeEntities (Maybe Text)
daeAccessToken :: Lens' DocumentsAnalyzeEntities (Maybe Text)
daeUploadType :: Lens' DocumentsAnalyzeEntities (Maybe Text)
daePayload :: Lens' DocumentsAnalyzeEntities AnalyzeEntitiesRequest
daeCallback :: Lens' DocumentsAnalyzeEntities (Maybe Text)

REST Resource

type DocumentsAnalyzeEntitiesResource = "v1" :> ("documents:analyzeEntities" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] AnalyzeEntitiesRequest :> Post '[JSON] AnalyzeEntitiesResponse)))))))) Source #

A resource alias for language.documents.analyzeEntities method which the DocumentsAnalyzeEntities request conforms to.

Creating a Request

documentsAnalyzeEntities Source #

Arguments

:: AnalyzeEntitiesRequest	`daePayload`
-> DocumentsAnalyzeEntities

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

Use one of the following lenses to modify other fields as desired:

data DocumentsAnalyzeEntities Source #

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

See: documentsAnalyzeEntities smart constructor.

Instances

Eq DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities Methods (==) :: DocumentsAnalyzeEntities -> DocumentsAnalyzeEntities -> Bool # (/=) :: DocumentsAnalyzeEntities -> DocumentsAnalyzeEntities -> Bool #
Data DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentsAnalyzeEntities -> c DocumentsAnalyzeEntities # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentsAnalyzeEntities # toConstr :: DocumentsAnalyzeEntities -> Constr # dataTypeOf :: DocumentsAnalyzeEntities -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DocumentsAnalyzeEntities) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentsAnalyzeEntities) # gmapT :: (forall b. Data b => b -> b) -> DocumentsAnalyzeEntities -> DocumentsAnalyzeEntities # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentsAnalyzeEntities -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentsAnalyzeEntities -> r # gmapQ :: (forall d. Data d => d -> u) -> DocumentsAnalyzeEntities -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentsAnalyzeEntities -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentsAnalyzeEntities -> m DocumentsAnalyzeEntities # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentsAnalyzeEntities -> m DocumentsAnalyzeEntities # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentsAnalyzeEntities -> m DocumentsAnalyzeEntities #
Show DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities Methods showsPrec :: Int -> DocumentsAnalyzeEntities -> ShowS # show :: DocumentsAnalyzeEntities -> String # showList :: [DocumentsAnalyzeEntities] -> ShowS #
Generic DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities Associated Types type Rep DocumentsAnalyzeEntities :: Type -> Type # Methods from :: DocumentsAnalyzeEntities -> Rep DocumentsAnalyzeEntities x # to :: Rep DocumentsAnalyzeEntities x -> DocumentsAnalyzeEntities #
GoogleRequest DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities Associated Types type Rs DocumentsAnalyzeEntities :: Type # type Scopes DocumentsAnalyzeEntities :: [Symbol] # Methods requestClient :: DocumentsAnalyzeEntities -> GClient (Rs DocumentsAnalyzeEntities) #
type Rep DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities type Rep DocumentsAnalyzeEntities = D1 (MetaData "DocumentsAnalyzeEntities" "Network.Google.Resource.Language.Documents.AnalyzeEntities" "gogol-language-0.4.0-5pnSmGql6DrGvyDSKlfn7G" False) (C1 (MetaCons "DocumentsAnalyzeEntities'" PrefixI True) ((S1 (MetaSel (Just "_daeXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_daeUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_daeAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_daeUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_daePayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AnalyzeEntitiesRequest) :*: S1 (MetaSel (Just "_daeCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities type Scopes DocumentsAnalyzeEntities = "https://www.googleapis.com/auth/cloud-language" ': ("https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol]))
type Rs DocumentsAnalyzeEntities Source #
Instance details Defined in Network.Google.Resource.Language.Documents.AnalyzeEntities type Rs DocumentsAnalyzeEntities = AnalyzeEntitiesResponse

Request Lenses

daeXgafv :: Lens' DocumentsAnalyzeEntities (Maybe Xgafv) Source #

V1 error format.

daeUploadProtocol :: Lens' DocumentsAnalyzeEntities (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

daeAccessToken :: Lens' DocumentsAnalyzeEntities (Maybe Text) Source #

OAuth access token.

daeUploadType :: Lens' DocumentsAnalyzeEntities (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

daePayload :: Lens' DocumentsAnalyzeEntities AnalyzeEntitiesRequest Source #

Multipart request metadata.

daeCallback :: Lens' DocumentsAnalyzeEntities (Maybe Text) Source #

JSONP