Keyword extraction (English)

Updated at:

Keyword extraction (Basic Edition - E-commerce domain - English)

Usage notes

  • This service is a feature of the Basic Edition. To call this service for free, you must activate the Basic Edition. You can confirm your activation status here: Click to confirm activation

  • Supported language: English

  • Supported domain: E-commerce

  • Description:

    1. The model is trained using keywords and categories from E-commerce titles. It calculates a relevance score for each word to determine its relevance to the sentence. This process identifies and extracts the keywords from the sentence.

    2. This service is suitable for extracting keywords from E-commerce search queries, titles, and other similar short texts, typically 40 words or less.

Request parameters

Name

Type

Required

Example

Description

Action

String

Yes

GetKeywordEnEcom

A required parameter. The value is GetKeywordEnEcom.

ServiceCode

String

Yes

alinlp

A static field. Only alinlp is supported.

Text

String

Yes

Enter a piece of English e-commerce text.

The text to process. It is usually a sentence with a length of 40 words or less.

Response data

Name

Type

Example value

Description

RequestId

String

FA53D08F-37D1-4D81-BEE7-41F24E825F60

The unique ID of the request. Use this ID for troubleshooting.

Data

String

{
  "result": {
    "output": [
      "power bank"
    ]
  },
  "success": true
}

The result object contains only the output field, which is a list of keywords.

API access

  1. To access the API using code, see Quick Start.

  2. To try the service online, see Online trial.

Error codes

If an error occurs during a call, refer to the following table for its description, cause, and solution.

HTTP status code

Error code

Error message

Description

400

UserStatusInvalid

The user status is invalid.

The user status is invalid. Check your account for overdue payments or unpaid bills.

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

You do not have the permissions to operate on the specified resource. Click the URL for help: 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.

The encoding of the input text is invalid.

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 return 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: 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.