text compare

概览

  • API URL:/api/v1/zoloz/textcompare/compare
  • API 描述:该接口用于比对两个文本的相似度,并返回相似度得分结果。

请求参数

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32

-

业务ID,业务的唯一标识,用于追踪业务。例如,商户业务相关数据库中的序列号。

说明:ZOLOZ服务器不检查该字段的值是否唯一。为了更便捷地追踪业务,建议开启商户服务器,并确保业务ID的唯一性。

"1759743058709"

textData1

String

512

-

待比对文本内容1。

"fff"

textData2

String

512

-

待比对文本内容2。

"fff"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

API请求结果,包含结果状态、结果码和结果消息。

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

transactionId

String

事务ID。

说明:仅当交易进入处理阶段后系统才会返回transactionId。如果在开始处理交易之前发生错误,系统不会返回transactionId。包括但不限于以下情况:

  • 请求参数非法,例如入参格式错误或缺失必传参数。
  • 请求未能成功到达服务器,例如网络问题或网关故障。
  • 系统限流导致请求被拒绝。

"G000000006FTC2025100600000014509101****"

score

Double

文本相似度比对分数,分值范围为0-100,分值越高相似度越高。

100.0

Result字段说明

字段名称

数据类型

必须返回

描述

示例值

resultCode

String

结果码。

  • SUCCESS:API调用成功。
  • SYSTEM_ERROR:其他内部错误。有关错误详情,请查看返回的resultMessage。
  • INVALID_ARGUMENT:输入参数无效。关于无效参数的详细信息,请查看返回的resultMessage。

"SUCCESS"

resultStatus

String

结果状态。

  • S:成功
  • F:失败

"S"

resultMessage

String

结果信息。

"Success"

代码示例

请求示例

copy
POST /api/v1/zoloz/textcompare/compare HTTP/1.1
Content-Type: application/json; charset=UTF-8
Client-Id: 5X67656YXXXXXX
Request-Time: 2025-10-06T21:56:11-0800
Signature: algorithm=RSA256, signature=xxxxxxxxxxxx

{
  "bizId": "1759743058709",
  "textData2": "fff",
  "textData1": "fff"
}

返回示例

copy
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Response-Time: 2025-10-06T21:56:15-0800
Signature: algorithm=RSA256, signature=xxxxxxxxxxxxxxxxxx

{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success",
    "resultStatus": "S"
  },
  "score": 100.0,
  "transactionId": "G000000006FTC2025100600000014509101****"
}