Package io.jenkins.plugins.explain_error.provider

Class BaseAIProvider

java.lang.Object

hudson.model.AbstractDescribableImpl<BaseAIProvider>

io.jenkins.plugins.explain_error.provider.BaseAIProvider

All Implemented Interfaces:

ExtensionPoint, Describable<BaseAIProvider>

Direct Known Subclasses:

GeminiProvider, OllamaProvider, OpenAIProvider

public abstract class BaseAIProvider
extends AbstractDescribableImpl<BaseAIProvider>
implements ExtensionPoint

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseAIProvider.Assistant
static class	BaseAIProvider.BaseProviderDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected String	model
protected String	url

Constructor Summary

Constructors

Constructor	Description
BaseAIProvider(String url, String model)

Method Summary

Modifier and Type	Method	Description
abstract BaseAIProvider.Assistant	createAssistant()
final String	explainError(String errorLogs, TaskListener listener)	Explain error logs using the configured AI provider.
final String	explainError(String errorLogs, TaskListener listener, String language)	Explain error logs using the configured AI provider.
BaseAIProvider.BaseProviderDescriptor	getDescriptor()
String	getModel()
String	getProviderName()
String	getUrl()
abstract boolean	isNotValid(TaskListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

url

protected String url

model

protected String model

Constructor Details

BaseAIProvider

public BaseAIProvider(String url,
 String model)

Method Details

createAssistant

public abstract BaseAIProvider.Assistant createAssistant()

isNotValid

public abstract boolean isNotValid(@CheckForNull
 TaskListener listener)

getUrl

public String getUrl()

getModel

public String getModel()

explainError

public final String explainError(String errorLogs,
 TaskListener listener)
                          throws ExplanationException

Explain error logs using the configured AI provider.

Parameters:

errorLogs - the error logs to explain

Returns:

the AI explanation

Throws:

ExplanationException - if there's a communication error

explainError

public final String explainError(String errorLogs,
 TaskListener listener,
 String language)
                          throws ExplanationException

Explain error logs using the configured AI provider.

Parameters:

errorLogs - the error logs to explain

language - the preferred response language

Returns:

the AI explanation

Throws:

ExplanationException - if there's a communication error

getDescriptor

public BaseAIProvider.BaseProviderDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<BaseAIProvider>

Overrides:

getDescriptor in class AbstractDescribableImpl<BaseAIProvider>

getProviderName

public String getProviderName()