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

# OpenAI 向量模型

Spring AI 支持 OpenAI 的文本嵌入模型。
OpenAI 的文本嵌入模型衡量文本字符串的相关性。
嵌入是一个浮点数向量（列表）。两个向量之间的距离衡量它们的相关性。小距离表示高相关性，大距离表示低相关性。

## 先决条件

您需要使用 OpenAI 创建一个 API 才能访问 OpenAI 嵌入模型。

在 [OpenAI 注册页面](https://platform.openai.com/signup)创建一个帐户，并在[API 密钥页面](https://platform.openai.com/account/api-keys)生成令牌。

Spring AI 项目定义了一个名为 `spring.ai.openai.api-key` 的配置属性，您应该将其设置为从 openai.com 获取的 `API Key` 的值。

您可以在 `application.properties` 文件中设置此配置属性：

```properties theme={"system"}
spring.ai.openai.api-key=<您的 OpenAI API 密钥>
```

为了在处理 API 密钥等敏感信息时增强安全性，您可以使用 Spring 表达式语言 (SpEL) 引用环境变量：

```yaml theme={"system"}
# 在 application.yml 中
spring:
  ai:
    openai:
      api-key: ${OPENAI_API_KEY}
```

```bash theme={"system"}
# 在您的环境或 .env 文件中
export OPENAI_API_KEY=<您的 OpenAI API 密钥>
```

您还可以在应用程序代码中以编程方式设置此配置：

```java theme={"system"}
// 从安全来源或环境变量中检索 API 密钥
String apiKey = System.getenv("OPENAI_API_KEY");
```

### 添加存储库和 BOM

Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。
请参阅[工件存储库](/spring4ai/getting-started#artifact-repositories)部分，将这些存储库添加到您的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了一个 BOM (物料清单) 以确保在整个项目中使用一致版本的 Spring AI。请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到您的构建系统中。

## 自动配置

> [!NOTE]
>
> Spring AI 自动配置和启动器模块的工件名称已发生重大更改。
> 有关更多信息，请参阅[升级说明](https://docs.spring.io/spring-ai/reference/upgrade-notes.html)。

Spring AI 为 OpenAI Embedding 模型提供 Spring Boot 自动配置。
要启用它，请将以下依赖项添加到项目的 Maven `pom.xml` 文件中：

```xml theme={"system"}
<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>
```

或添加到您的 Gradle `build.gradle` 构建文件中。

```groovy theme={"system"}
dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}
```

> [!TIP]
>
> 请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到您的构建文件中。

### Embedding 属性

#### 重试属性

前缀 `spring.ai.retry` 用作属性前缀，可让您配置 OpenAI Embedding 模型的重试机制。

| 属性 | 描述 | 默认值 |
| :- | :- | :- |
| spring.ai.retry.max-attempts | 最大重试次数。 | 10 |
| spring.ai.retry.backoff.initial-interval | 指数退避策略的初始休眠持续时间。 | 2 秒 |
| spring.ai.retry.backoff.multiplier | 退避间隔乘数。 | 5 |
| spring.ai.retry.backoff.max-interval | 最大退避持续时间。 | 3 分钟 |
| spring.ai.retry.on-client-errors | 如果为 false，则抛出 NonTransientAiException，并且不尝试对 `4xx` 客户端错误代码进行重试。 | false |
| spring.ai.retry.exclude-on-http-codes | 不应触发重试的 HTTP 状态代码列表 (例如，抛出 NonTransientAiException)。 | 空 |
| spring.ai.retry.on-http-codes | 应触发重试的 HTTP 状态代码列表 (例如，抛出 TransientAiException)。 | 空 |

#### 连接属性

前缀 `spring.ai.openai` 用作属性前缀，可让您连接到 OpenAI。

| 属性 | 描述 | 默认值 |
| :- | :- | :- |
| spring.ai.openai.base-url | 要连接的 URL。 | [https://api.openai.com](https://api.openai.com) |
| spring.ai.openai.api-key | API 密钥。 | - |
| spring.ai.openai.organization-id | 可选，您可以指定用于 API 请求的组织。 | - |
| spring.ai.openai.project-id | 可选，您可以指定用于 API 请求的项目。 | - |

> [!TIP]
>
> 对于属于多个组织的用户 (或通过其旧版用户 API 密钥访问其项目的用户)，您可以选择指定用于 API 请求的组织和项目。
> 来自这些 API 请求的使用量将计为指定组织和项目的使用量。

#### 配置属性

> [!NOTE]
>
> 嵌入自动配置的启用和禁用现在通过前缀为 `spring.ai.model.embedding` 的顶级属性进行配置。
>
> 要启用，请设置 spring.ai.model.embedding=openai (默认情况下启用)
>
> 要禁用，请设置 spring.ai.model.embedding=none (或任何与 openai 不匹配的值)
>
> 此更改是为了允许配置多个模型。

前缀 `spring.ai.openai.embedding` 是配置 OpenAI 的 `EmbeddingModel` 实现的属性前缀。

| 属性 | 描述 | 默认值 |
| :- | :- | :- |
| spring.ai.openai.embedding.enabled (必需且不再有效) | 启用 OpenAI 嵌入模型。 | true |
| spring.ai.model.embedding | 启用 OpenAI 嵌入模型。 | openai |
| spring.ai.openai.embedding.base-url | 可选，覆盖 spring.ai.openai.base-url 以提供特定于嵌入的 URL。 | - |
| spring.ai.openai.embedding.embeddings-path | 要附加到 base-url 的路径。 | `/v1/embeddings` |
| spring.ai.openai.embedding.api-key | 可选，覆盖 spring.ai.openai.api-key 以提供特定于嵌入的 API 密钥。 | - |
| spring.ai.openai.embedding.organization-id | 可选，您可以指定用于 API 请求的组织。 | - |
| spring.ai.openai.embedding.project-id | 可选，您可以指定用于 API 请求的项目。 | - |
| spring.ai.openai.embedding.metadata-mode | 文档内容提取模式。 | EMBED |
| spring.ai.openai.embedding.options.model | 要使用的模型。 | text-embedding-ada-002 (其他选项：text-embedding-3-large、text-embedding-3-small) |
| spring.ai.openai.embedding.options.encodingFormat | 返回嵌入的格式。可以是 float 或 base64。 | - |
| spring.ai.openai.embedding.options.user | 代表最终用户的唯一标识符，可帮助 OpenAI 监控和检测滥用行为。 | - |
| spring.ai.openai.embedding.options.dimensions | 生成的输出嵌入应具有的维度数。仅在 `text-embedding-3` 及更高版本的模型中受支持。 | - |

> [!NOTE]
>
> 您可以为 `ChatModel` 和 `EmbeddingModel` 实现覆盖通用的 `spring.ai.openai.base-url` 和 `spring.ai.openai.api-key`。
> 如果设置了 `spring.ai.openai.embedding.base-url` 和 `spring.ai.openai.embedding.api-key` 属性，则它们优先于通用属性。
> 同样，如果设置了 `spring.ai.openai.chat.base-url` 和 `spring.ai.openai.chat.api-key` 属性，则它们优先于通用属性。
> 如果您想为不同的模型和不同的模型端点使用不同的 OpenAI 帐户，这将非常有用。

> [!TIP]
>
> 所有以 `spring.ai.openai.embedding.options` 为前缀的属性都可以在运行时通过向 `EmbeddingRequest` 调用添加特定于请求的[嵌入选项](#embedding-options)来覆盖。

## 运行时选项

[OpenAiEmbeddingOptions.java](https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiEmbeddingOptions.java) 提供了 OpenAI 配置，例如要使用的模型等。

默认选项也可以使用 `spring.ai.openai.embedding.options` 属性进行配置。

在启动时，使用 `OpenAiEmbeddingModel` 构造函数设置用于所有嵌入请求的默认选项。
在运行时，您可以通过在 `EmbeddingRequest` 中使用 `OpenAiEmbeddingOptions` 实例来覆盖默认选项。

例如，要覆盖特定请求的默认模型名称：

```java theme={"system"}
EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        OpenAiEmbeddingOptions.builder()
            .model("Different-Embedding-Model-Deployment-Name")
        .build()));
```

## 示例控制器

这将创建一个 `EmbeddingModel` 实现，您可以将其注入到您的类中。
这是一个简单的 `@Controller` 类示例，它使用 `EmbeddingModel` 实现。

```properties theme={"system"}
spring.ai.openai.api-key=您的 API 密钥
spring.ai.openai.embedding.options.model=text-embedding-ada-002
```

```java theme={"system"}
@RestController
public class EmbeddingController {

    private final EmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}
```

## 手动配置

如果您不使用 Spring Boot，则可以手动配置 OpenAI Embedding 模型。
为此，请将 `spring-ai-openai` 依赖项添加到项目的 Maven `pom.xml` 文件中：

```xml theme={"system"}
<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai</artifactId>
</dependency>
```

或添加到您的 Gradle `build.gradle` 构建文件中。

```groovy theme={"system"}
dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
```

> [!TIP]
>
> 请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到您的构建文件中。

> [!NOTE]
>
> `spring-ai-openai` 依赖项还提供对 `OpenAiChatModel` 的访问。
> 有关 `OpenAiChatModel` 的更多信息，请参阅 [OpenAI 聊天客户端](/spring4ai/api/chat/openai-chat)部分。

接下来，创建一个 `OpenAiEmbeddingModel` 实例，并用它来计算两个输入文本之间的相似度：

```java theme={"system"}
var openAiApi = OpenAiApi.builder()
                .apiKey(System.getenv("OPENAI_API_KEY"))
                .build();

var embeddingModel = new OpenAiEmbeddingModel(
        this.openAiApi,
        MetadataMode.EMBED,
        OpenAiEmbeddingOptions.builder()
                .model("text-embedding-ada-002")
                .user("user-6")
                .build(),
        RetryUtils.DEFAULT_RETRY_TEMPLATE);

EmbeddingResponse embeddingResponse = this.embeddingModel
        .embedForResponse(List.of("Hello World", "World is big and salvation is near"));
```

`OpenAiEmbeddingOptions` 为嵌入请求提供配置信息。
api 和选项类提供了一个 `builder()` 以便轻松创建选项。

> **[文档有误？请协助编辑](https://github.com/javaai-pig4cloud-com/javaai-docs/edit/main/spring-ai/api/embeddings/openai-embeddings.mdx)**
>
> 发现文档问题？点击此处直接在 GitHub 上编辑并提交 PR，帮助我们改进文档！


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.