From 82bd6228b871b73c5cfa6785655751af3b7e0ed0 Mon Sep 17 00:00:00 2001 From: Yi Ding <yi.s.ding@gmail.com> Date: Wed, 16 Aug 2023 17:10:27 -0700 Subject: [PATCH] update docs --- apps/docs/docs/api/classes/OpenAIEmbedding.md | 6 +- apps/docs/docs/api/classes/PapaCSVReader.md | 105 ++++++++++++++++++ .../docs/api/classes/SimpleDirectoryReader.md | 2 +- apps/docs/docs/api/classes/TextFileReader.md | 2 +- apps/docs/docs/api/interfaces/BaseReader.md | 1 + apps/docs/docs/api/modules.md | 3 +- 6 files changed, 113 insertions(+), 6 deletions(-) create mode 100644 apps/docs/docs/api/classes/PapaCSVReader.md diff --git a/apps/docs/docs/api/classes/OpenAIEmbedding.md b/apps/docs/docs/api/classes/OpenAIEmbedding.md index 1abe8d935..fcf3c8b36 100644 --- a/apps/docs/docs/api/classes/OpenAIEmbedding.md +++ b/apps/docs/docs/api/classes/OpenAIEmbedding.md @@ -100,7 +100,7 @@ ___ #### 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 @@ ___ #### 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 @@ ___ #### 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) ___ diff --git a/apps/docs/docs/api/classes/PapaCSVReader.md b/apps/docs/docs/api/classes/PapaCSVReader.md new file mode 100644 index 000000000..e9ebb2a4e --- /dev/null +++ b/apps/docs/docs/api/classes/PapaCSVReader.md @@ -0,0 +1,105 @@ +--- +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) diff --git a/apps/docs/docs/api/classes/SimpleDirectoryReader.md b/apps/docs/docs/api/classes/SimpleDirectoryReader.md index 1591fae56..ad7050629 100644 --- a/apps/docs/docs/api/classes/SimpleDirectoryReader.md +++ b/apps/docs/docs/api/classes/SimpleDirectoryReader.md @@ -40,4 +40,4 @@ Read all of the documents in a directory. Currently supports PDF and TXT files. #### 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) diff --git a/apps/docs/docs/api/classes/TextFileReader.md b/apps/docs/docs/api/classes/TextFileReader.md index 859d0fa28..c8ef26677 100644 --- a/apps/docs/docs/api/classes/TextFileReader.md +++ b/apps/docs/docs/api/classes/TextFileReader.md @@ -41,4 +41,4 @@ Read a .txt file #### 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) diff --git a/apps/docs/docs/api/interfaces/BaseReader.md b/apps/docs/docs/api/interfaces/BaseReader.md index 114d1ede9..d290936d1 100644 --- a/apps/docs/docs/api/interfaces/BaseReader.md +++ b/apps/docs/docs/api/interfaces/BaseReader.md @@ -11,6 +11,7 @@ A reader takes imports data into Document objects. ## Implemented by - [`PDFReader`](../classes/PDFReader.md) +- [`PapaCSVReader`](../classes/PapaCSVReader.md) - [`SimpleDirectoryReader`](../classes/SimpleDirectoryReader.md) - [`TextFileReader`](../classes/TextFileReader.md) diff --git a/apps/docs/docs/api/modules.md b/apps/docs/docs/api/modules.md index 1cb9fbca5..385aa8216 100644 --- a/apps/docs/docs/api/modules.md +++ b/apps/docs/docs/api/modules.md @@ -41,6 +41,7 @@ custom_edit_url: null - [OpenAI](classes/OpenAI.md) - [OpenAIEmbedding](classes/OpenAIEmbedding.md) - [PDFReader](classes/PDFReader.md) +- [PapaCSVReader](classes/PapaCSVReader.md) - [Refine](classes/Refine.md) - [Response](classes/Response.md) - [ResponseSynthesizer](classes/ResponseSynthesizer.md) @@ -178,7 +179,7 @@ ___ #### 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) ___ -- GitLab