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.

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[minor]: Add new QA & RAG use case section #4211

Merged
merged 29 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
8bf6959
added index & quickstart pages
bracesproul Jan 30, 2024
8dc4e19
Merge branch 'main' into brace/qa-rag-use-case
bracesproul Jan 30, 2024
0c99bd2
sources page
bracesproul Jan 30, 2024
79e2d55
chat history notebook
bracesproul Jan 30, 2024
f77d1d0
streaming
bracesproul Jan 31, 2024
3d1d979
one more streaming cell
bracesproul Jan 31, 2024
fb81727
cr
bracesproul Jan 31, 2024
2eea002
almost finished
bracesproul Feb 1, 2024
0c0fbb2
agents notebook
bracesproul Feb 1, 2024
8e74f54
Merge branch 'main' of https://github.com/langchain-ai/langchainjs in…
bracesproul Feb 1, 2024
70d525f
local models
bracesproul Feb 2, 2024
349ac67
cr
bracesproul Feb 2, 2024
e08bd79
commit quickstart
bracesproul Feb 2, 2024
ff6e40c
gitignore .md files
bracesproul Feb 3, 2024
5f1212d
Merge branch 'main' of https://github.com/langchain-ai/langchainjs in…
bracesproul Feb 3, 2024
be079e8
docs
bracesproul Feb 3, 2024
a0b9ca0
Merge branch 'main' of https://github.com/langchain-ai/langchainjs in…
bracesproul Feb 5, 2024
7a7241d
cr
bracesproul Feb 5, 2024
ec6345f
cr
bracesproul Feb 5, 2024
0c76a47
Merge branch 'main' of https://github.com/langchain-ai/langchainjs in…
bracesproul Feb 5, 2024
8fcc83f
lets goooooo
bracesproul Feb 5, 2024
cfad948
chore: lint files
bracesproul Feb 5, 2024
a628538
fix links
bracesproul Feb 5, 2024
ca8550e
cr
bracesproul Feb 5, 2024
b1291ba
drop unnecessary dep
bracesproul Feb 5, 2024
4d13e61
cer
bracesproul Feb 5, 2024
a6bbf06
Merge branch 'main' into brace/qa-rag-use-case
bracesproul Feb 5, 2024
92e29d9
cr
bracesproul Feb 5, 2024
a4f6231
cr
bracesproul Feb 5, 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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,5 @@ langchain/api_refs_docs_build/dist/**/*

.docusaurus/
docs/build/
docs/api_refs/typedoc.json
docs/api_refs/typedoc.json
docs/core_docs/**/*.md
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,32 @@ and in generated documentation.

### Contribute Documentation

#### Install dependencies

##### Note: you only need to follow these steps if you are building the docs site locally.

1. [Quarto](https://quarto.org/) - package that converts Jupyter notebooks (`.ipynb` files) into `.mdx` files for serving in Docusaurus.
2. `yarn build --filter=core_docs` - It's as simple as that! (or you can simply run `yarn build` from `docs/core_docs/`)

All notebooks are converted to `.md` files and automatically gitignored. If you would like to create a non notebook doc, it must be a `.mdx` file.

### Writing Notebooks

When adding new dependencies inside the notebook you must update the import map inside `deno.json` in the root of the LangChain repo.

This is required because the notebooks use the Deno runtime, and Deno formats imports differently than Node.js.

Example:

```typescript
// Import in Node:
import { z } from "zod";
// Import in Deno:
import { z } from "npm:/zod";
```

See examples inside `deno.json` for more details.

Docs are largely autogenerated by [TypeDoc](https://typedoc.org/) from the code.

For that reason, we ask that you add good documentation to all classes and methods.
Expand Down
14 changes: 14 additions & 0 deletions deno.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"imports": {
"langchain/": "npm:/langchain/",
"@langchain/community/": "npm:/@langchain/community/",
"@langchain/openai": "npm:@langchain/openai",
"@langchain/core/": "npm:/@langchain/core/",
"cheerio": "npm:/cheerio",
"@langchain/pinecone": "npm:@langchain/pinecone",
"@pinecone-database/pinecone": "npm:@pinecone-database/pinecone",
"zod": "npm:/zod",
"@langchain/anthropic": "npm:@langchain/anthropic",
"node-llama-cpp": "npm:/node-llama-cpp"
}
}
2 changes: 2 additions & 0 deletions docs/core_docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ yarn-error.log*
!.yarn/releases
!.yarn/sdks
!.yarn/versions

/.quarto/
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/core_docs/docs/get_started/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Let models choose which tools to use given high-level directives
Walkthroughs and techniques for common end-to-end use cases, like:

- [Document question answering](/docs/use_cases/question_answering/)
- [RAG](/docs/use_cases/rag/code_understanding)
- [RAG](/docs/use_cases/question_answering/)
- [Agents](/docs/use_cases/autonomous_agents/)
- and much more...

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RAG over code
# Code Understanding

## Use case

Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
label: 'QA and Chat over Documents'
label: 'Q&A with RAG'
position: 3

This file was deleted.

Loading
Loading