edu.stanford.nlp.naturalli

Class OpenIE

java.lang.Object

edu.stanford.nlp.naturalli.OpenIE

All Implemented Interfaces:

Annotator

public class OpenIE
extends Object
implements Annotator

An OpenIE system based on valid Natural Logic deletions of a sentence. The system is described in:

   "Leveraging Linguistic Structure For Open Domain Information Extraction." Gabor Angeli, Melvin Johnson Premkumar, Christopher Manning. ACL 2015.
 

The paper can be found at http://nlp.stanford.edu/pubs/2015angeli-openie.pdf.

Documentation on the system can be found on the project homepage, or the CoreNLP annotator documentation page. The simplest invocation of the system would be something like:

 java -mx1g -cp stanford-openie.jar:stanford-openie-models.jar edu.stanford.nlp.naturalli.OpenIE
 

Note that this class serves both as an entry point for the OpenIE system, but also as a CoreNLP annotator which can be plugged into the CoreNLP pipeline (or any other annotation pipeline).

Author:

Gabor Angeli

See Also:

annotate(Annotation), main(String[])

Nested Class Summary

Nested classes/interfaces inherited from interface edu.stanford.nlp.pipeline.Annotator

Annotator.Requirement

Field Summary

Fields

Modifier and Type	Field and Description
Optional<ClauseSplitter>	clauseSplitter The clause splitter model, if one is to be used.
ForwardEntailer	forwardEntailer The forward entailer model, running a search from clauses to maximally shortened clauses.
RelationTripleSegmenter	segmenter The relation triple segmenter, which converts a maximally shortened clause into an OpenIE extraction triple.

Fields inherited from interface edu.stanford.nlp.pipeline.Annotator

BINARIZED_TREES_REQUIREMENT, CLEAN_XML_REQUIREMENT, COLUMN_DATA_CLASSIFIER, COREF_REQUIREMENT, DEPENDENCY_REQUIREMENT, DETERMINISTIC_COREF_REQUIREMENT, ENTITY_MENTIONS_REQUIREMENT, GENDER_REQUIREMENT, GUTIME_REQUIREMENT, HEIDELTIME_REQUIREMENT, LEMMA_REQUIREMENT, MENTION_REQUIREMENT, NATLOG_REQUIREMENT, NER_REQUIREMENT, NUMBER_REQUIREMENT, OPENIE_REQUIREMENT, PARSE_AND_TAG, PARSE_REQUIREMENT, PARSE_TAG_BINARIZED_TREES, PARSE_TAG_DEPPARSE, PARSE_TAG_DEPPARSE_BINARIZED_TREES, POS_REQUIREMENT, QUANTIFIABLE_ENTITY_NORMALIZATION_REQUIREMENT, QUOTE_REQUIREMENT, RELATION_EXTRACTOR_REQUIREMENT, REQUIREMENTS, SSPLIT_REQUIREMENT, STANFORD_CLEAN_XML, STANFORD_COLUMN_DATA_CLASSIFIER, STANFORD_COREF, STANFORD_DEPENDENCIES, STANFORD_DETERMINISTIC_COREF, STANFORD_ENTITY_MENTIONS, STANFORD_GENDER, STANFORD_LEMMA, STANFORD_MENTION, STANFORD_NATLOG, STANFORD_NER, STANFORD_OPENIE, STANFORD_PARSE, STANFORD_POS, STANFORD_QUOTE, STANFORD_REGEXNER, STANFORD_RELATION, STANFORD_SENTIMENT, STANFORD_SSPLIT, STANFORD_TOKENIZE, STANFORD_TRUECASE, STANFORD_UD_FEATURES, STEM_REQUIREMENT, SUTIME_REQUIREMENT, TIME_WORDS_REQUIREMENT, TOKENIZE_AND_SSPLIT, TOKENIZE_REQUIREMENT, TOKENIZE_SSPLIT_NER, TOKENIZE_SSPLIT_PARSE, TOKENIZE_SSPLIT_PARSE_NER, TOKENIZE_SSPLIT_POS, TOKENIZE_SSPLIT_POS_DEPPARSE, TOKENIZE_SSPLIT_POS_LEMMA, TRUECASE_REQUIREMENT, UD_FEATURES_REQUIREMENT

Constructor Summary

Constructors

Constructor and Description
OpenIE() Create a new OpenIE system, with default properties
OpenIE(Properties props) Create a ne OpenIE system, based on the given properties.

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation annotation) Given an Annotation, perform a task on this Annotation.
void	annotateSentence(CoreMap sentence, Map<CoreLabel,List<CoreLabel>> canonicalMentionMap) Annotate a single sentence.
List<SentenceFragment>	clausesInSentence(CoreMap sentence) Find the clauses in a sentence.
List<SentenceFragment>	clausesInSentence(SemanticGraph tree, boolean assumedTruth) Find the clauses in a sentence, where the sentence is expressed as a dependency tree.
List<SentenceFragment>	entailmentsFromClause(SentenceFragment clause) Returns all of the entailed shortened clauses (as per natural logic) from the given clause.
Set<SentenceFragment>	entailmentsFromClauses(Collection<SentenceFragment> clauses) Returns all the maximally shortened entailed fragments (as per natural logic) from the given collection of clauses.
static void	main(String[] args) An entry method for annotating standard in with OpenIE extractions.
Optional<RelationTriple>	relationInFragment(SentenceFragment fragment) Returns the possible relation triple in this sentence fragment.
List<RelationTriple>	relationsInClause(SentenceFragment clause) Extract the relations in this clause.
List<RelationTriple>	relationsInFragments(Collection<SentenceFragment> fragments) Returns the possible relation triple in this set of sentence fragments.
List<RelationTriple>	relationsInSentence(CoreMap sentence) Extract the relations in this sentence.
Set<Annotator.Requirement>	requirementsSatisfied() Returns a set of requirements for which tasks this annotator can provide.
Set<Annotator.Requirement>	requires() Returns the set of tasks which this annotator requires in order to perform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clauseSplitter

public final Optional<ClauseSplitter> clauseSplitter

The clause splitter model, if one is to be used. This component splits a sentence into a set of entailed clauses, but does not yet maximally shorten them. This is the implementation of stage 1 of the OpenIE pipeline.

forwardEntailer

public final ForwardEntailer forwardEntailer

The forward entailer model, running a search from clauses to maximally shortened clauses. This is the implementation of stage 2 of the OpenIE pipeline.

segmenter

public RelationTripleSegmenter segmenter

The relation triple segmenter, which converts a maximally shortened clause into an OpenIE extraction triple. This is the implementation of stage 3 of the OpenIE pipeline.

Constructor Detail

OpenIE

public OpenIE()

Create a new OpenIE system, with default properties

OpenIE

public OpenIE(Properties props)

Create a ne OpenIE system, based on the given properties.

Parameters:

props - The properties to parametrize the system with.

Method Detail

clausesInSentence

public List<SentenceFragment> clausesInSentence(SemanticGraph tree,
                                                boolean assumedTruth)

Find the clauses in a sentence, where the sentence is expressed as a dependency tree.

Parameters:

tree - The dependency tree representation of the sentence.

assumedTruth - The assumed truth of the sentence. This is almost always true, unless you are doing some more nuanced reasoning.

Returns:

A set of clauses extracted from the sentence. This includes the original sentence.

clausesInSentence

public List<SentenceFragment> clausesInSentence(CoreMap sentence)

Find the clauses in a sentence. This runs the clause splitting component of the OpenIE system only.

Parameters:

sentence - The raw sentence to extract clauses from.

Returns:

A set of clauses extracted from the sentence. This includes the original sentence.

See Also:

clausesInSentence(SemanticGraph, boolean)

entailmentsFromClause

public List<SentenceFragment> entailmentsFromClause(SentenceFragment clause)

Returns all of the entailed shortened clauses (as per natural logic) from the given clause. This runs the forward entailment component of the OpenIE system only. It is usually chained together with the clause splitting component: clausesInSentence(CoreMap).

Parameters:

clause - The premise clause, as a sentence fragment in itself.

Returns:

A list of entailed clauses.

entailmentsFromClauses

public Set<SentenceFragment> entailmentsFromClauses(Collection<SentenceFragment> clauses)

Returns all the maximally shortened entailed fragments (as per natural logic) from the given collection of clauses.

Parameters:

clauses - The clauses to shorten further.

Returns:

A set of sentence fragments corresponding to the maximally shortened entailed clauses.

relationInFragment

public Optional<RelationTriple> relationInFragment(SentenceFragment fragment)

Returns the possible relation triple in this sentence fragment.

See Also:

relationInFragment(SentenceFragment, CoreMap)

relationsInFragments

public List<RelationTriple> relationsInFragments(Collection<SentenceFragment> fragments)

Returns the possible relation triple in this set of sentence fragments.

See Also:

relationsInFragments(Collection, CoreMap)

relationsInClause

public List<RelationTriple> relationsInClause(SentenceFragment clause)

Extract the relations in this clause.

See Also:

entailmentsFromClause(SentenceFragment), relationsInFragments(Collection)

relationsInSentence

public List<RelationTriple> relationsInSentence(CoreMap sentence)

Extract the relations in this sentence.

See Also:

clausesInSentence(CoreMap), entailmentsFromClause(SentenceFragment), relationsInFragments(Collection)

annotateSentence

public void annotateSentence(CoreMap sentence,
                             Map<CoreLabel,List<CoreLabel>> canonicalMentionMap)

Annotate a single sentence.

This annotator will, in particular, set the NaturalLogicAnnotations.EntailedSentencesAnnotation and NaturalLogicAnnotations.RelationTriplesAnnotation annotations.

annotate

public void annotate(Annotation annotation)

Given an Annotation, perform a task on this Annotation.

This annotator will, in particular, set the NaturalLogicAnnotations.EntailedSentencesAnnotation and NaturalLogicAnnotations.RelationTriplesAnnotation annotations.

Specified by:

annotate in interface Annotator

requirementsSatisfied

public Set<Annotator.Requirement> requirementsSatisfied()

Returns a set of requirements for which tasks this annotator can provide. For example, the POS annotator will return "pos".

Specified by:

requirementsSatisfied in interface Annotator

requires

public Set<Annotator.Requirement> requires()

Returns the set of tasks which this annotator requires in order to perform. For example, the POS annotator will return "tokenize", "ssplit".

Specified by:

requires in interface Annotator

main

public static void main(String[] args)
                 throws IOException,
                        InterruptedException

An entry method for annotating standard in with OpenIE extractions.

Throws:

IOException

InterruptedException