mirror of
https://github.com/BerriAI/litellm.git
synced 2026-10-09 03:18:44 +00:00
docs responses API Compact
This commit is contained in:
parent
3f720f0b56
commit
86199b213a
2 changed files with 112 additions and 1 deletions
104
docs/my-website/docs/response_api_compact.md
Normal file
104
docs/my-website/docs/response_api_compact.md
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# /responses/compact
|
||||
|
||||
Compress conversation history using OpenAI's `/responses/compact` endpoint.
|
||||
|
||||
| Feature | Supported |
|
||||
|---------|-----------|
|
||||
| Supported LiteLLM Versions | 1.72.0+ |
|
||||
| Supported Providers | `openai` |
|
||||
|
||||
## Usage
|
||||
|
||||
### LiteLLM Python SDK
|
||||
|
||||
```python showLineNumbers title="Compact Response"
|
||||
import litellm
|
||||
|
||||
response = litellm.compact_responses(
|
||||
model="openai/gpt-4o",
|
||||
input=[{"role": "user", "content": "Hello, how are you?"}],
|
||||
instructions="Be helpful",
|
||||
previous_response_id="resp_abc123" # optional
|
||||
)
|
||||
|
||||
print(response.id)
|
||||
print(response.object) # "response.compaction"
|
||||
print(response.output)
|
||||
```
|
||||
|
||||
### LiteLLM Proxy
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="curl" label="Curl">
|
||||
|
||||
```bash showLineNumbers title="Compact Request"
|
||||
curl http://localhost:4000/v1/responses/compact \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Authorization: Bearer sk-1234" \
|
||||
-d '{
|
||||
"model": "openai/gpt-4o",
|
||||
"input": [{"role": "user", "content": "Hello"}],
|
||||
"instructions": "Be helpful"
|
||||
}'
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="openai-sdk" label="OpenAI Python SDK">
|
||||
|
||||
```python showLineNumbers title="Compact with OpenAI SDK"
|
||||
import httpx
|
||||
|
||||
response = httpx.post(
|
||||
"http://localhost:4000/v1/responses/compact",
|
||||
headers={"Authorization": "Bearer sk-1234"},
|
||||
json={
|
||||
"model": "openai/gpt-4o",
|
||||
"input": [{"role": "user", "content": "Hello"}],
|
||||
"instructions": "Be helpful"
|
||||
}
|
||||
)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Request Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| `model` | string | Yes | Model to use for compaction |
|
||||
| `input` | string or array | Yes | Input messages to compact |
|
||||
| `instructions` | string | No | System instructions |
|
||||
| `previous_response_id` | string | No | ID of previous response to continue from |
|
||||
|
||||
## Response Format
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "resp_abc123",
|
||||
"object": "response.compaction",
|
||||
"created_at": 1734366691,
|
||||
"output": [
|
||||
{
|
||||
"type": "message",
|
||||
"role": "assistant",
|
||||
"content": [...]
|
||||
},
|
||||
{
|
||||
"type": "compaction",
|
||||
"encrypted_content": "..."
|
||||
}
|
||||
],
|
||||
"usage": {
|
||||
"input_tokens": 100,
|
||||
"output_tokens": 50,
|
||||
"total_tokens": 150
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -541,7 +541,14 @@ const sidebars = {
|
|||
},
|
||||
"realtime",
|
||||
"rerank",
|
||||
"response_api",
|
||||
{
|
||||
type: "category",
|
||||
label: "/responses",
|
||||
items: [
|
||||
"response_api",
|
||||
"response_api_compact",
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "/search",
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue