通用參數
入參
字段 | 類型 | 說明 | 默認值 |
serviceId | long | 服務id | 101 |
uq | string | 用戶輸入檢索值 | |
type | string | 檢索類型（全文/分段） | 動態適配 |
queries | List<map<string, object>> | 檢索條件 | [] |
filters | List<map<string, object>> | 過濾條件 | [] |
fields | array | 召回字段（正排） | [] |
sort | array | 排序字段 | [] |
page | int | 分頁（頁碼） | 1 |
rows | int | 分頁（行數） | 10 |
rankModelInfo | map<string, object> | 算法干預配置（專用） | {} |
customConfigInfo | map<string, object> | 自定義干預配置 | {} |
minScore | double | 最小相關性分數召回過濾 | |
debug | boolean | 調試信息 | 0 |
出參
字段 | 類型 | 說明 | 默認值 |
requestId | string | 請求id | xxxx |
status | int | 請求結果狀態 | 0 |
message | string | 響應信息 | |
data.total | int | 檢索總數 | 0 |
data.docs | array(map/dict/json) | 檢索結果 | [] |
debug | map<string, object> | 調試信息 |
HTTP調用
鑒權token獲取
鑒權的TOKEN可通過POP SDK中的 PostMSConvSearchTokenGenerated接口獲取 在獲取的token值前加上"Bearer "頭封裝到Authorization的header中。
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>alinlp20200629</artifactId>
<version>2.7.2</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>4.6.0</version>
</dependency> public static void main(String[] args) throws Exception {
Config config = new Config();
config.setEndpoint("alinlp.cn-beijing.aliyuncs.com");
config.setAccessKeyId("xxxx");
config.setAccessKeySecret("xxxx");
Client client = new Client(config);
PostMSConvSearchTokenGeneratedResponse response = client.postMSConvSearchTokenGenerated();
System.out.println(JacksonUtils.toJson(response));
}{
"body" : {
"code" : 200,
"data" : "OQ25BJFGnMhUJ8NWpATLfcf2VW820vzGbXP5Us/qGdtwn338qSOLwkzyCnbmBD+t7AboAuvYzp5pujlKXfy90KSAnQVVVb/v15w7K+BkozM=",
"httpStatusCode" : 200,
"requestId" : "184B7122-B9EF-14BC-B974-7D013A601FE8",
"success" : true
},
"headers" : {
"access-control-allow-origin" : "*",
"access-control-expose-headers" : "*",
"connection" : "keep-alive",
"content-length" : "217",
"content-type" : "application/json;charset=utf-8",
"date" : "Tue, 02 Jan 2024 07:32:08 GMT",
"etag" : "2khQ+DZUrns9GU5hL39GwUQ7",
"keep-alive" : "timeout=25",
"x-acs-request-id" : "184B7122-B9EF-14BC-B974-7D013A601FE8",
"x-acs-trace-id" : "ec5e93d7765a4df394f82da31c6a729e"
},
"statusCode" : 200
}HTTP請求
請求入參
字段 | 類型 | 說明 | 默認值 |
headers | map/dict/json | 請求頭信息 | {} |
Authorization | string | 鑒權信息 | Bearer toY1FWrNAjvWkOmp24+UQFIi2PsYzbhNBq+yJmzumNmXw3sro3oOt9Kde5kzLcc4 |
訪問域名
https://nlp.aliyuncs.com
URL
https://nlp.aliyuncs.com/msearch/api/searchEnhance
curl -i -X POST \
-H "Content-Type:application/json" \
-H "Authorization:Bearer OQ25BJFGnMhUJ8NWpATLfcf2VW820vzGbXP5Us/qGdtwn338qSOLwkzyCnbmBD+t7AboAuvYzp5pujlKXfy90KSAnQVVVb/v15w7K+BkozM=" \
-d \
'{
"uq": "ECS管理控制臺：具有交互式操作的Web服務頁面",
"type": "title,content,keywords",
"serviceId":23,
"page": 1,
"rows": 5
}' \
'https://nlp.aliyuncs.com/msearch/api/searchEnhance'{
"requestId": null,
"data": {
"total": 3,
"docs": [
{
"_rc_score": 19.05915,
"keywords": "",
"b_id": "25367",
"gmt_modified_origin": "2022-09-26 18:26:12",
"_q_score": 1.0,
"id": 0,
"_id": "0",
"title": "什么是云服務器ECS",
"_score": 19.05915,
"content":"云服務器ECS（ElasticComputeService）是阿里云提供的性能卓越、穩定可靠、彈性擴展的IaaS（InfrastructureasaService）級別云計算服務。"
},
{
"_rc_score": 10.70154,
"keywords": "開發指南",
"b_id": "42431",
"gmt_modified_origin": "2023-01-06 11:07:33",
"_q_score": 0.5614909374237571,
"id": 37,
"_id": "37",
"title": "配置加速域名",
"_score": 10.70154,
"content": "媒體處理服務支持分發加速功能，可以對指定網站上的業務實現資源訪問加速。如果您有加速需求，建議您將需要加速的網站作為源站，為其創建加速域名。"
},
{
"_rc_score": 8.819408,
"keywords": "操作指南",
"b_id": "59977",
"gmt_modified_origin": "2023-02-15 09:42:23",
"_q_score": 0.4627387895053032,
"id": 89,
"_id": "89",
"title": "突發性能實例概述",
"_score": 8.819408,
"content": "突發性能實例是一種面向入門級計算場景，應對突發性能需求的經濟型實例規格。本文介紹突發性能實例規格族的特點和應用場景，以及基準性能、CPU積分、性能模式等概念，并列出了具體的實例規格。"
}
]
},
"status": 0,
"debug": null,
"message": null
}SDK調用
Java SDK
Maven依賴
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>alinlp20200629</artifactId>
<version>2.7.2</version>
</dependency>
<!--出現java.lang.NoSuchMethodError: com.aliyun.credentials.Client.getCredential()Lcom/aliyun/credentials/models/CredentialModel;異常則引入-->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>credentials-java</artifactId>
<version>0.3.0</version>
</dependency>Java示例代碼
public static void main(String[] args) throws Exception {
Config config = new Config();
config.setEndpoint("alinlp.cn-beijing.aliyuncs.com");
config.setAccessKeyId("xxxx");
config.setAccessKeySecret("xxxx");
Client client = new Client(config);
PostMSSearchEnhanceRequest postMSSearchEnhanceRequest = new PostMSSearchEnhanceRequest();
postMSSearchEnhanceRequest.setServiceId(1555L);
postMSSearchEnhanceRequest.setUq("阿里云");
postMSSearchEnhanceRequest.setPage(1);
postMSSearchEnhanceRequest.setRows(5);
postMSSearchEnhanceRequest.setFields(Lists.newArrayList("name","title", "content"));
// 運行時參數超時設置，僅對使用了該運行時參數實例的請求有效
RuntimeOptions runtimeOptions = new RuntimeOptions();
runtimeOptions.connectTimeout = 5000;
runtimeOptions.readTimeout = 10000;
PostMSSearchEnhanceResponse response = client.postMSSearchEnhanceWithOptions(postMSSearchEnhanceRequest, runtimeOptions);
System.out.println(JacksonUtils.toJson(response));
}
響應示例：
{
"body" : {
"code" : 200,
"data" : {
"data" : {
"docs" : [
{
"_id" : "3459649677041723584_2",
"_q_score" : 1,
"_rc_score" : 11.952197,
"_score" : 11.952197,
"content" : " ? 本文檔僅作為用戶使用阿里云產品及服務的參考性指引，阿里云以產品及服務的“現狀”、“有缺陷”和“當前功能”的狀態提供本文檔。阿里云在現有技術的基礎上盡最大努力提供相應的介紹及操作指引，但阿里云在此明確聲明對本文檔內容的準確性、完整性、適用性、可靠性等不作任何明示或暗示的保證。任何單位、公司或個人因為下載、使用或信賴本文檔而發生任何差錯或經濟損失的，阿里云不承擔任何法律責任。在任何情況下，阿里云均不對任何間接性、后果性、懲戒性、偶然性、特殊性或刑罰性的損害，包括用戶使用或信賴本文檔而遭受的利潤損失，承擔責任（即使阿里云已被告知該等損失的可能性）。 ? 阿里云網站上所有內容，包括但不限于著作、產品、圖片、檔案、資訊、資料、網站架構、網站畫面的安排、網頁設計，均由阿里云和/或其關聯公司依法擁有其知識產權，包括但不限于商標權、專利權、著作權、商業秘密等。非經阿里云和/或其關聯公司書面同意，任何人不得擅自使用、修改、復制、公開傳播、改變、散布、發行或公開發表阿里云網站、產品程序或內容",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : ""
},
{
"_id" : "3459649677041723584_3",
"_q_score" : 0.98918508454972753,
"_rc_score" : 11.822934999999999,
"_score" : 11.822934999999999,
"content" : "非經阿里云和/或其關聯公司書面同意，任何人不得擅自使用、修改、復制、公開傳播、改變、散布、發行或公開發表阿里云網站、產品程序或內容。此外，未經阿里云事先書面同意，任何人不得為了任何營銷、廣告、促銷或其他目的使用、公布或復制阿里云的名稱（包括但不限于單獨為或以組合形式包含“阿里云”、“Aliyun”、“萬網”等阿里云和/或其關聯公司品牌，上述品牌的附屬標志及圖案或任何類似公司名稱、商號、商標、產品或服務名稱、域名、圖案標示、標志、標識或通過特定描述使第三方能夠識別阿里云和/或其關聯公司）。 ? 如若發現本文檔存在任何錯誤，請與阿里云取得聯系",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : ""
},
{
"_id" : "3459649677041723584_4",
"_q_score" : 0.96916625453880978,
"_rc_score" : 11.583665999999999,
"_score" : 11.583665999999999,
"content" : " 阿里云文字識別OCR 阿里云文字識別OCR/目錄 文檔版本：20230509 3 目錄 法律聲明.................................................................................................................................................................................... 2 目錄 3 前言 4 概述................................................................................................................................................................................................................4",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : ""
},
{
"_id" : "3459649677041723584_73",
"_q_score" : 0.96650933715366305,
"_rc_score" : 11.551909999999999,
"_score" : 11.551909999999999,
"content" : "支持同一文件或圖片內卡證票據混貼檢測、識別，能夠實現在財務票據混貼、個人證照混貼等場景下的自動分類、關鍵有效信息精準識別和結構化提取，極大提升 OCR能力在財務自動化、辦公自動化及各類行業應用中的技術效能。 阿里云文字識別OCR 阿里云文字識別OCR/產品功能 文檔版本：20230509 30 阿里云文字識別OCR 阿里云文字識別OCR/產品規格 文檔版本：20230509 31 3. 產品規格",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : "電子面單識別 ii.混貼票據識別"
},
{
"_id" : "3459649677041723584_42",
"_q_score" : 0.93509536363900292,
"_rc_score" : 11.176444,
"_score" : 11.176444,
"content" : "精準識別銀行開戶許可證中的賬號、核準號、企業名稱、法人姓名以及開戶行等關鍵信息。 阿里云文字識別OCR 阿里云文字識別OCR/產品功能 文檔版本：20230509 15",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : "銀行開戶許可證識別"
}
],
"total" : 108
},
"requestId" : "F861AC34-7F30-15A6-AE92-FD788525036F",
"status" : 0
},
"httpStatusCode" : 200,
"requestId" : "F861AC34-7F30-15A6-AE92-FD788525036F",
"success" : true
},
"headers" : {
"access-control-allow-origin" : "*",
"access-control-expose-headers" : "*",
"connection" : "keep-alive",
"content-type" : "application/json;charset=utf-8",
"date" : "Tue, 02 Jan 2024 07:18:54 GMT",
"keep-alive" : "timeout=25",
"transfer-encoding" : "chunked",
"vary" : "Accept-Encoding",
"x-acs-request-id" : "F861AC34-7F30-15A6-AE92-FD788525036F",
"x-acs-trace-id" : "e6e485a286ccb89ce0008022f62682c9"
},
"statusCode" : 200
}
Python SDK
pip源
pip install alibabacloud_alinlp20200629==2.8.2Python示例代碼
import json
from alibabacloud_alinlp20200629 import client
from alibabacloud_tea_openapi import models as api_models
from alibabacloud_tea_util.models import RuntimeOptions
from alibabacloud_alinlp20200629 import models
import os
def searchEnhance():
config = api_models.Config(access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
region_id="cn-beijing")
nlp_client = client.Client(config)
request = models.PostMSSearchEnhanceRequest()
request.service_id = 1555
request.uq = '阿里云'
request.page = 1
request.rows = 5
runtime_options = RuntimeOptions(connect_timeout=5000, read_timeout=10000)
response = nlp_client.post_mssearch_enhance_with_options(request, runtime_options)
# python2: print(response)
print(json.dumps(response.body.data, ensure_ascii=False))
{
"data" : {
"docs" : [
{
"_id" : "3459649677041723584_2",
"_q_score" : 1,
"_rc_score" : 11.952197,
"_score" : 11.952197,
"chunkId" : "3459649677041723584_2",
"content" : " ? 本文檔僅作為用戶使用阿里云產品及服務的參考性指引，阿里云以產品及服務的“現狀”、“有缺陷”和“當前功能”的狀態提供本文檔。阿里云在現有技術的基礎上盡最大努力提供相應的介紹及操作指引，但阿里云在此明確聲明對本文檔內容的準確性、完整性、適用性、可靠性等不作任何明示或暗示的保證。任何單位、公司或個人因為下載、使用或信賴本文檔而發生任何差錯或經濟損失的，阿里云不承擔任何法律責任。在任何情況下，阿里云均不對任何間接性、后果性、懲戒性、偶然性、特殊性或刑罰性的損害，包括用戶使用或信賴本文檔而遭受的利潤損失，承擔責任（即使阿里云已被告知該等損失的可能性）。 ? 阿里云網站上所有內容，包括但不限于著作、產品、圖片、檔案、資訊、資料、網站架構、網站畫面的安排、網頁設計，均由阿里云和/或其關聯公司依法擁有其知識產權，包括但不限于商標權、專利權、著作權、商業秘密等。非經阿里云和/或其關聯公司書面同意，任何人不得擅自使用、修改、復制、公開傳播、改變、散布、發行或公開發表阿里云網站、產品程序或內容",
"docId" : "3459649677041723584",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : "",
"url" : "oss://msearch-cloud-jilin/ossFile1/createDir/OCR基礎能力產品白皮書V1.91，可對外.pdf"
},
{
"_id" : "3459649677041723584_3",
"_q_score" : 0.98918508454972753,
"_rc_score" : 11.822934999999999,
"_score" : 11.822934999999999,
"chunkId" : "3459649677041723584_3",
"content" : "非經阿里云和/或其關聯公司書面同意，任何人不得擅自使用、修改、復制、公開傳播、改變、散布、發行或公開發表阿里云網站、產品程序或內容。此外，未經阿里云事先書面同意，任何人不得為了任何營銷、廣告、促銷或其他目的使用、公布或復制阿里云的名稱（包括但不限于單獨為或以組合形式包含“阿里云”、“Aliyun”、“萬網”等阿里云和/或其關聯公司品牌，上述品牌的附屬標志及圖案或任何類似公司名稱、商號、商標、產品或服務名稱、域名、圖案標示、標志、標識或通過特定描述使第三方能夠識別阿里云和/或其關聯公司）。 ? 如若發現本文檔存在任何錯誤，請與阿里云取得聯系",
"docId" : "3459649677041723584",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : "",
"url" : "oss://msearch-cloud-jilin/ossFile1/createDir/OCR基礎能力產品白皮書V1.91，可對外.pdf"
},
{
"_id" : "3459649677041723584_4",
"_q_score" : 0.96916625453880978,
"_rc_score" : 11.583665999999999,
"_score" : 11.583665999999999,
"chunkId" : "3459649677041723584_4",
"content" : " 阿里云文字識別OCR 阿里云文字識別OCR/目錄 文檔版本：20230509 3 目錄 法律聲明.................................................................................................................................................................................... 2 目錄 3 前言 4 概述................................................................................................................................................................................................................4",
"docId" : "3459649677041723584",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : "",
"url" : "oss://msearch-cloud-jilin/ossFile1/createDir/OCR基礎能力產品白皮書V1.91，可對外.pdf"
},
{
"_id" : "3459649677041723584_73",
"_q_score" : 0.96650933715366305,
"_rc_score" : 11.551909999999999,
"_score" : 11.551909999999999,
"chunkId" : "3459649677041723584_73",
"content" : "支持同一文件或圖片內卡證票據混貼檢測、識別，能夠實現在財務票據混貼、個人證照混貼等場景下的自動分類、關鍵有效信息精準識別和結構化提取，極大提升 OCR能力在財務自動化、辦公自動化及各類行業應用中的技術效能。 阿里云文字識別OCR 阿里云文字識別OCR/產品功能 文檔版本：20230509 30 阿里云文字識別OCR 阿里云文字識別OCR/產品規格 文檔版本：20230509 31 3. 產品規格",
"docId" : "3459649677041723584",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : "電子面單識別 ii.混貼票據識別",
"url" : "oss://msearch-cloud-jilin/ossFile1/createDir/OCR基礎能力產品白皮書V1.91，可對外.pdf"
},
{
"_id" : "3459649677041723584_42",
"_q_score" : 0.93509536363900292,
"_rc_score" : 11.176444,
"_score" : 11.176444,
"chunkId" : "3459649677041723584_42",
"content" : "精準識別銀行開戶許可證中的賬號、核準號、企業名稱、法人姓名以及開戶行等關鍵信息。 阿里云文字識別OCR 阿里云文字識別OCR/產品功能 文檔版本：20230509 15",
"docId" : "3459649677041723584",
"name" : "OCR基礎能力產品白皮書V1.91，可對外.pdf",
"title" : "銀行開戶許可證識別",
"url" : "oss://msearch-cloud-jilin/ossFile1/createDir/OCR基礎能力產品白皮書V1.91，可對外.pdf"
}
],
"total" : 108
},
"requestId" : "891CB7AB-5773-132F-B03D-589A3D2A6C7E",
"status" : 0
}文檔內容是否對您有幫助？