cn.xfyun.api

类 LfasrClient

java.lang.Object

cn.xfyun.api.LfasrClient

public class LfasrClient
extends Object

转写client

作者:

: iflytek

Date:

: 2021年03月15日

嵌套类概要

嵌套类

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

构造器概要

构造器

构造器和说明
LfasrClient(LfasrClient.Builder builder) builder 字段赋值

方法概要

限定符和类型	方法和说明
LfasrMessage	getProgress(String taskId) 查询处理进度接口 在调用方发出合并文件请求后，服务端已将任务列入计划。
LfasrMessage	getResult(String taskId) 获取结果接口 当任务处理进度状态=9（见查询处理进度接口），调用该接口获取转写结果。
LfasrMessage	mergeFile(String taskId) 合并文件接口 全部文件切片上传成功后，调用该接口，通知服务端进行文件合并与转写操作。
LfasrMessage	prepare(String audioFilePath) 预处理接口 上传待转写音频文件的基本信息（文件名、大小）和分片信息（建议分片大小设置为10M，若无需分片，slice_num=1）和相关的可配置参数。
LfasrMessage	upload(String audioFilePath) 文件上传接口 包含： 1、prepare 2、uploadFile 3、merge
void	uploadFile(String taskId, String audioFilePath) 文件分片上传接口 按预处理设置的分片信息（slice_num）依次上传音频切片（文件以二进制方式读取上传）， 直到全部切片上传成功（如预处理时 slice_num=2，则需将音频切分成两部分，slice_id=aaaaaaaaaa和aaaaaaaaab，并按顺序调用该接口）； 上一切片成功上传，才可进行下一切片的上传操作。

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

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

构造器详细资料

LfasrClient

public LfasrClient(LfasrClient.Builder builder)

builder 字段赋值

参数:

builder -

方法详细资料

prepare

public LfasrMessage prepare(String audioFilePath)
                     throws LfasrException,
                            SignatureException

预处理接口 上传待转写音频文件的基本信息（文件名、大小）和分片信息（建议分片大小设置为10M，若无需分片，slice_num=1）和相关的可配置参数。 调用成功，返回任务ID（task_id，转写任务的唯一标识），是后续接口的必传参数。

参数:

audioFilePath -

返回:

抛出:

LfasrException

SignatureException

uploadFile

public void uploadFile(String taskId,
                       String audioFilePath)
                throws LfasrException

文件分片上传接口 按预处理设置的分片信息（slice_num）依次上传音频切片（文件以二进制方式读取上传）， 直到全部切片上传成功（如预处理时 slice_num=2，则需将音频切分成两部分，slice_id=aaaaaaaaaa和aaaaaaaaab，并按顺序调用该接口）； 上一切片成功上传，才可进行下一切片的上传操作。调用过程中若出现异常，可重试若干次。

参数:

taskId -

audioFilePath -

抛出:

LfasrException

mergeFile

public LfasrMessage mergeFile(String taskId)
                       throws LfasrException,
                              SignatureException

合并文件接口 全部文件切片上传成功后，调用该接口，通知服务端进行文件合并与转写操作。 该接口不会返回转写结果，而是通知服务端将任务列入转写计划。转写的结果通过 getResult 接口获取。

参数:

taskId -

返回:

抛出:

LfasrException

SignatureException

upload

public LfasrMessage upload(String audioFilePath)
                    throws LfasrException,
                           SignatureException

文件上传接口 包含： 1、prepare 2、uploadFile 3、merge

参数:

audioFilePath -

返回:

抛出:

LfasrException

SignatureException

getProgress

public LfasrMessage getProgress(String taskId)
                         throws SignatureException

查询处理进度接口 在调用方发出合并文件请求后，服务端已将任务列入计划。在获取结果前，调用方需轮询该接口查询任务当前状态。 当且仅当任务状态=9（转写结果上传完成），才可调用获取结果接口获取转写结果。 轮询策略由调用方决定，建议每隔10分钟轮询一次。状态码说明见附录。

参数:

taskId -

返回:

抛出:

SignatureException

getResult

public LfasrMessage getResult(String taskId)
                       throws SignatureException

获取结果接口 当任务处理进度状态=9（见查询处理进度接口），调用该接口获取转写结果。这是转写流程的最后一步。

参数:

taskId -

返回:

抛出:

SignatureException