> ## Documentation Index
> Fetch the complete documentation index at: https://ikun.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Voyage AI 嵌入器

`VoyageAIEmbedder` 类用于通过 Voyage AI API 将文本数据嵌入到向量中。请在此处获取您的密钥：[https://dash.voyageai.com/api-keys](https://dash.voyageai.com/api-keys)。

## 用法

```python cookbook/embedders/voyageai_embedder.py theme={null}
from agno.agent import AgentKnowledge
from agno.vectordb.pgvector import PgVector
from agno.embedder.voyageai import VoyageAIEmbedder

# 在数据库中嵌入句子
embeddings = VoyageAIEmbedder().get_embedding("The quick brown fox jumps over the lazy dog.")

# 打印嵌入向量及其维度
print(f"Embeddings: {embeddings[:5]}")
print(f"Dimensions: {len(embeddings)}")

# 在知识库中使用嵌入器
knowledge_base = AgentKnowledge(
    vector_db=PgVector(
        db_url="postgresql+psycopg://ai:ai@localhost:5532/ai",
        table_name="voyageai_embeddings",
        embedder=VoyageAIEmbedder(),
    ),
    num_documents=2,
)
```

## 参数

| 参数               | 类型                         | 默认值                                        | 描述                           |
| ---------------- | -------------------------- | ------------------------------------------ | ---------------------------- |
| `model`          | `str`                      | `"voyage-2"`                               | 用于生成嵌入向量的模型名称。               |
| `dimensions`     | `int`                      | `1024`                                     | 模型生成的嵌入向量的维度。                |
| `request_params` | `Optional[Dict[str, Any]]` | -                                          | 在 API 请求中包含的额外参数。可选。         |
| `api_key`        | `str`                      | -                                          | 用于身份验证请求的 API 密钥。            |
| `base_url`       | `str`                      | `"https://api.voyageai.com/v1/embeddings"` | API 端点的基本 URL。               |
| `max_retries`    | `Optional[int]`            | -                                          | API 请求的最大重试次数。可选。            |
| `timeout`        | `Optional[float]`          | -                                          | API 请求的超时时长。可选。              |
| `client_params`  | `Optional[Dict[str, Any]]` | -                                          | 用于配置 API 客户端的额外参数。可选。        |
| `voyage_client`  | `Optional[Client]`         | -                                          | 用于发出 API 请求的 `Client` 实例。可选。 |

## 开发者资源

* 查看 [Cookbook](https://github.com/agno-agi/agno/blob/main/cookbook/agent_concepts/knowledge/embedders/voyageai_embedder.py)