From 3950557e043e239526162cec4b42d334457d2a41 Mon Sep 17 00:00:00 2001
From: xiongxinlei <xiongxinlei@baidu.com>
Date: Sun, 1 May 2022 23:50:08 +0800
Subject: [PATCH] update the vector server note, test=doc

---
 paddlespeech/server/bin/paddlespeech_client.py | 10 +++++++---
 paddlespeech/server/restful/request.py         |  5 ++++-
 paddlespeech/server/restful/response.py        |  7 ++++++-
 3 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/paddlespeech/server/bin/paddlespeech_client.py b/paddlespeech/server/bin/paddlespeech_client.py
index f1f02d16..32f78942 100644
--- a/paddlespeech/server/bin/paddlespeech_client.py
+++ b/paddlespeech/server/bin/paddlespeech_client.py
@@ -655,12 +655,16 @@ class VectorClientExecutor(BaseExecutor):
         Python API to call text executor.
 
         Args:
-            input (str): the request sentence text
+            input (str): the request audio data
             server_ip (str, optional): the server ip. Defaults to "127.0.0.1".
             port (int, optional): the server port. Defaults to 8090.
-
+            audio_format (str, optional): audio format. Defaults to "wav".
+            sample_rate (str, optional): audio sample rate. Defaults to 16000.
+            enroll_audio (str, optional): enroll audio data. Defaults to None.
+            test_audio (str, optional): test audio data. Defaults to None.
+            task (str, optional): the task type, "spk" or "socre". Defaults to "spk"
         Returns:
-            str: the punctuation text
+            str: the audio embedding or score between enroll and test audio
         """
         if task == "spk":
             from paddlespeech.server.utils.audio_handler import VectorHttpHandler
diff --git a/paddlespeech/server/restful/request.py b/paddlespeech/server/restful/request.py
index b23ed76d..4e88280a 100644
--- a/paddlespeech/server/restful/request.py
+++ b/paddlespeech/server/restful/request.py
@@ -15,7 +15,10 @@ from typing import Optional
 
 from pydantic import BaseModel
 
-__all__ = ['ASRRequest', 'TTSRequest', 'CLSRequest', 'VectorRequest']
+__all__ = [
+    'ASRRequest', 'TTSRequest', 'CLSRequest', 'VectorRequest',
+    'VectorScoreRequest'
+]
 
 
 #****************************************************************************************/
diff --git a/paddlespeech/server/restful/response.py b/paddlespeech/server/restful/response.py
index f8cdb3cf..c91b3899 100644
--- a/paddlespeech/server/restful/response.py
+++ b/paddlespeech/server/restful/response.py
@@ -15,7 +15,10 @@ from typing import List
 
 from pydantic import BaseModel
 
-__all__ = ['ASRResponse', 'TTSResponse', 'CLSResponse']
+__all__ = [
+    'ASRResponse', 'TTSResponse', 'CLSResponse', 'TextResponse',
+    'VectorResponse', 'VectorScoreResponse'
+]
 
 
 class Message(BaseModel):
@@ -190,6 +193,7 @@ class VectorResponse(BaseModel):
 class VectorScoreResult(BaseModel):
     score: float
 
+
 class VectorScoreResponse(BaseModel):
     """
     response example
@@ -209,6 +213,7 @@ class VectorScoreResponse(BaseModel):
     message: Message
     result: VectorScoreResult
 
+
 #****************************************************************************************/
 #********************************** Error response **************************************/
 #****************************************************************************************/
-- 
GitLab