com.sinovoice.hcicloudsdk.api.kb

类 HciCloudKb

java.lang.Object

com.sinovoice.hcicloudsdk.api.kb.HciCloudKb

public class HciCloudKb
extends java.lang.Object

灵云KB能力API

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	HCI_KB_FILE_FLAG_ANDROID_SO android_so: 库文件的特性。
static java.lang.String	HCI_KB_FILE_FLAG_NONE 默认的库文件特性
static java.lang.String	KB_CONFIG_RECOG_CONV_MODE convmode
static java.lang.String	KB_CONFIG_RECOG_FAULT_TOLERANT_LEVEL faultTolerantLevel
static java.lang.String	KB_CONFIG_RECOG_INPUT_MODE inputmode
static java.lang.String	KB_CONFIG_RECOG_INPUT_TYPE inputtype
static java.lang.String	KB_CONFIG_RECOG_INPUT_TYPE_PRESS press
static java.lang.String	KB_CONFIG_RECOG_INPUT_TYPE_SLIDE slide
static java.lang.String	KB_CONFIG_RECOG_KEY_BOARD keyboard
static java.lang.String	KB_CONFIG_RECOG_PAGE_COUNT pagecount
static java.lang.String	KB_PROPERTY_RECOG_ENTRY_MODE entrymode
static java.lang.String	KB_PROPERTY_RECOG_LANG lang

构造器概要

构造器

构造器和说明
HciCloudKb()

方法概要

限定符和类型	方法和说明
static int	hciKbConfirm(Session session, java.lang.String confirmResult) 提交识别结果接口
static int	hciKbConv(Session session, java.lang.String strConfig, java.lang.String strSrc, KbConvResult convResult) 键盘转码函数
static int	hciKbFuzzySyllable(Session session, KbFuzzySyllable[] fuzzySyllableList) 音节模糊函数,该接口只能在中文拼音输入时有效(仅对当前session有效)
static int	hciKbInit(java.lang.String initparam) 灵云KB能力 初始化
static int	hciKbRecog(Session session, java.lang.String recogConfig, KbQueryInfo queryInfo, KbRecogResult recogResult) 键盘识别接口
static int	hciKbRelease() 灵云KB能力 反初始化
static int	hciKbSessionStart(java.lang.String sessionConfig, Session outSession) 开始会话
static int	hciKbSessionStop(Session session)
static int	hciKbUdbCommit(Session session, java.lang.String strConfig, KbUdbItemInfo udbItemInfo) 添加用户自定义词典
static int	hciKbUdbDelete(Session session, java.lang.String strConfig, KbUdbItemInfo udbItemInfo) 删除用户自定义词典
static int	hciKbUdbIterate(Session session, KbUdbIterateCallback callback)

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

KB_CONFIG_RECOG_INPUT_MODE

public static final java.lang.String KB_CONFIG_RECOG_INPUT_MODE

inputmode

另请参阅:

常量字段值

KB_CONFIG_RECOG_KEY_BOARD

public static final java.lang.String KB_CONFIG_RECOG_KEY_BOARD

keyboard

另请参阅:

常量字段值

KB_CONFIG_RECOG_FAULT_TOLERANT_LEVEL

public static final java.lang.String KB_CONFIG_RECOG_FAULT_TOLERANT_LEVEL

faultTolerantLevel

另请参阅:

常量字段值

KB_CONFIG_RECOG_PAGE_COUNT

public static final java.lang.String KB_CONFIG_RECOG_PAGE_COUNT

pagecount

另请参阅:

常量字段值

KB_CONFIG_RECOG_INPUT_TYPE

public static final java.lang.String KB_CONFIG_RECOG_INPUT_TYPE

inputtype

另请参阅:

常量字段值

KB_CONFIG_RECOG_INPUT_TYPE_PRESS

public static final java.lang.String KB_CONFIG_RECOG_INPUT_TYPE_PRESS

press

另请参阅:

常量字段值

KB_CONFIG_RECOG_INPUT_TYPE_SLIDE

public static final java.lang.String KB_CONFIG_RECOG_INPUT_TYPE_SLIDE

slide

另请参阅:

常量字段值

KB_CONFIG_RECOG_CONV_MODE

public static final java.lang.String KB_CONFIG_RECOG_CONV_MODE

convmode

另请参阅:

常量字段值

KB_PROPERTY_RECOG_ENTRY_MODE

public static final java.lang.String KB_PROPERTY_RECOG_ENTRY_MODE

entrymode

另请参阅:

常量字段值

KB_PROPERTY_RECOG_LANG

public static final java.lang.String KB_PROPERTY_RECOG_LANG

lang

另请参阅:

常量字段值

HCI_KB_FILE_FLAG_ANDROID_SO

public static final java.lang.String HCI_KB_FILE_FLAG_ANDROID_SO

android_so: 库文件的特性。
将“fileFlag”配置为该参数后，可以将库文件加上lib前缀和.so后缀放入libs/armeabi路径下， 采用“/data/data/” + context.getPackageName + “/lib”作为初始化路径。

另请参阅:

常量字段值

HCI_KB_FILE_FLAG_NONE

public static final java.lang.String HCI_KB_FILE_FLAG_NONE

默认的库文件特性

另请参阅:

常量字段值

构造器详细资料

HciCloudKb

public HciCloudKb()

方法详细资料

hciKbInit

public static final int hciKbInit(java.lang.String initparam)

灵云KB能力 初始化

参数:

initparam - 初始化配置串，可以通过KbInitParam类辅助生成

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_SYS_NOT_INIT	HCI SYS 尚未初始化
HCI_ERR_KB_ALREADY_INIT	已经初始化过了
HCI_ERR_CONFIG_INVALID	配置参数有误，如设定值非法、或格式错误等
HCI_ERR_CONFIG_DATAPATH_MISSING	缺少必需的dataPath配置项
HCI_ERR_CONFIG_CAPKEY_NOT_MATCH	CAPKEY与当前引擎不匹配
HCI_ERR_CAPKEY_NOT_FOUND	没有找到指定的能力
HCI_ERR_LOAD_FUNCTION_FROM_DLL	加载库函数失败
HCI_ERR_LOCAL_LIB_MISSING	本地能力引擎缺失必要的库资源

hciKbSessionStart

public static final int hciKbSessionStart(java.lang.String sessionConfig,
                                          Session outSession)

开始会话

参数:

sessionConfig - 会话配置串，可以通过KbConfig类辅助生成

outSession - 引擎分配的会话

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_CONFIG_INVALID	配置项不合法
HCI_ERR_TOO_MANY_SESSION	创建的Session数量超出限制(256)
HCI_ERR_CONFIG_CAPKEY_MISSING	缺少必需的capKey配置项
HCI_ERR_URL_MISSING	找不到对应的网络服务地址（HCI能力服务地址)
HCI_ERR_CONFIG_CAPKEY_NOT_MATCH	CAPKEY与当前引擎不匹配
HCI_ERR_CAPKEY_NOT_FOUND	没有找到指定的能力
HCI_ERR_LOAD_FUNCTION_FROM_DLL	加载库函数失败
HCI_ERR_KB_ENGINE_SESSION_START_FAILED	引擎开启会话失败
HCI_ERR_CONFIG_DATAPATH_MISSING	缺少必需的dataPath配置项

hciKbFuzzySyllable

public static final int hciKbFuzzySyllable(Session session,
                                           KbFuzzySyllable[] fuzzySyllableList)

音节模糊函数,该接口只能在中文拼音输入时有效(仅对当前session有效)

参数:

session - 会话

fuzzySyllableList - 要模糊的音节列表

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_UNSUPPORT	暂不支持
HCI_ERR_KB_ENGINE_FAILED	引擎错误
HCI_ERR_KB_SYLLABLE_INVALID	容错音节无法判断类型

hciKbRecog

public static final int hciKbRecog(Session session,
                                   java.lang.String recogConfig,
                                   KbQueryInfo queryInfo,
                                   KbRecogResult recogResult)

键盘识别接口

参数:

session - 会话

recogConfig - 识别配置信息

queryInfo - 识别键盘输入结构体，传入NULL标识获取下一页

recogResult - 识别结果结构体

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_CONFIG_INVALID	配置项不合法
HCI_ERR_CONFIG_UNSUPPORT	配置项不支持
HCI_ERR_KB_ENGINE_FAILED	引擎错误

hciKbConfirm

public static final int hciKbConfirm(Session session,
                                     java.lang.String confirmResult)

提交识别结果接口

参数:

session - 会话

confirmResult - 要提交的确认结果

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_KB_CONFIRM_NO_TASK	使用confirm，但没有确认任务

hciKbUdbIterate

public static final int hciKbUdbIterate(Session session,
                                        KbUdbIterateCallback callback)

参数:

session - 会话

confirmResult - 要提交的确认结果

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_KB_ENGINE_FAILED	引擎错误
HCI_ERR_UNSUPPORT	暂不支持

hciKbUdbCommit

public static final int hciKbUdbCommit(Session session,
                                       java.lang.String strConfig,
                                       KbUdbItemInfo udbItemInfo)

添加用户自定义词典

参数:

session - 会话

strConfig - 识别配置信息

udbItemInfo - 用户自定义词条结构体

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_CONFIG_INVALID	配置项不合法
HCI_ERR_KB_ENGINE_FAILED	引擎错误
HCI_ERR_KB_UDB_WORD_EXIST	已经在用户词库中存在
HCI_ERR_CONFIG_UNSUPPORT	配置项不支持
HCI_ERR_UNSUPPORT	暂不支持

hciKbUdbDelete

public static final int hciKbUdbDelete(Session session,
                                       java.lang.String strConfig,
                                       KbUdbItemInfo udbItemInfo)

删除用户自定义词典

参数:

session - 会话

strConfig - 识别配置信息

udbItemInfo - 用户自定义词条结构体

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_CONFIG_INVALID	配置项不合法
HCI_ERR_KB_ENGINE_FAILED	引擎错误
HCI_ERR_CONFIG_UNSUPPORT	配置项不支持
HCI_ERR_UNSUPPORT	暂不支持

hciKbConv

public static final int hciKbConv(Session session,
                                  java.lang.String strConfig,
                                  java.lang.String strSrc,
                                  KbConvResult convResult)

键盘转码函数

参数:

session - 会话

strConfig - 识别配置信息

strSrc - 需要转化的字符，中文韩文只支持一个字符，超过部分自动忽略

convResult - 转化后的键盘输入序列

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_PARAM_INVALID	输入参数不合法
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_SESSION_INVALID	传入的Session非法
HCI_ERR_CONFIG_INVALID	配置项不合法
HCI_ERR_CONFIG_UNSUPPORT	配置项不支持
HCI_ERR_KB_ENGINE_FAILED	引擎错误
HCI_ERR_UNSUPPORT	暂不支持

hciKbSessionStop

public static final int hciKbSessionStop(Session session)

参数:

session - 会话

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_SESSION_INVALID	传入的Session非法

hciKbRelease

public static final int hciKbRelease()

灵云KB能力 反初始化

返回:

HCI_ERR_NONE	操作成功
HCI_ERR_KB_NOT_INIT	HCI KB尚未初始化
HCI_ERR_ACTIVE_SESSION_EXIST	尚有未stop的Sesssion，无法结束