mirror of https://github.com/All-Hands-AI/OpenHands.git synced 2026-04-29 03:00:45 -04:00

Files

Robert Brennan 5bdacf738d Refactor session management (#1810 )

* refactor session mgmt

* defer file handling to runtime

* add todo

* refactor sessions a bit more

* remove messages logic from FE

* fix up socket handshake

* refactor frontend auth a bit

* first pass at redoing file explorer

* implement directory suffix

* fix up file tree

* close agent on websocket close

* remove session saving

* move file refresh

* remove getWorkspace

* plumb path/code differently

* fix build issues

* fix the tests

* fix npm build

* add session rehydration

* fix event serialization

* logspam

* fix user message rehydration

* add get_event fn

* agent state restoration

* change history tracking for codeact

* fix responsiveness of init

* fix lint

* lint

* delint

* fix prop

* update tests

* logspam

* lint

* fix test

* revert codeact

* change fileService to use API

* fix up session loading

* delint

* delint

* fix integration tests

* revert test

* fix up access to options endpoints

* fix initial files load

* delint

* fix file initialization

* fix mock server

* fixl int

* fix auth for html

* Update frontend/src/i18n/translation.json

Co-authored-by: Xingyao Wang <xingyao6@illinois.edu>

* refactor sessions and sockets

* avoid reinitializing the same session

* fix reconnect issue

* change up intro message

* more guards on reinit

* rename agent_session

* delint

* fix a bunch of tests

* delint

* fix last test

* remove code editor context

* fix build

* fix any

* fix dot notation

* Update frontend/src/services/api.ts

Co-authored-by: Boxuan Li <liboxuan@connect.hku.hk>

* fix up error handling

* Update opendevin/server/session/agent.py

Co-authored-by: Boxuan Li <liboxuan@connect.hku.hk>

* Update opendevin/server/session/agent.py

Co-authored-by: Boxuan Li <liboxuan@connect.hku.hk>

* Update frontend/src/services/session.ts

Co-authored-by: Boxuan Li <liboxuan@connect.hku.hk>

* fix build errs

* fix else

* add closed state

* delint

* Update opendevin/server/session/session.py

Co-authored-by: Engel Nyst <enyst@users.noreply.github.com>

---------

Co-authored-by: Xingyao Wang <xingyao6@illinois.edu>
Co-authored-by: Graham Neubig <neubig@gmail.com>
Co-authored-by: Boxuan Li <liboxuan@connect.hku.hk>
Co-authored-by: Engel Nyst <enyst@users.noreply.github.com>

2024-05-22 18:33:16 +00:00

auth

Refactor session management (#1810 )

2024-05-22 18:33:16 +00:00

mock

Refactor session management (#1810 )

2024-05-22 18:33:16 +00:00

session

Refactor session management (#1810 )

2024-05-22 18:33:16 +00:00

__init__.py

feat: websocket connection management and sandbox bound to session. (#559 )

2024-04-05 12:19:52 -05:00

listen.py

Refactor session management (#1810 )

2024-05-22 18:33:16 +00:00

README.md

Default to less expensive gpt-3.5-turbo model (#1675 )

2024-05-09 19:11:27 -04:00

README.md

OpenDevin Server

This is a WebSocket server that executes tasks using an agent.

Install

Follow the instructions in the base README.md to install dependencies and set up.

Start the Server

uvicorn opendevin.server.listen:app --reload --port 3000

Test the Server

You can use websocat to test the server: https://github.com/vi/websocat

websocat ws://127.0.0.1:3000/ws
{"action": "start", "args": {"task": "write a bash script that prints hello"}}

Supported Environment Variables

LLM_API_KEY=sk-... # Your OpenAI API Key
LLM_MODEL=gpt-3.5-turbo # Default model for the agent to use
WORKSPACE_BASE=/path/to/your/workspace # Default path to model's workspace

API Schema

There are two types of messages that can be sent to, or received from, the server:

Actions
Observations

Actions

An action has three parts:

action: The action to be taken
args: The arguments for the action
message: A friendly message that can be put in the chat log

There are several kinds of actions. Their arguments are listed below. This list may grow over time.

initialize - initializes the agent. Only sent by client.
- model - the name of the model to use
- directory - the path to the workspace
- agent_cls - the class of the agent to use
start - starts a new development task. Only sent by the client.
- task - the task to start
read - reads the content of a file.
- path - the path of the file to read
write - writes the content to a file.
- path - the path of the file to write
- content - the content to write to the file
run - runs a command.
- command - the command to run
- background - if true, run the command in the background
kill - kills a background command
- id - the ID of the background command to kill
browse - opens a web page.
- url - the URL to open
recall - searches long-term memory
- query - the query to search for
think - Allows the agent to make a plan, set a goal, or record thoughts
- thought - the thought to record
finish - agent signals that the task is completed

Observations

An observation has four parts:

observation: The observation type
content: A string representing the observed data
extras: additional structured data
message: A friendly message that can be put in the chat log

There are several kinds of observations. Their extras are listed below. This list may grow over time.

read - the content of a file
- path - the path of the file read
browse - the HTML content of a url
- url - the URL opened
run - the output of a command
- command - the command run
- exit_code - the exit code of the command
recall - the result of a search
- query - the query searched for
chat - a message from the user