docs: update integration api refs (#25195)

- [x] toolkits - [x] retrievers (in this repo)
2025-09-04 12:39:32 +00:00 · 2024-08-09 08:27:32 -04:00
parent 91ea4b7449
commit 3b7437d184
11 changed files with 675 additions and 21 deletions
--- a/libs/community/langchain_community/agent_toolkits/openapi/toolkit.py
+++ b/libs/community/langchain_community/agent_toolkits/openapi/toolkit.py
@@ -38,7 +38,125 @@ class RequestsToolkit(BaseToolkit):
        what network access it has.

        See https://python.langchain.com/docs/security for more information.
-    """
+
+    Setup:
+        Install ``langchain-community``.
+
+        .. code-block:: bash
+
+            pip install -U langchain-community
+
+    Key init args:
+        requests_wrapper: langchain_community.utilities.requests.GenericRequestsWrapper
+            wrapper for executing requests.
+        allow_dangerous_requests: bool
+            Defaults to False. Must "opt-in" to using dangerous requests by setting to True.
+
+    Instantiate:
+        .. code-block:: python
+
+            from langchain_community.agent_toolkits.openapi.toolkit import RequestsToolkit
+            from langchain_community.utilities.requests import TextRequestsWrapper
+
+            toolkit = RequestsToolkit(
+                requests_wrapper=TextRequestsWrapper(headers={}),
+                allow_dangerous_requests=ALLOW_DANGEROUS_REQUEST,
+            )
+
+    Tools:
+        .. code-block:: python
+
+            tools = toolkit.get_tools()
+            tools
+
+        .. code-block:: none
+
+            [RequestsGetTool(requests_wrapper=TextRequestsWrapper(headers={}, aiosession=None, auth=None, response_content_type='text', verify=True), allow_dangerous_requests=True),
+            RequestsPostTool(requests_wrapper=TextRequestsWrapper(headers={}, aiosession=None, auth=None, response_content_type='text', verify=True), allow_dangerous_requests=True),
+            RequestsPatchTool(requests_wrapper=TextRequestsWrapper(headers={}, aiosession=None, auth=None, response_content_type='text', verify=True), allow_dangerous_requests=True),
+            RequestsPutTool(requests_wrapper=TextRequestsWrapper(headers={}, aiosession=None, auth=None, response_content_type='text', verify=True), allow_dangerous_requests=True),
+            RequestsDeleteTool(requests_wrapper=TextRequestsWrapper(headers={}, aiosession=None, auth=None, response_content_type='text', verify=True), allow_dangerous_requests=True)]
+
+    Use within an agent:
+        .. code-block:: python
+
+            from langchain_openai import ChatOpenAI
+            from langgraph.prebuilt import create_react_agent
+
+
+            api_spec = \"\"\"
+            openapi: 3.0.0
+            info:
+              title: JSONPlaceholder API
+              version: 1.0.0
+            servers:
+              - url: https://jsonplaceholder.typicode.com
+            paths:
+              /posts:
+                get:
+                  summary: Get posts
+                  parameters: &id001
+                    - name: _limit
+                      in: query
+                      required: false
+                      schema:
+                        type: integer
+                      example: 2
+                      description: Limit the number of results
+            \"\"\"
+
+            system_message = \"\"\"
+            You have access to an API to help answer user queries.
+            Here is documentation on the API:
+            {api_spec}
+            \"\"\".format(api_spec=api_spec)
+
+            llm = ChatOpenAI(model="gpt-4o-mini")
+            agent_executor = create_react_agent(llm, tools, state_modifier=system_message)
+
+            example_query = "Fetch the top two posts. What are their titles?"
+
+            events = agent_executor.stream(
+                {"messages": [("user", example_query)]},
+                stream_mode="values",
+            )
+            for event in events:
+                event["messages"][-1].pretty_print()
+
+        .. code-block:: none
+
+             ================================[1m Human Message [0m=================================
+
+            Fetch the top two posts. What are their titles?
+            ==================================[1m Ai Message [0m==================================
+            Tool Calls:
+            requests_get (call_RV2SOyzCnV5h2sm4WPgG8fND)
+            Call ID: call_RV2SOyzCnV5h2sm4WPgG8fND
+            Args:
+                url: https://jsonplaceholder.typicode.com/posts?_limit=2
+            =================================[1m Tool Message [0m=================================
+            Name: requests_get
+
+            [
+            {
+                "userId": 1,
+                "id": 1,
+                "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
+                "body": "quia et suscipit..."
+            },
+            {
+                "userId": 1,
+                "id": 2,
+                "title": "qui est esse",
+                "body": "est rerum tempore vitae..."
+            }
+            ]
+            ==================================[1m Ai Message [0m==================================
+
+            The titles of the top two posts are:
+            1. "sunt aut facere repellat provident occaecati excepturi optio reprehenderit"
+            2. "qui est esse"
+    """  # noqa: E501

    requests_wrapper: TextRequestsWrapper
    """The requests wrapper."""