Index (GenAI Client 1.1.13-SNAPSHOT API)

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

A

AbstractAIProvider - Class in org.machanism.machai.ai.provider
AbstractAIProvider() - Constructor for class org.machanism.machai.ai.provider.AbstractAIProvider
addMcpServer() - Method in class org.machanism.machai.ai.provider.AbstractAIProvider
addMcpServer() - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
addMcpServer() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Adds one or more MCP server tools from configuration.
addTool(String, String, ToolFunction, String...) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider: Registers a function tool for the current provider instance.
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.openai.OpenAIProvider: Registers a function tool for the current provider instance.
addUsage(String, Usage) - Static method in class org.machanism.machai.ai.manager.UsageStatistics: Adds a single Usage record for a specific model identifier.
addWebSearch() - Method in class org.machanism.machai.ai.provider.AbstractAIProvider
addWebSearch() - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
addWebSearch() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Adds the built-in OpenAI web search tool when configured.
ANTHROPIC_API_KEY - Static variable in class org.machanism.machai.ai.provider.claude.ClaudeProvider
ANTHROPIC_BASE_URL - Static variable in class org.machanism.machai.ai.provider.claude.ClaudeProvider
apply(JsonNode, File) - Method in interface org.machanism.machai.ai.tools.ToolFunction: Executes the tool.
applyTools(Genai) - Method in interface org.machanism.machai.ai.tools.FunctionTools: Registers this tool set with the given provider.
applyTools(Genai, Configurator) - Method in class org.machanism.machai.ai.tools.FunctionToolsLoader: Applies all discovered FunctionTools installers to the given provider.
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 modes - Search tag in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Section

B

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

C

captureUsage(Optional<ResponseUsage>) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Extracts token usage from the response and stores it as AbstractAIProvider.usage().
chatModel - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Active model identifier used in Genai.perform().
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: Clears all accumulated inputs for the next request.
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.openai.OpenAIProvider: Clears all accumulated inputs for the next request.
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
config - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Configuration source used to initialize clients and provider features.
Configuration - Search tag in class org.machanism.machai.ai.provider.claude.ClaudeProvider: Section
Configuration - Search tag in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Section
Configuration and runtime behavior - Search tag in Overview: Section
Configuration overview - Search tag in package org.machanism.machai.ai.provider.openai: Section
Core abstractions - Search tag in package org.machanism.machai.ai.provider: Section

E

embedding(String, long) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider: Requests an embedding vector for the given input 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.openai.OpenAIProvider: Requests an embedding vector for the given input text.
embeddingModel - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Embedding model identifier used by Genai.embedding(String, long).
Example - Search tag in package org.machanism.machai.ai: Section
Example - Search tag in package org.machanism.machai.ai.manager: Section

F

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 Java's ServiceLoader mechanism.
FunctionToolsLoader() - Constructor for class org.machanism.machai.ai.tools.FunctionToolsLoader: Constructs a new FunctionToolsLoader and discovers available FunctionTools implementations using ServiceLoader.

G

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
getAllModelUsages() - Static method in class org.machanism.machai.ai.manager.UsageStatistics: Returns the aggregated usage map for all models.
getClient() - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider: Returns the underlying Anthropic client.
getClient() - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Returns the underlying OpenAI client.
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.
getOutputTokens() - Method in class org.machanism.machai.ai.manager.Usage: Returns the number of output tokens.
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.AbstractAIProvider: 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.
getUsageForModel(String) - Static method in class org.machanism.machai.ai.manager.UsageStatistics: Returns the aggregated usage list for a specific model.

I

Identifier handling - Search tag in package org.machanism.machai.ai.manager: Section
Included types - Search tag in package org.machanism.machai.ai.manager: Section
init(Configurator) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Initializes the provider from the given configuration.
init(Configurator) - Method in class org.machanism.machai.ai.provider.codemie.CodeMieProvider: Initializes the provider using configuration values.
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
inputs - Variable in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Accumulated request input items for the current conversation.
inputsLog(File) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Enables request input logging to the given 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
instructions - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Optional instructions applied to the request.
instructions(String) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Sets system-level instructions applied to 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
isRequiredParameter(String) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Determines whether the supplied parameter flag marks a required parameter.

L

lastUsage - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Latest usage metrics captured from the most recent Genai.perform() call.
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.
LOG_SECTION_SEPARATOR - Static variable in class org.machanism.machai.ai.provider.AbstractAIProvider
logger - Static variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Logger instance for this provider.
logger - Static variable in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Logger instance for this provider.
logInputs() - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Writes the current request inputs to AbstractAIProvider.inputsLog when logging is enabled.
logInputsSpec(Writer) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider
logInputsSpec(Writer) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider
logInputsSpec(Writer) - Method in class org.machanism.machai.ai.provider.openai.OpenAIProvider
logUsage() - Static method in class org.machanism.machai.ai.manager.UsageStatistics: Logs a summary of the aggregated Usage records (all models).
logUsageForModel(String) - Static method in class org.machanism.machai.ai.manager.UsageStatistics: Logs a summary of the aggregated Usage records for a specific model.

M

MAX_OUTPUT_TOKENS - Static variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Default maximum number of tokens the model may generate.
maxOutputTokens - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Maximum number of output tokens for responses.
maxToolCalls - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Maximum number of tool calls permitted per response.
MCP_PROP_NAME_PREFIX - Static variable in class org.machanism.machai.ai.provider.AbstractAIProvider

N

normalize(String) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Normalizes a string for case-insensitive comparisons.

O

OPENAI_API_KEY - Static variable in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Configuration/environment key used by OpenAI-compatible clients to provide the API key.
OPENAI_BASE_URL_NAME - Static variable in class org.machanism.machai.ai.provider.openai.OpenAIProvider
OpenAIProvider - Class in org.machanism.machai.ai.provider.openai: OpenAI-backed Genai implementation.
OpenAIProvider() - Constructor for class org.machanism.machai.ai.provider.openai.OpenAIProvider
org.machanism.machai.ai - package org.machanism.machai.ai: Provider-agnostic generative AI integration for MachAI.
org.machanism.machai.ai.manager - package org.machanism.machai.ai.manager: Provider resolution and usage tracking 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
org.machanism.machai.ai.provider.codemie - package org.machanism.machai.ai.provider.codemie: Provides CodeMie-backed AI provider integration for the MachAI application.
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: Provides the service-provider infrastructure for exposing host-defined functions as tools that can be registered with generative AI providers.

P

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.
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: Executes a request using the currently configured model and accumulated inputs.
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.openai.OpenAIProvider: Executes a request using the currently configured model, inputs, and tools.
Primary responsibilities - Search tag in package org.machanism.machai.ai.manager: Section
prompt(String) - Method in class org.machanism.machai.ai.provider.claude.ClaudeProvider: Adds a text prompt to the current request input.
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.openai.OpenAIProvider: Adds a text prompt to the current request input.
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 families - Search tag in package org.machanism.machai.ai.provider: Section
Purpose and scope - Search tag in Overview: Section

R

Relevant configuration properties - Search tag in package org.machanism.machai.ai.provider.codemie: Section
Responsibilities - Search tag in package org.machanism.machai.ai: Section

S

safelyInvokeTool(String, ToolFunction, JsonNode, File) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Safely invokes a tool function and converts IOExceptions into a textual error payload suitable for the model conversation.
SERVERID_PROP_NAME - Static variable in interface org.machanism.machai.ai.provider.Genai: Configuration property name for the target GenAI server identifier.
setConfigurator(Configurator) - Method in interface org.machanism.machai.ai.tools.FunctionTools: Provides a configurator instance to the tool set.
setProvider(Genai) - Method in class org.machanism.machai.ai.provider.GenaiAdapter: Sets the delegate provider.
setTimeout(long, OpenAIProvider) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Sets a request timeout in seconds for new clients created by this provider.
setWorkingDir(File) - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Sets the working directory passed to tool handlers.
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
Supported capabilities - Search tag in package org.machanism.machai.ai.provider.openai: Section
Supported responsibilities - Search tag in package org.machanism.machai.ai.provider.codemie: Section

T

timeoutSec - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Request timeout in seconds; 0 means SDK defaults are used.
ToolFunction - Interface in org.machanism.machai.ai.tools: Functional interface representing a tool callable by a provider during a run.
toolMap - Variable in class org.machanism.machai.ai.provider.openai.OpenAIProvider: Maps tools to handler functions.
Typical usage - Search tag in interface org.machanism.machai.ai.provider.Genai: Section
Typical usage - Search tag in package org.machanism.machai.ai.provider: Section
Typical usage - Search tag in package org.machanism.machai.ai.provider.openai: Section
Typical usage - Search tag in package org.machanism.machai.ai.tools: Section
Typical workflow - Search tag in Overview: Section
Typical workflow - Search tag in package org.machanism.machai.ai: Section

U

usage() - Method in class org.machanism.machai.ai.provider.AbstractAIProvider: Returns token usage metrics captured from the most recent Genai.perform() call.
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 - 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 notes - Search tag in Overview: Section
UsageStatistics - Class in org.machanism.machai.ai.manager: Manages and aggregates usage statistics for GenAI models.
UsageStatistics() - Constructor for class org.machanism.machai.ai.manager.UsageStatistics
USERNAME_PROP_NAME - Static variable in interface org.machanism.machai.ai.provider.Genai: Environment variable name for authenticating with the GenAI provider.

W

workingDir - Variable in class org.machanism.machai.ai.provider.AbstractAIProvider: Working directory passed to tool handlers as contextual information.

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