Skip to content

Commit

Permalink
docs: add docs for xfyun configuration comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Yogurt-lei committed Jan 2, 2019
1 parent 227f207 commit 1a7a610
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
There have some api to easy convert video audio image to text, and revert text to audio(base64).
Here is [api-docs](http://kbs55.demo.xiaoi.com/kbase-media/swagger-ui.html) which use Swagger2.

> easy convert video audio image to text, or revert text to audio(base64), more features can expected.
Here is [api-docs](http://kbs41.demo.xiaoi.com/kbase-media/swagger-ui.html) which use Swagger2.

>
[![Build Status](https://travis-ci.org/Yogurt-lei/kbase-media.svg?branch=develop)](https://travis-ci.org/Yogurt-lei/kbase-media)
![license](https://img.shields.io/github/license/mashape/apistatus.svg)
![Java v1.8](https://img.shields.io/badge/Java-v1.8.0__162-blue.svg)
![Maven v3.5.3](https://img.shields.io/badge/Maven-v3.5.3-blue.svg)

**配置文件说明**

Expand All @@ -26,7 +33,7 @@ convert:
output-folder: ./convert/async/
video:
vca:
# 项目依赖于ffmpeg,必须要安装,默认即可
# 项目依赖于ffmpeg,必须要安装,默认即可
default: ffmpeg
ffmpeg:
# ffmpeg的安装路径
Expand All @@ -37,7 +44,7 @@ convert:
audio:
# asr引擎配置
asr:
# 可选值:shhan:声瀚引擎(私有化部署),baidu:百度引擎
# 可选值:shhan:声瀚引擎(私有化部署),baidu:百度引擎
default: shhan
# asr接口对音频时间长度有限制,所以此值为切割文件的长度,声瀚为20s/段,百度为60s/段
seg-duration: 20
Expand All @@ -46,8 +53,12 @@ convert:
appId: 11067243
apiKey: iDEvPvY4zT9CzFgYKMQY6eAi
secretKey: Wkeh8gIbB2LrNBtGwuechG8TUkLlB2TY
xfyun:
apiUrl: http://api.xfyun.cn/v1/service/v1/iat
appId: 5be241a0
apiKey: da08f42480e67f574a61290717e8f945
shhan:
# 声瀚引擎base-url
# 声瀚引擎base-url
base-url: http://172.16.8.103:8177/shRecBase/
image:
# ocr 引擎配置
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public Docket customDocket() {
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Convert API")
.description("easy convert video audio image to text, and revert text to audio(base64)")
.description("easy convert video audio image to text, or revert text to audio(base64), more feature can expected")
.termsOfServiceUrl("http://kbs55.demo.xiaoi.com/kbase-media/swagger-ui.html")
.contact(new Contact("Yogurt_lei", "", "[email protected]"))
.version("2.0")
Expand Down

0 comments on commit 1a7a610

Please sign in to comment.