Skip to content
Merged

Dev #105

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="https://vectorless.dev/img/with-title.png" alt="Vectorless" width="400">

<h1>Reasoning-based Document Engine</h1>
<h5>Reason, don't vector · Structure, not chunks · Agents, not embeddings · Exact, not synthesized</h5>
<h5>Reason, don't vector · Structure, not chunks · Agents, not embeddings</h5>

[![PyPI](https://img.shields.io/pypi/v/vectorless.svg)](https://pypi.org/project/vectorless/)
[![PyPI Downloads](https://static.pepy.tech/badge/vectorless/month)](https://pepy.tech/projects/vectorless)
Expand Down
32 changes: 32 additions & 0 deletions examples/session_walkthrough/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Session API Walkthrough

Demonstrates the full high-level Vectorless Python API using the `Session` and `SyncSession` classes.

## What it covers

| # | Topic | API |
|---|-------|-----|
| 1 | Session creation | `Session()`, `from_env()`, `from_config_file()` |
| 2 | Indexing sources | `index(content=)`, `index(path=)`, `index(bytes_data=)`, `index(directory=)` |
| 3 | Batch indexing | `index_batch(paths, jobs=N)` |
| 4 | Querying | `ask(question, doc_ids=)`, `ask(question, workspace_scope=True)` |
| 5 | Streaming query | `query_stream()` async iterator |
| 6 | Document management | `list_documents()`, `document_exists()`, `remove_document()`, `clear_all()` |
| 7 | Document graph | `get_graph()` nodes, edges, keywords |
| 8 | Event callbacks | `EventEmitter` with `@on_index` / `@on_query` decorators |
| 9 | Metrics | `metrics_report()` |
| 10 | Sync API | `SyncSession` (no async/await) |

## Setup

```bash
pip install vectorless
export VECTORLESS_API_KEY="sk-..."
export VECTORLESS_MODEL="gpt-4o"
```

## Run

```bash
python main.py
```
Loading
Loading