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 |
Find Freebase entities using textual queries and other constraints.
- freebaseSearchService :: ServiceConfig
- type FreebaseSearchAPI = ReconcileMethod :<|> SearchMethod
- module Network.Google.Method.Freebase.Reconcile
- module Network.Google.Method.Freebase.Search
- data FreebaseSearchFormat
- data ReconcileGetWarningItem
- reconcileGetWarningItem :: ReconcileGetWarningItem
- rgwiLocation :: Lens' ReconcileGetWarningItem (Maybe Text)
- rgwiReason :: Lens' ReconcileGetWarningItem (Maybe Text)
- rgwiMessage :: Lens' ReconcileGetWarningItem (Maybe Text)
- data FreebaseSearchScoring
- data ReconcileGetCosts
- reconcileGetCosts :: ReconcileGetCosts
- rgcHits :: Lens' ReconcileGetCosts (Maybe Int32)
- rgcMs :: Lens' ReconcileGetCosts (Maybe Int32)
- data ReconcileGet
- reconcileGet :: ReconcileGet
- rgCandidate :: Lens' ReconcileGet [ReconcileCandidate]
- rgCosts :: Lens' ReconcileGet (Maybe ReconcileGetCosts)
- rgWarning :: Lens' ReconcileGet [ReconcileGetWarningItem]
- rgMatch :: Lens' ReconcileGet (Maybe ReconcileCandidate)
- data FreebaseSearchEncode
- data ReconcileCandidateNotable
- reconcileCandidateNotable :: ReconcileCandidateNotable
- rcnName :: Lens' ReconcileCandidateNotable (Maybe Text)
- rcnId :: Lens' ReconcileCandidateNotable (Maybe Text)
- data ReconcileCandidate
- reconcileCandidate :: ReconcileCandidate
- rcLang :: Lens' ReconcileCandidate (Maybe Text)
- rcConfidence :: Lens' ReconcileCandidate (Maybe Double)
- rcName :: Lens' ReconcileCandidate (Maybe Text)
- rcNotable :: Lens' ReconcileCandidate (Maybe ReconcileCandidateNotable)
- rcMid :: Lens' ReconcileCandidate (Maybe Text)
- data FreebaseSearchHelp
- = Langs
- | MAppings
- | Predicates
- data FreebaseSearchSpell
Service Configuration
freebaseSearchService :: ServiceConfig Source #
Default request referring to version v1
of the Freebase Search. This contains the host and root path used as a starting point for constructing service requests.
API Declaration
type FreebaseSearchAPI = ReconcileMethod :<|> SearchMethod Source #
Represents the entirety of the methods and resources available for the Freebase Search service.
Methods
freebase.reconcile
freebase.search
Types
FreebaseSearchFormat
data FreebaseSearchFormat Source #
Structural format of the json response.
AC |
|
Classic |
|
Entity |
|
Guids |
|
Ids |
|
Mids |
|
ReconcileGetWarningItem
reconcileGetWarningItem :: ReconcileGetWarningItem Source #
Creates a value of ReconcileGetWarningItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rgwiLocation :: Lens' ReconcileGetWarningItem (Maybe Text) Source #
Location of warning in the request e.g. invalid predicate.
rgwiReason :: Lens' ReconcileGetWarningItem (Maybe Text) Source #
Code for identifying classes of warnings.
rgwiMessage :: Lens' ReconcileGetWarningItem (Maybe Text) Source #
Warning message to display to the user.
FreebaseSearchScoring
data FreebaseSearchScoring Source #
Relevance scoring algorithm to use.
FSSEntity |
|
FSSFreebase |
|
FSSSchema |
|
ReconcileGetCosts
data ReconcileGetCosts Source #
Server costs for reconciling.
See: reconcileGetCosts
smart constructor.
reconcileGetCosts :: ReconcileGetCosts Source #
Creates a value of ReconcileGetCosts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ReconcileGet
data ReconcileGet Source #
reconcileGet :: ReconcileGet Source #
Creates a value of ReconcileGet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rgCandidate :: Lens' ReconcileGet [ReconcileCandidate] Source #
If filled, then the listed candidates are potential matches, and such should be evaluated by a more discerning algorithm or human. The matches are ordered by confidence.
rgCosts :: Lens' ReconcileGet (Maybe ReconcileGetCosts) Source #
Server costs for reconciling.
rgWarning :: Lens' ReconcileGet [ReconcileGetWarningItem] Source #
If filled, then there were recoverable problems that affected the request. For example, some of the properties were ignored because they either are not valid Freebase predicates or are not indexed for reconciliation. The candidates returned should be considered valid results, with the caveat that sections of the request were ignored as specified by the warning text.
rgMatch :: Lens' ReconcileGet (Maybe ReconcileCandidate) Source #
If filled, this entity is guaranteed to match at requested confidence probability (default 99%).
FreebaseSearchEncode
data FreebaseSearchEncode Source #
The encoding of the response. You can use this parameter to enable html encoding.
HTML |
|
Off |
|
ReconcileCandidateNotable
data ReconcileCandidateNotable Source #
Type or profession the candidate is notable for.
See: reconcileCandidateNotable
smart constructor.
reconcileCandidateNotable :: ReconcileCandidateNotable Source #
Creates a value of ReconcileCandidateNotable
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcnName :: Lens' ReconcileCandidateNotable (Maybe Text) Source #
Name of notable category in specified language.
ReconcileCandidate
data ReconcileCandidate Source #
reconcileCandidate :: ReconcileCandidate Source #
Creates a value of ReconcileCandidate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcLang :: Lens' ReconcileCandidate (Maybe Text) Source #
Language code that candidate and notable names are displayed in.
rcConfidence :: Lens' ReconcileCandidate (Maybe Double) Source #
Percentage likelihood that this candidate is the unique matching entity. Value will be between 0.0 and 1.0
rcName :: Lens' ReconcileCandidate (Maybe Text) Source #
Freebase name of matching entity in specified language.
rcNotable :: Lens' ReconcileCandidate (Maybe ReconcileCandidateNotable) Source #
Type or profession the candidate is notable for.
FreebaseSearchHelp
data FreebaseSearchHelp Source #
The keyword to request help on.
Langs |
|
MAppings |
|
Predicates |
|
FreebaseSearchSpell
data FreebaseSearchSpell Source #
Request 'did you mean' suggestions
Always |
|
NoResults |
|
NoSpelling |
|