-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added support mapping to to complex types in ai service methods. Adde…
…d data from @description annotations to json schema, for llm to better understand how to output data.
- Loading branch information
Showing
7 changed files
with
314 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 148 additions & 6 deletions
154
.../runtime/src/main/java/io/quarkiverse/langchain4j/runtime/QuarkusServiceOutputParser.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,163 @@ | ||
| package io.quarkiverse.langchain4j.runtime; | ||
|
|
||
| import static dev.langchain4j.service.TypeUtils.getRawClass; | ||
| import java.lang.reflect.*; | ||
| import java.util.*; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import java.lang.reflect.Type; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
|
|
||
| import dev.langchain4j.data.message.AiMessage; | ||
| import dev.langchain4j.model.output.Response; | ||
| import dev.langchain4j.model.output.structured.Description; | ||
| import dev.langchain4j.service.Result; | ||
| import dev.langchain4j.service.TokenStream; | ||
| import dev.langchain4j.service.TypeUtils; | ||
| //import dev.langchain4j.service.output.OutputParser; | ||
| import dev.langchain4j.service.output.ServiceOutputParser; | ||
| import io.quarkiverse.langchain4j.QuarkusJsonCodecFactory; | ||
| import io.smallrye.mutiny.Multi; | ||
|
|
||
| public class QuarkusServiceOutputParser extends ServiceOutputParser { | ||
| private static final Pattern JSON_BLOCK_PATTERN = Pattern.compile("(?s)\\{.*\\}|\\[.*\\]"); | ||
|
|
||
| @Override | ||
| public String outputFormatInstructions(Type returnType) { | ||
| Class<?> rawClass = getRawClass(returnType); | ||
| if (Multi.class.equals(rawClass)) { | ||
| // when Multi is used as the return type, Multi<String> is the only supported type, thus we don't need want any formatting instructions | ||
| return ""; | ||
|
|
||
| if (rawClass != String.class && rawClass != AiMessage.class && rawClass != TokenStream.class | ||
| && rawClass != Response.class && !Multi.class.equals(rawClass)) { | ||
| try { | ||
| var schema = this.toJsonSchema(returnType); | ||
| return "You must answer strictly with json according to the following json schema format: " + schema; | ||
| } catch (Exception e) { | ||
| return ""; | ||
| } | ||
| } | ||
|
|
||
| return ""; | ||
| } | ||
|
|
||
| public Object parse(Response<AiMessage> response, Type returnType) { | ||
| QuarkusJsonCodecFactory factory = new QuarkusJsonCodecFactory(); | ||
| var codec = factory.create(); | ||
|
|
||
| if (TypeUtils.typeHasRawClass(returnType, Result.class)) { | ||
| returnType = TypeUtils.resolveFirstGenericParameterClass(returnType); | ||
| } | ||
|
|
||
| Class<?> rawReturnClass = TypeUtils.getRawClass(returnType); | ||
|
|
||
| if (rawReturnClass == Response.class) { | ||
| return response; | ||
| } else { | ||
| AiMessage aiMessage = response.content(); | ||
| if (rawReturnClass == AiMessage.class) { | ||
| return aiMessage; | ||
| } else { | ||
| String text = aiMessage.text(); | ||
| if (rawReturnClass == String.class) { | ||
| return text; | ||
| } else { | ||
| try { | ||
| return codec.fromJson(text, returnType); | ||
| } catch (Exception var10) { | ||
| String jsonBlock = this.extractJsonBlock(text); | ||
| return codec.fromJson(jsonBlock, returnType); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private String extractJsonBlock(String text) { | ||
| Matcher matcher = JSON_BLOCK_PATTERN.matcher(text); | ||
| return matcher.find() ? matcher.group() : text; | ||
| } | ||
|
|
||
| public String toJsonSchema(Type type) throws Exception { | ||
| Map<String, Object> schema = new HashMap<>(); | ||
| Class<?> rawClass = getRawClass(type); | ||
|
|
||
| if (type instanceof WildcardType wildcardType) { | ||
| Type boundType = wildcardType.getUpperBounds().length > 0 ? wildcardType.getUpperBounds()[0] | ||
| : wildcardType.getLowerBounds()[0]; | ||
| return toJsonSchema(boundType); | ||
| } | ||
|
|
||
| if (rawClass == String.class || rawClass == Character.class) { | ||
| schema.put("type", "string"); | ||
| } else if (rawClass == Boolean.class || rawClass == boolean.class) { | ||
| schema.put("type", "boolean"); | ||
| } else if (Number.class.isAssignableFrom(rawClass) || rawClass.isPrimitive()) { | ||
| schema.put("type", (rawClass == double.class || rawClass == float.class) ? "number" : "integer"); | ||
| } else if (Collection.class.isAssignableFrom(rawClass) || rawClass.isArray()) { | ||
| schema.put("type", "array"); | ||
|
|
||
| Type elementType = getElementType(type); | ||
| Map<String, Object> itemsSchema = toJsonSchemaMap(elementType); | ||
| schema.put("items", itemsSchema); | ||
| } else if (rawClass.isEnum()) { | ||
| schema.put("type", "string"); | ||
| schema.put("enum", getEnumConstants(rawClass)); | ||
| } else { | ||
| schema.put("type", "object"); | ||
| Map<String, Object> properties = new HashMap<>(); | ||
|
|
||
| for (Field field : rawClass.getDeclaredFields()) { | ||
| field.setAccessible(true); | ||
| Map<String, Object> fieldSchema = toJsonSchemaMap(field.getGenericType()); | ||
| properties.put(field.getName(), fieldSchema); | ||
| if (field.isAnnotationPresent(Description.class)) { | ||
| Description description = field.getAnnotation(Description.class); | ||
| fieldSchema.put("description", description.value()); | ||
| } | ||
| } | ||
| schema.put("properties", properties); | ||
| } | ||
|
|
||
| ObjectMapper mapper = new ObjectMapper(); | ||
| return mapper.writeValueAsString(schema); // Convert the schema map to a JSON string | ||
| } | ||
|
|
||
| private Class<?> getRawClass(Type type) { | ||
| if (type instanceof Class<?>) { | ||
| return (Class<?>) type; | ||
| } else if (type instanceof ParameterizedType) { | ||
| return (Class<?>) ((ParameterizedType) type).getRawType(); | ||
| } else if (type instanceof GenericArrayType) { | ||
| Type componentType = ((GenericArrayType) type).getGenericComponentType(); | ||
| return Array.newInstance(getRawClass(componentType), 0).getClass(); | ||
| } else if (type instanceof WildcardType) { | ||
| Type boundType = ((WildcardType) type).getUpperBounds().length > 0 ? ((WildcardType) type).getUpperBounds()[0] | ||
| : ((WildcardType) type).getLowerBounds()[0]; | ||
| return getRawClass(boundType); | ||
| } | ||
| throw new IllegalArgumentException("Unsupported type: " + type); | ||
| } | ||
|
|
||
| private Type getElementType(Type type) { | ||
| if (type instanceof ParameterizedType) { | ||
| return ((ParameterizedType) type).getActualTypeArguments()[0]; | ||
| } else if (type instanceof GenericArrayType) { | ||
| return ((GenericArrayType) type).getGenericComponentType(); | ||
| } else if (type instanceof Class<?> && ((Class<?>) type).isArray()) { | ||
| return ((Class<?>) type).getComponentType(); | ||
| } | ||
| return Object.class; // Fallback for cases where element type cannot be determined | ||
| } | ||
|
|
||
| private Map<String, Object> toJsonSchemaMap(Type type) throws Exception { | ||
| String jsonSchema = toJsonSchema(type); | ||
| ObjectMapper mapper = new ObjectMapper(); | ||
| return mapper.readValue(jsonSchema, Map.class); | ||
| } | ||
|
|
||
| private List<String> getEnumConstants(Class<?> enumClass) { | ||
| List<String> constants = new ArrayList<>(); | ||
| for (Object constant : enumClass.getEnumConstants()) { | ||
| constants.add(constant.toString()); | ||
| } | ||
| return super.outputFormatInstructions(returnType); | ||
| return constants; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 66 additions & 0 deletions
66
...n-tests/openai/src/main/java/org/acme/example/openai/aiservices/EntityMappedResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| package org.acme.example.openai.aiservices; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import jakarta.ws.rs.POST; | ||
| import jakarta.ws.rs.Path; | ||
|
|
||
| import org.jboss.resteasy.reactive.RestQuery; | ||
|
|
||
| import dev.langchain4j.model.output.structured.Description; | ||
| import dev.langchain4j.service.UserMessage; | ||
| import io.quarkiverse.langchain4j.RegisterAiService; | ||
|
|
||
| @Path("collection-entity-mapping") | ||
| public class EntityMappedResource { | ||
|
|
||
| private final EntityMappedDescriber describer; | ||
|
|
||
| public EntityMappedResource(EntityMappedDescriber describer) { | ||
| this.describer = describer; | ||
| } | ||
|
|
||
| public static class TestData { | ||
| @Description("Foo description for structured output") | ||
| String foo; | ||
|
|
||
| @Description("Foo description for structured output") | ||
| Integer bar; | ||
|
|
||
| @Description("Foo description for structured output") | ||
| Double baz; | ||
|
|
||
| TestData(String foo, Integer bar, Double baz) { | ||
| this.foo = foo; | ||
| this.bar = bar; | ||
| this.baz = baz; | ||
| } | ||
| } | ||
|
|
||
| @POST | ||
| public List<String> generate(@RestQuery String message) { | ||
| var result = describer.describe(message); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| @POST | ||
| @Path("generateMapped") | ||
| public List<TestData> generateMapped(@RestQuery String message) { | ||
| List<TestData> inputs = new ArrayList<>(); | ||
| inputs.add(new TestData(message, 100, 100.0)); | ||
|
|
||
| return describer.describeMapped(inputs); | ||
| } | ||
|
|
||
| @RegisterAiService | ||
| public interface EntityMappedDescriber { | ||
|
|
||
| @UserMessage("This is a describer returning a collection of strings") | ||
| List<String> describe(String url); | ||
|
|
||
| @UserMessage("This is a describer returning a collection of mapped entities") | ||
| List<TestData> describeMapped(List<TestData> inputs); | ||
| } | ||
| } |
Oops, something went wrong.