Skip to content

Commit 0e7d0e6

Browse files
Tarjei400Tarjei400
committed
Add handling for Optional types
1 parent bd88ad9 commit 0e7d0e6

File tree

4 files changed

+111
-16
lines changed

4 files changed

+111
-16
lines changed

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

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,11 @@ 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+
8691
@BuildStep
8792
public void telemetry(Capabilities capabilities, BuildProducer<AdditionalBeanBuildItem> additionalBeanProducer) {
8893
var addOpenTelemetrySpan = capabilities.isPresent(Capability.OPENTELEMETRY_TRACER);
@@ -488,11 +493,18 @@ private Iterable<JsonSchemaProperty> toJsonSchemaProperties(Type type, IndexView
488493
ClassInfo classInfo = index.getClassByName(type.name());
489494

490495
List<String> required = new ArrayList<>();
496+
491497
if (classInfo != null) {
492498
for (FieldInfo field : classInfo.fields()) {
493499
String fieldName = field.name();
500+
Type fieldType = field.type();
494501

495-
Iterable<JsonSchemaProperty> fieldSchema = toJsonSchemaProperties(field.type(), index, null);
502+
boolean isOptional = isJavaOptionalType(fieldType);
503+
if (isOptional) {
504+
fieldType = unwrapOptionalType(fieldType);
505+
}
506+
507+
Iterable<JsonSchemaProperty> fieldSchema = toJsonSchemaProperties(fieldType, index, null);
496508
Map<String, Object> fieldDescription = new HashMap<>();
497509

498510
for (JsonSchemaProperty fieldProperty : fieldSchema) {
@@ -506,6 +518,10 @@ private Iterable<JsonSchemaProperty> toJsonSchemaProperties(Type type, IndexView
506518
fieldDescription.put("description", String.join(",", descriptionValue));
507519
}
508520
}
521+
if (!isOptional) {
522+
required.add(fieldName);
523+
}
524+
509525
properties.put(fieldName, fieldDescription);
510526
}
511527
}
@@ -517,10 +533,39 @@ private Iterable<JsonSchemaProperty> toJsonSchemaProperties(Type type, IndexView
517533
throw new IllegalArgumentException("Unsupported type: " + type);
518534
}
519535

536+
private boolean isJavaOptionalType(Type type) {
537+
DotName typeName = type.name();
538+
return typeName.equals(DotName.createSimple("java.util.Optional"))
539+
|| typeName.equals(DotName.createSimple("java.util.OptionalInt"))
540+
|| typeName.equals(DotName.createSimple("java.util.OptionalLong"))
541+
|| typeName.equals(DotName.createSimple("java.util.OptionalDouble"));
542+
}
543+
544+
private Type unwrapOptionalType(Type optionalType) {
545+
if (optionalType.kind() == Type.Kind.PARAMETERIZED_TYPE) {
546+
ParameterizedType parameterizedType = optionalType.asParameterizedType();
547+
return parameterizedType.arguments().get(0);
548+
}
549+
return optionalType;
550+
}
551+
520552
private boolean isComplexType(Type type) {
521553
return type.kind() == Type.Kind.CLASS || type.kind() == Type.Kind.PARAMETERIZED_TYPE;
522554
}
523555

556+
private boolean isOptionalField(FieldInfo field, IndexView index) {
557+
Type fieldType = field.type();
558+
DotName fieldTypeName = fieldType.name();
559+
560+
if (OPTIONAL.equals(fieldTypeName) || OPTIONAL_INT.equals(fieldTypeName) || OPTIONAL_LONG.equals(fieldTypeName)
561+
|| OPTIONAL_DOUBLE.equals(fieldTypeName)) {
562+
return true;
563+
}
564+
565+
return false;
566+
567+
}
568+
524569
private Iterable<JsonSchemaProperty> removeNulls(JsonSchemaProperty... properties) {
525570
return stream(properties)
526571
.filter(Objects::nonNull)

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

Lines changed: 59 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
import dev.langchain4j.service.Result;
1414
import dev.langchain4j.service.TokenStream;
1515
import dev.langchain4j.service.TypeUtils;
16-
//import dev.langchain4j.service.output.OutputParser;
1716
import dev.langchain4j.service.output.ServiceOutputParser;
1817
import io.quarkiverse.langchain4j.QuarkusJsonCodecFactory;
1918
import io.smallrye.mutiny.Multi;
@@ -23,13 +22,17 @@ public class QuarkusServiceOutputParser extends ServiceOutputParser {
2322

2423
@Override
2524
public String outputFormatInstructions(Type returnType) {
26-
Class<?> rawClass = getRawClass(returnType);
25+
boolean isOptional = isJavaOptional(returnType);
26+
Type actualType = isOptional ? unwrapOptionalType(returnType) : returnType;
27+
28+
Class<?> rawClass = getRawClass(actualType);
2729

2830
if (rawClass != String.class && rawClass != AiMessage.class && rawClass != TokenStream.class
2931
&& rawClass != Response.class && !Multi.class.equals(rawClass)) {
3032
try {
3133
var schema = this.toJsonSchema(returnType);
32-
return "You must answer strictly with json according to the following json schema format: " + schema;
34+
return "You must answer strictly with json according to the following json schema format. Use description metadata to fill data properly: "
35+
+ schema;
3336
} catch (Exception e) {
3437
return "";
3538
}
@@ -77,7 +80,10 @@ private String extractJsonBlock(String text) {
7780

7881
public String toJsonSchema(Type type) throws Exception {
7982
Map<String, Object> schema = new HashMap<>();
80-
Class<?> rawClass = getRawClass(type);
83+
boolean isOptional = isJavaOptional(type);
84+
Type actualType = isOptional ? unwrapOptionalType(type) : type;
85+
86+
Class<?> rawClass = getRawClass(actualType);
8187

8288
if (type instanceof WildcardType wildcardType) {
8389
Type boundType = wildcardType.getUpperBounds().length > 0 ? wildcardType.getUpperBounds()[0]
@@ -104,22 +110,64 @@ public String toJsonSchema(Type type) throws Exception {
104110
schema.put("type", "object");
105111
Map<String, Object> properties = new HashMap<>();
106112

113+
List<String> required = new ArrayList<>();
107114
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());
115+
try {
116+
field.setAccessible(true);
117+
Type fieldType = field.getGenericType();
118+
119+
// Check if the field is Optional and unwrap it if necessary
120+
boolean fieldIsOptional = isJavaOptional(fieldType);
121+
Type fieldActualType = fieldIsOptional ? unwrapOptionalType(fieldType) : fieldType;
122+
123+
Map<String, Object> fieldSchema = toJsonSchemaMap(fieldActualType);
124+
properties.put(field.getName(), fieldSchema);
125+
126+
if (field.isAnnotationPresent(Description.class)) {
127+
Description description = field.getAnnotation(Description.class);
128+
fieldSchema.put("description", String.join(",", description.value()));
129+
}
130+
131+
// Only add to required if it is not Optional
132+
if (!fieldIsOptional) {
133+
required.add(field.getName());
134+
} else {
135+
fieldSchema.put("nullable", true); // Mark as nullable in the JSON schema
136+
}
137+
138+
} catch (Exception e) {
139+
114140
}
141+
115142
}
116143
schema.put("properties", properties);
144+
if (!required.isEmpty()) {
145+
schema.put("required", required);
146+
}
147+
}
148+
if (isOptional) {
149+
schema.put("nullable", true);
117150
}
118-
119151
ObjectMapper mapper = new ObjectMapper();
120152
return mapper.writeValueAsString(schema); // Convert the schema map to a JSON string
121153
}
122154

155+
private boolean isJavaOptional(Type type) {
156+
if (type instanceof ParameterizedType) {
157+
Type rawType = ((ParameterizedType) type).getRawType();
158+
return rawType == Optional.class || rawType == OptionalInt.class || rawType == OptionalLong.class
159+
|| rawType == OptionalDouble.class;
160+
}
161+
return false;
162+
}
163+
164+
private Type unwrapOptionalType(Type optionalType) {
165+
if (optionalType instanceof ParameterizedType) {
166+
return ((ParameterizedType) optionalType).getActualTypeArguments()[0];
167+
}
168+
return optionalType;
169+
}
170+
123171
private Class<?> getRawClass(Type type) {
124172
if (type instanceof Class<?>) {
125173
return (Class<?>) type;

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

Lines changed: 3 additions & 2 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;
@@ -36,12 +37,12 @@ public static class TestData {
3637
Integer bar;
3738

3839
@Description("Foo description for structured output")
39-
Double baz;
40+
Optional<Double> baz;
4041

4142
TestData(String foo, Integer bar, Double baz) {
4243
this.foo = foo;
4344
this.bar = bar;
44-
this.baz = baz;
45+
this.baz = Optional.of(baz);
4546
}
4647
}
4748

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

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

33
import java.util.ArrayList;
44
import java.util.List;
5+
import java.util.Optional;
56

67
import jakarta.ws.rs.POST;
78
import jakarta.ws.rs.Path;
@@ -29,12 +30,12 @@ public static class TestData {
2930
Integer bar;
3031

3132
@Description("Foo description for structured output")
32-
Double baz;
33+
Optional<Double> baz;
3334

3435
TestData(String foo, Integer bar, Double baz) {
3536
this.foo = foo;
3637
this.bar = bar;
37-
this.baz = baz;
38+
this.baz = Optional.of(baz);
3839
}
3940
}
4041

0 commit comments

Comments
 (0)