|
最新快照版本请使用Spring AI 1.1.0！ |
OpenAI 聊天
Spring AI 支持来自 OpenAI 的各种 AI 语言模型，OpenAI 是 ChatGPT 背后的公司，该公司通过创建行业领先的文本生成模型和嵌入，在激发 AI 驱动文本生成的兴趣方面发挥了关键作用。
前提条件
你需要用OpenAI创建一个API来访问ChatGPT模型。
在OpenAI注册页面创建账户，并在API密钥页面生成Tokens。
Spring AI 项目定义了一个配置属性，名为spring.ai.openai.api-key（春.ai.openai.api-key）你应该设置为API 密钥资料来源 openai.com。
你可以在你的application.properties文件：
spring.ai.openai.api-key=<your-openai-api-key>为了在处理敏感信息如 API 密钥时增强安全性，您可以使用 Spring 表达式语言（SpEL）引用自定义环境变量：
# In application.yml
spring:
ai:
openai:
api-key: ${OPENAI_API_KEY}# In your environment or .env file
export OPENAI_API_KEY=<your-openai-api-key>你也可以在应用代码中编程设置此配置：
// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("OPENAI_API_KEY");自动配置
|
春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。 |
Spring AI 为 OpenAI 聊天客户端提供 Spring Boot 自动配置。
要启用它，请在项目的Maven中添加以下依赖pom.xml或者Gradlebuild.gradle构建文件：
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}| 请参考依赖管理部分，将Spring AI的物料清单添加到你的构建文件中。 |
聊天属性
重试属性
前缀spring.ai.retry作为属性前缀，用于配置OpenAI聊天模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.retry.max尝试 |
重试次数上限。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数式退避政策的初始睡眠时长。 |
两秒钟。 |
spring.ai.retry.backoff.multiplier |
后退间隔倍数。 |
5 |
spring.ai.retry.backoff.max区间 |
最大退回时间。 |
3分钟。 |
spring.ai.retry.on-client-errors |
如果为假，抛出非瞬态AiException，且不要尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应该触发重试的HTTP状态码列表（例如抛出非瞬态Ai异常）。 |
empty |
spring.ai.retry.on-http-codes |
应触发重试的HTTP状态码列表（例如抛出TransientAiException）。 |
empty |
连接性质
前缀春.ai.openai作为属性前缀，允许你连接到OpenAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
Spring.ai.openai.base-url |
连接的URL（链接） |
|
spring.ai.openai.api-key（春.ai.openai.api-key） |
API 密钥 |
- |
spring.ai.openai.organization-id |
可选地，你可以指定使用哪个组织来执行 API 请求。 |
- |
spring.ai.openai.project-id |
可选地，你可以指定用于 API 请求的项目。 |
- |
| 对于属于多个组织的用户（或通过其遗留用户API密钥访问项目）的用户，你可以选择指定用于API请求的组织和项目。 这些 API 请求的使用将计入指定组织和项目的使用。 |
配置属性
|
现在，启用和禁用聊天自动配置通过带有前缀的顶层属性进行配置 启用时，spring.ai.model.chat=openai（默认启用） 要禁用，可以选择 spring.ai.model.chat=none（或任何与 openai 不匹配的值） 此改动旨在允许配置多个模型。 |
前缀spring.ai.openai.chat是允许您配置OpenAI聊天模型实现的属性前缀。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.openai.chat.enabled（已移除且不再有效） |
启用OpenAI聊天模型。 |
true |
spring.ai.model.chat |
启用OpenAI聊天模型。 |
OpenAI |
spring.ai.openai.chat.base-url |
可选覆盖 |
- |
spring.ai.openai.chat.completions-path |
附加到基础URL的路径。 |
|
spring.ai.openai.chat.api-key。 |
可选覆盖 |
- |
spring.ai.openai.chat.organization-id |
可选地，你可以指定使用哪个组织来执行 API 请求。 |
- |
spring.ai.openai.chat.project-id |
可选地，你可以指定用于 API 请求的项目。 |
- |
spring.ai.openai.chat.options.model |
OpenAI 聊天模型的名称。您可以选择以下型号： |
|
spring.ai.openai.chat.options.temperature. |
采样温度决定了生成完备的显得创造力。值越高，输出越随机，值越低，结果越聚焦且确定性强。不建议进行修改 |
0.8 |
spring.ai.openai.chat.options.frequency 惩罚 |
数字介于-2.0到2.0之间。正值会根据新标记在文本中已有的频率进行惩罚，降低模型逐字重复同一行的可能性。 |
0.0f |
spring.ai.openai.chat.options.logit偏见 |
修改完成中出现指定标记的可能性。 |
- |
spring.ai.openai.chat.options.maxTokens |
聊天补全时最多可生成的Tokens数。输入标记和生成标记的总长度受模型上下文长度限制。用于非推理模型（例如，GPT-40，GPT-3.5-turbo）。不能与推理模型（例如 o1、o3、o4-mini 系列）一起使用。与 maxCompletionTokens 互斥——同时设置两者都会导致 API 错误。 |
- |
spring.ai.openai.chat.options.maxCompletionTokens |
完成化可生成的Tokens数量的上限，包括可见的输出Tokens和推理Tokens。推理模型（例如 o1、o3、o4-mini 系列）必备。不能用于非推理模型（例如 gpt-4o、gpt-3.5-turbo）。与 maxTokens 互斥——同时设置两者都会导致 API 错误。 |
- |
spring.ai.openai.chat.options.n |
每个输入消息需要生成多少聊天补全选项。请注意，你将根据所有选项中生成的Tokens数量收费。保持 |
1 |
spring.ai.openai.chat.options.store |
是否将该聊天补全请求的输出存储在我们的模型中使用 |
false |
spring.ai.openai.chat.options.metadata |
开发者自定义的标签和值，用于在聊天补全仪表盘中过滤完成内容 |
空映射 |
spring.ai.openai.chat.options.output-modalities |
你希望模型为本次请求生成的输出类型。大多数模型都能生成文本，这是默认的。
这 |
- |
spring.ai.openai.chat.options.output-audio |
音频生成的音频参数。当音频输出被要求时，必须通过 |
- |
spring.ai.openai.chat.options.presence惩罚 |
数字介于-2.0到2.0之间。正值会根据新Tokens是否出现在文本中来惩罚它们，从而提高模型讨论新话题的可能性。 |
- |
spring.ai.openai.chat.options.responseFormat.type |
兼容于 |
- |
spring.ai.openai.chat.options.responseFormat.name |
响应格式模式名称。仅适用于 |
custom_schema |
spring.ai.openai.chat.options.responseFormat.schema |
响应格式 JSON 模式。仅适用于 |
- |
spring.ai.openai.chat.options.responseFormat.strict |
响应格式 JSON schema 遵循严格性。仅适用于 |
- |
spring.ai.openai.chat.options.seed |
此功能目前处于测试阶段。如果有明确规定，我们的系统会尽最大努力以确定性方式采样，使得用相同的种子和参数重复请求应返回相同的结果。 |
- |
spring.ai.openai.chat.options.stop |
最多有4个序列，API会停止生成更多Tokens。 |
- |
spring.ai.openai.chat.options.topP |
一种与温度抽样不同的替代方案，称为核抽样，模型考虑符号的结果，满足 |
- |
spring.ai.openai.chat.options.tools |
模型可能调用的工具列表。目前，仅支持函数作为工具。利用该列表提供模型可能生成 JSON 输入的函数列表。 |
- |
spring.ai.openai.chat.options.toolChoice |
控制模型调用的函数（如果有的话）。 |
- |
spring.ai.openai.chat.options.user |
一个代表终端用户的唯一标识符，可以帮助OpenAI监控和检测滥用行为。 |
- |
spring.ai.openai.chat.options.functions |
函数列表，按名称标识，以便实现函数调用，只需一次提示请求。带有这些名称的函数必须存在于 |
- |
spring.ai.openai.chat.options.stream-usage |
（仅限流媒体播放）设置为为整个请求添加一个额外的块，包含Tokens使用统计数据。这 |
false |
spring.ai.openai.chat.options.parallel-tool-calls |
是否在工具使用时启用并行函数调用。 |
true |
spring.ai.openai.chat.options.http-headers |
在聊天补全请求中添加可选的HTTP头。以覆盖 |
- |
spring.ai.openai.chat.options.proxy-tool-calls |
如果属实，Spring AI不会在内部处理函数调用，而是会代理给客户端。那么，客户端负责处理函数调用，将其派遣到相应的函数，并返回结果。如果 false（默认），Spring AI 会在内部处理函数调用。仅适用于支持函数调用的聊天模型 |
false |
|
当使用如 |
你可以覆盖公共信息Spring.ai.openai.base-url和spring.ai.openai.api-key（春.ai.openai.api-key）对于聊天模型和嵌入模型实现。
这spring.ai.openai.chat.base-url和spring.ai.openai.chat.api-key。如果属性被设置，则优先于共同属性。
如果你想为不同模型和不同模型端点使用不同的OpenAI账户，这非常有用。 |
所有以spring.ai.openai.chat.options。可以通过在运行时为 Run 添加请求特定的运行时选项来覆盖提示叫。 |
Tokens限制参数：特定型号使用情况
OpenAI 提供了两个互斥的参数来控制Tokens生成限制：
| 参数 | 用例 | 兼容型号 |
|---|---|---|
|
非推理模型 |
GPT-4O、GPT-4O-迷你、GPT-4-涡轮、GPT-3.5-涡轮 |
|
推理模型 |
O1、O1-mini、O1-预览、O3、O4-Mini系列 |
| 这两个参数是互斥的。同时设置这两个都会触发OpenAI的API错误。 |
使用示例
对于非推理模型（GPT-40，GPT-3.5-turbo）：
ChatResponse response = chatModel.call(
new Prompt(
"Explain quantum computing in simple terms.",
OpenAiChatOptions.builder()
.model("gpt-4o")
.maxTokens(150) // Use maxTokens for non-reasoning models
.build()
));对于推理模型（o1，o3系列）：
ChatResponse response = chatModel.call(
new Prompt(
"Solve this complex math problem step by step: ...",
OpenAiChatOptions.builder()
.model("o1-preview")
.maxCompletionTokens(1000) // Use maxCompletionTokens for reasoning models
.build()
));架构模式验证：OpenAI 聊天选项构建器自动通过“最后一盘获胜”方式强制互斥性：
// This will automatically clear maxTokens and use maxCompletionTokens
OpenAiChatOptions options = OpenAiChatOptions.builder()
.maxTokens(100) // Set first
.maxCompletionTokens(200) // This clears maxTokens and logs a warning
.build();
// Result: maxTokens = null, maxCompletionTokens = 200运行时选项
OpenAiChatOptions.java类提供模型配置，如所用模型、温度、频率惩罚等。
启动时，默认选项可以配置为OpenAiChatModel（api， options）构造者或spring.ai.openai.chat.options.*性能。
运行时，您可以通过添加新的、针对特定请求的选项来覆盖默认选项提示叫。 例如，要覆盖特定请求的默认型号和温度：
ChatResponse response = chatModel.call(
new Prompt(
"Generate the names of 5 famous pirates.",
OpenAiChatOptions.builder()
.model("gpt-4o")
.temperature(0.4)
.build()
));| 除了模型特定的OpenAiChatOptions，你还可以使用用ChatOptions#builder（）创建的可移动ChatOptions实例。 |
函数调用
你可以用OpenAiChatModel并让OpenAI模型智能地选择输出包含参数的JSON对象，以调用一个或多个注册函数。
这是一种强大的技术，将LLM功能与外部工具和API连接起来。
阅读更多关于工具调用的信息。
模 态
多模态指的是模型能够同时理解和处理来自多种来源的信息，包括文本、图像、音频及其他数据格式。 OpenAI 支持文本、视觉和音频输入模式。
视觉
提供视觉多模态支持的OpenAI模型包括GPT-4,GPT-4O和GPT-40-迷你.
更多信息请参阅《愿景指南》。
OpenAI 用户消息 API 可以与消息一起包含 base64 编码的图片或图片 URL 列表。
Spring AI 的 Message 界面通过引入媒体类型，促进了多模态 AI 模型的发展。
这种类型包含了关于消息中媒体附件的数据和详细信息，利用Spring的org.springframework.util.MimeType以及一个org.springframework.core.io.Resource对于原始媒体数据。
以下是摘自OpenAiChatModelIT.java的代码示例，展示了用户文本与图像的融合过程，使用GPT-4O型。
var imageData = new ClassPathResource("/test.png");
var userMessage = UserMessage.builder()
.text("Explain what do you see on this picture?")
.media(List.of(new Media(MimeTypeUtils.IMAGE_PNG, imageData)))
.build();
var response = this.chatModel
.call(new Prompt(List.of(userMessage), OpenAiChatOptions.builder().model(modelName).build()));| GPT_4_VISION_PREVIEW自2024年6月17日起将继续仅对现有该型号用户开放。如果您不是现有用户，请使用GPT_4_O或GPT_4_TURBO型号。更多细节请见此处 |
或使用图片URL的对应GPT-4O型：
var userMessage = UserMessage.builder()
.text("Explain what do you see on this picture?")
.media(List.of(Media.builder()
.mimeType(MimeTypeUtils.IMAGE_PNG)
.data(URI.create("https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"))
.build()))
.build();
ChatResponse response = this.chatModel
.call(new Prompt(List.of(userMessage), OpenAiChatOptions.builder().model(modelName).build()));| 你也可以同时传递多张图像。 |
示例展示了一个以multimodal.test.png图像：
并附上短信“请解释你在这张图片上看到了什么？”，并生成如下回复：
This is an image of a fruit bowl with a simple design. The bowl is made of metal with curved wire edges that create an open structure, allowing the fruit to be visible from all angles. Inside the bowl, there are two yellow bananas resting on top of what appears to be a red apple. The bananas are slightly overripe, as indicated by the brown spots on their peels. The bowl has a metal ring at the top, likely to serve as a handle for carrying. The bowl is placed on a flat surface with a neutral-colored background that provides a clear view of the fruit inside.
音频
提供输入音频多模态支持的OpenAI模型包括GPT-4O-音频预览.
更多信息请参阅音频指南。
OpenAI 用户消息 API 可以将 base64 编码的音频文件列表与消息一起整合。
Spring AI 的 Message 界面通过引入媒体类型，促进了多模态 AI 模型的发展。
这种类型包含了关于消息中媒体附件的数据和详细信息，利用Spring的org.springframework.util.MimeType以及一个org.springframework.core.io.Resource对于原始媒体数据。
目前，OpenAI 仅支持以下媒体类型：音频/mp3和音频/WAV.
以下是OpenAiChatModelIT.java中摘录的代码示例，展示了用户文本与音频文件的融合过程GPT-4O-音频预览型。
var audioResource = new ClassPathResource("speech1.mp3");
var userMessage = new UserMessage("What is this recording about?",
List.of(new Media(MimeTypeUtils.parseMimeType("audio/mp3"), audioResource)));
ChatResponse response = chatModel.call(new Prompt(List.of(userMessage),
OpenAiChatOptions.builder().model(OpenAiApi.ChatModel.GPT_4_O_AUDIO_PREVIEW).build()));| 你也可以传递多个音频文件。 |
输出音频
提供输入音频多模态支持的OpenAI模型包括GPT-4O-音频预览.
更多信息请参阅音频指南。
OpenAI 助手消息 API 可以包含包含 base64 编码的音频文件列表，并附有该消息。
Spring AI 的 Message 界面通过引入媒体类型，促进了多模态 AI 模型的发展。
这种类型包含了关于消息中媒体附件的数据和详细信息，利用Spring的org.springframework.util.MimeType以及一个org.springframework.core.io.Resource对于原始媒体数据。
目前，OpenAI 仅支持以下音频类型：音频/mp3和音频/WAV.
下面是一个代码示例，展示了用户文本的响应以及一个音频字节数组，使用GPT-4O-音频预览型：
var userMessage = new UserMessage("Tell me joke about Spring Framework");
ChatResponse response = chatModel.call(new Prompt(List.of(userMessage),
OpenAiChatOptions.builder()
.model(OpenAiApi.ChatModel.GPT_4_O_AUDIO_PREVIEW)
.outputModalities(List.of("text", "audio"))
.outputAudio(new AudioParameters(Voice.ALLOY, AudioResponseFormat.WAV))
.build()));
String text = response.getResult().getOutput().getContent(); // audio transcript
byte[] waveAudio = response.getResult().getOutput().getMedia().get(0).getDataAsByteArray(); // audio data你必须指定一个音频模态在OpenAiChatOptions以产生音频输出。
这音频参数class 提供音频输出的语音和音频格式。
结构化输出
OpenAI 提供自定义的结构化输出 API，确保你的模型生成的响应严格符合你提供的条件JSON 模式. 除了现有的Spring AI模型无关的结构化输出转换器外，这些API还提供了更强的控制和精度。
| 目前，OpenAI 支持 JSON Schema 语言格式的子集。 |
配置
Spring AI 允许你通过编程方式配置响应格式OpenAiChatOptions建造者或通过应用属性。
使用聊天选项生成器
你可以用OpenAiChatOptions架构师如下所示：
String jsonSchema = """
{
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"explanation": { "type": "string" },
"output": { "type": "string" }
},
"required": ["explanation", "output"],
"additionalProperties": false
}
},
"final_answer": { "type": "string" }
},
"required": ["steps", "final_answer"],
"additionalProperties": false
}
""";
Prompt prompt = new Prompt("how can I solve 8x + 7 = -23",
OpenAiChatOptions.builder()
.model(ChatModel.GPT_4_O_MINI)
.responseFormat(new ResponseFormat(ResponseFormat.Type.JSON_SCHEMA, this.jsonSchema))
.build());
ChatResponse response = this.openAiChatModel.call(this.prompt);与 BeanOutputConverter 工具集成
你可以利用现有的 BeanOutputConverter 工具，自动从你的域对象生成 JSON 模式，然后将结构化响应转换为域特定的实例：
-
Java
-
Kotlin
record MathReasoning(
@JsonProperty(required = true, value = "steps") Steps steps,
@JsonProperty(required = true, value = "final_answer") String finalAnswer) {
record Steps(
@JsonProperty(required = true, value = "items") Items[] items) {
record Items(
@JsonProperty(required = true, value = "explanation") String explanation,
@JsonProperty(required = true, value = "output") String output) {
}
}
}
var outputConverter = new BeanOutputConverter<>(MathReasoning.class);
var jsonSchema = this.outputConverter.getJsonSchema();
Prompt prompt = new Prompt("how can I solve 8x + 7 = -23",
OpenAiChatOptions.builder()
.model(ChatModel.GPT_4_O_MINI)
.responseFormat(new ResponseFormat(ResponseFormat.Type.JSON_SCHEMA, this.jsonSchema))
.build());
ChatResponse response = this.openAiChatModel.call(this.prompt);
String content = this.response.getResult().getOutput().getContent();
MathReasoning mathReasoning = this.outputConverter.convert(this.content);data class MathReasoning(
val steps: Steps,
@get:JsonProperty(value = "final_answer") val finalAnswer: String) {
data class Steps(val items: Array<Items>) {
data class Items(
val explanation: String,
val output: String)
}
}
val outputConverter = BeanOutputConverter(MathReasoning::class.java)
val jsonSchema = outputConverter.jsonSchema;
val prompt = Prompt("how can I solve 8x + 7 = -23",
OpenAiChatOptions.builder()
.model(ChatModel.GPT_4_O_MINI)
.responseFormat(ResponseFormat(ResponseFormat.Type.JSON_SCHEMA, jsonSchema))
.build())
val response = openAiChatModel.call(prompt)
val content = response.getResult().getOutput().getContent()
val mathReasoning = outputConverter.convert(content)通过应用属性配置
或者，在使用 OpenAI 自动配置时，你可以通过以下应用属性配置所需的响应格式：
spring.ai.openai.api-key=YOUR_API_KEY
spring.ai.openai.chat.options.model=gpt-4o-mini
spring.ai.openai.chat.options.response-format.type=JSON_SCHEMA
spring.ai.openai.chat.options.response-format.name=MySchemaName
spring.ai.openai.chat.options.response-format.schema={"type":"object","properties":{"steps":{"type":"array","items":{"type":"object","properties":{"explanation":{"type":"string"},"output":{"type":"string"}},"required":["explanation","output"],"additionalProperties":false}},"final_answer":{"type":"string"}},"required":["steps","final_answer"],"additionalProperties":false}
spring.ai.openai.chat.options.response-format.strict=true采样控制器
创建一个新的 Spring Boot 项目并添加Spring-AI-starter-model-openai对你的POM（或Gradle）依赖。
添加一个application.properties归档于以下src/主/资源用于启用和配置OpenAi聊天模型的目录：
spring.ai.openai.api-key=YOUR_API_KEY
spring.ai.openai.chat.options.model=gpt-4o
spring.ai.openai.chat.options.temperature=0.7替换API密钥用你的OpenAI资质。 |
这将产生OpenAiChatModel你可以注入到你的类中。这里有一个简单的例子@RestController使用聊天模式生成文本的课程。
@RestController
public class ChatController {
private final OpenAiChatModel chatModel;
@Autowired
public ChatController(OpenAiChatModel chatModel) {
this.chatModel = chatModel;
}
@GetMapping("/ai/generate")
public Map<String,String> generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
return Map.of("generation", this.chatModel.call(message));
}
@GetMapping("/ai/generateStream")
public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
Prompt prompt = new Prompt(new UserMessage(message));
return this.chatModel.stream(prompt);
}
}手动配置
OpenAiChatModel 实现了聊天模型和StreamingChatModel并使用低级 OpenAiApi 客户端连接 OpenAI 服务。
添加春艾开胃对你项目Maven的依赖pom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>或者去你的Gradlebuild.gradle构建文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-openai'
}| 请参考依赖管理部分，将Spring AI的物料清单添加到你的构建文件中。 |
接下来，创建一个OpenAiChatModel并用于文本生成：
var openAiApi = OpenAiApi.builder()
.apiKey(System.getenv("OPENAI_API_KEY"))
.build();
var openAiChatOptions = OpenAiChatOptions.builder()
.model("gpt-3.5-turbo")
.temperature(0.4)
.maxTokens(200)
.build();
var chatModel = new OpenAiChatModel(this.openAiApi, this.openAiChatOptions);
ChatResponse response = this.chatModel.call(
new Prompt("Generate the names of 5 famous pirates."));
// Or with streaming responses
Flux<ChatResponse> response = this.chatModel.stream(
new Prompt("Generate the names of 5 famous pirates."));这OpenAiChatOptions提供聊天请求的配置信息。
这OpenAiApi.构建器和OpenAiChatOptions.Builder分别是 API 客户端和聊天配置的流利选项构建器。
低级OpenAiApi客户端
以下类图展示了OpenAiAPI聊天界面与构建模块：
这里有一个简单的片段，展示了如何以程序方式使用该 API：
OpenAiApi openAiApi = OpenAiApi.builder()
.apiKey(System.getenv("OPENAI_API_KEY"))
.build();
ChatCompletionMessage chatCompletionMessage =
new ChatCompletionMessage("Hello world", Role.USER);
// Sync request
ResponseEntity<ChatCompletion> response = this.openAiApi.chatCompletionEntity(
new ChatCompletionRequest(List.of(this.chatCompletionMessage), "gpt-3.5-turbo", 0.8, false));
// Streaming request
Flux<ChatCompletionChunk> streamResponse = this.openAiApi.chatCompletionStream(
new ChatCompletionRequest(List.of(this.chatCompletionMessage), "gpt-3.5-turbo", 0.8, true));更多信息请关注OpenAiApi.java的JavaDoc。
底层API示例
-
OpenAiApiIT.java测试提供了一些使用轻量级库的通用示例。
-
OpenAiApiToolFunctionCallIT.java测试展示了如何使用底层API调用工具函数。 基于OpenAI函数调用教程。
API密钥管理
Spring AI 通过ApiKey接口及其实现。默认实现，SimpleApiKey适用于大多数用例，但你也可以为更复杂的场景创建自定义实现。
默认配置
默认情况下，Spring Boot 自动配置会使用spring.ai.openai.api-key（春.ai.openai.api-key）财产：
spring.ai.openai.api-key=your-api-key-here自定义API密钥配置
你可以创建一个自定义实例OpenAiAPI用你自己的ApiKey使用构建模式实现：
ApiKey customApiKey = new ApiKey() {
@Override
public String getValue() {
// Custom logic to retrieve API key
return "your-api-key-here";
}
};
OpenAiApi openAiApi = OpenAiApi.builder()
.apiKey(customApiKey)
.build();
// Create a chat model with the custom OpenAiApi instance
OpenAiChatModel chatModel = OpenAiChatModel.builder()
.openAiApi(openAiApi)
.build();
// Build the ChatClient using the custom chat model
ChatClient openAiChatClient = ChatClient.builder(chatModel).build();这在你需要时非常有用：
-
从安全密钥存储中获取API密钥
-
动态旋转API密钥
-
实现自定义API密钥选择逻辑