# LocalAIEmbeddings

> **Class** in `langchain_community`

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

LocalAI embedding models.

Since LocalAI and OpenAI have 1:1 compatibility between APIs, this class
uses the ``openai`` Python package's ``openai.Embedding`` as its client.
Thus, you should have the ``openai`` python package installed, and defeat
the environment variable ``OPENAI_API_KEY`` by setting to a random string.
You also need to specify ``OPENAI_API_BASE`` to point to your LocalAI
service endpoint.

## Signature

```python
LocalAIEmbeddings()
```

## Description

**Example:**

.. code-block:: python

from langchain_community.embeddings import LocalAIEmbeddings
openai = LocalAIEmbeddings(
    openai_api_key="random-string",
    openai_api_base="http://localhost:8080"
)

## Extends

- `BaseModel`
- `Embeddings`

## Properties

- `client`
- `model`
- `deployment`
- `openai_api_version`
- `openai_api_base`
- `openai_proxy`
- `embedding_ctx_length`
- `openai_api_key`
- `openai_organization`
- `allowed_special`
- `disallowed_special`
- `chunk_size`
- `max_retries`
- `request_timeout`
- `headers`
- `show_progress_bar`
- `model_kwargs`
- `model_config`

## Methods

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

---

[View source on GitHub](https://github.com/langchain-ai/langchain-community/blob/4b280287bd55b99b44db2dd849f02d66c89534d5/libs/community/langchain_community/embeddings/localai.py#L123)