com.microsoft.semantickernel.contextvariables.converters.ContextVariableJacksonConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of semantickernel-api Show documentation

Defines the public interface for the Semantic Kernel

There is a newer version: 1.4.2

// Copyright (c) Microsoft. All rights reserved.
package com.microsoft.semantickernel.contextvariables.converters;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter;
import com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Builder;
import com.microsoft.semantickernel.exceptions.SKException;

/**
 * A utility class for creating {@link ContextVariableTypeConverter} instances that use Jackson for
 * serialization and deserialization.
 */
public final class ContextVariableJacksonConverter {

    /**
     * Creates a new {@link ContextVariableTypeConverter} that uses Jackson for serialization and
     * deserialization.
     *
     * @param type   the type of the context variable
     * @param mapper the {@link ObjectMapper} to use for serialization and deserialization
     * @param     the type of the context variable
     * @return a new {@link ContextVariableTypeConverter}
     */
    public static  ContextVariableTypeConverter create(Class type, ObjectMapper mapper) {
        return builder(type, mapper).build();
    }

    /**
     * Creates a new {@link ContextVariableTypeConverter} that uses Jackson for serialization and
     * deserialization.
     *
     * @param type the type of the context variable
     * @param   the type of the context variable
     * @return a new {@link ContextVariableTypeConverter}
     */
    public static  ContextVariableTypeConverter create(Class type) {
        return create(type, new ObjectMapper());
    }

    /**
     * Creates a new {@link Builder} for a {@link ContextVariableTypeConverter} that uses Jackson
     * for serialization and deserialization.
     *
     * @param type the type of the context variable
     * @param   the type of the context variable
     * @return a new {@link Builder}
     */
    public static  Builder builder(Class type) {
        return builder(type, new ObjectMapper());
    }

    /**
     * Creates a new {@link Builder} for a {@link ContextVariableTypeConverter} that uses Jackson
     * for serialization and deserialization.
     *
     * @param type   the type of the context variable
     * @param mapper the {@link ObjectMapper} to use for serialization and deserialization
     * @param     the type of the context variable
     * @return a new {@link Builder}
     */
    public static  Builder builder(Class type, ObjectMapper mapper) {
        return ContextVariableTypeConverter.builder(type)
            .fromPromptString(str -> {
                try {
                    return mapper.readValue(str, type);
                } catch (JsonProcessingException e) {
                    throw new SKException("Failed to deserialize object", e);
                }
            })
            .toPromptString(obj -> {
                try {
                    return mapper.writerWithDefaultPrettyPrinter().writeValueAsString(obj);
                } catch (JsonProcessingException e) {
                    throw new SKException("Failed to serialize object", e);
                }
            });
    }
}