Skip to content

Commit

Permalink
Separated list_agents() from session management (#4111)
Browse files Browse the repository at this point in the history
### What problem does this PR solve?


### Type of change

- [x] Documentation Update
  • Loading branch information
writinwaters authored Dec 19, 2024
1 parent 57c99dd commit 8939206
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 21 deletions.
38 changes: 18 additions & 20 deletions docs/references/http_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ curl --request GET \

Success:

```text
```json
This is a test to verify the file download feature.
```

Expand Down Expand Up @@ -1702,7 +1702,7 @@ Failure:

---

## CHAT SESSIONS
## SESSION MANAGEMENT

---

Expand Down Expand Up @@ -1772,13 +1772,13 @@ Failure:
```json
{
"code": 102,
"message": "Name can not be empty."
"message": "Name cannot be empty."
}
```

---

### Update session
### Update chat assistant's session

**PUT** `/api/v1/chats/{chat_id}/sessions/{session_id}`

Expand Down Expand Up @@ -1813,7 +1813,7 @@ curl --request PUT \
The ID of the associated chat assistant.
- `session_id`: (*Path parameter*)
The ID of the session to update.
- `"name"`: (*Body Parameter), `string`
- `"name"`: (*Body Parameter*), `string`
The revised name of the session.

#### Response
Expand All @@ -1837,7 +1837,7 @@ Failure:

---

### List sessions
### List chat assistant's sessions

**GET** `/api/v1/chats/{chat_id}/sessions?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={session_name}&id={session_id}`

Expand Down Expand Up @@ -1915,7 +1915,7 @@ Failure:

---

### Delete sessions
### Delete chat assistant's sessions

**DELETE** `/api/v1/chats/{chat_id}/sessions`

Expand Down Expand Up @@ -1979,18 +1979,15 @@ Failure:
Asks a specified chat assistant a question to start an AI-powered conversation.

:::tip NOTE

- In streaming mode, not all responses include a reference, as this depends on the system's judgement.
- In streaming mode, the last message is an empty message:

```text
```json
data:
{
"code": 0,
"data": true
}
```

:::

#### Request
Expand Down Expand Up @@ -2045,7 +2042,7 @@ curl --request POST \
#### Response

Success without `session_id`:
```text
```json
data:{
"code": 0,
"message": "",
Expand All @@ -2066,7 +2063,7 @@ data:{

Success with `session_id`:

```text
```json
data:{
"code": 0,
"data": {
Expand Down Expand Up @@ -2305,18 +2302,15 @@ Failure:
Asks a specified agent a question to start an AI-powered conversation.

:::tip NOTE

- In streaming mode, not all responses include a reference, as this depends on the system's judgement.
- In streaming mode, the last message is an empty message:

```text
```json
data:
{
"code": 0,
"data": true
}
```

:::

#### Request
Expand Down Expand Up @@ -2383,7 +2377,7 @@ curl --request POST \
The parameters in the begin component.
#### Response
success without `session_id` provided and with no parameters in the `begin` component:
```text
```json
data:{
"code": 0,
"message": "",
Expand All @@ -2402,7 +2396,7 @@ data:{
```
Success with `session_id` provided and with no parameters in the `begin` component:

```text
```json
data:{
"code": 0,
"message": "",
Expand Down Expand Up @@ -2509,7 +2503,7 @@ data:{
}
```
Success with parameters in the `begin` component:
```text
```json
data:{
"code": 0,
"message": "",
Expand Down Expand Up @@ -2791,6 +2785,10 @@ Failure:

---

## AGENT MANAGEMENT

---

### List agents

**GET** `/api/v1/agents?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={agent_name}&id={agent_id}`
Expand Down
6 changes: 5 additions & 1 deletion docs/references/python_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1139,7 +1139,7 @@ for assistant in rag_object.list_chats():

---

## CHAT SESSIONS
## SESSION MANAGEMENT

---

Expand Down Expand Up @@ -1576,6 +1576,10 @@ for session in sessions:

---

## AGENT MANAGEMENT

---

### List agents

```python
Expand Down

0 comments on commit 8939206

Please sign in to comment.