Spaces:
Sleeping
Sleeping
cotcotquedec
commited on
Commit
Β·
736b42c
1
Parent(s):
154ea17
docs(README): expand documentation for OpenWebUI Anthropic integration
Browse filesThe README.md file has been significantly updated to provide comprehensive documentation for integrating Anthropic's Claude models with OpenWebUI. The updated documentation includes sections on getting started, security, features, usage notes, limitations, and related links. This enhancement aims to improve user understanding and facilitate easier integration of the service.
The changes include detailed instructions on obtaining an Anthropic API key, configuring OpenWebUI, and understanding the service's capabilities and limitations. Additionally, security measures and usage notes are highlighted to ensure proper use of the service.
README.md
CHANGED
@@ -9,4 +9,79 @@ pinned: false
|
|
9 |
short_description: Pipeline backend for using Claude model
|
10 |
---
|
11 |
|
12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
9 |
short_description: Pipeline backend for using Claude model
|
10 |
---
|
11 |
|
12 |
+
|
13 |
+
# OpenWebUI Anthropic Integration π€
|
14 |
+
|
15 |
+
This space provides a backend service to use Anthropic's Claude models with OpenWebUI. It acts as an API compatibility layer between OpenWebUI and Anthropic's API.
|
16 |
+
|
17 |
+
## π Overview
|
18 |
+
|
19 |
+
This service allows you to use Claude models in OpenWebUI by providing an OpenAI-compatible API endpoint. It supports all Claude 3 models:
|
20 |
+
- claude-3-opus-20240229
|
21 |
+
- claude-3-sonnet-20240229
|
22 |
+
- claude-3-haiku-20240307
|
23 |
+
- claude-3-5-sonnet-20241022
|
24 |
+
|
25 |
+
## π Getting Started
|
26 |
+
|
27 |
+
### 1. Get Your Anthropic API Key
|
28 |
+
First, you'll need an Anthropic API key. You can get one from [Anthropic's website](https://console.anthropic.com/).
|
29 |
+
|
30 |
+
### 2. Configure OpenWebUI
|
31 |
+
|
32 |
+
In OpenWebUI's settings, add a new API endpoint with the following configuration:
|
33 |
+
|
34 |
+
1. Go to "Parameters" > "API compatibles OpenAI"
|
35 |
+
2. Set the API endpoint URL to:
|
36 |
+
```
|
37 |
+
https://cotcotquedec-openwebui-anthropic.hf.space
|
38 |
+
```
|
39 |
+
3. Add your Anthropic API key in the authorization field (as a Bearer token)
|
40 |
+
4. Save the configuration
|
41 |
+
|
42 |
+
The service will automatically fetch available models from:
|
43 |
+
```
|
44 |
+
https://cotcotquedec-openwebui-anthropic.hf.space/models
|
45 |
+
```
|
46 |
+
|
47 |
+
## π Security
|
48 |
+
|
49 |
+
- Your Anthropic API key is only used to authenticate requests to Anthropic's API
|
50 |
+
- The key is never stored or write anywhere
|
51 |
+
- All communication is encrypted via HTTPS
|
52 |
+
|
53 |
+
## π Features
|
54 |
+
|
55 |
+
- Compatible with OpenWebUI's interface
|
56 |
+
- Supports streaming responses
|
57 |
+
- Handles both chat completions and regular completions
|
58 |
+
- Automatic token management
|
59 |
+
|
60 |
+
## π Usage Notes
|
61 |
+
|
62 |
+
- The service acts as a proxy between OpenWebUI and Anthropic's API
|
63 |
+
- Response formats are automatically converted to be compatible with OpenWebUI
|
64 |
+
- All Claude model features are supported (including system prompts)
|
65 |
+
|
66 |
+
## β οΈ Limitations
|
67 |
+
|
68 |
+
- The service is designed specifically for OpenWebUI integration
|
69 |
+
- API calls require a valid Anthropic API key
|
70 |
+
- Usage is subject to Anthropic's rate limits and pricing
|
71 |
+
|
72 |
+
## π Related Links
|
73 |
+
|
74 |
+
- [Anthropic API Documentation](https://docs.anthropic.com/claude/docs)
|
75 |
+
- [OpenWebUI Documentation](https://docs.openwebui.com/)
|
76 |
+
- [Hugging Face Spaces Documentation](https://huggingface.co/docs/hub/spaces)
|
77 |
+
|
78 |
+
## π License
|
79 |
+
|
80 |
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
81 |
+
|
82 |
+
## β¨ Contributing
|
83 |
+
|
84 |
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
85 |
+
|
86 |
+
---
|
87 |
+
For more information about space configuration, check out the [Hugging Face Spaces configuration reference](https://huggingface.co/docs/hub/spaces-config-reference).
|