Copyright	(c) 2015 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.FreebaseSearch

Contents

Service Configuration
API Declaration
Methods
- freebase.reconcile
- freebase.search
Types

Description

Find Freebase entities using textual queries and other constraints.

See: Freebase Search Reference

Synopsis

Service Configuration

freebaseSearchService :: Service 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

module Network.Google.Method.Freebase.Reconcile

freebase.search

module Network.Google.Method.Freebase.Search

Types

FreebaseSearchFormat

data FreebaseSearchFormat Source

Structural format of the json response.

Constructors

AC	`ac` Compact format useful for autocomplete/suggest UIs.
Classic	`classic` [DEPRECATED] Same format as was returned by api.freebase.com.
Entity	`entity` Basic information about the entities.
Guids	`guids` [DEPRECATED] Ordered list of a freebase guids.
Ids	`ids` Ordered list of freebase ids.
Mids	`mids` Ordered list of freebase 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.

Constructors

FSSEntity	`entity` Use freebase and popularity entity ranking.
FSSFreebase	`freebase` Use freebase entity ranking.
FSSSchema	`schema` Use schema ranking for properties and types.

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:

rgcHits
rgcMs

rgcHits :: Lens' ReconcileGetCosts (Maybe Int32) Source

Total number of hits found.

rgcMs :: Lens' ReconcileGetCosts (Maybe Int32) Source

Total milliseconds spent.

ReconcileGet

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.

Constructors

HTML	`html` Encode certain characters in the response (such as tags and ambersands) using html encoding.
Off	`off` No encoding of the response. You should not print the results directly on an web page without html-escaping the content first.

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
rcnId

rcnName :: Lens' ReconcileCandidateNotable (Maybe Text) Source

Name of notable category in specified language.

rcnId :: Lens' ReconcileCandidateNotable (Maybe Text) Source

MID of notable category.

ReconcileCandidate

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.

rcMid :: Lens' ReconcileCandidate (Maybe Text) Source

Freebase MID of candidate entity.

FreebaseSearchHelp

data FreebaseSearchHelp Source

The keyword to request help on.

Constructors

Langs	`langs` The language codes served by the service.
MAppings	`mappings` The property/path mappings supported by the filter and output request parameters.
Predicates	`predicates` The predicates and path-terminating properties supported by the filter and output request parameters.

FreebaseSearchSpell

data FreebaseSearchSpell Source

Request 'did you mean' suggestions

Constructors

Always	`always` Request spelling suggestions for any query at least three characters long.
NoResults	`no_results` Request spelling suggestions if no results were found.
NoSpelling	`no_spelling` Don't request spelling suggestions.

Enum FreebaseSearchFormat Source
Eq FreebaseSearchFormat Source
Data FreebaseSearchFormat Source
Ord FreebaseSearchFormat Source
Read FreebaseSearchFormat Source
Show FreebaseSearchFormat Source
Generic FreebaseSearchFormat Source
ToJSON FreebaseSearchFormat Source
FromJSON FreebaseSearchFormat Source
ToText FreebaseSearchFormat Source
FromText FreebaseSearchFormat Source
Hashable FreebaseSearchFormat Source
type Rep FreebaseSearchFormat Source

Eq ReconcileGetWarningItem Source
Data ReconcileGetWarningItem Source
Show ReconcileGetWarningItem Source
Generic ReconcileGetWarningItem Source
ToJSON ReconcileGetWarningItem Source
FromJSON ReconcileGetWarningItem Source
type Rep ReconcileGetWarningItem Source

Enum FreebaseSearchScoring Source
Eq FreebaseSearchScoring Source
Data FreebaseSearchScoring Source
Ord FreebaseSearchScoring Source
Read FreebaseSearchScoring Source
Show FreebaseSearchScoring Source
Generic FreebaseSearchScoring Source
ToJSON FreebaseSearchScoring Source
FromJSON FreebaseSearchScoring Source
ToText FreebaseSearchScoring Source
FromText FreebaseSearchScoring Source
Hashable FreebaseSearchScoring Source
type Rep FreebaseSearchScoring Source

Eq ReconcileGetCosts Source
Data ReconcileGetCosts Source
Show ReconcileGetCosts Source
Generic ReconcileGetCosts Source
ToJSON ReconcileGetCosts Source
FromJSON ReconcileGetCosts Source
type Rep ReconcileGetCosts Source

Eq ReconcileGet Source
Data ReconcileGet Source
Show ReconcileGet Source
Generic ReconcileGet Source
ToJSON ReconcileGet Source
FromJSON ReconcileGet Source
type Rep ReconcileGet Source

Enum FreebaseSearchEncode Source
Eq FreebaseSearchEncode Source
Data FreebaseSearchEncode Source
Ord FreebaseSearchEncode Source
Read FreebaseSearchEncode Source
Show FreebaseSearchEncode Source
Generic FreebaseSearchEncode Source
ToJSON FreebaseSearchEncode Source
FromJSON FreebaseSearchEncode Source
ToText FreebaseSearchEncode Source
FromText FreebaseSearchEncode Source
Hashable FreebaseSearchEncode Source
type Rep FreebaseSearchEncode Source

Eq ReconcileCandidateNotable Source
Data ReconcileCandidateNotable Source
Show ReconcileCandidateNotable Source
Generic ReconcileCandidateNotable Source
ToJSON ReconcileCandidateNotable Source
FromJSON ReconcileCandidateNotable Source
type Rep ReconcileCandidateNotable Source

Eq ReconcileCandidate Source
Data ReconcileCandidate Source
Show ReconcileCandidate Source
Generic ReconcileCandidate Source
ToJSON ReconcileCandidate Source
FromJSON ReconcileCandidate Source
type Rep ReconcileCandidate Source

Enum FreebaseSearchHelp Source
Eq FreebaseSearchHelp Source
Data FreebaseSearchHelp Source
Ord FreebaseSearchHelp Source
Read FreebaseSearchHelp Source
Show FreebaseSearchHelp Source
Generic FreebaseSearchHelp Source
ToJSON FreebaseSearchHelp Source
FromJSON FreebaseSearchHelp Source
ToText FreebaseSearchHelp Source
FromText FreebaseSearchHelp Source
Hashable FreebaseSearchHelp Source
type Rep FreebaseSearchHelp Source

Enum FreebaseSearchSpell Source
Eq FreebaseSearchSpell Source
Data FreebaseSearchSpell Source
Ord FreebaseSearchSpell Source
Read FreebaseSearchSpell Source
Show FreebaseSearchSpell Source
Generic FreebaseSearchSpell Source
ToJSON FreebaseSearchSpell Source
FromJSON FreebaseSearchSpell Source
ToText FreebaseSearchSpell Source
FromText FreebaseSearchSpell Source
Hashable FreebaseSearchSpell Source
type Rep FreebaseSearchSpell Source