Skip to main content

An integration package connecting Cloro.dev and LangChain

Project description

langchain-cloro

This package contains the LangChain integration for cloro.dev - a unified API for monitoring multiple AI providers including Google Search, ChatGPT, Gemini, Perplexity, Grok, and Microsoft Copilot.

Installation

pip install langchain-cloro

Setup

You'll need a cloro API key. Get one at https://cloro.dev.

Set the API key as an environment variable:

export CLORO_API_KEY="your-api-key-here"

Or pass it directly when initializing:

from langchain_cloro import CloroGoogleSearch

tool = CloroGoogleSearch(cloro_api_key="your-api-key-here")

Available Tools

CloroGoogleSearch

Extract structured data from Google Search results, including organic results, People Also Ask questions, related searches, and optional AI Overview data.

from langchain_cloro import CloroGoogleSearch

tool = CloroGoogleSearch()

# Basic search
results = tool.invoke({"query": "best laptops for programming"})

# With AI Overview
results = tool.invoke({
    "query": "best laptops for programming",
    "include_aioverview": True,
    "aioverview_markdown": True
})

# Multiple pages
results = tool.invoke({
    "query": "python tutorials",
    "pages": 3,
    "country": "US",
    "device": "desktop"
})

Parameters:

  • query (str, required): The search query
  • country (str): ISO 3166-1 alpha-2 country code. Default: "US"
  • device (str): "desktop" or "mobile". Default: "desktop"
  • pages (int): Number of pages to scrape (1-20). Default: 1
  • include_aioverview (bool): Include Google AI Overview. Default: False
  • aioverview_markdown (bool): Format AI Overview as markdown. Default: False
  • include_html (bool): Include raw HTML response. Default: False

CloroChatGPT

Extract structured data from ChatGPT with shopping cards, entity extraction, and advanced features for monitoring products, prices, and brand mentions.

from langchain_cloro import CloroChatGPT

tool = CloroChatGPT()

# Basic query
results = tool.invoke({"prompt": "What are the best sneakers under $100?"})

# With shopping card data
results = tool.invoke({
    "prompt": "best running shoes",
    "include_raw_response": True,
    "include_search_queries": True
})

Parameters:

  • prompt (str, required): The prompt/query
  • country (str): ISO 3166-1 alpha-2 country code. Default: "US"
  • include_raw_response (bool): Include raw streaming response events. Default: False
  • include_search_queries (bool): Include search fan-out queries. Default: False
  • include_html (bool): Include HTML response. Default: False
  • include_markdown (bool): Include markdown response. Default: False

CloroGemini

Extract structured data from Google's Gemini AI with source citations, confidence levels, and multiple output formats.

from langchain_cloro import CloroGemini

tool = CloroGemini()

results = tool.invoke({"prompt": "Explain quantum entanglement"})

Parameters:

  • prompt (str, required): The prompt/query
  • country (str): ISO 3166-1 alpha-2 country code. Default: "US"
  • include_html (bool): Include HTML response. Default: False
  • include_markdown (bool): Include markdown response. Default: False

CloroPerplexity

Extract comprehensive structured data from Perplexity AI with real-time web sources, shopping products, media content, and travel information.

from langchain_cloro import CloroPerplexity

tool = CloroPerplexity()

# Travel query
results = tool.invoke({"prompt": "Best hotels in San Francisco"})

# Shopping query
results = tool.invoke({"prompt": "best noise-cancelling headphones"})

Parameters:

  • prompt (str, required): The prompt/query
  • country (str): ISO 3166-1 alpha-2 country code. Default: "US"
  • include_html (bool): Include HTML response. Default: False
  • include_markdown (bool): Include markdown response. Default: False

CloroGrok

Extract comprehensive structured data from Grok with real-time web sources and enhanced source metadata including preview text, creator details, and images.

from langchain_cloro import CloroGrok

tool = CloroGrok()

results = tool.invoke({"prompt": "Latest news about AI"})

Parameters:

  • prompt (str, required): The prompt/query
  • country (str): ISO 3166-1 alpha-2 country code. Default: "US"
  • include_html (bool): Include HTML response. Default: False
  • include_markdown (bool): Include markdown response. Default: False

CloroCopilot

Extract structured data from Microsoft Copilot with source citations.

from langchain_cloro import CloroCopilot

tool = CloroCopilot()

results = tool.invoke({"prompt": "What is the capital of France?"})

Parameters:

  • prompt (str, required): The prompt/query
  • country (str): ISO 3166-1 alpha-2 country code. Default: "US"
  • include_html (bool): Include HTML response. Default: False
  • include_markdown (bool): Include markdown response. Default: False

get_countries Utility

Get list of supported country codes for specific AI providers.

from langchain_cloro import get_countries

# Get all countries
all_countries = get_countries()

# Get countries for specific model
chatgpt_countries = get_countries(model="chatgpt")
google_countries = get_countries(model="google")

Usage with LangChain Agents

With an Agent

from langchain.agents import initialize_agent, AgentType
from langchain_openai import OpenAI
from langchain_cloro import CloroGoogleSearch, CloroChatGPT

llm = OpenAI(temperature=0)
tools = [CloroGoogleSearch(), CloroChatGPT()]

agent = initialize_agent(
    tools,
    llm,
    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,
    verbose=True,
)

agent.run("What are the latest developments in AI?")

With LCEL

from langchain_core.prompts import ChatPromptTemplate
from langchain_core.output_parsers import StrOutputParser
from langchain_openai import ChatOpenAI
from langchain_cloro import CloroChatGPT

chatgpt = CloroChatGPT()

prompt = ChatPromptTemplate.from_messages([
    ("system", "Answer based on the AI's response:\n\n{response}"),
    ("user", "{question}")
])

chain = {
    "response": lambda x: chatgpt.invoke({"prompt": x["question"]}),
    "question": lambda x: x["question"]
} | prompt | ChatOpenAI() | StrOutputParser()

response = chain.invoke({"question": "What is LangChain?"})
print(response)

Multiple Tools Example

from langchain_cloro import (
    CloroGoogleSearch,
    CloroChatGPT,
    CloroGemini,
    CloroPerplexity,
    CloroGrok,
    CloroCopilot
)

tools = [
    CloroGoogleSearch(),  # For search queries
    CloroChatGPT(),      # For shopping/product queries
    CloroGemini(),       # For general AI queries
    CloroPerplexity(),   # For research with citations
    CloroGrok(),         # For real-time news
    CloroCopilot(),      # For general queries
]

Supported Country Codes

Use the get_countries() utility to fetch supported countries:

from langchain_cloro import get_countries

# Check which countries are available for each model
models = ["google", "chatgpt", "gemini", "perplexity", "grok", "copilot"]

for model in models:
    countries = get_countries(model=model)
    print(f"{model}: {len(countries)} countries")

Development

Running Tests

# Unit tests
pytest tests/unit_tests -v

# Linting
ruff check .
ruff format .

# Type checking
mypy langchain_cloro

API Reference

For detailed API documentation, see https://docs.cloro.dev.

License

MIT

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langchain_cloro-0.2.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langchain_cloro-0.2.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file langchain_cloro-0.2.0.tar.gz.

File metadata

  • Download URL: langchain_cloro-0.2.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for langchain_cloro-0.2.0.tar.gz
Algorithm Hash digest
SHA256 66aa990132c352e0f284efc6777c93541cf56643a8cd658787c5412c8cff0b0c
MD5 4e3ef2ef78eeb9e28b5e4de09efa1e5a
BLAKE2b-256 9efb05c53ae5d28e4b59a502435951854f6e8eb22b9964a8938d785edcce0868

See more details on using hashes here.

File details

Details for the file langchain_cloro-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_cloro-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 740accb566dd6a232593e0d3c1fd6660e6fbc30fb2ba9382ad112f1d7ea586fe
MD5 8b87f22cdaefd95f499cc0ea27ae83b5
BLAKE2b-256 4c0c773dbb14b08e2915564b93d2c8d60c2e06ad42b0d71b8413f6bad282e42b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page