utilities — Wrappers for SerpAPI, SQL, Wikipedia, BashProcess, etc.

Wrappers for SerpAPI, SQL, Wikipedia, BashProcess, etc.

Module langchain_classic/utilities/ — Wrappers for SerpAPI, SQL, Wikipedia, BashProcess, etc.. Part of the Cross-cutting group.

🎯 Why This Module Exists

Provider wrappers that aren't LLMs themselves but back tools and chains: SerpAPI, GoogleSearch, Bing, DuckDuckGo, Wikipedia, ArXiv, OpenWeatherMap, Wolfram Alpha, SQL databases (SQLAlchemy), BashProcess, Python REPL. Each wrapper normalises auth, rate-limit handling, and result shape so the corresponding Tool stays small.

Source files

Sub-directories

Cross-cutting

Architecture

flowchart LR
  subgraph Core["langchain_classic/utilities/"]
    BASE["Base abstraction"]
    IMPLS["Concrete implementations"]
    BASE --> IMPLS
  end
  subgraph Up["Upstream callers"]
    U1["chains/"]
    U2["agents/"]
  end
  subgraph Down["Downstream"]
    D1["langchain_core"]
    D2["External providers"]
  end
  Up --> Core
  Core --> Down

Data Flow

sequenceDiagram
  participant Caller as Caller
  participant Utilitie as utilities
  participant Core as langchain_core
  participant Ext as External
  Caller->>Utilitie: invoke(input)
  Note over Utilitie: Validate & route
  Utilitie->>Core: delegate primitive
  Core->>Ext: provider call
  Ext-->>Core: response
  Core-->>Utilitie: typed output
  Utilitie-->>Caller: result

Design Decisions

Decision	Choice Made	Alternatives	Why This Approach
Wrapper vs Tool	Wrapper is the API client; Tool wraps wrapper with a name+description+schema	Single Tool class doing both	Same wrapper sometimes backs multiple tools (search vs retrieve)
Optional deps	Per-wrapper imports inside the file	All-required dependencies	Most users need only one or two
Async wrappers where SDK supports	asyncio.to_thread fallback	Sync only	Agents often need parallel tool calls

Tools in tools/ almost always delegate to a utility wrapper here for the actual API call.

Step-by-Step Walkthrough

Follow a typical operation through the utilities/ module:

Caller invokes the public surface — usually .invoke(input) on a Runnable, or a legacy __call__(inputs_dict) on a Chain subclass.
Pydantic validation — every entry point is a BaseModel; constructor args, input dicts, and tool args_schema are validated before any expensive work runs. Fail-fast on type errors.
CallbackManager.configure — a fresh manager is built per call, fans on_*_start events to all subscribers (LangSmith tracer, stdout handler, custom logging), and stamps a UUID4 run_id for tree reconstruction.
utilities-specific logic — the module's core method runs: prompt rendering, retrieval, tool execution, memory load, document split, etc. See the deep-dive sections above.
Provider call — typically a single HTTP request to OpenAI/Anthropic/etc., or a local SDK call. Retries are handled by tenacity with exponential backoff and a configurable max-attempts knob.
Streaming fan-out — if the provider streams tokens, each chunk fires on_llm_new_token through the callback manager so downstream observers (UI, log, tracer) see partial output.
OutputParser pass — if a parser is attached, the raw provider output is parsed into a structured Python object; OutputParserException may trigger a retry chain (RetryWithErrorOutputParser).
Memory write-back — for chains/agents that have a BaseMemory attached, save_context(inputs, outputs) persists the turn before returning to the caller.
on_*_end fan-out — the callback manager closes the run span; tracers serialise the Run tree and ship it to LangSmith asynchronously.
Result returned — caller receives a typed object (AIMessage, dict, BaseModel, list[Document], ...) matching the module's declared output schema.

What Could Go Wrong

Failure Mode	Trigger	Detection	Recovery
Provider 5xx / rate-limit	OpenAI/Anthropic/etc. transient error	HTTP status from SDK	tenacity retries with exponential backoff up to `max_retries`; then surface to caller
Output parser failure	LLM returned malformed JSON / wrong schema	`OutputParserException` in parser	`RetryWithErrorOutputParser` re-prompts with the parser error included; or surface
Pydantic validation	Caller passes wrong-shaped dict	`ValidationError` at `__init__` / `invoke`	Surface immediately — no fallback is correct here
Callback handler exception	User-supplied tracer raises	Try/except around each fan-out	Logged and swallowed by default; `raise_error=True` to opt in to propagation
Provider auth missing	`OPENAI_API_KEY` unset	SDK `AuthenticationError`	Surface with a helpful message; no retry (would just fail again)

Performance Profile

Hot Paths

Provider HTTP round-trip dominates wall-clock time (100ms–30s depending on model and prompt length).
Pydantic validation is repeated on every invoke; cached schema parsing keeps it under 1ms for typical inputs.
Callback fan-out is synchronous by default — a slow handler will slow every call. Async tracers (LangSmith) push work to a background thread to avoid blocking.

Resource Usage

Memory: token-history buffers (in memory/) and document caches (in retrieval pipelines) are the largest steady-state allocations.
I/O: bounded by provider rate limits; vector store I/O for retrieval-flavored modules.
Concurrency: async support via a* methods; agents and parallel chains use asyncio.gather for concurrent tool calls.

Directory Map

Source tree for utilities

utilities/
├── __init__.py
├── alpha_vantage.py
├── anthropic.py
├── apify.py
├── arcee.py
├── arxiv.py
├── asyncio.py
├── awslambda.py
├── bibtex.py
├── bing_search.py
├── brave_search.py
├── clickup.py
├── dalle_image_generator.py
├── dataforseo_api_search.py
├── duckduckgo_search.py
├── github.py
├── gitlab.py
├── golden_query.py
├── google_finance.py
├── google_jobs.py
├── google_lens.py
├── google_places_api.py
├── google_scholar.py
├── google_search.py
├── google_serper.py
├── google_trends.py
├── graphql.py
├── jira.py
├── max_compute.py
├── merriam_webster.py
├── metaphor_search.py
├── nasa.py
├── opaqueprompts.py
├── openapi.py
├── openweathermap.py
├── outline.py
├── portkey.py
├── powerbi.py
├── pubmed.py
├── python.py
├── reddit_search.py
├── redis.py
├── requests.py
├── scenexplain.py
├── searchapi.py
├── searx_search.py
├── serpapi.py
├── spark_sql.py
├── sql_database.py
├── stackexchange.py
├── steam.py
├── tavily_search.py
├── tensorflow_datasets.py
├── twilio.py
├── vertexai.py
├── wikipedia.py
├── wolfram_alpha.py
└── zapier.py