mirror of
https://github.com/BerriAI/litellm.git
synced 2025-04-27 11:43:54 +00:00
docs(assistants.md): add openai-compatible assistants api example to docs
This commit is contained in:
parent
04628ccd75
commit
0f2ec6c0e9
1 changed files with 29 additions and 0 deletions
|
@ -26,6 +26,7 @@ Call an existing Assistant.
|
||||||
|
|
||||||
- Run the Assistant on the Thread to generate a response by calling the model and the tools.
|
- Run the Assistant on the Thread to generate a response by calling the model and the tools.
|
||||||
|
|
||||||
|
### SDK + PROXY
|
||||||
<Tabs>
|
<Tabs>
|
||||||
<TabItem value="sdk" label="SDK">
|
<TabItem value="sdk" label="SDK">
|
||||||
|
|
||||||
|
@ -281,3 +282,31 @@ curl -X POST 'http://0.0.0.0:4000/threads/{thread_id}/runs' \
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
## [👉 Proxy API Reference](https://litellm-api.up.railway.app/#/assistants)
|
## [👉 Proxy API Reference](https://litellm-api.up.railway.app/#/assistants)
|
||||||
|
|
||||||
|
## OpenAI-Compatible APIs
|
||||||
|
|
||||||
|
To call openai-compatible Assistants API's (eg. Astra Assistants API), just add `openai/` to the model name:
|
||||||
|
|
||||||
|
|
||||||
|
**config**
|
||||||
|
```yaml
|
||||||
|
assistant_settings:
|
||||||
|
custom_llm_provider: openai
|
||||||
|
litellm_params:
|
||||||
|
api_key: os.environ/ASTRA_API_KEY
|
||||||
|
api_base: os.environ/ASTRA_API_BASE
|
||||||
|
```
|
||||||
|
|
||||||
|
**curl**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:4000/v1/assistants" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-H "Authorization: Bearer sk-1234" \
|
||||||
|
-d '{
|
||||||
|
"instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
|
||||||
|
"name": "Math Tutor",
|
||||||
|
"tools": [{"type": "code_interpreter"}],
|
||||||
|
"model": "openai/<my-astra-model-name>"
|
||||||
|
}'
|
||||||
|
```
|
Loading…
Add table
Add a link
Reference in a new issue