java/com/google/android/textclassifier/AnnotatorModel.java - platform/external/libtextclassifier - Git at Google

 /*
  * Copyright (C) 2018 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 package com.google.android.textclassifier;

 import java.util.Collection;
 import java.util.concurrent.atomic.AtomicBoolean;

 /**
  * Java wrapper for Annotator native library interface. This library is used for detecting entities
  * in text.
  *
  * @hide
  */
 public final class AnnotatorModel implements AutoCloseable {
   private final AtomicBoolean isClosed = new AtomicBoolean(false);

   static {
     System.loadLibrary("textclassifier");
   }

   // Keep these in sync with the constants defined in AOSP.
   static final String TYPE_UNKNOWN = "";
   static final String TYPE_OTHER = "other";
   static final String TYPE_EMAIL = "email";
   static final String TYPE_PHONE = "phone";
   static final String TYPE_ADDRESS = "address";
   static final String TYPE_URL = "url";
   static final String TYPE_DATE = "date";
   static final String TYPE_DATE_TIME = "datetime";
   static final String TYPE_FLIGHT_NUMBER = "flight";

   private long annotatorPtr;

   /** Enumeration for specifying the usecase of the annotations. */
   public static enum AnnotationUsecase {
     /** Results are optimized for Smart{Select,Share,Linkify}. */
     SMART(0),

     /**
      * Results are optimized for using TextClassifier as an infrastructure that annotates as much as
      * possible.
      */
     RAW(1);

     private final int value;

     AnnotationUsecase(int value) {
       this.value = value;
     }

     public int getValue() {
       return value;
     }
   };

   /**
    * Creates a new instance of SmartSelect predictor, using the provided model image, given as a
    * file descriptor.
    */
   public AnnotatorModel(int fileDescriptor) {
     annotatorPtr = nativeNewAnnotator(fileDescriptor);
     if (annotatorPtr == 0L) {
       throw new IllegalArgumentException("Couldn't initialize TC from file descriptor.");
     }
   }

   /**
    * Creates a new instance of SmartSelect predictor, using the provided model image, given as a
    * file path.
    */
   public AnnotatorModel(String path) {
     annotatorPtr = nativeNewAnnotatorFromPath(path);
     if (annotatorPtr == 0L) {
       throw new IllegalArgumentException("Couldn't initialize TC from given file.");
     }
   }

   /** Initializes the knowledge engine, passing the given serialized config to it. */
   public void initializeKnowledgeEngine(byte[] serializedConfig) {
     if (!nativeInitializeKnowledgeEngine(annotatorPtr, serializedConfig)) {
       throw new IllegalArgumentException("Couldn't initialize the KG engine");
     }
   }

   /** Initializes the contact engine, passing the given serialized config to it. */
   public void initializeContactEngine(byte[] serializedConfig) {
     if (!nativeInitializeContactEngine(annotatorPtr, serializedConfig)) {
       throw new IllegalArgumentException("Couldn't initialize the contact engine");
     }
   }

   /** Initializes the installed app engine, passing the given serialized config to it. */
   public void initializeInstalledAppEngine(byte[] serializedConfig) {
     if (!nativeInitializeInstalledAppEngine(annotatorPtr, serializedConfig)) {
       throw new IllegalArgumentException("Couldn't initialize the installed app engine");
     }
   }

   /**
    * Given a string context and current selection, computes the selection suggestion.
    *
    * <p>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.
    *
    * <p>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.
    *
    * <p>The begin and end params are character indices in the context string.
    *
    * <p>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<String> entityTypes,
         int annotationUsecase,
         boolean isSerializedEntityDataEnabled) {
       this.referenceTimeMsUtc = referenceTimeMsUtc;
       this.referenceTimezone = referenceTimezone;
       this.locales = locales;
       this.detectedTextLanguageTags = detectedTextLanguageTags;
       this.entityTypes = entityTypes == null ? new String[0] : entityTypes.toArray(new String[0]);
       this.annotationUsecase = annotationUsecase;
       this.isSerializedEntityDataEnabled = isSerializedEntityDataEnabled;
     }

     public AnnotationOptions(
         long referenceTimeMsUtc,
         String referenceTimezone,
         String locales,
         String detectedTextLanguageTags) {
       this(
           referenceTimeMsUtc,
           referenceTimezone,
           locales,
           detectedTextLanguageTags,
           null,
           AnnotationUsecase.SMART.getValue(),
           /* isSerializedEntityDataEnabled */ false);
     }

     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 String[] getEntityTypes() {
       return entityTypes;
     }

     public int getAnnotationUsecase() {
       return annotationUsecase;
     }

     public boolean isSerializedEntityDataEnabled() {
       return isSerializedEntityDataEnabled;
     }
   }

   /**
    * Retrieves the pointer to the native object. Note: Need to keep the AnnotatorModel alive as long
    * as the pointer is used.
    */
   long getNativeAnnotator() {
     return nativeGetNativeModelPtr(annotatorPtr);
   }

   private static native long nativeNewAnnotator(int fd);

   private static native long nativeNewAnnotatorFromPath(String path);

   private static native String nativeGetLocales(int fd);

   private static native int nativeGetVersion(int fd);

   private static native String nativeGetName(int fd);

   private native long nativeGetNativeModelPtr(long context);

   private native boolean nativeInitializeKnowledgeEngine(long context, byte[] serializedConfig);

   private native boolean nativeInitializeContactEngine(long context, byte[] serializedConfig);

   private native boolean nativeInitializeInstalledAppEngine(long context, byte[] serializedConfig);

   private native int[] nativeSuggestSelection(
       long context, String text, int selectionBegin, int selectionEnd, SelectionOptions options);

   private native ClassificationResult[] nativeClassifyText(
       long context,
       String text,
       int selectionBegin,
       int selectionEnd,
       ClassificationOptions options,
       Object appContext,
       String deviceLocales);

   private native AnnotatedSpan[] nativeAnnotate(
       long context, String text, AnnotationOptions options);

   private native byte[] nativeLookUpKnowledgeEntity(long context, String id);

   private native void nativeCloseAnnotator(long context);
 }
	/*
	* Copyright (C) 2018 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	package com.google.android.textclassifier;

	import java.util.Collection;
	import java.util.concurrent.atomic.AtomicBoolean;

	/**
	* Java wrapper for Annotator native library interface. This library is used for detecting entities
	* in text.
	*
	* @hide
	*/
	public final class AnnotatorModel implements AutoCloseable {
	private final AtomicBoolean isClosed = new AtomicBoolean(false);

	static {
	System.loadLibrary("textclassifier");
	}

	// Keep these in sync with the constants defined in AOSP.
	static final String TYPE_UNKNOWN = "";
	static final String TYPE_OTHER = "other";
	static final String TYPE_EMAIL = "email";
	static final String TYPE_PHONE = "phone";
	static final String TYPE_ADDRESS = "address";
	static final String TYPE_URL = "url";
	static final String TYPE_DATE = "date";
	static final String TYPE_DATE_TIME = "datetime";
	static final String TYPE_FLIGHT_NUMBER = "flight";

	private long annotatorPtr;

	/** Enumeration for specifying the usecase of the annotations. */
	public static enum AnnotationUsecase {
	/** Results are optimized for Smart{Select,Share,Linkify}. */
	SMART(0),

	/**
	* Results are optimized for using TextClassifier as an infrastructure that annotates as much as
	* possible.
	*/
	RAW(1);

	private final int value;

	AnnotationUsecase(int value) {
	this.value = value;
	}

	public int getValue() {
	return value;
	}
	};

	/**
	* Creates a new instance of SmartSelect predictor, using the provided model image, given as a
	* file descriptor.
	*/
	public AnnotatorModel(int fileDescriptor) {
	annotatorPtr = nativeNewAnnotator(fileDescriptor);
	if (annotatorPtr == 0L) {
	throw new IllegalArgumentException("Couldn't initialize TC from file descriptor.");
	}
	}

	/**
	* Creates a new instance of SmartSelect predictor, using the provided model image, given as a
	* file path.
	*/
	public AnnotatorModel(String path) {
	annotatorPtr = nativeNewAnnotatorFromPath(path);
	if (annotatorPtr == 0L) {
	throw new IllegalArgumentException("Couldn't initialize TC from given file.");
	}
	}

	/** Initializes the knowledge engine, passing the given serialized config to it. */
	public void initializeKnowledgeEngine(byte[] serializedConfig) {
	if (!nativeInitializeKnowledgeEngine(annotatorPtr, serializedConfig)) {
	throw new IllegalArgumentException("Couldn't initialize the KG engine");
	}
	}

	/** Initializes the contact engine, passing the given serialized config to it. */
	public void initializeContactEngine(byte[] serializedConfig) {
	if (!nativeInitializeContactEngine(annotatorPtr, serializedConfig)) {
	throw new IllegalArgumentException("Couldn't initialize the contact engine");
	}
	}

	/** Initializes the installed app engine, passing the given serialized config to it. */
	public void initializeInstalledAppEngine(byte[] serializedConfig) {
	if (!nativeInitializeInstalledAppEngine(annotatorPtr, serializedConfig)) {
	throw new IllegalArgumentException("Couldn't initialize the installed app engine");
	}
	}

	/**
	* Given a string context and current selection, computes the selection suggestion.
	*
	* <p>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.
	*
	* <p>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.
	*
	* <p>The begin and end params are character indices in the context string.
	*
	* <p>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<String> entityTypes,
	int annotationUsecase,
	boolean isSerializedEntityDataEnabled) {
	this.referenceTimeMsUtc = referenceTimeMsUtc;
	this.referenceTimezone = referenceTimezone;
	this.locales = locales;
	this.detectedTextLanguageTags = detectedTextLanguageTags;
	this.entityTypes = entityTypes == null ? new String[0] : entityTypes.toArray(new String[0]);
	this.annotationUsecase = annotationUsecase;
	this.isSerializedEntityDataEnabled = isSerializedEntityDataEnabled;
	}

	public AnnotationOptions(
	long referenceTimeMsUtc,
	String referenceTimezone,
	String locales,
	String detectedTextLanguageTags) {
	this(
	referenceTimeMsUtc,
	referenceTimezone,
	locales,
	detectedTextLanguageTags,
	null,
	AnnotationUsecase.SMART.getValue(),
	/* isSerializedEntityDataEnabled */ false);
	}

	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 String[] getEntityTypes() {
	return entityTypes;
	}

	public int getAnnotationUsecase() {
	return annotationUsecase;
	}

	public boolean isSerializedEntityDataEnabled() {
	return isSerializedEntityDataEnabled;
	}
	}

	/**
	* Retrieves the pointer to the native object. Note: Need to keep the AnnotatorModel alive as long
	* as the pointer is used.
	*/
	long getNativeAnnotator() {
	return nativeGetNativeModelPtr(annotatorPtr);
	}

	private static native long nativeNewAnnotator(int fd);

	private static native long nativeNewAnnotatorFromPath(String path);

	private static native String nativeGetLocales(int fd);

	private static native int nativeGetVersion(int fd);

	private static native String nativeGetName(int fd);

	private native long nativeGetNativeModelPtr(long context);

	private native boolean nativeInitializeKnowledgeEngine(long context, byte[] serializedConfig);

	private native boolean nativeInitializeContactEngine(long context, byte[] serializedConfig);

	private native boolean nativeInitializeInstalledAppEngine(long context, byte[] serializedConfig);

	private native int[] nativeSuggestSelection(
	long context, String text, int selectionBegin, int selectionEnd, SelectionOptions options);

	private native ClassificationResult[] nativeClassifyText(
	long context,
	String text,
	int selectionBegin,
	int selectionEnd,
	ClassificationOptions options,
	Object appContext,
	String deviceLocales);

	private native AnnotatedSpan[] nativeAnnotate(
	long context, String text, AnnotationOptions options);

	private native byte[] nativeLookUpKnowledgeEntity(long context, String id);

	private native void nativeCloseAnnotator(long context);
	}