Product Title Generation API Reference

Product Title Generation

GET/POST /ai/product/title/generation

Product Title Generation is trained on massive e-commerce data. With simple input parameters, it can quickly generate highly attractive titles based on category features, highlighting the product's advantages and helping merchants acquire more traffic.

Request Parameters

Parameter Type Required Description

Parameter	Type	Required	Description
`productName`	String	Yes	Product name. You can enter the original product title or a short description of the product. Total character length must not exceed 500. `Sample: Pen for iPad, 13 mins Fast Charging Stylus with Palm Rejection, Tilt Sensitivity, Compatible with 2018-2022 iPad Air 3/4/5, iPad Mini 5/6, iPad 6/7/8/9/10, iPad Pro 11", iPad Pro 12.9" (Black)`
`productCategory`	String[]	Yes	Category that product belongs. You can refer to the category structure of any platform and input the product category name. The more detailed the category information, the more accurate the generated results will be. `Sample: ["Clothes"]`
`targetLanguage`	String	Yes	Target language for generated language. You need to input a language code here, which can be found in the language code appendix. Currently supported languages are listed in the appendix for Languages of Titles Supporting Generated. `Sample: es`
`productKeyword`	String[]	No	Product related keyword which are usually SEO-related keywords or core selling points of the product. The more you input, the more it will help the generation results. Fill in any additional keywords that need to be added during the product title generation process `Sample: sweet`
`itemSpec`	String	No	Product features，characterization of products，like material. Input the product attribute names and attribute values (Key1: Value1, Key2: Value2) to make the generated results more detailed and accurate. `Sample: Number: 12 cans, Brand: Coca Cola`;
`productDescription`	String	No	Product detailed description, introduce the selling points. In the product title generation, if more basic information is provided, the generation effect is more accurate. Sample: Ergonomic Comfort Design: The wireless ergonomic keyboard features with curved and split key-frame design, which helps to position your wrist and forearm in a more natural, relaxed posture.Scooped keys perfectly match the shape of your fingertips, offering quick response with every keystroke. Premium comfort for all-day typing.Cushioned Palm Rest: Curved palm rest with soft memory foam layer offers typing comfort with more wrist support, less wrist bending compared to standard keyboard without palm rest. Adjustable tilt design positions the keyboard at a perfect angle to keep your wrist relaxed and comfortable whether seated or standing.2.4G Wireless keyboard and Mouse comb : The keyboard and mouse share the same one USB receiverColoful keyboard and mouse!
`generateCounts`	Integer	No	Generate counts. The number of results to be generated at one time can be an integer between 1 and 6, if not specified, the default is 1. `Sample: 2`

productName

String

Yes

Product name. You can enter the original product title or a short description of the product.

Total character length must not exceed 500.

Sample: Pen for iPad, 13 mins Fast Charging Stylus with Palm Rejection, Tilt Sensitivity, Compatible with 2018-2022 iPad Air 3/4/5, iPad Mini 5/6, iPad 6/7/8/9/10, iPad Pro 11", iPad Pro 12.9" (Black)

productCategory

String[]

Yes

Category that product belongs. You can refer to the category structure of any platform and input the product category name. The more detailed the category information, the more accurate the generated results will be. Sample: ["Clothes"]

targetLanguage

String

Yes

Target language for generated language. You need to input a language code here, which can be found in the language code appendix. Currently supported languages are listed in the appendix for Languages of Titles Supporting Generated.

Sample: es

productKeyword

String[]

Product related keyword which are usually SEO-related keywords or core selling points of the product. The more you input, the more it will help the generation results. Fill in any additional keywords that need to be added during the product title generation process

Sample: sweet

itemSpec

String

Product features，characterization of products，like material. Input the product attribute names and attribute values (Key1: Value1, Key2: Value2) to make the generated results more detailed and accurate. Sample: Number: 12 cans, Brand: Coca Cola;

productDescription

String

Product detailed description, introduce the selling points. In the product title generation, if more basic information is provided, the generation effect is more accurate. Sample: Ergonomic Comfort Design: The wireless ergonomic keyboard features with curved and split key-frame design, which helps to position your wrist and forearm in a more natural, relaxed posture.Scooped keys perfectly match the shape of your fingertips, offering quick response with every keystroke. Premium comfort for all-day typing.Cushioned Palm Rest: Curved palm rest with soft memory foam layer offers typing comfort with more wrist support, less wrist bending compared to standard keyboard without palm rest. Adjustable tilt design positions the keyboard at a perfect angle to keep your wrist relaxed and comfortable whether seated or standing.2.4G Wireless keyboard and Mouse comb : The keyboard and mouse share the same one USB receiverColoful keyboard and mouse!

generateCounts

Integer

Generate counts. The number of results to be generated at one time can be an integer between 1 and 6, if not specified, the default is 1.

Sample: 2

Sample Request

IopClient client = new IopClient(url, appkey, appSecret);
IopRequest request = new IopRequest();
request.setApiName("/ai/product/title/generation");
request.addApiParameter("targetLanguage", "en");
request.addApiParameter("productName", "Vintage Black Printing Blazer Women Jacket High Street Fashion 2024 Spring Plus Size Elegant Office Lady Coat American Stylish.");
request.addApiParameter("productCategory", "[\"Blazers\"]");
request.addApiParameter("generateCounts", "1");
request.addApiParameter("productDescription", "Sleeve Type, style, Sleeve Length, distinctive features, category terms, benefits.");
request.addApiParameter("productKeyword", "[\"chaqueta casual mujer\",\"female blazers jacket\"]");
request.addApiParameter("itemSpec", "[\"service:dropshippingClothing\", \"style\":Europe and America\",\"pattern:Printing\",\"season:spring\"]");
IopResponse response = client.execute(request);
System.out.println(response.getBody());
Thread.sleep(10);

Response Parameters

Parameter Type Description

Parameter	Type	Description
`resCode`	Number	Response code;200 indicates a successful call,other response codes can be referred to in the error code information.
`data`	Object	Result data that generated.
`requestId`	String	Request ID.
`success`	Boolean	Request successfully.
`resMessage`	String	Request message;if an error occurs,it will be reflected in this field.

resCode

Number

Response code;200 indicates a successful call,other response codes can be referred to in the error code information.

data

Object

Result data that generated.

requestId

String

Request ID.

success

Boolean

Request successfully.

resMessage

String

Request message;if an error occurs,it will be reflected in this field.

Sample Response

{
  "data": {
    "usage": 1,
    "generatedTitle": [
      "Vintage Black Printing Blazer Women's High Street Fashion Office Lady Coat Elegant Plus Size Jacket for Spring 2024 American Style"
    ],
    "class": "com.aidc.service.api.client.text.dto.ProductTitleGenerationResponse"
  },
  "requestId": "2141069c17186253490176155e1cdc",
  "success": true,
  "resCode": 200,
  "resMessage": "success",
  "code": "0",
  "request_id": "212a714317186253490184213",
  "_trace_id_": "2141069c17186253490176155e1cdc"
}

Errors

Error Code	Error Message	Description
700	invalid input	Input parameters does not meet the requirements, resMessage will return detailed information about the fields that do not comply.
801	model failed	Internal call exception. Please contact us via navigation bar or email us (aidge_support@service.alibaba.com) for troubleshooting.
501	rate limit exceed	The current interface has reached its rate limit. Please contact us to increase the current limit.
1000	content has sensitive data, please try other input	Content has sensitive data, please try other input.
1001	content control failed, please retry	Content control failed, please retry.
1002	content risk filter failed, please contact us	Content risk filter failed, please contact us via navigation bar or email us (aidge_support@service.alibaba.com).

Error Code

Error Message

Description

700

invalid input

Input parameters does not meet the requirements, resMessage will return detailed information about the fields that do not comply.

801

model failed

Internal call exception. Please contact us via navigation bar or email us (aidge_support@service.alibaba.com) for troubleshooting.

501

rate limit exceed

The current interface has reached its rate limit. Please contact us to increase the current limit.

1000

content has sensitive data, please try other input

Content has sensitive data, please try other input.

1001

content control failed, please retry

Content control failed, please retry.

1002

content risk filter failed, please contact us

Content risk filter failed, please contact us via navigation bar or email us (aidge_support@service.alibaba.com).

Appendix

Supported Language Pairs

The Product Title Generation API supports generation between the language pairs listed in the following table. More language pairs are continuously being added. Please contact us via navigation bar or email us (aidge_support@service.alibaba.com) if you have any specific requirements.

Source Language	Target Language
Chinese	English
Chinese	Spanish
Chinese	French
Chinese	Portuguese
Chinese	Korean
Chinese	Japanese
Chinese	Vietnamese
Chinese	Thai
Chinese	Turkish
Chinese	Indonesian
Chinese	German
Chinese	Italian
Chinese	Malay
Chinese	Russian
Chinese	Dutch
English	English
English	Spanish
English	French
English	Portuguese
English	Korean
English	Japanese
English	Vietnamese
English	Thai
English	Turkish
English	Indonesian
English	German
English	Italian
English	Malay
English	Russian
English	Dutch

Source Language

Target Language

Chinese

English

Chinese

Spanish

Chinese

French

Chinese

Portuguese

Chinese

Korean

Chinese

Japanese

Chinese

Vietnamese

Chinese

Thai

Chinese

Turkish

Chinese

Indonesian

Chinese

German

Chinese

Italian

Chinese

Malay

Chinese

Russian

Chinese

Dutch

English

Spanish

English

French

English

Portuguese

English

Korean

English

Japanese

English

Vietnamese

English

Thai

English

Turkish

English

Indonesian

English

German

English

Italian

English

Malay

English

Russian

English

Dutch

Language Code

The language code uses ISO 639-1 two-digit language codes. For a country/region variant of a language, the table follows the RFC 5646 format of appending a dash followed by an ISO 3166 2-digit country code. For example, the language code for Traditional Chinese is zh-tw.

Language	Language Code
Arabic	ar
Chinese (Simplified)	zh
Chinese (Traditional)	zh-tw
Danish	da
Dutch	nl
English	en
Persian	fa
Filipino/Tagalog	tl
Finnish	fi
French	fr
German	de
Hungarian	hu
Icelandic	is
Indonesian	id
Italian	it
Japanese	ja
Korean	ko
Lithuanian	lt
Malay	ms
Polish	pl
Portuguese (Portugal)	pt
Romanian	ro
Russian	ru
Sinhala	si
Spanish	es
Thai	th
Turkish	tr
Ukrainian	uk
Urdu	ur
Uzbek	uz
Vietnamese	vi

Language

Language Code

Arabic

Chinese (Simplified)

Chinese (Traditional)

zh-tw

Danish

Dutch

English

Persian

Filipino/Tagalog

Finnish

French

German

Hungarian

Icelandic

Indonesian

Italian

Japanese

Korean

Lithuanian

Malay

Polish

Portuguese (Portugal)

Romanian

Russian

Sinhala

Spanish

Thai

Turkish

Ukrainian

Urdu

Uzbek

Vietnamese

PreviousProduct Title Generation NextProduct Description Generation

Last updated 2 months ago