Skip to content

Commit 60120cf

Browse files
committed
doc fixes
1 parent d7e0b3e commit 60120cf

File tree

2 files changed

+35
-23
lines changed

2 files changed

+35
-23
lines changed

docs/enterprise/guardrails.mdx

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,21 @@ Bifrost integrates with leading guardrail providers to offer comprehensive prote
154154
- Custom policy templates
155155
- Integration with existing safety workflows
156156

157+
### Additional Guardrail Providers
158+
159+
Beyond the natively integrated providers above, the following guardrail solutions are available in the ecosystem:
160+
161+
- **Guardrails AI** - Open-source framework with validators for hallucination prevention, content moderation, and PII detection
162+
- **Lakera (Lakera Guard)** - Enterprise security platform for prompt injection, jailbreak, and data leakage protection
163+
- **Aporia** - Multi-modal guardrails (audio, vision, text) with 20+ pre-configured policies
164+
- **Lasso Security** - Real-time GenAI security with contextual data protection and custom policy wizard
165+
- **PromptArmor** - LLM security and compliance platform
166+
- **WhyLabs** - LLM security and observability platform with real-time guardrails and monitoring
167+
- **CalypsoAI** - Model-agnostic AI security platform with customizable scanners
168+
- **NeuralTrust** - LLM firewall specializing in prompt injection prevention
169+
- **Vigil** - Open-source prompt-level security tool
170+
- **Confident AI** - Red-teaming platform with LLM guardrail capabilities (DeepTeam)
171+
157172
---
158173

159174
## Guardrail Rules
@@ -389,7 +404,7 @@ request.model.startsWith("gpt-4") && request.messages.exists(m, m.role == "user"
389404
Rules can be linked to multiple profiles for comprehensive validation:
390405

391406
<Frame>
392-
<img src="/media/guardrails/rule-profile-link.png" alt="Rule configuration showing linked profiles" />
407+
<img src="/media/guardrails/query-creation.png" alt="Rule configuration showing linked profiles" />
393408
</Frame>
394409

395410
**Best Practices:**
@@ -405,7 +420,7 @@ Rules can be linked to multiple profiles for comprehensive validation:
405420
Profiles are reusable configurations for external guardrail providers. Each profile contains provider-specific settings including credentials, endpoints, and detection thresholds.
406421

407422
<Frame>
408-
<img src="/media/guardrails/profiles-list.png" alt="Guardrail profiles list showing configured providers" />
423+
<img src="/media/guardrails/provider-aws-create.png" alt="Guardrail profiles list showing configured providers" />
409424
</Frame>
410425

411426
### Profile Properties

docs/features/semantic-caching.mdx

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ Semantic caching uses vector similarity search to intelligently cache AI respons
2727

2828
## Vector Store Setup
2929

30+
Semantic caching requires a configured vector store. Bifrost supports the following vector databases:
31+
32+
- **[Weaviate](/architecture/framework/vector-store#weaviate)**: Production-ready vector database with gRPC support
33+
- **[Redis](/architecture/framework/vector-store#redis)**: High-performance in-memory vector store using RediSearch
34+
- **[Qdrant](/architecture/framework/vector-store#qdrant)**: Rust-based vector search engine with advanced filtering
35+
- **[Pinecone](/architecture/framework/vector-store#pinecone)**: Managed vector database service with serverless options
36+
37+
<Info>
38+
For detailed setup instructions and configuration options for each vector store, see the [Vector Store documentation](/architecture/framework/vector-store).
39+
</Info>
40+
41+
**Quick Example (Weaviate):**
42+
3043
<Tabs group="vector-store-setup">
3144

3245
<Tab title="Go SDK">
@@ -35,16 +48,15 @@ Semantic caching uses vector similarity search to intelligently cache AI respons
3548
import (
3649
"context"
3750
"github.com/maximhq/bifrost/framework/vectorstore"
38-
"github.com/maximhq/bifrost/core/schemas"
3951
)
4052

41-
// Configure vector store
53+
// Configure vector store (example: Weaviate)
4254
vectorConfig := &vectorstore.Config{
4355
Enabled: true,
4456
Type: vectorstore.VectorStoreTypeWeaviate,
4557
Config: vectorstore.WeaviateConfig{
46-
Scheme: "http",
47-
Host: "localhost:8080",
58+
Scheme: "http",
59+
Host: "localhost:8080",
4860
},
4961
}
5062

@@ -66,22 +78,7 @@ if err != nil {
6678
"type": "weaviate",
6779
"config": {
6880
"host": "localhost:8080",
69-
"scheme": "http",
70-
}
71-
}
72-
}
73-
```
74-
75-
**For Weaviate Cloud:**
76-
```json
77-
{
78-
"vector_store": {
79-
"enabled": true,
80-
"type": "weaviate",
81-
"config": {
82-
"host": "your-cluster.weaviate.network",
83-
"scheme": "https",
84-
"api_key": "your-weaviate-api-key"
81+
"scheme": "http"
8582
}
8683
}
8784
}
@@ -515,5 +512,5 @@ The semantic cache namespace and all its cache entries are deleted when Bifrost
515512
---
516513

517514
<Info>
518-
**Vector Store Requirement**: Semantic caching requires a configured vector store (currently Weaviate only). Without vector store setup, the plugin will not function.
515+
**Vector Store Requirement**: Semantic caching requires a configured vector store. Bifrost supports Weaviate, Redis, Qdrant, and Pinecone. See the [Vector Store documentation](/architecture/framework/vector-store) for setup details.
519516
</Info>

0 commit comments

Comments
 (0)