refactor(docs): update API usage examples with new QueryContext and from_path methods

zTgx · zTgx · commit bcf74726ba8b · 2026-04-15T16:01:57.000+08:00
- Replace IndexContext.from_file() with IndexContext.from_path() in documentation examples
- Update query method to use QueryContext with with_doc_ids() instead of direct doc_id parameter
- Add QueryContext import to code examples
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ pip install vectorless
 
 ```python
 import asyncio
-from vectorless import Engine, IndexContext
+from vectorless import Engine, IndexContext, QueryContext
 
 async def main():
     # Create engine — api_key and model are required
@@ -38,11 +38,13 @@ async def main():
     )
 
     # Index a document (PDF or Markdown)
-    result = await engine.index(IndexContext.from_file("./report.pdf"))
+    result = await engine.index(IndexContext.from_path("./report.pdf"))
     doc_id = result.doc_id
 
     # Query
-    result = await engine.query(doc_id, "What is the total revenue?")
+    result = await engine.query(
+        QueryContext("What is the total revenue?").with_doc_ids([doc_id])
+    )
     print(result.single().content)
 
 asyncio.run(main())
diff --git a/docs/blog/2026-04-12-welcome/index.mdx b/docs/blog/2026-04-12-welcome/index.mdx
@@ -34,7 +34,7 @@ async def main():
     )
 
     # Index a document
-    result = await engine.index(IndexContext.from_file("./report.pdf"))
+    result = await engine.index(IndexContext.from_path("./report.pdf"))
     doc_id = result.doc_id
 
     # Query
diff --git a/docs/docs/intro.mdx b/docs/docs/intro.mdx
@@ -32,7 +32,7 @@ async def main():
         model="gpt-4o",
     )
 
-    result = await engine.index(IndexContext.from_file("./report.pdf"))
+    result = await engine.index(IndexContext.from_path("./report.pdf"))
     doc_id = result.doc_id
 
     answer = await engine.query(doc_id, "What is the total revenue?")
diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx
@@ -55,7 +55,7 @@ async def main():
 
     # Index a document
     result = await engine.index(
-        IndexContext.from_file("./report.pdf")
+        IndexContext.from_path("./report.pdf")
     )
     doc_id = result.doc_id
 

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ async def main():`
`34`	`34`	`)`
`35`	`35`
`36`	`36`	`# Index a document`
`37`		`- result = await engine.index(IndexContext.from_file("./report.pdf"))`
	`37`	`+ result = await engine.index(IndexContext.from_path("./report.pdf"))`
`38`	`38`	`doc_id = result.doc_id`
`39`	`39`
`40`	`40`	`# Query`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ async def main():`
`32`	`32`	`model="gpt-4o",`
`33`	`33`	`)`
`34`	`34`
`35`		`- result = await engine.index(IndexContext.from_file("./report.pdf"))`
	`35`	`+ result = await engine.index(IndexContext.from_path("./report.pdf"))`
`36`	`36`	`doc_id = result.doc_id`
`37`	`37`
`38`	`38`	`answer = await engine.query(doc_id, "What is the total revenue?")`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ async def main():`
`55`	`55`
`56`	`56`	`# Index a document`
`57`	`57`	`result = await engine.index(`
`58`		`- IndexContext.from_file("./report.pdf")`
	`58`	`+ IndexContext.from_path("./report.pdf")`
`59`	`59`	`)`
`60`	`60`	`doc_id = result.doc_id`
`61`	`61`