From 5e3dce38f448e311b9cca7996a6a83a4d2704913 Mon Sep 17 00:00:00 2001 From: Ftps Date: Tue, 26 Mar 2024 23:55:57 +0900 Subject: [PATCH] add document for inference api --- README.md | 17 ++++++++++++++--- docs/es/README.es.md | 21 ++++++++++++++++----- docs/jp/README.ja.md | 17 ++++++++++++++--- 3 files changed, 44 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a13733a..c6b5066 100644 --- a/README.md +++ b/README.md @@ -120,12 +120,23 @@ poetry run poe rvc-api ``` #### Inference Audio + +##### Get as blob ```sh curl -X 'POST' \ - 'http://127.0.0.1:8000/inference' \ + 'http://127.0.0.1:8000/inference?res_type=blob' \ -H 'accept: application/json' \ -H 'Content-Type: multipart/form-data' \ -F 'modelpath={model.pth}' \ - -F 'input={input audio path}' \ - -o {output audio path} + -F 'input={input audio path}' +``` + +##### Get as json(include time) +```sh +curl -X 'POST' \ + 'http://127.0.0.1:8000/inference?res_type=json' \ + -H 'accept: application/json' \ + -H 'Content-Type: multipart/form-data' \ + -F 'modelpath={model.pth}' \ + -F 'input={input audio path}' ``` diff --git a/docs/es/README.es.md b/docs/es/README.es.md index ee85afb..cef6fdc 100644 --- a/docs/es/README.es.md +++ b/docs/es/README.es.md @@ -120,12 +120,23 @@ poetry run poe rvc-api ``` #### Inferir audio + +##### Obtener como blob ```sh curl -X 'POST' \ - 'http://127.0.0.1:8000/inference' \ + 'http://127.0.0.1:8000/inference?res_type=blob' \ -H 'accept: application/json' \ -H 'Content-Type: multipart/form-data' \ - -F 'modelpath={modelo.pth}' \ - -F 'input={ruta del audio de entrada}' \ - -o {ruta del audio de salida} -``` \ No newline at end of file + -F 'modelpath={model.pth}' \ + -F 'input={input audio path}' +``` + +##### Obtener como json(incluir tiempo) +```sh +curl -X 'POST' \ + 'http://127.0.0.1:8000/inference?res_type=json' \ + -H 'accept: application/json' \ + -H 'Content-Type: multipart/form-data' \ + -F 'modelpath={model.pth}' \ + -F 'input={input audio path}' +``` diff --git a/docs/jp/README.ja.md b/docs/jp/README.ja.md index f79e95a..3903640 100644 --- a/docs/jp/README.ja.md +++ b/docs/jp/README.ja.md @@ -95,14 +95,25 @@ rvc-api poetry run poe rvc-api ``` にて実行されます。 + #### Inference Audio + +##### blobでレスポンスを受け取る ```sh curl -X 'POST' \ - 'http://127.0.0.1:8000/inference' \ + 'http://127.0.0.1:8000/inference?res_type=blob' \ -H 'accept: application/json' \ -H 'Content-Type: multipart/form-data' \ -F 'modelpath={model.pth}' \ - -F 'input={input audio path}' \ - -o {output audio path} + -F 'input={input audio path}' ``` +##### jsonでレスポンス！(include time) +```sh +curl -X 'POST' \ + 'http://127.0.0.1:8000/inference?res_type=json' \ + -H 'accept: application/json' \ + -H 'Content-Type: multipart/form-data' \ + -F 'modelpath={model.pth}' \ + -F 'input={input audio path}' +```