Skip to content

Commit 87dec3b

Browse files
gs-snagarajgs-snagaraj
committed
Support OpenAIFunction Custom object Schema
1 parent b08fdf0 commit 87dec3b

6 files changed

Lines changed: 163 additions & 10 deletions

File tree

‎aiservices/openai/src/main/java/com/microsoft/semantickernel/aiservices/openai/chatcompletion/OpenAIFunction.java‎

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,25 @@
77
import com.fasterxml.jackson.core.JsonProcessingException;
88
import com.fasterxml.jackson.databind.JsonNode;
99
import com.fasterxml.jackson.databind.ObjectMapper;
10+
import com.microsoft.semantickernel.exceptions.SKException;
11+
import com.microsoft.semantickernel.orchestration.responseformat.ResponseSchemaGenerator;
1012
import com.microsoft.semantickernel.semanticfunctions.InputVariable;
1113
import com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata;
14+
import org.apache.commons.lang3.StringUtils;
1215
import java.util.ArrayList;
1316
import java.util.Collections;
1417
import java.util.HashMap;
1518
import java.util.List;
1619
import java.util.Locale;
1720
import java.util.Map;
21+
import java.util.Objects;
22+
import java.util.concurrent.ConcurrentHashMap;
1823
import java.util.stream.Collectors;
1924
import javax.annotation.Nonnull;
2025
import javax.annotation.Nullable;
2126

2227
class OpenAIFunction {
28+
private static final ConcurrentHashMap<String, String> SCHEMA_CACHE = new ConcurrentHashMap<>();
2329

2430
private final String pluginName;
2531
private final String name;
@@ -159,14 +165,17 @@ private static String getSchemaForFunctionParameter(@Nullable InputVariable para
159165
entries.add("\"type\":\"" + type + "\"");
160166

161167
// Add description if present
168+
String description =null;
162169
if (parameter != null && parameter.getDescription() != null && !parameter.getDescription()
163170
.isEmpty()) {
164-
String description = parameter.getDescription();
171+
description = parameter.getDescription();
165172
description = description.replaceAll("\\r?\\n|\\r", "");
166173
description = description.replace("\"", "\\\"");
167-
168-
description = String.format("\"description\":\"%s\"", description);
169-
entries.add(description);
174+
entries.add(String.format("\"description\":\"%s\"", description));
175+
}
176+
// If custom type, generate schema
177+
if("object".equalsIgnoreCase(type)) {
178+
return getObjectSchema(parameter.getType(), description);
170179
}
171180

172181
// Add enum options if parameter is an enum
@@ -219,4 +228,24 @@ private static String getJavaTypeToOpenAiFunctionType(String javaType) {
219228
return "object";
220229
}
221230
}
231+
232+
private static String getObjectSchema(String type, String description){
233+
String schema= "";
234+
try {
235+
if(SCHEMA_CACHE.containsKey(type)) {
236+
schema= SCHEMA_CACHE.get(type);
237+
} else {
238+
Class<?> clazz = Class.forName(type);
239+
schema = ResponseSchemaGenerator.jacksonGenerator().generateSchema(clazz);
240+
SCHEMA_CACHE.put(type, schema);
241+
}
242+
} catch (ClassNotFoundException | SKException ignored) {
243+
244+
}
245+
Map<String, Object> properties = BinaryData.fromString(schema).toObject(Map.class);
246+
if(StringUtils.isNotBlank(description)) {
247+
properties.put("description", description);
248+
}
249+
return BinaryData.fromObject(properties).toString();
250+
}
222251
}

‎aiservices/openai/src/test/java/com/microsoft/semantickernel/aiservices/openai/chatcompletion/JsonSchemaTest.java‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
// Copyright (c) Microsoft. All rights reserved.
22
package com.microsoft.semantickernel.aiservices.openai.chatcompletion;
33

4+
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
45
import com.fasterxml.jackson.core.JsonProcessingException;
56
import com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat;
7+
import com.microsoft.semantickernel.plugin.KernelPlugin;
8+
import com.microsoft.semantickernel.plugin.KernelPluginFactory;
9+
import com.microsoft.semantickernel.semanticfunctions.KernelFunction;
10+
import com.microsoft.semantickernel.semanticfunctions.annotations.DefineKernelFunction;
11+
import com.microsoft.semantickernel.semanticfunctions.annotations.KernelFunctionParameter;
612
import org.junit.jupiter.api.Assertions;
713
import org.junit.jupiter.api.Test;
14+
import reactor.core.publisher.Mono;
815

916
public class JsonSchemaTest {
1017

@@ -24,4 +31,84 @@ public void jacksonGenerationTest() throws JsonProcessingException {
2431
"\"type\":\"object\",\"properties\":{\"bar\":{}}"));
2532
}
2633

34+
@Test
35+
public void openAIFunctionTest() {
36+
KernelPlugin plugin = KernelPluginFactory.createFromObject(
37+
new TestPlugin(),
38+
"test");
39+
40+
Assertions.assertNotNull(plugin);
41+
Assertions.assertEquals(plugin.getName(), "test");
42+
Assertions.assertEquals(plugin.getFunctions().size(), 3);
43+
44+
KernelFunction<?> testFunction = plugin.getFunctions()
45+
.get("asyncPersonFunction");
46+
OpenAIFunction openAIFunction = OpenAIFunction.build(
47+
testFunction.getMetadata(),
48+
plugin.getName());
49+
System.out.println(openAIFunction.getFunctionDefinition());
50+
51+
}
52+
53+
54+
public static class TestPlugin {
55+
56+
@DefineKernelFunction
57+
public String testFunction(
58+
@KernelFunctionParameter(name = "input", description = "input string") String input) {
59+
return "test" + input;
60+
}
61+
62+
@DefineKernelFunction(returnType = "int")
63+
public Mono<Integer> asyncTestFunction(
64+
@KernelFunctionParameter(name = "input") String input) {
65+
return Mono.just(1);
66+
}
67+
68+
@DefineKernelFunction(returnType = "int", description = "test function description",
69+
name = "asyncPersonFunction", returnDescription = "test return description")
70+
public Mono<Integer> asyncPersonFunction(
71+
@KernelFunctionParameter(name = "person",description = "input person", type = Person.class) Person person,
72+
@KernelFunctionParameter(name = "input", description = "input string") String input) {
73+
return Mono.just(1);
74+
}
75+
}
76+
77+
private static enum Title {
78+
MS,
79+
MRS,
80+
MR
81+
}
82+
83+
public static class Person {
84+
@JsonPropertyDescription("The name of the person.")
85+
private String name;
86+
@JsonPropertyDescription("The age of the person.")
87+
private int age;
88+
@JsonPropertyDescription("The title of the person.")
89+
private Title title;
90+
91+
92+
public Person(String name, int age) {
93+
this.name = name;
94+
this.age = age;
95+
}
96+
97+
public String getName() {
98+
return name;
99+
}
100+
101+
public int getAge() {
102+
return age;
103+
}
104+
105+
public Title getTitle() {
106+
return title;
107+
}
108+
109+
public void setTitle(Title title) {
110+
this.title = title;
111+
}
112+
}
113+
27114
}

‎samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/demos/lights/App.java‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,7 @@ public static void main(String[] args) throws Exception {
7070
ChatCompletionService.class);
7171

7272
ContextVariableTypes
73-
.addGlobalConverter(ContextVariableTypeConverter.builder(LightModel.class)
74-
.toPromptString(new Gson()::toJson)
75-
.build());
73+
.addGlobalConverter(new LightModelTypeConverter());
7674

7775
KernelHooks hook = new KernelHooks();
7876

@@ -99,9 +97,7 @@ public static void main(String[] args) throws Exception {
9997
InvocationContext invocationContext = new Builder()
10098
.withReturnMode(InvocationReturnMode.LAST_MESSAGE_ONLY)
10199
.withToolCallBehavior(ToolCallBehavior.allowAllKernelFunctions(true))
102-
.withContextVariableConverter(ContextVariableTypeConverter.builder(LightModel.class)
103-
.toPromptString(new Gson()::toJson)
104-
.build())
100+
.withContextVariableConverter(new LightModelTypeConverter())
105101
.build();
106102

107103
// Create a history to store the conversation

‎samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/demos/lights/LightModel.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
// Copyright (c) Microsoft. All rights reserved.
22
package com.microsoft.semantickernel.samples.demos.lights;
33

4+
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
5+
46
public class LightModel {
57

8+
@JsonPropertyDescription("The unique identifier of the light")
69
private int id;
10+
11+
@JsonPropertyDescription("The name of the light")
712
private String name;
13+
14+
@JsonPropertyDescription("The state of the light")
815
private Boolean isOn;
916

1017
public LightModel(int id, String name, Boolean isOn) {

‎samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/demos/lights/LightModelTypeConverter.java‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
package com.microsoft.semantickernel.samples.demos.lights;
2+
3+
import com.google.gson.Gson;
4+
import com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter;
5+
6+
public class LightModelTypeConverter extends ContextVariableTypeConverter<LightModel> {
7+
private static final Gson gson = new Gson();
8+
9+
public LightModelTypeConverter() {
10+
super(
11+
LightModel.class,
12+
obj -> {
13+
if(obj instanceof String) {
14+
return gson.fromJson((String)obj, LightModel.class);
15+
} else {
16+
return gson.fromJson(gson.toJson(obj), LightModel.class);
17+
}
18+
},
19+
(types, lightModel) -> gson.toJson(lightModel),
20+
json -> gson.fromJson(json, LightModel.class)
21+
);
22+
}
23+
}

‎samples/semantickernel-concepts/semantickernel-syntax-examples/src/main/java/com/microsoft/semantickernel/samples/demos/lights/LightsPlugin.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ public List<LightModel> getLights() {
2424
return lights;
2525
}
2626

27+
@DefineKernelFunction(name = "add_light", description = "Adds a new light")
28+
public String addLight(
29+
@KernelFunctionParameter(name = "newLight", description = "new Light Details", type = LightModel.class) LightModel light) {
30+
if( light != null) {
31+
System.out.println("Adding light " + light.getName());
32+
lights.add(light);
33+
return "Light added";
34+
}
35+
return "Light failed to added";
36+
}
37+
2738
@DefineKernelFunction(name = "change_state", description = "Changes the state of the light")
2839
public LightModel changeState(
2940
@KernelFunctionParameter(name = "id", description = "The ID of the light to change", type = int.class) int id,

0 commit comments

Comments
 (0)