Gitbook
SimpleGitbookReader #
Bases: BaseReader
Simple gitbook reader.
Convert each gitbook page into Document used by LlamaIndex.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
api_token
|
str
|
Gitbook API Token. |
required |
api_url
|
str
|
Gitbook API Endpoint. |
None
|
Source code in llama-index-integrations/readers/llama-index-readers-gitbook/llama_index/readers/gitbook/base.py
11 12 13 14 15 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 |
|
load_data #
load_data(space_id: str, metadata_names: Optional[List[str]] = None, show_progress=False) -> List[Document]
Load data from the input directory.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
space_id
|
str
|
Gitbook space id |
required |
metadata_names
|
Optional[List[str]]
|
names of the fields to be added to the metadata attribute of the Document. only 'path', 'title', 'description', 'parent' are available Defaults to None |
None
|
show_progress
|
bool
|
Show progress bar. Defaults to False |
False
|
Returns:
Type | Description |
---|---|
List[Document]
|
List[Document]: A list of documents. |
Source code in llama-index-integrations/readers/llama-index-readers-gitbook/llama_index/readers/gitbook/base.py
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 |
|