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

Various code cleanup

Browse Source 
Co-authored-by: Alex Klymenko <alxkm@users.noreply.github.com>
This commit is contained in:
Mark Pollack
2024-07-02 15:35:01 -04:00
parent da4b26f74c
commit cb6662a61e
8 changed files with 88 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-ai-core/src/main/java/org/springframework/ai/ResourceUtils.java
View File

@@ -21,10 +21,24 @@ import java.nio.charset.StandardCharsets;
import org.springframework.core.io.DefaultResourceLoader;
/**
* Miscellaneous Resource utility methods. Mainly for use within Spring AI
*
* @author Christian Tzolov
*/
public class ResourceUtils {
public abstract class ResourceUtils {
/**
* Retrieves the content of a resource as a UTF-8 encoded string.
*
* This method uses Spring's DefaultResourceLoader to load the resource from the given
* URI and then reads its content as a string using UTF-8 encoding. If an IOException
* occurs during reading, it is wrapped in a RuntimeException.
* @param uri The URI of the resource to be read. This can be any URI supported by
* Spring's ResourceLoader, such as "classpath:", "file:", or "http:".
* @return The content of the resource as a string.
* @throws RuntimeException If an error occurs while reading the resource. This
* exception wraps the original IOException.
*/
public static String getText(String uri) {
var resource = new DefaultResourceLoader().getResource(uri);
try {

23
spring-ai-core/src/main/java/org/springframework/ai/aot/AiRuntimeHints.java
View File

@@ -32,16 +32,23 @@ import java.util.Set;
import java.util.stream.Collectors;
/**
* Native runtime hints. See other modules for their respective native runtime hints.
* Utility methods for creating native runtime hints. See other modules for their
* respective native runtime hints.
*
* @author Josh Long
* @author Christian Tzolov
* @author Mark Pollack
*/
public class AiRuntimeHints {
public abstract class AiRuntimeHints {
private static final Logger log = LoggerFactory.getLogger(AiRuntimeHints.class);
/**
* Finds classes in a package that are annotated with JsonInclude or have Jackson
* annotations.
* @param packageName The name of the package to search for annotated classes.
* @return A set of TypeReference objects representing the annotated classes found.
*/
public static Set<TypeReference> findJsonAnnotatedClassesInPackage(String packageName) {
var annotationTypeFilter = new AnnotationTypeFilter(JsonInclude.class);
TypeFilter typeFilter = (metadataReader, metadataReaderFactory) -> {
@@ -58,10 +65,22 @@ public class AiRuntimeHints {
return findClassesInPackage(packageName, typeFilter);
}
/**
* Finds classes in a package that are annotated with JsonInclude or have Jackson
* annotations.
* @param packageClass The class in the package to search for annotated classes.
* @return A set of TypeReference objects representing the annotated classes found.
*/
public static Set<TypeReference> findJsonAnnotatedClassesInPackage(Class<?> packageClass) {
return findJsonAnnotatedClassesInPackage(packageClass.getPackageName());
}
/**
* Finds all classes in the specified package that match the given type filter.
* @param packageName The name of the package to scan for classes.
* @param typeFilter The type filter used to filter the scanned classes.
* @return A set of TypeReference objects representing the found classes.
*/
public static Set<TypeReference> findClassesInPackage(String packageName, TypeFilter typeFilter) {
var classPathScanningCandidateComponentProvider = new ClassPathScanningCandidateComponentProvider(false);
classPathScanningCandidateComponentProvider.addIncludeFilter(typeFilter);

2
spring-ai-core/src/main/java/org/springframework/ai/chat/metadata/PromptMetadata.java
View File

@@ -48,7 +48,7 @@ public interface PromptMetadata extends Iterable<PromptMetadata.PromptFilterMeta
* @return a new {@link PromptMetadata} composed of an array of
* {@link PromptFilterMetadata}.
*/
static <T> PromptMetadata of(PromptFilterMetadata... array) {
static PromptMetadata of(PromptFilterMetadata... array) {
return of(Arrays.asList(array));
}

4
spring-ai-core/src/main/java/org/springframework/ai/document/Document.java
View File

@@ -203,8 +203,8 @@ public class Document implements Content {
@Override
public String toString() {
return "Document{" + "id='" + id + '\'' + ", metadata=" + metadata + ", content='" + new String(content) + '\''
+ '}';
return "Document{" + "id='" + id + '\'' + ", metadata=" + metadata + ", content='" + content + '\'' + ", media="
+ media + '}';
}
}

14
spring-ai-core/src/main/java/org/springframework/ai/document/id/JdkSha256HexIdGenerator.java
View File

@@ -72,9 +72,7 @@ public class JdkSha256HexIdGenerator implements IdGenerator {
private byte[] serializeToBytes(Object... contents) {
Assert.notNull(contents, "Contents must not be null");
ByteArrayOutputStream byteOut = null;
try {
byteOut = new ByteArrayOutputStream();
try (ByteArrayOutputStream byteOut = new ByteArrayOutputStream()) {
ObjectOutputStream out = new ObjectOutputStream(byteOut);
for (Object content : contents) {
out.writeObject(content);
@@ -84,16 +82,6 @@ public class JdkSha256HexIdGenerator implements IdGenerator {
catch (Exception e) {
throw new RuntimeException("Failed to serialize", e);
}
finally {
if (byteOut != null) {
try {
byteOut.close();
}
catch (Exception e) {
// ignore
}
}
}
}
MessageDigest getMessageDigest() {

14
spring-ai-core/src/main/java/org/springframework/ai/model/ModelOptionsUtils.java
View File

@@ -57,22 +57,18 @@ import org.springframework.util.CollectionUtils;
* @author Christian Tzolov
* @since 0.8.0
*/
public final class ModelOptionsUtils {
public abstract class ModelOptionsUtils {
public final static ObjectMapper OBJECT_MAPPER = new ObjectMapper()
public static final ObjectMapper OBJECT_MAPPER = new ObjectMapper()
.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
.registerModule(new JavaTimeModule());
private final static List<String> BEAN_MERGE_FIELD_EXCISIONS = List.of("class");
private static final List<String> BEAN_MERGE_FIELD_EXCISIONS = List.of("class");
private static ConcurrentHashMap<Class<?>, List<String>> REQUEST_FIELD_NAMES_PER_CLASS = new ConcurrentHashMap<Class<?>, List<String>>();
private static final ConcurrentHashMap<Class<?>, List<String>> REQUEST_FIELD_NAMES_PER_CLASS = new ConcurrentHashMap<Class<?>, List<String>>();
private static AtomicReference<SchemaGenerator> SCHEMA_GENERATOR_CACHE = new AtomicReference<>();
private ModelOptionsUtils() {
}
private static final AtomicReference<SchemaGenerator> SCHEMA_GENERATOR_CACHE = new AtomicReference<>();
/**
* Converts the given JSON string to a Map of String and Object.

2
spring-ai-core/src/main/java/org/springframework/ai/model/function/FunctionCallbackWrapper.java
View File

@@ -81,7 +81,7 @@ public class FunctionCallbackWrapper<I, O> extends AbstractFunctionCallback<I, O
}
// By default the response is converted to a JSON string.
private Function<O, String> responseConverter = (response) -> ModelOptionsUtils.toJsonString(response);
private Function<O, String> responseConverter = ModelOptionsUtils::toJsonString;
private String inputTypeSchema;

43
spring-ai-core/src/main/java/org/springframework/ai/model/function/TypeResolverHelper.java
View File

@@ -25,18 +25,37 @@ import net.jodah.typetools.TypeResolver;
import org.springframework.cloud.function.context.catalog.FunctionTypeUtils;
/**
* A utility class that provides methods for resolving types and classes related to
* functions.
*
* @author Christian Tzolov
*/
public class TypeResolverHelper {
public abstract class TypeResolverHelper {
/**
* Returns the input class of a given function class.
* @param functionClass The function class.
* @return The input class of the function.
*/
public static Class<?> getFunctionInputClass(Class<? extends Function<?, ?>> functionClass) {
return getFunctionArgumentClass(functionClass, 0);
}
/**
* Returns the output class of a given function class.
* @param functionClass The function class.
* @return The output class of the function.
*/
public static Class<?> getFunctionOutputClass(Class<? extends Function<?, ?>> functionClass) {
return getFunctionArgumentClass(functionClass, 1);
}
/**
* Retrieves the class of a specific argument in a given function class.
* @param functionClass The function class.
* @param argumentIndex The index of the argument whose class should be retrieved.
* @return The class of the specified function argument.
*/
public static Class<?> getFunctionArgumentClass(Class<? extends Function<?, ?>> functionClass, int argumentIndex) {
Type type = TypeResolver.reify(Function.class, functionClass);
@@ -46,19 +65,41 @@ public class TypeResolverHelper {
return toRawClass(argumentType);
}
/**
* Returns the input type of a given function class.
* @param functionClass The class of the function.
* @return The input type of the function.
*/
public static Type getFunctionInputType(Class<? extends Function<?, ?>> functionClass) {
return getFunctionArgumentType(functionClass, 0);
}
/**
* Retrieves the output type of a given function class.
* @param functionClass The function class.
* @return The output type of the function.
*/
public static Type getFunctionOutputType(Class<? extends Function<?, ?>> functionClass) {
return getFunctionArgumentType(functionClass, 1);
}
/**
* Retrieves the type of a specific argument in a given function class.
* @param functionClass The function class.
* @param argumentIndex The index of the argument whose type should be retrieved.
* @return The type of the specified function argument.
*/
public static Type getFunctionArgumentType(Class<? extends Function<?, ?>> functionClass, int argumentIndex) {
Type functionType = TypeResolver.reify(Function.class, functionClass);
return getFunctionArgumentType(functionType, argumentIndex);
}
/**
* Retrieves the type of a specific argument in a given function type.
* @param functionType The function type.
* @param argumentIndex The index of the argument whose type should be retrieved.
* @return The type of the specified function argument.
*/
public static Type getFunctionArgumentType(Type functionType, int argumentIndex) {
// Resolves: https://github.com/spring-projects/spring-ai/issues/726