[Docs] Example of using Vizro-AI in chain as tools

vizro-ai/changelog.d/20241029_220013_lingyi_zhang_bind_vizroai_as_tool.md

@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->

vizro-ai/docs/index.md

@@ -47,7 +47,8 @@ If a feature you need for your dashboard isn't currently supported by Vizro-AI y
     [:octicons-arrow-right-24: Create advanced charts](pages/user-guides/create-advanced-charts.md)</br>
     [:octicons-arrow-right-24: Add charts to a dashboard](pages/user-guides/add-generated-chart-usecase.md)</br>
     [:octicons-arrow-right-24: Generate a complex dashboard](pages/user-guides/create-complex-dashboard.md)</br>
-    [:octicons-arrow-right-24: Retrieve code for a generated dashboard](pages/user-guides/retrieve-dashboard-code.md)
+    [:octicons-arrow-right-24: Retrieve code for a generated dashboard](pages/user-guides/retrieve-dashboard-code.md)</br>
+    [:octicons-arrow-right-24: Use Vizro-AI as Langchain tools](pages/user-guides/vizro-ai-langchain-guide.md)
 
 - :material-format-font:{ .lg .middle } __Find out more__
 

vizro-ai/docs/pages/user-guides/vizro-ai-langchain-guide.md

@@ -0,0 +1,193 @@
+# Using Vizro-AI methods as LangChain tools
+
+This guide demonstrates how to integrate Vizro-AI's chart and dashboard generation capabilities as LangChain tools. This integration enables you to use Vizro-AI's functionality within a larger LangChain application.
+
+## 1. Set up the environment
+
+First, import the required libraries and prepare your data:
+
+```python
+from copy import deepcopy
+from typing import Annotated, Any
+
+import pandas as pd
+import vizro.plotly.express as px
+from langchain_core.runnables import chain
+from langchain_core.tools import InjectedToolArg, tool
+from langchain_openai import ChatOpenAI
+from vizro_ai import VizroAI
+
+# Load sample data
+df = px.data.gapminder()
+dfs = [df]
+
+# Initialize the LLM
+llm = ChatOpenAI(model="gpt-4o-mini")
+```
+
+## 2. Define LangChain tools
+
+Basic tools only take string as input and output. Vizro-AI takes Pandas dataframes as input and it's not cost-efficient and secure to pass the full data to a LLM. In this case, [bind the Pandas dataframes at run time](https://python.langchain.com/v0.2/docs/how_to/tool_runtime/) is more suitable.
+
+Now, create tools that wrap Vizro-AI's plotting and dashboard generation capabilities:
+
+```python
+@tool(parse_docstring=True)
+def get_plot_code(df: Annotated[Any, InjectedToolArg], question: str) -> str:
+    """Generate only the plot code.
+
+    Args:
+        df: A pandas DataFrame
+        question: The plotting question
+
+    Returns:
+        Generated plot code
+    """
+    df = pd.DataFrame(df)
+    vizro_ai = VizroAI(model=llm)
+    plot_elements = vizro_ai.plot(
+        df,
+        user_input=question,
+        return_elements=True,
+    )
+    return plot_elements.code_vizro
+
+@tool(parse_docstring=True)
+def get_dashboard_code(dfs: Annotated[Any, InjectedToolArg], question: str) -> str:
+    """Generate the dashboard code.
+
+    Args:
+        dfs: Pandas DataFrames
+        question: The dashboard question
+
+    Returns:
+        Generated dashboard code
+    """
+    vizro_ai = VizroAI(model=llm)
+    dashboard_elements = vizro_ai.dashboard(
+        dfs,
+        user_input=question,
+        return_elements=True,
+    )
+    return dashboard_elements.code
+```
+
+## 3. Set up the tool chain
+
+Create a chain that handles tool execution and data injection:
+
+```python
+# Bind tools to the LLM
+tools = [get_plot_code, get_dashboard_code]
+llm_with_tools = llm.bind_tools(tools)
+
+# Create data injection chain
+@chain
+def inject_df(ai_msg):
+    tool_calls = []
+    for tool_call in ai_msg.tool_calls:
+        tool_call_copy = deepcopy(tool_call)
+
+        if tool_call_copy["name"] == "get_dashboard_code":
+            tool_call_copy["args"]["dfs"] = dfs
+        else:
+            tool_call_copy["args"]["df"] = df
+
+        tool_calls.append(tool_call_copy)
+    return tool_calls
+
+# Create tool router
+tool_map = {tool.name: tool for tool in tools}
+
+@chain
+def tool_router(tool_call):
+    return tool_map[tool_call["name"]]
+
+# Combine chains
+chain = llm_with_tools | inject_df | tool_router.map()
+```
+
+## 4. Use the chain
+
+Now you can use the chain to generate charts or dashboards based on natural language queries. The chain will generate code that you can use to create visualizations.
+
+!!! example "Generate chart code"
+
+    === "Code"
+        ```py
+        plot_response = chain.invoke("Plot GDP per capita for each continent")
+        print(plot_response[0].content)
+        ```
+    === "Vizro-AI Generated Code"
+        ```py
+        import plotly.graph_objects as go
+        from vizro.models.types import capture
+
+        @capture("graph")
+        def custom_chart(data_frame):
+            continent_gdp = data_frame.groupby("continent")["gdpPercap"].mean().reset_index()
+            fig = go.Figure(
+                data=[go.Bar(x=continent_gdp["continent"], y=continent_gdp["gdpPercap"])]
+            )
+            fig.update_layout(
+                title="GDP per Capita by Continent",
+                xaxis_title="Continent",
+                yaxis_title="GDP per Capita",
+            )
+            return fig
+        ```
+
+!!! example "Generate dashboard code"
+
+    === "Code"
+        ```py
+        dashboard_response = chain.invoke("Create a dashboard. This dashboard has a chart showing the correlation between gdpPercap and lifeExp.")
+        print(dashboard_response[0].content)
+        ```
+    === "Vizro-AI Generated Code"
+        ```py
+        ############ Imports ##############
+        import vizro.models as vm
+        from vizro.models.types import capture
+        import plotly.graph_objects as go
+
+
+        ####### Function definitions ######
+        @capture("graph")
+        def gdp_life_exp_graph(data_frame):
+            fig = go.Figure()
+            fig.add_trace(
+                go.Scatter(x=data_frame["gdpPercap"], y=data_frame["lifeExp"], mode="markers")
+            )
+            fig.update_layout(
+                title="GDP per Capita vs Life Expectancy",
+                xaxis_title="GDP per Capita",
+                yaxis_title="Life Expectancy",
+            )
+            return fig
+
+
+        ####### Data Manager Settings #####
+        #######!!! UNCOMMENT BELOW !!!#####
+        # from vizro.managers import data_manager
+        # data_manager["gdp_life_exp"] = ===> Fill in here <===
+
+
+        ########### Model code ############
+        model = vm.Dashboard(
+            pages=[
+                vm.Page(
+                    components=[
+                        vm.Graph(
+                            id="gdp_life_exp_graph",
+                            figure=gdp_life_exp_graph(data_frame="gdp_life_exp"),
+                        )
+                    ],
+                    title="GDP vs Life Expectancy Correlation",
+                    layout=vm.Layout(grid=[[0]]),
+                    controls=[],
+                )
+            ],
+            title="GDP per Capita vs Life Expectancy",
+        )
+        ```

vizro-ai/mkdocs.yml

@@ -18,6 +18,7 @@ nav:
       - DASHBOARDS:
           - Generate a complex dashboard: pages/user-guides/create-complex-dashboard.md
           - Retrieve code for a generated dashboard: pages/user-guides/retrieve-dashboard-code.md
+          - Use Vizro-AI methods as Langchain tools: pages/user-guides/vizro-ai-langchain-guide.md
   - API Reference:
       - VizroAI: pages/API-reference/vizro-ai.md
   - Explanation:

vizro-core/examples/scratch_dev/README2.md

@@ -1 +1 @@
-# Also to be deleted
+# Also to be deleted