The begin and end are character indices into the context UTF8 string. selectionBegin is the * character index where the selection begins, and selectionEnd is the index of one character past * the selection span. * *
The return value is an array of two ints: suggested selection beginning and end, with the * same semantics as the input selectionBeginning and selectionEnd. */ public int[] suggestSelection( String context, int selectionBegin, int selectionEnd, SelectionOptions options) { return nativeSuggestSelection(annotatorPtr, context, selectionBegin, selectionEnd, options); } /** * Given a string context and current selection, classifies the type of the selected text. * *
The begin and end params are character indices in the context string. * *
Returns an array of ClassificationResult objects with the probability scores for different
* collections.
*/
public ClassificationResult[] classifyText(
String context, int selectionBegin, int selectionEnd, ClassificationOptions options) {
return classifyText(
context,
selectionBegin,
selectionEnd,
options,
/*appContext=*/ null,
/*deviceLocales=*/ null);
}
public ClassificationResult[] classifyText(
String context,
int selectionBegin,
int selectionEnd,
ClassificationOptions options,
Object appContext,
String deviceLocales) {
return nativeClassifyText(
annotatorPtr, context, selectionBegin, selectionEnd, options, appContext, deviceLocales);
}
/**
* Annotates given input text. The annotations should cover the whole input context except for
* whitespaces, and are sorted by their position in the context string.
*/
public AnnotatedSpan[] annotate(String text, AnnotationOptions options) {
return nativeAnnotate(annotatorPtr, text, options);
}
/**
* Looks up a knowledge entity by its identifier. Returns null if the entity is not found or on
* error.
*/
public byte[] lookUpKnowledgeEntity(String id) {
return nativeLookUpKnowledgeEntity(annotatorPtr, id);
}
/** Frees up the allocated memory. */
@Override
public void close() {
if (isClosed.compareAndSet(false, true)) {
nativeCloseAnnotator(annotatorPtr);
annotatorPtr = 0L;
}
}
@Override
protected void finalize() throws Throwable {
try {
close();
} finally {
super.finalize();
}
}
/** Returns a comma separated list of locales supported by the model as BCP 47 tags. */
public static String getLocales(int fd) {
return nativeGetLocales(fd);
}
/** Returns the version of the model. */
public static int getVersion(int fd) {
return nativeGetVersion(fd);
}
/** Returns the name of the model. */
public static String getName(int fd) {
return nativeGetName(fd);
}
/** Information about a parsed time/date. */
public static final class DatetimeResult {
public static final int GRANULARITY_YEAR = 0;
public static final int GRANULARITY_MONTH = 1;
public static final int GRANULARITY_WEEK = 2;
public static final int GRANULARITY_DAY = 3;
public static final int GRANULARITY_HOUR = 4;
public static final int GRANULARITY_MINUTE = 5;
public static final int GRANULARITY_SECOND = 6;
private final long timeMsUtc;
private final int granularity;
public DatetimeResult(long timeMsUtc, int granularity) {
this.timeMsUtc = timeMsUtc;
this.granularity = granularity;
}
public long getTimeMsUtc() {
return timeMsUtc;
}
public int getGranularity() {
return granularity;
}
}
/** Classification result for classifyText method. */
public static final class ClassificationResult {
private final String collection;
private final float score;
private final DatetimeResult datetimeResult;
private final byte[] serializedKnowledgeResult;
private final String contactName;
private final String contactGivenName;
private final String contactNickname;
private final String contactEmailAddress;
private final String contactPhoneNumber;
private final String contactId;
private final String appName;
private final String appPackageName;
private final NamedVariant[] entityData;
private final byte[] serializedEntityData;
private final RemoteActionTemplate[] remoteActionTemplates;
private final long durationMs;
private final long numericValue;
public ClassificationResult(
String collection,
float score,
DatetimeResult datetimeResult,
byte[] serializedKnowledgeResult,
String contactName,
String contactGivenName,
String contactNickname,
String contactEmailAddress,
String contactPhoneNumber,
String contactId,
String appName,
String appPackageName,
NamedVariant[] entityData,
byte[] serializedEntityData,
RemoteActionTemplate[] remoteActionTemplates,
long durationMs,
long numericValue) {
this.collection = collection;
this.score = score;
this.datetimeResult = datetimeResult;
this.serializedKnowledgeResult = serializedKnowledgeResult;
this.contactName = contactName;
this.contactGivenName = contactGivenName;
this.contactNickname = contactNickname;
this.contactEmailAddress = contactEmailAddress;
this.contactPhoneNumber = contactPhoneNumber;
this.contactId = contactId;
this.appName = appName;
this.appPackageName = appPackageName;
this.entityData = entityData;
this.serializedEntityData = serializedEntityData;
this.remoteActionTemplates = remoteActionTemplates;
this.durationMs = durationMs;
this.numericValue = numericValue;
}
/** Returns the classified entity type. */
public String getCollection() {
return collection;
}
/** Confidence score between 0 and 1. */
public float getScore() {
return score;
}
public DatetimeResult getDatetimeResult() {
return datetimeResult;
}
public byte[] getSerializedKnowledgeResult() {
return serializedKnowledgeResult;
}
public String getContactName() {
return contactName;
}
public String getContactGivenName() {
return contactGivenName;
}
public String getContactNickname() {
return contactNickname;
}
public String getContactEmailAddress() {
return contactEmailAddress;
}
public String getContactPhoneNumber() {
return contactPhoneNumber;
}
public String getContactId() {
return contactId;
}
public String getAppName() {
return appName;
}
public String getAppPackageName() {
return appPackageName;
}
public NamedVariant[] getEntityData() {
return entityData;
}
public byte[] getSerializedEntityData() {
return serializedEntityData;
}
public RemoteActionTemplate[] getRemoteActionTemplates() {
return remoteActionTemplates;
}
public long getDurationMs() {
return durationMs;
}
public long getNumericValue() {
return numericValue;
}
}
/** Represents a result of Annotate call. */
public static final class AnnotatedSpan {
private final int startIndex;
private final int endIndex;
private final ClassificationResult[] classification;
AnnotatedSpan(int startIndex, int endIndex, ClassificationResult[] classification) {
this.startIndex = startIndex;
this.endIndex = endIndex;
this.classification = classification;
}
public int getStartIndex() {
return startIndex;
}
public int getEndIndex() {
return endIndex;
}
public ClassificationResult[] getClassification() {
return classification;
}
}
/** Represents options for the suggestSelection call. */
public static final class SelectionOptions {
private final String locales;
private final String detectedTextLanguageTags;
private final int annotationUsecase;
public SelectionOptions(
String locales, String detectedTextLanguageTags, int annotationUsecase) {
this.locales = locales;
this.detectedTextLanguageTags = detectedTextLanguageTags;
this.annotationUsecase = annotationUsecase;
}
public SelectionOptions(String locales, String detectedTextLanguageTags) {
this(locales, detectedTextLanguageTags, AnnotationUsecase.SMART.getValue());
}
public String getLocales() {
return locales;
}
/** Returns a comma separated list of BCP 47 language tags. */
public String getDetectedTextLanguageTags() {
return detectedTextLanguageTags;
}
public int getAnnotationUsecase() {
return annotationUsecase;
}
}
/** Represents options for the classifyText call. */
public static final class ClassificationOptions {
private final long referenceTimeMsUtc;
private final String referenceTimezone;
private final String locales;
private final String detectedTextLanguageTags;
private final int annotationUsecase;
public ClassificationOptions(
long referenceTimeMsUtc,
String referenceTimezone,
String locales,
String detectedTextLanguageTags,
int annotationUsecase) {
this.referenceTimeMsUtc = referenceTimeMsUtc;
this.referenceTimezone = referenceTimezone;
this.locales = locales;
this.detectedTextLanguageTags = detectedTextLanguageTags;
this.annotationUsecase = annotationUsecase;
}
public ClassificationOptions(
long referenceTimeMsUtc,
String referenceTimezone,
String locales,
String detectedTextLanguageTags) {
this(
referenceTimeMsUtc,
referenceTimezone,
locales,
detectedTextLanguageTags,
AnnotationUsecase.SMART.getValue());
}
public long getReferenceTimeMsUtc() {
return referenceTimeMsUtc;
}
public String getReferenceTimezone() {
return referenceTimezone;
}
public String getLocale() {
return locales;
}
/** Returns a comma separated list of BCP 47 language tags. */
public String getDetectedTextLanguageTags() {
return detectedTextLanguageTags;
}
public int getAnnotationUsecase() {
return annotationUsecase;
}
}
/** Represents options for the annotate call. */
public static final class AnnotationOptions {
private final long referenceTimeMsUtc;
private final String referenceTimezone;
private final String locales;
private final String detectedTextLanguageTags;
private final String[] entityTypes;
private final int annotationUsecase;
private final boolean isSerializedEntityDataEnabled;
public AnnotationOptions(
long referenceTimeMsUtc,
String referenceTimezone,
String locales,
String detectedTextLanguageTags,
Collection