Skip to main content

Octogen Python SDK built on LangGraph

PyPI version Python Version

A Python SDK for building LLM-powered shop agents using LangGraph and LangChain, designed to work with the Octogen platform.

Features

  • Build conversational shop agents with LangGraph's state management
  • Structured output parsing with Pydantic models
  • Built-in recommendation expansion functionality
  • Server deployment capabilities with FastAPI
  • Integration with Octogen MCP tools for product discovery
  • Streamlined agent creation through factory patterns

Environment Variables

Required Variables

  • OPENAI_API_KEY - Your OpenAI API key
  • OCTOGEN_API_KEY - Your Octogen API key
  • OCTOGEN_MCP_SERVER_HOST - Octogen MCP server host URL

Optional Variables (for LangChain Tracing)

  • LANGCHAIN_API_KEY - Your LangChain API key
  • LANGCHAIN_TRACING_V2 - Enable LangChain tracing (set to "true")
  • LANGCHAIN_PROJECT - LangChain project name

.env File Placement

For the SDK to properly load your environment variables, you can:

  1. Place a .env file in your project's root directory - The default behavior is to look for a .env file in the current working directory.

  2. Explicitly specify the path - When using example servers or creating agents, pass the path to your .env file:

    from dotenv import find_dotenv
    from octogen.shop_agent.settings import get_agent_settings
    
    # Pass the path to your .env file
    get_agent_settings(find_dotenv(usecwd=True))
    
  3. Set environment variables directly - You can also set these variables in your environment before running your application.

Example Projects

When running the example projects (stylist, discovery, comparison), place your .env file in the specific example's directory. For instance, to run the stylist example:

examples/stylist/.env  # Place your .env file here when running the stylist example

This is because the examples use find_dotenv(usecwd=True), which looks for a .env file in the current working directory.

Installation

pip install octogen-sdk-langgraph

Requirements

  • Python ≥ 3.12
  • Dependencies:
    • langchain ≥ 0.3.25
    • langgraph ≥ 0.4.3
    • pydantic ≥ 2.11.4
    • octogen-api ≥ 0.1.0a4
    • structlog ≥ 25.3.0

Quick Start

from langchain_openai import ChatOpenAI
from octogen.shop_agent import ShopAgent, create_agent
from your_models import ResponseClass, HydratedResponseClass

# Define your recommendation expansion function
def expand_recommendations(response, messages):
    # Process and expand recommendations
    return json.dumps(expanded_response)

# Create a shop agent
async with create_agent(
    model=ChatOpenAI(model="gpt-4"),
    agent_name="MyShopAgent",
    response_class=ResponseClass,
    hydrated_response_class=HydratedResponseClass,
    rec_expansion_fn=expand_recommendations,
    tool_names=["agent_search_products", "enrich_product_image"],
    hub_prompt_id="your/hub/prompt_id",
) as agent:
    # Use the agent
    result = await agent.run("I'm looking for a new jacket")

Usage Examples

See the examples/ directory for complete implementations:

  • examples/stylist/ - A personal shopping assistant
  • examples/discovery/ - Product discovery agent
  • examples/comparison/ - Product comparison tool

License

This project is licensed under the terms included in the LICENSE file.

Release files for octogen-sdk-langgraph 0.1.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for octogen-sdk-langgraph 0.1.9
File Size Uploaded
octogen_sdk_langgraph-0.1.9.tar.gz 348.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for octogen-sdk-langgraph 0.1.9
File Interpreter ABI Platform
octogen_sdk_langgraph-0.1.9-py3-none-any.whl Python 3 none any Details

Total release size: 371.7 kB

Release files / octogen_sdk_langgraph-0.1.9.tar.gz

Download URL octogen_sdk_langgraph-0.1.9.tar.gz
Size 348.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8191f4462d65e484f16a0adacc7fe7527de01c02788c46de08936385ffca53be
BLAKE2b-256 checksum
How to use checksums
1cc3f23391154b637da21e77b934cb1da41b3434205b585e5c2451b2e07589f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 1, 2025.

Transparency log

Release files / octogen_sdk_langgraph-0.1.9-py3-none-any.whl

Download URL octogen_sdk_langgraph-0.1.9-py3-none-any.whl
Size 23.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c62d4dff0df186eb7c181a17c6b8b9510fee6e73b6e8b401845b761acd213b35
BLAKE2b-256 checksum
How to use checksums
71d66997e911bca4d63784a3690d464b36eab5bfb102d4ff3c202264b99f0413
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 1, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.9 This release

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page