Index

A C E F G I M N O P S T U W
All Classes and Interfaces|All Packages|Constant Field Values

A

addFile(File) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Adds a file for processing.

addFile(File) - Method in class org.machanism.machai.ai.none.NoneProvider

Placeholder for adding a file as input.

addFile(File) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Uploads a file to OpenAI and adds its reference as input.

addFile(URL) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Adds a file via a URL (downloads/uses remote file).

addFile(URL) - Method in class org.machanism.machai.ai.none.NoneProvider

Placeholder for adding a file via URL.

addFile(URL) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Adds input from a file by URL.

addTool(String, String, Function<Object[], Object>, String...) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Adds a custom function tool to the provider for runtime invocation.

addTool(String, String, Function<Object[], Object>, String...) - Method in class org.machanism.machai.ai.none.NoneProvider

No-op for adding tools in this stub provider.

addTool(String, String, Function<Object[], Object>, String...) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Adds a tool to the current session, providing its function handler.

applyTools(GenAIProvider) - Method in class org.machanism.machai.ai.manager.CommandFunctionTools

Installs supported shell command tool(s) to the specified GenAIProvider.

applyTools(GenAIProvider) - Method in class org.machanism.machai.ai.manager.FileFunctionTools

Installs file read/write/list tools into the provided GenAIProvider.

applyTools(GenAIProvider) - Method in class org.machanism.machai.ai.manager.SystemFunctionTools

Attaches both file and command function tool capabilities to the specified GenAIProvider.

C

clear() - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Clears all internal state and stored files for this provider instance.

clear() - Method in class org.machanism.machai.ai.none.NoneProvider

Clears all accumulated prompts.

clear() - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Clears all input items for the next request.

CommandFunctionTools - Class in org.machanism.machai.ai.manager

Provides support for command line tool functions to be used within GenAIProvider.

CommandFunctionTools() - Constructor for class org.machanism.machai.ai.manager.CommandFunctionTools

Core Capabilities - Search tag in package org.machanism.machai.ai.web

Section

E

embedding(String) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Returns the embedding vector for the supplied string using the underlying model.

embedding(String) - Method in class org.machanism.machai.ai.none.NoneProvider

Not supported for NoneProvider.

embedding(String) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Requests embeddings for the given text using the current embedding model.

F

FileFunctionTools - Class in org.machanism.machai.ai.manager

Provides file system utility tools for use in GenAIProvider environments.

FileFunctionTools() - Constructor for class org.machanism.machai.ai.manager.FileFunctionTools

G

GenAIProvider - Interface in org.machanism.machai.ai.manager

Interface for generic AI providers (GenAIProvider) supporting prompts, file operations, and tool augmentation.

GenAIProviderManager - Class in org.machanism.machai.ai.manager

Manages the instantiation of GenAIProvider implementations based on model identifier strings.

GenAIProviderManager() - Constructor for class org.machanism.machai.ai.manager.GenAIProviderManager

getPrompts() - Method in class org.machanism.machai.ai.none.NoneProvider

getProvider(String) - Static method in class org.machanism.machai.ai.manager.GenAIProviderManager

Creates and returns the appropriate GenAIProvider based on the provided model string.

I

inputsLog(File) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Logs input events, optionally into a temporary directory.

inputsLog(File) - Method in class org.machanism.machai.ai.none.NoneProvider

Sets the file to log inputs.

inputsLog(File) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Set the file used for logging model inputs.

instructions(String) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Sets or updates instruction text for the provider session.

instructions(String) - Method in class org.machanism.machai.ai.none.NoneProvider

Stores the instructions to be used by the provider (if any).

instructions(String) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Sets instructions for the model to use in the session.

M

model(String) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Selects the model name for this provider instance.

model(String) - Method in class org.machanism.machai.ai.none.NoneProvider

Stub for choosing a model.

model(String) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Initializes the chat model and OpenAI client.

model(String) - Method in class org.machanism.machai.ai.web.WebProvider

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

N

NAME - Static variable in class org.machanism.machai.ai.none.NoneProvider

The name identifying this provider.

NoneProvider - Class in org.machanism.machai.ai.none

The NoneProvider class is an implementation of the GenAIProvider interface, intended for use as a request logger when integration with AI services is not required or available.

NoneProvider() - Constructor for class org.machanism.machai.ai.none.NoneProvider

O

OpenAIProvider - Class in org.machanism.machai.ai.openAI

The `OpenAIProvider` class integrates seamlessly with the OpenAI API, serving as a concrete implementation of the `GenAIProvider` interface.

OpenAIProvider() - Constructor for class org.machanism.machai.ai.openAI.OpenAIProvider

org.machanism.machai.ai.manager - package org.machanism.machai.ai.manager

org.machanism.machai.ai.none - package org.machanism.machai.ai.none

Provides classes and interfaces representing a non-operational AI Provider implementation.

org.machanism.machai.ai.openAI - package org.machanism.machai.ai.openAI

org.machanism.machai.ai.web - package org.machanism.machai.ai.web

Provides integration with AE workspace and prompt-driven workflows for automated code generation projects.

P

Parameters and Methods - Search tag in class org.machanism.machai.ai.web.WebProvider

Section

perform() - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Performs the main action, typically runs or triggers model output.

perform() - Method in class org.machanism.machai.ai.none.NoneProvider

Writes the prompts and instructions (if present) to files if inputsLog is set.

perform() - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Performs a request using current inputs and returns the response string.

perform() - Method in class org.machanism.machai.ai.web.WebProvider

Executes the AE workspace task using provided input prompts.

prompt(String) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Sends a prompt string to the provider.

prompt(String) - Method in class org.machanism.machai.ai.none.NoneProvider

Appends the given text to the prompt buffer.

prompt(String) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Adds a text prompt to the current conversation.

promptBundle(ResourceBundle) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Set the ResourceBundle for prompts.

promptFile(File, String) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

Sends a prompt using the contents of a file.

promptFile(File, String) - Method in class org.machanism.machai.ai.none.NoneProvider

Placeholder for adding a prompt from a file.

promptFile(File, String) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

Adds a prompt from a file, formatting the file content according to a ResourceBundle message.

S

setWorkingDir(File) - Method in interface org.machanism.machai.ai.manager.GenAIProvider

setWorkingDir(File) - Method in class org.machanism.machai.ai.none.NoneProvider

setWorkingDir(File) - Method in class org.machanism.machai.ai.openAI.OpenAIProvider

setWorkingDir(File) - Method in class org.machanism.machai.ai.web.WebProvider

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

SystemFunctionTools - Class in org.machanism.machai.ai.manager

Provides unified access to file and command function tools for GenAIProvider environments.

SystemFunctionTools() - Constructor for class org.machanism.machai.ai.manager.SystemFunctionTools

Initializes unified system function tools for a working directory.

T

Thread Safety - Search tag in class org.machanism.machai.ai.web.WebProvider

Section

U

Usage Example - Search tag in class org.machanism.machai.ai.web.WebProvider

Section

Usage Example - Search tag in package org.machanism.machai.ai.web

Section

W

WebProvider - Class in org.machanism.machai.ai.web

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.

WebProvider() - Constructor for class org.machanism.machai.ai.web.WebProvider

A C E F G I M N O P S T U W
All Classes and Interfaces|All Packages|Constant Field Values