Skip to content
Snippets Groups Projects
Commit 82bd6228 authored by Yi Ding's avatar Yi Ding
Browse files

update docs

parent a747f289
No related branches found
No related tags found
No related merge requests found
...@@ -100,7 +100,7 @@ ___ ...@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[Embedding.ts:270](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L270) [Embedding.ts:272](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L272)
___ ___
...@@ -124,7 +124,7 @@ ___ ...@@ -124,7 +124,7 @@ ___
#### Defined in #### Defined in
[Embedding.ts:286](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L286) [Embedding.ts:288](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L288)
___ ___
...@@ -148,7 +148,7 @@ ___ ...@@ -148,7 +148,7 @@ ___
#### Defined in #### Defined in
[Embedding.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L282) [Embedding.ts:284](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L284)
___ ___
......
---
id: "PapaCSVReader"
title: "Class: PapaCSVReader"
sidebar_label: "PapaCSVReader"
sidebar_position: 0
custom_edit_url: null
---
papaparse-based csv parser
**`Implements`**
BaseReader
## Implements
- [`BaseReader`](../interfaces/BaseReader.md)
## Constructors
### constructor
**new PapaCSVReader**(`concatRows?`, `colJoiner?`, `rowJoiner?`, `papaConfig?`)
Constructs a new instance of the class.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `concatRows?` | `boolean` | `true` | whether to concatenate all rows into one document.If set to False, a Document will be created for each row.True by default. |
| `colJoiner?` | `string` | `", "` | - |
| `rowJoiner?` | `string` | `"\n"` | Separator to use for joining each row.Only used when `concat_rows=True`.Set to "\n" by default. |
| `papaConfig?` | `ParseConfig`<`any`, `undefined`\> | `undefined` | - |
#### Defined in
[readers/CSVReader.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/CSVReader.ts#L23)
## Properties
### colJoiner
`Private` **colJoiner**: `string`
#### Defined in
[readers/CSVReader.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/CSVReader.ts#L13)
___
### concatRows
`Private` **concatRows**: `boolean`
#### Defined in
[readers/CSVReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/CSVReader.ts#L12)
___
### papaConfig
`Private` `Optional` **papaConfig**: `ParseConfig`<`any`, `undefined`\>
#### Defined in
[readers/CSVReader.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/CSVReader.ts#L15)
___
### rowJoiner
`Private` **rowJoiner**: `string`
#### Defined in
[readers/CSVReader.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/CSVReader.ts#L14)
## Methods
### loadData
**loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)[]\>
Loads data from csv files
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `file` | `string` | `undefined` | The path to the file to load. |
| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | The file system to use for reading the file. |
#### Returns
`Promise`<[`Document`](Document.md)[]\>
#### Implementation of
[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata)
#### Defined in
[readers/CSVReader.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/CSVReader.ts#L41)
...@@ -40,4 +40,4 @@ Read all of the documents in a directory. Currently supports PDF and TXT files. ...@@ -40,4 +40,4 @@ Read all of the documents in a directory. Currently supports PDF and TXT files.
#### Defined in #### Defined in
[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L37) [readers/SimpleDirectoryReader.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L39)
...@@ -41,4 +41,4 @@ Read a .txt file ...@@ -41,4 +41,4 @@ Read a .txt file
#### Defined in #### Defined in
[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L12) [readers/SimpleDirectoryReader.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L13)
...@@ -11,6 +11,7 @@ A reader takes imports data into Document objects. ...@@ -11,6 +11,7 @@ A reader takes imports data into Document objects.
## Implemented by ## Implemented by
- [`PDFReader`](../classes/PDFReader.md) - [`PDFReader`](../classes/PDFReader.md)
- [`PapaCSVReader`](../classes/PapaCSVReader.md)
- [`SimpleDirectoryReader`](../classes/SimpleDirectoryReader.md) - [`SimpleDirectoryReader`](../classes/SimpleDirectoryReader.md)
- [`TextFileReader`](../classes/TextFileReader.md) - [`TextFileReader`](../classes/TextFileReader.md)
......
...@@ -41,6 +41,7 @@ custom_edit_url: null ...@@ -41,6 +41,7 @@ custom_edit_url: null
- [OpenAI](classes/OpenAI.md) - [OpenAI](classes/OpenAI.md)
- [OpenAIEmbedding](classes/OpenAIEmbedding.md) - [OpenAIEmbedding](classes/OpenAIEmbedding.md)
- [PDFReader](classes/PDFReader.md) - [PDFReader](classes/PDFReader.md)
- [PapaCSVReader](classes/PapaCSVReader.md)
- [Refine](classes/Refine.md) - [Refine](classes/Refine.md)
- [Response](classes/Response.md) - [Response](classes/Response.md)
- [ResponseSynthesizer](classes/ResponseSynthesizer.md) - [ResponseSynthesizer](classes/ResponseSynthesizer.md)
...@@ -178,7 +179,7 @@ ___ ...@@ -178,7 +179,7 @@ ___
#### Defined in #### Defined in
[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L26) [readers/SimpleDirectoryReader.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L28)
___ ___
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment