> ## 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.

# OpenAI Embedder

Agno 使用 `OpenAIEmbedder` 作为向量数据库的默认嵌入器。`OpenAIEmbedder` 类用于通过 OpenAI API 将文本数据嵌入到向量中。请在此处获取您的密钥：[https://platform.openai.com/api-keys](https://platform.openai.com/api-keys)。

## 用法

```python cookbook/embedders/openai_embedder.py theme={null}
from agno.agent import AgentKnowledge
from agno.vectordb.pgvector import PgVector
from agno.embedder.openai import OpenAIEmbedder

# 将句子嵌入到数据库中
embeddings = OpenAIEmbedder().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="openai_embeddings",
        embedder=OpenAIEmbedder(),
    ),
    num_documents=2,
)
```

## 参数

| 参数                | 类型                           | 默认值                        | 描述                              |
| ----------------- | ---------------------------- | -------------------------- | ------------------------------- |
| `model`           | `str`                        | `"text-embedding-ada-002"` | 用于生成嵌入的模型的名称。                   |
| `dimensions`      | `int`                        | `1536`                     | 模型生成的嵌入的维度。                     |
| `encoding_format` | `Literal['float', 'base64']` | `"float"`                  | 嵌入编码的格式。选项为 "float" 或 "base64"。 |
| `user`            | `str`                        | -                          | 与 API 请求关联的用户。                  |
| `api_key`         | `str`                        | -                          | 用于身份验证请求的 API 密钥。               |
| `organization`    | `str`                        | -                          | 与 API 请求关联的组织。                  |
| `base_url`        | `str`                        | -                          | API 端点的基本 URL。                  |
| `request_params`  | `Optional[Dict[str, Any]]`   | -                          | 要包含在 API 请求中的其他参数。              |
| `client_params`   | `Optional[Dict[str, Any]]`   | -                          | 用于配置 API 客户端的其他参数。              |
| `openai_client`   | `Optional[OpenAIClient]`     | -                          | 用于发出 API 请求的 `OpenAIClient` 实例。 |

## 开发者资源

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