更新时间:2024-01-17 GMT+08:00
分享

文本相似度(高级版)

功能介绍

对文本语义相似度计算。

具体Endpoint请参见终端节点

本API免费调用,调用限制为2次/秒。

文本相似度基础版和高级版基于不同算法实现,对相同文本,基础版和高级版的结果有所差别。根据测试数据,高级版效果一般优于基础版。

调试

您可以在API Explorer中调试该接口。

前提条件

在使用本API之前,需要您完成服务申请和认证鉴权,具体操作流程请参见申请服务认证鉴权章节。

用户首次使用需要先申请开通。服务只需要开通一次即可,后面使用时无需再次申请。如未开通服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注意开通服务区域与调用服务的区域保持一致。

URI

  • URI格式
    POST /v1/{project_id}/nlp-fundamental/text-similarity/advance
  • 参数说明
    表1 URI参数说明

    参数名

    必选

    说明

    project_id

    项目ID。获取方法请参见获取项目ID

请求消息

请求参数如表2所示。

表2 请求参数

参数名

参数类型

必选

说明

text1

String

待计算文本1,长度1~64,文本编码为UTF-8。

text2

String

待计算文本2,长度1~64,文本编码为UTF-8。

lang

String

支持的文本语言类型,目前只支持中文(zh),默认为中文。

响应消息

响应参数如表3所示。

表3 响应参数

参数名

参数类型

说明

similarity

Float

相似度得分,范围在0~1,默认小数点后保留8位。

error_code

String

调用失败时的错误码,具体参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

  • 请求示例(计算文本语义相似度)
    POST https://{endpoint}/v1/{project_id}/nlp-fundamental/text-similarity/advance
    
    Request Header:
        Content-Type: application/json
        X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    
    Request Body:
        {
            "text1":"杭州有啥好玩的",
            "text2":"杭州哪里好玩",
            "lang":"zh"
        }
  • Python3语言请求代码示例(计算文本语义相似度)
    # -*- coding: utf-8 -*-
    # 此demo仅供测试使用,建议使用sdk。需提前安装requests,执行pip install requests
    import requests
    import json
    
    def nlp_demo():
        url = 'https://{endpoint}/v1/{project_id}/nlp-fundamental/text-similarity/advance'  # endpoint和project_id需替换
        token = '用户对应region的token'
        header = {
            'Content-Type': 'application/json',
            'X-Auth-Token': token
        }
        body = {
            'text1': '订单记录怎么删除',
            'text2': '如何删除浏览记录',
            'lang': 'zh'
        }
        resp = requests.post(url, data=json.dumps(body), headers=header)
        print(resp.json())
    
    if __name__ == '__main__':
        nlp_demo()
  • Java语言请求代码示例(计算文本语义相似度)
    import java.io.BufferedReader;
    import java.io.InputStream;
    import java.io.InputStreamReader;
    import java.io.OutputStreamWriter;
    import java.net.HttpURLConnection;
    import java.net.URL;
    
    /**
     * 此demo仅供测试使用,建议使用sdk
     */
    public class NLPDemo {
        public void nlpDemo() {
            try {
                //endpoint和projectId需要替换成实际信息。
                URL url = new URL("https://{endpoint}/v1/{project_id}/nlp-fundamental/text-similarity/advance");
                String token = "对应region的token";
                HttpURLConnection connection = (HttpURLConnection) url.openConnection();
                connection.setRequestMethod("POST");
                connection.setDoInput(true);
                connection.setDoOutput(true);
                connection.addRequestProperty("Content-Type", "application/json");
                connection.addRequestProperty("X-Auth-Token", token);
    
                //输入参数
                String text1 = "订单记录怎么删除";
                String text2 = "如何删除浏览记录";
                String lang = "zh";
                String body = "{\"text1\":\"" + text1 + "\",\"text2\":\"" + text2 + "\",\"lang\":\"" + lang + "\"}";
    
                OutputStreamWriter osw = new OutputStreamWriter(connection.getOutputStream(), "UTF-8");
                osw.append(body);
                osw.flush();
                InputStream is = connection.getInputStream();
                BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
                while (br.ready()) {
                    System.out.println(br.readLine());
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    
        public static void main(String[] args) {
            NLPDemo nlpDemo = new NLPDemo();
            nlpDemo.nlpDemo();
        }
    }

响应示例

  • 成功响应示例
    {
      "similarity":0.93171031
    }
  • 失败响应示例
    {
        "error_code": "NLP.0301",
        "error_msg": "text1 must not be null. text2 must not be null"
    }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

相关文档