NLP 文本语义相似度检测 - LLM Markdown

# NLP 文本语义相似度检测

> 来源页面: https://www.gugudata.com/api/details/nlpsimilarity

## 概览

- API 标识: `nlpsimilarity`
- 分类: 文本/NLP
- 描述: 比较两段文本，返回相似度参考分数
- 标签: 文本比较 / 相似度参考
- 短标签: 文本比较
- 详情页: https://www.gugudata.com/api/details/nlpsimilarity
- LLM Markdown: https://www.gugudata.com/api/details/nlpsimilarity/llm.md
- 数据预览: https://www.gugudata.com/preview/nlpsimilarity
- 购买开通: https://www.gugudata.com/order/nlpsimilarity
- APP KEY 管理: https://www.gugudata.com/portal/
- 订单与续费: https://www.gugudata.com/portal/orders

## 给大模型的接入指令

如果你正在帮助用户接入这个 API，请优先使用本文档中的接口地址、请求方式、请求参数、返回参数、状态码、cURL 示例和预览数据生成代码或排查问题。

- 接入目标: 调用 `NLP 文本语义相似度检测`，不要臆造未在文档中出现的参数或返回字段。
- AppKey 获取: 用户登录咕咕数据开发者中心后，在 `APP KEY 管理` 页面复制对应产品的 AppKey。
- AppKey 替换: 示例中的 `YOUR_APPKEY`、`APPKEY`、`{{YOUR_APPKEY}}`、`{{appkey}}`、`{{appKey}}` 都应替换为用户自己的 AppKey。
- AppKey 传递: 推荐使用 `X-GUGUDATA-APPKEY` 或 `X-API-Key` 请求头；OpenAI 兼容客户端可使用 `Authorization: Bearer <AppKey>`；历史 query 参数 `appkey` 继续有效。
- 开通与续费: 未开通时引导用户访问购买开通页；已开通或需要续费时，引导用户进入开发者中心或订单与续费页。
- 错误处理: HTTP 状态码代表传输层结果，响应体内的业务状态码代表接口业务结果，代码中应分别处理。
- 生产建议: AppKey 应保存在服务端环境变量或密钥配置中，由服务端统一发起请求，不要写入网页、App 客户端或公开仓库。

关键链接:

- 接口详情页: https://www.gugudata.com/api/details/nlpsimilarity
- LLM Markdown: https://www.gugudata.com/api/details/nlpsimilarity/llm.md
- 数据预览: https://www.gugudata.com/preview/nlpsimilarity
- 购买开通页: https://www.gugudata.com/order/nlpsimilarity
- 开发者中心 APP KEY 管理: https://www.gugudata.com/portal/
- 订单与续费: https://www.gugudata.com/portal/orders

## API 功能

- 比较一对文本，返回 0–1 范围内的相似度参考值；
- 单对结果保留两位小数字符串，便于现有业务读取；
- 兼容 [文本一|文本二] 的历史成对输入表达；
- 一次可比较最多 10 对文本，结果顺序与输入对应；
- 批量结果以字符串数组独立返回每对参考分数；
- 支持经过样例验证的中文文本对；
- 支持经过样例验证的英文文本对；
- 支持文档表单和历史 JSON 请求；
- 可辅助比较内容草稿的相似程度；
- 可为用户反馈或客服问句建立相似度参考；
- 可将参考分数用于人工复核队列排序，不替代事实或等价性判断；
- 默认最大 QPS:5，可在开发者中心自助升级，月付年付订单接口调用次数不限。
- [接口调用状态与状态监控](https://www.gugudata.com/status)

## API 文档

- 接口地址: `https://api.gugudata.com/text/similarity`
- 返回格式: `application/json; charset=utf-8`
- 请求方式: `POST`
- 请求协议: `HTTPS`
- 请求示例: `https://api.gugudata.com/text/similarity?appkey=YOUR_APPKEY`
- 接口测试: https://api.gugudata.com/text/similarity/demo
- Apifox: https://doc.gugudata.com/
- Postman: https://www.postman.com/gugudata/gugudata-official
- OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

## 鉴权方式

接口支持以下 AppKey 传递方式，任选一种即可；已有请求示例、Postman 集合和历史代码仍可继续使用原来的 `appkey` 参数方式。

| 传输载体 | 参数 | 示例 | 说明 |
| --- | --- | --- | --- |
| HTTP Header | `X-GUGUDATA-APPKEY` | `X-GUGUDATA-APPKEY: YOUR_APPKEY` | 推荐方式，适合服务端接入和统一封装。 |
| HTTP Header | `X-API-Key` | `X-API-Key: YOUR_APPKEY` | 通用 API Key Header，便于和常见 API 客户端集成。 |
| HTTP Header | `Authorization` | `Authorization: Bearer YOUR_APPKEY` | 适合 OpenAI 兼容接口或 Bearer Token 风格客户端。 |
| Query 参数 | `appkey` | `?appkey=YOUR_APPKEY` | 兼容现有示例、Postman 集合、浏览器调试和历史代码。 |

> 部分历史 POST 接口仍兼容表单或 JSON body 中的 `appkey`；新接入建议优先使用 Header 或 Query 参数。

## 请求参数

| 参数名 | 参数类型 | 是否必须 | 默认值 | 备注 |
| --- | --- | --- | --- | --- |
| appkey | string | 是 | 无 | 付费后获取的 APPKEY |
| content1 | string | 是 | 无 | 非空白文本；历史批量使用 [a\|b]，两侧数量一致、最多 10 对。 |
| content2 | string | 是 | 无 | 非空白文本；历史批量使用 [a\|b]，两侧数量一致、最多 10 对。 |

## 返回参数

| 参数名 | 参数类型 | 备注 |
| --- | --- | --- |
| DataStatus.RequestParameter | string | 真实可读的业务参数，不包含凭据。 |
| DataStatus.StatusCode | integer | 成功 100；参数和依赖错误按下列错误说明判断。 |
| DataStatus.StatusDescription | string | 业务状态说明。 |
| DataStatus.ResponseDateTime | string | 接口响应时间。 |
| DataStatus.DataTotalCount | integer | 当前条件下总数；单对结果为 1，批量为实际对数。 |
| Data | string\|array(string) | 单对为两位小数字符串；历史批量为同序字符串数组。 |

## 响应示例（真实数据节选）

```json
{
  
  "DataStatus":  {
    
    "RequestParameter":  "{\"content1\":\"文本相似度旨在识别两段文本在语义上是否相似\",\"content2\":\"文本相似度可以检查两个文本的语义上的相似程度\"}",
    
    "StatusCode":  100,
    
    "StatusDescription":  "请求成功。",
    
    "ResponseDateTime":  "2026-10-26 11:06:59.151",
    
    "DataTotalCount":  1
  
  },
  
  "Data":  "0.92"

}
```

## 接口常见 HTTP 响应状态码

> 以下为接口调用中常见的 HTTP 传输层状态码，不等同于响应体内的业务状态码；完整状态码注册表以 IANA HTTP Status Code Registry 为准。

| 状态码 | 状态码解释 | 备注 |
| --- | --- | --- |
| 200 | 请求成功 | HTTP 请求已成功处理；业务状态请结合响应体中的自定义业务码判断。 |
| 201 | 资源已创建 | 创建类接口请求成功，并已生成对应资源。 |
| 202 | 请求已接受 | 请求已被接受处理，结果可能异步完成。 |
| 204 | 无响应内容 | 请求成功但响应体为空，适用于无需返回数据的操作。 |
| 400 | 请求参数错误 | 请求参数缺失、格式错误或参数组合不合法。 |
| 401 | 认证失败 | 缺少、无效或未通过认证的访问凭证（如 AppKey）。 |
| 403 | 无权限访问 | 订单到期、权限不足或接口额度不可用。 |
| 404 | 资源不存在 | 请求路径不存在。 |
| 405 | 请求方法不允许 | 当前路径不支持该 HTTP 方法。 |
| 408 | 请求超时 | 客户端请求在服务端等待时间内未完成，可稍后重试。 |
| 409 | 请求冲突 | 请求与当前资源状态冲突，调整参数或业务状态后重试。 |
| 413 | 请求内容过大 | 上传文件或请求体超过接口限制。 |
| 414 | 请求地址过长 | 请求 URL 超过服务端可处理长度，建议减少查询参数或改用 POST。 |
| 415 | 请求内容类型不支持 | 上传或请求体的内容类型不符合接口要求。 |
| 422 | 请求语义错误 | 请求格式正确，但参数取值、语义或业务约束无法处理。 |
| 429 | 请求频率受限 | 默认按来源 IP 限速，单 IP 最多 5 QPS，可满足常规业务调用。超出限制时接口会返回 429 请求频率受限；已购买接口订单可加购 10 QPS 扩展。 |
| 431 | 请求头过大 | 请求头字段过大或过多，建议精简 Header 后重试。 |
| 500 | 服务器内部错误 | 服务端处理异常，请稍后重试。 |
| 502 | 服务暂时不可用 | 请稍后重试。 |
| 503 | 服务暂时不可用 | 请稍后重试。 |
| 504 | 请求超时 | 请稍后重试。 |

## 接口自定义业务状态码

| 业务状态码 | 业务状态码解释 | 备注 |
| --- | --- | --- |
| 100 | 成功 | HTTP 200 |
| 501 | 参数错误 | HTTP 400 |
| 901 | 处理、依赖失败或超时 | HTTP 503 |
| 502 | 请求频率限制 | HTTP 429 |
| 503 | 权益过期 | HTTP 403 |
| 504 | 凭据缺失或无效、无商品权限、鉴权服务不可用；结合状态判断 | HTTP 401/403/503 |
| 505 | 调用额度不足 | HTTP 403 |

## cURL 请求示例

```bash
curl --location --request POST 'https://api.gugudata.com/text/similarity?appkey=YOUR_APPKEY' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'content1=咕咕数据提供数据接口。' \
--data-urlencode 'content2=开发者可以使用咕咕数据的数据接口。'
```

## 常见问题 Q&A

### Q: 如何完成第一次 API 调用？
A: 先确认当前接口的请求方法、必填参数和成功状态，再使用对应产品的 AppKey 发起请求；以实际响应中的业务状态判断结果。 [查看接入指南](https://www.gugudata.com/developers/getting-started)

### Q: 如何保证请求时 AppKey 的安全性？
A: 在开发者中心的 APP KEY 管理页面复制对应产品的 AppKey，并保存在服务端环境变量或密钥管理服务中。不要写入网页、App 客户端、公开仓库或日志。

### Q: 接口可以用于哪些开发语言？
A: Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等支持 HTTP 请求的语言均可接入；也可以通过 OpenAPI、Postman 或 Apifox 查看和调试接口。

### Q: 请求失败或超时后可以重试吗？
A: 先区分 HTTP 状态与业务错误。参数、鉴权和权限错误应修正后再请求；超时并不表示服务端未执行，重试前需确认接口是否会重复计费或产生副作用。 [查看接入指南](https://www.gugudata.com/developers/errors-and-retries)

### Q: 接口的性能可以保证吗？
A: 实际响应时间受接口类型、参数和网络环境影响。请按当前套餐的 QPS 控制并发，生产接入前完成联调与容量评估。

## 服务协议以及服务免责声明

- [服务协议](https://www.gugudata.com/license)
- [服务免责声明](https://www.gugudata.com/disclaimer)

## 技术支持

- 技术支持邮箱: support@gugudata.com
- 微信客服: https://work.weixin.qq.com/kfid/kfcf9a60a6afe3337b7