langchain/libs/partners/openai/README.md

# langchain-openai

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

## Installation and Setup

- Install the LangChain partner package
```bash
pip install langchain-openai
```
- Get an OpenAI api key and set it as an environment variable (`OPENAI_API_KEY`)


## LLM

See a [usage example](http://python.langchain.com/docs/integrations/llms/openai).

```python
from langchain_openai import OpenAI
```

If you are using a model hosted on `Azure`, you should use different wrapper for that:
```python
from langchain_openai import AzureOpenAI
```
For a more detailed walkthrough of the `Azure` wrapper, see [here](http://python.langchain.com/docs/integrations/llms/azure_openai)


## Chat model

See a [usage example](http://python.langchain.com/docs/integrations/chat/openai).

```python
from langchain_openai import ChatOpenAI
```

If you are using a model hosted on `Azure`, you should use different wrapper for that:
```python
from langchain_openai import AzureChatOpenAI
```
For a more detailed walkthrough of the `Azure` wrapper, see [here](http://python.langchain.com/docs/integrations/chat/azure_chat_openai)


## Text Embedding Model

See a [usage example](http://python.langchain.com/docs/integrations/text_embedding/openai)

```python
from langchain_openai import OpenAIEmbeddings
```

If you are using a model hosted on `Azure`, you should use different wrapper for that:
```python
from langchain_openai import AzureOpenAIEmbeddings
```
For a more detailed walkthrough of the `Azure` wrapper, see [here](https://python.langchain.com/docs/integrations/text_embedding/azureopenai)
openai[minor]: implement langchain-openai package (#15503) Todo - [x] copy over integration tests - [x] update docs with new instructions in #15513 - [x] add linear ticket to bump core -> community, community->langchain, and core->openai deps - [ ] (optional): add `pip install langchain-openai` command to each notebook using it - [x] Update docstrings to not need `openai` install - [x] Add serialization - [x] deprecate old models Contributor steps: - [x] Add secret names to manual integrations workflow in .github/workflows/_integration_test.yml - [x] Add secrets to release workflow (for pre-release testing) in .github/workflows/_release.yml Maintainer steps (Contributors should not do these): - [x] set up pypi and test pypi projects - [x] add credential secrets to Github Actions - [ ] add package to conda-forge Functional changes to existing classes: - now relies on openai client v1 (1.6.1) via concrete dep in langchain-openai package Codebase organization - some function calling stuff moved to `langchain_core.utils.function_calling` in order to be used in both community and langchain-openai 8 months ago			`# langchain-openai`
openai[patch], docs: readme (#15773) 8 months ago
			This package contains the LangChain integrations for OpenAI through their `openai` SDK.

			`## Installation and Setup`

			`- Install the LangChain partner package`
			```bash
			`pip install langchain-openai`
			```
			- Get an OpenAI api key and set it as an environment variable (`OPENAI_API_KEY`)


			`## LLM`

			`See a [usage example](http://python.langchain.com/docs/integrations/llms/openai).`

			```python
			`from langchain_openai import OpenAI`
			```

			If you are using a model hosted on `Azure`, you should use different wrapper for that:
			```python
			`from langchain_openai import AzureOpenAI`
			```
			For a more detailed walkthrough of the `Azure` wrapper, see [here](http://python.langchain.com/docs/integrations/llms/azure_openai)


			`## Chat model`

			`See a [usage example](http://python.langchain.com/docs/integrations/chat/openai).`

			```python
			`from langchain_openai import ChatOpenAI`
			```

			If you are using a model hosted on `Azure`, you should use different wrapper for that:
			```python
			`from langchain_openai import AzureChatOpenAI`
			```
			For a more detailed walkthrough of the `Azure` wrapper, see [here](http://python.langchain.com/docs/integrations/chat/azure_chat_openai)


			`## Text Embedding Model`

			`See a [usage example](http://python.langchain.com/docs/integrations/text_embedding/openai)`

			```python
			`from langchain_openai import OpenAIEmbeddings`
			```

			If you are using a model hosted on `Azure`, you should use different wrapper for that:
			```python
			`from langchain_openai import AzureOpenAIEmbeddings`
			```
			For a more detailed walkthrough of the `Azure` wrapper, see [here](https://python.langchain.com/docs/integrations/text_embedding/azureopenai)