Install
$ agentstack add skill-omidzamani-dspy-skills-dspy-embedding-retrieval ✓ scanned · ✓ verified — works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
About
DSPy Embedding Retrieval
Goal
Build semantic retrieval over an application-owned text corpus with dspy.Embedder and dspy.Embeddings.
Basic Hosted Embedder
import dspy
corpus = [
"DSPy programs are composed from modules.",
"MIPROv2 optimizes instructions and demonstrations.",
"RLM explores large contexts with a sandboxed REPL.",
]
embedder = dspy.Embedder("openai/text-embedding-3-small")
search = dspy.Embeddings(corpus=corpus, embedder=embedder, k=2)
result = search("Which optimizer tunes prompts?")
print(result.passages)
print(result.indices)
Use in RAG
class LocalRAG(dspy.Module):
def __init__(self, retriever):
super().__init__()
self.retriever = retriever
self.answer = dspy.ChainOfThought("context: list[str], question -> answer")
def forward(self, question: str):
context = self.retriever(question).passages
return self.answer(context=context, question=question)
Custom Local Embeddings
Wrap any callable that accepts list[str] and returns a 2D numeric array:
from sentence_transformers import SentenceTransformer
import dspy
model = SentenceTransformer("sentence-transformers/static-retrieval-mrl-en-v1")
embedder = dspy.Embedder(model.encode)
search = dspy.Embeddings(corpus=corpus, embedder=embedder, k=5)
Scores, FAISS, and Persistence
Use dspy.EmbeddingsWithScores when downstream logic needs similarity thresholds or reranking.
For corpora at or above the brute_force_threshold default of 20_000, DSPy builds a FAISS index. Install FAISS first:
pip install faiss-cpu
Persist the index when embedding the corpus is expensive:
search.save("./retrieval-index")
loaded = dspy.Embeddings.from_saved("./retrieval-index", embedder=embedder)
Related Skills
- Build a complete pipeline: [dspy-rag-pipeline](../dspy-rag-pipeline/SKILL.md)
- Design typed context fields: [dspy-signature-designer](../dspy-signature-designer/SKILL.md)
- Harden caches: [dspy-production-deployment](../dspy-production-deployment/SKILL.md)
Best Practices
- Evaluate retrieval quality separately from answer quality.
- Keep corpus chunking deterministic and versioned.
- Persist expensive indexes.
- Use
EmbeddingsWithScoreswhen debugging relevance. - Measure memory and latency before enabling FAISS for large corpora.
Official Documentation
- Embedder API: https://dspy.ai/api/models/Embedder/
- Embeddings API: https://dspy.ai/api/tools/Embeddings/
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: OmidZamani
- Source: OmidZamani/dspy-skills
- License: MIT
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet — be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.