with_structured_output(
  self,
  schema: Optional[Union[Dict, Type[BaseModel]]] = None,
  *,
  method: Literal['function_calling', 'json_mode'] = 'function_calling',
  include_raw: bool = False,
  **kwargs: Any = {}
) -> Runnable[LanguageModelInput, Union[Dict, BaseModel]]

Function-calling, Pydantic schema (method="function_calling", include_raw=False)::

.. code-block:: python

from langchain_community.chat_models import ChatZhipuAI from pydantic import BaseModel

class AnswerWithJustification(BaseModel): '''An answer to the user question along with justification for the answer.''' answer: str justification: str

llm = ChatZhipuAI(temperature=0) structured_llm = llm.with_structured_output(AnswerWithJustification)

structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers")

-> AnswerWithJustification(

answer='A pound of bricks and a pound of feathers weigh the same.'

justification="Both a pound of bricks and a pound of feathers have been defined to have the same weight. The 'pound' is a unit of weight, so any two things that are described as weighing a pound will weigh the same."

)

Function-calling, Pydantic schema (method="function_calling", include_raw=True)::

.. code-block:: python

from langchain_community.chat_models import ChatZhipuAI from pydantic import BaseModel

class AnswerWithJustification(BaseModel): '''An answer to the user question along with justification for the answer.''' answer: str justification: str

llm = ChatZhipuAI(temperature=0) structured_llm = llm.with_structured_output(AnswerWithJustification, include_raw=True)

structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers")

-> {

'raw': AIMessage(content='', additional_kwargs={'tool_calls': [{'id': 'call_01htjn3cspevxbqc1d7nkk8wab', 'function': {'arguments': '{"answer": "A pound of bricks and a pound of feathers weigh the same.", "justification": "Both a pound of bricks and a pound of feathers have been defined to have the same weight. The 'pound' is a unit of weight, so any two things that are described as weighing a pound will weigh the same.", "unit": "pounds"}', 'name': 'AnswerWithJustification'}, 'type': 'function'}]}, id='run-456beee6-65f6-4e80-88af-a6065480822c-0'),

'parsed': AnswerWithJustification(answer='A pound of bricks and a pound of feathers weigh the same.', justification="Both a pound of bricks and a pound of feathers have been defined to have the same weight. The 'pound' is a unit of weight, so any two things that are described as weighing a pound will weigh the same."),

'parsing_error': None

}

Function-calling, dict schema (method="function_calling", include_raw=False)::

.. code-block:: python

from langchain_community.chat_models import ChatZhipuAI from pydantic import BaseModel from langchain_core.utils.function_calling import convert_to_openai_tool

class AnswerWithJustification(BaseModel): '''An answer to the user question along with justification for the answer.''' answer: str justification: str

dict_schema = convert_to_openai_tool(AnswerWithJustification) llm = ChatZhipuAI(temperature=0) structured_llm = llm.with_structured_output(dict_schema)

structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers")

-> {

'answer': 'A pound of bricks and a pound of feathers weigh the same.',

'justification': "Both a pound of bricks and a pound of feathers have been defined to have the same weight. The 'pound' is a unit of weight, so any two things that are described as weighing a pound will weigh the same.", 'unit': 'pounds'}

}