REF: Mark Deprecate for prompt, system_prompt and `chat_history…

…` parameters in `chat` client interface (xorbitsai#2043)
qinxuye · Aug 8, 2024 · 7d83300 · 7d83300
1 parent 9b713bc
commit 7d83300
Show file tree

Hide file tree

Showing 9 changed files with 122 additions and 343 deletions.
diff --git a/doc/source/locale/ja_JP/LC_MESSAGES/reference/index.po b/doc/source/locale/ja_JP/LC_MESSAGES/reference/index.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Xinference \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-12-27 15:43+0800\n"
+"POT-Creation-Date: 2024-08-08 14:38+0800\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: ja_JP\n"
@@ -17,7 +17,7 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.12.1\n"
+"Generated-By: Babel 2.11.0\n"
 
 #: ../../source/reference/index.rst:5
 msgid "API Reference"
@@ -30,7 +30,7 @@ msgstr ""
 #: ../../source/reference/index.rst:25:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.Client <xinference.client.Client>`\\ "
-"\\(base\\_url\\)"
+"\\(base\\_url\\[\\, api\\_key\\]\\)"
 msgstr ""
 
 #: ../../source/reference/index.rst:25:<autosummary>:1
@@ -124,198 +124,166 @@ msgid "Model Handles"
 msgstr ""
 
 #: ../../source/reference/index.rst:31
-msgid "ChatglmCppChatModelHandle"
-msgstr ""
-
-#: ../../source/reference/index.rst:40:<autosummary>:1
-msgid ""
-":py:obj:`xinference.client.handlers.ChatglmCppChatModelHandle "
-"<xinference.client.handlers.ChatglmCppChatModelHandle>`\\"
-msgstr ""
-
-#: ../../source/reference/index.rst:40:<autosummary>:1
-msgid ""
-"alias of "
-":py:class:`~xinference.client.restful.restful_client.RESTfulChatglmCppChatModelHandle`"
-msgstr ""
-
-#: ../../source/reference/index.rst:40:<autosummary>:1
-msgid ""
-":py:obj:`xinference.client.handlers.ChatglmCppChatModelHandle.chat "
-"<xinference.client.handlers.ChatglmCppChatModelHandle.chat>`\\ "
-"\\(prompt\\)"
-msgstr ""
-
-#: ../../source/reference/index.rst:40:<autosummary>:1
-msgid ""
-"Given a list of messages comprising a conversation, the ChatGLM model "
-"will return a response via RESTful APIs."
-msgstr ""
-
-#: ../../source/reference/index.rst:40:<autosummary>:1
-msgid ""
-":py:obj:`xinference.client.handlers.ChatglmCppChatModelHandle.create_embedding"
-" "
-"<xinference.client.handlers.ChatglmCppChatModelHandle.create_embedding>`\\"
-" \\(input\\)"
-msgstr ""
-
-#: ../../source/reference/index.rst:40:<autosummary>:1
-#: ../../source/reference/index.rst:52:<autosummary>:1
-#: ../../source/reference/index.rst:62:<autosummary>:1
-#: ../../source/reference/index.rst:73:<autosummary>:1
-msgid "Create an Embedding from user input via RESTful APIs."
-msgstr ""
-
-#: ../../source/reference/index.rst:42
 msgid "ChatModelHandle"
 msgstr ""
 
-#: ../../source/reference/index.rst:52:<autosummary>:1
+#: ../../source/reference/index.rst:40:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.ChatModelHandle "
 "<xinference.client.handlers.ChatModelHandle>`\\"
 msgstr ""
 
-#: ../../source/reference/index.rst:52:<autosummary>:1
+#: ../../source/reference/index.rst:40:<autosummary>:1
 msgid ""
 "alias of "
 ":py:class:`~xinference.client.restful.restful_client.RESTfulChatModelHandle`"
 msgstr ""
 
-#: ../../source/reference/index.rst:52:<autosummary>:1
+#: ../../source/reference/index.rst:40:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.ChatModelHandle.chat "
 "<xinference.client.handlers.ChatModelHandle.chat>`\\ \\(prompt\\)"
 msgstr ""
 
-#: ../../source/reference/index.rst:52:<autosummary>:1
+#: ../../source/reference/index.rst:40:<autosummary>:1
 msgid ""
 "Given a list of messages comprising a conversation, the model will return"
 " a response via RESTful APIs."
 msgstr ""
 
-#: ../../source/reference/index.rst:52:<autosummary>:1
-msgid ""
-":py:obj:`xinference.client.handlers.ChatModelHandle.create_embedding "
-"<xinference.client.handlers.ChatModelHandle.create_embedding>`\\ "
-"\\(input\\)"
-msgstr ""
-
-#: ../../source/reference/index.rst:52:<autosummary>:1
+#: ../../source/reference/index.rst:40:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.ChatModelHandle.generate "
 "<xinference.client.handlers.ChatModelHandle.generate>`\\ \\(prompt\\)"
 msgstr ""
 
-#: ../../source/reference/index.rst:52:<autosummary>:1
-#: ../../source/reference/index.rst:73:<autosummary>:1
+#: ../../source/reference/index.rst:40:<autosummary>:1
+#: ../../source/reference/index.rst:60:<autosummary>:1
 msgid ""
 "Creates a completion for the provided prompt and parameters via RESTful "
 "APIs."
 msgstr ""
 
-#: ../../source/reference/index.rst:54
+#: ../../source/reference/index.rst:42
 msgid "EmbeddingModelHandle"
 msgstr ""
 
-#: ../../source/reference/index.rst:62:<autosummary>:1
+#: ../../source/reference/index.rst:50:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.EmbeddingModelHandle "
 "<xinference.client.handlers.EmbeddingModelHandle>`\\"
 msgstr ""
 
-#: ../../source/reference/index.rst:62:<autosummary>:1
+#: ../../source/reference/index.rst:50:<autosummary>:1
 msgid ""
 "alias of "
 ":py:class:`~xinference.client.restful.restful_client.RESTfulEmbeddingModelHandle`"
 msgstr ""
 
-#: ../../source/reference/index.rst:62:<autosummary>:1
+#: ../../source/reference/index.rst:50:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.EmbeddingModelHandle.create_embedding"
 " <xinference.client.handlers.EmbeddingModelHandle.create_embedding>`\\ "
-"\\(input\\)"
+"\\(...\\)"
+msgstr ""
+
+#: ../../source/reference/index.rst:50:<autosummary>:1
+msgid "Create an Embedding from user input via RESTful APIs."
 msgstr ""
 
-#: ../../source/reference/index.rst:64
+#: ../../source/reference/index.rst:52
 msgid "GenerateModelHandle"
 msgstr ""
 
-#: ../../source/reference/index.rst:73:<autosummary>:1
+#: ../../source/reference/index.rst:60:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.GenerateModelHandle "
 "<xinference.client.handlers.GenerateModelHandle>`\\"
 msgstr ""
 
-#: ../../source/reference/index.rst:73:<autosummary>:1
+#: ../../source/reference/index.rst:60:<autosummary>:1
 msgid ""
 "alias of "
 ":py:class:`~xinference.client.restful.restful_client.RESTfulGenerateModelHandle`"
 msgstr ""
 
-#: ../../source/reference/index.rst:73:<autosummary>:1
-msgid ""
-":py:obj:`xinference.client.handlers.GenerateModelHandle.create_embedding "
-"<xinference.client.handlers.GenerateModelHandle.create_embedding>`\\ "
-"\\(input\\)"
-msgstr ""
-
-#: ../../source/reference/index.rst:73:<autosummary>:1
+#: ../../source/reference/index.rst:60:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.GenerateModelHandle.generate "
 "<xinference.client.handlers.GenerateModelHandle.generate>`\\ \\(prompt\\)"
 msgstr ""
 
-#: ../../source/reference/index.rst:75
+#: ../../source/reference/index.rst:62
 msgid "ImageModelHandle"
 msgstr ""
 
-#: ../../source/reference/index.rst:81:<autosummary>:1
+#: ../../source/reference/index.rst:70:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.ImageModelHandle "
 "<xinference.client.handlers.ImageModelHandle>`\\"
 msgstr ""
 
-#: ../../source/reference/index.rst:81:<autosummary>:1
+#: ../../source/reference/index.rst:70:<autosummary>:1
 msgid ""
 "alias of "
 ":py:class:`~xinference.client.restful.restful_client.RESTfulImageModelHandle`"
 msgstr ""
 
-#: ../../source/reference/index.rst:81:<autosummary>:1
+#: ../../source/reference/index.rst:70:<autosummary>:1
 msgid ""
 ":py:obj:`xinference.client.handlers.ImageModelHandle.text_to_image "
 "<xinference.client.handlers.ImageModelHandle.text_to_image>`\\ "
 "\\(prompt\\)"
 msgstr ""
 
-#: ../../source/reference/index.rst:81:<autosummary>:1
+#: ../../source/reference/index.rst:70:<autosummary>:1
 msgid "Creates an image by the input text."
 msgstr ""
 
-#~ msgid ""
-#~ "alias of "
-#~ ":py:class:`xinference.client.restful.restful_client.RESTfulChatglmCppChatModelHandle`"
-#~ msgstr ""
+#: ../../source/reference/index.rst:72
+msgid "AudioModelHandle"
+msgstr ""
+
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid ""
+":py:obj:`xinference.client.handlers.AudioModelHandle "
+"<xinference.client.handlers.AudioModelHandle>`\\"
+msgstr ""
+
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid ""
+"alias of "
+":py:class:`~xinference.client.restful.restful_client.RESTfulAudioModelHandle`"
+msgstr ""
+
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid ""
+":py:obj:`xinference.client.handlers.AudioModelHandle.transcriptions "
+"<xinference.client.handlers.AudioModelHandle.transcriptions>`\\ "
+"\\(audio\\)"
+msgstr ""
+
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid "Transcribes audio into the input language."
+msgstr ""
 
-#~ msgid ""
-#~ "alias of "
-#~ ":py:class:`xinference.client.restful.restful_client.RESTfulChatModelHandle`"
-#~ msgstr ""
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid ""
+":py:obj:`xinference.client.handlers.AudioModelHandle.translations "
+"<xinference.client.handlers.AudioModelHandle.translations>`\\ \\(audio\\)"
+msgstr ""
 
-#~ msgid ""
-#~ "alias of "
-#~ ":py:class:`xinference.client.restful.restful_client.RESTfulEmbeddingModelHandle`"
-#~ msgstr ""
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid "Translates audio into English."
+msgstr ""
 
-#~ msgid ""
-#~ "alias of "
-#~ ":py:class:`xinference.client.restful.restful_client.RESTfulGenerateModelHandle`"
-#~ msgstr ""
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid ""
+":py:obj:`xinference.client.handlers.AudioModelHandle.speech "
+"<xinference.client.handlers.AudioModelHandle.speech>`\\ \\(input\\)"
+msgstr ""
 
-#~ msgid ""
-#~ "alias of "
-#~ ":py:class:`xinference.client.restful.restful_client.RESTfulImageModelHandle`"
-#~ msgstr ""
+#: ../../source/reference/index.rst:80:<autosummary>:1
+msgid "Generates audio from the input text."
+msgstr ""