跳到主要内容

OpenAI 官方 SDK

备注

这是 OpenAI 官方 SDK 集成的文档，它使用官方 OpenAI Java SDK。

LangChain4j 提供了 3 种不同的 OpenAI 图像生成集成方式，这是第 2 种：

  • OpenAI 使用自定义的 OpenAI REST API Java 实现，最适合与 Quarkus（因为它使用 Quarkus REST 客户端）和 Spring（因为它使用 Spring 的 RestClient）一起使用。
  • OpenAI 官方 SDK 使用 OpenAI 官方 Java SDK。
  • Azure OpenAI 使用微软的 Azure SDK，如果您使用的是微软 Java 技术栈（包括高级 Azure 认证机制），这个集成将是最佳选择。

此集成的使用场景​

此集成使用 OpenAI Java SDK GitHub 仓库，适用于以下提供商的所有 OpenAI 模型：

  • OpenAI
  • Azure OpenAI

它也适用于支持 OpenAI API 的模型。

OpenAI 文档​

Maven 依赖​

<dependency>
    <groupId>dev.langchain4j</groupId>
    <artifactId>langchain4j-open-ai-official</artifactId>
    <version>1.0.0-beta3</version>
</dependency>

配置模型​

要使用 OpenAI 模型，通常需要一个端点 URL、API 密钥和模型名称。这取决于模型的托管位置，此集成尝试通过一些自动配置使其更容易：

通用配置​

import com.openai.models.images.ImageModel;
import dev.langchain4j.model.image.ImageModel;
import dev.langchain4j.model.openaiofficial.OpenAiOfficialImageModel;

// ....

ImageModel model = OpenAiOfficialImageModel.builder()
        .baseUrl(System.getenv("OPENAI_BASE_URL"))
        .apiKey(System.getenv("OPENAI_API_KEY"))
        .modelName(ImageModel.DALL_E_3)
        .build();

Azure OpenAI 和 GitHub Models 的特定配置​

与配置 OpenAI 官方聊天模型 类似，您可以使用 isAzure() 和 isGitHubModels() 方法为 Azure OpenAI 和 GitHub Models 配置 OpenAiOfficialImageModel。

Azure OpenAI​

ImageModel model = OpenAiOfficialImageModel.builder()
        .baseUrl(System.getenv("AZURE_OPENAI_ENDPOINT"))
        .apiKey(System.getenv("AZURE_OPENAI_KEY"))
        .modelName(ImageModel.DALL_E_3)
        .isAzure(true) // 如果基础 URL 以 `openai.azure.com` 结尾，则不必要
        .build();

您还可以使用"无密码"认证，如 OpenAI 官方聊天模型 文档中所述。

GitHub Models​

ImageModel model = OpenAiOfficialImageModel.builder()
        .modelName(ImageModel.DALL_E_3)
        .isGitHubModels(true)
        .build();

使用模型​

一旦配置好模型，您就可以使用它来生成图像：

String imageUrl = imageModel
        .generate("巴黎的一个咖啡杯")
        .content()
        .url()
        .toString();