mirror of https://github.com/hwchase17/langchain.git synced 2026-06-09 10:17:00 +00:00

Files

ccurme 815bfa1913 openai[patch]: support streaming with json_schema response format (#29044 )

- Stream JSON string content. Final chunk includes parsed representation
(following OpenAI
[docs](https://platform.openai.com/docs/guides/structured-outputs#streaming)).
- Mildly (?) breaking change: if you were using streaming with
`response_format` before, usage metadata will disappear unless you set
`stream_usage=True`.

## Response format

Before:

![Screenshot 2025-01-06 at 11 59
01 AM](https://github.com/user-attachments/assets/e54753f7-47d5-421d-b8f3-172f32b3364d)


After:

![Screenshot 2025-01-06 at 11 58
13 AM](https://github.com/user-attachments/assets/34882c6c-2284-45b4-92f7-5b5b69896903)


## with_structured_output

For pydantic output, behavior of `with_structured_output` is unchanged
(except for warning disappearing), because we pluck the parsed
representation straight from OpenAI, and OpenAI doesn't return it until
the stream is completed. Open to alternatives (e.g., parsing from
content or intermediate dict chunks generated by OpenAI).

Before:

![Screenshot 2025-01-06 at 12 38
11 PM](https://github.com/user-attachments/assets/913d320d-f49e-4cbb-a800-b394ae817fd1)

After:

![Screenshot 2025-01-06 at 12 38
58 PM](https://github.com/user-attachments/assets/f7a45dd6-d886-48a6-8d76-d0e21ca767c6)

2025-01-09 10:32:30 -05:00

langchain_openai

openai[patch]: support streaming with json_schema response format (#29044 )

2025-01-09 10:32:30 -05:00

scripts

multiple: pydantic 2 compatibility, v0.3 (#26443 )

2024-09-13 14:38:45 -07:00

tests

openai[patch]: support streaming with json_schema response format (#29044 )

2025-01-09 10:32:30 -05:00

.gitignore

openai: audio modality, remove sockets from unit tests (#27436 )

2024-10-18 08:02:09 -07:00

LICENSE

…

Makefile

openai: audio modality, remove sockets from unit tests (#27436 )

2024-10-18 08:02:09 -07:00

poetry.lock

openai[patch]: type reasoning_effort (#28825 )

2024-12-19 19:36:49 +00:00

pyproject.toml

openai[patch]: Release 0.2.14 (#28826 )

2024-12-19 11:56:44 -08:00

README.md

openai[patch], docs: readme (#15773 )

2024-01-09 11:52:24 -08:00

README.md

langchain-openai

This package contains the LangChain integrations for OpenAI through their openai SDK.

Installation and Setup

Install the LangChain partner package

pip install langchain-openai

Get an OpenAI api key and set it as an environment variable (OPENAI_API_KEY)

LLM

See a usage example.

from langchain_openai import OpenAI

If you are using a model hosted on Azure, you should use different wrapper for that:

from langchain_openai import AzureOpenAI

For a more detailed walkthrough of the Azure wrapper, see here

Chat model

See a usage example.

from langchain_openai import ChatOpenAI

If you are using a model hosted on Azure, you should use different wrapper for that:

from langchain_openai import AzureChatOpenAI

For a more detailed walkthrough of the Azure wrapper, see here

Text Embedding Model

See a usage example

from langchain_openai import OpenAIEmbeddings

If you are using a model hosted on Azure, you should use different wrapper for that:

from langchain_openai import AzureOpenAIEmbeddings

For a more detailed walkthrough of the Azure wrapper, see here