Update AGENT_USAGE.md
Browse files- AGENT_USAGE.md +11 -3
AGENT_USAGE.md
CHANGED
|
@@ -19,12 +19,19 @@ All endpoints below are relative to this base URL.
|
|
| 19 |
- **Path**: `/chat`
|
| 20 |
- **Description**: General chat/completions endpoint, similar to OpenAI Chat Completions.
|
| 21 |
|
| 22 |
-
**Request JSON:**
|
| 23 |
|
| 24 |
```json
|
| 25 |
{
|
| 26 |
"messages": [
|
| 27 |
-
{
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
],
|
| 29 |
"temperature": 1.0,
|
| 30 |
"top_p": 1.0,
|
|
@@ -34,7 +41,8 @@ All endpoints below are relative to this base URL.
|
|
| 34 |
|
| 35 |
- `messages`:
|
| 36 |
- Array of objects with `role` (`"user"`, `"assistant"`, `"system"`) and `content` (string).
|
| 37 |
-
-
|
|
|
|
| 38 |
- `temperature`, `top_p`, `max_tokens` are optional; if omitted, defaults are used.
|
| 39 |
|
| 40 |
**Response JSON:**
|
|
|
|
| 19 |
- **Path**: `/chat`
|
| 20 |
- **Description**: General chat/completions endpoint, similar to OpenAI Chat Completions.
|
| 21 |
|
| 22 |
+
**Request JSON (with optional system prompt):**
|
| 23 |
|
| 24 |
```json
|
| 25 |
{
|
| 26 |
"messages": [
|
| 27 |
+
{
|
| 28 |
+
"role": "system",
|
| 29 |
+
"content": "You are a helpful assistant that answers briefly."
|
| 30 |
+
},
|
| 31 |
+
{
|
| 32 |
+
"role": "user",
|
| 33 |
+
"content": "Your question here"
|
| 34 |
+
}
|
| 35 |
],
|
| 36 |
"temperature": 1.0,
|
| 37 |
"top_p": 1.0,
|
|
|
|
| 41 |
|
| 42 |
- `messages`:
|
| 43 |
- Array of objects with `role` (`"user"`, `"assistant"`, `"system"`) and `content` (string).
|
| 44 |
+
- Include one or more **`system` messages at the start** to control behavior (system prompting).
|
| 45 |
+
- Append `user` and `assistant` messages to maintain conversation history.
|
| 46 |
- `temperature`, `top_p`, `max_tokens` are optional; if omitted, defaults are used.
|
| 47 |
|
| 48 |
**Response JSON:**
|