From 737b682b20d3b52bf9ad0341dc486678f29185ba Mon Sep 17 00:00:00 2001 From: Jael Gu Date: Mon, 26 Jun 2023 15:20:55 +0800 Subject: [PATCH] Update README Signed-off-by: Jael Gu --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 52cb347..9676708 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ p = ( .output('answer') ) -an1 = p('Who are you?', [], []).get()[0] +an1 = p('What is your name?', [], []).get()[0] print(an1) an2 = p('Tell me something about Towhee', towhee_docs, []).get()[0] @@ -57,6 +57,20 @@ Create the operator via the following factory method: ***ops.prompt.template(temp, keys, sys_msg)*** +**Parameters:** + +***temp***: *str* + +​ A template to create a prompt as the last user message. + +***keys***: *list* + +​ A list of keys used in template. + +***sys_msg***: *str=None* + +​ A system message, defaults to None. If None, it will not pass any system message. +