Preprocess
PreprocessReader #
Bases: BaseReader
Preprocess is an API service that splits any kind of document into optimal chunks of text for use in language model tasks. Preprocess splits the documents into chunks of text that respect the layout and semantics of the original document. Learn more at https://preprocess.co/.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
api_key |
str
|
[Required] The Preprocess API Key.
If you don't have one yet, please request it at [email protected].
Default: |
required |
file_path |
str
|
[Required] The path to the document to be preprocessed (convertend and split into chunks).
Default: |
required |
table_output_format |
str
|
The output format for tables within the document.
Accepted values are [text, markdown, html].
Default: |
required |
repeat_table_header |
bool
|
If |
required |
merge |
bool
|
If |
required |
repeat_title |
bool
|
If |
required |
keep_header |
bool
|
If |
required |
smart_header |
bool
|
If |
required |
keep_footer |
bool
|
If |
required |
image_text |
bool
|
If |
required |
Examples:
>>> loader = PreprocessReader(api_key="your-api-key", file_path="valid/path/to/file")
Source code in llama-index-integrations/readers/llama-index-readers-preprocess/llama_index/readers/preprocess/base.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
|
load_data #
load_data(return_whole_document=False) -> List[Document]
Load data from Preprocess.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
return_whole_document |
bool
|
Returning a list of one element, that element containing the full document.
Default: |
False
|
Examples:
>>> documents = loader.load_data()
>>> documents = loader.load_data(return_whole_document=True)
Returns:
Type | Description |
---|---|
List[Document]
|
List[Document]: A list of documents each document containing a chunk from the original document. |
Source code in llama-index-integrations/readers/llama-index-readers-preprocess/llama_index/readers/preprocess/base.py
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|
get_process_id #
get_process_id()
Get process's hash id from Preprocess.
Examples:
>>> process_id = loader.get_process_id()
Returns:
Name | Type | Description |
---|---|---|
str |
Process's hash id. |
Source code in llama-index-integrations/readers/llama-index-readers-preprocess/llama_index/readers/preprocess/base.py
186 187 188 189 190 191 192 193 194 195 196 |
|
get_nodes #
get_nodes() -> List[TextNode]
Get nodes from Preprocess's chunks.
Examples:
>>> nodes = loader.get_nodes()
Returns:
Type | Description |
---|---|
List[TextNode]
|
List[TextNode]: List of nodes, each node will contains a chunk from the original document. |
Source code in llama-index-integrations/readers/llama-index-readers-preprocess/llama_index/readers/preprocess/base.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
|