doc: API endpoints for sotopia #242

XuhuiZhou · 2024-10-30T19:26:45Z

This is an initial design of the Sotopia API

Closes #

📑 Description

✅ Checks

My pull request adheres to the code style of this project
My code requires changes to the documentation
I have updated the documentation as required
All the tests have passed
Branch name follows type/descript (e.g. feature/add-llm-agents)
Ready for code review

ℹ Additional Information

codecov · 2024-10-30T19:30:40Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.88%. Comparing base (19d39e0) to head (80063cc).
Report is 20 commits behind head on main.

@@           Coverage Diff           @@
##             main     #242   +/-   ##
=======================================
  Coverage   72.88%   72.88%           
=======================================
  Files          58       58           
  Lines        2972     2972           
=======================================
  Hits         2166     2166           
  Misses        806      806

see 2 files with indirect coverage changes

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

ProKil · 2024-10-30T22:12:52Z

My high level question is whether we should allow agent and scenario design to be of a custom schema?

XuhuiZhou · 2024-10-30T23:53:32Z

Not for now? Imo the current schema is quite flexible. You can literally squeeze so much info into public information and secret. I do think we should re visit how we compose those schema tho

…

On Wed, Oct 30, 2024 at 6:13 PM Hao Zhu ***@***.***> wrote: My high level question is whether we should allow agent and scenario design to be of a custom schema? — Reply to this email directly, view it on GitHub <#242 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AE35IXOYEDPGBW6VHIQHM73Z6FKXVAVCNFSM6AAAAABQ422FJWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINBYGU2TMMJQGY> . You are receiving this because you authored the thread.Message ID: ***@***.***>

ProKil · 2024-10-31T03:55:09Z

It would be great if we can allow people who use our apis to bring their own agent specifications, i.e. having a generic AgentProfile

XuhuiZhou · 2024-10-31T05:33:02Z

Please give a concrete example in terms of fastAPI

…

On Wed, Oct 30, 2024 at 11:55 PM Hao Zhu ***@***.***> wrote: It would be great if we can allow people who use our apis to bring their own agent specifications, i.e. having a generic AgentProfile — Reply to this email directly, view it on GitHub <#242 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AE35IXI77J7B7DV73675N6DZ6GS3JAVCNFSM6AAAAABQ422FJWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINBYHE3DIMZUHA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

ProKil · 2024-10-31T17:15:32Z

Sure, a new api "PUT add_agentprofile_schema" with parameters "schema_name" and "schema"

An example input:

{
    schema_name: "AI assistants",
    schema: "{'title': 'AIAssistant', 'type': 'object', 'properties': {'name': {'title': 'Name', 'type': 'string'}, 'role_description': {'title': 'Role Description', 'type': 'string'}, 'tools': {'title': 'Tools', 'type': 'array', 'items': {'type': 'string'}}}, 'required': ['name', 'role_description', 'tools']}"
}

sotopia/ui/README.md

XuhuiZhou · 2024-11-08T01:23:14Z

Let's merge this imo

ProKil

Cool It looks great. Just left some final request changes.

BTW, in all of endpoints /{get/post}/... seems to be not useful, i.e. we might just do GET /agents instead of GET /get/agents.

sotopia/ui/README.md

sotopia/ui/websocket_ex.py

XuhuiZhou · 2024-11-08T18:07:26Z

Cool It looks great. Just left some final request changes.

BTW, in all of endpoints /{get/post}/... seems to be not useful, i.e. we might just do GET /agents instead of GET /get/agents.

@ProKil why get is not useful? we want to disabiguiate from post right?

ProKil · 2024-11-08T18:57:21Z

Cool It looks great. Just left some final request changes.
BTW, in all of endpoints /{get/post}/... seems to be not useful, i.e. we might just do GET /agents instead of GET /get/agents.

@ProKil why get is not useful? we want to disabiguiate from post right?

Since when you send an request, you will specify whether the method is GET/POST/PUT/DEL, have these method names in the end point is redundant.

For example,

import requests

# Make a GET request
response = requests.get('https://api.example.com/data')

# Make a POST request
data = ...
response = requests.post('https://api.example.com/data', json=data)

You don't need to use ' requests.get('https://api.example.com/get/data')'

sotopia/ui/README.md

…ab/sotopia into feature/sotopia-ui-doc

sotopia/ui/README.md

bugsz

lgtm : )

ProKil · 2024-11-21T23:39:48Z

pyproject.toml

+chat = [
+    "fastapi[standard]",
+    "websockets>=13.1",
+    "rel",


Why is rel needed?

ProKil · 2024-11-21T23:40:14Z

pyproject.toml

-chat = ["fastapi"]
+chat = [
+    "fastapi[standard]",
+    "websockets>=13.1",


Is websockets needed? Can we use aiohttp?

* Update langchain requirement from <0.3.0,>=0.2.5 to >=0.2.5,<0.4.0 (#236) * [Automated] Merge release into main (#235) * bump the version, test release to PyPi * Update README.md * Update README.md * Update README.md * bumpy version to 0.0.9 * Update Sotopia presentation information in README.md * bump version to 0.0.10 * bump version * add merge release back to main action * change checkout v4->v3 * fix merge-back-to-main and pin mypy to <1.11.0 * merge bug fix * upgrade default model to handle bad-foratted outputs to gpt-4o-mini as gpt-3.5-turbo is deprecated (#183) * update pull request -> pull request target * bump version * Add `bad_output_process_model` option and `use_fixed_model_version` option for all generation methods, to avoid future OpenAI API changes break Sotopia running. (#196) * Two major updates: 1) add "bad_output_process_model" option to all `agenerate_xxx()` methods so users can decide which model to use for handling bad outputs. By default, this is set to be `gpt-4o-mini`. 2) add `use_fixed_model_version` option for all generation methods, as some fixed model version may no longer available in the future. Users should have the right to bypass the fixed model version mapping instead of getting stuck in an error. Document (`generation.md`) has been updated for these two major changes correspondingly. * [autofix.ci] apply automated fixes --------- Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix gpt-3.5 * replace gpt3.5 turbo for tests * update gpt-3.5-turbo to gpt-4o-mini * bug fix for return fixed model version function * fix sampling error * fix rc.4 * new tag * bump version * update workflow permission * add why sotopia * improve the why sotopia * bump version * further add clarification to the custom models --------- Co-authored-by: XuhuiZhou <zhouxuhui2018@gmail.com> Co-authored-by: Chenghao (Alan) Yang <chenghao@uchicago.edu> Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * update macos test runner as macos-latest (#238) * update macos test runner as macos-latest * redis-stack-server * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * feat(exp_eval): support tag for combo iteration (#245) * support tag for combo iteration * fix pre-commit error * [autofix.ci] apply automated fixes * fix mypy error --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * feat: Initial Message for LLM agnets in Sotopia Aact (Experimental) (#249) * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Rebasing --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * feat: Adding Chat print node for pretty printing chat conversation between agents (#250) * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Adding scene context for agents * [autofix.ci] apply automated fixes * Added chat print node * [autofix.ci] apply automated fixes * Fixing the runtime channel * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Adding scene context for agents * Added chat print node * [autofix.ci] apply automated fixes * Moving chat node to experiment * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * feat: Initial Message for LLM agnets in Sotopia Aact (Experimental) (#249) * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Rebasing --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding scene context for agents * Added chat print node * [autofix.ci] apply automated fixes * Adding scene context for agents * [autofix.ci] apply automated fixes * Fixing the runtime channel * Moving chat node to experiment * Updating the toml file paths --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * doc: API endpoints for sotopia (#242) * api doc * add PUT * add an temp example for websocket * websocket * update readme * Update README.md * update websocket live simulation api doc * [autofix.ci] apply automated fixes * update websocket doc * add api server with websocket as well as a client * fix mypy errors * support stopping the chat * add 404 to the status code * fix mypy issue * remove files * update requirement * update return message from the server * add restful error code * Update README.md * remove paks --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * feat: FastAPI Implementation of Sotopia Part One (wo websocket) (#246) * api doc * add PUT * add an temp example for websocket * websocket * update readme * Update README.md * fastapi server wo websocket * update project toml * add websocket api and a sample client sample * add initial test * post update * finalize the doc * fix the create * finish test * add files * change chata to api * fix mypy error * fix mypy bug * fix mypy * create mock agents * downgrade langchain openai upperbound to fix CI --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> * update the instruction to load existing data via docker (#255) * fix doc (#258) * Sotopia API and UI (#264) * feat: FastAPI Implementation of Sotopia Part Two (w websocket) (#252) * api doc * add PUT * add an temp example for websocket * websocket * update readme * Update README.md * update websocket live simulation api doc * [autofix.ci] apply automated fixes * update websocket doc * add api server with websocket as well as a client * fix mypy errors * support stopping the chat * add 404 to the status code * fix mypy issue * update the returned message types * redesign websocket api * update websocket, fix mypy error * add example of using websocket * clean code & change to existing functions for simulation * fix typing mismatch * update doc & mypy type fix * add type check for run_async_server * move example --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Add customizable evaluation dimensions (#256) * add customizable evaluation dimensions * add docs * fix mypy error & refactor examples * add docs for evaluation dimensions * update docs and examples * add test cases and fix mypy issue * fix mypy issue * Fix test_create_custom_dimension to use CustomEvaluationDimension.get(pk) (#262) Co-authored-by: openhands <openhands@all-hands.dev> * Fix/custom eval dimension test (#263) * Fix test_create_custom_dimension to use CustomEvaluationDimension.get(pk) * Update documentation for SotopiaDimension and EvaluationDimensionBuilder * [autofix.ci] apply automated fixes * Add API documentation for evaluation dimensions * Refine API documentation for evaluation_dimensions.py to match style * [autofix.ci] apply automated fixes --------- Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * add doc --------- Co-authored-by: XuhuiZhou <zhouxuhui2018@gmail.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Feat/addtional fast apis for non-streaming simulation and managing relationshio (#265) * temp run * add relationship api * fix mypy error * update relationship api * simulate episode non-streaming * modify sim episodes * add simulation status * task error * add background task * [autofix.ci] apply automated fixes * back to arun one episode * upload the code * use rq to execute background tasks * temp sol --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix ci error * solving pytests * improve the tests * add custom eval fast api (#268) * fix mypy error * aact moderator (#257) * initial framework * initial conv * fix module error * feat: Add 3 new features to Moderator (#266) * feat:introduce booting procedure, saving, and ending chat to moderator * fix: moderator will now ignore none AgentAction, Observations now don't have to include all channels in the mapping * merge changes of example into the original one * fix: 1. save() method now accepts push_to_db config 2. booting()'s waiting time is changed to 0.1 sec * fix: rewrite booting() so that different agent will receive different background information * fix: moderator now inherits from Node directly, instead of from BaseAgent --------- Co-authored-by: JXZhou <JXZhou> * add save condition for moderator * push to db false * to fully stop * stopping all agents * fix mypy * fix mypy error --------- Co-authored-by: JXZhou <156194797+JXZhou0224@users.noreply.github.com> * Deploy the api to modal (#267) * prototype for modal serving * add openai secret * fix type annotation * add doc * bug fix for simulation api * add customize model, evaluator model and evaluation dimensions * Implement modal API server with Redis integration and FastAPI setup - Added a new script for the modal API server that initializes a Redis instance. - Created a persistent volume for Redis data and included a function to download initial data if not present. - Configured a Docker image with necessary dependencies including Redis Stack and FastAPI. - Implemented a web API class that sets up and cleans up the Redis connection, ensuring readiness before serving requests. - Integrated the SotopiaFastAPI application within the modal framework. --------- Co-authored-by: XuhuiZhou <zhouxuhui2018@gmail.com> * Feature/sotopia demo UI (#261) * initial * initial ui * merge main * add new ui * switch to fastAPI * websocket check * fix render episode error * add page; make a simplified page and still WIP * [autofix.ci] apply automated fixes * fix simplified streaming version * semi-done character page + avatar assets * Fixed character card styling * [autofix.ci] apply automated fixes * unified rendering and chat display * updated chat character icons * add some tags * add typing * temp fix * add characters avatar to simulation * fix episode full avatar * go to modal config * clean up code * add modal streamlit app * clean codebase except websocket * remove repeated local css * clean websocket * fix get name error * fix errors * pre render scenario * add custom eval * change streamlit to dynamic path * new uv * revert to previous install commands * a fix for modal * add customized dimension * [autofix.ci] apply automated fixes * sort scenarios in simulation * for demo video * update deploy instruction * update intro page * update intro page * [autofix.ci] apply automated fixes * update intro page * add customized dimensions * update api link and modal environment * move folder * fix relative import * update modal image build * use uv to build environment * change folder name * change test * fix modal serve * environment change * refactor * fix ui --------- Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: astrophie <sophie.w.feng@gmail.com> * remove dev tag * add custom eval * base dimension * fix ui mypy * fix mypy * add delete dimension * update streamlit ui * ignores the ui directory * Committing changes before push * pytest for eval dimension * fix mypy * clean up comments * run non streaming simulation * add pytest for websocket * fix mypy issue --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: JXZhou <156194797+JXZhou0224@users.noreply.github.com> Co-authored-by: astrophie <sophie.w.feng@gmail.com> --------- Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Chenghao (Alan) Yang <chenghao@uchicago.edu> Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Haofei Yu <1125027232@qq.com> Co-authored-by: Arpandeep Khatua <arpandeepk@gmail.com> Co-authored-by: Arpandeep Khatua <54747935+akhatua2@users.noreply.github.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: JXZhou <156194797+JXZhou0224@users.noreply.github.com> Co-authored-by: astrophie <sophie.w.feng@gmail.com>

* bump the version, test release to PyPi * Update README.md * Update README.md * Update README.md * bumpy version to 0.0.9 * Update Sotopia presentation information in README.md * bump version to 0.0.10 * bump version * add merge release back to main action * change checkout v4->v3 * fix merge-back-to-main and pin mypy to <1.11.0 * merge bug fix * upgrade default model to handle bad-foratted outputs to gpt-4o-mini as gpt-3.5-turbo is deprecated (#183) * update pull request -> pull request target * bump version * Add `bad_output_process_model` option and `use_fixed_model_version` option for all generation methods, to avoid future OpenAI API changes break Sotopia running. (#196) * Two major updates: 1) add "bad_output_process_model" option to all `agenerate_xxx()` methods so users can decide which model to use for handling bad outputs. By default, this is set to be `gpt-4o-mini`. 2) add `use_fixed_model_version` option for all generation methods, as some fixed model version may no longer available in the future. Users should have the right to bypass the fixed model version mapping instead of getting stuck in an error. Document (`generation.md`) has been updated for these two major changes correspondingly. * [autofix.ci] apply automated fixes --------- Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix gpt-3.5 * replace gpt3.5 turbo for tests * update gpt-3.5-turbo to gpt-4o-mini * bug fix for return fixed model version function * fix sampling error * fix rc.4 * new tag * bump version * update workflow permission * add why sotopia * improve the why sotopia * bump version * further add clarification to the custom models * UI update (#273) * Update langchain requirement from <0.3.0,>=0.2.5 to >=0.2.5,<0.4.0 (#236) * [Automated] Merge release into main (#235) * bump the version, test release to PyPi * Update README.md * Update README.md * Update README.md * bumpy version to 0.0.9 * Update Sotopia presentation information in README.md * bump version to 0.0.10 * bump version * add merge release back to main action * change checkout v4->v3 * fix merge-back-to-main and pin mypy to <1.11.0 * merge bug fix * upgrade default model to handle bad-foratted outputs to gpt-4o-mini as gpt-3.5-turbo is deprecated (#183) * update pull request -> pull request target * bump version * Add `bad_output_process_model` option and `use_fixed_model_version` option for all generation methods, to avoid future OpenAI API changes break Sotopia running. (#196) * Two major updates: 1) add "bad_output_process_model" option to all `agenerate_xxx()` methods so users can decide which model to use for handling bad outputs. By default, this is set to be `gpt-4o-mini`. 2) add `use_fixed_model_version` option for all generation methods, as some fixed model version may no longer available in the future. Users should have the right to bypass the fixed model version mapping instead of getting stuck in an error. Document (`generation.md`) has been updated for these two major changes correspondingly. * [autofix.ci] apply automated fixes --------- Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix gpt-3.5 * replace gpt3.5 turbo for tests * update gpt-3.5-turbo to gpt-4o-mini * bug fix for return fixed model version function * fix sampling error * fix rc.4 * new tag * bump version * update workflow permission * add why sotopia * improve the why sotopia * bump version * further add clarification to the custom models --------- Co-authored-by: XuhuiZhou <zhouxuhui2018@gmail.com> Co-authored-by: Chenghao (Alan) Yang <chenghao@uchicago.edu> Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * update macos test runner as macos-latest (#238) * update macos test runner as macos-latest * redis-stack-server * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * feat(exp_eval): support tag for combo iteration (#245) * support tag for combo iteration * fix pre-commit error * [autofix.ci] apply automated fixes * fix mypy error --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * feat: Initial Message for LLM agnets in Sotopia Aact (Experimental) (#249) * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Rebasing --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * feat: Adding Chat print node for pretty printing chat conversation between agents (#250) * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Adding scene context for agents * [autofix.ci] apply automated fixes * Added chat print node * [autofix.ci] apply automated fixes * Fixing the runtime channel * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Adding scene context for agents * Added chat print node * [autofix.ci] apply automated fixes * Moving chat node to experiment * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * feat: Initial Message for LLM agnets in Sotopia Aact (Experimental) (#249) * Adding OpenHands node * [autofix.ci] apply automated fixes * Added LLM Agent Node * [autofix.ci] apply automated fixes * removing openhands * [autofix.ci] apply automated fixes * Correcting mypy error in tick agent * Moving everything to examples since its not specific to sotopia * [autofix.ci] apply automated fixes * Adding some additional final checks * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Renaming to interview openhands * Adding documentation * [autofix.ci] apply automated fixes * Updating the readme * [autofix.ci] apply automated fixes * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding the initial message channel * Rebasing --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Adding scene context for agents * [autofix.ci] apply automated fixes * Renaming scene context to initial message * Adding scene context for agents * Added chat print node * [autofix.ci] apply automated fixes * Adding scene context for agents * [autofix.ci] apply automated fixes * Fixing the runtime channel * Moving chat node to experiment * Updating the toml file paths --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * doc: API endpoints for sotopia (#242) * api doc * add PUT * add an temp example for websocket * websocket * update readme * Update README.md * update websocket live simulation api doc * [autofix.ci] apply automated fixes * update websocket doc * add api server with websocket as well as a client * fix mypy errors * support stopping the chat * add 404 to the status code * fix mypy issue * remove files * update requirement * update return message from the server * add restful error code * Update README.md * remove paks --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * feat: FastAPI Implementation of Sotopia Part One (wo websocket) (#246) * api doc * add PUT * add an temp example for websocket * websocket * update readme * Update README.md * fastapi server wo websocket * update project toml * add websocket api and a sample client sample * add initial test * post update * finalize the doc * fix the create * finish test * add files * change chata to api * fix mypy error * fix mypy bug * fix mypy * create mock agents * downgrade langchain openai upperbound to fix CI --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> * update the instruction to load existing data via docker (#255) * fix doc (#258) * Sotopia API and UI (#264) * feat: FastAPI Implementation of Sotopia Part Two (w websocket) (#252) * api doc * add PUT * add an temp example for websocket * websocket * update readme * Update README.md * update websocket live simulation api doc * [autofix.ci] apply automated fixes * update websocket doc * add api server with websocket as well as a client * fix mypy errors * support stopping the chat * add 404 to the status code * fix mypy issue * update the returned message types * redesign websocket api * update websocket, fix mypy error * add example of using websocket * clean code & change to existing functions for simulation * fix typing mismatch * update doc & mypy type fix * add type check for run_async_server * move example --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Add customizable evaluation dimensions (#256) * add customizable evaluation dimensions * add docs * fix mypy error & refactor examples * add docs for evaluation dimensions * update docs and examples * add test cases and fix mypy issue * fix mypy issue * Fix test_create_custom_dimension to use CustomEvaluationDimension.get(pk) (#262) Co-authored-by: openhands <openhands@all-hands.dev> * Fix/custom eval dimension test (#263) * Fix test_create_custom_dimension to use CustomEvaluationDimension.get(pk) * Update documentation for SotopiaDimension and EvaluationDimensionBuilder * [autofix.ci] apply automated fixes * Add API documentation for evaluation dimensions * Refine API documentation for evaluation_dimensions.py to match style * [autofix.ci] apply automated fixes --------- Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * add doc --------- Co-authored-by: XuhuiZhou <zhouxuhui2018@gmail.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * Feat/addtional fast apis for non-streaming simulation and managing relationshio (#265) * temp run * add relationship api * fix mypy error * update relationship api * simulate episode non-streaming * modify sim episodes * add simulation status * task error * add background task * [autofix.ci] apply automated fixes * back to arun one episode * upload the code * use rq to execute background tasks * temp sol --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix ci error * solving pytests * improve the tests * add custom eval fast api (#268) * fix mypy error * aact moderator (#257) * initial framework * initial conv * fix module error * feat: Add 3 new features to Moderator (#266) * feat:introduce booting procedure, saving, and ending chat to moderator * fix: moderator will now ignore none AgentAction, Observations now don't have to include all channels in the mapping * merge changes of example into the original one * fix: 1. save() method now accepts push_to_db config 2. booting()'s waiting time is changed to 0.1 sec * fix: rewrite booting() so that different agent will receive different background information * fix: moderator now inherits from Node directly, instead of from BaseAgent --------- Co-authored-by: JXZhou <JXZhou> * add save condition for moderator * push to db false * to fully stop * stopping all agents * fix mypy * fix mypy error --------- Co-authored-by: JXZhou <156194797+JXZhou0224@users.noreply.github.com> * Deploy the api to modal (#267) * prototype for modal serving * add openai secret * fix type annotation * add doc * bug fix for simulation api * add customize model, evaluator model and evaluation dimensions * Implement modal API server with Redis integration and FastAPI setup - Added a new script for the modal API server that initializes a Redis instance. - Created a persistent volume for Redis data and included a function to download initial data if not present. - Configured a Docker image with necessary dependencies including Redis Stack and FastAPI. - Implemented a web API class that sets up and cleans up the Redis connection, ensuring readiness before serving requests. - Integrated the SotopiaFastAPI application within the modal framework. --------- Co-authored-by: XuhuiZhou <zhouxuhui2018@gmail.com> * Feature/sotopia demo UI (#261) * initial * initial ui * merge main * add new ui * switch to fastAPI * websocket check * fix render episode error * add page; make a simplified page and still WIP * [autofix.ci] apply automated fixes * fix simplified streaming version * semi-done character page + avatar assets * Fixed character card styling * [autofix.ci] apply automated fixes * unified rendering and chat display * updated chat character icons * add some tags * add typing * temp fix * add characters avatar to simulation * fix episode full avatar * go to modal config * clean up code * add modal streamlit app * clean codebase except websocket * remove repeated local css * clean websocket * fix get name error * fix errors * pre render scenario * add custom eval * change streamlit to dynamic path * new uv * revert to previous install commands * a fix for modal * add customized dimension * [autofix.ci] apply automated fixes * sort scenarios in simulation * for demo video * update deploy instruction * update intro page * update intro page * [autofix.ci] apply automated fixes * update intro page * add customized dimensions * update api link and modal environment * move folder * fix relative import * update modal image build * use uv to build environment * change folder name * change test * fix modal serve * environment change * refactor * fix ui --------- Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: astrophie <sophie.w.feng@gmail.com> * remove dev tag * add custom eval * base dimension * fix ui mypy * fix mypy * add delete dimension * update streamlit ui * ignores the ui directory * Committing changes before push * pytest for eval dimension * fix mypy * clean up comments * run non streaming simulation * add pytest for websocket * fix mypy issue --------- Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: JXZhou <156194797+JXZhou0224@users.noreply.github.com> Co-authored-by: astrophie <sophie.w.feng@gmail.com> --------- Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Hao Zhu <prokilchu@gmail.com> Co-authored-by: Chenghao (Alan) Yang <chenghao@uchicago.edu> Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Haofei Yu <1125027232@qq.com> Co-authored-by: Arpandeep Khatua <arpandeepk@gmail.com> Co-authored-by: Arpandeep Khatua <54747935+akhatua2@users.noreply.github.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: JXZhou <156194797+JXZhou0224@users.noreply.github.com> Co-authored-by: astrophie <sophie.w.feng@gmail.com> * bump release version --------- Co-authored-by: XuhuiZhou <zhouxuhui2018@gmail.com> Co-authored-by: Chenghao (Alan) Yang <chenghao@uchicago.edu> Co-authored-by: Chenghao Yang <yangalan1996@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Haofei Yu <1125027232@qq.com> Co-authored-by: Arpandeep Khatua <arpandeepk@gmail.com> Co-authored-by: Arpandeep Khatua <54747935+akhatua2@users.noreply.github.com> Co-authored-by: Zhe Su <360307598@qq.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: JXZhou <156194797+JXZhou0224@users.noreply.github.com> Co-authored-by: astrophie <sophie.w.feng@gmail.com>

api doc

decacd9

XuhuiZhou mentioned this pull request Oct 30, 2024

[FEAT]: An user-friendly API and UI for Sotopia #243

Closed

5 tasks

ProKil reviewed Oct 31, 2024

View reviewed changes

sotopia/ui/README.md Outdated Show resolved Hide resolved

sotopia/ui/README.md Outdated Show resolved Hide resolved

XuhuiZhou added 3 commits November 4, 2024 20:12

add PUT

b62a554

add an temp example for websocket

1942a14

websocket

a5e0cc2

XuhuiZhou requested a review from ProKil November 8, 2024 01:23

ProKil requested changes Nov 8, 2024

View reviewed changes

sotopia/ui/README.md Outdated Show resolved Hide resolved

sotopia/ui/README.md Show resolved Hide resolved

sotopia/ui/README.md Outdated Show resolved Hide resolved

sotopia/ui/README.md Show resolved Hide resolved

sotopia/ui/websocket_ex.py Outdated Show resolved Hide resolved

ProKil reviewed Nov 8, 2024

View reviewed changes

sotopia/ui/README.md Show resolved Hide resolved

update readme

1cddc10

XuhuiZhou requested review from ProKil and bugsz November 8, 2024 21:44

Update README.md

4cd747f

ProKil requested changes Nov 9, 2024

View reviewed changes

sotopia/ui/README.md Show resolved Hide resolved

bugsz and others added 2 commits November 10, 2024 08:19

update websocket live simulation api doc

2342dc5

[autofix.ci] apply automated fixes

4977993

ProKil requested changes Nov 10, 2024

View reviewed changes

sotopia/ui/README.md Outdated Show resolved Hide resolved

sotopia/ui/README.md Outdated Show resolved Hide resolved

bugsz added 2 commits November 10, 2024 19:43

update websocket doc

215cf8c

Merge branch 'feature/sotopia-ui-doc' of https://github.com/sotopia-l…

ea2f92c

…ab/sotopia into feature/sotopia-ui-doc

ProKil requested changes Nov 11, 2024

View reviewed changes

sotopia/ui/README.md Outdated Show resolved Hide resolved

sotopia/ui/README.md Outdated Show resolved Hide resolved

ProKil changed the title ~~api doc~~ doc: API endpoints for sotopia Nov 14, 2024

bugsz added 2 commits November 15, 2024 11:34

add api server with websocket as well as a client

ae7f7a8

fix mypy errors

f6aeecf

bugsz requested a review from ProKil November 15, 2024 21:02

bugsz added 3 commits November 17, 2024 13:04

support stopping the chat

ead08b4

add 404 to the status code

ed6e437

fix mypy issue

c345711

XuhuiZhou added the ui label Nov 20, 2024

XuhuiZhou and others added 5 commits November 20, 2024 14:21

remove files

cdc19ec

update requirement

1cb3759

update return message from the server

644249b

add restful error code

859eda2

Update README.md

2cc44cc

bugsz approved these changes Nov 21, 2024

View reviewed changes

ProKil approved these changes Nov 21, 2024

View reviewed changes

ProKil requested changes Nov 21, 2024

View reviewed changes

remove paks

80063cc

ProKil approved these changes Nov 22, 2024

View reviewed changes

ProKil merged commit 07ee2c4 into main Nov 22, 2024
9 checks passed

ProKil deleted the feature/sotopia-ui-doc branch November 22, 2024 01:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: API endpoints for sotopia #242

doc: API endpoints for sotopia #242

XuhuiZhou commented Oct 30, 2024 •

edited by ProKil

Loading

codecov bot commented Oct 30, 2024 •

edited

Loading

ProKil commented Oct 30, 2024

XuhuiZhou commented Oct 30, 2024 via email

ProKil commented Oct 31, 2024

XuhuiZhou commented Oct 31, 2024 via email

ProKil commented Oct 31, 2024 •

edited

Loading

XuhuiZhou commented Nov 8, 2024

ProKil left a comment

XuhuiZhou commented Nov 8, 2024

ProKil commented Nov 8, 2024

bugsz left a comment

ProKil Nov 21, 2024

ProKil Nov 21, 2024

doc: API endpoints for sotopia #242

doc: API endpoints for sotopia #242

Conversation

XuhuiZhou commented Oct 30, 2024 • edited by ProKil Loading

📑 Description

✅ Checks

ℹ Additional Information

codecov bot commented Oct 30, 2024 • edited Loading

Codecov Report

ProKil commented Oct 30, 2024

XuhuiZhou commented Oct 30, 2024 via email

ProKil commented Oct 31, 2024

XuhuiZhou commented Oct 31, 2024 via email

ProKil commented Oct 31, 2024 • edited Loading

XuhuiZhou commented Nov 8, 2024

ProKil left a comment

Choose a reason for hiding this comment

XuhuiZhou commented Nov 8, 2024

ProKil commented Nov 8, 2024

bugsz left a comment

Choose a reason for hiding this comment

ProKil Nov 21, 2024

Choose a reason for hiding this comment

ProKil Nov 21, 2024

Choose a reason for hiding this comment

XuhuiZhou commented Oct 30, 2024 •

edited by ProKil

Loading

codecov bot commented Oct 30, 2024 •

edited

Loading

ProKil commented Oct 31, 2024 •

edited

Loading