# ClarifaiEmbeddings

> **Class** in `langchain_community`

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

Clarifai embedding models.

To use, you should have the ``clarifai`` python package installed, and the
environment variable ``CLARIFAI_PAT`` set with your personal access token or pass it
as a named parameter to the constructor.

## Signature

```python
ClarifaiEmbeddings()
```

## Description

**Example:**

.. code-block:: python

from langchain_community.embeddings import ClarifaiEmbeddings
clarifai = ClarifaiEmbeddings(user_id=USER_ID,
                              app_id=APP_ID,
                              model_id=MODEL_ID)
                 (or)
Example_URL = "https://clarifai.com/clarifai/main/models/BAAI-bge-base-en-v15"
clarifai = ClarifaiEmbeddings(model_url=EXAMPLE_URL)

## Extends

- `BaseModel`
- `Embeddings`

## Properties

- `model_url`
- `model_id`
- `model_version_id`
- `app_id`
- `user_id`
- `pat`
- `token`
- `model`
- `api_base`
- `model_config`

## Methods

- [`validate_environment()`](https://reference.langchain.com/python/langchain-community/embeddings/clarifai/ClarifaiEmbeddings/validate_environment)
- [`embed_documents()`](https://reference.langchain.com/python/langchain-community/embeddings/clarifai/ClarifaiEmbeddings/embed_documents)
- [`embed_query()`](https://reference.langchain.com/python/langchain-community/embeddings/clarifai/ClarifaiEmbeddings/embed_query)

---

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