新零售智能助理商家問答。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String RecognizeMessage

接口功能枚舉值

RobotCode String 1cY9drMec4b2uzS2

機器人ID

SessionId String aUeafnr-scgyw28f4

買賣家之間的會話ID

ChatId String c8jd-2ncpocs

單句的唯一ID

Round Integer 2

當前的對話輪次

Content String 你好

用戶輸入的query

ContentType String TEXT

用戶輸入的query類型

TEXT、PIC、URL、CLICK、OTHERS

ExtraContent Map

query擴展信息, 通常在點擊事件中使用

UserNick String 買家賬號

買家nick

UserId String 12345678

買家ID

StaffNick String 智能助理測試賬號客服

賣家接待人nick

StaffId String 12341

賣家接待人ID

SellerNick String 智能助理測試賬號

賣家nick

SellerId String 124234

賣家ID

ServiceMode String AUTO

機器人模式

FocusOrderId String 987654321

焦點訂單id

FocusItemId String 13579

焦點商品id

Orders Array

訂單列表

OrderId String 987654321

子訂單id

ParentOrderId String 1234567890

主訂單id

CreateTime Long 1611130298820

訂單創建時間

PayTime Long 1611130298820

訂單支付時間

BuyerId String 123445

買家id

SellerId String 124321143

賣家id

PayStatus String STATUS_PAID

支付狀態

RefundStatus String STATUS_WAIT_SELLER_AGREE

退款狀態

LogisticsStatus String STATUS_CONSIGNED

物流狀態

BuyerRateStatus String RATE_STATUS_RATED

評價狀態

ItemId String 13579

訂單中的商品id

ItemTitle String xxx商品

商品標題

ItemPic String https://image.alicdn.com/xxxxx

商品主圖URL

Price Float 123.45

訂單價格

Count Integer 1

訂單中的商品數量

SkuProperty String 顏色:紅;材質:棉

sku屬性

ExpectedSlots Array

期望槽位

SlotKey String sys.number.bodyheight

槽位key

Items Array

商品列表

ItemId String 13579

商品id

SellerId String 124321143

賣家id

Title String xxx商品

商品標題

CategoryId String 3333333

商品葉子類目id

ShopCategoryIds Array of String 12343421

商品店鋪類目id

Price Float 123.45

商品價格

PicUrl String https://img.alicdn.com/xxxxx

商品主圖url

Property Map 顏色:紅

商品屬性

String 顏色:紅

屬性鍵值對

Packages Array

調用知識包指令

PackageCode String common

行業包code

PackageVersion String 2

行業包版本

ClientInfo Object

客戶端信息

ClientVersion String 2.0.5

客戶端版本

ClientApp String taobao

客戶端APP

taobao、douyin、kuaishou、pdd、qiwei、jd、app、wechat、others

ClientOs String ios

客戶端系統

android、ios、harmonyos、windows、linux、macos、others

StressTesting Boolean false

是否壓測流量

PlatformCode String RETAILBOT_PAAS

平臺標識

Variables Map {}

調用方傳入的變量

返回數據

名稱 類型 示例值 描述
RequestId String 59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A

Id of the request

Data Object

問答返回結果

Scene Object

定位到的場景

SceneDTOs Array of SceneDTO

場景識別

SceneKey String sc_wenhou

場景key

SceneSource String singleRound

場景來源

contextModule String context_scene_e2e

多輪中上下文信息

PackageCode String sg_common

當前定位到的場景所屬的行業包Code

EmotionTag String fq_fennu

情緒識別

SemanticComplete String SEMANTIC_COMPLETE

語義完整性識別

ItemId String 13579

定位場景使用的商品id

OrderId String 987654321

定位場景使用的訂單id

Knowledges Array of KnowledgeDTO

定位到的知識

KnowledgeId Long 1

知識id

KnowledgeTitle String 測試知識

知識標題

SceneKey String sc_wenhou

場景key

Solutions Array of Solution

知識答案

SolutionId Long 3

答案id

KnowledgeId Long 1

知識id

SolutionType String text

答案類型

SolutionSource String source

答案來源

SolutionContent String 你好

答案內容

Conditions Array of Condition

答案限定條件

ConditionType String EffectiveMode

條件類型

ConditionValue String auto

條件表達式

ExtraContent String ["emoji1","emoji2"]

擴展答案信息

SolutionVariables Array of SolutionVariable

答案變量

VariableName String 變量名稱

變量名稱

VariableType String 系統變量

變量類型

OutputMessages Array of OutputMessage

建議的回復內容,為數組類型。每個元素表示一條消息。

OutputContentType String TEXT

表示消息的類型。可選值有IMAGE,LIVEAGENT,TEXT,NO_ANSWER,SELECTOR。

OutputContent Map

表示消息的具體內容,為JSON格式

1、轉人工消息示例


{
    "failMessage": "fail msg",//轉人工成功提示語
    "skillGroup": "groupId",//客服組id
    "successTip": "success msg",//轉人工成功提示語
    "ttpType":"SOLUTION_TTP",//表示轉人工類型。可選值有INSTRUCT_TTP("指令轉人工"),SOLUTION_TTP("答案直連人工"),GLOBAL_KEYWORD("全局關鍵詞轉人工"),STRATEGY("命中轉人工策略");
    "type": "LIVEAGENT"http://contentType
}

2、文本消息示例


{
    "content": "test msg",
    "type": "TEXT"
}

3、圖片消息示例


{
    "imgUrl": "http://test.aliyuncdn.com/xxx.png",
    "type": "IMAGE"
}

4、無答案消息


{
  "type": "NO_ANSWER",
  "noAnswerType": "MISS_SCENE"
}

noAnswerType 表示無答案類型,可選值有:

  • MISS_SCENE 未定位到場景
  • HIT_CLOSED_SCENE 定位到場景但場景關閉
  • HIT_NO_SOLUTION 定位到場景但未設置答案
  • HIT_SCENE_FILTERED 定位到場景但答案被條件過濾

5、訂單選擇器


{
    "code": "ORDER_SELECT",
    "type": "SELECTOR"
 }
OutputContentSource String FAQ

表示消息的來源自哪個功能模塊。可選值有DS,FAQ,MARKETING,ARTIFICIAL_SERVICE,ORDER_TRACKING,KEYWORD-OFFICIAL,KEYWORD-SELLER。例如、當OutputContentSource為FAQ時,表示該消息產生自FAQ功能。

extOutput Map

擴展的輸出

UnitSlots Object

識別到的槽位信息

UnitSpans Array of UnitSpan
Start Integer 0

槽位起始下標

End Integer 4

槽位結束下標

SlotKey String sys.number.bodyheight

槽位key

SlotValue String 170cm

槽位值

Source String model

槽位來源

Score double 0.8

槽位分值

Alias String 身高

槽位名稱

NumericSlotValue Object

槽位值

Num double 170

數值部分

Unit Object

單位部分

UnitKey String length_si_cm

單位唯一標識

UnitName String 厘米

單位中文名

Success Boolean true

是否成功

Code String 200

錯誤碼

Message String successful

錯誤信息

1.場景來源:單輪:singleRound, 多輪:multiRounds ,

2.上下模塊(多輪模式下補充):context_scene_inherit(場景繼承)、context_scene_semantic (基于語義的上下文)、context_scene_rule(基于知識的上下文)、context_scene_e2e(端到端的上下文)

示例

請求示例

http(s)://[Endpoint]/?Action=RecognizeMessage
&RobotCode=1cY9drMec4b2uzS2
&SessionId=aUeafnr-scgyw28f4
&ChatId=c8jd-2ncpocs
&Round=2
&Content=你好
&ContentType=TEXT
&UserNick=買家賬號
&UserId=12345678
&StaffNick=智能助理測試賬號:客服
&StaffId=12341
&SellerNick=智能助理測試賬號
&SellerId=124234
&ServiceMode=AUTO
&FocusOrderId=987654321
&FocusItemId=13579
&Orders=[{"OrderId":"987654321","ParentOrderId":"1234567890","CreateTime":1611130298820,"PayTime":1611130298820,"BuyerId":"123445","SellerId":"124321143","PayStatus":"STATUS_PAID","RefundStatus":"STATUS_WAIT_SELLER_AGREE","LogisticsStatus":"STATUS_CONSIGNED","BuyerRateStatus":"RATE_STATUS_RATED","ItemId":"13579","ItemTitle":"xxx商品","ItemPic":"https://image.alicdn.com/xxxxx","Price":123.45,"Count":1,"SkuProperty":"顏色:紅;材質:棉"}]
&ExpectedSlots=[{"SlotKey":"sys.number.bodyheight"}]
&Items=[{"ItemId":"13579","SellerId":"124321143","Title":"xxx商品","CategoryId":"3333333","ShopCategoryIds":["12343421"],"Price":123.45,"PicUrl":"https://img.alicdn.com/xxxxx","Property":{"key":"顏色:紅"}}]
&Packages=[{"PackageCode":"common","PackageVersion":"2"}]
&ClientInfo={"ClientVersion":"2.0.5","ClientApp":"taobao","ClientOs":"ios"}
&StressTesting=false
&PlatformCode=RETAILBOT_PAAS
&公共請求參數

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RecognizeMessageResponse>
    <RequestId>59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A</RequestId>
    <Data>
        <Scene>
            <SceneDTOs>
                <SceneKey>sc_wenhou</SceneKey>
                <SceneSource>singleRound</SceneSource>
                <contextModule>context_scene_e2e</contextModule>
            </SceneDTOs>
            <EmotionTag>fq_fennu</EmotionTag>
            <SemanticComplete>SEMANTIC_COMPLETE</SemanticComplete>
            <ItemId>13579</ItemId>
            <OrderId>987654321</OrderId>
        </Scene>
        <Knowledges>
            <KnowledgeId>1</KnowledgeId>
            <KnowledgeTitle>測試知識</KnowledgeTitle>
            <SceneKey>sc_wenhou</SceneKey>
            <Solutions>
                <SolutionId>3</SolutionId>
                <KnowledgeId>1</KnowledgeId>
                <SolutionType>text</SolutionType>
                <SolutionSource>source</SolutionSource>
                <SolutionContent>你好</SolutionContent>
                <Conditions>
                    <ConditionType>EffectiveMode</ConditionType>
                    <ConditionValue>auto</ConditionValue>
                </Conditions>
                <ExtraContent>["emoji1","emoji2"]</ExtraContent>
                <SolutionVariables>
                    <VariableName>變量名稱</VariableName>
                    <VariableType>系統變量</VariableType>
                </SolutionVariables>
            </Solutions>
        </Knowledges>
        <OutputMessages>
            <OutputContentType>ASK_TEXT</OutputContentType>
        </OutputMessages>
        <UnitSlots>
            <UnitSpans>
                <Start>0</Start>
                <End>4</End>
                <SlotKey>sys.number.bodyheight</SlotKey>
                <SlotValue>170cm</SlotValue>
                <Source>model</Source>
                <Score>0.8</Score>
                <Alias>身高</Alias>
                <NumericSlotValue>
                    <Num>170</Num>
                    <Unit>
                        <UnitKey>length_si_cm</UnitKey>
                        <UnitName>厘米</UnitName>
                    </Unit>
                </NumericSlotValue>
            </UnitSpans>
        </UnitSlots>
    </Data>
    <Success>true</Success>
    <Code>200</Code>
    <Message>successful</Message>
</RecognizeMessageResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A",
  "Data" : {
    "Scene" : {
      "SceneDTOs" : [ {
        "SceneKey" : "sc_wenhou",
        "SceneSource" : "singleRound",
        "contextModule" : "context_scene_e2e"
      } ],
      "EmotionTag" : "fq_fennu",
      "SemanticComplete" : "SEMANTIC_COMPLETE",
      "ItemId" : "13579",
      "OrderId" : "987654321"
    },
    "Knowledges" : [ {
      "KnowledgeId" : 1,
      "KnowledgeTitle" : "測試知識",
      "SceneKey" : "sc_wenhou",
      "Solutions" : [ {
        "SolutionId" : 3,
        "KnowledgeId" : 1,
        "SolutionType" : "text",
        "SolutionSource" : "source",
        "SolutionContent" : "你好",
        "Conditions" : [ {
          "ConditionType" : "EffectiveMode",
          "ConditionValue" : "auto"
        } ],
        "ExtraContent" : "[\"emoji1\",\"emoji2\"]",
        "SolutionVariables" : [ {
          "VariableName" : "變量名稱",
          "VariableType" : "系統變量"
        } ]
      } ]
    } ],
    "OutputMessages" : [ {
      "OutputContentType" : "ASK_TEXT"
    } ],
    "UnitSlots" : {
      "UnitSpans" : [ {
        "Start" : 0,
        "End" : 4,
        "SlotKey" : "sys.number.bodyheight",
        "SlotValue" : "170cm",
        "Source" : "model",
        "Score" : 0.8,
        "Alias" : "身高",
        "NumericSlotValue" : {
          "Num" : 170,
          "Unit" : {
            "UnitKey" : "length_si_cm",
            "UnitName" : "厘米"
          }
        }
      } ]
    }
  },
  "Success" : true,
  "Code" : "200",
  "Message" : "successful"
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
429 Throttling.Api The request was denied due to API flow control. 請求已超過最大允許的流量
500 InternalError The request processing has failed due to some unknown error. 內部服務出現錯誤

訪問錯誤中心查看更多錯誤碼。