Package org.machanism.machai.ai.web

Class WebProvider

java.lang.Object

org.machanism.machai.ai.none.NoneProvider

org.machanism.machai.ai.web.WebProvider

All Implemented Interfaces:

GenAIProvider

public class WebProvider
extends NoneProvider

The WebProvider class serves as a gateway for interacting with web-based user interfaces via a web driver when direct access to the GenAI API is not feasible. It automates communication with supported services such as AI DIAL and EPAM AI/Run CodeMie, utilizing recipes from Anteater for sending and receiving information.

Limitations: Configuration and usage of this class may require additional plugins or handling of resources such as the clipboard, especially for platforms like CodeMie. Please refer to target platform instructions prior to use.

Usage Example

 GenAIProvider provider = GenAIProviderManager.getProvider("Web:CodeMie");
 

Thread Safety

This implementation is not thread-safe.

Parameters and Methods

• perform() - Executes the AE workspace task using input prompts.
• setWorkingDir(File workingDir) - Initializes workspace with configuration and runs setup nodes.
• model(String configName) - Sets the AE workspace configuration name.

Since:

0.0.2

Author:

Viktor Tovstyi

Field Summary

Fields inherited from class org.machanism.machai.ai.none.NoneProvider

NAME

Constructor Summary

Constructors

Constructor	Description
WebProvider()

Method Summary

Modifier and Type	Method	Description
void	model(String configName)	Sets the AE workspace configuration name, validating change from previous value.
String	perform()	Executes the AE workspace task using provided input prompts.
void	setWorkingDir(File workingDir)	Sets the working directory for AE workspace operations, initializes configuration and runs setup nodes if not already initialized.

Methods inherited from class org.machanism.machai.ai.none.NoneProvider

addFile, addFile, addTool, clear, embedding, getPrompts, inputsLog, instructions, prompt, promptFile

Methods inherited from class java.lang.Object

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

Constructor Details

WebProvider

public WebProvider()

Method Details

perform

public String perform()

Executes the AE workspace task using provided input prompts.

Specified by:

perform in interface GenAIProvider

Overrides:

perform in class NoneProvider

Returns:

the result string from AE task execution

Throws:

IllegalArgumentException - if AE task execution fails (wraps any Exception)

 <code>
 String result = provider.perform();
 </code>
 

setWorkingDir

public void setWorkingDir(File workingDir)

Sets the working directory for AE workspace operations, initializes configuration and runs setup nodes if not already initialized.

Specified by:

setWorkingDir in interface GenAIProvider

Overrides:

setWorkingDir in class NoneProvider

Parameters:

workingDir - the working directory to be set

Throws:

IllegalArgumentException - if initialization fails

model

public void model(String configName)

Sets the AE workspace configuration name, validating change from previous value.

Specified by:

model in interface GenAIProvider

Overrides:

model in class NoneProvider

Parameters:

configName - the name of the configuration file

Throws:

IllegalArgumentException - if configuration change is requested while already in use