edu.stanford.nlp.pipeline

Class StanfordCoreNLPClient

java.lang.Object

edu.stanford.nlp.pipeline.AnnotationPipeline

edu.stanford.nlp.pipeline.StanfordCoreNLPClient

All Implemented Interfaces:

Annotator

public class StanfordCoreNLPClient
extends AnnotationPipeline

An annotation pipeline in spirit identical to StanfordCoreNLP, but with the backend supported by a web server.

Author:

Gabor Angeli

Field Summary

Fields inherited from class edu.stanford.nlp.pipeline.AnnotationPipeline

TIME

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

DEFAULT_REQUIREMENTS, STANFORD_CDC_TOKENIZE, STANFORD_CLEAN_XML, STANFORD_COLUMN_DATA_CLASSIFIER, STANFORD_COREF, STANFORD_COREF_MENTION, STANFORD_DEPENDENCIES, STANFORD_DETERMINISTIC_COREF, STANFORD_DOCDATE, STANFORD_ENTITY_MENTIONS, STANFORD_GENDER, STANFORD_KBP, STANFORD_LEMMA, STANFORD_LINK, STANFORD_MWT, STANFORD_NATLOG, STANFORD_NER, STANFORD_OPENIE, STANFORD_PARSE, STANFORD_POS, STANFORD_QUOTE, STANFORD_QUOTE_ATTRIBUTION, STANFORD_REGEXNER, STANFORD_RELATION, STANFORD_SENTIMENT, STANFORD_SSPLIT, STANFORD_TOKENIZE, STANFORD_TOKENSREGEX, STANFORD_TRUECASE, STANFORD_UD_FEATURES

Constructor Summary

Constructors

Constructor and Description
StanfordCoreNLPClient(java.util.Properties properties) Run the client, pulling credentials from the environment.
StanfordCoreNLPClient(java.util.Properties properties, java.lang.String host, int port) Run on a single backend.
StanfordCoreNLPClient(java.util.Properties properties, java.lang.String host, int port, int threads) Run on a single backend, but with k threads on each backend.
StanfordCoreNLPClient(java.util.Properties properties, java.lang.String host, int port, int threads, java.lang.String apiKey, java.lang.String apiSecret) Run on a single backend, but with k threads on each backend, and with authentication
StanfordCoreNLPClient(java.util.Properties properties, java.lang.String host, int port, java.lang.String apiKey, java.lang.String apiSecret) Run on a single backend, with authentication
StanfordCoreNLPClient(java.util.Properties properties, java.lang.String host, java.lang.String apiKey, java.lang.String apiSecret) Run on a single backend, with authentication

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation annotation) Run the pipeline on an input annotation.
void	annotate(Annotation annotation, java.util.function.Consumer<Annotation> callback) The canonical entry point of the client annotator.
void	annotate(java.lang.Iterable<Annotation> annotations, int numThreads, java.util.function.Consumer<Annotation> callback) This method fires off a request to the server.
boolean	checkStatus(java.net.URL serverURL) Return true if the referenced server is alive and returns a non-error response code.
static void	main(java.lang.String[] args) Client that runs data through a StanfordCoreNLPServer either just for testing or for command-line text processing.
Annotation	process(java.lang.String text) Runs the entire pipeline on the content of the given text passed in.
void	run() The implementation of what to run on a command-line call of CoreNLPWebClient
void	setTimeoutMilliseconds(int timeout)
void	shutdown() Good practice to call after you are done with this object.

Methods inherited from class edu.stanford.nlp.pipeline.AnnotationPipeline

addAnnotator, annotate, annotate, annotate, getTotalTime, requirementsSatisfied, requires, timingInformation

Methods inherited from class java.lang.Object

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

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

exactRequirements, unmount

Constructor Detail

StanfordCoreNLPClient

public StanfordCoreNLPClient(java.util.Properties properties)
                      throws java.lang.IllegalStateException

Run the client, pulling credentials from the environment. Throws an IllegalStateException if the required environment variables aren't set. These are:

• CORENLP_HOST
• CORENLP_KEY
• CORENLP_SECRET

Throws:

java.lang.IllegalStateException - Thrown if we could not read the required environment variables.

StanfordCoreNLPClient

public StanfordCoreNLPClient(java.util.Properties properties,
                             java.lang.String host,
                             int port)

Run on a single backend.

See Also:

(Properties, List)

StanfordCoreNLPClient

public StanfordCoreNLPClient(java.util.Properties properties,
                             java.lang.String host,
                             int port,
                             java.lang.String apiKey,
                             java.lang.String apiSecret)

Run on a single backend, with authentication

See Also:

(Properties, List)

StanfordCoreNLPClient

public StanfordCoreNLPClient(java.util.Properties properties,
                             java.lang.String host,
                             java.lang.String apiKey,
                             java.lang.String apiSecret)

Run on a single backend, with authentication

See Also:

(Properties, List)

StanfordCoreNLPClient

public StanfordCoreNLPClient(java.util.Properties properties,
                             java.lang.String host,
                             int port,
                             int threads)

Run on a single backend, but with k threads on each backend.

See Also:

(Properties, List)

StanfordCoreNLPClient

public StanfordCoreNLPClient(java.util.Properties properties,
                             java.lang.String host,
                             int port,
                             int threads,
                             java.lang.String apiKey,
                             java.lang.String apiSecret)

Run on a single backend, but with k threads on each backend, and with authentication

See Also:

(Properties, List)

Method Detail

setTimeoutMilliseconds

public void setTimeoutMilliseconds(int timeout)

annotate

public void annotate(Annotation annotation)

Run the pipeline on an input annotation. The annotation is modified in place. This method creates an async call to the server, and blocks until the server has finished annotating the object.

Specified by:

annotate in interface Annotator

Overrides:

annotate in class AnnotationPipeline

Parameters:

annotation - The input annotation, usually a raw document

annotate

public void annotate(java.lang.Iterable<Annotation> annotations,
                     int numThreads,
                     java.util.function.Consumer<Annotation> callback)

This method fires off a request to the server. Upon returning, it calls the provided callback method.

Overrides:

annotate in class AnnotationPipeline

Parameters:

annotations - The input annotations to process

numThreads - The number of threads to run on. IGNORED in this class.

callback - A function to be called when an annotation finishes.

annotate

public void annotate(Annotation annotation,
                     java.util.function.Consumer<Annotation> callback)

The canonical entry point of the client annotator. Create an HTTP request, send this annotation to the server, and await a response.

Parameters:

annotation - The annotation to annotate.

callback - Called when the server has returned an annotated document. The input to this callback is the same as the passed Annotation object.

checkStatus

public boolean checkStatus(java.net.URL serverURL)

Return true if the referenced server is alive and returns a non-error response code.

Parameters:

serverURL - The server (running CoreNLP) to check

Returns:

true if the server is alive and returns a response code between 200 and 400 inclusive

process

public Annotation process(java.lang.String text)

Runs the entire pipeline on the content of the given text passed in.

Parameters:

text - The text to process

Returns:

An Annotation object containing the output of all annotators

run

public void run()
         throws java.io.IOException

The implementation of what to run on a command-line call of CoreNLPWebClient

Throws:

java.io.IOException - If any IO problem

shutdown

public void shutdown()
              throws java.lang.InterruptedException

Good practice to call after you are done with this object. Shuts down the queue of annotations to run and the associated threads.

If this is not called, any job which has been scheduled but not run will be cancelled.

Throws:

java.lang.InterruptedException

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Client that runs data through a StanfordCoreNLPServer either just for testing or for command-line text processing. This runs the pipeline you specify on the text in the file(s) that you specify (with -file or -filelist) and sends some results to stdout. The current code in this main method assumes that each line of the file is to be processed separately as a single sentence. A site must be specified with a protocol like "https:" in front of it.

Options:

• -h or -help: print a help message
• -backends: Specify the URL of backends to use (default is: http://localhost:9000)
• -host and -port: Legacy alternative to -backends
• -fallbackToLocalPipeline: If processing via the server fails, try to process a text with a local pipeline

Example usage:
java -mx6g edu.stanford.nlp.pipeline.StanfordCoreNLP -props properties -backends site1:port1,site2:port2
or just -host https://foo.bar.com [-port 9000]

Parameters:

args - List of required properties

Throws:

java.io.IOException - If IO problem