# OpenAIEmbeddings

> **Class** in `langchain_community`

📖 [View in docs](https://reference.langchain.com/python/langchain-community/embeddings/openai/OpenAIEmbeddings)

OpenAI embedding models.

To use, you should have the ``openai`` python package installed, and the
environment variable ``OPENAI_API_KEY`` set with your API key or pass it
as a named parameter to the constructor.

## Signature

```python
OpenAIEmbeddings()
```

## Description

**Example:**

.. code-block:: python

from langchain_community.embeddings import OpenAIEmbeddings
openai = OpenAIEmbeddings(openai_api_key="my-api-key")

In order to use the library with Microsoft Azure endpoints, you need to set
the OPENAI_API_TYPE, OPENAI_API_BASE, OPENAI_API_KEY and OPENAI_API_VERSION.
The OPENAI_API_TYPE must be set to 'azure' and the others correspond to
the properties of your endpoint.
In addition, the deployment name must be passed as the model parameter.

**Example:**

.. code-block:: python

import os

os.environ["OPENAI_API_TYPE"] = "azure"
os.environ["OPENAI_API_BASE"] = "https://<your-endpoint.openai.azure.com/"
os.environ["OPENAI_API_KEY"] = "your AzureOpenAI key"
os.environ["OPENAI_API_VERSION"] = "2023-05-15"
os.environ["OPENAI_PROXY"] = "http://your-corporate-proxy:8080"

from langchain_community.embeddings.openai import OpenAIEmbeddings
embeddings = OpenAIEmbeddings(
    deployment="your-embeddings-deployment-name",
    model="your-embeddings-model-name",
    openai_api_base="https://your-endpoint.openai.azure.com/",
    openai_api_type="azure",
)
text = "This is a test query."
query_result = embeddings.embed_query(text)

## Extends

- `BaseModel`
- `Embeddings`

## Properties

- `client`
- `async_client`
- `model`
- `deployment`
- `openai_api_version`
- `openai_api_base`
- `openai_api_type`
- `openai_proxy`
- `embedding_ctx_length`
- `openai_api_key`
- `openai_organization`
- `allowed_special`
- `disallowed_special`
- `chunk_size`
- `max_retries`
- `request_timeout`
- `headers`
- `tiktoken_enabled`
- `tiktoken_model_name`
- `show_progress_bar`
- `model_kwargs`
- `skip_empty`
- `default_headers`
- `default_query`
- `retry_min_seconds`
- `retry_max_seconds`
- `http_client`
- `model_config`

## Methods

- [`build_extra()`](https://reference.langchain.com/python/langchain-community/embeddings/openai/OpenAIEmbeddings/build_extra)
- [`validate_environment()`](https://reference.langchain.com/python/langchain-community/embeddings/openai/OpenAIEmbeddings/validate_environment)
- [`embed_documents()`](https://reference.langchain.com/python/langchain-community/embeddings/openai/OpenAIEmbeddings/embed_documents)
- [`aembed_documents()`](https://reference.langchain.com/python/langchain-community/embeddings/openai/OpenAIEmbeddings/aembed_documents)
- [`embed_query()`](https://reference.langchain.com/python/langchain-community/embeddings/openai/OpenAIEmbeddings/embed_query)
- [`aembed_query()`](https://reference.langchain.com/python/langchain-community/embeddings/openai/OpenAIEmbeddings/aembed_query)

## ⚠️ Deprecated

Deprecated since version 0.0.9.

---

[View source on GitHub](https://github.com/langchain-ai/langchain-community/blob/d5ea8358933260ad48dd31f7f8076555c7b4885a/libs/community/langchain_community/embeddings/openai.py#L145)