Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update for PR #14 on langchain-test #15

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Docs update for PR #14 on langchain-test #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78caed7
Docs update (f50cc65)
promptless[bot] Nov 25, 2024
66028f2
Docs update
prithvi2206 Nov 25, 2024
0a406a1
Docs update
prithvi2206 Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion docs/docs/how_to/markdown_header_metadata_splitter.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,50 @@
"splits = text_splitter.split_documents(md_header_splits)\n",
"splits"
]
},
{
"cell_type": "markdown",
"id": "b7b557f7",
"metadata": {},
"source": [
"### How to preserve whitespace from the original document:\n",
"\n",
"By default, `MarkdownHeaderTextSplitter` strips whitespace and newlines from the resulting documents, which can sometimes can cause issues with markdown sections like code blocks or nested lists. Use the `ExperimentalMarkdownSyntaxTextSplitter` to preserve whitespace in these instances."
]
},
{
"cell_type": "code",
"execution_count": 7,
"id": "ba48193b",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"[Document(metadata={'Header 1': 'Foo'}, page_content='# Foo \\nThis is Jim'),\n",
" Document(metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}, page_content='## Bar \\n* Bullet 1\\n* Sub-bullet a')]"
]
},
"execution_count": 7,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"from langchain_text_splitters import ExperimentalMarkdownSyntaxTextSplitter\n",
"\n",
"markdown_document = \"# Foo\\n\\n This is Jim \\n\\n## Bar\\n\\n* Bullet 1\\n * Sub-bullet a\"\n",
"\n",
"headers_to_split_on = [\n",
" (\"#\", \"Header 1\"),\n",
" (\"##\", \"Header 2\"),\n",
" (\"###\", \"Header 3\"),\n",
"]\n",
"\n",
"markdown_splitter = ExperimentalMarkdownSyntaxTextSplitter(headers_to_split_on, strip_headers=False)\n",
"md_header_splits = markdown_splitter.split_text(markdown_document)\n",
"md_header_splits"
]
}
],
"metadata": {
Expand All @@ -279,7 +323,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.4"
"version": "3.11.6"
}
},
"nbformat": 4,
Expand Down
Loading