Skip to content

Commit d42e46c

Browse files
chore: [Orchestration] Clarify response format (#637)
1 parent ecb47e9 commit d42e46c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

orchestration/src/main/java/com/sap/ai/sdk/orchestration/ResponseJsonSchema.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ public class ResponseJsonSchema {
3333
@Nonnull Map<String, Object> schemaMap;
3434
@Nonnull String name;
3535
@Nullable String description;
36+
37+
/**
38+
* ⚠️ Fields of the schema class should be annotated with {@code @JsonProperty(required = true)}
39+
* to not fail requests if set to true.
40+
*/
3641
@Nullable Boolean strict;
3742

3843
/**
@@ -51,6 +56,9 @@ public static ResponseJsonSchema fromMap(
5156
/**
5257
* Create a new instance of {@link ResponseJsonSchema} from a given class.
5358
*
59+
* <p>⚠️ Fields of the schema class should be annotated with {@code @JsonProperty(required =
60+
* true)}.
61+
*
5462
* @param classType The class to generate the schema from
5563
* @return The new instance of {@link ResponseJsonSchema}
5664
*/

0 commit comments

Comments
 (0)