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

Gargantext.Database.Action.Flow

Contents

Orphan instances

Description

- TODO-ACCESS:
- check userId CanFillUserCorpus userCorpusId
- check masterUserId CanFillMasterCorpus masterCorpusId
- TODO-ACCESS: check uId CanInsertDoc pId && checkDocType nodeType
- TODO-EVENTS: InsertedNodes

Synopsis

data DataText
- = DataOld ![NodeId]
- | DataNew ![[HyperdataDocument]]
getDataText :: FlowCmdM env err m => DataOrigin -> TermType Lang -> Query -> Maybe Limit -> m DataText
flowDataText :: FlowCmdM env err m => User -> DataText -> TermType Lang -> CorpusId -> Maybe FlowSocialListWith -> (JobLog -> m ()) -> m CorpusId
flow :: (FlowCmdM env err m, FlowCorpus a, MkCorpus c) => Maybe c -> User -> Either CorpusName [CorpusId] -> TermType Lang -> Maybe FlowSocialListWith -> [[a]] -> (JobLog -> m ()) -> m CorpusId
flowCorpusFile :: FlowCmdM env err m => User -> Either CorpusName [CorpusId] -> Limit -> TermType Lang -> FileFormat -> FilePath -> Maybe FlowSocialListWith -> (JobLog -> m ()) -> m CorpusId
flowCorpus :: (FlowCmdM env err m, FlowCorpus a) => User -> Either CorpusName [CorpusId] -> TermType Lang -> Maybe FlowSocialListWith -> [[a]] -> (JobLog -> m ()) -> m CorpusId
flowAnnuaire :: FlowCmdM env err m => User -> Either CorpusName [CorpusId] -> TermType Lang -> FilePath -> (JobLog -> m ()) -> m AnnuaireId
insertMasterDocs :: (FlowCmdM env err m, FlowCorpus a, MkCorpus c) => Maybe c -> TermType Lang -> [a] -> m [DocId]
saveDocNgramsWith :: FlowCmdM env err m => ListId -> HashMap ExtractedNgrams (Map NgramsType (Map NodeId Int)) -> m ()
getOrMkRoot :: HasNodeError err => User -> Cmd err (UserId, RootId)
getOrMk_RootWithCorpus :: (HasNodeError err, MkCorpus a) => User -> Either CorpusName [CorpusId] -> Maybe a -> Cmd err (UserId, RootId, CorpusId)
data TermType lang
- = Mono {
  - _tt_lang :: !lang
  }
- | Multi {
  - _tt_lang :: !lang
  }
- | MonoMulti {
  - _tt_lang :: !lang
  }
- | Unsupervised {
  - _tt_lang :: !lang
  - _tt_windowSize :: !Int
  - _tt_ngramsSize :: !Int
  - _tt_model :: !(Maybe (Tries Token ()))
  }
data DataOrigin
- = InternalOrigin {
  - _do_api :: ExternalAPIs
  }
- | ExternalOrigin {
  - _do_api :: ExternalAPIs
  }
allDataOrigins :: [DataOrigin]
do_api :: Lens' DataOrigin ExternalAPIs
indexAllDocumentsWithPosTag :: FlowCmdM env err m => m ()

Documentation

data DataText Source #

Constructors

DataOld ![NodeId]
DataNew ![[HyperdataDocument]]

getDataText :: FlowCmdM env err m => DataOrigin -> TermType Lang -> Query -> Maybe Limit -> m DataText Source #

flowDataText :: FlowCmdM env err m => User -> DataText -> TermType Lang -> CorpusId -> Maybe FlowSocialListWith -> (JobLog -> m ()) -> m CorpusId Source #

flow :: (FlowCmdM env err m, FlowCorpus a, MkCorpus c) => Maybe c -> User -> Either CorpusName [CorpusId] -> TermType Lang -> Maybe FlowSocialListWith -> [[a]] -> (JobLog -> m ()) -> m CorpusId Source #

flowCorpusFile :: FlowCmdM env err m => User -> Either CorpusName [CorpusId] -> Limit -> TermType Lang -> FileFormat -> FilePath -> Maybe FlowSocialListWith -> (JobLog -> m ()) -> m CorpusId Source #

flowCorpus :: (FlowCmdM env err m, FlowCorpus a) => User -> Either CorpusName [CorpusId] -> TermType Lang -> Maybe FlowSocialListWith -> [[a]] -> (JobLog -> m ()) -> m CorpusId Source #

TODO improve the needed type to create/update a corpus (For now, Either is enough)

flowAnnuaire :: FlowCmdM env err m => User -> Either CorpusName [CorpusId] -> TermType Lang -> FilePath -> (JobLog -> m ()) -> m AnnuaireId Source #

insertMasterDocs :: (FlowCmdM env err m, FlowCorpus a, MkCorpus c) => Maybe c -> TermType Lang -> [a] -> m [DocId] Source #

saveDocNgramsWith :: FlowCmdM env err m => ListId -> HashMap ExtractedNgrams (Map NgramsType (Map NodeId Int)) -> m () Source #

getOrMkRoot :: HasNodeError err => User -> Cmd err (UserId, RootId) Source #

getOrMk_RootWithCorpus :: (HasNodeError err, MkCorpus a) => User -> Either CorpusName [CorpusId] -> Maybe a -> Cmd err (UserId, RootId, CorpusId) Source #

data TermType lang Source #

Constructors

Mono
Fields _tt_lang :: !lang
Multi
Fields _tt_lang :: !lang
MonoMulti
Fields _tt_lang :: !lang
Unsupervised
Fields _tt_lang :: !lang _tt_windowSize :: !Int _tt_ngramsSize :: !Int _tt_model :: !(Maybe (Tries Token ()))

Instances

Instances details

Generic (TermType lang) Source #
Instance details Defined in Gargantext.Core.Text.Terms Associated Types type Rep (TermType lang) :: Type -> Type # Methods from :: TermType lang -> Rep (TermType lang) x # to :: Rep (TermType lang) x -> TermType lang #
type Rep (TermType lang) Source #
Instance details Defined in Gargantext.Core.Text.Terms type Rep (TermType lang)

data DataOrigin Source #

Constructors

InternalOrigin
Fields _do_api :: ExternalAPIs
ExternalOrigin
Fields _do_api :: ExternalAPIs

Instances

Instances details

Eq DataOrigin Source #
Instance details Defined in Gargantext.Database.Action.Flow Methods (==) :: DataOrigin -> DataOrigin -> Bool # (/=) :: DataOrigin -> DataOrigin -> Bool #
Generic DataOrigin Source #
Instance details Defined in Gargantext.Database.Action.Flow Associated Types type Rep DataOrigin :: Type -> Type # Methods from :: DataOrigin -> Rep DataOrigin x # to :: Rep DataOrigin x -> DataOrigin #
ToJSON DataOrigin Source #
Instance details Defined in Gargantext.Database.Action.Flow Methods toJSON :: DataOrigin -> Value # toEncoding :: DataOrigin -> Encoding # toJSONList :: [DataOrigin] -> Value # toEncodingList :: [DataOrigin] -> Encoding #
FromJSON DataOrigin Source #
Instance details Defined in Gargantext.Database.Action.Flow Methods parseJSON :: Value -> Parser DataOrigin # parseJSONList :: Value -> Parser [DataOrigin] #
ToSchema DataOrigin Source #
Instance details Defined in Gargantext.Database.Action.Flow Methods declareNamedSchema :: Proxy DataOrigin -> Declare (Definitions Schema) NamedSchema #
type Rep DataOrigin Source #
Instance details Defined in Gargantext.Database.Action.Flow type Rep DataOrigin = D1 ('MetaData "DataOrigin" "Gargantext.Database.Action.Flow" "gargantext-0.0.4.9.5-IFz7nHafad4HfDNkPsR1x8" 'False) (C1 ('MetaCons "InternalOrigin" 'PrefixI 'True) (S1 ('MetaSel ('Just "_do_api") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExternalAPIs)) :+: C1 ('MetaCons "ExternalOrigin" 'PrefixI 'True) (S1 ('MetaSel ('Just "_do_api") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExternalAPIs)))

allDataOrigins :: [DataOrigin] Source #

do_api :: Lens' DataOrigin ExternalAPIs Source #

indexAllDocumentsWithPosTag :: FlowCmdM env err m => m () Source #

TODO putelsewhere | Upgrade function Suppose all documents are English (this is the case actually)

Orphan instances

ExtractNgramsT HyperdataDocument Source #
Instance details Methods extractNgramsT :: HasText HyperdataDocument => TermType Lang -> HyperdataDocument -> Cmd err (HashMap ExtractedNgrams (Map NgramsType Int)) Source #
ExtractNgramsT HyperdataContact Source #
Instance details Methods extractNgramsT :: HasText HyperdataContact => TermType Lang -> HyperdataContact -> Cmd err (HashMap ExtractedNgrams (Map NgramsType Int)) Source #
HasText a => HasText (Node a) Source #
Instance details Methods hasText :: Node a -> [Text] Source #
(ExtractNgramsT a, HasText a) => ExtractNgramsT (Node a) Source #
Instance details Methods extractNgramsT :: HasText (Node a) => TermType Lang -> Node a -> Cmd err (HashMap ExtractedNgrams (Map NgramsType Int)) Source #