Skip to content

Commit b75fa4c

Browse files
committed
docs: add langchain-integration-health tool documentation
Add documentation with all required template headers. - Include exact headers: Overview, Setup, Instantiation, Invocation, Use within an agent, API reference - Follow LangChain tools template validation requirements - Provide usage examples and installation instructions
1 parent 238ecd0 commit b75fa4c

File tree

2 files changed

+129
-0
lines changed

2 files changed

+129
-0
lines changed
Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"id": "a6f91f20",
6+
"metadata": {},
7+
"source": [
8+
"# LangChain Integration Health\n",
9+
"\n",
10+
"This notebook shows how to use the LangChain Integration Health framework for testing and monitoring LangChain integration compatibility.\n",
11+
"\n",
12+
"First, you need to install the `langchain-integration-health` package."
13+
]
14+
},
15+
{
16+
"cell_type": "markdown",
17+
"id": "r7krg98s4f",
18+
"source": "## Overview\n\nThe LangChain Integration Health framework provides testing and monitoring for LangChain integration compatibility.",
19+
"metadata": {}
20+
},
21+
{
22+
"cell_type": "markdown",
23+
"id": "2sh24bppwqk",
24+
"source": "## Setup\n\nInstall the package:",
25+
"metadata": {}
26+
},
27+
{
28+
"cell_type": "code",
29+
"execution_count": null,
30+
"id": "d5a7209e",
31+
"metadata": {},
32+
"outputs": [],
33+
"source": [
34+
"%pip install --upgrade --quiet langchain-integration-health"
35+
]
36+
},
37+
{
38+
"cell_type": "markdown",
39+
"id": "1c97218f-f366-479d-8bf7-fe9f2f6df73f",
40+
"metadata": {},
41+
"source": "## Instantiation\n\nCreate the testing framework:"
42+
},
43+
{
44+
"cell_type": "code",
45+
"execution_count": null,
46+
"id": "8b3ddfe9-ca79-494c-a7ab-1f56d9407a64",
47+
"metadata": {},
48+
"outputs": [],
49+
"source": [
50+
"# Run integration health checks\n",
51+
"# !langchain-health discover\n",
52+
"# !langchain-health test\n",
53+
"# !langchain-health report\n",
54+
"\n",
55+
"print(\"LangChain Integration Health CLI ready\")"
56+
]
57+
},
58+
{
59+
"cell_type": "markdown",
60+
"id": "21c5b56f-0da0-485f-b6f5-38950bae4fd0",
61+
"metadata": {},
62+
"source": "## Invocation\n\nRun integration tests:"
63+
},
64+
{
65+
"cell_type": "code",
66+
"execution_count": null,
67+
"id": "520767b8-9e61-4485-840a-d16f1da5eb3a",
68+
"metadata": {},
69+
"outputs": [],
70+
"source": [
71+
"from langchain_integration_health.testers import LLMIntegrationTester\n",
72+
"from langchain_integration_health.utils.config import Config\n",
73+
"\n",
74+
"# Example usage\n",
75+
"config = Config.from_env()\n",
76+
"print(\"Integration health framework ready\")"
77+
]
78+
},
79+
{
80+
"cell_type": "markdown",
81+
"id": "b4183343-d69a-4be0-9b2c-cc98464a6825",
82+
"metadata": {},
83+
"source": "## Use within an agent\n\nMonitor integration health in real-time:"
84+
},
85+
{
86+
"cell_type": "code",
87+
"execution_count": null,
88+
"id": "34bb5968",
89+
"metadata": {},
90+
"outputs": [],
91+
"source": [
92+
"# Launch dashboard\n",
93+
"# !streamlit run -m langchain_integration_health.dashboard.app\n",
94+
"print(\"Dashboard available at http://localhost:8501\")"
95+
]
96+
},
97+
{
98+
"cell_type": "markdown",
99+
"id": "vp8foz8rzv",
100+
"source": "## API reference\n\nFor detailed documentation of all features head to the [GitHub repository](https://github.com/sadiqkhzn/langchain-integration-health).",
101+
"metadata": {}
102+
}
103+
],
104+
"metadata": {
105+
"kernelspec": {
106+
"display_name": "Python 3",
107+
"language": "python",
108+
"name": "python3"
109+
},
110+
"language_info": {
111+
"codemirror_mode": {
112+
"name": "ipython",
113+
"version": 3
114+
},
115+
"file_extension": ".py",
116+
"mimetype": "text/x-python",
117+
"name": "python",
118+
"nbconvert_exporter": "python",
119+
"pygments_lexer": "ipython3",
120+
"version": "3.11.0"
121+
}
122+
},
123+
"nbformat": 4,
124+
"nbformat_minor": 5
125+
}

libs/packages.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -733,4 +733,8 @@ packages:
733733
- name: langchain-scrapeless
734734
repo: scrapeless-ai/langchain-scrapeless
735735
path: .
736+
- name: langchain-integration-health
737+
name_title: Integration Health Framework
738+
path: .
739+
repo: sadiqkhzn/langchain-integration-health
736740

0 commit comments

Comments
 (0)