Skip to content

Commit fa9117f

Browse files
micpstmicpst
committed
rename document meta create_text_document_from_literal to from_literal
1 parent aac48f8 commit fa9117f

File tree

20 files changed

+83
-89
lines changed

20 files changed

+83
-89
lines changed

‎docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ from ragbits.document_search import DocumentSearch
8484
from ragbits.document_search.documents.document import DocumentMeta
8585

8686
documents = [
87-
DocumentMeta.create_text_document_from_literal("RIP boiled water. You will be mist."),
88-
DocumentMeta.create_text_document_from_literal(
87+
DocumentMeta.from_literal("RIP boiled water. You will be mist."),
88+
DocumentMeta.from_literal(
8989
"Why doesn't James Bond fart in bed? Because it would blow his cover."
9090
),
91-
DocumentMeta.create_text_document_from_literal(
91+
DocumentMeta.from_literal(
9292
"Why programmers don't like to swim? Because they're scared of the floating points."
9393
),
9494
]

‎examples/document-search/basic.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,22 @@
4141
set_trace_handlers("cli")
4242

4343
documents = [
44-
DocumentMeta.create_text_document_from_literal(
44+
DocumentMeta.from_literal(
4545
"""
4646
RIP boiled water. You will be mist.
4747
"""
4848
),
49-
DocumentMeta.create_text_document_from_literal(
49+
DocumentMeta.from_literal(
5050
"""
5151
Why doesn't James Bond fart in bed? Because it would blow his cover.
5252
"""
5353
),
54-
DocumentMeta.create_text_document_from_literal(
54+
DocumentMeta.from_literal(
5555
"""
5656
Why programmers don't like to swim? Because they're scared of the floating points.
5757
"""
5858
),
59-
DocumentMeta.create_text_document_from_literal(
59+
DocumentMeta.from_literal(
6060
"""
6161
This one is completely unrelated.
6262
"""

‎examples/document-search/chroma.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,22 @@
4545
set_trace_handlers("cli")
4646

4747
documents = [
48-
DocumentMeta.create_text_document_from_literal(
48+
DocumentMeta.from_literal(
4949
"""
5050
RIP boiled water. You will be mist.
5151
"""
5252
),
53-
DocumentMeta.create_text_document_from_literal(
53+
DocumentMeta.from_literal(
5454
"""
5555
Why doesn't James Bond fart in bed? Because it would blow his cover.
5656
"""
5757
),
58-
DocumentMeta.create_text_document_from_literal(
58+
DocumentMeta.from_literal(
5959
"""
6060
Why programmers don't like to swim? Because they're scared of the floating points.
6161
"""
6262
),
63-
DocumentMeta.create_text_document_from_literal(
63+
DocumentMeta.from_literal(
6464
"""
6565
This one is completely unrelated.
6666
"""

‎examples/document-search/configurable.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,22 @@ class to rephrase the query.
3737
set_trace_handlers("cli")
3838

3939
documents = [
40-
DocumentMeta.create_text_document_from_literal(
40+
DocumentMeta.from_literal(
4141
"""
4242
RIP boiled water. You will be mist.
4343
"""
4444
),
45-
DocumentMeta.create_text_document_from_literal(
45+
DocumentMeta.from_literal(
4646
"""
4747
Why doesn't James Bond fart in bed? Because it would blow his cover.
4848
"""
4949
),
50-
DocumentMeta.create_text_document_from_literal(
50+
DocumentMeta.from_literal(
5151
"""
5252
Why programmers don't like to swim? Because they're scared of the floating points.
5353
"""
5454
),
55-
DocumentMeta.create_text_document_from_literal(
55+
DocumentMeta.from_literal(
5656
"""
5757
This one is completely unrelated.
5858
"""

‎examples/document-search/distributed.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,22 +56,22 @@
5656
from ragbits.document_search.ingestion.strategies import RayDistributedIngestStrategy
5757

5858
documents = [
59-
DocumentMeta.create_text_document_from_literal(
59+
DocumentMeta.from_literal(
6060
"""
6161
RIP boiled water. You will be mist.
6262
"""
6363
),
64-
DocumentMeta.create_text_document_from_literal(
64+
DocumentMeta.from_literal(
6565
"""
6666
Why doesn't James Bond fart in bed? Because it would blow his cover.
6767
"""
6868
),
69-
DocumentMeta.create_text_document_from_literal(
69+
DocumentMeta.from_literal(
7070
"""
7171
Why programmers don't like to swim? Because they're scared of the floating points.
7272
"""
7373
),
74-
DocumentMeta.create_text_document_from_literal(
74+
DocumentMeta.from_literal(
7575
"""
7676
This one is completely unrelated.
7777
"""

‎examples/document-search/multimodal.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
DocumentMeta(document_type=DocumentType.JPG, source=LocalFileSource(path=IMAGES_PATH / "bear.jpg")),
5050
DocumentMeta(document_type=DocumentType.JPG, source=LocalFileSource(path=IMAGES_PATH / "game.jpg")),
5151
DocumentMeta(document_type=DocumentType.JPG, source=LocalFileSource(path=IMAGES_PATH / "tree.jpg")),
52-
DocumentMeta.create_text_document_from_literal("A beautiful teady bear."),
53-
DocumentMeta.create_text_document_from_literal("The constitution of the United States."),
52+
DocumentMeta.from_literal("A beautiful teady bear."),
53+
DocumentMeta.from_literal("The constitution of the United States."),
5454
]
5555

5656

‎examples/document-search/pgvector.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,22 +52,22 @@
5252
set_trace_handlers("cli")
5353

5454
documents = [
55-
DocumentMeta.create_text_document_from_literal(
55+
DocumentMeta.from_literal(
5656
"""
5757
RIP boiled water. You will be mist.
5858
"""
5959
),
60-
DocumentMeta.create_text_document_from_literal(
60+
DocumentMeta.from_literal(
6161
"""
6262
Why doesn't James Bond fart in bed? Because it would blow his cover.
6363
"""
6464
),
65-
DocumentMeta.create_text_document_from_literal(
65+
DocumentMeta.from_literal(
6666
"""
6767
Why programmers don't like to swim? Because they're scared of the floating points.
6868
"""
6969
),
70-
DocumentMeta.create_text_document_from_literal(
70+
DocumentMeta.from_literal(
7171
"""
7272
This one is completely unrelated.
7373
"""

‎examples/document-search/qdrant.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,22 @@
4545
set_trace_handlers("cli")
4646

4747
documents = [
48-
DocumentMeta.create_text_document_from_literal(
48+
DocumentMeta.from_literal(
4949
"""
5050
RIP boiled water. You will be mist.
5151
"""
5252
),
53-
DocumentMeta.create_text_document_from_literal(
53+
DocumentMeta.from_literal(
5454
"""
5555
Why doesn't James Bond fart in bed? Because it would blow his cover.
5656
"""
5757
),
58-
DocumentMeta.create_text_document_from_literal(
58+
DocumentMeta.from_literal(
5959
"""
6060
Why programmers don't like to swim? Because they're scared of the floating points.
6161
"""
6262
),
63-
DocumentMeta.create_text_document_from_literal(
63+
DocumentMeta.from_literal(
6464
"""
6565
This one is completely unrelated.
6666
"""

‎packages/ragbits-core/tests/integration/vector_stores/test_vector_store.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ async def test_handling_document_ingestion_with_different_content_and_verifying_
230230
document_2_content = "This is another test sentence and it should be removed from the vector store"
231231
document_2_new_content = "This is one more test sentence and it should be added to the vector store"
232232

233-
document_1 = DocumentMeta.create_text_document_from_literal(document_1_content)
234-
document_2 = DocumentMeta.create_text_document_from_literal(document_2_content)
233+
document_1 = DocumentMeta.from_literal(document_1_content)
234+
document_2 = DocumentMeta.from_literal(document_2_content)
235235

236236
document_search: DocumentSearch = DocumentSearch(
237237
vector_store=text_vector_store,

‎packages/ragbits-document-search/src/ragbits/document_search/documents/document.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ async def fetch(self) -> "Document":
7676
return Document.from_document_meta(self, local_path)
7777

7878
@classmethod
79-
def create_text_document_from_literal(cls, content: str) -> "DocumentMeta":
79+
def from_literal(cls, content: str) -> "DocumentMeta":
8080
"""
8181
Create a text document from a literal content.
8282

‎packages/ragbits-document-search/tests/integration/test_docling.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
("document_metadata", "expected_num_elements"),
1111
[
1212
pytest.param(
13-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George."),
13+
DocumentMeta.from_literal("Name of Peppa's brother is George."),
1414
1,
1515
id="TextDocument",
1616
),

‎packages/ragbits-document-search/tests/integration/test_rerankers.py

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,9 @@
1414

1515
ELEMENTS = [
1616
[
17-
TextElement(
18-
content="Element 1", document_meta=DocumentMeta.create_text_document_from_literal("Mock document 1")
19-
),
20-
TextElement(
21-
content="Element 2", document_meta=DocumentMeta.create_text_document_from_literal("Mock document 1")
22-
),
23-
TextElement(
24-
content="Element 3", document_meta=DocumentMeta.create_text_document_from_literal("Mock document 1")
25-
),
17+
TextElement(content="Element 1", document_meta=DocumentMeta.from_literal("Mock document 1")),
18+
TextElement(content="Element 2", document_meta=DocumentMeta.from_literal("Mock document 1")),
19+
TextElement(content="Element 3", document_meta=DocumentMeta.from_literal("Mock document 1")),
2620
]
2721
]
2822

‎packages/ragbits-document-search/tests/integration/test_unstructured.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
("document_metadata", "expected_num_elements"),
3434
[
3535
pytest.param(
36-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George."),
36+
DocumentMeta.from_literal("Name of Peppa's brother is George."),
3737
1,
3838
id="TextDocument",
3939
),

‎packages/ragbits-document-search/tests/unit/test_document_search.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@
4242
("document", "expected"),
4343
[
4444
(
45-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George"),
45+
DocumentMeta.from_literal("Name of Peppa's brother is George"),
4646
"Name of Peppa's brother is George",
4747
),
4848
(
4949
Document.from_document_meta(
50-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George"), Path("test.txt")
50+
DocumentMeta.from_literal("Name of Peppa's brother is George"), Path("test.txt")
5151
),
5252
"Name of Peppa's brother is George",
5353
),
@@ -88,9 +88,9 @@ async def test_document_search_ingest_from_source():
8888
@pytest.mark.parametrize(
8989
"document",
9090
[
91-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George"),
91+
DocumentMeta.from_literal("Name of Peppa's brother is George"),
9292
Document.from_document_meta(
93-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George"),
93+
DocumentMeta.from_literal("Name of Peppa's brother is George"),
9494
Path("test.txt"),
9595
),
9696
],
@@ -125,7 +125,7 @@ async def test_document_search_with_search_config():
125125
vector_store=InMemoryVectorStore(embedder=embeddings_mock),
126126
parser_router=DocumentParserRouter({DocumentType.TXT: TextDocumentParser()}),
127127
)
128-
await document_search.ingest([DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George")])
128+
await document_search.ingest([DocumentMeta.from_literal("Name of Peppa's brother is George")])
129129

130130
results = await document_search.search(
131131
"Peppa's brother", options=DocumentSearchOptions(vector_store_options=VectorStoreOptions(k=1))
@@ -157,9 +157,9 @@ async def retrieve(self, text: str, options: VectorStoreOptions | None = None) -
157157

158158
# Ingest multiple documents
159159
documents = [
160-
DocumentMeta.create_text_document_from_literal("First document about Peppa"),
161-
DocumentMeta.create_text_document_from_literal("Second document about George"),
162-
DocumentMeta.create_text_document_from_literal("Third document about Peppa and George"),
160+
DocumentMeta.from_literal("First document about Peppa"),
161+
DocumentMeta.from_literal("Second document about George"),
162+
DocumentMeta.from_literal("Third document about Peppa and George"),
163163
]
164164
await document_search.ingest(documents)
165165

@@ -196,18 +196,18 @@ async def test_document_search_ingest_multiple_from_sources():
196196

197197
async def test_document_search_with_batched():
198198
documents = [
199-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George"),
200-
DocumentMeta.create_text_document_from_literal("Name of Peppa's father is Daddy Pig"),
201-
DocumentMeta.create_text_document_from_literal("Name of Peppa's mother is Mummy Pig"),
202-
DocumentMeta.create_text_document_from_literal("Name of Peppa's friend is Suzy Sheep"),
203-
DocumentMeta.create_text_document_from_literal("Name of Peppa's friend is Danny Dog"),
204-
DocumentMeta.create_text_document_from_literal("Name of Peppa's friend is Pedro Pony"),
205-
DocumentMeta.create_text_document_from_literal("Name of Peppa's friend is Emily Elephant"),
206-
DocumentMeta.create_text_document_from_literal("Name of Peppa's friend is Candy Cat"),
207-
DocumentMeta.create_text_document_from_literal("Name of Peppa's teacher is Madame Gazelle"),
208-
DocumentMeta.create_text_document_from_literal("Name of Peppa's doctor is Dr. Brown Bear"),
209-
DocumentMeta.create_text_document_from_literal("Name of Peppa's cousin is Chloe Pig"),
210-
DocumentMeta.create_text_document_from_literal("Name of Peppa's cousin is Alexander Pig"),
199+
DocumentMeta.from_literal("Name of Peppa's brother is George"),
200+
DocumentMeta.from_literal("Name of Peppa's father is Daddy Pig"),
201+
DocumentMeta.from_literal("Name of Peppa's mother is Mummy Pig"),
202+
DocumentMeta.from_literal("Name of Peppa's friend is Suzy Sheep"),
203+
DocumentMeta.from_literal("Name of Peppa's friend is Danny Dog"),
204+
DocumentMeta.from_literal("Name of Peppa's friend is Pedro Pony"),
205+
DocumentMeta.from_literal("Name of Peppa's friend is Emily Elephant"),
206+
DocumentMeta.from_literal("Name of Peppa's friend is Candy Cat"),
207+
DocumentMeta.from_literal("Name of Peppa's teacher is Madame Gazelle"),
208+
DocumentMeta.from_literal("Name of Peppa's doctor is Dr. Brown Bear"),
209+
DocumentMeta.from_literal("Name of Peppa's cousin is Chloe Pig"),
210+
DocumentMeta.from_literal("Name of Peppa's cousin is Alexander Pig"),
211211
]
212212

213213
ingest_strategy = BatchedIngestStrategy(batch_size=5)

‎packages/ragbits-document-search/tests/unit/test_document_search_ingest_errors.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ async def test_ingest_fails_on_error():
2828
)
2929

3030
# Create a test document
31-
document = DocumentMeta.create_text_document_from_literal("Test content")
31+
document = DocumentMeta.from_literal("Test content")
3232

3333
# Test that ingest raises IngestExecutionError when fail_on_error=True (default)
3434
with pytest.raises(IngestExecutionError) as exc_info:
@@ -52,7 +52,7 @@ async def test_ingest_returns_errors_when_fail_on_error_false():
5252
)
5353

5454
# Create a test document
55-
document = DocumentMeta.create_text_document_from_literal("Test content")
55+
document = DocumentMeta.from_literal("Test content")
5656

5757
# Test that ingest returns errors when fail_on_error=False
5858
result = await document_search.ingest([document], fail_on_error=False)

‎packages/ragbits-document-search/tests/unit/test_ingest_strategies.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ def ingest_strategy_fixture(request: pytest.FixtureRequest) -> IngestStrategy:
3030

3131
async def test_ingest_strategy_call(ingest_strategy: IngestStrategy) -> None:
3232
documents = [
33-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George"),
34-
DocumentMeta.create_text_document_from_literal("Name of Peppa's mother is Mummy Pig"),
35-
DocumentMeta.create_text_document_from_literal("Name of Peppa's father is Daddy Pig"),
36-
DocumentMeta.create_text_document_from_literal("Name of Peppa's grandfather is Grandpa Pig"),
37-
DocumentMeta.create_text_document_from_literal("Name of Peppa's grandmother is Granny Pig"),
33+
DocumentMeta.from_literal("Name of Peppa's brother is George"),
34+
DocumentMeta.from_literal("Name of Peppa's mother is Mummy Pig"),
35+
DocumentMeta.from_literal("Name of Peppa's father is Daddy Pig"),
36+
DocumentMeta.from_literal("Name of Peppa's grandfather is Grandpa Pig"),
37+
DocumentMeta.from_literal("Name of Peppa's grandmother is Granny Pig"),
3838
]
3939
vector_store = InMemoryVectorStore(embedder=NoopEmbedder())
4040
parser_router = DocumentParserRouter({DocumentType.TXT: TextDocumentParser()})
@@ -53,9 +53,9 @@ async def test_ingest_strategy_call(ingest_strategy: IngestStrategy) -> None:
5353

5454
async def test_ingest_strategy_call_fail(ingest_strategy: IngestStrategy) -> None:
5555
documents = [
56-
DocumentMeta.create_text_document_from_literal("Name of Peppa's brother is George"),
57-
DocumentMeta.create_text_document_from_literal("Name of Peppa's mother is Mummy Pig"),
58-
DocumentMeta.create_text_document_from_literal("Name of Peppa's father is Daddy Pig"),
56+
DocumentMeta.from_literal("Name of Peppa's brother is George"),
57+
DocumentMeta.from_literal("Name of Peppa's mother is Mummy Pig"),
58+
DocumentMeta.from_literal("Name of Peppa's father is Daddy Pig"),
5959
DocumentMeta.from_local_path(Path(__file__).parent.parent / "assets" / "img" / "transformers_paper_page.png"),
6060
DocumentMeta.from_local_path(Path(__file__).parent.parent / "assets" / "pdf" / "transformers_paper_page.pdf"),
6161
]

0 commit comments

Comments
 (0)