Copyright	(c) CNRS 2017
License	AGPL + CECILL v3
Maintainer	team@gargantext.org
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.Core.Text.Corpus.API

Description

Synopsis

data ExternalAPIs
- = OpenAlex
- | PubMed
- | Arxiv
- | HAL
- | IsTex
- | Isidore
- | EPO
newtype RawQuery = RawQuery {
- getRawQuery :: Text
}
newtype Limit = Limit {
- getLimit :: Int
}
data GetCorpusError
- = InvalidInputQuery !RawQuery !Text
- | ExternalAPIError !ExternalAPIs !ClientError
get :: ExternalAPIs -> Lang -> RawQuery -> Maybe APIKey -> Maybe AuthKey -> Text -> Maybe Limit -> IO (Either GetCorpusError (Maybe Integer, ConduitT () HyperdataDocument IO ()))
externalAPIs :: [ExternalAPIs]

Documentation

data ExternalAPIs #

Main Types TODO IsidoreAuth

Constructors

OpenAlex
PubMed
Arxiv
HAL
IsTex
Isidore
EPO

Instances

Instances details

Arbitrary ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods arbitrary :: Gen ExternalAPIs # shrink :: ExternalAPIs -> [ExternalAPIs] #
FromJSON ExternalAPIs #	Main Instances
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods parseJSON :: Value -> Parser ExternalAPIs # parseJSONList :: Value -> Parser [ExternalAPIs] #
ToJSON ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods toJSON :: ExternalAPIs -> Value # toEncoding :: ExternalAPIs -> Encoding # toJSONList :: [ExternalAPIs] -> Value # toEncodingList :: [ExternalAPIs] -> Encoding #
Bounded ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods minBound :: ExternalAPIs # maxBound :: ExternalAPIs #
Enum ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods succ :: ExternalAPIs -> ExternalAPIs # pred :: ExternalAPIs -> ExternalAPIs # toEnum :: Int -> ExternalAPIs # fromEnum :: ExternalAPIs -> Int # enumFrom :: ExternalAPIs -> [ExternalAPIs] # enumFromThen :: ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] # enumFromTo :: ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] # enumFromThenTo :: ExternalAPIs -> ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] #
Generic ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type Rep ExternalAPIs :: Type -> Type # Methods from :: ExternalAPIs -> Rep ExternalAPIs x # to :: Rep ExternalAPIs x -> ExternalAPIs #
Show ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods showsPrec :: Int -> ExternalAPIs -> ShowS # show :: ExternalAPIs -> String # showList :: [ExternalAPIs] -> ShowS #
Eq ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods (==) :: ExternalAPIs -> ExternalAPIs -> Bool # (/=) :: ExternalAPIs -> ExternalAPIs -> Bool #
ToSchema ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods declareNamedSchema :: Proxy ExternalAPIs -> Declare (Definitions Schema) NamedSchema #
type Rep ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type Rep ExternalAPIs = D1 ('MetaData "ExternalAPIs" "Gargantext.API.Admin.Orchestrator.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) ((C1 ('MetaCons "OpenAlex" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PubMed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Arxiv" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "HAL" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IsTex" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Isidore" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EPO" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype RawQuery #

A raw query, as typed by the user from the frontend.

Constructors

RawQuery
Fields getRawQuery :: Text

Instances

Instances details

Arbitrary RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods arbitrary :: Gen RawQuery # shrink :: RawQuery -> [RawQuery] #
FromJSON RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods parseJSON :: Value -> Parser RawQuery # parseJSONList :: Value -> Parser [RawQuery] #
ToJSON RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods toJSON :: RawQuery -> Value # toEncoding :: RawQuery -> Encoding # toJSONList :: [RawQuery] -> Value # toEncodingList :: [RawQuery] -> Encoding #
IsString RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods fromString :: String -> RawQuery #
Show RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods showsPrec :: Int -> RawQuery -> ShowS # show :: RawQuery -> String # showList :: [RawQuery] -> ShowS #
Eq RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods (==) :: RawQuery -> RawQuery -> Bool # (/=) :: RawQuery -> RawQuery -> Bool #
FromHttpApiData RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods parseUrlPiece :: Text -> Either Text RawQuery # parseHeader :: ByteString -> Either Text RawQuery # parseQueryParam :: Text -> Either Text RawQuery #
ToHttpApiData RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods toUrlPiece :: RawQuery -> Text # toEncodedUrlPiece :: RawQuery -> Builder # toHeader :: RawQuery -> ByteString # toQueryParam :: RawQuery -> Text #
ToParamSchema RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy RawQuery -> ParamSchema t #
ToSchema RawQuery #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods declareNamedSchema :: Proxy RawQuery -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #

newtype Limit #

A limit to the number of results we want to retrieve.

Constructors

Limit
Fields getLimit :: Int

Instances

Instances details

FromJSON Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods parseJSON :: Value -> Parser Limit # parseJSONList :: Value -> Parser [Limit] #
ToJSON Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods toJSON :: Limit -> Value # toEncoding :: Limit -> Encoding # toJSONList :: [Limit] -> Value # toEncodingList :: [Limit] -> Encoding #
Num Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods (+) :: Limit -> Limit -> Limit # (-) :: Limit -> Limit -> Limit # (*) :: Limit -> Limit -> Limit # negate :: Limit -> Limit # abs :: Limit -> Limit # signum :: Limit -> Limit # fromInteger :: Integer -> Limit #
Show Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods showsPrec :: Int -> Limit -> ShowS # show :: Limit -> String # showList :: [Limit] -> ShowS #
Eq Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods (==) :: Limit -> Limit -> Bool # (/=) :: Limit -> Limit -> Bool #
FromHttpApiData Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods parseUrlPiece :: Text -> Either Text Limit # parseHeader :: ByteString -> Either Text Limit # parseQueryParam :: Text -> Either Text Limit #
ToHttpApiData Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods toUrlPiece :: Limit -> Text # toEncodedUrlPiece :: Limit -> Builder # toHeader :: Limit -> ByteString # toQueryParam :: Limit -> Text #
ToParamSchema Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy Limit -> ParamSchema t #
ToSchema Limit #
Instance details Defined in Gargantext.Core.Text.Corpus.Query Methods declareNamedSchema :: Proxy Limit -> Declare (Definitions Schema) NamedSchema #

data GetCorpusError #

Constructors

InvalidInputQuery !RawQuery !Text	We couldn't parse the user input query into something meaningful.
ExternalAPIError !ExternalAPIs !ClientError	The external service returned an error.

Instances

Instances details

Show GetCorpusError #
Instance details Defined in Gargantext.Core.Text.Corpus.API Methods showsPrec :: Int -> GetCorpusError -> ShowS # show :: GetCorpusError -> String # showList :: [GetCorpusError] -> ShowS #
ToHumanFriendlyError GetCorpusError #
Instance details Defined in Gargantext.Core.Text.Corpus.API Methods mkHumanFriendly :: GetCorpusError -> Text #
Eq GetCorpusError #
Instance details Defined in Gargantext.Core.Text.Corpus.API Methods (==) :: GetCorpusError -> GetCorpusError -> Bool # (/=) :: GetCorpusError -> GetCorpusError -> Bool #

get #

Arguments

:: ExternalAPIs
-> Lang	A user-selected language in which documents needs to be retrieved. If the provider doesn't support the search filtered by language, or if the language is not important, the frontend will simply send `EN` to the backend.
-> RawQuery
-> Maybe APIKey
-> Maybe AuthKey
-> Text
-> Maybe Limit
-> IO (Either GetCorpusError (Maybe Integer, ConduitT () HyperdataDocument IO ()))

Get External API metadata main function

externalAPIs :: [ExternalAPIs] #