cn.xfyun.api

类 LfasrClient

java.lang.Object

cn.xfyun.api.LfasrClient

public class LfasrClient
extends Object

录音文件转写客户端

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	LfasrClient.Builder

构造器概要

构造器

构造器和说明
LfasrClient(LfasrClient.Builder builder) 通过Builder构建LfasrClient实例

方法概要

限定符和类型	方法和说明
LfasrResponse	getResult(String orderId) 获取结果接口
LfasrResponse	getResult(String orderId, String resultType) 获取结果接口
LfasrResponse	uploadFile(String audioFilePath) 本地音频文件上传接口
LfasrResponse	uploadUrl(String audioUrl) 音频URL上传接口

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

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

构造器详细资料

LfasrClient

public LfasrClient(LfasrClient.Builder builder)

通过Builder构建LfasrClient实例

参数:

builder - 构建器

方法详细资料

uploadFile

public LfasrResponse uploadFile(String audioFilePath)
                         throws LfasrException,
                                SignatureException

本地音频文件上传接口

参数:

audioFilePath - 音频文件路径

返回:

调用成功时返回orderId（转写任务的唯一标识），是后续接口的必传参数。

抛出:

LfasrException - 转写异常

SignatureException - 签名异常

uploadUrl

public LfasrResponse uploadUrl(String audioUrl)
                        throws LfasrException,
                               SignatureException

音频URL上传接口

参数:

audioUrl - 音频链接

返回:

调用成功时返回orderId（转写任务的唯一标识），是后续接口的必传参数。

抛出:

LfasrException - 转写异常

SignatureException - 签名异常

getResult

public LfasrResponse getResult(String orderId)
                        throws SignatureException

获取结果接口

参数:

orderId - 转写订单ID

返回:

转写结果

抛出:

SignatureException - 签名异常

getResult

public LfasrResponse getResult(String orderId,
                               String resultType)
                        throws SignatureException

获取结果接口

参数:

orderId - 转写订单ID

resultType - 查询结果类型 - 转写结果：transfer（默认） - 翻译结果：translate - 质检结果：predict - 组合结果查询：多个类型结果使用”,”隔开，目前只支持转写和质检结果一起返回，不支持转写和翻译结果一起返回（如果任务有失败则只返回处理成功的结果） - 转写和质检结果组合返回：transfer,predict - 注：使用质检功能请先在控制台开启

返回:

转写结果

抛出:

SignatureException - 签名异常