Named Entity Recognition (Multilingual Premium Edition)-阿里云帮助中心

Named Entity Recognition (Premium Edition - Multilingual)

Usage notes

This service is a feature of the Premium Edition. To call this service for free, activate the Premium Edition. You can confirm your activation status here: Confirm activation
Supported languages: English, Vietnamese, Indonesian, Thai, and Malay
Supported realm: E-commerce
Feature description: For the E-commerce realm, this service detects brands, products, and models. It also detects general entities such as names of people, locations, organizations, and dates.
Customization not supported: This service does not support customization methods such as custom dictionaries or regular expressions.

Request parameters

Name	Type	Required	Example value:	Description
Action	String	Yes	GetNerCustomizedSeaEcom	A required parameter. The value is GetNerCustomizedSeaEcom.
ServiceCode	String	Yes	alinlp	A static field. The value must be alinlp.
Language	String	Yes	en	Language code. Valid values: vi (Vietnamese), id (Indonesian), th (Thai), ms (Malay), and en (English).
Text	String	Yes	Text	The sentence to process. The maximum length is 500 characters.

Response data

Name	Type	Sample value	Description
RequestId	String	FA53D08F-37D1-4D81-BEE7-41F24E825F60	The unique ID of the request. Use this ID to troubleshoot issues.
Data	String	`{ "success": true, "tracerId": "2019a1bb-96ab-43cb-94ba-4face5aba579", "result": { "output": [ { "sentence": "Kính Mat Ray-Ban 0RB3129 W0226 Màu Xanh Riêu Gong Vang RBS07622", "sentence_seg": [ "Kính", "Mat", "Ray", "-", "Ban", "0RB3129", "W0226", "Màu", "Xanh", "Riêu", "Gong", "Vang", "RBS07622" ], "tags": [ { "class": "brand", "end": 17, "span": "Ray-Ban", "start": 10 }, { "class": "color", "end": 46, "span": "Xanh Riêu", "start": 37 } ] } ] } }`	output: The specific output result. sentence: The original input sentence. sentence_seg: The result after syllable segmentation. tags: A list where each element is a dictionary that corresponds to a named entity. class: The named entity type. start: The starting character position of the named entity. end: The ending character position of the named entity. span: The named entity string.

API access

For code-based access, see Quick Start.
For a quick online trial, see Online trial.

Supported E-commerce entity types

Category
- Example: "dress" in "slim-fit dress"
Category modifier
- Example: "car" in "car floor mat"
Brand
- Example: "Xiaomi" in "Xiaomi phone"
Material
Style
Design element
Color
Function or effect
Size or specification
Quality or condition
Scenario
Audience
Set or bundle
Time or season
Model
New product
Series
Marketing Service
Location or region
Person name
Movie or TV show title
Organization
Game title
Number
Unit
Common word
New word
Modifier
Proper noun
Symbol
Prefix
Suffix
Gift
Negation
Proxy
Entertainment (books, articles, or songs)

Error codes

If an error occurs during a call, see the following table for information about the cause and solution.

HttpCode	Error code	Error message	Description
400	UserStatusInvalid	The user status is invalid.	The user status is invalid. Check if your account has an overdue payment or an unpaid bill.
400	BasicServiceNotActivated	The NLP API （Version : base） service has not been activated. Please click the url to confirm the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpBasePost_public_cn#/buy	The NLP API (Basic Edition) service is not activated. Click the link to confirm the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpBasePost_public_cn#/buy
400	AdvancedServiceNotActivated	The NLP API （Version : advanced） service has not been activated. Please click the url to confirm the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpAdvancedPost_public_cn#/buy	The NLP API (Premium Edition) service is not activated. Click the link to confirm the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpAdvancedPost_public_cn#/buy
400	IndustryServiceNotActivated	The NLP API （Version : industry） service has not been activated. Please click the url to confirm the activation status:https://common-buy.aliyun.com/?commodityCode=nlp_alinlpIndustryPost_public_cn#/buy	The NLP API (Industry Application Edition) service is not activated. Click the link to confirm the activation status: https://common-buy.aliyun.com/?commodityCode=nlp_alinlpIndustryPost_public_cn#/buy
401	InvalidParameter	The parameter is invalid.	The parameter is invalid. Check the request parameters.
403	Forbidden.NoAuth	You are not authorized to operate on the specified resource. Please click the URL for help information:https://help.aliyun.com/document_detail/177209.html	Your account does not have the permission to operate on the specified resource. Click the URL for help information: https://help.aliyun.com/document_detail/177209.html
405	TextLimitExceeded	The maximum length of the text is exceeded.	The text length exceeds the limit.
406	TextCodingError	An encoding error occurred to the input text.	An encoding error occurred in the input text.
410	FrameworkError	Framework internal server error.	Framework error.
411	FrameworkApiError	Framework API error.	Framework API error.
412	FrameworkFormatError	Framework request format error.	Framework request format error.
413	FrameworkReturnError	Framework return type format error.	Framework response format error.
429	Throttling.User	Flow control has been triggered.	The maximum number of queries per second (QPS) is exceeded. Click the URL for help information: https://help.aliyun.com/document_detail/69780.html#p-wq5-zb9-5wu
500	InternalError	A server error occurred while processing your request. Please try again later or contact customer support.	A server error occurred while processing your request. Try again later or contact customer support.