convert_to_openai_messages

Parameters

Name	Type	Description
`messages`*	`MessageLikeRepresentation \| Sequence[MessageLikeRepresentation]`	Message-like object or iterable of objects whose contents are in OpenAI, Anthropic, Bedrock Converse, or VertexAI formats.
`text_format`	`Literal['string', 'block']`	Default:`'string'` How to format string or text block contents: `'string'`: If a message has a string content, this is left as a string. If a message has content blocks that are all of type `'text'`, these are joined with a newline to make a single string. If a message has content blocks and at least one isn't of type `'text'`, then all blocks are left as dicts. `'block'`: If a message has a string content, this is turned into a list with a single content block of type `'text'`. If a message has content blocks these are left as is.
`include_id`	`bool`	Default:`False`
`pass_through_unknown_blocks`	`bool`	Default:`True`

Example:

from langchain_core.messages import (
    convert_to_openai_messages,
    AIMessage,
    SystemMessage,
    ToolMessage,
)

messages = [
    SystemMessage([{"type": "text", "text": "foo"}]),
    {
        "role": "user",
        "content": [
            {"type": "text", "text": "what's in this"},
            {
                "type": "image_url",
                "image_url": {"url": "data:image/png;base64,'/9j/4AAQSk'"},
            },
        ],
    },
    AIMessage(
        "",
        tool_calls=[
            {
                "name": "analyze",
                "args": {"baz": "buz"},
                "id": "1",
                "type": "tool_call",
            }
        ],
    ),
    ToolMessage("foobar", tool_call_id="1", name="bar"),
    {"role": "assistant", "content": "that's nice"},
]
oai_messages = convert_to_openai_messages(messages)
# -> [
#   {'role': 'system', 'content': 'foo'},
#   {'role': 'user', 'content': [{'type': 'text', 'text': 'what's in this'}, {'type': 'image_url', 'image_url': {'url': "data:image/png;base64,'/9j/4AAQSk'"}}]},
#   {'role': 'assistant', 'tool_calls': [{'type': 'function', 'id': '1','function': {'name': 'analyze', 'arguments': '{"baz": "buz"}'}}], 'content': ''},
#   {'role': 'tool', 'name': 'bar', 'content': 'foobar'},
#   {'role': 'assistant', 'content': 'that's nice'}
# ]

LangChain Assistant

Menu

Parameters

Menu

convert_to_openai_messages

Used in Docs

Parameters