Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ProKil authored Nov 9, 2024
1 parent 1cddc10 commit 4cd747f
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions sotopia/ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ parameters:
returns:
- scenarios: list[EnvironmentProfile]

#### GET /get/agents
#### GET /agents

Get all agents.

returns:
- agents: list[AgentProfile]

#### GET /get/agents/?get_by={id|gender|occupation}/{value}
#### GET /agents/?get_by={id|gender|occupation}/{value}

Get agents by id, gender, or occupation.
parameters:
Expand All @@ -47,14 +47,14 @@ returns:
- agents: list[AgentProfile]


#### GET /get/episodes
#### GET /episodes

Get all episodes.

returns:
- episodes: list[Episode]

#### GET /get/episodes/?get_by={id|tag}/{episode_id|episode_tag}
#### GET /episodes/?get_by={id|tag}/{episode_id|episode_tag}

Get episode by episode_tag.
parameters:
Expand All @@ -67,7 +67,7 @@ returns:

### Sending Data to the API Server

w#### POST /post/agents/
#### POST /agents/

Send agent profile to the API server.
Request Body:
Expand All @@ -76,7 +76,7 @@ AgentProfile
returns:
- agent_id: str

#### POST /post/scenarios/
#### POST /scenarios/

Send scenario profile to the API server.
Request Body:
Expand All @@ -87,7 +87,7 @@ returns:

### Updating Data in the API Server

#### PUT /put/agents/{agent_id}
#### PUT /agents/{agent_id}

Update agent profile in the API server.
Request Body:
Expand All @@ -97,7 +97,7 @@ returns:
- agent_id: str


#### PUT /put/scenarios/{scenario_id}
#### PUT /scenarios/{scenario_id}

Update scenario profile in the API server.
Request Body:
Expand All @@ -108,7 +108,7 @@ returns:

### Initiating a new non-streaming simulation episode

#### POST /post/episodes/
#### POST /episodes/

```python
class SimulationEpisodeInitiation(BaseModel):
Expand Down

0 comments on commit 4cd747f

Please sign in to comment.