# VoyageEmbeddings

> **Class** in `langchain_community`

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

Voyage embedding models.

To use, you should have the environment variable ``VOYAGE_API_KEY`` set with
your API key or pass it as a named parameter to the constructor.

## Signature

```python
VoyageEmbeddings()
```

## Description

**Example:**

.. code-block:: python

from langchain_community.embeddings import VoyageEmbeddings

voyage = VoyageEmbeddings(voyage_api_key="your-api-key", model="voyage-2")
text = "This is a test query."
query_result = voyage.embed_query(text)

## Extends

- `BaseModel`
- `Embeddings`

## Properties

- `model`
- `voyage_api_base`
- `voyage_api_key`
- `batch_size`
- `max_retries`
- `request_timeout`
- `show_progress_bar`
- `truncation`
- `model_config`

## Methods

- [`validate_environment()`](https://reference.langchain.com/python/langchain-community/embeddings/voyageai/VoyageEmbeddings/validate_environment)
- [`embed_documents()`](https://reference.langchain.com/python/langchain-community/embeddings/voyageai/VoyageEmbeddings/embed_documents)
- [`embed_query()`](https://reference.langchain.com/python/langchain-community/embeddings/voyageai/VoyageEmbeddings/embed_query)
- [`embed_general_texts()`](https://reference.langchain.com/python/langchain-community/embeddings/voyageai/VoyageEmbeddings/embed_general_texts)

## ⚠️ Deprecated

Deprecated since version 0.0.29.

---

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