APIUSB / OpenAPI / 分词接口

分词接口

接口描述: NLP分词,可进行中文分词。

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
text字符串必须我爱你中国待进行中文分词的文本

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.words数组分词结果
data.words[].word数组词本身
data.words[].start数组该词在原文本路的起始位置
data.words[].end数组该词在原文本路的结束位置
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
text 必须

客户端请求示例

{
    "ret": 200,
    "data": {
        "words": [
            {
                "word": "我爱你",
                "start": 0,
                "end": 3
            },
            {
                "word": "中国",
                "start": 3,
                "end": 5
            }
        ]
    },
    "msg": "",
    "debug": {
        "stack": [
            "[#1 - 0ms - PHALAPI_INIT]D:\\wamp64\\www\\api\\public\\api\\app.php(47)",
            "[#2 - 1.8ms - PHALAPI_RESPONSE]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(46)",
            "[#3 - 2349.7ms - PHALAPI_FINISH]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(74)"
        ],
        "sqls": [],
        "version": "2.15.0"
    }
}
curl https://api.apiusb.com/api/app?s=App.Language.GetChineseWords&text=我爱你中国
{
    "ret": 200,
    "data": {
        "words": [
            {
                "word": "我爱你",
                "start": 0,
                "end": 3
            },
            {
                "word": "中国",
                "start": 3,
                "end": 5
            }
        ]
    },
    "msg": "",
    "debug": {
        "stack": [
            "[#1 - 0ms - PHALAPI_INIT]D:\\wamp64\\www\\api\\public\\api\\app.php(47)",
            "[#2 - 1.8ms - PHALAPI_RESPONSE]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(46)",
            "[#3 - 2349.7ms - PHALAPI_FINISH]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(74)"
        ],
        "sqls": [],
        "version": "2.15.0"
    }
}

$.ajax({
    url: "https://api.apiusb.com/api/app",
    data: {s: "App.Language.GetChineseWords", text: "我爱你中国"},
    dataType: 'json',
    success: function (response, status, xhr) {
        console.log(response);
    }
});
<?php
require_once dirname(__FILE__) . '/PhalApiClient.php';

$client = PhalApiClient::create()
    ->withHost('https://api.apiusb.com/api/app');$rs = $client->reset()
->withService('App.Language.GetChineseWords')
->withParams('text', '我爱你中国')
->withTimeout(3000)
->request();

// ret状态码,200表示成功
var_dump($rs->getRet());
// 业务数据
var_dump($rs->getData());
// 提示信息
var_dump($rs->getMsg());
#-*- coding:utf-8 -*-
import PhalApiClient

result = PhalApiClient.PhalApiClient('https://api.apiusb.com/api/app', 'App.Language.GetChineseWordsx', {'text': '我爱你中国'}, 3)
//FullscreenActivity.java
import net.phalapi.sdk.*;    /**
     * 网络操作相关的子线程
     */  
    Runnable networkTask = new Runnable() {  
      
        @Override  
        public void run() {  
            // TODO  
            // 在这里进行 http request.网络请求相关操作  
            
        	PhalApiClient client = PhalApiClient.create()
	       			    .withHost("https://api.apiusb.com/api/app");
	       	
	       	PhalApiClientResponse response = client
	       			    .withService("App.Language.GetChineseWords")
	       			    .withParams("text", "我爱你中国")
	       			    .withTimeout(3000)
	       			    .request();

	   		String content = "";
	   		content += "ret=" + response.getRet() + "\n";
	   		if (response.getRet() == 200) {
				try {
					JSONObject data = new JSONObject(response.getData());
					content += "data.title=" + data.getString("title") + "\n";
					content += "data.content=" + data.getString("content") + "\n";
					content += "data.version=" + data.getString("version") + "\n";
				} catch (JSONException ex) {
					  
				}
	   		}
			content += "msg=" + response.getMsg() + "\n";
			
			Log.v("[PhalApiClientResponse]", content);
            
            
            Message msg = new Message();  
            Bundle data = new Bundle();  
            data.putString("value", content);  
            msg.setData(data);  
            handler.sendMessage(msg);  
        }  
    }; 
PhalApiClientResponse response = PhalApiClient.create()
  .withHost("https://api.apiusb.com/api/app")
  .withService("App.Language.GetChineseWords")
  .withparamsList("text", "我爱你中国")
  .withTimeout(3000)
  .request();

Log.v("response ret", response.ret + "");
Log.v("response data", response.data);
Log.v("response msg", response.msg);
#import "AFNPhalApiClient.h"// POST
NSDictionary *params = @{@"text": @"我爱你中国"};

// Call AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"https://api.apiusb.com/api/app"] withService:@"App.Language.GetChineseWords"] withParams:params] requestWithFormDataBlock:^(id formData) {
	//
    [formData appendPartWithFileData:UIImageJPEGRepresentation([UIImage imageNamed:@"head.JPG"], 1) name:@"file" fileName:@"image.jpg" mimeType:@"image/jpeg"];
} completeBlock:^(id resultObject) {
    PALog(@"resultObject: %@", resultObject);
} failureBlock:^(NSError *error) {
    PALog(@"error: %@", error);
}];

// Print url
PALog(@"total url: %@", [[AFNPhalApiClient sharedClient] printTotalUrlStr]);

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2024-10-16 08:33:55