Narzędzie systemowe dla AI
Narzędzie systemowe dla AI to komponent, który może zostać wykorzystany przez mechanizmy systemowe lub wtyczkowe związane z LLM do wykonania operacji na systemie PlusWorkflow.
Definiowanie narzędzia systemowego dla AI
Narzędzie systemowe dla AI tworzone jest w oparciu o definicję stworzoną przez użytkownika. Definicja taka musi zawierać następujące elementy:
- Adnotację @AiToolComponent (jeżeli zadanie zaplanowane nie jest definiowane we wtyczce, musi ono pochodzić z pakietu
com.suncode) - Implementować interfejs AiTool
Definicja może zawierać również adnotację @AiToolComponentScript. Adnotacja ta przekazuje ścieżkę do skryptu (z classpath) zawierającego definicję implementacji wywołania tool'a po stronie formularza zadania.
Przykładowa definicja przedstawiona jest poniżej:
@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 );
}
}
}
Implementacja metody execute
Metoda execute przyjmuje parametry wejściowe jako String od modelu LLM, który ma strukturę JSON o kształcie takim, jaki został opisany w parametrze narzędzia aiDescription oraz opcjonalnie inputJsonSchema.
Wartością zwracaną metody może być cokolwiek, co akceptuje model LLM - zwykle jest to JSON reprezentujący rezultat wykonania narzędzia.
Rejestracja narzędzia systemowego dla AI we wtyczce
Jeżeli zadanie zaplanowane 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:
<!-- Udostępnianie komponentów (m.in. narzędzi systemowych dla AI) --> <workflow-components key="components" />