Getting started

Updated at:

This tutorial helps you get started with calling Natural Language Processing (NLP) services.

Support group

Each API has a default queries per second (QPS) limit after you activate the service. To increase your QPS limit or for any other questions, join the "Alibaba Cloud NLP Basic Service User Support Group" on DingTalk. The group number is 35235845.

Step 1: Activate the service

You must activate NLP before you can purchase and use its products.

  1. Create an account: You must have an Alibaba Cloud account. If you do not have one, click here to create one.

  2. Activate the service: Click the activation link in the table below to activate the corresponding algorithm. After activation, you can purchase resource plans. For more information, see the console.

Edition

Activation link

Resource plan purchase link

Description

Basic Text Service - Basic Edition

Activate

Purchase

  • Provides general-domain APIs for lexical, syntactic, and discourse analysis, such as general tokenization and part-of-speech tagging.

  • Each algorithm service includes a free quota of 500,000 calls/day.

Basic Text Service - Premium Edition

Activate

Purchase

  • Provides domain-specific APIs for lexical, syntactic, and discourse analysis. This edition offers more comprehensive features than the Basic Edition, such as E-commerce tokenization and Chinese-English error correction.

  • Each algorithm service includes a one-time free quota of 500,000 calls.

E-commerce capabilities

Activate

Purchase

  • Provides multiple capabilities for E-commerce scenarios, including intelligent product publishing, product review parsing, and knowledge extraction from E-commerce customer service dialogues.

  • All algorithm services include a one-time free quota of 500 calls.

Conversational intelligence service

Activate

Purchase

  • Provides table-based Q&A pairs, open-domain dialogue (coming soon), and FAQ mining (coming soon).

  • Free to use during the public preview.

General industry capabilities

Activate

Purchase

  • Provides general capabilities for various industry scenarios, including bidding document parsing, resume extraction, and legal document parsing.

  • All algorithm services include a one-time free quota of 500 calls.

Healthcare industry capabilities

Activate

Purchase

  • Provides NLP algorithm capabilities for specific industry domains, such as medical record deduplication and medical named entity recognition.

  • Each algorithm service includes a one-time free quota of 500 calls.

For a detailed list of algorithm capabilities, see the console or the Product Introduction.

Step 2: Obtain an AccessKey

Use an AccessKey for identity verification when you call Alibaba Cloud APIs from your code.

Important
  1. An AccessKey consists of an AccessKey ID and an AccessKey secret.

    1. AccessKey ID: Identifies the user.

    2. AccessKey secret: A key used to authenticate the user. Keep your AccessKey secret confidential.

  2. A leaked AccessKey for your Alibaba Cloud account can compromise all resources under that account. To ensure account security, create an AccessKey for a Resource Access Management (RAM) user instead of for your Alibaba Cloud account.

For more information, see Create an AccessKey.

Important: To prevent key leakage, do not hardcode your AccessKey ID and AccessKey secret into your code. The SDK code examples show how to configure access credentials using environment variables. Use this method to store and read your AccessKey ID and AccessKey secret.

Step 3: Grant permissions to a RAM user

If you use a RAM user to call this product, you must grant the necessary permissions to that user. A RAM user cannot access or call the product without the required permissions. For more information, see Grant permissions to a RAM user.

Step 4: Select an API to call

Select the API you want to use from the Product Introduction and view its corresponding API reference.

Alternatively, you can find the API basic information reference document in the Operations column of the console or in the API reference. This document contains the API description and call information.

Step 5: Call the API

You can use one of the SDKs in the table below to call the API. For information about how to obtain the AccessKey ID and AccessKey secret required by the SDK, see Step 2.

For descriptions of the API request parameters and return values, see the API basic information reference document mentioned in Step 4.

If an API call fails, see Troubleshoot API call errors (error codes) for initial troubleshooting.

Java SDK

Python SDK

PHP

Node.js

Go

C#

Swift

If the SDKs do not meet your needs, you can make calls using the HTTP request structure. The custom signing process is complex. If you encounter problems, join the support group for assistance.

For pricing details, see Pricing.