Skip to content

Commit

Permalink
docs: fix broken link
Browse files Browse the repository at this point in the history
  • Loading branch information
KindOfAScam committed Jun 22, 2024
1 parent e431e9f commit 8ad07fe
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions apps/docs/docs/modules/data_loader.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ It is a simple reader that reads all files from a directory and its subdirectori

Currently, it supports reading `.txt`, `.pdf`, `.csv`, `.md`, `.docx`, `.htm`, `.html`, `.jpg`, `.jpeg`, `.png` and `.gif` files, but support for other file types is planned.

You can override the default reader for all file types, inlcuding unsupported ones, with the `overrideReader` option.
Additionally, you can override the default reader for specific file types or add support for additional file types with the `fileExtToReader` option.
Also, you can provide a `defaultReader` as a fallback for files with unsupported extensions. By default it is `TextFileReader`.
You can modify the reader three different ways:

- `overrideReader` overrides the reader for all file types, including unsupported ones.
- `fileExtToReader` maps a reader to a specific file type. Can override reader for existing file types or add support for new file types.
- `defaultReader` sets a fallback reader for files with unsupported extensions. By default it is `TextFileReader`.

SimpleDirectoryReader supports up to 9 concurrent requests. Use the `numWorkers` option to set the number of concurrent requests. By default it runs in sequential mode, i.e. set to 1.

Expand All @@ -41,8 +43,10 @@ LlamaParse is an API created by LlamaIndex to efficiently parse files, e.g. it's

To use it, first login and get an API key from https://cloud.llamaindex.ai. Make sure to store the key as `apiKey` parameter or in the environment variable `LLAMA_CLOUD_API_KEY`.

Official documentation for LlamaIndex can be found [here](https://docs.cloud.llamaindex.ai/).

Then, you can use the `LlamaParseReader` class to local files and convert them into a parsed document that can be used by LlamaIndex.
See [LlamaParseReader.ts](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/LlamaParseReader.ts#L6) for a list of supported file types:
See [LlamaParseReader.ts](https://github.com/run-llama/main/packages/llamaindex/src/readers/LlamaParseReader.ts) for a list of supported file types:

<CodeBlock language="ts">{CodeSource3}</CodeBlock>

Expand Down

0 comments on commit 8ad07fe

Please sign in to comment.