Package io.quarkus.assistant.runtime.dev

Interface Assistant

public interface Assistant

This is the Assistant for Quarkus Dev Mode. The actual implementation will be provided by another extension (eg. Chappie)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Assistant.AssistBuilder
static class	Assistant.ExceptionBuilder

Method Summary

Modifier and Type	Method	Description
<T> CompletionStage<T>	assist(Optional<String> systemMessageTemplate, String userMessageTemplate, Map<String,String> variables, List<Path> paths)	Assist the developer with something
default Assistant.AssistBuilder	assistBuilder()
<T> CompletionStage<T>	exception(Optional<String> systemMessage, String userMessage, String stacktrace, Path path)	Explain and suggest a fix for an exception in the user code
default Assistant.ExceptionBuilder	exceptionBuilder()
boolean	isAvailable()	Check if the assistant is available

Method Details

isAvailable

boolean isAvailable()

Check if the assistant is available

Returns:

true id there is an implementation that is configured and connected

exception

<T> CompletionStage<T> exception(Optional<String> systemMessage,
 String userMessage,
 String stacktrace,
 Path path)

Explain and suggest a fix for an exception in the user code

Type Parameters:

T -

Parameters:

systemMessage - System wide context

userMessage - User specific context

stacktrace - The exception stacktrace

path - The path to the effective class causing this exception

Returns:

assist

<T> CompletionStage<T> assist(Optional<String> systemMessageTemplate,
 String userMessageTemplate,
 Map<String,String> variables,
 List<Path> paths)

Assist the developer with something

Type Parameters:

T - The response

Parameters:

systemMessageTemplate - System wide context

userMessageTemplate - User specific context

variables - variables that can be used in the templates

paths - Paths to workspace files (optional)

Returns:

exceptionBuilder

default Assistant.ExceptionBuilder exceptionBuilder()

assistBuilder

default Assistant.AssistBuilder assistBuilder()