Skip to content

Revert "Improve clarity in JSON loader documentation" #758

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

Merged
merged 1 commit into from
Oct 6, 2025
Merged

Revert "Improve clarity in JSON loader documentation" #758

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 28 additions & 27 deletions build/oss/javascript/integrations/document_loaders/file_loaders/json.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,14 @@ The JSON loader use [JSON pointer](https://github.com/janl/node-jsonpointer) to

### No JSON pointer example

The most simple way of using it is to specify no JSON pointer.
The most simple way of using it, is to specify no JSON pointer.
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatical error: unnecessary comma before 'is'. Should be 'The most simple way of using it is to specify no JSON pointer.'

Suggested change
The most simple way of using it, is to specify no JSON pointer.
The most simple way of using it is to specify no JSON pointer.

Copilot uses AI. Check for mistakes.

The loader will load all strings it finds in the JSON object.

Example JSON file:

```json
{
"texts": ["This is a sentence.", "This is another sentence."],
"nestedTexts": {
"one": "This is a sentence nested in an object.",
"two": "This is another sentence nested in an object."
}
"texts": ["This is a sentence.", "This is another sentence."]
}
```

Expand All @@ -32,28 +28,28 @@ const docs = await loader.load();
/*
[
Document {
pageContent: 'This is a sentence.',
metadata: { source: 'example.json', line: 1 }
},
Document {
pageContent: 'This is another sentence.',
metadata: { source: 'example.json', line: 2 }
"metadata": {
"blobType": "application/json",
"line": 1,
"source": "blob",
},
"pageContent": "This is a sentence.",
},
Document {
pageContent: 'This is a sentence nested in an object.',
metadata: { source: 'example.json', line: 3 }
"metadata": {
"blobType": "application/json",
"line": 2,
"source": "blob",
},
"pageContent": "This is another sentence.",
},
Document {
pageContent: 'This is another sentence nested in an object.',
metadata: { source: 'example.json', line: 4 }
}
]
*/
```

### Using JSON pointer example

You can choose which keys in your JSON object you want to extract strings from.
You can do a more advanced scenario by choosing which keys in your JSON object you want to extract string from.
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatical error: 'string' should be plural 'strings' to match the context of extracting multiple text values.

Suggested change
You can do a more advanced scenario by choosing which keys in your JSON object you want to extract string from.
You can do a more advanced scenario by choosing which keys in your JSON object you want to extract strings from.

Copilot uses AI. Check for mistakes.


In this example, we want to only extract information from "from" and "surname" entries.

Expand Down Expand Up @@ -90,16 +86,21 @@ const docs = await loader.load();
/*
[
Document {
pageContent: 'LinkedIn Job',
metadata: { source: 'example.json', line: 1 }
"metadata": {
"blobType": "application/json",
"line": 1,
"source": "blob",
},
"pageContent": "BD 2023 SUMMER",
},
Document {
pageContent: 'LinkedIn Job2',
metadata: { source: 'example.json', line: 2 }
"metadata": {
"blobType": "application/json",
"line": 2,
"source": "blob",
},
"pageContent": "LinkedIn Job",
},
Document {
pageContent: 'bob',
metadata: { source: 'example.json', line: 3 }
}
...
]
```