文本相似度（基础版）

功能介绍

对文本进行语义相似度计算。

具体Endpoint请参见终端节点。

调用华为云NLP服务会产生费用，本API支持使用基础套餐包，购买时请在自然语言处理价格计算器中查看基础套餐包和领域套餐包支持的API范围。

也可使用文本相似度（高级版）接口，详情请见文本相似度（高级版）。文本相似度基础版和高级版基于不同算法实现，对相同文本，基础版和高级版的结果有所差别。根据测试数据，高级版效果一般优于基础版。

本API调用限制为20次/秒。

调试

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

前提条件

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

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

URI

• URI格式

  POST /v1/{project_id}/nlp-fundamental/text-similarity

• 参数说明

  表1 URI参数说明

  参数名	必选	说明
  project_id	是	项目ID。获取方法请参见获取项目ID。

请求消息

请求参数如表2所示。

响应消息

响应参数如表3所示。

请求示例

• 请求示例（计算文本语义相似度）

  POST https://{endpoint}/v1/{project_id}/nlp-fundamental/text-similarity
  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'  # 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");
              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.73369961
    
  }

• 失败响应示例

  {
      "error_code": "NLP.0301",
      "error_msg": "argument valid error:text2.text2 for text similarity should be between 1 to 512 ;text2.must not be blank;"
  }

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。