Natural Language Kit annotates all input plain text as part-of-speech tags, indicating whether each word is a noun, verb, adjective, or other part of speech.
It also extracts entities from the input text and classifies them into different types. The output results contain the entity type, location of an entity in the input text, original text of the entity, and other parameters obtained in entity parsing. For details about entity parameters, please refer to EntityType.
Start version: 5.0.0(12)
Word segmentation output, including words and parts of speech.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
word | string | No | No | Word. |
Entity type, which is optional.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
entitytypes | No | Yes | Type of an entity. |
Entity type enumeration class.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Name | Value | Description |
|---|---|---|
DATETIME | datetime | Date and time. |
Email address. | ||
EXPRESS_NO | expressNo | Courier number. |
FLIGHT_NO | flightNo | Flight number. |
LOCATION | location | Location. |
NAME | name | Name. |
PHONE_NO | phoneNo | Mobile number. |
URL | url | URL. |
VERIFICATION_CODE | verificationCode | Verification code. |
ID_NO | idNo | ID card number. |
Entity extraction result.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
text | string | No | No | Original text. |
charOffset | number | No | No | Location of an entity in the original text. |
type | No | No | Type of an entity. | |
jsonObject | string | No | No | Other parameters about an entity. |
getWordSegment(text: string): Promise<Array<WordSegment>>
Creates a word segmentation instance and initializes the engine. This API returns the result asynchronously through a promise.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
text | string | Yes | Text to be analyzed. |
Returns:
Type | Description |
|---|---|
Promise<Array<WordSegment>> | Promise object, which returns a set of word segmentation results. |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
200 | Run timed out, please try again later. |
401 | The parameter check failed. |
1011200001 | Failed to run, please try again. |
1011200002 | The service is abnormal. |
Example:
import { textProcessing } from '@kit.NaturalLanguageKit'
import { BusinessError } from '@kit.BasicServicesKit';
async function testWordSegment(inputText: string) {
textProcessing.getWordSegment(inputText)
.then(result => {
let outputText = formatWordSegmentResult(result);
console.info(outputText);
})
.catch((err: BusinessError) => {
console.error(`getWordSegment errorCode: ${err.code} errorMessage: ${err.message}`);
});
}
function formatWordSegmentResult(segments: textProcessing.WordSegment[]): string {
let output = 'Word Segments:\n';
segments.forEach((segment, index) => {
output += `Word[${index}]: ${segment.word}, Tag: ${segment.wordTag}\n`;
});
return output;
}
// Test text word segmentation.
let inputText = 'test for nlp word segment';
testWordSegment(inputText); getEntity(text: string, entityConfig?: EntityConfig): Promise<Array<Entity>>
Creates an entity extraction instance and initializes the engine. This API returns the result asynchronously through a promise.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
text | string | Yes | Input string. |
entityConfig | No | Entity type. |
Returns:
Type | Description |
|---|---|
Promise<Array<Entity>> | Promise object, which returns the entity set. |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
200 | Run timed out, please try again later. |
401 | The parameter check failed. |
1011200001 | Failed to run, please try again. |
1011200002 | The service is abnormal. |
Example:
import { textProcessing, EntityType } from '@kit.NaturalLanguageKit';
import { BusinessError } from '@kit.BasicServicesKit';
async function testEntityRecognition(inputText: string) {
textProcessing.getEntity(inputText, {
entityTypes: [EntityType.NAME]
}).then(result => {
let outputText = formatEntityResult(result);
console.info(outputText);
}).catch((err: BusinessError) => {
console.error(`getEntity errorCode: ${err.code} errorMessage: ${err.message}`);
})
}
function formatEntityResult(entities: textProcessing.Entity[]): string {
if (!entities || !entities.length) {
return 'No entities found.';
}
let output = 'Entities:\n';
for (let i = 0; i < entities.length; i++) {
let entity = entities[i];
output += `Entity[${i}]:\n`;
output += ` oriText: ${entity.text}\n`;
output += ` charOffset: ${entity.charOffset}\n`;
output += ` entityType: ${entity.type}\n`;
output += ` jsonObject: ${entity.jsonObject}\n\n`;
}
return output;
}
// Test entity recognition.
let inputText = 'test for nlp getEntity. Mary, Bob and Mike.';
testEntityRecognition(inputText); init(): Promise<boolean>
Initializes the natural language processing engine. This API returns the result asynchronously through a promise.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Returns:
Type | Description |
|---|---|
Promise<boolean> | Promise object, indicating whether initialization is successful. The values are true (yes) and false (no). |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
200 | Run timed out, please try again later. |
401 | The parameter check failed. |
1011200001 | Failed to run, please try again. |
1011200002 | The service is abnormal. |
Example:
import { textProcessing } from '@kit.NaturalLanguageKit';
import { BusinessError } from '@kit.BasicServicesKit';
textProcessing.init().then(async result => {
console.info(`textProcess init result: ${result}`)
}).catch((err: BusinessError) => {
console.error(`textProcess init failed errorCode: ${err.code} errorMessage: ${err.message}`);
}) release(): Promise<boolean>
Releases the engine. This API returns the result asynchronously through a promise.
System capability: SystemCapability.AI.NaturalLanguage.TextProcessing
Start version: 5.0.0(12)
Returns:
Type | Description |
|---|---|
Promise<boolean> | Promise object, which indicates whether the engine is successfully released. The values are true (yes) and false (no). |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
200 | Run timed out, please try again later. |
401 | The parameter check failed. |
1011200001 | Failed to run, please try again. |
1011200002 | The service is abnormal. |
Example:
import { textProcessing } from '@kit.NaturalLanguageKit';
export async function runTextProcessing() {
await textProcessing.init();
console.info('Text processing initialized successfully');
try {
const result = await textProcessing.release();
console.info(`textProcess release result: ${result}`);
} catch (err) {
console.error(`textProcess release failed errorCode: ${err.code} errorMessage: ${err.message}`);
}
}