Skip to content

Commit 24a45f0

Browse files
Tarjei400Tarjei400
committed
Add handling for Optional types
1 parent bd88ad9 commit 24a45f0

File tree

7 files changed

+184
-59
lines changed

7 files changed

+184
-59
lines changed

‎core/deployment/src/main/java/io/quarkiverse/langchain4j/deployment/ToolProcessor.java‎

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,16 @@ public class ToolProcessor {
8383
Object.class);
8484
private static final Logger log = Logger.getLogger(ToolProcessor.class);
8585

86+
public static final DotName OPTIONAL = DotName.createSimple("java.util.Optional");
87+
public static final DotName OPTIONAL_INT = DotName.createSimple("java.util.OptionalInt");
88+
public static final DotName OPTIONAL_LONG = DotName.createSimple("java.util.OptionalLong");
89+
public static final DotName OPTIONAL_DOUBLE = DotName.createSimple("java.util.OptionalDouble");
90+
91+
private static final DotName DATE = DotName.createSimple("java.util.Date");
92+
private static final DotName LOCAL_DATE = DotName.createSimple("java.time.LocalDate");
93+
private static final DotName LOCAL_DATE_TIME = DotName.createSimple("java.time.LocalDateTime");
94+
private static final DotName OFFSET_DATE_TIME = DotName.createSimple("java.time.OffsetDateTime");
95+
8696
@BuildStep
8797
public void telemetry(Capabilities capabilities, BuildProducer<AdditionalBeanBuildItem> additionalBeanProducer) {
8898
var addOpenTelemetrySpan = capabilities.isPresent(Capability.OPENTELEMETRY_TRACER);
@@ -453,7 +463,15 @@ private Iterable<JsonSchemaProperty> toJsonSchemaProperties(Type type, IndexView
453463
|| DotNames.BIG_DECIMAL.equals(typeName)) {
454464
return removeNulls(NUMBER, description);
455465
}
466+
if (LOCAL_DATE_TIME.equals(typeName) || OFFSET_DATE_TIME.equals(typeName)) {
467+
return removeNulls(JsonSchemaProperty.from("type", "string"), JsonSchemaProperty.from("format", "date-time"),
468+
description);
469+
}
456470

471+
if (DATE.equals(typeName) || LOCAL_DATE.equals(typeName)) {
472+
return removeNulls(JsonSchemaProperty.from("type", "string"), JsonSchemaProperty.from("format", "date"),
473+
description);
474+
}
457475
// TODO something else?
458476
if (type.kind() == Type.Kind.ARRAY || DotNames.LIST.equals(typeName) || DotNames.SET.equals(typeName)) {
459477
ParameterizedType parameterizedType = type.kind() == Type.Kind.PARAMETERIZED_TYPE ? type.asParameterizedType()
@@ -488,11 +506,18 @@ private Iterable<JsonSchemaProperty> toJsonSchemaProperties(Type type, IndexView
488506
ClassInfo classInfo = index.getClassByName(type.name());
489507

490508
List<String> required = new ArrayList<>();
509+
491510
if (classInfo != null) {
492511
for (FieldInfo field : classInfo.fields()) {
493512
String fieldName = field.name();
513+
Type fieldType = field.type();
494514

495-
Iterable<JsonSchemaProperty> fieldSchema = toJsonSchemaProperties(field.type(), index, null);
515+
boolean isOptional = isJavaOptionalType(fieldType);
516+
if (isOptional) {
517+
fieldType = unwrapOptionalType(fieldType);
518+
}
519+
520+
Iterable<JsonSchemaProperty> fieldSchema = toJsonSchemaProperties(fieldType, index, null);
496521
Map<String, Object> fieldDescription = new HashMap<>();
497522

498523
for (JsonSchemaProperty fieldProperty : fieldSchema) {
@@ -506,6 +531,10 @@ private Iterable<JsonSchemaProperty> toJsonSchemaProperties(Type type, IndexView
506531
fieldDescription.put("description", String.join(",", descriptionValue));
507532
}
508533
}
534+
if (!isOptional) {
535+
required.add(fieldName);
536+
}
537+
509538
properties.put(fieldName, fieldDescription);
510539
}
511540
}
@@ -517,10 +546,39 @@ private Iterable<JsonSchemaProperty> toJsonSchemaProperties(Type type, IndexView
517546
throw new IllegalArgumentException("Unsupported type: " + type);
518547
}
519548

549+
private boolean isJavaOptionalType(Type type) {
550+
DotName typeName = type.name();
551+
return typeName.equals(DotName.createSimple("java.util.Optional"))
552+
|| typeName.equals(DotName.createSimple("java.util.OptionalInt"))
553+
|| typeName.equals(DotName.createSimple("java.util.OptionalLong"))
554+
|| typeName.equals(DotName.createSimple("java.util.OptionalDouble"));
555+
}
556+
557+
private Type unwrapOptionalType(Type optionalType) {
558+
if (optionalType.kind() == Type.Kind.PARAMETERIZED_TYPE) {
559+
ParameterizedType parameterizedType = optionalType.asParameterizedType();
560+
return parameterizedType.arguments().get(0);
561+
}
562+
return optionalType;
563+
}
564+
520565
private boolean isComplexType(Type type) {
521566
return type.kind() == Type.Kind.CLASS || type.kind() == Type.Kind.PARAMETERIZED_TYPE;
522567
}
523568

569+
private boolean isOptionalField(FieldInfo field, IndexView index) {
570+
Type fieldType = field.type();
571+
DotName fieldTypeName = fieldType.name();
572+
573+
if (OPTIONAL.equals(fieldTypeName) || OPTIONAL_INT.equals(fieldTypeName) || OPTIONAL_LONG.equals(fieldTypeName)
574+
|| OPTIONAL_DOUBLE.equals(fieldTypeName)) {
575+
return true;
576+
}
577+
578+
return false;
579+
580+
}
581+
524582
private Iterable<JsonSchemaProperty> removeNulls(JsonSchemaProperty... properties) {
525583
return stream(properties)
526584
.filter(Objects::nonNull)

‎core/runtime/src/main/java/io/quarkiverse/langchain4j/QuarkusJsonCodecFactory.java‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,13 @@ public <T> T fromJson(String json, Type type) {
7272
if (e instanceof JsonParseException && isEnumType(type)) {
7373
// this is the case where LangChain4j simply passes the string value of the enum to Json.fromJson()
7474
// and Jackson does not handle it
75-
Class<? extends Enum> enumClass = (Class<? extends Enum>) ((ParameterizedType) type).getRawType();
76-
return (T) Enum.valueOf(enumClass, json);
75+
if (type instanceof ParameterizedType) {
76+
Class<? extends Enum> enumClass = (Class<? extends Enum>) ((ParameterizedType) type).getRawType();
77+
return (T) Enum.valueOf(enumClass, json);
78+
} else {
79+
80+
return (T) Enum.valueOf((Class<? extends Enum>) type, json);
81+
}
7782
}
7883
throw new UncheckedIOException(e);
7984
}

‎core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/QuarkusServiceOutputParser.java‎

Lines changed: 71 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
package io.quarkiverse.langchain4j.runtime;
22

33
import java.lang.reflect.*;
4+
import java.time.LocalDate;
5+
import java.time.LocalDateTime;
6+
import java.time.OffsetDateTime;
47
import java.util.*;
58
import java.util.regex.Matcher;
69
import java.util.regex.Pattern;
710

811
import com.fasterxml.jackson.databind.ObjectMapper;
912

1013
import dev.langchain4j.data.message.AiMessage;
14+
import dev.langchain4j.data.message.ChatMessage;
1115
import dev.langchain4j.model.output.Response;
1216
import dev.langchain4j.model.output.structured.Description;
1317
import dev.langchain4j.service.Result;
1418
import dev.langchain4j.service.TokenStream;
1519
import dev.langchain4j.service.TypeUtils;
16-
//import dev.langchain4j.service.output.OutputParser;
1720
import dev.langchain4j.service.output.ServiceOutputParser;
1821
import io.quarkiverse.langchain4j.QuarkusJsonCodecFactory;
1922
import io.smallrye.mutiny.Multi;
@@ -23,13 +26,18 @@ public class QuarkusServiceOutputParser extends ServiceOutputParser {
2326

2427
@Override
2528
public String outputFormatInstructions(Type returnType) {
26-
Class<?> rawClass = getRawClass(returnType);
29+
boolean isOptional = isJavaOptional(returnType);
30+
Type actualType = isOptional ? unwrapOptionalType(returnType) : returnType;
31+
32+
Class<?> rawClass = getRawClass(actualType);
2733

2834
if (rawClass != String.class && rawClass != AiMessage.class && rawClass != TokenStream.class
35+
&& rawClass != ChatMessage.class
2936
&& rawClass != Response.class && !Multi.class.equals(rawClass)) {
3037
try {
3138
var schema = this.toJsonSchema(returnType);
32-
return "You must answer strictly with json according to the following json schema format: " + schema;
39+
return "You must answer strictly with json according to the following json schema format. Use description metadata to fill data properly: "
40+
+ schema;
3341
} catch (Exception e) {
3442
return "";
3543
}
@@ -52,7 +60,7 @@ public Object parse(Response<AiMessage> response, Type returnType) {
5260
return response;
5361
} else {
5462
AiMessage aiMessage = response.content();
55-
if (rawReturnClass == AiMessage.class) {
63+
if (rawReturnClass == AiMessage.class || rawReturnClass == ChatMessage.class) {
5664
return aiMessage;
5765
} else {
5866
String text = aiMessage.text();
@@ -77,7 +85,10 @@ private String extractJsonBlock(String text) {
7785

7886
public String toJsonSchema(Type type) throws Exception {
7987
Map<String, Object> schema = new HashMap<>();
80-
Class<?> rawClass = getRawClass(type);
88+
boolean isOptional = isJavaOptional(type);
89+
Type actualType = isOptional ? unwrapOptionalType(type) : type;
90+
91+
Class<?> rawClass = getRawClass(actualType);
8192

8293
if (type instanceof WildcardType wildcardType) {
8394
Type boundType = wildcardType.getUpperBounds().length > 0 ? wildcardType.getUpperBounds()[0]
@@ -97,29 +108,77 @@ public String toJsonSchema(Type type) throws Exception {
97108
Type elementType = getElementType(type);
98109
Map<String, Object> itemsSchema = toJsonSchemaMap(elementType);
99110
schema.put("items", itemsSchema);
111+
} else if (rawClass == LocalDate.class || rawClass == Date.class) {
112+
schema.put("type", "string");
113+
schema.put("format", "date");
114+
} else if (rawClass == LocalDateTime.class || rawClass == OffsetDateTime.class) {
115+
schema.put("type", "string");
116+
schema.put("format", "date-time");
100117
} else if (rawClass.isEnum()) {
101118
schema.put("type", "string");
102119
schema.put("enum", getEnumConstants(rawClass));
103120
} else {
104121
schema.put("type", "object");
105122
Map<String, Object> properties = new HashMap<>();
106123

124+
List<String> required = new ArrayList<>();
107125
for (Field field : rawClass.getDeclaredFields()) {
108-
field.setAccessible(true);
109-
Map<String, Object> fieldSchema = toJsonSchemaMap(field.getGenericType());
110-
properties.put(field.getName(), fieldSchema);
111-
if (field.isAnnotationPresent(Description.class)) {
112-
Description description = field.getAnnotation(Description.class);
113-
fieldSchema.put("description", description.value());
126+
try {
127+
field.setAccessible(true);
128+
Type fieldType = field.getGenericType();
129+
130+
// Check if the field is Optional and unwrap it if necessary
131+
boolean fieldIsOptional = isJavaOptional(fieldType);
132+
Type fieldActualType = fieldIsOptional ? unwrapOptionalType(fieldType) : fieldType;
133+
134+
Map<String, Object> fieldSchema = toJsonSchemaMap(fieldActualType);
135+
properties.put(field.getName(), fieldSchema);
136+
137+
if (field.isAnnotationPresent(Description.class)) {
138+
Description description = field.getAnnotation(Description.class);
139+
fieldSchema.put("description", String.join(",", description.value()));
140+
}
141+
142+
// Only add to required if it is not Optional
143+
if (!fieldIsOptional) {
144+
required.add(field.getName());
145+
} else {
146+
fieldSchema.put("nullable", true); // Mark as nullable in the JSON schema
147+
}
148+
149+
} catch (Exception e) {
150+
114151
}
152+
115153
}
116154
schema.put("properties", properties);
155+
if (!required.isEmpty()) {
156+
schema.put("required", required);
157+
}
158+
}
159+
if (isOptional) {
160+
schema.put("nullable", true);
117161
}
118-
119162
ObjectMapper mapper = new ObjectMapper();
120163
return mapper.writeValueAsString(schema); // Convert the schema map to a JSON string
121164
}
122165

166+
private boolean isJavaOptional(Type type) {
167+
if (type instanceof ParameterizedType) {
168+
Type rawType = ((ParameterizedType) type).getRawType();
169+
return rawType == Optional.class || rawType == OptionalInt.class || rawType == OptionalLong.class
170+
|| rawType == OptionalDouble.class;
171+
}
172+
return false;
173+
}
174+
175+
private Type unwrapOptionalType(Type optionalType) {
176+
if (optionalType instanceof ParameterizedType) {
177+
return ((ParameterizedType) optionalType).getActualTypeArguments()[0];
178+
}
179+
return optionalType;
180+
}
181+
123182
private Class<?> getRawClass(Type type) {
124183
if (type instanceof Class<?>) {
125184
return (Class<?>) type;

‎integration-tests/openai/src/main/java/org/acme/example/openai/aiservices/AssistantWithToolsResource.java‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import java.util.List;
44
import java.util.Map;
5+
import java.util.Optional;
56
import java.util.concurrent.ConcurrentHashMap;
67

78
import jakarta.annotation.PreDestroy;
@@ -12,6 +13,8 @@
1213

1314
import org.jboss.resteasy.reactive.RestQuery;
1415

16+
import com.fasterxml.jackson.annotation.JsonProperty;
17+
1518
import dev.langchain4j.agent.tool.Tool;
1619
import dev.langchain4j.memory.ChatMemory;
1720
import dev.langchain4j.memory.chat.ChatMemoryProvider;
@@ -30,18 +33,24 @@ public AssistantWithToolsResource(Assistant assistant) {
3033

3134
public static class TestData {
3235
@Description("Foo description for structured output")
36+
@JsonProperty("foo")
3337
String foo;
3438

3539
@Description("Foo description for structured output")
40+
@JsonProperty("bar")
3641
Integer bar;
3742

3843
@Description("Foo description for structured output")
39-
Double baz;
44+
@JsonProperty("baz")
45+
Optional<Double> baz;
46+
47+
public TestData() {
48+
}
4049

4150
TestData(String foo, Integer bar, Double baz) {
4251
this.foo = foo;
4352
this.bar = bar;
44-
this.baz = baz;
53+
this.baz = Optional.of(baz);
4554
}
4655
}
4756

@@ -50,18 +59,11 @@ public String get(@RestQuery String message) {
5059
return assistant.chat(message);
5160
}
5261

53-
@GET
54-
@Path("/many")
55-
public List<TestData> getMany(@RestQuery String message) {
56-
return assistant.chats(message);
57-
}
58-
5962
@RegisterAiService(tools = Calculator.class, chatMemoryProviderSupplier = RegisterAiService.BeanChatMemoryProviderSupplier.class)
6063
public interface Assistant {
6164

6265
String chat(String userMessage);
6366

64-
List<TestData> chats(String userMessage);
6567
}
6668

6769
@Singleton

0 commit comments

Comments
 (0)