# Bring your own data

Run a file or folder directly, with questions and optional reviewed evidence.

CLI version: 0.2.1 · [Read online](<https://ragvidence.medo-id.com/docs/bring-your-own-data>)

## Prepare a small first experiment

**manual.txt**

```
Hold the reset button for eight seconds. Use USB-C power.
```

**Terminal**

```
ragvi bm25 ./manual.txt --query "How do I reset the device?"
```

The default export is a self-contained HTML report in a unique directory under ragvi-reports/. Original input files stay unchanged. --output DIRECTORY selects another root; --open explicitly opens the HTML in a browser.

## Add your questions

**questions.txt**

```
How do I reset the device?
What power does it require?
```

**Terminal**

```
ragvi bm25 ./docs --questions ./questions.txt --format html --format json
ragvi compare-data ./docs --questions ./questions.txt --techniques bm25,parent-child
```

TXT uses one question per nonblank line. JSON accepts an array of strings or question objects; JSONL uses one object per line. IDs must be unique; portable question objects accept only question\_id and question.

**JSONL · questions.jsonl**

```
{"question_id":"Q1","question":"How do I reset the device?"}
```

## Inspect without questions

**Terminal**

```
ragvi bm25 ./manual.txt --no-input
```

Without questions, an interactive terminal offers question entry. Empty entry selects source inspection. --no-input disables prompts; redirected input never blocks. --interactive offers output-format selection on a terminal. Explicit --format flags work without prompts.

## Download the synthetic worked example

- [Device manual](<https://ragvidence.medo-id.com/examples/manual.md>)
- [Question file](<https://ragvidence.medo-id.com/examples/questions.txt>)
- [Reviewed original spans](<https://ragvidence.medo-id.com/examples/reviewed.json>)
- [Actual generated comparison](<https://ragvidence.medo-id.com/sample-report.html>)

Save manual.md inside docs/, with questions.txt and reviewed.json beside that folder. The reviewed file binds to the exact original text and its corpus hash. Keep the downloaded manual’s UTF-8 bytes unchanged.

**Terminal**

```
ragvi compare-data ./docs --reviewed ./reviewed.json --techniques bm25,parent-child,compress --k 1 --chunk-size 100 --chunk-overlap 10 --format html --format json --format markdown
```

> **Scoring needs review**
>
> Questions alone do not establish relevant evidence or a quality winner. Reviewed references supply questions and cannot combine with --query or --questions.