babelnet.apis.abstract_api.AbstractAPI

class documentation

class AbstractAPI(object):

Known subclasses: babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI, babelnet.apis.rpc_api.RPCApi

View In Hierarchy

The Abstract api.

Method	`get_senses`	Get the senses of synsets searched by words or by ResourceIDs, satisfying the optional constraints.
Method	`get_senses_containing`	Get the senses of synsets containing the word with the given constraints.
Method	`get_senses_from`	Get the senses of synsets from the word with the given constraints.
Method	`get_synset`	Return the synset identified by the ResourceID in input.
Method	`get_synsets`	Get synsets by words or by ResourceIDs, satisfying the optional constraints.
Method	`iterator`	Create a new instance of BabelSynset iterator.
Method	`lexicon_iterator`	Create a new instance of a lexicon iterator.
Method	`offset_iterator`	Create a new instance of an offset iterator.
Method	`to_babelnet_synsets`	Get a BabelSytnset using the languages passed as input and an id_.
Method	`to_synsets`	Convert from ResourceID to the corresponding BabelSynset.
Method	`version`	Get the version of loaded BabelNet indices.
Method	`wordnet_iterator`	Create a new instance of a WordNet iterator.
Method	`_get_outgoing_edges`	Return the outgoing edges from a given BabelSynsetID
Method	`_get_senses`	Private version of get_senses().
Method	`_get_synsets`	Private version of get_synsets()
Method	`_mapping_from_ids`	Get the mapping from BabelSynsetID to _InternalBabelSynsetID.
Method	`_prepare_kwargs`	Prepare the input data by trasforming each iterable in an ordered set.
Method	`_to_wordnet_synsets`	Convert a WordNetSynsetID into a Synset.
Method	`examples`	Get the examples (in the specified languages) of a BabelSynsetID.
Method	`get_outgoing_edges`	Return the outgoing edges from a given BabelSynsetID
Method	`glosses`	Get the glosses (in the specified languages) of a BabelSysetID.
Method	`images`	Get the images of a BabelSynsetID.

def get_senses(self, *args, **kwargs):

overridden in babelnet.apis.local_api.LocalAPI

Get the senses of synsets searched by words or by ResourceIDs, satisfying the optional constraints.

Parameters
*args:`Union[str`, `ResourceID]`	A homogeneous collection of words (str) or ResourceIDs used to search for senses in synsets.
**kwargs	keyword arguemts.
containing:`bool`	Used if the senses are searched by words: if it is True, the words have to be contained in the sense (default False).
from_langs:`Iterable[Language]`	An iterable collection of Languages used for searching the senses.
to_langs:`Iterable[Language]`	An iterable collection of Languages in which the senses are to be retrieved.
poses:`Iterable[POS]`	An iterable collection of Parts of Speech of the senses.
normalized:`bool`	True if the search is insensitive to accents, etc. (default True).
sources:`Iterable[BabelSenseSource]`	An iterable collection of BabelSenseSources used to restrict the search.
synset_filters:`Iterable[Callable[[BabelSynset]`, `bool]]`	An iterable collection of filters (functions accepting a BabelSynset and returning bool) to be applied to each synset retrieved.
sense_filters:`Iterable[Callable[[BabelSynset]`, `bool]]`	An iterable collection of filters (functions accepting a BabelSense and returning bool) to be applied to each sense retrieved.
Returns
`List[BabelSense]`	The resulting senses.
Raises
`ValueError`	If arg is not an homogeneous collection

def get_senses_containing(self, word, language=None, pos=None, to_langs=None):

overridden in babelnet.apis.local_api.LocalAPI

Get the senses of synsets containing the word with the given constraints.

Parameters
word:`str`	The word whose senses are to be retrieved.
language:`Optional[Language]`	The language of the input word.
pos:`Optional[POS]`	The Part of Speech of the word.
to_langs:`Optional[Set[Language]]`	An iterable collection of Languages in which the senses are to be retrieved.
Returns
`List[BabelSense]`	The senses of the word.

def get_senses_from(self, word, language=None, pos=None, to_langs=None):

overridden in babelnet.apis.local_api.LocalAPI

Get the senses of synsets from the word with the given constraints.

Parameters
word:`str`	The word whose senses are to be retrieved.
language:`Optional[Language]`	The language of the input word.
pos:`Optional[POS]`	The Part of Speech of the word.
to_langs:`Optional[Set[Language]]`	An iterable collection of Languages in which the senses are to be retrieved.
Returns
`List[BabelSense]`	The senses of the word.

def get_synset(self, resource_id, to_langs=None):

overridden in babelnet.apis.local_api.LocalAPI

Return the synset identified by the ResourceID in input.

Some examples that can be used follow:

    import babelnet as bn

    # Retrieving BabelSynset from a Wikipedia page title:
    synset = bn.get_synset(WikipediaID('BabelNet', Language.EN, POS.NOUN))

    # Retrieving BabelSynset from a WordNet id:
    synset = bn.get_synset(WordNetSynsetID('wn:03544360n'))

    # Retrieving BabelSynset from a Wikidata page id:
    synset = bn.get_synset(WikidataID('Q4837690'))

    # Retrieving BabelSynset from a OmegaWiki page id:
    synset = bn.get_synset(OmegaWikiID('1499705'))

Parameters
resource_id:`ResourceID`	The resource identifier.
to_langs:`Optional[Set[Language]]`	A set of languages to use. If passed as input, the results in those languages will be returned.
Returns
`Optional[BabelSynset]`	The synset identified by the ResourceID.

def get_synsets(self, *args, **kwargs):

overridden in babelnet.apis.local_api.LocalAPI

Get synsets by words or by ResourceIDs, satisfying the optional constraints.

Parameters
*args:`Union[str`, `ResourceID]`	A homogeneous collection of words (str) or ResourceIDs used to search for synsets or senses in synsets.
**kwargs	keyword arguemts.
containing:`bool`	Used if the senses are searched by words: if it is True, the words have to be contained in the sense (default False).
from_langs:`Iterable[Language]`	An iterable collection of Languages used for searching the senses.
to_langs:`Iterable[Language]`	An iterable collection of Languages in which the senses are to be retrieved.
poses:`Iterable[POS]`	An iterable collection of Parts of Speech of the senses.
normalized:`bool`	True if the search is insensitive to accents, etc. (default True).
sources:`Iterable[BabelSenseSource]`	An iterable collection of BabelSenseSources used to restrict the search.
synset_filters:`Iterable[Callable[[BabelSynset]`, `bool]]`	An iterable collection of filters (functions accepting a BabelSynset and returning bool) to be applied to each synset retrieved.
sense_filters:`Iterable[Callable[[BabelSynset]`, `bool]]`	An iterable collection of filters (functions accepting a BabelSense and returning bool) to be applied to each sense retrieved.
Returns
`List[BabelSynset]`	The resulting synsets.
Raises
`ValueError`	If arg is not an homogeneous collection

@abstractmethod
def iterator(self):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Create a new instance of BabelSynset iterator.

Returns
`BabelSynsetIterator`	An instance of a BabelSynset iterator.
Raises
`NotImplementedError`	Raised if the function is called using online APIs.

@abstractmethod
def lexicon_iterator(self):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Create a new instance of a lexicon iterator.

Returns
`BabelLexiconIterator`	An instance of a lexicon iterator.
Raises
`NotImplementedError`	Raised if the function is called using online APIs.

@abstractmethod
def offset_iterator(self):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Create a new instance of an offset iterator.

Returns
`BabelOffsetIterator`	An instance of an offset iterator.
Raises
`NotImplementedError`	Raised if the function is called using online APIs.

@abstractmethod
def to_babelnet_synsets(self, id_, languages):

overridden in babelnet.apis.local_api.LocalAPI

Get a BabelSytnset using the languages passed as input and an id_.

Parameters
id_:`BabelSynsetID`	the id that needs to be converted
languages:`Set[Language]`	the languages to use.
Raises
`NotImplementedError`	if not implemented

@abstractmethod
def to_synsets(self, resource_id, languages=None):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Convert from ResourceID to the corresponding BabelSynset.

Parameters
resource_id:`ResourceID`	The input ID.
languages:`Optional[Iterable[Language]]`	The target languages to populate synsets with (default None).
Returns
`List[BabelSynset]`	The list of corresponding synsets.
Raises
`NotImplementedError`	if not implemented

@abstractmethod
def version(self):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Get the version of loaded BabelNet indices.

Returns
`BabelVersion`	The BabelVersion of BabelNet indices.
Raises
`NotImplementedError`	if not implemented

@abstractmethod
def wordnet_iterator(self):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Create a new instance of a WordNet iterator.

Returns
`WordNetSynsetIterator`	An instance of a WordNetSynset iterator.
Raises
`NotImplementedError`	Raised if the function is called using online APIs.

@abstractmethod
def _get_outgoing_edges(self, synset_id):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Return the outgoing edges from a given BabelSynsetID

Parameters
synset_id:`BabelSynsetID`	The BabelSynsetID whose outgoing edges we want to retrieve.
Returns
`List[BabelSynsetRelation]`	The list of relation edges.
Raises
`NotImplementedError`	if not implemented

@abstractmethod
def _get_senses(self, words=None, resource_ids=None, containing=False, to_langs=None, sources=None, **kwargs):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Private version of get_senses().

Parameters
words:`Optional[Set[str]]`	A set of words to look for
resource_ids:`Optional[Set[ResourceID]]`	a set of resource ids to look for
containing:`Optional[bool]`	Contaninig parameter.
to_langs:`Optional[Set[Language]]`	If set, the results will be in these languages
sources:`Optional[Set[BabelSenseSource]]`	filter on the sources
**kwargs	keyword arguemts.s
Returns
`List[BabelSense]`	the list of BabelSenses
Raises
`NotImplementedError`	if not implemented

@abstractmethod
def _get_synsets(self, words=None, resource_ids=None, from_langs=None, to_langs=None, poses=None, normalized=True, sources=None, synset_filters=None, sense_filters=None):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Private version of get_synsets()

Parameters
words:`Optional[Set[str]]`	A set of words to look for
resource_ids:`Optional[Set[ResourceID]]`	a set of resource ids to look for
from_langs:`Optional[Set[Language]]`	The language of the words passed as input
to_langs:`Optional[Set[Language]]`	If set, the results will be in these languages
poses:`Set[Set[POS]]`	Filter on poses
normalized:`Optional[bool]`	if true, results will be normalized
sources:`Optional[Set[BabelSenseSource]]`	filter on sources
synset_filters:`Optional[Set[Callable[[BabelSynset], bool]]]`	filter on synsets
sense_filters:`Optional[Set[Callable[[BabelSense], bool]]]`	filter on senses
Returns
`List[BabelSynset]`	the list of BabelSynset.
Raises
`NotImplementedError`	if not implemented

@abstractmethod
def _mapping_from_ids(self, *ids):

overridden in babelnet.apis.local_api.LocalAPI

Get the mapping from BabelSynsetID to _InternalBabelSynsetID.

Parameters
*ids:`BabelSynsetID`	a tuple of BabelSynsetID to use.
Returns
`Dict[BabelSynsetID`, `List[`"_InternalBabelSynsetID"]	The mapping from BabelSynsetID to a list of _InternalBabelSynsetID
Raises
`NotImplementedError`	if not implemented

def _prepare_kwargs(self, kwargs):

overridden in babelnet.apis.local_api.LocalAPI

Prepare the input data by trasforming each iterable in an ordered set.

Parameters
kwargs	the keyword argumetns to unpack

@abstractmethod
def _to_wordnet_synsets(self, id_, languages):

overridden in babelnet.apis.local_api.LocalAPI

Convert a WordNetSynsetID into a Synset.

Parameters
id_:`WordNetSynsetID`	the WordnetSynsetID to convert
languages:`Set[Language]`	the languages that will be used for the results inside the Synset.

@abstractmethod
def examples(self, synset_id, filter_langs, *ids):

overridden in babelnet.apis.local_api.LocalAPI

Get the examples (in the specified languages) of a BabelSynsetID.

Parameters
synset_id:`BabelSynsetID`	The BabelSynsetID to use
filter_langs:`Set[Language]`	The set of language to use
*ids:`_InternalBabelSynsetID`	the ids
Returns
`List[BabelExample]`	A list of BabelExamples
Raises
`NotImplementedError`	Raised if not implemented.

def get_outgoing_edges(self, *args, **kwargs):

Return the outgoing edges from a given BabelSynsetID

Parameters
*args	Undocumented
**kwargs	Undocumented
synset_id:`BabelSynsetID`	The BabelSynsetID whose outgoing edges we want to retrieve.
Returns
`List[BabelSynsetRelation]`	The list of relation edges.

@abstractmethod
def glosses(self, synset_id, filter_langs, *ids):

overridden in babelnet.apis.local_api.LocalAPI

Get the glosses (in the specified languages) of a BabelSysetID.

Parameters
synset_id:`BabelSynsetID`	the BabelSynsetID from where the glosses will be retreived
filter_langs:`Set[Language]`	The set of language to use.
*ids:`_InternalBabelSynsetID`	the _InternalBabelSynsetID
Returns
`List[BabelGloss]`	A list of BabelGlosses
Raises
`NotImplementedError`	Raised if not implemented.

@abstractmethod
def images(self, id):

overridden in babelnet.apis.local_api.LocalAPI, babelnet.apis.online_api.OnlineAPI

Get the images of a BabelSynsetID.

Parameters
id:`BabelSynsetID`	the BabelSynsetID to use
Returns
`List[BabelImage]`	A list of BabelImages
Raises
`NotImplementedError`	Raised if the function is called using online APIs.