Skip to content

Commit ca56726

Browse files
committed
docs - fix formatting issues in README.md
1 parent 3b2a4d9 commit ca56726

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

README.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -163,17 +163,13 @@ and fill in the necessary environment variables.
163163
#### Indexing
164164

165165
```bash
166-
rye run simple-app-indexer \
167-
--llm-type azure_openai \ # other options are - openai or ollama
168-
--llm-model gpt-4o \
169-
--embedding-type azure_openai \ # other options are - openai or ollama
170-
--embedding-model text-embedding-3-small
166+
rye run simple-app-indexer --llm-type azure_openai --llm-model gpt-4o --embedding-type azure_openai --embedding-model text-embedding-3-small
171167
```
172168

173169
```bash
174170
# To see more options
175171
$ rye run simple-app-indexer --help
176-
Usage: main.py indexer index [OPTIONS]
172+
Usage: main.py indexer index [OPTIONS]
177173

178174
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
179175
* --input-file FILE [default: None] [required] │
@@ -196,19 +192,14 @@ $ rye run simple-app-indexer --help
196192

197193
#### Global Search
198194

199-
200195
```bash
201-
rye run simple-app-global-search \
202-
--llm-type azure_openai \ # other options are openai or ollama
203-
--llm-model gpt-4o \
204-
--query "What are the top themes in this story?"
196+
rye run simple-app-global-search --llm-type azure_openai --llm-model gpt-4o --query "What are the top themes in this story?"
205197
```
206198

207199
```bash
208200
$ rye run simple-app-global-search --help
209-
210-
Usage: main.py query global-search [OPTIONS]
211-
201+
Usage: main.py query global-search [OPTIONS]
202+
212203
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
213204
* --output-dir DIRECTORY [default: None] [required] │
214205
* --cache-dir DIRECTORY [default: None] [required] │
@@ -225,16 +216,12 @@ $ rye run simple-app-global-search --help
225216
#### Local Search
226217

227218
```bash
228-
rye run simple-app-local-search \
229-
--llm-type azure_openai \ # other options are openai or ollama
230-
--llm-model gpt-4o \
231-
--query "Who is Scrooge, and what are his main relationships?"
219+
rye run simple-app-local-search --llm-type azure_openai --llm-model gpt-4o --query "Who is Scrooge, and what are his main relationships?" --embedding-type azure_openai --embedding-model text-embedding-3-small
232220
```
233221

234222
```bash
235223
$ rye run simple-app-local-search --help
236-
237-
Usage: main.py query local-search [OPTIONS]
224+
Usage: main.py query local-search [OPTIONS]
238225

239226
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
240227
* --output-dir DIRECTORY [default: None] [required] │

0 commit comments

Comments
 (0)