文本相似度

最近更新时间:2019-07-12 11:20:58

1. 接口描述

接口请求域名: nlp.tencentcloudapi.com 。

文本相似度接口能够基于深度学习技术来计算两个输入文本的相似度,相似度数值越大的两个文本在语义上越相似。目前仅支持短文本的相似度计算,长文本的相似度计算也即将推出。

鉴于文本相似度是一个应用非常广泛的功能,腾讯知文自然语言处理团队在深度神经网络模型的基础上,专门针对文本相似任务进行了优化,并持续迭代更新。基于文本相似度,可以轻松实现诸如文本去重、相似推荐等功能。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SentenceSimilarity
Version String 公共参数,本接口取值:2019-04-08
Region String 公共参数,详见产品支持的 地域列表
SrcText String 计算相似度的源句子(仅支持UTF-8格式,不超过500字)
TargetText String 计算相似度的目标句子(仅支持UTF-8格式,不超过500字)

3. 输出参数

参数名称 类型 描述
Similarity Float 两个文本的相似度
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 句相似度示例

输入示例

https://nlp.tencentcloudapi.com/?Action=SentenceSimilarity
&SrcText="自然语言处理(英语:Natural Language Processing,缩写作 NLP)是人工智能和语言学领域的分支学科。"
&TargetText="自然语言处理是计算机科学领域与人工智能领域中的一个重要方向。"
&<公共请求参数>

输出示例

{
  "Response": {
    "Similarity": 0.8319392423634003,
    "RequestId": "8dd99adb-5144-43ca-8213-f6a929ce5075"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.TextEmbeddingFailed 文本向量化失败
InvalidParameterValue.EmptyValueError 参数空值错误
InvalidParameterValue.TextEncodeError 文本编码错误,不符合utf-8
InvalidParameterValue.TextTooLong 输入文本超出长度限制
ResourceInsufficient.QuotaRunOut 额度用尽,请充值后重试