...
Narzędzie systemowe dla AI tworzone jest w oparciu o definicję stworzoną przez użytkownikaprogramistę. Definicja taka musi zawierać następujące elementy:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
@Slf4j
@AiToolComponent
public class ExampleAiTool
implements AiTool
{
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
private static final String INPUT_JSON_SCHEMA = """
{
"type": "object",
"properties": {
"exampleParam": {
"type": "string",
"description": "Example parameter"
}
},
"required": ["exampleParam"]
}
""";
@Override
public void define( AiToolBuilder builder )
{
builder
.id( "example-tool" )
.name( "example-tool-name" )
.userDescription( "example-tool-description-shown-to-user" )
.aiDescription( "example-tool-description-shown-to-ai" )
.inputJsonSchema( INPUT_JSON_SCHEMA )
.scope( AiToolScope.SERVER );
}
@Override
@Transactional( readOnly = true )
public String execute( String input )
{
try
{
String exampleParam = extractExampleParam( input );
if ( StringUtils.isBlank( exampleParam ) )
{
return "Parameter exampleParam is required.";
}
return OBJECT_MAPPER.writeValueAsString( exampleParam + " answered" );
}
catch ( Exception e )
{
return "Invalid input data";
}
}
private String extractExampleParam( String input )
{
if ( StringUtils.isBlank( input ) )
{
return null;
}
try
{
JsonNode node = OBJECT_MAPPER.readTree( input );
if ( node.isTextual() )
{
return node.asText();
}
return node.path( "exampleParam" ).asText( null );
}
catch ( Exception e )
{
throw new RuntimeException( "Could not extract parameter", e );
}
}
}
|
Parametry:
- userDescription (wymagany)
- opis narzędzia wyświetlany użytkownikowi
- aiDescription (wymagany)
- opis narzędzia przekazywany do modelów LLM
- scope (wymagany)
- enum określający możliwe strony wywołania narzędzia
- możliwe wartości
- SERVER - tylko po stronie serwera
- CLIENT - tylko po stronie przeglądarki
- ALL - możliwość wykonania w obu miejscach
- inputJsonSchema (opcjonalny)
- string ze schematem JSON dla modelów LLM opisujący parametry wejściowe narzędzia przekazane do parametru String input
Implementacja metody execute
...
Rejestracja narzędzia systemowego dla AI we wtyczce
Jeżeli zadanie zaplanowane narzędzie systemowe dla AI jest definiowane we wtyczce to należy dodatkowo zaznaczyć, że wtyczka ta udostępnia komponenty. W tym celu należy w pliku suncode-plugin.xml dodać wpis:
| Code Block | ||
|---|---|---|
| ||
<!-- Udostępnianie komponentów (m.in. narzędzi systemowych dla AI) --> <workflow-components key="components" /> |
Wykonanie po stronie formularza zadania
Narzędzia systemowe dla AI mogą zostać wykonywane po stronie przeglądarki na formularzu zadania.
Rejestracja narzędzia po stronie formularza zadania
Wykonanie po stronie przeglądarki rejestrowane jest poprzez przekazanie ścieżki do skryptu js (z classpath wtyczki) zawierającego definicję obiektu z funkcją w adnotacji @AiToolComponentScript dodanej na poziomie klasy komponentu narzędzia systemowego dla AI.
Przykładowa rejestracja skryptu na klasie po stronie Javy:
| Code Block | ||||
|---|---|---|---|---|
| ||||
@AiToolComponent
@AiToolComponentScript( "js/example-tool-definition.js" )
public class ExampleScheduledTask {
@Override
public void define( AiToolBuilder builder ) {
builder
.id( "example-tool" ) // identyfikator narzędzia
... // pozostałe parametry
}
...
} |
Przykładowa zawartość skryptu rejestrującego obiekt z funkcją po stronie Javascript:
| Code Block | ||||
|---|---|---|---|---|
| ||||
// kluczem w metodzie register jest identyfikator narzędzia systemowego dla AI
PW.AiTools.register('example-tool', {
execute: function (input) {
var inputObj = JSON.parse(input);
var result = inputObj.exampleParam + " answered";
return JSON.stringify(result);
}
}) |