# Index

A C D E F G H I L M N O P S T
All Classes and Interfaces|All Packages|Constant Field Values

## A

AbstractDL - Class in opennlp.dl
  Base class for OpenNLP deep-learning classes using ONNX Runtime.
ATTENTION_MASK - Static variable in class opennlp.dl.AbstractDL
AverageClassificationScoringStrategy - Class in opennlp.dl.doccat.scoring
  A `ClassificationScoringStrategy` which calculates the document classification scores by averaging the scores for all individual parts of a document.
AverageClassificationScoringStrategy() - Constructor for class opennlp.dl.doccat.scoring.AverageClassificationScoringStrategy

## C

categorize(String[]) - Method in class opennlp.dl.doccat.DocumentCategorizerDL
  Categorizes the document, failing loudly rather than returning an invalid distribution: malformed input is rejected with `IllegalArgumentException`, and any failure executing the model is surfaced as an `IllegalStateException` (cause preserved).
categorize(String[], Map<String, Object>) - Method in class opennlp.dl.doccat.DocumentCategorizerDL
ClassificationScoringStrategy - Interface in opennlp.dl.doccat.scoring
  Used to determine the scores of document classification.
clearAdaptiveData() - Method in class opennlp.dl.namefinder.NameFinderDL
close() - Method in class opennlp.dl.AbstractDL
  Closes the ONNX `OrtSession` owned by this instance.
CLS_TOKEN - Static variable in class opennlp.dl.namefinder.NameFinderDL

## D

DocumentCategorizerConfig - Record Class in opennlp.dl.doccat
DocumentCategorizerConfig(Map<String, String>) - Constructor for record class opennlp.dl.doccat.DocumentCategorizerConfig
  Creates an instance of a `DocumentCategorizerConfig` record class.
DocumentCategorizerDL - Class in opennlp.dl.doccat
  An implementation of `DocumentCategorizer` that performs document classification using ONNX models.
DocumentCategorizerDL(File, File, File, ClassificationScoringStrategy, InferenceOptions) - Constructor for class opennlp.dl.doccat.DocumentCategorizerDL
  Instantiates a `document categorizer` using ONNX models.
DocumentCategorizerDL(File, File, Map<Integer, String>, ClassificationScoringStrategy, InferenceOptions) - Constructor for class opennlp.dl.doccat.DocumentCategorizerDL
  Instantiates a `document categorizer` using ONNX models.

## E

equals(Object) - Method in record class opennlp.dl.doccat.DocumentCategorizerConfig
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class opennlp.dl.Tokens
  Indicates whether some other object is "equal to" this one.

## F

find(String[]) - Method in class opennlp.dl.namefinder.NameFinderDL
findInOriginal(String[]) - Method in class opennlp.dl.namefinder.NameFinderDL
  Finds names and returns their `spans` in coordinates of the original joined input (`String.join(" ", input)`), regardless of any whitespace or dash normalization applied before inference.
fromJson(String) - Static method in record class opennlp.dl.doccat.DocumentCategorizerConfig

## G

getAllResults(double[]) - Method in class opennlp.dl.doccat.DocumentCategorizerDL
getBestCategory(double[]) - Method in class opennlp.dl.doccat.DocumentCategorizerDL
getCategory(int) - Method in class opennlp.dl.doccat.DocumentCategorizerDL
getDocumentSplitSize() - Method in class opennlp.dl.InferenceOptions
getGpuDeviceId() - Method in class opennlp.dl.InferenceOptions
getIndex(String) - Method in class opennlp.dl.doccat.DocumentCategorizerDL
getLowerCase() - Method in class opennlp.dl.InferenceOptions
  Returns whether tokenization should lower case the input text and strip accents, as required by uncased models.
getNumberOfCategories() - Method in class opennlp.dl.doccat.DocumentCategorizerDL
getSplitOverlapSize() - Method in class opennlp.dl.InferenceOptions
getVectors(String) - Method in class opennlp.dl.vectors.SentenceVectorsDL
  Generates vectors given a sentence.

## H

hashCode() - Method in record class opennlp.dl.doccat.DocumentCategorizerConfig
  Returns a hash code value for this object.
hashCode() - Method in record class opennlp.dl.Tokens
  Returns a hash code value for this object.

## I

id2label() - Method in record class opennlp.dl.doccat.DocumentCategorizerConfig
  Returns the value of the `id2label` record component.
ids() - Method in record class opennlp.dl.Tokens
  Returns the value of the `ids` record component.
InferenceOptions - Class in opennlp.dl
InferenceOptions() - Constructor for class opennlp.dl.InferenceOptions
INPUT_IDS - Static variable in class opennlp.dl.AbstractDL
isGpu() - Method in class opennlp.dl.InferenceOptions
isIncludeAttentionMask() - Method in class opennlp.dl.InferenceOptions
isIncludeTokenTypeIds() - Method in class opennlp.dl.InferenceOptions
isNormalizeDashes() - Method in class opennlp.dl.InferenceOptions
  Returns whether input dashes are normalized to the ASCII hyphen before inference.
isNormalizeWhitespace() - Method in class opennlp.dl.InferenceOptions
  Returns whether input whitespace is normalized to ASCII spaces before inference.

## L

loadVocab(File) - Method in class opennlp.dl.AbstractDL
  Loads a vocabulary `File` from disk.

## M

mask() - Method in record class opennlp.dl.Tokens
  Returns the value of the `mask` record component.

## N

NameFinderDL - Class in opennlp.dl.namefinder
  An implementation of `TokenNameFinder` that uses ONNX models.
NameFinderDL(File, File, Map<Integer, String>, InferenceOptions, SentenceDetector) - Constructor for class opennlp.dl.namefinder.NameFinderDL
  Instantiates a `name finder` using ONNX models.
NameFinderDL(File, File, Map<Integer, String>, SentenceDetector) - Constructor for class opennlp.dl.namefinder.NameFinderDL
  Instantiates a `name finder` using ONNX models.
NO_SPACE_AFTER_TOKENS - Static variable in class opennlp.dl.namefinder.NameFinderDL
  Tokens after which the following token attaches directly when span text is reconstructed.
NO_SPACE_BEFORE_TOKENS - Static variable in class opennlp.dl.namefinder.NameFinderDL
  Tokens that attach directly to the preceding token when span text is reconstructed.

## O

opennlp.dl - package opennlp.dl
opennlp.dl.doccat - package opennlp.dl.doccat
opennlp.dl.doccat.scoring - package opennlp.dl.doccat.scoring
opennlp.dl.namefinder - package opennlp.dl.namefinder
opennlp.dl.vectors - package opennlp.dl.vectors

## P

PREFIX_BEGIN - Static variable in class opennlp.dl.namefinder.NameFinderDL
  Prefix used by BIO labels for the first token in an entity span.
PREFIX_INSIDE - Static variable in class opennlp.dl.namefinder.NameFinderDL
  Prefix used by BIO labels for continuation tokens in an entity span.

## S

score(List<double[]>) - Method in class opennlp.dl.doccat.scoring.AverageClassificationScoringStrategy
score(List<double[]>) - Method in interface opennlp.dl.doccat.scoring.ClassificationScoringStrategy
  Calculate the final scores based on the scores of the individual document parts.
scoreMap(String[]) - Method in class opennlp.dl.doccat.DocumentCategorizerDL
SentenceVectorsDL - Class in opennlp.dl.vectors
  Facilitates the generation of sentence vectors using a sentence-transformers model converted to ONNX.
SentenceVectorsDL(File, File) - Constructor for class opennlp.dl.vectors.SentenceVectorsDL
  Instantiates a `sentence vector generator` for an uncased model.
SentenceVectorsDL(File, File, boolean) - Constructor for class opennlp.dl.vectors.SentenceVectorsDL
  Instantiates a `sentence vector generator` using ONNX models.
SEPARATOR - Static variable in class opennlp.dl.namefinder.NameFinderDL
setDocumentSplitSize(int) - Method in class opennlp.dl.InferenceOptions
setGpu(boolean) - Method in class opennlp.dl.InferenceOptions
setGpuDeviceId(int) - Method in class opennlp.dl.InferenceOptions
setIncludeAttentionMask(boolean) - Method in class opennlp.dl.InferenceOptions
setIncludeTokenTypeIds(boolean) - Method in class opennlp.dl.InferenceOptions
setLowerCase(boolean) - Method in class opennlp.dl.InferenceOptions
  Sets whether tokenization should lower case the input text and strip accents.
setNormalizeDashes(boolean) - Method in class opennlp.dl.InferenceOptions
  Replaces Unicode dashes in the input with the ASCII hyphen-minus before inference.
setNormalizeWhitespace(boolean) - Method in class opennlp.dl.InferenceOptions
  Replaces every Unicode whitespace character in the input with an ASCII space before inference.
setSplitOverlapSize(int) - Method in class opennlp.dl.InferenceOptions
sortedScoreMap(String[]) - Method in class opennlp.dl.doccat.DocumentCategorizerDL

## T

TOKEN_TYPE_IDS - Static variable in class opennlp.dl.AbstractDL
tokens() - Method in record class opennlp.dl.Tokens
  Returns the value of the `tokens` record component.
Tokens - Record Class in opennlp.dl
  Holds the tokens for input to an ONNX model.
Tokens(String[], long[], long[], long[]) - Constructor for record class opennlp.dl.Tokens
  Creates an instance of a `Tokens` record class.
toString() - Method in record class opennlp.dl.doccat.DocumentCategorizerConfig
  Returns a string representation of this record class.
toString() - Method in record class opennlp.dl.Tokens
  Returns a string representation of this record class.
types() - Method in record class opennlp.dl.Tokens
  Returns the value of the `types` record component.

A C D E F G H I L M N O P S T
All Classes and Interfaces|All Packages|Constant Field Values