Skip to content

Commit 298551d

Browse files
fix(docs/retrievers): correct title and factory method calls
- retriever.md: rename title Retrievers → Retriever - All files: replace incorrect mf.Retriever.bm25() / mf.Retriever.wikipedia() with the actual API — mf.Retriever.lexical("bm25") / mf.Retriever.web("wikipedia") Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 3d10a7a commit 298551d

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

docs/learn/retrievers/bm25.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ All three share the same `add()` / `__call__()` / `acall()` interface.
2121
```python
2222
import msgflux as mf
2323

24-
retriever = mf.Retriever.bm25()
24+
retriever = mf.Retriever.lexical("bm25")
2525

2626
retriever.add([
2727
"Python is a high-level programming language.",
@@ -49,7 +49,7 @@ Pure Python implementation. No external packages required.
4949
```python
5050
import msgflux as mf
5151

52-
retriever = mf.Retriever.bm25(k1=1.5, b=0.75)
52+
retriever = mf.Retriever.lexical("bm25", k1=1.5, b=0.75)
5353
```
5454

5555
### `bm25s` — High-performance (scipy sparse matrices)
@@ -59,7 +59,7 @@ Uses the [`bm25s`](https://github.com/xhluca/bm25s) library. Significantly faste
5959
```python
6060
import msgflux as mf
6161

62-
retriever = mf.Retriever.bm25s(
62+
retriever = mf.Retriever.lexical("bm25s",
6363
k1=1.5,
6464
b=0.75,
6565
method="lucene", # "lucene" | "robertson" | "atire" | "bm25l" | "bm25+"
@@ -76,7 +76,7 @@ Uses [`rank-bm25`](https://github.com/dorianbrown/rank_bm25), a popular BM25 lib
7676
```python
7777
import msgflux as mf
7878

79-
retriever = mf.Retriever.rank_bm25(k1=1.5, b=0.75)
79+
retriever = mf.Retriever.lexical("rank_bm25", k1=1.5, b=0.75)
8080
```
8181

8282
Install: `pip install rank-bm25`
@@ -101,7 +101,7 @@ Call `.add()` with a list of strings before searching. Documents are indexed inc
101101
```python
102102
import msgflux as mf
103103

104-
retriever = mf.Retriever.bm25()
104+
retriever = mf.Retriever.lexical("bm25")
105105

106106
# First batch
107107
retriever.add([
@@ -136,7 +136,7 @@ response = retriever(
136136
```python
137137
import msgflux as mf
138138

139-
retriever = mf.Retriever.bm25()
139+
retriever = mf.Retriever.lexical("bm25")
140140
retriever.add([
141141
"Deep learning uses neural networks with many layers.",
142142
"The weather today is sunny and warm.",
@@ -160,7 +160,7 @@ response = retriever(
160160
```python
161161
import msgflux as mf
162162

163-
retriever = mf.Retriever.bm25()
163+
retriever = mf.Retriever.lexical("bm25")
164164
retriever.add([
165165
"Python is great for data science.",
166166
"Java is widely used in enterprise applications.",
@@ -184,7 +184,7 @@ Inspect how scores are distributed across your corpus for a given query:
184184
```python
185185
import msgflux as mf
186186

187-
retriever = mf.Retriever.bm25()
187+
retriever = mf.Retriever.lexical("bm25")
188188
retriever.add([
189189
"Machine learning automates pattern recognition.",
190190
"Deep learning is a subset of machine learning.",
@@ -211,7 +211,7 @@ Useful for choosing a `threshold` value — e.g. use `mean_score` to filter out
211211
```python
212212
import msgflux as mf
213213

214-
retriever = mf.Retriever.bm25()
214+
retriever = mf.Retriever.lexical("bm25")
215215
retriever.add([
216216
"Async Python enables non-blocking I/O.",
217217
"Asyncio is the standard async library.",

docs/learn/retrievers/retriever.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Retrievers
1+
# Retriever
22

33
## ✦₊⁺ Overview
44

@@ -20,7 +20,7 @@ There are two retriever families:
2020
```python
2121
import msgflux as mf
2222

23-
retriever = mf.Retriever.bm25()
23+
retriever = mf.Retriever.lexical("bm25")
2424

2525
retriever.add([
2626
"Python is a high-level programming language.",
@@ -40,7 +40,7 @@ There are two retriever families:
4040
```python
4141
import msgflux as mf
4242

43-
retriever = mf.Retriever.wikipedia(summary=2)
43+
retriever = mf.Retriever.web("wikipedia", summary=2)
4444

4545
response = retriever("quantum entanglement")
4646

@@ -91,7 +91,7 @@ Pass a list to search multiple queries in a single call. Results are returned in
9191
```python
9292
import msgflux as mf
9393

94-
retriever = mf.Retriever.bm25()
94+
retriever = mf.Retriever.lexical("bm25")
9595
retriever.add(["Doc A about Python", "Doc B about Java", "Doc C about Rust"])
9696

9797
queries = ["Python language", "systems programming"]
@@ -112,7 +112,7 @@ All retrievers expose `.acall()` for async usage:
112112
```python
113113
import msgflux as mf
114114

115-
retriever = mf.Retriever.wikipedia(summary=3)
115+
retriever = mf.Retriever.web("wikipedia", summary=3)
116116

117117
response = await retriever.acall("artificial intelligence", top_k=2)
118118

docs/learn/retrievers/wikipedia.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `wikipedia` retriever fetches and returns Wikipedia article content at query
1616
```python
1717
import msgflux as mf
1818

19-
retriever = mf.Retriever.wikipedia()
19+
retriever = mf.Retriever.web("wikipedia")
2020

2121
response = retriever("machine learning", top_k=2)
2222

@@ -45,7 +45,7 @@ The `wikipedia` retriever fetches and returns Wikipedia article content at query
4545
```python
4646
import msgflux as mf
4747

48-
retriever = mf.Retriever.wikipedia(
48+
retriever = mf.Retriever.web("wikipedia",
4949
language="en",
5050
summary=3, # Return only the first 3 sentences
5151
return_images=True,
@@ -64,7 +64,7 @@ By default, the full article content is returned. Set `summary` to an integer to
6464
```python
6565
import msgflux as mf
6666

67-
retriever = mf.Retriever.wikipedia(summary=2)
67+
retriever = mf.Retriever.web("wikipedia", summary=2)
6868

6969
response = retriever("Eiffel Tower")
7070

@@ -86,7 +86,7 @@ Enable `return_images=True` to get a list of image URLs from each article. Icons
8686
```python
8787
import msgflux as mf
8888

89-
retriever = mf.Retriever.wikipedia(
89+
retriever = mf.Retriever.web("wikipedia",
9090
return_images=True,
9191
max_return_images=3
9292
)
@@ -111,7 +111,7 @@ Set `language` to any Wikipedia language code:
111111
```python
112112
import msgflux as mf
113113

114-
retriever = mf.Retriever.wikipedia(language="pt", summary=3)
114+
retriever = mf.Retriever.web("wikipedia", language="pt", summary=3)
115115
response = retriever("inteligência artificial")
116116
print(response.data[0].results[0].data.content)
117117
```
@@ -121,7 +121,7 @@ Set `language` to any Wikipedia language code:
121121
```python
122122
import msgflux as mf
123123

124-
retriever = mf.Retriever.wikipedia(language="es", summary=3)
124+
retriever = mf.Retriever.web("wikipedia", language="es", summary=3)
125125
response = retriever("aprendizaje automático")
126126
print(response.data[0].results[0].data.content)
127127
```
@@ -131,7 +131,7 @@ Set `language` to any Wikipedia language code:
131131
```python
132132
import msgflux as mf
133133

134-
retriever = mf.Retriever.wikipedia(language="fr", summary=3)
134+
retriever = mf.Retriever.web("wikipedia", language="fr", summary=3)
135135
response = retriever("réseau de neurones")
136136
print(response.data[0].results[0].data.content)
137137
```
@@ -143,7 +143,7 @@ Set `language` to any Wikipedia language code:
143143
```python
144144
import msgflux as mf
145145

146-
retriever = mf.Retriever.wikipedia(summary=2)
146+
retriever = mf.Retriever.web("wikipedia", summary=2)
147147

148148
queries = ["Python programming", "Rust programming language", "Go programming"]
149149
response = retriever(queries, top_k=1)
@@ -165,7 +165,7 @@ A typical pattern: retrieve Wikipedia context, then pass it to an LLM:
165165
```python
166166
import msgflux as mf
167167

168-
retriever = mf.Retriever.wikipedia(summary=5)
168+
retriever = mf.Retriever.web("wikipedia", summary=5)
169169
chat = mf.Model.chat_completion("openai/gpt-4.1-mini")
170170

171171
def answer_with_wikipedia(question: str) -> str:
@@ -191,7 +191,7 @@ A typical pattern: retrieve Wikipedia context, then pass it to an LLM:
191191
```python
192192
import msgflux as mf
193193

194-
retriever = mf.Retriever.wikipedia(summary=3)
194+
retriever = mf.Retriever.web("wikipedia", summary=3)
195195

196196
queries = ["quantum computing", "photosynthesis", "black holes"]
197197
response = await retriever.acall(queries, top_k=1)

0 commit comments

Comments
 (0)