Kotlin-AI-Examples项目教程：使用Spring AI实现结构化输出

什么是结构化输出？

结构化输出是大型语言模型(LLM)的一项重要能力，它允许模型按照预定义的格式（如JSON、XML等）生成响应，而不仅仅是自由格式的文本。这种能力使得AI生成的响应更易于在应用程序中解析和使用。

在Kotlin-AI-Examples项目中，我们通过Spring AI框架展示了如何利用这一功能，特别是在Kotlin环境下如何优雅地实现结构化输出。

结构化输出的优势

1. 一致性：确保每次响应都遵循相同的格式
2. 可预测性：明确知道返回数据的结构和类型
3. 易用性：可以直接映射到Kotlin数据类，减少解析工作
4. 可靠性：比单纯依赖提示词更稳定

两种实现方式对比

1. 通过提示词描述格式

val response = chatClient
    .prompt()
    .system("The response must be a valid JSON object.")
    .user("""
        What is the firstName and lastName of the person in this sentence?
        "Aurora Skyfield announced her candidacy for the local city council yesterday."
        """)
    .call()
    .content()

这种方法虽然简单，但存在明显缺点：

• 无法保证模型一定会返回完美格式化的JSON
• 需要额外的解析步骤
• 缺乏类型安全

2. 使用结构化输出能力

Spring AI提供了更强大的结构化输出支持，可以直接将响应映射到Kotlin数据类：

data class MobileDevice(
    val name: String,
    val price: Double,
    val category: String,
    val features: List<String> = emptyList()
)

val device = chatClient
    .prompt("Tell me about the latest smartphone")
    .call()
    .entity<MobileDevice>()

这种方式优势明显：

• 类型安全
• 自动映射到Kotlin类
• 更可靠的格式保证
• 减少样板代码

实际应用示例

让我们看一个完整的示例，展示如何在Kotlin项目中实现结构化输出：

1. 首先定义数据模型：

@Serializable
data class Person(val firstName: String, val lastName: String)

data class MobileDevice(
    val name: String,
    val price: Double,
    val category: String,
    val features: List<String> = emptyList()
)

2. 配置AI客户端：

val openAiApi = OpenAiApi.builder().apiKey(apiKey).build()
val openAiOptions = OpenAiChatOptions.builder()
    .model(OpenAiApi.ChatModel.GPT_4_O_MINI)
    .temperature(0.7)
    .build()

val chatClient = ChatClient.create(
    OpenAiChatModel.builder()
        .openAiApi(openAiApi)
        .defaultOptions(openAiOptions)
        .build()
)

3. 使用结构化输出：

// 简单JSON输出
val jsonResponse = chatClient.prompt()
    .system("The response must be a valid JSON object.")
    .user("Extract person details from: \"Aurora Skyfield announced...\"")
    .call()
    .content()

// 直接映射到Kotlin类
val device = chatClient
    .prompt("Tell me about the latest smartphone")
    .call()
    .entity<MobileDevice>()

最佳实践

1. 明确的数据模型：始终先定义好期望的数据结构
2. 适当的错误处理：处理可能的结构化输出失败情况
3. 验证数据：即使使用结构化输出，也应验证关键字段
4. 合理使用默认值：为可选字段提供合理的默认值
5. 文档化：为数据类添加清晰的文档说明

常见问题解答

Q: 结构化输出会影响模型创造力吗？ A: 不会，结构化输出只约束响应格式，不影响内容质量。

Q: 所有AI模型都支持结构化输出吗？ A: 不是所有模型都原生支持，但通过Spring AI这样的框架可以统一接口。

Q: 如何处理复杂的嵌套结构？ A: Kotlin数据类支持嵌套定义，可以很好地表示复杂结构。

Q: 性能影响如何？ A: 结构化输出会增加少量处理开销，但通常可以忽略不计。

总结

Kotlin-AI-Examples项目展示了如何在Kotlin生态中高效利用Spring AI的结构化输出能力。通过直接映射到Kotlin数据类，开发者可以获得类型安全、易于维护的AI集成方案。这种方法特别适合需要将AI响应集成到现有系统或需要严格数据格式的场景。

结构化输出不仅提高了开发效率，还增强了系统的可靠性和可维护性，是现代AI应用开发中值得掌握的重要技术。