diff --git a/README.md b/README.md index a920703..5d49818 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,17 @@ InteRecAgent consists of 4 necessary components: We also provide a shell script `run.sh`, where commonly used arguments are given. You could directly set the API related information in `run.sh`, or create a new shell script `oai.sh` that would be loaded in `run.sh`. GPT-4 API is highly recommended for the InteRecAgent since it has remarkable instruction-following capability. + Here is an example of the `oai.sh` script: + + ```bash + API_KEY="xxxxxx" # your api key + API_BASE="https://xxxx.azure.com/" # [https://xxxx.azure.com, https://api.openai.com/v1] + API_VERSION="2023-03-15-preview" + API_TYPE="azure" # ['open_ai', 'azure'] + engine="gpt4" # model name for OpenAI or deployment name for Azure OpenAI. GPT-4 is recommended. + bot_type="chat" # model type, ["chat", "completetion"]. For gpt-3.5-turbo and gpt-4, it should be "chat". For text-davinci-003, it should be "completetion" + ``` + 4. Features @@ -183,6 +194,7 @@ Any use of third-party trademarks or logos are subject to those third-party's po Thanks to the open source codes of the following projects: +[UniRec](https://github.com/microsoft/UniRec)   [VisualChatGPT](https://github.com/microsoft/TaskMatrix/blob/main/visual_chatgpt.py)   [JARVIS](https://github.com/microsoft/JARVIS)   [LangChain](https://github.com/langchain-ai/langchain)   diff --git a/requirements.txt b/requirements.txt index ed9c3de..696ea92 100644 --- a/requirements.txt +++ b/requirements.txt @@ -12,4 +12,4 @@ guidance==0.0.64 SQLAlchemy==1.4.46 --extra-index-url https://download.pytorch.org/whl/cu113 torch>=1.12.1,<=1.13.1 -unirec==0.0.1a2 \ No newline at end of file +unirec>=0.0.1a4 \ No newline at end of file