Index (GenAI Client 1.1.0 API)

A B C D E F G H I K L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addTool(String, String, ToolFunction, String...) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
addTool(String, String, ToolFunction, String...) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Registers a tool/function that the model may invoke.
addTool(String, String, ToolFunction, String...) - Method in interface org.machanism.machai.ai.provider.Genai: Registers a custom tool function that the provider may invoke at runtime.
addTool(String, String, ToolFunction, String...) - Method in class org.machanism.machai.ai.provider.GenaiAdapter
addTool(String, String, ToolFunction, String...) - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Registers a tool.
addTool(String, String, ToolFunction, String...) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Registers a function tool for the current provider instance.
addUsage(Usage) - Static method in class org.machanism.machai.ai.manager.GenaiProviderManager: Adds a single Usage record to the in-memory aggregation list.
append(String) - Method in class org.machanism.machai.ai.tools.LimitedStringBuilder: Appends text to this builder, trimming any excess characters from the start to stay within the configured maximum size.
apply(Object[]) - Method in interface org.machanism.machai.ai.tools.ToolFunction: Executes the tool.
applySelectorIfPresent(String, String) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Applies a CSS selector to the response HTML if one was provided.
applyTools(Genai) - Method in class org.machanism.machai.ai.tools.CommandFunctionTools: Registers system command and process control tools with the provided Genai.
applyTools(Genai) - Method in interface org.machanism.machai.ai.tools.FunctionTools: Registers this tool set with the given provider.
applyTools(Genai) - Method in class org.machanism.machai.ai.tools.FunctionToolsLoader: Applies all discovered tool installers to the given provider.
applyTools(Genai) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Registers web content and REST API function tools with the provided Genai.
Architecture overview - Search tag in Overview: Section
AUTH_URL - Static variable in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Default OpenID Connect token endpoint for CodeMie.
AUTH_URL_PROP_NAME - Static variable in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Configuration key used to override the default token endpoint.
Authentication - Search tag in class org.machanism.machai.ai.tools.WebFunctionTools: Section
Authentication behavior - Search tag in package org.machanism.machai.ai.provider.codemie: Section
Authentication modes - Search tag in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Section
Available provider packages - Search tag in package org.machanism.machai.ai.provider: Section

B

BASE_URL - Static variable in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Base URL for the CodeMie Code Assistant API.

C

callRestApi(Object[]) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Implements call_rest_api by executing an HTTP request against the provided endpoint.
ClaudeProvider - Class in org.machanism.machai.ai.provider.claude: Anthropic-backed implementation of MachAI's Genai abstraction.
ClaudeProvider() - Constructor for class org.machanism.machai.ai.provider.claude.ClaudeProvider
clear() - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
clear() - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Clears the current request context (prompt, files, tools, instructions).
clear() - Method in interface org.machanism.machai.ai.provider.Genai: Clears any stored files and session/provider state.
clear() - Method in class org.machanism.machai.ai.provider.GenaiAdapter
clear() - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Clears the accumulated prompt buffer.
clear() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Clears all accumulated inputs for the next request.
clear() - Method in class org.machanism.machai.ai.tools.LimitedStringBuilder: Clears the retained content.
CodeMieProvider - Class in org.machanism.machai.ai.provider.codemie: Genai implementation that integrates with EPAM CodeMie.
CodeMieProvider() - Constructor for class org.machanism.machai.ai.provider.codemie.CodeMieProvider
CommandFunctionTools - Class in org.machanism.machai.ai.tools: Installs command-execution and process-termination tools into a Genai.
CommandFunctionTools() - Constructor for class org.machanism.machai.ai.tools.CommandFunctionTools
CommandFunctionTools.ProcessTerminationException - Exception Class in org.machanism.machai.ai.tools: Runtime exception used by terminate_process to signal early termination to the host.
CommandSecurityChecker - Class in org.machanism.machai.ai.tools: Loads and evaluates command deny-list rules used by host-side command execution tools.
CommandSecurityChecker(Configurator) - Constructor for class org.machanism.machai.ai.tools.CommandSecurityChecker: Creates a new checker and loads deny-list rules from an operating-system specific classpath resource.
Configuration - Search tag in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Section
Configuration - Search tag in package org.machanism.machai.ai.provider.codemie: Section
Configuration overview - Search tag in package org.machanism.machai.ai.provider.openai: Section
Core responsibilities - Search tag in package org.machanism.machai.ai.manager: Section
Core types - Search tag in package org.machanism.machai.ai.provider: Section

D

denyCheck(String) - Method in class org.machanism.machai.ai.tools.CommandSecurityChecker: Checks whether the supplied command matches any deny-list rule.
DenyException - Exception Class in org.machanism.machai.ai.tools: Exception thrown when a command fails a deny-list security check.
DenyException(String) - Constructor for exception class org.machanism.machai.ai.tools.DenyException: Creates a new exception with a human-readable reason.

E

embedding(String, long) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
embedding(String, long) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Computes an embedding vector for the given text.
embedding(String, long) - Method in interface org.machanism.machai.ai.provider.Genai: Computes an embedding vector for the provided text.
embedding(String, long) - Method in class org.machanism.machai.ai.provider.GenaiAdapter
embedding(String, long) - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Indicates that embedding generation is not available for this provider.
embedding(String, long) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Requests an embedding vector for the given input text.
Example - Search tag in class org.machanism.machai.ai.provider.none.NoneProvider: Section
Example - Search tag in package org.machanism.machai.ai: Section
Example - Search tag in package org.machanism.machai.ai.provider.none: Section
executeCommand(Object[]) - Method in class org.machanism.machai.ai.tools.CommandFunctionTools: Implements the run_command_line_tool tool.

F

fillHeader(String, HttpURLConnection) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Applies headers to the connection.
FunctionTools - Interface in org.machanism.machai.ai.tools: Service-provider interface (SPI) for installing host-provided function tools into a Genai.
FunctionToolsLoader - Class in org.machanism.machai.ai.tools: Discovers and applies FunctionTools implementations using ServiceLoader.

G

GeminiProvider - Class in org.machanism.machai.ai.provider.gemini: MachAI Genai implementation for Google's Gemini models.
GeminiProvider() - Constructor for class org.machanism.machai.ai.provider.gemini.GeminiProvider
Genai - Interface in org.machanism.machai.ai.provider: Contract for a generative-AI provider integration.
GenaiAdapter - Class in org.machanism.machai.ai.provider: Delegating Genai implementation.
GenaiAdapter() - Constructor for class org.machanism.machai.ai.provider.GenaiAdapter: Creates an adapter without a delegate.
GenAI Client - Search tag in Overview: Section
GenaiProviderManager - Class in org.machanism.machai.ai.manager: Factory/registry for resolving Genai implementations from a provider/model identifier and aggregating per-run Usage metrics.
getClient() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Returns the underlying OpenAI client.
getConnection(URI, String) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Creates and configures an HttpURLConnection.
getExitCode() - Method in exception class org.machanism.machai.ai.tools.CommandFunctionTools.ProcessTerminationException: Returns the desired exit code.
getInputCachedTokens() - Method in class org.machanism.machai.ai.manager.Usage: Returns the number of cached input tokens.
getInputTokens() - Method in class org.machanism.machai.ai.manager.Usage: Returns the number of input tokens.
getInstance() - Static method in class org.machanism.machai.ai.tools.FunctionToolsLoader: Returns the singleton instance.
getLastText() - Method in class org.machanism.machai.ai.tools.LimitedStringBuilder: Returns the retained content.
getOutputTokens() - Method in class org.machanism.machai.ai.manager.Usage: Returns the number of output tokens.
getPrompts() - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Returns the accumulated prompt text.
getProvider(String, Configurator) - Static method in class org.machanism.machai.ai.manager.GenaiProviderManager: Creates a provider instance for the given provider/model identifier and applies the selected model.
getTimeout() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Returns the configured request timeout.
getToken(String, String, String) - Static method in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Requests an OAuth 2.0 access token from the given token endpoint.
getWebContent(Object[]) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Implements get_web_content by retrieving web content via an HTTP GET request.
getWebPage(HttpURLConnection, int, String) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Performs the HTTP GET request and returns the response content.

H

Header variable placeholders - Search tag in class org.machanism.machai.ai.tools.WebFunctionTools: Section

I

Included types - Search tag in package org.machanism.machai.ai.manager: Section
init(Configurator) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
init(Configurator) - Method in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Initializes the provider using configuration values.
init(Configurator) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Initializes this provider using the supplied configuration.
init(Configurator) - Method in interface org.machanism.machai.ai.provider.Genai: Initializes the provider with application configuration.
init(Configurator) - Method in class org.machanism.machai.ai.provider.GenaiAdapter
init(Configurator) - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Initializes this provider from configuration.
init(Configurator) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Initializes the provider from the given configuration.
inputsLog(File) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
inputsLog(File) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Enables logging of provider inputs to the specified file.
inputsLog(File) - Method in interface org.machanism.machai.ai.provider.Genai: Enables logging of provider inputs to the given directory.
inputsLog(File) - Method in class org.machanism.machai.ai.provider.GenaiAdapter
inputsLog(File) - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Configures the file used for logging prompts.
inputsLog(File) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Enables request input logging to the given file.
Installed tools - Search tag in class org.machanism.machai.ai.tools.CommandFunctionTools: Section
instructions(String) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
instructions(String) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Sets system-level instructions to guide model behavior for subsequent requests.
instructions(String) - Method in interface org.machanism.machai.ai.provider.Genai: Sets system/session instructions for the current conversation.
instructions(String) - Method in class org.machanism.machai.ai.provider.GenaiAdapter
instructions(String) - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Sets instructions to be written during NoneProvider.perform() (when NoneProvider.inputsLog(File) is set).
instructions(String) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Sets system-level instructions applied to subsequent requests.

K

Key characteristics - Search tag in class org.machanism.machai.ai.provider.none.NoneProvider: Section
Key types - Search tag in package org.machanism.machai.ai.tools: Section

L

length() - Method in class org.machanism.machai.ai.tools.LimitedStringBuilder: Returns the number of characters currently retained.
LimitedStringBuilder - Class in org.machanism.machai.ai.tools: A StringBuilder-like helper that retains only the last maxSize characters.
LimitedStringBuilder(int) - Constructor for class org.machanism.machai.ai.tools.LimitedStringBuilder: Creates a builder that keeps at most maxSize characters.
LINE_SEPARATOR - Static variable in interface org.machanism.machai.ai.provider.Genai: Line separator used when composing prompts.
LOG_INPUTS_PROP_NAME - Static variable in interface org.machanism.machai.ai.provider.Genai: Configuration property name indicating whether provider inputs should be logged.
logInputs() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Writes the current request inputs to OpenAIProvider.inputsLog when logging is enabled.
logUsage() - Static method in class org.machanism.machai.ai.manager.GenaiProviderManager: Logs a summary of the aggregated Usage records.

M

MAX_OUTPUT_TOKENS - Static variable in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Default maximum number of tokens the model may generate.
MAX_TOOL_CALLS - Static variable in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Default maximum number of tool calls allowed per response.

N

NAME - Static variable in class org.machanism.machai.ai.provider.none.NoneProvider: Provider name used for identification in configuration.
NoneProvider - Class in org.machanism.machai.ai.provider.none: No-op implementation of Genai.
NoneProvider() - Constructor for class org.machanism.machai.ai.provider.none.NoneProvider

O

OPENAI_API_KEY - Static variable in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Configuration/environment key used by OpenAI-compatible clients to provide the API key.
OpenAIProvider - Class in org.machanism.machai.ai.provider.openai: OpenAI-backed Genai implementation.
OpenAIProvider() - Constructor for class org.machanism.machai.ai.provider.openai.OpenAIProvider
Operational notes - Search tag in Overview: Section
org.machanism.machai.ai - package org.machanism.machai.ai: Provider-agnostic generative AI client API for MachAI.
org.machanism.machai.ai.manager - package org.machanism.machai.ai.manager: Provider-resolution and usage-tracking infrastructure for generative-AI integrations.
org.machanism.machai.ai.provider - package org.machanism.machai.ai.provider: Defines the provider abstraction layer used by MachAI to integrate with concrete generative AI services.
org.machanism.machai.ai.provider.claude - package org.machanism.machai.ai.provider.claude: Provides Anthropic Claude integration for the MachAI generative AI abstraction layer.
org.machanism.machai.ai.provider.codemie - package org.machanism.machai.ai.provider.codemie: Provides integration with the EPAM CodeMie Code Assistant platform.
org.machanism.machai.ai.provider.gemini - package org.machanism.machai.ai.provider.gemini: Provides the Gemini-specific implementation of MachAI's provider abstraction.
org.machanism.machai.ai.provider.none - package org.machanism.machai.ai.provider.none: Provides a no-op Genai implementation for offline, disabled, or test-only execution paths.
org.machanism.machai.ai.provider.openai - package org.machanism.machai.ai.provider.openai: OpenAI provider integration for MachAI.
org.machanism.machai.ai.tools - package org.machanism.machai.ai.tools: Host-side function tooling for integrating controlled local capabilities with a Genai provider.

P

Package responsibilities - Search tag in package org.machanism.machai.ai.tools: Section
Package scope - Search tag in package org.machanism.machai.ai: Section
Package structure - Search tag in Overview: Section
PARAGRAPH_SEPARATOR - Static variable in interface org.machanism.machai.ai.provider.Genai: Paragraph separator used when composing prompts.
parseEnv(String) - Method in class org.machanism.machai.ai.tools.CommandFunctionTools: Parses the env parameter string into a map of environment variables.
PASSWORD_PROP_NAME - Static variable in interface org.machanism.machai.ai.provider.Genai: Environment variable name for authenticating with the GenAI provider.
perform() - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
perform() - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Executes the configured prompt against Gemini and returns the model output.
perform() - Method in interface org.machanism.machai.ai.provider.Genai: Executes the provider to produce a response based on the accumulated prompts and state.
perform() - Method in class org.machanism.machai.ai.provider.GenaiAdapter
perform() - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Writes instructions (when set) and accumulated prompts to local files when NoneProvider.inputsLog(File) is set.
perform() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Executes a request using the currently configured model, inputs, and tools.
ProcessTerminationException(String, int) - Constructor for exception class org.machanism.machai.ai.tools.CommandFunctionTools.ProcessTerminationException: Creates a termination exception.
ProcessTerminationException(String, Throwable, int) - Constructor for exception class org.machanism.machai.ai.tools.CommandFunctionTools.ProcessTerminationException: Creates a termination exception.
prompt(String) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
prompt(String) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Adds a plain-text prompt to the current request context.
prompt(String) - Method in interface org.machanism.machai.ai.provider.Genai: Adds a user prompt to the current session.
prompt(String) - Method in class org.machanism.machai.ai.provider.GenaiAdapter
prompt(String) - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Appends the given text to the prompt buffer.
prompt(String) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Adds a text prompt to the current request input.
promptBundle(ResourceBundle) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
promptBundle(ResourceBundle) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Adds prompts from the provided ResourceBundle to the current request context.
provider - Variable in class org.machanism.machai.ai.provider.GenaiAdapter: Delegate provider.
Provider delegation - Search tag in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Section
Provider identifiers - Search tag in package org.machanism.machai.ai.manager: Section
Purpose and scope - Search tag in Overview: Section

R

replace(String, Configurator) - Method in interface org.machanism.machai.ai.tools.FunctionTools: Resolves ${...} placeholders using the provided configurator.
resolveWorkingDir(File, String) - Method in class org.machanism.machai.ai.tools.CommandFunctionTools: Resolves a working directory relative to a canonical project directory.

S

Security model - Search tag in class org.machanism.machai.ai.tools.CommandFunctionTools: Section
SERVERID_PROP_NAME - Static variable in interface org.machanism.machai.ai.provider.Genai: Configuration property name for the target GenAI server identifier.
setConfiguration(Configurator) - Method in class org.machanism.machai.ai.tools.FunctionToolsLoader: Supplies configuration to all discovered tool installers.
setConfigurator(Configurator) - Method in class org.machanism.machai.ai.tools.CommandFunctionTools
setConfigurator(Configurator) - Method in interface org.machanism.machai.ai.tools.FunctionTools: Provides a configurator instance to the tool set.
setConfigurator(Configurator) - Method in class org.machanism.machai.ai.tools.WebFunctionTools: Supplies configuration for resolving header placeholders.
setProvider(Genai) - Method in class org.machanism.machai.ai.provider.GenaiAdapter: Sets the delegate provider.
setTimeout(long) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Sets a request timeout (in seconds) for new clients created by this provider.
setWorkingDir(File) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
setWorkingDir(File) - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Sets the working directory used for file resolution or other provider operations.
setWorkingDir(File) - Method in interface org.machanism.machai.ai.provider.Genai: Configures the working directory used for file and tool operations.
setWorkingDir(File) - Method in class org.machanism.machai.ai.provider.GenaiAdapter
setWorkingDir(File) - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Configures the working directory.
setWorkingDir(File) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Sets the working directory passed to tool handlers.
Status - Search tag in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Section
Supported behavior - Search tag in package org.machanism.machai.ai.provider.none: Section
Supported model routing - Search tag in package org.machanism.machai.ai.provider.codemie: Section

T

terminateProcess(Object[]) - Method in class org.machanism.machai.ai.tools.CommandFunctionTools: Implements the terminate_process tool.
ToolFunction - Interface in org.machanism.machai.ai.tools: Functional interface representing a tool callable by a provider during a run.
Typical usage - Search tag in interface org.machanism.machai.ai.provider.Genai: Section
Typical usage - Search tag in package org.machanism.machai.ai.manager: Section
Typical usage - Search tag in package org.machanism.machai.ai.provider.openai: Section
Typical usage flow - Search tag in package org.machanism.machai.ai: Section
Typical workflow - Search tag in Overview: Section

U

Unsupported behavior - Search tag in package org.machanism.machai.ai.provider.none: Section
usage() - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
usage() - Method in class org.machanism.machai.ai.provider.gemini.GeminiProvider: Returns usage information (for example, token counts) for the last request.
usage() - Method in interface org.machanism.machai.ai.provider.Genai: Returns token usage metrics for the most recent Genai.perform() invocation.
usage() - Method in class org.machanism.machai.ai.provider.GenaiAdapter
usage() - Method in class org.machanism.machai.ai.provider.none.NoneProvider: Returns token usage metrics captured from the most recent NoneProvider.perform() call.
usage() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Returns token usage metrics captured from the most recent OpenAIProvider.perform() call.
Usage - Search tag in class org.machanism.machai.ai.manager.GenaiProviderManager: Section
Usage - Search tag in class org.machanism.machai.ai.tools.FunctionToolsLoader: Section
Usage - Class in org.machanism.machai.ai.manager: Token usage metrics for a single generative-AI invocation.
Usage(long, long, long) - Constructor for class org.machanism.machai.ai.manager.Usage: Creates a usage record.
Usage model - Search tag in package org.machanism.machai.ai.provider: Section
Usage notes - Search tag in package org.machanism.machai.ai.tools: Section
Usage overview - Search tag in package org.machanism.machai.ai.provider.gemini: Section
USERNAME_PROP_NAME - Static variable in interface org.machanism.machai.ai.provider.Genai: Environment variable name for authenticating with the GenAI provider.

W

waitAndCollect(Process, Future<?>, Future<?>, LimitedStringBuilder, String) - Method in class org.machanism.machai.ai.tools.CommandFunctionTools: Waits for the process to finish (up to CommandFunctionTools.processTimeoutSeconds) and then returns collected output.
WebFunctionTools - Class in org.machanism.machai.ai.tools: Installs HTTP retrieval tools into a Genai.
WebFunctionTools() - Constructor for class org.machanism.machai.ai.tools.WebFunctionTools

A B C D E F G H I K L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form