Stay organized with collections
Save and categorize content based on your preferences.
TextClassificationManager
class TextClassificationManager
Interface to the text classification service.
Summary
Public methods
createTextClassificationSession
fun createTextClassificationSession(classificationContext: TextClassificationContext): TextClassifier
Call this method to start a text classification session with the given context. A session is created with a context helping the classifier better understand what the user needs and consists of queries and feedback events. The queries are directly related to providing useful functionality to the user and the events are a feedback loop back to the classifier helping it learn and better serve future queries.
All interactions with the returned classifier are considered part of a single session and are logically grouped. For example, when a text widget is focused all user interactions around text editing (selection, editing, etc) can be grouped together to allow the classifier get better.
| Parameters |
classificationContext |
TextClassificationContext: The context in which classification would occur This value cannot be null. |
| Return |
TextClassifier |
An instance to perform classification in the given context This value cannot be null. |
getTextClassifier
fun getTextClassifier(): TextClassifier
Returns the text classifier that was set via setTextClassifier(android.view.textclassifier.TextClassifier). If this is null, this method returns a default text classifier (i.e. either the system text classifier if one exists, or a local text classifier running in this process.)
Note that requests to the TextClassifier may be handled in an OEM-provided process rather than in the calling app's process.
setTextClassificationSessionFactory
fun setTextClassificationSessionFactory(factory: TextClassificationSessionFactory?): Unit
Sets a TextClassificationSessionFactory to be used to create session-aware TextClassifiers.
setTextClassifier
fun setTextClassifier(textClassifier: TextClassifier?): Unit
Sets the text classifier. Set to null to use the system default text classifier. Set to TextClassifier.NO_OP to disable text classifier features.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# TextClassificationManager\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nTextClassificationManager\n=========================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/view/textclassifier/TextClassificationManager \"View this page in Java\") \n\n```\nclass TextClassificationManager\n```\n\n|---|------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.view.textclassifier.TextClassificationManager](#) |\n\nInterface to the text classification service.\n\nSummary\n-------\n\n| Public methods ||\n|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [TextClassifier](/reference/kotlin/android/view/textclassifier/TextClassifier) | [createTextClassificationSession](#createTextClassificationSession(android.view.textclassifier.TextClassificationContext))`(`classificationContext:` `[TextClassificationContext](/reference/kotlin/android/view/textclassifier/TextClassificationContext)`)` Call this method to start a text classification session with the given context. |\n| [TextClassifier](/reference/kotlin/android/view/textclassifier/TextClassifier) | [getTextClassifier](#getTextClassifier())`()` Returns the text classifier that was set via [setTextClassifier(android.view.textclassifier.TextClassifier)](#setTextClassifier(android.view.textclassifier.TextClassifier)). |\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setTextClassificationSessionFactory](#setTextClassificationSessionFactory(android.view.textclassifier.TextClassificationSessionFactory))`(`factory:` `[TextClassificationSessionFactory](/reference/kotlin/android/view/textclassifier/TextClassificationSessionFactory)?`)` Sets a TextClassificationSessionFactory to be used to create session-aware TextClassifiers. |\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setTextClassifier](#setTextClassifier(android.view.textclassifier.TextClassifier))`(`textClassifier:` `[TextClassifier](/reference/kotlin/android/view/textclassifier/TextClassifier)?`)` Sets the text classifier. |\n\nPublic methods\n--------------\n\n### createTextClassificationSession\n\nAdded in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun createTextClassificationSession(classificationContext: TextClassificationContext): TextClassifier\n```\n\nCall this method to start a text classification session with the given context. A session is created with a context helping the classifier better understand what the user needs and consists of queries and feedback events. The queries are directly related to providing useful functionality to the user and the events are a feedback loop back to the classifier helping it learn and better serve future queries.\n\nAll interactions with the returned classifier are considered part of a single session and are logically grouped. For example, when a text widget is focused all user interactions around text editing (selection, editing, etc) can be grouped together to allow the classifier get better.\n\n| Parameters ||\n|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `classificationContext` | [TextClassificationContext](/reference/kotlin/android/view/textclassifier/TextClassificationContext): The context in which classification would occur This value cannot be `null`. |\n\n| Return ||\n|--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|\n| [TextClassifier](/reference/kotlin/android/view/textclassifier/TextClassifier) | An instance to perform classification in the given context This value cannot be `null`. |\n\n### getTextClassifier\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getTextClassifier(): TextClassifier\n```\n\nReturns the text classifier that was set via [setTextClassifier(android.view.textclassifier.TextClassifier)](#setTextClassifier(android.view.textclassifier.TextClassifier)). If this is null, this method returns a default text classifier (i.e. either the system text classifier if one exists, or a local text classifier running in this process.)\n\nNote that requests to the TextClassifier may be handled in an OEM-provided process rather than in the calling app's process. \n**See Also**\n\n- [#setTextClassifier(TextClassifier)](#setTextClassifier(android.view.textclassifier.TextClassifier)) \n\n### setTextClassificationSessionFactory\n\nAdded in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun setTextClassificationSessionFactory(factory: TextClassificationSessionFactory?): Unit\n```\n\nSets a TextClassificationSessionFactory to be used to create session-aware TextClassifiers.\n\n| Parameters ||\n|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `factory` | [TextClassificationSessionFactory](/reference/kotlin/android/view/textclassifier/TextClassificationSessionFactory)?: the textClassification session factory. If this is null, the default factory will be used. |\n\n### setTextClassifier\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun setTextClassifier(textClassifier: TextClassifier?): Unit\n```\n\nSets the text classifier. Set to null to use the system default text classifier. Set to [TextClassifier.NO_OP](/reference/kotlin/android/view/textclassifier/TextClassifier#NO_OP:android.view.textclassifier.TextClassifier) to disable text classifier features.\n\n| Parameters ||\n|------------------|------------------------------------------------------------------------------------------------------------|\n| `textClassifier` | [TextClassifier](/reference/kotlin/android/view/textclassifier/TextClassifier)?: This value may be `null`. |"]]
