add mock requests to docs

This commit is contained in:
Krrish Dholakia
2023-09-11 12:24:19 -07:00
parent 6da500c6e0
commit 8aefab1969
2 changed files with 41 additions and 1 deletions
@@ -0,0 +1,39 @@
# Mock Requests
For testing purposes, you can set `mock_requests=True` while calling the completion endpoint.
This will return a response object with a default response, without calling the LLM APIs.
```python
from litellm import completion
model = "gpt-3.5-turbo"
messages = [{"role":"user", "content":"This is a test request"}]
completion(model=model, messages=messages, mock_request=True)
```
## Mock Response Object
```
{
"choices": [
{
"finish_reason": "stop",
"index": 0,
"message": {
"content": "This is a mock request",
"role": "assistant",
"logprobs": null
}
}
],
"created": 1694459929.4496052,
"model": "MockResponse",
"usage": {
"prompt_tokens": null,
"completion_tokens": null,
"total_tokens": null
}
}
```
+2 -1
View File
@@ -34,7 +34,8 @@ const sidebars = {
"completion/model_alias",
"completion/reliable_completions",
"completion/stream",
"completion/batching"
"completion/batching",
"completion/mock_requests",
],
},
{