diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 045fc2ee2..0cf0ef2ae 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to LangChain Docs -Please read our [contributing guide](https://docs.langchain.com/docs/contributing) to learn how you can make a contribution to the LangChain documentation. +Please read our [contributing guide](https://docs.langchain.com/oss/python/contributing/overview) to learn how you can make a contribution to the LangChain ecosystem and documentation. Happy writing! 🎤🦜 diff --git a/.github/ISSUE_TEMPLATE/04-langchain-labs.yml b/.github/ISSUE_TEMPLATE/04-langchain-labs.yml new file mode 100644 index 000000000..536f61b1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-langchain-labs.yml @@ -0,0 +1,36 @@ +name: LangChain Labs Documentation +description: Report an issue related to the LangChain Labs documentation. +title: "[langchain-labs]: " +labels: [langchain-labs] + +body: + - type: dropdown + attributes: + label: "Type of issue" + description: "What type of documentation issue are you reporting?" + options: + - issue / bug + - request for content + - question + - other + default: 0 + validations: + required: true + - type: dropdown + attributes: + label: "Language" + description: "What language is the documentation issue related to?" + options: + - Python + - JavaScript + - N/A + default: 0 + - type: textarea + attributes: + label: "Description" + description: > + Please describe your issue, content request, or question in detail. + If reporting an issue with current documentation, please include a reference + to the specific document/code you're referring to. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/05-reference-docs.yml b/.github/ISSUE_TEMPLATE/05-reference-docs.yml new file mode 100644 index 000000000..831ba5393 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05-reference-docs.yml @@ -0,0 +1,54 @@ +name: Reference Documentation +description: Report an issue related to API reference documentation. +title: "[reference]: " +labels: [reference] + +body: + - type: dropdown + attributes: + label: "Type of issue" + description: "What type of reference documentation issue are you reporting?" + options: + - issue / bug + - missing documentation + - incorrect type signature + - outdated/deprecated content + - other + default: 0 + validations: + required: true + - type: dropdown + attributes: + label: "Language" + description: "What language is the reference documentation issue related to?" + options: + - Python + - JavaScript + - N/A + default: 0 + validations: + required: true + - type: dropdown + attributes: + label: "Product" + description: "Which product's reference docs is this issue related to?" + options: + - LangChain + - LangGraph + - LangSmith + - Other + default: 0 + - type: input + attributes: + label: "Link to reference page" + description: "URL to the specific reference page with the issue (if applicable)" + - type: textarea + attributes: + label: "Description" + description: > + Please describe your issue in detail. + For missing documentation, specify the class/method/function that needs documentation. + For incorrect signatures, provide the expected vs. actual signature. + For bugs, include what you expected to see vs. what you actually see. + validations: + required: true diff --git a/IDE_SETUP.md b/IDE_SETUP.md index acc6ea070..31abe59ae 100644 --- a/IDE_SETUP.md +++ b/IDE_SETUP.md @@ -2,6 +2,8 @@ This repository includes configuration files to ensure consistent formatting across different editors and IDEs used by documentation writers. +Ensure the following steps are taken and configurations are in place before making substantial docs changes. + ## Automatic Configuration ### VSCode diff --git a/README.md b/README.md index 6777a3836..2931c773c 100644 --- a/README.md +++ b/README.md @@ -57,11 +57,14 @@ Built files are stored in `/reference/dist/{LANGUAGE}`, which is then deployed t ## Contributing -The following steps refer to the [`docs.langchain.com`](https://docs.langchain.com) Mintlify documentation site. For contributing to the reference docs, see the `README.md` files in `/reference/python` and `/reference/javascript`. +Before making any changes, we encourage you to read the LangChain [contributing guide](https://docs.langchain.com/oss/python/contributing/documentation) to understand our documentation types and their writing and quality standards. -### Set up a dev environment +> [!IMPORTANT] +> The following steps refer to the [`docs.langchain.com`](https://docs.langchain.com) Mintlify documentation site. For contributing to reference docs, see the `README.md` file in the `/reference/python` and `/reference/javascript` directories. + +### Set up a local dev environment -1. Clone this repo. Ensure the steps in [IDE_SETUP.md](./IDE_SETUP.md) are followed to configure your IDE/editor to automatically apply the correct settings. +1. Clone this repo. Follow the steps outlined in [IDE_SETUP.md](./IDE_SETUP.md). 2. Install `uv` from (if not already installed) 3. Install `npm` from (if not already installed) 4. Create and activate a virtual environment: @@ -121,7 +124,7 @@ Common commands: * `make lint_md_fix` - Lint and fix markdown files * `make help` - Show all available commands -#### docs CLI Tool +#### `docs` CLI Tool The `docs` command (installed as `uv run docs`) provides additional functionality: @@ -153,12 +156,12 @@ These can be used directly using the `Makefile` or via the `docs` CLI tool: ### File formats * **Markdown files** (`.md`, `.mdx`) - Standard documentation content -* **Jupyter notebooks** (`.ipynb`) - Converted to markdown during build, though **these are not recommended for new content!** +* **Jupyter notebooks** (`.ipynb`) - Converted to markdown during build, though **these are not recommended for new content!** Your PR will likely be rejected if you attempt to add a Jupyter notebook unless asked to by a maintainer. * **Assets** - Images and other files are copied to the build directory ### Documentation syntax -This project uses [Mintlify](https://mintlify.com/docs) for documentation generation. Key features: +Our primary docs the [Mintlify](https://mintlify.com/docs) platform for docs generation. Key features include: * **Frontmatter** - YAML metadata at the top of files * **Components** - Special Mintlify components for enhanced formatting @@ -250,7 +253,7 @@ Once your branch has been merged into `main`, you need to push the changes to `p ### `docs dev` not working / running -Re-do the [steps to set up your dev environment](#set-up-a-dev-environment), ensuring you have activated the virtual environment and installed all dependencies. +Re-do the [steps to set up your dev environment](#set-up-a-local-dev-environment), ensuring you have activated the virtual environment and installed all dependencies. ### Mintlify `.venv` parsing error diff --git a/reference/python/README.md b/reference/python/README.md index 2f7d82bfe..802519349 100644 --- a/reference/python/README.md +++ b/reference/python/README.md @@ -35,6 +35,7 @@ This site is currently being migrated from a previous Sphinx-based implementatio - [ ] Fix `navigation.path` feature/plugin in `mkdocs.yml` not working - [ ] Resolve Griffe errors - [ ] Set up CI to fail on unexpected Griffe warnings +- [ ] "Module last updated" auto-generation for module pages using source file commit timestamps or the MkDocs plugin [git-revision-date-localized](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) - [ ] Fix search magnifying glass icon color in dark mode - [ ] Copy page support (need to add a post-processing step to generate markdown files to serve alongside the API reference docs) - [ ] Language switcher (JS/TS) diff --git a/reference/python/docs/index.md b/reference/python/docs/index.md index 5db5dc9df..9252e8a7b 100644 --- a/reference/python/docs/index.md +++ b/reference/python/docs/index.md @@ -5,7 +5,7 @@ title: LangChain Python Reference Welcome to the [LangChain](https://langchain.com) Python reference documentation! These pages detail the core interfaces you will use when building applications with LangChain and LangGraph. Each section covers a different part of the ecosystem !!! warning "Work in progress" - This site is a work in progress. If you have any suggestions or find any issues, please [open an issue on GitHub](https://github.com/langchain-ai/docs/issues). + This site is a work in progress. If you have any suggestions or find any issues, please [open an issue on GitHub](https://github.com/langchain-ai/docs/issues/new?template=05-reference-docs.yml). !!! note "Reference docs" This site contains **Python reference documentation**. You can find **conceptual guides, tutorials, and more** in the [main LangChain documentation site](https://docs.langchain.com). @@ -15,5 +15,5 @@ Welcome to the [LangChain](https://langchain.com) Python reference documentation !!! info "Looking for legacy docs?" Legacy docs and API references are available for: - - [LangChain](https://python.langchain.com/). - - [LangGraph](https://langchain-ai.github.io/langgraph/). + - [LangChain](https://python.langchain.com/) + - [LangGraph](https://langchain-ai.github.io/langgraph/) diff --git a/reference/python/docs/integrations/langchain_anthropic.md b/reference/python/docs/integrations/langchain_anthropic.md index 972f94256..40ccfcad6 100644 --- a/reference/python/docs/integrations/langchain_anthropic.md +++ b/reference/python/docs/integrations/langchain_anthropic.md @@ -4,4 +4,8 @@ title: Anthropic - LangChain Integration Reference # :simple-claude:{ .lg .middle } `langchain-anthropic` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-anthropic?label=%20)](https://pypi.org/project/langchain-anthropic/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-anthropic)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-anthropic)](https://pypistats.org/packages/langchain-anthropic) + ::: langchain_anthropic diff --git a/reference/python/docs/integrations/langchain_astradb.md b/reference/python/docs/integrations/langchain_astradb.md index 700078d96..e7c1da823 100644 --- a/reference/python/docs/integrations/langchain_astradb.md +++ b/reference/python/docs/integrations/langchain_astradb.md @@ -4,4 +4,8 @@ title: AstraDB - LangChain Integration Reference # :simple-datastax:{ .lg .middle } `langchain-astradb` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-astradb?label=%20)](https://pypi.org/project/langchain-astradb/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-astradb)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-astradb)](https://pypistats.org/packages/langchain-astradb) + ::: langchain_astradb diff --git a/reference/python/docs/integrations/langchain_aws.md b/reference/python/docs/integrations/langchain_aws.md index 2f0eedf03..832e3dac6 100644 --- a/reference/python/docs/integrations/langchain_aws.md +++ b/reference/python/docs/integrations/langchain_aws.md @@ -4,4 +4,8 @@ title: AWS - LangChain Integration Reference # :material-aws:{ .lg .middle } `langchain-aws` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-aws?label=%20)](https://pypi.org/project/langchain-aws/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-aws)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-aws)](https://pypistats.org/packages/langchain-aws) + ::: langchain_aws diff --git a/reference/python/docs/integrations/langchain_azure_ai.md b/reference/python/docs/integrations/langchain_azure_ai.md index e623436ea..e7faf6e8e 100644 --- a/reference/python/docs/integrations/langchain_azure_ai.md +++ b/reference/python/docs/integrations/langchain_azure_ai.md @@ -4,4 +4,8 @@ title: Azure AI - LangChain Integration Reference # :material-microsoft-azure:{ .lg .middle } `langchain-azure-ai` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-azure-ai?label=%20)](https://pypi.org/project/langchain-azure-ai/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-azure-ai)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-azure-ai)](https://pypistats.org/packages/langchain-azure-ai) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/azure_ai/index.html). diff --git a/reference/python/docs/integrations/langchain_azure_dynamic_sessions.md b/reference/python/docs/integrations/langchain_azure_dynamic_sessions.md index 5ac34ac11..ecb22252d 100644 --- a/reference/python/docs/integrations/langchain_azure_dynamic_sessions.md +++ b/reference/python/docs/integrations/langchain_azure_dynamic_sessions.md @@ -4,4 +4,8 @@ title: Azure Dynamic Sessions - LangChain Integration Reference # :material-microsoft-azure:{ .lg .middle } `langchain-azure-dynamic-sessions` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-azure-dynamic-sessions?label=%20)](https://pypi.org/project/langchain-azure-dynamic-sessions/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-azure-dynamic-sessions)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-azure-dynamic-sessions)](https://pypistats.org/packages/langchain-azure-dynamic-sessions) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/azure_dynamic_sessions/index.html). diff --git a/reference/python/docs/integrations/langchain_cerebras.md b/reference/python/docs/integrations/langchain_cerebras.md index c1ed5c1e3..ba32dd236 100644 --- a/reference/python/docs/integrations/langchain_cerebras.md +++ b/reference/python/docs/integrations/langchain_cerebras.md @@ -4,4 +4,8 @@ title: Cerebras - LangChain Integration Reference # `langchain-cerebras` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-cerebras?label=%20)](https://pypi.org/project/langchain-cerebras/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-cerebras)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-cerebras)](https://pypistats.org/packages/langchain-cerebras) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/cerebras/index.html). diff --git a/reference/python/docs/integrations/langchain_chroma.md b/reference/python/docs/integrations/langchain_chroma.md index 8ecfe1654..c4e1fd6e3 100644 --- a/reference/python/docs/integrations/langchain_chroma.md +++ b/reference/python/docs/integrations/langchain_chroma.md @@ -4,4 +4,8 @@ title: Chroma - LangChain Integration Reference # `langchain-chroma` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-chroma?label=%20)](https://pypi.org/project/langchain-chroma/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-chroma)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-chroma)](https://pypistats.org/packages/langchain-chroma) + ::: langchain_chroma diff --git a/reference/python/docs/integrations/langchain_cohere.md b/reference/python/docs/integrations/langchain_cohere.md index 20e009c46..1703902bc 100644 --- a/reference/python/docs/integrations/langchain_cohere.md +++ b/reference/python/docs/integrations/langchain_cohere.md @@ -4,4 +4,8 @@ title: Cohere - LangChain Integration Reference # `langchain-cohere` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-cohere?label=%20)](https://pypi.org/project/langchain-cohere/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-cohere)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-cohere)](https://pypistats.org/packages/langchain-cohere) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/cohere/index.html). diff --git a/reference/python/docs/integrations/langchain_db2.md b/reference/python/docs/integrations/langchain_db2.md index 146b0d016..873a86e0a 100644 --- a/reference/python/docs/integrations/langchain_db2.md +++ b/reference/python/docs/integrations/langchain_db2.md @@ -4,4 +4,8 @@ title: Db2 - LangChain Integration Reference # `langchain-db2` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-db2?label=%20)](https://pypi.org/project/langchain-db2/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-db2)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-db2)](https://pypistats.org/packages/langchain-db2) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/db2/index.html). diff --git a/reference/python/docs/integrations/langchain_deepseek.md b/reference/python/docs/integrations/langchain_deepseek.md index 78b398d38..6b6416097 100644 --- a/reference/python/docs/integrations/langchain_deepseek.md +++ b/reference/python/docs/integrations/langchain_deepseek.md @@ -4,4 +4,8 @@ title: DeepSeek - LangChain Integration Reference # `langchain-deepseek` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-deepseek?label=%20)](https://pypi.org/project/langchain-deepseek/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-deepseek)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-deepseek)](https://pypistats.org/packages/langchain-deepseek) + ::: langchain_deepseek diff --git a/reference/python/docs/integrations/langchain_elasticsearch.md b/reference/python/docs/integrations/langchain_elasticsearch.md index 98ffe6558..15dd520fd 100644 --- a/reference/python/docs/integrations/langchain_elasticsearch.md +++ b/reference/python/docs/integrations/langchain_elasticsearch.md @@ -4,4 +4,8 @@ title: Elasticsearch - LangChain Integration Reference # :simple-elasticsearch:{ .lg .middle } `langchain-elasticsearch` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-elasticsearch?label=%20)](https://pypi.org/project/langchain-elasticsearch/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-elasticsearch)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-elasticsearch)](https://pypistats.org/packages/langchain-elasticsearch) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/elasticsearch/index.html). diff --git a/reference/python/docs/integrations/langchain_exa.md b/reference/python/docs/integrations/langchain_exa.md index cf8bdef76..420ed71b8 100644 --- a/reference/python/docs/integrations/langchain_exa.md +++ b/reference/python/docs/integrations/langchain_exa.md @@ -4,4 +4,8 @@ title: Exa - LangChain Integration Reference # `langchain-exa` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-exa?label=%20)](https://pypi.org/project/langchain-exa/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-exa)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-exa)](https://pypistats.org/packages/langchain-exa) + ::: langchain_exa diff --git a/reference/python/docs/integrations/langchain_fireworks.md b/reference/python/docs/integrations/langchain_fireworks.md index 499e89c40..7e2fb4cf8 100644 --- a/reference/python/docs/integrations/langchain_fireworks.md +++ b/reference/python/docs/integrations/langchain_fireworks.md @@ -4,4 +4,8 @@ title: Fireworks - LangChain Integration Reference # `langchain-fireworks` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-fireworks?label=%20)](https://pypi.org/project/langchain-fireworks/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-fireworks)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-fireworks)](https://pypistats.org/packages/langchain-fireworks) + ::: langchain_fireworks diff --git a/reference/python/docs/integrations/langchain_google_community.md b/reference/python/docs/integrations/langchain_google_community.md index 612d3d328..81688647a 100644 --- a/reference/python/docs/integrations/langchain_google_community.md +++ b/reference/python/docs/integrations/langchain_google_community.md @@ -4,4 +4,8 @@ title: Google (Community) - LangChain Integration Reference # `langchain-google-community` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-google-community?label=%20)](https://pypi.org/project/langchain-google-community/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-google-community)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-google-community)](https://pypistats.org/packages/langchain-google-community) + ::: langchain_google_community diff --git a/reference/python/docs/integrations/langchain_google_genai.md b/reference/python/docs/integrations/langchain_google_genai.md index e8c3ff687..0ddf97421 100644 --- a/reference/python/docs/integrations/langchain_google_genai.md +++ b/reference/python/docs/integrations/langchain_google_genai.md @@ -4,4 +4,8 @@ title: Google (GenAI) - LangChain Integration Reference # :simple-googlegemini:{ .lg .middle } `langchain-google-genai` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-google-genai?label=%20)](https://pypi.org/project/langchain-google-genai/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-google-genai)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-google-genai)](https://pypistats.org/packages/langchain-google-genai) + ::: langchain_google_genai diff --git a/reference/python/docs/integrations/langchain_google_vertexai.md b/reference/python/docs/integrations/langchain_google_vertexai.md index f04669855..b67058c62 100644 --- a/reference/python/docs/integrations/langchain_google_vertexai.md +++ b/reference/python/docs/integrations/langchain_google_vertexai.md @@ -4,4 +4,8 @@ title: Google (VertexAI) - LangChain Integration Reference # :simple-googlecloud:{ .lg .middle } `langchain-google-vertexai` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-google-vertexai?label=%20)](https://pypi.org/project/langchain-google-vertexai/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-google-vertexai)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-google-vertexai)](https://pypistats.org/packages/langchain-google-vertexai) + ::: langchain_google_vertexai diff --git a/reference/python/docs/integrations/langchain_groq.md b/reference/python/docs/integrations/langchain_groq.md index c5e1fa4cd..a698490d1 100644 --- a/reference/python/docs/integrations/langchain_groq.md +++ b/reference/python/docs/integrations/langchain_groq.md @@ -4,4 +4,8 @@ title: Groq - LangChain Integration Reference # `langchain-groq` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-groq?label=%20)](https://pypi.org/project/langchain-groq/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-groq)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-groq)](https://pypistats.org/packages/langchain-groq) + ::: langchain_groq diff --git a/reference/python/docs/integrations/langchain_huggingface.md b/reference/python/docs/integrations/langchain_huggingface.md index 8c9b16844..ac45a48a0 100644 --- a/reference/python/docs/integrations/langchain_huggingface.md +++ b/reference/python/docs/integrations/langchain_huggingface.md @@ -4,4 +4,8 @@ title: HuggingFace - LangChain Integration Reference # :simple-huggingface:{ .lg .middle } `langchain-huggingface` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-huggingface?label=%20)](https://pypi.org/project/langchain-huggingface/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-huggingface)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-huggingface)](https://pypistats.org/packages/langchain-huggingface) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/huggingface/index.html). diff --git a/reference/python/docs/integrations/langchain_ibm.md b/reference/python/docs/integrations/langchain_ibm.md index d50ae28a0..21bb1175e 100644 --- a/reference/python/docs/integrations/langchain_ibm.md +++ b/reference/python/docs/integrations/langchain_ibm.md @@ -4,4 +4,8 @@ title: IBM - LangChain Integration Reference # `langchain-ibm` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-ibm?label=%20)](https://pypi.org/project/langchain-ibm/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-ibm)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-ibm)](https://pypistats.org/packages/langchain-ibm) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/ibm/index.html). diff --git a/reference/python/docs/integrations/langchain_milvus.md b/reference/python/docs/integrations/langchain_milvus.md index 8b3c1ecfc..1a0afa202 100644 --- a/reference/python/docs/integrations/langchain_milvus.md +++ b/reference/python/docs/integrations/langchain_milvus.md @@ -4,4 +4,8 @@ title: Milvus - LangChain Integration Reference # :simple-milvus:{ .lg .middle } `langchain-milvus` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-milvus?label=%20)](https://pypi.org/project/langchain-milvus/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-milvus)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-milvus)](https://pypistats.org/packages/langchain-milvus) + This package ref has not yet been migrated to v1. diff --git a/reference/python/docs/integrations/langchain_mistralai.md b/reference/python/docs/integrations/langchain_mistralai.md index 908849f0f..1c796a224 100644 --- a/reference/python/docs/integrations/langchain_mistralai.md +++ b/reference/python/docs/integrations/langchain_mistralai.md @@ -4,4 +4,8 @@ title: MistralAI - LangChain Integration Reference # :simple-mistralai:{ .lg .middle } `langchain-mistralai` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-mistralai?label=%20)](https://pypi.org/project/langchain-mistralai/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-mistralai)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-mistralai)](https://pypistats.org/packages/langchain-mistralai) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/mistralai/index.html). diff --git a/reference/python/docs/integrations/langchain_mongodb.md b/reference/python/docs/integrations/langchain_mongodb.md index 38d61d628..d1afb871d 100644 --- a/reference/python/docs/integrations/langchain_mongodb.md +++ b/reference/python/docs/integrations/langchain_mongodb.md @@ -4,4 +4,8 @@ title: MongoDB - LangChain Integration Reference # :simple-mongodb:{ .lg .middle } `langchain-mongodb` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-mongodb?label=%20)](https://pypi.org/project/langchain-mongodb/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-mongodb)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-mongodb)](https://pypistats.org/packages/langchain-mongodb) + ::: langchain_mongodb diff --git a/reference/python/docs/integrations/langchain_neo4j.md b/reference/python/docs/integrations/langchain_neo4j.md index 8ea6531bc..0707916ba 100644 --- a/reference/python/docs/integrations/langchain_neo4j.md +++ b/reference/python/docs/integrations/langchain_neo4j.md @@ -4,4 +4,8 @@ title: Neo4J - LangChain Integration Reference # :simple-neo4j:{ .lg .middle } `langchain-neo4j` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-neo4j?label=%20)](https://pypi.org/project/langchain-neo4j/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-neo4j)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-neo4j)](https://pypistats.org/packages/langchain-neo4j) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/neo4j/index.html). diff --git a/reference/python/docs/integrations/langchain_nomic.md b/reference/python/docs/integrations/langchain_nomic.md index 30a6b6a2a..00de7a419 100644 --- a/reference/python/docs/integrations/langchain_nomic.md +++ b/reference/python/docs/integrations/langchain_nomic.md @@ -4,4 +4,8 @@ title: Nomic - LangChain Integration Reference # `langchain-nomic` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-nomic?label=%20)](https://pypi.org/project/langchain-nomic/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-nomic)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-nomic)](https://pypistats.org/packages/langchain-nomic) + ::: langchain_nomic diff --git a/reference/python/docs/integrations/langchain_nvidia_ai_endpoints.md b/reference/python/docs/integrations/langchain_nvidia_ai_endpoints.md index 57d56192b..74b75358f 100644 --- a/reference/python/docs/integrations/langchain_nvidia_ai_endpoints.md +++ b/reference/python/docs/integrations/langchain_nvidia_ai_endpoints.md @@ -4,4 +4,8 @@ title: Nvidia AI Endpoints - LangChain Integration Reference # :simple-nvidia:{ .lg .middle } `langchain-nvidia-ai-endpoints` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-nvidia-ai-endpoints?label=%20)](https://pypi.org/project/langchain-nvidia-ai-endpoints/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-nvidia-ai-endpoints)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-nvidia-ai-endpoints)](https://pypistats.org/packages/langchain-nvidia-ai-endpoints) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/nvidia_ai_endpoints/index.html). diff --git a/reference/python/docs/integrations/langchain_ollama.md b/reference/python/docs/integrations/langchain_ollama.md index daad7e6b2..df2cb5253 100644 --- a/reference/python/docs/integrations/langchain_ollama.md +++ b/reference/python/docs/integrations/langchain_ollama.md @@ -4,4 +4,8 @@ title: Ollama - LangChain Integration Reference # :simple-ollama:{ .lg .middle } `langchain-ollama` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-ollama?label=%20)](https://pypi.org/project/langchain-ollama/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-ollama)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-ollama)](https://pypistats.org/packages/langchain-ollama) + ::: langchain_ollama diff --git a/reference/python/docs/integrations/langchain_openai/index.md b/reference/python/docs/integrations/langchain_openai/index.md index f49bb47ab..e0ec9be34 100644 --- a/reference/python/docs/integrations/langchain_openai/index.md +++ b/reference/python/docs/integrations/langchain_openai/index.md @@ -4,6 +4,11 @@ title: OpenAI - LangChain Integration Reference # :fontawesome-brands-openai:{ .lg .middle } `langchain-openai` -Use the sidebar to navigate the various modules in this package. +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-openai?label=%20)](https://pypi.org/project/langchain-openai/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-openai)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-openai)](https://pypistats.org/packages/langchain-openai) -Refer to [the docs](https://docs.langchain.com/oss/python/integrations/providers/openai) for a high-level guide on how to use each module. These reference pages contain auto-generated API documentation for each module, focusing on the "what" rather than the "how" or "why" (i.e. no end-to-end tutorials or conceptual overviews). +## Modules + +!!! note "Usage Documentation" + Refer to [the docs](https://docs.langchain.com/oss/python/integrations/providers/openai) for a high-level guide on how to use each module. These reference pages contain auto-generated API documentation for each module, focusing on the "what" rather than the "how" or "why" (i.e. no end-to-end tutorials or conceptual overviews). diff --git a/reference/python/docs/integrations/langchain_perplexity.md b/reference/python/docs/integrations/langchain_perplexity.md index 313da9c3e..8401e5375 100644 --- a/reference/python/docs/integrations/langchain_perplexity.md +++ b/reference/python/docs/integrations/langchain_perplexity.md @@ -4,4 +4,8 @@ title: Perplexity - LangChain Integration Reference # :simple-perplexity:{ .lg .middle } `langchain-perplexity` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-perplexity?label=%20)](https://pypi.org/project/langchain-perplexity/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-perplexity)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-perplexity)](https://pypistats.org/packages/langchain-perplexity) + ::: langchain_perplexity diff --git a/reference/python/docs/integrations/langchain_pinecone.md b/reference/python/docs/integrations/langchain_pinecone.md index 53f555f44..63342a8ec 100644 --- a/reference/python/docs/integrations/langchain_pinecone.md +++ b/reference/python/docs/integrations/langchain_pinecone.md @@ -4,4 +4,8 @@ title: Pinecone - LangChain Integration Reference # `langchain-pinecone` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-pinecone?label=%20)](https://pypi.org/project/langchain-pinecone/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-pinecone)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-pinecone)](https://pypistats.org/packages/langchain-pinecone) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/pinecone/index.html). diff --git a/reference/python/docs/integrations/langchain_postgres.md b/reference/python/docs/integrations/langchain_postgres.md index ef51ce781..83e0a3f76 100644 --- a/reference/python/docs/integrations/langchain_postgres.md +++ b/reference/python/docs/integrations/langchain_postgres.md @@ -4,4 +4,8 @@ title: Postgres - LangChain Integration Reference # :simple-postgresql:{ .lg .middle } `langchain-postgres` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-postgres?label=%20)](https://pypi.org/project/langchain-postgres/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-postgres)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-postgres)](https://pypistats.org/packages/langchain-postgres) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/postgres/index.html). diff --git a/reference/python/docs/integrations/langchain_prompty.md b/reference/python/docs/integrations/langchain_prompty.md index cf71f751b..1ef5ba205 100644 --- a/reference/python/docs/integrations/langchain_prompty.md +++ b/reference/python/docs/integrations/langchain_prompty.md @@ -4,4 +4,8 @@ title: Prompty - LangChain Integration Reference # :material-microsoft:{ .lg .middle } `langchain-prompty` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-prompty?label=%20)](https://pypi.org/project/langchain-prompty/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-prompty)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-prompty)](https://pypistats.org/packages/langchain-prompty) + ::: langchain_prompty diff --git a/reference/python/docs/integrations/langchain_qdrant.md b/reference/python/docs/integrations/langchain_qdrant.md index a835de932..356b70807 100644 --- a/reference/python/docs/integrations/langchain_qdrant.md +++ b/reference/python/docs/integrations/langchain_qdrant.md @@ -4,4 +4,8 @@ title: Qdrant - LangChain Integration Reference # `langchain-qdrant` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-qdrant?label=%20)](https://pypi.org/project/langchain-qdrant/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-qdrant)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-qdrant)](https://pypistats.org/packages/langchain-qdrant) + ::: langchain_qdrant diff --git a/reference/python/docs/integrations/langchain_redis.md b/reference/python/docs/integrations/langchain_redis.md index ce0812816..2ec0b458c 100644 --- a/reference/python/docs/integrations/langchain_redis.md +++ b/reference/python/docs/integrations/langchain_redis.md @@ -4,4 +4,8 @@ title: Redis - LangChain Integration Reference # :simple-redis:{ .lg .middle } `langchain-redis` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-redis?label=%20)](https://pypi.org/project/langchain-redis/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-redis)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-redis)](https://pypistats.org/packages/langchain-redis) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/redis/index.html). diff --git a/reference/python/docs/integrations/langchain_sema4.md b/reference/python/docs/integrations/langchain_sema4.md index c0e8ef3ed..b564a78b4 100644 --- a/reference/python/docs/integrations/langchain_sema4.md +++ b/reference/python/docs/integrations/langchain_sema4.md @@ -4,4 +4,8 @@ title: Sema4 - LangChain Integration Reference # `langchain-sema4` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-sema4?label=%20)](https://pypi.org/project/langchain-sema4/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-sema4)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-sema4)](https://pypistats.org/packages/langchain-sema4) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/sema4/index.html). diff --git a/reference/python/docs/integrations/langchain_snowflake.md b/reference/python/docs/integrations/langchain_snowflake.md index 331e81159..2a8fe76a0 100644 --- a/reference/python/docs/integrations/langchain_snowflake.md +++ b/reference/python/docs/integrations/langchain_snowflake.md @@ -4,4 +4,8 @@ title: Snowflake - LangChain Integration Reference # `langchain-snowflake` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-snowflake?label=%20)](https://pypi.org/project/langchain-snowflake/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-snowflake)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-snowflake)](https://pypistats.org/packages/langchain-snowflake) + This package ref has not yet been migrated to v1. diff --git a/reference/python/docs/integrations/langchain_sqlserver.md b/reference/python/docs/integrations/langchain_sqlserver.md index 61ea69769..5f49fea4e 100644 --- a/reference/python/docs/integrations/langchain_sqlserver.md +++ b/reference/python/docs/integrations/langchain_sqlserver.md @@ -4,4 +4,8 @@ title: SQL Server - LangChain Integration Reference # :simple-sqlite:{ .lg .middle } `langchain-sqlserver` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-sqlserver?label=%20)](https://pypi.org/project/langchain-sqlserver/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-sqlserver)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-sqlserver)](https://pypistats.org/packages/langchain-sqlserver) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/sqlserver/index.html). diff --git a/reference/python/docs/integrations/langchain_tavily.md b/reference/python/docs/integrations/langchain_tavily.md index 1a7103c7d..6ece0f422 100644 --- a/reference/python/docs/integrations/langchain_tavily.md +++ b/reference/python/docs/integrations/langchain_tavily.md @@ -4,4 +4,8 @@ title: Tavily - LangChain Integration Reference # `langchain-tavily` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-tavily?label=%20)](https://pypi.org/project/langchain-tavily/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-tavily)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-tavily)](https://pypistats.org/packages/langchain-tavily) + ::: langchain_tavily diff --git a/reference/python/docs/integrations/langchain_together.md b/reference/python/docs/integrations/langchain_together.md index bf90451d5..5211c27ff 100644 --- a/reference/python/docs/integrations/langchain_together.md +++ b/reference/python/docs/integrations/langchain_together.md @@ -4,4 +4,8 @@ title: Together - LangChain Integration Reference # `langchain-together` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-together?label=%20)](https://pypi.org/project/langchain-together/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-together)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-together)](https://pypistats.org/packages/langchain-together) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/together/index.html). diff --git a/reference/python/docs/integrations/langchain_unstructured.md b/reference/python/docs/integrations/langchain_unstructured.md index 0b5f1c422..643271bce 100644 --- a/reference/python/docs/integrations/langchain_unstructured.md +++ b/reference/python/docs/integrations/langchain_unstructured.md @@ -4,4 +4,8 @@ title: Unstructured - LangChain Integration Reference # `langchain-unstructured` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-unstructured?label=%20)](https://pypi.org/project/langchain-unstructured/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-unstructured)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-unstructured)](https://pypistats.org/packages/langchain-unstructured) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/unstructured/index.html). diff --git a/reference/python/docs/integrations/langchain_upstage.md b/reference/python/docs/integrations/langchain_upstage.md index d9231fe42..e79edb228 100644 --- a/reference/python/docs/integrations/langchain_upstage.md +++ b/reference/python/docs/integrations/langchain_upstage.md @@ -4,4 +4,8 @@ title: Upstage - LangChain Integration Reference # `langchain-upstage` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-upstage?label=%20)](https://pypi.org/project/langchain-upstage/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-upstage)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-upstage)](https://pypistats.org/packages/langchain-upstage) + This package ref has not yet been migrated to v1. diff --git a/reference/python/docs/integrations/langchain_weaviate.md b/reference/python/docs/integrations/langchain_weaviate.md index 464bb2ef0..a32d981a4 100644 --- a/reference/python/docs/integrations/langchain_weaviate.md +++ b/reference/python/docs/integrations/langchain_weaviate.md @@ -4,4 +4,8 @@ title: Weaviate - LangChain Integration Reference # `langchain-weaviate` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-weaviate?label=%20)](https://pypi.org/project/langchain-weaviate/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-weaviate)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-weaviate)](https://pypistats.org/packages/langchain-weaviate) + This package ref has not yet been migrated to v1. See the [old ref](https://python.langchain.com/api_reference/weaviate/index.html). diff --git a/reference/python/docs/integrations/langchain_xai.md b/reference/python/docs/integrations/langchain_xai.md index 96bf9f2d0..d80e7cce3 100644 --- a/reference/python/docs/integrations/langchain_xai.md +++ b/reference/python/docs/integrations/langchain_xai.md @@ -4,4 +4,8 @@ title: xAI - LangChain Integration Reference # `langchain-xai` +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-xai?label=%20)](https://pypi.org/project/langchain-xai/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-xai)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-xai)](https://pypistats.org/packages/langchain-xai) + ::: langchain_xai diff --git a/reference/python/docs/langchain/index.md b/reference/python/docs/langchain/index.md index bc360ab59..8f07b0a26 100644 --- a/reference/python/docs/langchain/index.md +++ b/reference/python/docs/langchain/index.md @@ -6,8 +6,32 @@ hide: Welcome to the LangChain package reference documentation! -There are three main packages in the LangChain ecosystem, though most users will primarily interact with the main `langchain` package: +There are three main packages in the LangChain ecosystem, though most users will primarily interact with the main [`langchain`](./index.md) package: -- [`langchain`](./index.md): The main entrypoint containing all implementations you need for building applications with models. -- [`langchain-core`](../langchain_core/index.md): Core interfaces and abstractions used across the LangChain ecosystem. -- [`langchain-classic`](../langchain_classic/index.md): WIP. +
+ +- __`langchain`__ + + --- + + The main entrypoint containing all implementations you need for building applications with LLMs. + + [:octicons-arrow-right-24: Reference](./index.md) + +- __`langchain-core`__ + + --- + + Core interfaces and abstractions used across the LangChain ecosystem. + + [:octicons-arrow-right-24: Reference](../langchain_core/index.md) + +- __`langchain-classic`__ + + --- + + Description WIP. + + [:octicons-arrow-right-24: Reference](../langchain_classic/index.md) + +
diff --git a/reference/python/docs/langchain/langchain/index.md b/reference/python/docs/langchain/langchain/index.md index 69c921a3a..4f3acde37 100644 --- a/reference/python/docs/langchain/langchain/index.md +++ b/reference/python/docs/langchain/langchain/index.md @@ -1,5 +1,9 @@ # `langchain` -Documentation for the `langchain` package. +[![PyPI - Version](https://img.shields.io/pypi/v/langchain?label=%20)](https://pypi.org/project/langchain/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain)](https://pypistats.org/packages/langchain) + +Reference documentation for the [`langchain`](https://pypi.org/project/langchain/) package. TODO: expand overview (follow LangGraph example) diff --git a/reference/python/docs/langchain_classic/index.md b/reference/python/docs/langchain_classic/index.md index edea89271..c49c0ad15 100644 --- a/reference/python/docs/langchain_classic/index.md +++ b/reference/python/docs/langchain_classic/index.md @@ -1,5 +1,9 @@ # `langchain_classic` -Documentation for the `langchain-classic` package. +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-classic?label=%20)](https://pypi.org/project/langchain-classic/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-classic)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-classic)](https://pypistats.org/packages/langchain-classic) + +Reference documentation for the [`langchain-classic`](https://pypi.org/project/langchain-classic/) package. TODO: expand overview (follow LangGraph example) diff --git a/reference/python/docs/langchain_core/index.md b/reference/python/docs/langchain_core/index.md index 9eafac2b5..55bc5e339 100644 --- a/reference/python/docs/langchain_core/index.md +++ b/reference/python/docs/langchain_core/index.md @@ -1,5 +1,9 @@ # `langchain_core` -Documentation for the `langchain-core` package. +[![PyPI - Version](https://img.shields.io/pypi/v/langchain-core?label=%20)](https://pypi.org/project/langchain-core/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langchain-core)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-core)](https://pypistats.org/packages/langchain-core) + +Reference documentation for the [`langchain-core`](https://pypi.org/project/langchain-core/) package. TODO: expand overview (follow LangGraph example) diff --git a/reference/python/docs/langgraph/index.md b/reference/python/docs/langgraph/index.md index 5bb99f145..575039f9a 100644 --- a/reference/python/docs/langgraph/index.md +++ b/reference/python/docs/langgraph/index.md @@ -4,6 +4,10 @@ hide: - toc --- +[![PyPI - Version](https://img.shields.io/pypi/v/langgraph?label=%20)](https://pypi.org/project/langgraph/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langgraph)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langgraph)](https://pypistats.org/packages/langgraph) + Welcome to the LangGraph reference docs! These pages detail the core interfaces you will use when building with LangGraph. Each section covers a different part of the ecosystem. ## `langgraph` diff --git a/reference/python/docs/platform/python_sdk.md b/reference/python/docs/platform/python_sdk.md index 3b6a6edbe..d1f928ee3 100644 --- a/reference/python/docs/platform/python_sdk.md +++ b/reference/python/docs/platform/python_sdk.md @@ -1,5 +1,9 @@ # LangGraph Platform SDK Reference +[![PyPI - Version](https://img.shields.io/pypi/v/langgraph-sdk?label=%20)](https://pypi.org/project/langgraph-sdk/#history) +[![PyPI - License](https://img.shields.io/pypi/l/langgraph-sdk)](https://opensource.org/licenses/MIT) +[![PyPI - Downloads](https://img.shields.io/pepy/dt/langgraph-sdk)](https://pypistats.org/packages/langgraph-sdk) + ::: langgraph_sdk.client handler: python diff --git a/reference/python/mkdocs.yml b/reference/python/mkdocs.yml index cd951d186..652d4c365 100644 --- a/reference/python/mkdocs.yml +++ b/reference/python/mkdocs.yml @@ -525,9 +525,6 @@ extra_javascript: # https://www.mkdocs.org/user-guide/configuration/#extra_templates # extra_templates: -copyright: > - Copyright © 2025 - # https://www.mkdocs.org/user-guide/configuration/#extra extra: social: diff --git a/reference/python/pyproject.prod.toml b/reference/python/pyproject.prod.toml index c71a0e583..c97e6d965 100644 --- a/reference/python/pyproject.prod.toml +++ b/reference/python/pyproject.prod.toml @@ -49,7 +49,7 @@ dependencies = [ "langchain-qdrant", "langchain-xai", #"langchain-experimental", - "langchain-community", + #"langchain-community", "langchain-mcp-adapters", "langchain-astradb", #"langchain-ai21", diff --git a/reference/python/pyproject.toml b/reference/python/pyproject.toml index c71a0e583..c97e6d965 100644 --- a/reference/python/pyproject.toml +++ b/reference/python/pyproject.toml @@ -49,7 +49,7 @@ dependencies = [ "langchain-qdrant", "langchain-xai", #"langchain-experimental", - "langchain-community", + #"langchain-community", "langchain-mcp-adapters", "langchain-astradb", #"langchain-ai21", diff --git a/reference/python/uv.lock b/reference/python/uv.lock index 89d1d97fd..2bfedf277 100644 --- a/reference/python/uv.lock +++ b/reference/python/uv.lock @@ -1671,7 +1671,7 @@ wheels = [ [[package]] name = "langchain" version = "1.0.0a14" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Flangchain_v1#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Flangchain_v1#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "langgraph" }, @@ -1681,7 +1681,7 @@ dependencies = [ [[package]] name = "langchain-anthropic" version = "1.0.0a4" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fanthropic#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fanthropic#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "anthropic" }, { name = "langchain-core" }, @@ -1691,7 +1691,7 @@ dependencies = [ [[package]] name = "langchain-astradb" version = "0.6.1" -source = { git = "https://github.com/langchain-ai/langchain-datastax.git?subdirectory=libs%2Fastradb#42782e7b617b0d737e130aa4891f41ce170f18eb" } +source = { git = "https://github.com/langchain-ai/langchain-datastax.git?subdirectory=libs%2Fastradb#8d4faadac755c4ac996eed10737806ebe5af88a6" } dependencies = [ { name = "astrapy" }, { name = "langchain-core" }, @@ -1701,7 +1701,7 @@ dependencies = [ [[package]] name = "langchain-aws" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain-aws.git?subdirectory=libs%2Faws#24f60270925963c2b4c9f9d198df435ddf106eb9" } +source = { git = "https://github.com/langchain-ai/langchain-aws.git?subdirectory=libs%2Faws#f36bec98f64b65ad4c884b29e5b79469df08b3c3" } dependencies = [ { name = "boto3" }, { name = "langchain-core" }, @@ -1712,7 +1712,7 @@ dependencies = [ [[package]] name = "langchain-chroma" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fchroma#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fchroma#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "chromadb" }, { name = "langchain-core" }, @@ -1722,7 +1722,7 @@ dependencies = [ [[package]] name = "langchain-classic" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Flangchain#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Flangchain#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "langchain-text-splitters" }, @@ -1736,7 +1736,7 @@ dependencies = [ [[package]] name = "langchain-community" version = "0.3.31" -source = { git = "https://github.com/langchain-ai/langchain-community.git?subdirectory=libs%2Fcommunity#e807a4c0c3a157eb3770f4fad437a5e9abfed049" } +source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "aiohttp" }, { name = "dataclasses-json" }, @@ -1751,11 +1751,15 @@ dependencies = [ { name = "sqlalchemy" }, { name = "tenacity" }, ] +sdist = { url = "https://files.pythonhosted.org/packages/83/49/2ff5354273809e9811392bc24bcffda545a196070666aef27bc6aacf1c21/langchain_community-0.3.31.tar.gz", hash = "sha256:250e4c1041539130f6d6ac6f9386cb018354eafccd917b01a4cff1950b80fd81", size = 33241237, upload-time = "2025-10-07T20:17:57.857Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e6/0a/b8848db67ad7c8d4652cb6f4cb78d49b5b5e6e8e51d695d62025aa3f7dbc/langchain_community-0.3.31-py3-none-any.whl", hash = "sha256:1c727e3ebbacd4d891b07bd440647668001cea3e39cbe732499ad655ec5cb569", size = 2532920, upload-time = "2025-10-07T20:17:54.91Z" }, +] [[package]] name = "langchain-core" version = "1.0.0a8" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fcore#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fcore#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "jsonpatch" }, { name = "langsmith" }, @@ -1769,7 +1773,7 @@ dependencies = [ [[package]] name = "langchain-deepseek" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fdeepseek#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fdeepseek#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "langchain-openai" }, @@ -1778,7 +1782,7 @@ dependencies = [ [[package]] name = "langchain-exa" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fexa#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fexa#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "exa-py" }, { name = "langchain-core" }, @@ -1787,7 +1791,7 @@ dependencies = [ [[package]] name = "langchain-fireworks" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Ffireworks#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Ffireworks#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "aiohttp" }, { name = "fireworks-ai" }, @@ -1799,7 +1803,7 @@ dependencies = [ [[package]] name = "langchain-google-community" version = "2.0.10" -source = { git = "https://github.com/langchain-ai/langchain-google.git?subdirectory=libs%2Fcommunity#33f015b490b80348eed3979a1837b9e131da343b" } +source = { git = "https://github.com/langchain-ai/langchain-google.git?subdirectory=libs%2Fcommunity#fb85af64f9a135bb3e6ce89e7311da315328039c" } dependencies = [ { name = "google-api-core" }, { name = "google-api-python-client" }, @@ -1813,7 +1817,7 @@ dependencies = [ [[package]] name = "langchain-google-genai" version = "2.1.12" -source = { git = "https://github.com/langchain-ai/langchain-google.git?subdirectory=libs%2Fgenai#33f015b490b80348eed3979a1837b9e131da343b" } +source = { git = "https://github.com/langchain-ai/langchain-google.git?subdirectory=libs%2Fgenai#fb85af64f9a135bb3e6ce89e7311da315328039c" } dependencies = [ { name = "filetype" }, { name = "google-ai-generativelanguage" }, @@ -1824,7 +1828,7 @@ dependencies = [ [[package]] name = "langchain-google-vertexai" version = "2.1.2" -source = { git = "https://github.com/langchain-ai/langchain-google.git?subdirectory=libs%2Fvertexai#33f015b490b80348eed3979a1837b9e131da343b" } +source = { git = "https://github.com/langchain-ai/langchain-google.git?subdirectory=libs%2Fvertexai#fb85af64f9a135bb3e6ce89e7311da315328039c" } dependencies = [ { name = "bottleneck" }, { name = "google-cloud-aiplatform" }, @@ -1841,7 +1845,7 @@ dependencies = [ [[package]] name = "langchain-groq" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fgroq#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fgroq#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "groq" }, { name = "langchain-core" }, @@ -1873,7 +1877,7 @@ dependencies = [ [[package]] name = "langchain-nomic" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fnomic#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fnomic#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "nomic" }, @@ -1883,7 +1887,7 @@ dependencies = [ [[package]] name = "langchain-ollama" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Follama#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Follama#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "ollama" }, @@ -1892,7 +1896,7 @@ dependencies = [ [[package]] name = "langchain-openai" version = "1.0.0a4" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fopenai#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fopenai#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "openai" }, @@ -1902,7 +1906,7 @@ dependencies = [ [[package]] name = "langchain-perplexity" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fperplexity#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fperplexity#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "openai" }, @@ -1911,7 +1915,7 @@ dependencies = [ [[package]] name = "langchain-prompty" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fprompty#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fprompty#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "pyyaml" }, @@ -1920,7 +1924,7 @@ dependencies = [ [[package]] name = "langchain-qdrant" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fqdrant#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fqdrant#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, { name = "pydantic" }, @@ -1939,7 +1943,6 @@ dependencies = [ { name = "langchain-aws" }, { name = "langchain-chroma" }, { name = "langchain-classic" }, - { name = "langchain-community" }, { name = "langchain-core" }, { name = "langchain-deepseek" }, { name = "langchain-exa" }, @@ -1988,7 +1991,6 @@ requires-dist = [ { name = "langchain-aws", git = "https://github.com/langchain-ai/langchain-aws.git?subdirectory=libs%2Faws" }, { name = "langchain-chroma", git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fchroma" }, { name = "langchain-classic", git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Flangchain" }, - { name = "langchain-community", git = "https://github.com/langchain-ai/langchain-community.git?subdirectory=libs%2Fcommunity" }, { name = "langchain-core", git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fcore" }, { name = "langchain-deepseek", git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fdeepseek" }, { name = "langchain-exa", git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fexa" }, @@ -2042,7 +2044,7 @@ dependencies = [ [[package]] name = "langchain-text-splitters" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Ftext-splitters#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Ftext-splitters#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "langchain-core" }, ] @@ -2050,7 +2052,7 @@ dependencies = [ [[package]] name = "langchain-xai" version = "1.0.0a1" -source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fxai#961f965f0cba25a5acb54571a56b0cb7979137b2" } +source = { git = "https://github.com/langchain-ai/langchain.git?subdirectory=libs%2Fpartners%2Fxai#53e9f00804b8c285925ee2449284324b80f19f6a" } dependencies = [ { name = "aiohttp" }, { name = "langchain-core" }, diff --git a/src/docs.json b/src/docs.json index d1905a007..ad7d21010 100644 --- a/src/docs.json +++ b/src/docs.json @@ -397,8 +397,7 @@ "icon": "heart-circle-plus", "pages": [ "oss/python/contributing/documentation", - "oss/python/contributing/code", - "oss/python/contributing/review" + "oss/python/contributing/code" ] }, { @@ -729,8 +728,7 @@ "icon": "heart-circle-plus", "pages": [ "oss/javascript/contributing/documentation", - "oss/javascript/contributing/code", - "oss/javascript/contributing/review" + "oss/javascript/contributing/code" ] }, { diff --git a/src/oss/contributing/code.mdx b/src/oss/contributing/code.mdx index 9e7b30107..c358133e3 100644 --- a/src/oss/contributing/code.mdx +++ b/src/oss/contributing/code.mdx @@ -3,7 +3,7 @@ title: Contributing to code sidebarTitle: Code --- -Code contributions are welcome! Whether you're fixing bugs, adding features, or improving performance, your contributions help deliver a better developer experience for everyone. +Code contributions are always welcome! Whether you're fixing bugs, adding features, or improving performance, your contributions help deliver a better developer experience for thousands of developers. Before submitting large **new features or refactors**, please first discuss your ideas in [the forum](https://forum.langchain.com/). This ensures alignment with project goals and prevents duplicate work. @@ -30,7 +30,7 @@ Aim to follow these core principles for all code contributions: Follow consistent style, documentation, and architecture patterns - + Prioritize secure coding practices and vulnerability prevention @@ -70,6 +70,8 @@ For simple bugfixes, you can get started immediately: # Inside your repo, install dependencies uv sync --all-groups ``` + + You will need to install [`uv`](https://docs.astral.sh/uv/) if you haven't previously. ::: :::js @@ -160,7 +162,7 @@ For ongoing development or larger contributions: - Set up your environment following our [setup guide](#development-environment) + Set up your environment following our [setup guide](#development-environment) below @@ -180,21 +182,21 @@ For ongoing development or larger contributions: :::python - Our Python projects use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for dependency management. Make sure you have the latest version of `uv` installed. + Our Python projects use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for dependency management. Make sure you have the latest version installed. ::: :::js - Our JS/TS projects uses [`pnpm`](https://pnpm.io/) for dependency management. Make sure you have the latest version of `pnpm` installed, or run `corepack enable` (on Node 24+) to setup the required pnpm version. + Our JS/TS projects uses [`pnpm`](https://pnpm.io/) for dependency management. Make sure you have the latest version installed, or run `corepack enable` (on Node 24+) to setup the required pnpm version. ::: -Set up a development environment for the package(s) you're working on: +Set up a development environment for the package(s) you're working on. - + For changes to `langchain-core`: :::python @@ -242,6 +244,7 @@ Set up a development environment for the package(s) you're working on: ```bash cd libs/partners/langchain-{partner} + uv sync --all-groups make test # Ensure tests pass before starting development ``` @@ -258,10 +261,11 @@ Set up a development environment for the package(s) you're working on: ::: :::python - For changes to [community integrations](https://github.com/langchain-ai/langchain-community) (located in a separate repo): + For changes to community integrations (located in a [separate repo](https://github.com/langchain-ai/langchain-community)): ```bash cd libs/community/langchain_community/path/to/integration + uv sync --all-groups make test # Ensure tests pass before starting development ``` @@ -279,7 +283,7 @@ Set up a development environment for the package(s) you're working on: - WIP - coming soon! + WIP - coming soon! In the meantime, follow instructions for LangChain. @@ -294,24 +298,23 @@ Set up a development environment for the package(s) you're working on: :::python - - **[`langchain-core`](https://github.com/langchain-ai/langchain/tree/master/libs/core#readme)** (located in `libs/core/`): Base interfaces and core abstractions - **[`langchain`](https://github.com/langchain-ai/langchain/tree/master/libs/langchain#readme)** (located in `libs/langchain/`): Main package with chains, agents, and retrieval logic + - **[`langchain-core`](https://github.com/langchain-ai/langchain/tree/master/libs/core#readme)** (located in `libs/core/`): Base interfaces and core abstractions ::: :::js - - **[`@langchain/core`](https://github.com/langchain-ai/langchainjs/tree/main/langchain-core#readme)** (located in `libs/langchain-core/`): Base interfaces and core abstractions - **[`langchain`](https://github.com/langchain-ai/langchainjs/tree/main/langchain#readme)** (located in `libs/langchain/`): Main package with chains, agents, and retrieval logic + - **[`@langchain/core`](https://github.com/langchain-ai/langchainjs/tree/main/langchain-core#readme)** (located in `libs/langchain-core/`): Base interfaces and core abstractions ::: - :::python Located in `libs/partners/`, these are independently versioned packages for specific integrations. For example: - **[`langchain-openai`](https://github.com/langchain-ai/langchain/tree/master/libs/partners/openai#readme)**: [OpenAI](/oss/integrations/providers/openai) integrations - **[`langchain-anthropic`](https://github.com/langchain-ai/langchain/tree/master/libs/partners/anthropic#readme)**: [Anthropic](/oss/integrations/providers/anthropic) integrations - **[`langchain-google-genai`](https://github.com/langchain-ai/langchain-google/)**: [Google Generative AI](/oss/integrations/chat/google_generative_ai) integrations - Many partner packages are in external repositories. Please check the [list of integrations](/oss/integrations/providers) for details. + Many partner packages are in external repositories. Please check the [list of integrations](/oss/integrations/providers/overview) for details. ::: :::js Located in `libs/providers/`, these are independently versioned packages for specific integrations. For example: @@ -339,7 +342,7 @@ Set up a development environment for the package(s) you're working on: - WIP - coming soon! + WIP - coming soon! In the meantime, follow instructions for LangChain. @@ -776,7 +779,7 @@ Before submitting your PR, ensure you have completed the following steps. Note t - WIP - coming soon! + WIP - coming soon! In the meantime, follow instructions for LangChain. @@ -888,7 +891,7 @@ In order to write effective tests, there's a few good practices to follow: ## Getting help -Our goal is to have the simplest developer setup possible. Should you experience any difficulty getting setup, please ask in the [community slack](https://www.langchain.com/join-community) or open a [forum post](https://forum.langchain.com/). +Our goal is to have the most accessible developer setup possible. Should you experience any difficulty getting setup, please ask in the [community slack](https://www.langchain.com/join-community) or open a [forum post](https://forum.langchain.com/). You're now ready to contribute high-quality code to LangChain! diff --git a/src/oss/contributing/documentation.mdx b/src/oss/contributing/documentation.mdx index a0b2fbc87..a23bc6695 100644 --- a/src/oss/contributing/documentation.mdx +++ b/src/oss/contributing/documentation.mdx @@ -6,7 +6,7 @@ sidebarTitle: Documentation Accessible documentation is a vital part of LangChain. We welcome both new documentation for new features/integrations, as well as community improvements to existing docs. - We generally do not merge new tutorials from outside contributors without an acute need. + We generally do not merge new tutorials from outside contributors without an acute need. If you feel that a certain topic is missing from docs or is not sufficiently covered, please [open a new issue](https://github.com/langchain-ai/docs/issues). All documentation falls under one of four categories: @@ -20,7 +20,7 @@ All documentation falls under one of four categories: Technical descriptions of APIs and implementation details - + Lessons that guide users through practical activities to build understanding @@ -39,17 +39,17 @@ For simple changes like fixing typos, you can edit directly on GitHub without se **Prerequisites:** - - A GitHub account - - Basic familiarity with GitHub's web interface for pull requests + - A [GitHub](https://github.com/) account + - Basic familiarity of the [fork-and-pull workflow](https://graphite.dev/guides/understanding-git-fork-pull-request-workflow) for contributing - Navigate to any documentation page and click the "suggest edits" link at the bottom + Navigate to any documentation page, scroll to the bottom of the page, and click the link "Edit the source of this page on GitHub" - GitHub will prompt you to fork the repository to your account. Make sure to fork into your personal account! + GitHub will prompt you to fork the repository to your account. Make sure to fork into your personal account @@ -57,100 +57,27 @@ For simple changes like fixing typos, you can edit directly on GitHub without se - Click `Commit changes...` and give your commit a descriptive title like `fix(docs): description` + Click `Commit changes...` and give your commit a descriptive title like `fix(docs): summary of change`. If applicable, add an [extended description](https://www.gitkraken.com/learn/git/best-practices/git-commit-message#git-commit-message-structure) - GitHub will redirect you to create a pull request. Title it like `docs: Fix typo in X` and follow the PR template checklist + GitHub will redirect you to create a pull request. Give it a title (often the same as the commit) and follow the PR template checklist, if present - Docs PRs are typically reviewed within a few days. Keep an eye on your PR to address any feedback from maintainers. + Docs PRs are typically reviewed within a few days. Keep an eye on your PR to address any feedback from maintainers. Do not bump the PR unless you have new information to provide - maintainers will address it as their availability permits. ### Full development IDE setup -For larger changes or ongoing contributions, set up a local development environment. Our documentation is built using [Mintlify](https://mintlify.com/), which offers local preview and live reload as you edit. (Note: reference docs are built following a different process - continue below for details.) +For larger changes or ongoing contributions, it's important to set up a local development environment on your machine. Our documentation build pipeline offers local preview and live reload as you edit, important for ensuring your changes appear as intended before submitting. - - - Clone our [documentation repository](https://github.com/langchain-ai/docs) - - - - Review the [Mintlify documentation](https://mintlify.com/docs) for component usage and best practices - you can also refer to existing docs for examples - - - - Set up your development environment following our the steps below - - - - -This repository includes configuration files to ensure consistent formatting across different editors: - - - - Settings in `.vscode/settings.json` are automatically applied when you open the project. No additional setup required. - - **Recommended extensions:** - - [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - - [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) - - [MDX](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) - - When you open the "Extensions" tab in VSCode, it may prompt you to install these extensions automatically. - - - - Most modern IDEs support [EditorConfig](https://editorconfig.org/). The `.editorconfig` file automatically configures: - - IntelliJ IDEA / PyCharm / WebStorm - - Sublime Text / Atom - - Vim / Emacs - - Install the [EditorConfig plugin](https://editorconfig.org/) if needed and restart your IDE. - - - -{/* ### Build system - - - Only edit files in `src/` - The `build/` directory is automatically generated! - - -Our documentation uses a build pipeline that allows us to write in MDX and use Mintlify components. The source files are in `src/` and the built output is in `build/`. You are able to run a local development server with hot reload to see changes in your browser immediately. - - - - You will need to install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) and [`mint`](https://mintlify.com/docs/installation) if you haven't already. Also, be sure to [clone the docs](#full-development-setup) repository - - ```bash - cd docs - uv venv - source .venv/bin/activate - uv sync --all-groups - npm i -g mint - ``` - - - - Run from the project root: - - ```bash - docs dev - ``` - - This starts a development server with hot reload at http://localhost:3000 (unless overridden). - - - - Edit files in `src/` and see changes reflected immediately in your browser - - */} +Please review the steps to set up your environment outlined in the docs repo [`README.md`](https://github.com/langchain-ai/docs?tab=readme-ov-file#contributing). --- -## Documentation types +## Documentation types Where applicable, all documentation must have translations in both Python and JavaScript/TypeScript. See [our localization guide](#localization) for details. @@ -169,7 +96,7 @@ Conceptual guide cover core concepts abstractly, providing deep understanding. - - Explain design decisions - *why does concept X exist?* + - Explain design decisions - *"why does concept X exist?"* - Use analogies and reference alternatives - Avoid blending in too much reference content - Link to related tutorials and how-to guides @@ -178,8 +105,8 @@ Conceptual guide cover core concepts abstractly, providing deep understanding. - - + + @@ -188,9 +115,13 @@ Conceptual guide cover core concepts abstractly, providing deep understanding. Reference documentation contains detailed, low-level information describing exactly what functionality exists and how to use it. -**Existing references** -- [LangChain Python API reference](https://reference.langchain.com/python/) -- [LangChain JavaScript/TypeScript API reference](https://reference.langchain.com/javascript/) +:::python + +::: + +:::js + +::: A good reference should: - Describe what exists (all parameters, options, return values) @@ -208,7 +139,7 @@ A good reference should: - - Be consistent; follow existing patterns for provider-specific documentation + - **Be consistent**; follow existing patterns for provider-specific documentation - Include both basic usage (code snippets) and common edge cases/failure modes - Note when features require specific versions @@ -223,7 +154,7 @@ A good reference should: --- -## Writing standard +## Writing standard :::python @@ -296,7 +227,7 @@ Content for both languages (not wrapped) --- -## Quality standards +## Quality standards ### General guidelines @@ -352,7 +283,7 @@ Before submitting documentation: --- -## In-code documentation +## In-code documentation ### Language and style @@ -418,5 +349,5 @@ def filter_unknown_users(users: list[str], known_users: set[str]) -> list[str]: Our goal is to have the simplest developer setup possible. Should you experience any difficulty getting setup, please ask in the [community slack](https://www.langchain.com/join-community) or open a [forum post](https://forum.langchain.com/). - You now have everything you need to contribute high-quality documentation to LangChain! + You now have everything you need to contribute high-quality documentation to LangChain! 🎤🦜 diff --git a/src/oss/contributing/implement-langchain.mdx b/src/oss/contributing/implement-langchain.mdx index 60eaad6f7..65ee25ebd 100644 --- a/src/oss/contributing/implement-langchain.mdx +++ b/src/oss/contributing/implement-langchain.mdx @@ -13,7 +13,9 @@ Your integration package will typically implement a subclass of at least one of Chat models are subclasses of the [`BaseChatModel`](https://python.langchain.com/api_reference/core/language_models/langchain_core.language_models.chat_models.BaseChatModel.html) class. They implement methods for generating chat completions, handling message formatting, and managing model parameters. - See the [chat model integration guide](/oss/langchain/models) for details on implementing a chat model integration. + + The chat model integration guide is currently WIP. In the meantime, read the [chat model conceptual guide](/oss/langchain/models) for details on how LangChain chat models function. + Tools are used in 2 main ways: @@ -23,21 +25,31 @@ Your integration package will typically implement a subclass of at least one of The Tools class must inherit from the [`BaseTool`](https://python.langchain.com/api_reference/core/tools/langchain_core.tools.base.BaseTool.html#langchain_core.tools.base.BaseTool) base class. This interface has 3 properties and 2 methods that should be implemented in a subclass. - See the [tool integration guide](/oss/langchain/tools) for details on implementing a tool integration. + + The tools integration guide is currently WIP. In the meantime, read the [tools conceptual guide](/oss/langchain/tools) for details on how LangChain tools function. + Retrievers are used to retrieve documents from APIs, databases, or other sources based on a query. The Retriever class must inherit from the BaseRetriever base class. - See the [retriever integration guide](/oss/integrations/retrievers) for details on implementing a retriever integration. + + The retriever integration guide is currently WIP. In the meantime, read the [retriever conceptual guide](/oss/langchain/retrievers) for details on how LangChain retrievers function. + All vector stores must inherit from the [`VectorStore`](https://python.langchain.com/api_reference/core/vectorstores/langchain_core.vectorstores.base.VectorStore.html) base class. This interface consists of methods for writing, deleting and searching for documents in the vector store. See the [vector store integration guide](/oss/integrations/vectorstores) for details on implementing a vector store integration. + + + The vector store integration guide is currently WIP. In the meantime, read the [vector store conceptual guide](/oss/langchain/vectorstores) for details on how LangChain vector stores function. + Embedding models are subclasses of the [`Embeddings`](https://python.langchain.com/api_reference/core/embeddings/langchain_core.embeddings.embeddings.Embeddings.html) class. - See the [embedding model integration guide](/oss/integrations/text_embedding) for details on implementing an embedding model integration. + + The embedding model integration guide is currently WIP. In the meantime, read the [embedding model conceptual guide](/oss/langchain/text_embedding) for details on how LangChain embedding models function. + diff --git a/src/oss/contributing/integrations-langchain.mdx b/src/oss/contributing/integrations-langchain.mdx index 988f07f46..70040c73e 100644 --- a/src/oss/contributing/integrations-langchain.mdx +++ b/src/oss/contributing/integrations-langchain.mdx @@ -9,51 +9,46 @@ LangChain provides standard interfaces for several different components (languag ## Why contribute an integration to LangChain? - - - LangChain is the most used framework for building LLM applications, with over 20 million monthly downloads. - + + LangChain is the most used framework for building LLM applications, with over 20 million monthly downloads. + - - LangChain components expose a standard interface, allowing developers to easily swap them for each other. If you implement a LangChain integration, any developer using a different component will easily be able to swap yours in. - + + LangChain components expose a standard interface, allowing developers to easily swap them for each other. If you implement a LangChain integration, any developer using a different component will easily be able to swap yours in. + - - Through their standard interface, LangChain components encourage and facilitate best practices (streaming, async, etc.) that improve developer experience and application performance. - - + + Through their standard interface, LangChain components encourage and facilitate best practices (streaming, async, etc.) that improve developer experience and application performance. + ## Components to integrate While any component can be integrated into LangChain, there are specific types of integrations we encourage more: - - - - **Chat Models**: Most actively used component type - - **Tools/Toolkits**: Enable agent capabilities - - **Retrievers**: Core to RAG applications - - **Vector Stores**: Essential for semantic search - - **Embedding Models**: Foundation for vector operations - - - - **LLMs (Text-Completion Models)**: Deprecated in favor of Chat Models - - **Document Loaders**: High maintenance burden - - **Key-Value Stores**: Limited usage - - **Document Transformers**: Niche use cases - - **Model Caches**: Infrastructure concerns - - **Graphs**: Complex abstractions - - **Message Histories**: Storage abstractions - - **Callbacks**: System-level components - - **Chat Loaders**: Limited demand - - **Adapters**: Edge case utilities - - +**Integrate these ✅**: +- [**Chat Models**](/oss/integrations/chat): Most actively used component type +- [**Tools/Toolkits**](/oss/integrations/tools): Enable agent capabilities +- [**Retrievers**](/oss/integrations/retrievers): Core to RAG applications +- [**Embedding Models**](/oss/integrations/text_embedding): Foundation for vector operations +- [**Vector Stores**](/oss/integrations/vectorstores): Essential for semantic search + +**Not these ❌**: +- **LLMs (Text-Completion Models)**: Deprecated in favor of [Chat Models](/oss/integrations/chat) +- [**Document Loaders**](/oss/integrations/document_loaders): High maintenance burden +- [**Key-Value Stores**](/oss/integrations/stores): Limited usage +- **Document Transformers**: Niche use cases +- **Model Caches**: Infrastructure concerns +- **Graphs**: Complex abstractions +- **Message Histories**: Storage abstractions +- **Callbacks**: System-level components +- **Chat Loaders**: Limited demand +- **Adapters**: Edge case utilities ## How to contribute an integration - Verify that your integration is in the list of encouraged components we are currently accepting. + Verify that your integration is in the list of [encouraged components](#components-to-integrate) we are currently accepting. @@ -61,7 +56,7 @@ While any component can be integrated into LangChain, there are specific types o - If applicable, implement the [standard tests](/oss/contributing/standard-tests-langchain) for your integration and successfully run them. + If applicable, implement support for LangChain's [standard test](/oss/contributing/standard-tests-langchain) suite for your integration and successfully run them. @@ -74,7 +69,8 @@ While any component can be integrated into LangChain, there are specific types o An integration is only as useful as its documentation. To ensure a consistent experience for users, docs are required for all new integrations. We have a standard starting-point template for each type of integration for you to copy and modify. - In a new PR to the LangChain docs repo, create a new file in the relevant directory under `src/oss/python/integrations//integration_name.mdx` using the appropriate template file: + In a new PR to the LangChain [docs repo](https://github.com/langchain-ai/docs), create a new file in the relevant directory under `src/oss/python/integrations//integration_name.mdx` using the appropriate template file: + - [Chat models](/oss/integrations/chat/TEMPLATE) - [Tools and toolkits](/oss/integrations/tools/TEMPLATE) - [Retrievers](/oss/integrations/retrievers/TEMPLATE) @@ -83,11 +79,13 @@ While any component can be integrated into LangChain, there are specific types o - [Vector stores](/oss/integrations/vectorstores/TEMPLATE) - Document loaders - Coming soon - Key-value stores - Coming soon + + For reference docs, please open an issue on the repo so that a maintainer can add them. - **Optional**: Engage with the LangChain team for joint [co-marketing](/oss/contributing/comarketing). + (Optional) Engage with the LangChain team for joint [co-marketing](/oss/contributing/comarketing). diff --git a/src/oss/contributing/overview.mdx b/src/oss/contributing/overview.mdx index 78c7ecb96..f8baf1ba9 100644 --- a/src/oss/contributing/overview.mdx +++ b/src/oss/contributing/overview.mdx @@ -17,28 +17,29 @@ LangChain has helped form the largest developer community in generative AI, and Check if the issue already exists in our GitHub Issues for the respective repo: + :::python - Issues - Issues + Issues + Issues ::: :::js - Issues - Issues + Issues + Issues ::: - If no issue exists, create a new one. When writing, be sure to follow the template provided and to include a [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example). Attach any relevant labels to the final issue once created. + If no issue exists, create a new one. When writing, be sure to follow the template provided and to include a [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example). Attach any relevant labels to the final issue once created. If a project maintainer is unable to reproduce the issue, it is unlikely to be addressed in a timely manner. - A project maintainer will triage the issue and may ask for additional information. Please be patient as we manage a high volume of issues. + A project maintainer will triage the issue and may ask for additional information. Please be patient as we manage a high volume of issues. Do not bump the issue unless you have new information to provide. - If you are adding an issue, please try to keep it focused on a single topic. If two issues are related, or blocking, please link them rather than combining them. For example, + If you are adding an issue, please try to keep it focused on a single topic. If two issues are related, or blocking, please [link them](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) rather than combining them. For example, ```text This issue is blocked by #123 and related to #456. @@ -50,7 +51,20 @@ LangChain has helped form the largest developer community in generative AI, and - Search the issues for the respective repository for existing feature requests. + Search the issues for the respective repository for existing feature requests: + + :::python + + Issues + Issues + + ::: + :::js + + Issues + Issues + + ::: :::python @@ -61,7 +75,7 @@ LangChain has helped form the largest developer community in generative AI, and ::: - Be sure to describe the use case and why it would be valuable to others. If possible, provide examples or mockups where applicable. + Be sure to describe the use case and why it would be valuable to others. If possible, provide examples or mockups where applicable. Outline test cases that should pass. @@ -79,7 +93,7 @@ LangChain has helped form the largest developer community in generative AI, and If you start working on an issue, please assign it to yourself or ask a maintainer to do so. This helps avoid duplicate work. - If you are looking for something to work on, check out the issues labeled "good first issue" or "help wanted" in our GitHub repos: + If you are looking for something to work on, check out the issues labeled "good first issue" or "help wanted" in our repos: :::python diff --git a/src/oss/contributing/publish-langchain.mdx b/src/oss/contributing/publish-langchain.mdx index 19837a0b1..1f6e61f74 100644 --- a/src/oss/contributing/publish-langchain.mdx +++ b/src/oss/contributing/publish-langchain.mdx @@ -5,15 +5,15 @@ sidebarTitle: Publish **Make your integration available to the community.** +:::python **Important: New integrations should be standalone packages, not PRs to the LangChain monorepo.** -While LangChain maintains a small subset of first-party and high-usage integrations (like OpenAI, Anthropic, and Ollama) in the main repository, **new integrations should be published as separate PyPI packages and repositories** (e.g., `langchain-yourservice`) that users install alongside the core LangChain packages. You do **not** submit a PR to add your integration directly to the main LangChain repository. +While LangChain maintains a small subset of first-party and high-usage integrations (like OpenAI, Anthropic, and Ollama) in the main repository, **new integrations should be published as separate PyPI packages and repositories** (e.g., `langchain-yourservice`) that users install alongside the core LangChain packages. You **should not** submit a PR to add your integration directly to the main LangChain repository. Now that your package is implemented and tested, you can publish it and add documentation to make it discoverable by the community. -:::python ## Publishing your package @@ -67,7 +67,6 @@ To add documentation for your package to this site under the [integrations tab]( Depending on the type of integration you have built, you will need to create different types of documentation pages. LangChain provides templates for different types of integrations to help you get started. -:::python @@ -75,16 +74,6 @@ Depending on the type of integration you have built, you will need to create dif -::: -:::js - - - - - - - -::: To reference existing documentation, you can look at the [list of integrations](/oss/integrations/providers) and find similar ones to yours. @@ -117,8 +106,8 @@ Please be patient as we handle a large volume of PRs. We will review your PR as Get in touch with the LangChain marketing team to explore co-marketing opportunities. - ::: + :::js TODO ::: diff --git a/src/oss/contributing/review.mdx b/src/oss/contributing/review.mdx deleted file mode 100644 index e97a66161..000000000 --- a/src/oss/contributing/review.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: PR Review Process -sidebarTitle: Review ---- - -WIP - coming soon! diff --git a/src/oss/contributing/standard-tests-langchain.mdx b/src/oss/contributing/standard-tests-langchain.mdx index e0179235e..2b4d22933 100644 --- a/src/oss/contributing/standard-tests-langchain.mdx +++ b/src/oss/contributing/standard-tests-langchain.mdx @@ -5,7 +5,7 @@ sidebarTitle: Standard tests **Standard tests ensure your integration works as expected.** -When creating either a custom class for yourself or to publish in a LangChain integration, it is important to add standard tests to ensure it works as expected. This guide will show you how to add standard tests to each integration type. +When creating either a custom class for yourself or to publish in a LangChain integration, it is necessary to add tests to ensure it works as expected. LangChain provides a comprehensive [set of tests](https://pypi.org/project/langchain-tests/) for each integration type for you. This guide will show you how to add LangChain's standard test suite to each integration type. ## Setup @@ -153,8 +153,16 @@ class ChatParrotLinkStandardIntegrationTests extends ChatModelIntegrationTests< - `tests/integration_tests` for integration tests -To see the complete list of configurable capabilities and their defaults, visit the API reference for your integration type. Reference pages include code examples for implementing standard tests. +:::python +To see the complete list of configurable capabilities and their defaults, visit the [API reference](https://reference.langchain.com/python) for your integration type. Reference pages include code examples for implementing standard tests. +::: + +:::js +To see the complete list of configurable capabilities and their defaults, visit the [API reference](https://reference.langchain.com/javascript) for your integration type. Reference pages include code examples for implementing standard tests. +::: +{/* +TODO update when added to new refs :::python @@ -166,7 +174,7 @@ To see the complete list of configurable capabilities and their defaults, visit -::: +::: */} Here are some example implementations of standard tests from popular integrations: @@ -232,6 +240,7 @@ TODO :::python For a full list of the standard test suites that are available, as well as information on which tests are included and how to troubleshoot common issues, see the [Standard Tests API Reference](https://python.langchain.com/api_reference/standard_tests/index.html). +{/* TODO update to use new ref */} You can find troubleshooting guides under the individual test suites listed in that API Reference. For example, [here is the guide for `ChatModelIntegrationTests.test_usage_metadata`](https://python.langchain.com/api_reference/standard_tests/integration_tests/langchain_tests.integration_tests.chat_models.ChatModelIntegrationTests.html#langchain_tests.integration_tests.chat_models.ChatModelIntegrationTests.test_usage_metadata). ::: :::js diff --git a/src/oss/python/integrations/chat/index.mdx b/src/oss/python/integrations/chat/index.mdx index 1cd7c9a1d..d0324708a 100644 --- a/src/oss/python/integrations/chat/index.mdx +++ b/src/oss/python/integrations/chat/index.mdx @@ -2,7 +2,7 @@ title: "Chat models" --- -[Chat models](/oss/langchain/models) are language models that use a sequence of [messages](/oss/langchain/messages) as inputs and return messages as outputs (as opposed to plaintext). +[Chat models](/oss/langchain/models) are language models that use a sequence of [messages](/oss/langchain/messages) as inputs and return messages as outputs (as opposed to traditional, plaintext LLMs). ## Featured providers diff --git a/src/oss/python/releases/langchain-v1.mdx b/src/oss/python/releases/langchain-v1.mdx index a4deb41ae..010119387 100644 --- a/src/oss/python/releases/langchain-v1.mdx +++ b/src/oss/python/releases/langchain-v1.mdx @@ -16,7 +16,7 @@ import AlphaCallout from '/snippets/alpha-lc-callout.mdx'; A new `content_blocks` property that provides unified access to modern LLM features across providers. - + The `langchain` namespace has been streamlined to focus on essential building blocks for agents, with legacy functionality moved to `langchain-classic`.