概要

langchain v0.3のChatOpenAIの構造化出力、tool_callのやり方をよく忘れるので自分用にまとめました。

準備

pip install langchain langchain-openai

環境変数OPENAI_API_KEYを指定します。もしくはプロジェクトのルートに.envを作成しOPENAI_API_KEYを指定します。

構造化出力

pydanticのBaseModelまたはTypedDictをmodel.with_structured_outputに渡せばよいです（参考）

Pydantic

pydantic.Fieldは変数の説明を加えたいときに使います。変数名のみで意味が明確であれば不要です。

from pydantic import BaseModel, Field
from langchain_openai import ChatOpenAI

class AnswerWithConfidence(BaseModel):
    answer: str = Field(description="回答")
    answer_is_based_on_reference: bool = Field(description="参考文献に基づいて正確な回答を作成できたかどうか。参考文献が情報不足の場合などはFalseとする。")

model = ChatOpenAI(model="gpt-4o-mini")
model_with_structured_output = model.with_structured_output(AnswerWithConfidence)

output = model_with_structured_output.invoke("質問: この世界で５０番目の山の高さは？、参考文献: この世界で５０番目に高い山は富士山です。")
print(output.answer)
print(output.answer_is_based_on_reference)

富士山の高さは3,776メートルです。
True

TypedDict

pydantic.BaseModelの代わりにTypedDictを使うこともできます。
Annotatedは変数の説明を加えたいときに使います。変数名のみで意味が明確であれば不要です。

from langchain_openai import ChatOpenAI
from typing import TypedDict, Annotated

class AnswerWithConfidence(TypedDict):
    answer: Annotated[str, ..., "回答"]
    answer_is_based_on_reference: Annotated[bool, ..., "参考文献に基づいて正確な回答を作成できたかどうか。参考文献が情報不足の場合などはFalseとする。"]

model = ChatOpenAI(model="gpt-4o-mini")
model_with_structured_output = model.with_structured_output(AnswerWithConfidence)

output = model_with_structured_output.invoke("質問: この世界で５０番目の山の高さは？、参考文献: この世界で５０番目に高い山は富士山です。")
print(output["answer"])
print(output["answer_is_based_on_reference"])

富士山の高さは3,776メートルです。
True

tool_call

tool_callはtoolを定義して、model.with_toolsに渡します（参考）。
toolの定義はpydanticかTypedDictか@toolデコレータを使います。
ここではデコレータを使います。

from typing import Literal
import sys
from langchain_core.tools import tool
from langchain_core.messages import HumanMessage

@tool
def weather_tool(weather: Literal["sunny", "cloudy", "rainy"]) -> None:
    """Describe the weather"""
    print(f"The weather is {weather}")


model_with_tools = model.bind_tools([weather_tool])

message = HumanMessage(
    content=[
        {"type": "text", "text": "天気をランダムに教えて"},
    ],
)
response = model_with_tools.invoke([message])
print(response.tool_calls)

function_name = response.tool_calls[0]["name"]
function_args = response.tool_calls[0]["args"]

module = sys.modules[__name__]  # 現在のモジュールを取得
getattr(module, function_name)(function_args)

[{'name': 'weather_tool', 'args': {'weather': 'sunny'}, 'id': 'call_6ffI1FLNwPrTWfyXIBVnCgLB', 'type': 'tool_call'}]
The weather is sunny

デコレータでツール化された関数は引数の辞書を受け取る仕様になっているので、**function_argsではなくfunction_argsを与えていることに注意してください。