Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Kotlin updates (#2006)

Browse Source 
* Update Kotlin documentation

This commit updates the Kotlin documentation to
showcase the new Kotlin reflection capabilities
allowing to identify required properties.

* Update Kotlin integration tests

This commit updates the Kotlin integration tests to
leverage the new Kotlin reflection capabilities
allowing to identify required properties.

It also adds a missing jackson-module-kotlin
dependency and refine test implementation to be
closer to the Java ones and use more idiomatic
Kotlin code.
This commit is contained in:
Sébastien Deleuze
2024-12-24 17:11:18 +01:00
committed by GitHub
parent d7fe07b0f1
commit 34ac31910d
5 changed files with 26 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/openai-chat.adoc
View File

@@ -376,14 +376,14 @@ Kotlin::
[source,kotlin]
----
data class MathReasoning(
@get:JsonProperty(required = true, value = "steps") val steps: Steps,
@get:JsonProperty(required = true, value = "final_answer") val finalAnswer: String) {
val steps: Steps,
@get:JsonProperty(value = "final_answer") val finalAnswer: String) {
data class Steps(@get:JsonProperty(required = true, value = "items") val items: Array<Items>) {
data class Steps(val items: Array<Items>) {
data class Items(
@get:JsonProperty(required = true, value = "explanation") val explanation: String,
@get:JsonProperty(required = true, value = "output") val output: String)
val explanation: String,
val output: String)
}
}
@@ -405,9 +405,7 @@ val mathReasoning = outputConverter.convert(content)
======
--
NOTE: Ensure you use the `@JsonProperty(required = true,...)` annotation (`@get:JsonProperty(required = true,...)` with Kotlin in order to generate the annotation on the related getters, see link:https://kotlinlang.org/docs/annotations.html#annotation-use-site-targets[related documentation]).
This is crucial for generating a schema that accurately marks fields as `required`.
Although this is optional for JSON Schema, OpenAI link:https://platform.openai.com/docs/guides/structured-outputs/all-fields-must-be-required[mandates] it for the structured response to function correctly.
NOTE: Although this is optional for JSON Schema, OpenAI link:https://platform.openai.com/docs/guides/structured-outputs/all-fields-must-be-required#all-fields-must-be-required[mandates] required fields for the structured response to function correctly. Kotlin reflection is used to infer which property are required or not based on the nullability of types and default values of parameters, so for most use case `@get:JsonProperty(required = true)` is not needed. `@get:JsonProperty(value = "custom_name")` can be useful to customize the property name. Make sure to generate the annotation on the related getters with this `@get:` syntax, see link:https://kotlinlang.org/docs/annotations.html#annotation-use-site-targets[related documentation].
==== Configuring via Application Properties