Review Auto-Reply API reference

Customer Review Response Generation

GET/POST /ai/review/auto/reply

Customer Review Response Generation generates personalized response for various types of reviews by deeply analyzing user reviews and star ratings. It optimizes customer interaction, enhances service satisfaction, and ensures that every customer review receives a precise and considerate response.

Request Parameters

Parameter
Type
Required
Description

sourceLanguage

String

Yes

Source language of review. You can refer to the supported language pairs and code in the appendix.

Sample: en

targetLanguage

String

Yes

Target language of generated response. You can refer to the supported language pairs and code in the appendix.

Sample: en

commentContent

String

Yes

The review content.

Sample: very good

replyLength

Number

Yes

The length of the generated response. 0 =short(5-10 words)、1=medium(15-30 words)、2=long(30-50 words)。

Sample: 2

commentStarRating

Number

No

The star rating ranked by the customer. Range 1-5.

Sample: 5

productTitle

String

No

Product Title. It is used to help understand the content of customer reviews and provide more reasonable reponses.

Sample: 38pcs/Strand 13x13mm Starfish Shape Turquoises Beads Loose Spacer Beads Seed Beads for DIY Jewelry Making Bracelet Necklace

rootCategory

String

No

Root category of product. The more product information available, the more accurate the response content.

Sample: Jewelry & Accessories

leafCategory

String

No

Leaf category of product. The more product information available, the more accurate the response content.

Sample: Beads

extendParams

Object

No

Extend parameters. Reserved extension fields and can be ignored.

Sample Request

IopClient client = new IopClient(url, appkey, appSecret);
IopRequest request = new IopRequest();
request.setApiName("/ai/review/auto/reply");
request.addApiParameter("commentContent", "very good");
request.addApiParameter("sourceLanguage", "en");
request.addApiParameter("targetLanguage", "en");
request.addApiParameter("replyLenght", "2");
request.addApiParameter("commentStarRating", "5");
request.addApiParameter("productTitle", "38pcs/Strand 13x13mm Starfish Shape Turquoises Beads Loose Spacer Beads Seed Beads for DIY Jewelry Making Bracelet Necklace");
request.addApiParameter("rootCategory", "Jewelry & Accessories");
request.addApiParameter("leafCategory", "Beads");
request.addApiParameter("platformSource", "AE");
request.addApiParameter("extendParams", "{\"\":\"\"}");
IopResponse response = client.execute(request, Protocol.TOP);
System.out.println(response.getBody());
Thread.sleep(10);

Response Parameters

Parameter
Type
Description

result

Object

Result that generated.

resCode

Number

Result errors that generated.

data

Object

Result data that generated

replyContent

String[]

The content of response, such as"thanks for your comment."

success

Boolean

Request successfully.

resMessage

String

Request message.

resMessage

String

Request message; such as"content has sensitive data, please try other input"。

Sample Response

{
  "result": {
    "data": {
      "replayContent": [
        "Thank you so much for your positive feedback! We're thrilled to hear you had a great experience."
      ]
    },
    "success": true,
    "resCode": 200,
    "resMessage": "success"
  },
  "code": "0",
  "request_id": "2101725817192364345216241",
  "_trace_id_": "2140dcce17192364345174096eb7f3"
}

Errors

Error Code
Error Message
Description

700

invalid input

The format of the input parameters does not meet the requirements, and resMessage will return detailed fields that do not meet the requirements.

801

model failed

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

501

rate limit exceed

The current interface has reached the current limit. Please contact us via navigation bar or email us (aidge_support@service.alibaba.com) to increase the current limit value.

1000

content has sensitive data, please try other input

Content has sensitive data and cannot be handled now. 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 and Code

Language
Language Code

Arabic

ar

Chinese

zh

Dutch

nl

English

en

French

fr

German

de

Japanese

ja

Korean

ko

Portuguese

pt

Spanish

es

Turkish

tr

Last updated