JA ▾
API キーを取得

LangChain エージェントAIドキュメント:ツールとJSONモード

LangChainのエージェントAIドキュメントの多くはベンダー独自のモデルクラスを前提としていますが、base URLを設定すれば、ChatOpenAIは任意のOpenAI互換エンドポイントで動作します。このガイドでは、LangChainをこのAPIに接続し、ツール呼び出しエージェントを段階的に構築します。

更新日:

主要ポイント

  • base_urlをこのAPIに設定し、モデルをuncensoredに設定してChatOpenAIを使用します。
  • ツール呼び出しと JSON モードはサポートされているため、bind_tools と response_format は文書通り動作します。
  • エージェントループを制限し、ツール引数を検証し、フルキーではmax_concurrencyを8以下に保ってください。
  • SSE 経由のストリーミングは終了時にトークン使用量を返すため、各エージェント実行のコストを追跡するのに役立ちます。
ツールステーションを介してキューブを移動するロボットアームがループトラックを回る様子で、LangChain エージェントループを表しています

開始前に必要なもの

LangChain エージェント AI ドキュメントを読んでいて、モデルが例のベンダー製ではない場合に何が変わるのか疑問に思っている場合、答えは「ほとんど変わりません」です。LangChain のエージェントはループです:モデルが会話を読み取り、ツールを呼び出すかどうかを判断し、あなたのコードがツールを実行し、最終的な回答が生成されるまで結果がモデルに戻ります。モデルエンドポイントはツール呼び出し付きのchat completionsをサポートする必要があり、この API はそれをサポートしています。

必要なものは 3 つです:キーページからの API キー、Python 3.10 以降、および以下のパッケージです。ベース URL は https://api.unlimitedaiapi.com/v1 で、モデル ID は uncensored です。これは独立したプロバイダが運営するオープンウェイトモデルのため、選択できるモデルリストはありません。GET /v1/models はクライアントの検出用にこれを返します。

pip install -U langchain langchain-openai
export UNLIMITED_API_KEY="your-key-here"

ステップ1:ChatOpenAIをエンドポイントに接続する

LangChainのChatOpenAIクラスはカスタムbase_urlを受け取ります。それ以外の部分はすべて同じままです。invoke、stream、batch、および非同期バリアントを含みます。

import os
from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    model="uncensored",
    base_url="https://api.unlimitedaiapi.com/v1",
    api_key=os.environ["UNLIMITED_API_KEY"],
    temperature=0.2,
)

print(llm.invoke("Reply with one short sentence.").content)

これが文を出力する場合、認証、ルーティング、モデル名はすべて正しいです。認証は標準のAuthorization: Bearerヘッダーであり、クラスが自動的に追加します。よくあるミスはベースURLに/v1を付け忘れることで、通常は最初の呼び出しが失敗します。

ステップ2:ツールを定義してバインドする

ツールはdocstringを持つ単純な Python 関数です。docstringと型ヒントはモデルが参照するスキーマになるため、新しい同僚に関数を説明するように記述してください。

import os
from langchain_core.tools import tool
from langchain_openai import ChatOpenAI

@tool
def get_order_status(order_id: str) -> str:
    '''Look up the status of an order by its ID, for example A100.'''
    return {"A100": "shipped", "A101": "processing"}.get(order_id, "not found")

llm = ChatOpenAI(
    model="uncensored",
    base_url="https://api.unlimitedaiapi.com/v1",
    api_key=os.environ["UNLIMITED_API_KEY"],
    temperature=0,
)
llm_with_tools = llm.bind_tools([get_order_status])

ai = llm_with_tools.invoke("Where is order A100?")
print(ai.tool_calls)

出力されたリストには、名前がget_order_statusで、{"order_id": "A100"}のような引数を持つ呼び出しが含まれています。内部ではLangChainはあなたの関数をchat completionsリクエストのtools配列のエントリとして送信し、APIはtools、tool_choice、ストリーミングされたtool_callsをサポートしています。ツール呼び出しを強制するには、tool_choiceをbind_toolsに渡します。

温度が低い理由

エージェントは複数のモデル呼び出しをチェーンするため、1つの不正な引数が実行を破綻させる可能性があります。温度を0から0.2に設定すると、ツール選択の再現性が高まります。より多様な文章を望む場合のみ、最終的な回答ステップで温度を上げてください。

ステップ3:エージェントループを実行する

ループを自分で記述するには15行かかり、各ステップで何が起こっているかが明確になり、問題が発生した際に役立ちます。ツール結果はToolMessageオブジェクトとしてモデルに戻され、それらはネットワーク上ではrole: "tool"メッセージになります。

import os
from langchain_core.messages import HumanMessage, ToolMessage
from langchain_core.tools import tool
from langchain_openai import ChatOpenAI

@tool
def get_order_status(order_id: str) -> str:
    '''Look up the status of an order by its ID, for example A100.'''
    return {"A100": "shipped", "A101": "processing"}.get(order_id, "not found")

llm = ChatOpenAI(
    model="uncensored",
    base_url="https://api.unlimitedaiapi.com/v1",
    api_key=os.environ["UNLIMITED_API_KEY"],
    temperature=0,
)
tools = {"get_order_status": get_order_status}
llm_with_tools = llm.bind_tools(list(tools.values()))

messages = [HumanMessage("Where is order A100, and what about A101?")]
for _ in range(5):                      # hard cap on loop length
    ai = llm_with_tools.invoke(messages)
    messages.append(ai)
    if not ai.tool_calls:
        break
    for call in ai.tool_calls:
        result = tools[call["name"]].invoke(call["args"])
        messages.append(ToolMessage(content=str(result), tool_call_id=call["id"]))

print(ai.content)

range(5)に注目してください。ステップ制限のないエージェントは、混乱を招くツール結果に対して無限にループする可能性があり、各パスではこれまでの会話全体の入力トークンがかかります。5は単純なタスクには適切な上限です。意図的に引き上げてください。

ビルトインエージェントヘルパーの使用

最新のLangChainバージョンには、このループをあなたのために実行するヘルパーが含まれています。名前とインポートパスはリリース間で移動しているため、インストールされているバージョンのドキュメントで確認してください。現在の1.xラインでは次のようになります。

import os
from langchain.agents import create_agent
from langchain_core.tools import tool
from langchain_openai import ChatOpenAI

@tool
def get_order_status(order_id: str) -> str:
    '''Look up the status of an order by its ID, for example A100.'''
    return {"A100": "shipped", "A101": "processing"}.get(order_id, "not found")

llm = ChatOpenAI(
    model="uncensored",
    base_url="https://api.unlimitedaiapi.com/v1",
    api_key=os.environ["UNLIMITED_API_KEY"],
    temperature=0,
)

agent = create_agent(llm, tools=[get_order_status], system_prompt="You are a concise support assistant.")
result = agent.invoke({"messages": [{"role": "user", "content": "Where is order A100?"}]})
print(result["messages"][-1].content)

標準的なパターンを望む場合はヘルパーを使用し、カスタム停止ルール、ステップごとのログ、モデルが確認する前にフィルタリングしたいツール結果が必要な場合は手書きのループを使用してください。

JSON モードによる構造化出力

エージェントはしばしば他のコードにデータを渡す必要があります。例えば、計画、分類、または抽出されたフィールドのリストなどです。JSONモードは応答を有効なJSONオブジェクトに強制します。LangChainでは、それをbind経由で渡すことができます。

import json
import os
from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    model="uncensored",
    base_url="https://api.unlimitedaiapi.com/v1",
    api_key=os.environ["UNLIMITED_API_KEY"],
    temperature=0,
)
json_llm = llm.bind(response_format={"type": "json_object"})

msg = json_llm.invoke(
    "Extract the city and country from: 'I moved to Lyon, France last spring.' "
    "Answer as JSON with the keys city and country."
)
print(json.loads(msg.content))

プロンプトに JSON という単語を含め、期待するキーを記述します(例参照)。JSON モードは構文を保証しますがスキーマを保証するわけではないため、解析されたオブジェクト(例えば Pydantic で)をまだ検証し、欠落したキーの処理を行ってください。

エージェント実行の制限、ストリーミング、コスト

エージェントは短時間で多数の呼び出しを行うため、アカウントの制限は単純なチャットボットよりも重要です。フルキーでは同時8リクエスト、1分あたり300リクエストが可能です。トライアルキーでは2と60です。batchでファンアウトしたり、複数のエージェントを同時に実行する場合は、設定で同時実行数を制限してください:

import os
from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    model="uncensored",
    base_url="https://api.unlimitedaiapi.com/v1",
    api_key=os.environ["UNLIMITED_API_KEY"],
)
prompts = ["Name one prime number.", "Name one even number.", "Name one square number."]
answers = llm.batch(prompts, config={"max_concurrency": 8})
for a in answers:
    print(a.content)

トライアルキーでは8の代わりに2を使用してください。インタラクティブなエージェントの場合、llm.stream(...)は生成されるたびにSSE経由でトークンを返し、使用量はストリームの最後に到着します。

コストの見積もりは簡単です。平均して4,000の入力トークンと300の出力トークンを使用する5ステップの実行では、合計で20,000の入力トークンと1,500の出力トークンを使用し、1Mトークンあたり$0.15と$0.50の場合、1回の実行あたり$0.003 + $0.00075 = $0.00375になります。料金ページにはレートが、ドキュメントには単一の失敗した呼び出しを追跡するためのX-Request-Idを含むリクエストパラメータとヘッダーがリストされています。

モデルが使用できるツールの設計

エージェントの失敗の多くはループではなくツールに起因します。どのモデルでも役立つルールがいくつかあります。

  • 各ツールは特定の目的に絞ってください。get_order_statusのようなツールは、自由形式のテキストを取るdatabase_queryのような1つのツールよりも効果的です。
  • 単純な引数型を使用してください:文字列、整数、短い列挙型。深くネストされたオブジェクトは、モデルがフィールドを誤って取得する可能性を増やします。
  • 短く、簡潔な結果を返してください。50,000文字を会話にダンプするツールはコンテキストウィンドウを埋め、後のすべてのステップのコストを上げます。
  • 例外を発生させて実行を終了させるのではなく、エラーをテキストとして返してください。例えば「order_idはA100のように見える必要があります」など。

スケールアップする前に、$0.50のトライアルクレジットで実際のプロンプトいくつかでエージェントをテストしてください。新規ユーザーはキーページでワンクリックで取得でき、7日間有効です。

最初に確認すべき落とし穴

  • ツール呼び出しが生成されない。 docstringを具体的にし、温度を下げるか、tool_choiceで呼び出しを強制してください。
  • 無効な引数。 ツール内で検証し、明確なエラー文字列を返して、モデルが次のステップで自己修正できるようにします。
  • コンテキストの肥大化。 ウィンドウは応答を含む100,000トークンです。ウィンドウが埋まる前に古いツール出力をトリムしてください。

質問と回答

どの LangChain クラスがこの API で動作しますか?

langchain-openaiのChatOpenAIを使用します。base_urlをhttps://api.unlimitedaiapi.com/v1に設定し、モデルをuncensoredに設定し、api_keyとしてキーを渡します。

API はエージェントのツール呼び出しに対応していますか?

はい。tools と tool_choice パラメータを受け付け、ストリーミング時を含む tool_calls を返し、role tool のメッセージとして結果を受け取ります。

LangChain はこの API を通じて構造化出力を解析できますか?

はい、JSON モードを使用します。response_format を json_object 型に設定します。有効な JSON 構文を保証しますが、フィールドは自分で検証してください。

並列で何個のエージェントを実行できますか?

フルキーは8つの同時リクエストと1分あたり300リクエストを許可します。トライアルキーは2つの同時リクエストと1分あたり60リクエストを許可します。

キーはフォーム 1 つで手に入ります

アカウントを作成し、キーをコピーし、ベースURLを変更します。これでセットアップは完了です。

API キーを取得