Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abbreviate(String) - Method in class org.machanism.machai.genai.provider.ToolLogger
-
Abbreviates long log strings to keep logs concise and clean.
- abbreviate(String) - Method in class org.machanism.machai.process.provider.ToolLogger
-
Abbreviates long log strings to keep logs concise and clean.
- AbstractAIProvider - Class in org.machanism.machai.genai.provider
-
Base implementation of the
ProcessProvidercontract shared by concrete provider integrations. - AbstractAIProvider - Class in org.machanism.machai.process.provider
-
Base implementation of the
ProcessProvidercontract shared by concrete provider integrations. - AbstractAIProvider() - Constructor for class org.machanism.machai.genai.provider.AbstractAIProvider
-
Creates a provider base instance.
- AbstractAIProvider() - Constructor for class org.machanism.machai.process.provider.AbstractAIProvider
-
Creates a provider base instance.
- addMcpServer(String, String, String, String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Registers one MCP server/tool with the underlying provider SDK.
- addMcpServer(String, String, String, String) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Registers an MCP server definition for future requests.
- addMcpServer(String, String, String, String) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Adds one or more MCP server tools from configuration.
- addMcpServer(String, String, String, String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Registers one MCP server/tool with the underlying provider SDK.
- addMcpServers() - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Reads sequential MCP server configuration groups and registers them with the concrete provider implementation.
- addMcpServers() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Reads sequential MCP server configuration groups and registers them with the concrete provider implementation.
- addPrompt(String, String, ToolFunction, Role, ParamDescriptor...) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Registers a prompt callback for providers that support prompt tools.
- addPrompt(String, String, ToolFunction, Role, ParamDescriptor...) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Registers a prompt callback for providers that support prompt tools.
- addPrompt(FunctionTools, Method, String, String, Role) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Configures and registers a single prompt method.
- addPrompt(FunctionTools, Method, String, String, Role) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Configures and registers a single prompt method.
- addPrompts(FunctionTools) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Registers all annotated prompt methods from the given
FunctionToolsinstance. - addPrompts(FunctionTools) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Registers all annotated prompt methods from the given
FunctionToolsinstance. - addPrompts(FunctionTools) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; no prompt tools are registered.
- addPrompts(FunctionTools) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Scans the provided
FunctionToolsinstance for methods annotated withPromptand registers each prompt for use during a run. - addPrompts(FunctionTools) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Scans the provided
FunctionToolsinstance for methods annotated withPromptand registers each prompt for use during a run. - addResource(URI, String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Registers a resource callback for providers that support resource management tools.
- addResource(URI, String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Registers a resource callback for providers that support resource management tools.
- addResource(FunctionTools, Method, String[], String, String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Resolves resource endpoints from declared arrays and binds them to the implementation context.
- addResource(FunctionTools, Method, String[], String, String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Resolves resource endpoints from declared arrays and binds them to the implementation context.
- addResources(FunctionTools) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Scans the provided
FunctionToolsinstance for methods annotated withResource, and registers each resource for use during a run. - addResources(FunctionTools) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Scans the provided
FunctionToolsinstance for methods annotated withResource, and registers each resource for use during a run. - addResources(FunctionTools) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; no resource tools are registered.
- addResources(FunctionTools) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Scans the provided
FunctionToolsinstance for methods annotated withResource, and registers each resource for use during a run. - addResources(FunctionTools) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Scans the provided
FunctionToolsinstance for methods annotated withResource, and registers each resource for use during a run. - addTool(String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Adds a tool to the provider.
- addTool(String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Registers a local function tool.
- addTool(String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Registers a function tool for the current provider instance.
- addTool(String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Adds a tool to the provider.
- addTool(String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.process.provider.ToolsProvider
-
Registers a tool function with the provider.
- addTool(FunctionTools, Method, String, String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Configures and registers a single tool method.
- addTool(FunctionTools, Method, String, String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Configures and registers a single tool method.
- addTools(FunctionTools, String[]) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Registers tool methods from the given
FunctionToolsinstance, filtering them based on an optional array of enabled tool patterns. - addTools(FunctionTools, String[]) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Registers tool methods from the given
FunctionToolsinstance, filtering them based on an optional array of enabled tool patterns. - addTools(FunctionTools, String[]) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; no function tools are registered.
- addTools(FunctionTools, String[]) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Registers the tools exposed by the given
FunctionToolsimplementation, optionally restricting registration to a filtered subset of tools. - addTools(FunctionTools, String[]) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Registers the tools exposed by the given
FunctionToolsimplementation, optionally restricting registration to a filtered subset of tools. - addUsage(String, Usage) - Static method in class org.machanism.machai.process.manager.UsageStatistics
-
Adds a single
Usagerecord for a specific model identifier. - addWebSearch() - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Registers a web-search capability when enabled in configuration.
- addWebSearch() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Registers a web-search capability when enabled in configuration.
- addWebSearch(String, String, String, String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Registers a provider-specific web-search tool.
- addWebSearch(String, String, String, String) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Registers a web search tool and optional location hints.
- addWebSearch(String, String, String, String) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Adds the built-in OpenAI web search tool when configured.
- addWebSearch(String, String, String, String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Registers a provider-specific web-search tool.
- ANTHROPIC_API_KEY - Static variable in class org.machanism.machai.genai.provider.AnthropicProvider
-
Configuration property name that contains the Anthropic API key or authorization token.
- ANTHROPIC_BASE_URL - Static variable in class org.machanism.machai.genai.provider.AnthropicProvider
-
Configuration property that overrides the Anthropic API base URL.
- AnthropicProvider - Class in org.machanism.machai.genai.provider
-
Anthropic-backed implementation of Machai's
ProcessProviderabstraction. - AnthropicProvider() - Constructor for class org.machanism.machai.genai.provider.AnthropicProvider
-
Creates an Anthropic provider instance.
- apply(JsonNode, Object...) - Method in interface org.machanism.machai.process.tools.ToolFunction
-
Executes the tool with the given parameters and variable context instances.
- applyTools(ProcessProvider, String[], Class<?>) - Method in class org.machanism.machai.process.tools.FunctionToolsLoader
-
Applies all discovered
FunctionToolsinstallers to the given provider, filtered by application class compatibility. - Architecture - Search tag in Overview
- Section
- ASSISTANT - Enum constant in enum org.machanism.machai.process.tools.Role
-
Represents the AI assistant or provider.
- AUTH_URL - Static variable in class org.machanism.machai.genai.provider.CodeMieProvider
-
Default OpenID Connect token endpoint for CodeMie.
- AUTH_URL_PROP_NAME - Static variable in class org.machanism.machai.genai.provider.CodeMieProvider
-
Configuration key used to override the default token endpoint.
- Authentication modes - Search tag in class org.machanism.machai.genai.provider.CodeMieProvider
- Section
B
- BASE_URL - Static variable in class org.machanism.machai.genai.provider.CodeMieProvider
-
Base URL for the CodeMie Code Assistant API.
- Behavior Summary: - Search tag in org.machanism.machai.genai.provider.AbstractAIProvider.setErrorHandling(boolean)
- Section
- Behavior Summary: - Search tag in org.machanism.machai.process.provider.AbstractAIProvider.setErrorHandling(boolean)
- Section
- BOOLEAN_TYPE - Static variable in class org.machanism.machai.genai.provider.TypeConverter
- BOOLEAN_TYPE - Static variable in class org.machanism.machai.process.provider.TypeConverter
C
- call(MessageCreateParams) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Submits a request to the Anthropic Beta Messages API and records its token usage.
- call(ResponseCreateParams) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Submits a Responses API request and records any usage reported by OpenAI.
- CALL_MSG - Static variable in class org.machanism.machai.genai.provider.ToolLogger
-
Format used when a tool is invoked.
- CALL_MSG - Static variable in class org.machanism.machai.process.provider.ToolLogger
-
Format used when a tool is invoked.
- callFunction(BetaToolUseBlock) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Locates and invokes the locally registered handler for an Anthropic tool invocation.
- callFunction(ResponseFunctionToolCall) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Executes a function tool call by finding a registered tool with the same name and delegating to its handler.
- Capability declarations - Search tag in package org.machanism.machai.process.tools
- Section
- captureUsage(BetaMessage) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Captures token usage and updates global usage statistics.
- captureUsage(Optional<ResponseUsage>) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Captures and records usage statistics from an optional
ResponseUsageinstance. - chatModel - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Active model identifier used in
ProcessProvider.perform(). - CLAUDE_COMPATIBLE_MODELS_PREFIXES - Static variable in class org.machanism.machai.genai.provider.CodeMieProvider
-
Model prefixes delegated to the Anthropic-compatible provider.
- ClaudeProviderExtension(String, String, String) - Constructor for class org.machanism.machai.genai.provider.CodeMieProvider.ClaudeProviderExtension
-
Creates an Anthropic extension with the credentials used for token refresh.
- clear() - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Clears the provider state.
- clear() - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Clears accumulated conversation inputs.
- clear() - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Clears all accumulated inputs for the next request.
- clear() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Clears the provider state.
- clear() - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing because this provider does not retain prompts or other request state.
- clear() - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Clears any stored files and session/provider state.
- clear() - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Clears any stored files and session/provider state.
- CodeMieProvider - Class in org.machanism.machai.genai.provider
-
ProcessProviderimplementation that integrates with EPAM CodeMie. - CodeMieProvider() - Constructor for class org.machanism.machai.genai.provider.CodeMieProvider
-
Creates a CodeMie provider instance.
- CodeMieProvider.ClaudeProviderExtension - Class in org.machanism.machai.genai.provider
-
Anthropic provider extension that refreshes the CodeMie access token.
- CodeMieProvider.OpenAIProviderExtension - Class in org.machanism.machai.genai.provider
-
OpenAI provider extension that refreshes the CodeMie access token.
- Common lifecycle - Search tag in package org.machanism.machai.genai.provider
- Section
- config - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Configuration source used to initialize clients and provider features.
- config - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Configuration source used to initialize clients and provider features.
- Configuration - Search tag in class org.machanism.machai.genai.provider.OpenAIProvider
- Section
- Configuration and boundaries - Search tag in package org.machanism.machai.genai.provider
- Section
- convert(Parameter, String) - Static method in class org.machanism.machai.genai.provider.TypeConverter
- convert(Parameter, String) - Static method in class org.machanism.machai.process.provider.TypeConverter
- convertMap(Parameter, String) - Static method in class org.machanism.machai.genai.provider.TypeConverter
- convertMap(Parameter, String) - Static method in class org.machanism.machai.process.provider.TypeConverter
- convertObject(Class<?>, String) - Static method in class org.machanism.machai.genai.provider.TypeConverter
- convertObject(Class<?>, String) - Static method in class org.machanism.machai.process.provider.TypeConverter
- convertToType(Parameter, String) - Static method in class org.machanism.machai.genai.provider.TypeConverter
-
Converts an input value to the type declared by a reflected tool parameter.
- convertToType(Parameter, String) - Static method in class org.machanism.machai.process.provider.TypeConverter
-
Converts an input value to the type declared by a reflected tool parameter.
- createResponseBuilder(List<BetaMessageParam>) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Builds a Messages API request from the current conversation and provider configuration, including registered local tools, MCP servers, and web search when configured.
- createResponseBuilder(List<ResponseInputItem>) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Builds the request parameters for the OpenAI Responses API.
- createTypeMap() - Static method in class org.machanism.machai.genai.provider.TypeConverter
- createTypeMap() - Static method in class org.machanism.machai.process.provider.TypeConverter
D
- DEFAULT_WEBSEARCH_TYPE_NAME - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Default web search type name.
- DEFAULT_WEBSEARCH_TYPE_NAME - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Default web search type name.
- defaultValue - Variable in class org.machanism.machai.process.tools.ParamDescriptor
-
Default value supplied when the corresponding parameter is omitted.
- defaultValue() - Element in annotation type org.machanism.machai.process.tools.Param
-
Optional default value for the parameter.
- description - Variable in class org.machanism.machai.process.tools.ParamDescriptor
-
Description of the parameter's purpose or usage.
- description() - Element in annotation type org.machanism.machai.process.tools.Param
-
Description of the parameter's purpose and usage.
- description() - Element in annotation type org.machanism.machai.process.tools.Prompt
-
Description of the prompt's purpose and content.
- description() - Element in annotation type org.machanism.machai.process.tools.Resource
-
Description of the resource's purpose, structure, or content.
- description() - Element in annotation type org.machanism.machai.process.tools.Tool
-
Description of the tool's purpose and functionality.
- Discovery and registration - Search tag in package org.machanism.machai.process.tools
- Section
E
- embedding(String, long) - Method in class org.machanism.machai.genai.provider.CodeMieProvider
-
Requests an embedding vector for the given input text.
- embedding(String, long) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Requests an embedding vector for the given input text.
- embedding(String, long) - Method in interface org.machanism.machai.process.provider.EmbeddingProvider
-
Computes an embedding vector for the provided text.
- EmbeddingProvider - Interface in org.machanism.machai.process.provider
-
EmbeddingProvider defines the contract for AI embedding providers.
- ERROR_MSG - Static variable in class org.machanism.machai.genai.provider.ToolLogger
-
Format used when a tool invocation fails.
- ERROR_MSG - Static variable in class org.machanism.machai.process.provider.ToolLogger
-
Format used when a tool invocation fails.
- ERROR_TOOL_RESULT_PREFIX - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Prefix prepended to tool invocation error messages that are returned back to the LLM.
- ERROR_TOOL_RESULT_PREFIX - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Prefix prepended to tool invocation error messages that are returned back to the LLM.
- errorHandling - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Flag indicating if standard runtime exceptions should be wrapped or handled conversationally.
- errorHandling - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Flag indicating if standard runtime exceptions should be wrapped or handled conversationally.
- ErrorResultException - Exception Class in org.machanism.machai.process.tools
-
A runtime exception used to signal a tool or processing error, with a structured error payload that is serialized to JSON and included in the exception message.
- ErrorResultException(Object) - Constructor for exception class org.machanism.machai.process.tools.ErrorResultException
-
Creates a new exception with a message that is the JSON representation of the given object.
- ErrorResultException(Object, Exception) - Constructor for exception class org.machanism.machai.process.tools.ErrorResultException
-
Creates a new exception with a message that is the JSON representation of the given object, combined with additional error details from another exception.
- ErrorResultException(String) - Constructor for exception class org.machanism.machai.process.tools.ErrorResultException
-
Creates a new exception using the given string directly as the message, without JSON serialization.
- Example - Search tag in package org.machanism.machai.process.manager
- Section
- Example - Search tag in package org.machanism.machai.process.tools
- Section
- excludes() - Element in annotation type org.machanism.machai.process.tools.SupportedFor
- Execution and failure handling - Search tag in package org.machanism.machai.process.tools
- Section
- extractMessageText(ResponseOutputItem) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Extracts text content from a message output item.
- extractReasoningText(ResponseOutputItem) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Extracts reasoning text from a response output item when present.
F
- fillParamDesc(Method) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Analyzes method signature annotations to build an array of parameter descriptions.
- fillParamDesc(Method) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Analyzes method signature annotations to build an array of parameter descriptions.
- firstNonBlankReasoning(List<ResponseReasoningItem.Content>) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Returns the first non-blank reasoning fragment.
- functionTools - Variable in class org.machanism.machai.process.tools.FunctionToolsLoader
-
List of discovered
FunctionToolsinstances, loaded from the classpath. - FunctionTools - Interface in org.machanism.machai.process.tools
-
Service-provider interface (SPI) for installing host-provided function tools.
- FunctionToolsLoader - Class in org.machanism.machai.process.tools
-
Discovers and applies
FunctionToolsimplementations using Java'sServiceLoadermechanism. - FunctionToolsLoader() - Constructor for class org.machanism.machai.process.tools.FunctionToolsLoader
-
Constructs a new
FunctionToolsLoaderand discovers availableFunctionToolsimplementations usingServiceLoader.
G
- GenAI Client - Search tag in Overview
- Section
- get(Class<?>) - Static method in class org.machanism.machai.genai.provider.TypeConverter
-
Returns the simplified schema type for the supplied Java type.
- get(Class<?>) - Static method in class org.machanism.machai.process.provider.TypeConverter
-
Returns the simplified schema type for the supplied Java type.
- getAllModelUsages() - Static method in class org.machanism.machai.process.manager.UsageStatistics
-
Returns the aggregated usage map for all models.
- getClient() - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Creates and configures an Anthropic client.
- getClient() - Method in class org.machanism.machai.genai.provider.CodeMieProvider.ClaudeProviderExtension
-
Refreshes the access token and creates the configured Anthropic client.
- getClient() - Method in class org.machanism.machai.genai.provider.CodeMieProvider.OpenAIProviderExtension
-
Refreshes the access token and creates the configured OpenAI client.
- getClient() - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Returns the underlying OpenAI client.
- getConfigurator() - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Returns the configurator context source.
- getConfigurator() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Returns the configurator context source.
- getDefaultValue() - Method in class org.machanism.machai.process.tools.ParamDescriptor
-
Returns the configured default value, translating the
Param.NULLandParam.NOT_DEFINEDsentinel values tonull. - getDescription() - Method in class org.machanism.machai.process.tools.ParamDescriptor
-
Returns a description of the parameter's purpose or usage.
- getEmbeddingProvider(String, Configurator) - Static method in class org.machanism.machai.process.manager.ProcessProviderManager
-
Dynamically loads and initializes an
EmbeddingProviderbased on the specified provider/model string. - getInputCachedTokens() - Method in class org.machanism.machai.process.manager.Usage
-
Returns the number of cached input tokens reported by the provider.
- getInputTokens() - Method in class org.machanism.machai.process.manager.Usage
-
Returns the number of input tokens consumed by the request.
- getInstructions() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- getMapValueType(Parameter) - Static method in class org.machanism.machai.genai.provider.TypeConverter
- getMapValueType(Parameter) - Static method in class org.machanism.machai.process.provider.TypeConverter
- getMaxOutputTokens() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- getMaxToolCalls() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- getModel() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- getName() - Method in class org.machanism.machai.process.tools.ParamDescriptor
-
Returns the parameter's name.
- getOutputTokens() - Method in class org.machanism.machai.process.manager.Usage
-
Returns the number of output tokens generated by the response.
- getParamByType(Class<T>, Object[]) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Filters parameter arrays to find the first assignment-compatible instance of the specified type.
- getParamByType(Class<T>, Object[]) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Filters parameter arrays to find the first assignment-compatible instance of the specified type.
- getParamValue(JsonNode, String, String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Retrieves the value for a parameter from the given JSON node, or returns the default value if not present.
- getParamValue(JsonNode, String, String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Retrieves the value for a parameter from the given JSON node, or returns the default value if not present.
- getProjectDir() - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Returns the current project directory.
- getProjectDir() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Returns the current project directory.
- getProvider(String, Configurator) - Static method in class org.machanism.machai.process.manager.ProcessProviderManager
-
Dynamically loads and initializes a
ProcessProviderprovider based on the specified provider/model string. - getTimeout() - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Returns the configured request timeout.
- getTimeout() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Returns the configured request timeout.
- getToken(String, String, String) - Static method in class org.machanism.machai.genai.provider.CodeMieProvider
-
Requests an OAuth 2.0 access token from the given token endpoint.
- getToolNames() - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Returns the names of locally registered Anthropic tools.
- getToolNames() - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Returns the names of function tools registered with this provider.
- getToolNames() - Method in class org.machanism.machai.process.provider.NoneProvider
-
Returns the empty tool-name list because this provider never registers tools.
- getToolNames() - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Returns the names of tools currently registered with the provider.
- getToolNames() - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
- getToolNames() - Method in class org.machanism.machai.process.provider.ToolsProvider
-
Returns the names of tools currently registered with this provider.
- getType() - Method in class org.machanism.machai.process.tools.ParamDescriptor
-
Returns the parameter's data type.
- getUsageForModel(String) - Static method in class org.machanism.machai.process.manager.UsageStatistics
-
Returns the aggregated usage entries for a specific model.
H
- handleFunctionCall(BetaToolUseBlock) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Adds a received tool-use block to the conversation, invokes its local handler, and appends the corresponding tool-result user message.
- handleFunctionCall(ResponseFunctionToolCall) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Records a function call in the conversation, executes it, and appends the resulting function output item.
I
- Implementations and relationships - Search tag in package org.machanism.machai.genai.provider
- Section
- Included implementations - Search tag in package org.machanism.machai.process.provider
- Section
- init() - Static method in class org.machanism.machai.process.manager.UsageStatistics
-
Initializes the usage statistics module.
- init(String, Configurator) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Initializes the provider from the given configuration.
- init(String, Configurator) - Method in class org.machanism.machai.genai.provider.CodeMieProvider
-
Initializes the provider using configuration values.
- init(String, Configurator) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Initializes the provider from the given configuration.
- init(String, Configurator) - Method in interface org.machanism.machai.process.provider.EmbeddingProvider
-
Initializes the provider with application configuration.
- init(String, Configurator) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; the given model and configurator are discarded.
- init(String, Configurator) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Initializes the provider with application configuration.
- init(String, Configurator) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Initializes the provider with application configuration.
- inputCachedTokens - Variable in class org.machanism.machai.process.manager.Usage
-
Number of cached input tokens reported by the provider.
- inputs - Variable in class org.machanism.machai.genai.provider.AnthropicProvider
-
Accumulated Anthropic message inputs for the current conversation.
- inputs - Variable in class org.machanism.machai.genai.provider.OpenAIProvider
-
Accumulated request input items for the current conversation.
- inputTokens - Variable in class org.machanism.machai.process.manager.Usage
-
Number of input or prompt tokens consumed by the request.
- instructions - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Optional instructions applied to the request.
- instructions - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Optional instructions applied to the request.
- instructions(String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Sets system-level instructions applied to subsequent requests.
- instructions(String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Sets system-level instructions applied to subsequent requests.
- instructions(String) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; the given instructions are discarded.
- instructions(String) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Sets system/session instructions for the current conversation.
- instructions(String) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Sets system/session instructions for the current conversation.
- interpolateDescription(String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Interpolates system metadata variables (e.g., OS Name) inside the annotation's tool description text before registering it with the LLM.
- interpolateDescription(String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Interpolates system metadata variables (e.g., OS Name) inside the annotation's tool description text before registering it with the LLM.
- invoke(FunctionTools, Method, JsonNode, Object...) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Dynamically invokes the specified method on the given tools instance, matching arguments dynamically.
- invoke(FunctionTools, Method, JsonNode, Object...) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Dynamically invokes the specified method on the given tools instance, matching arguments dynamically.
- isErrorHandling() - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Returns whether runtime tool errors are handled conversationally.
- isErrorHandling() - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Returns whether runtime tool errors are handled conversationally.
- isRequired() - Method in class org.machanism.machai.process.tools.ParamDescriptor
-
Indicates whether the parameter is required.
- isSupportedFor(Class<?>, Class<? extends FunctionTools>) - Method in class org.machanism.machai.process.tools.FunctionToolsLoader
-
Checks whether the given
FunctionToolsimplementation supports assignment to the specified application class. - isUndefined(String) - Static method in class org.machanism.machai.genai.provider.TypeConverter
- isUndefined(String) - Static method in class org.machanism.machai.process.provider.TypeConverter
L
- LINE_SEPARATOR - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Line separator used when composing prompts.
- LINE_SEPARATOR - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Line separator used when composing prompts.
- loadLegacyServiceDescriptor() - Method in class org.machanism.machai.process.tools.FunctionToolsLoader
- LOG_LINE_LENG - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Maximum length for log lines.
- LOG_LINE_LENG - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Maximum length for log lines.
- logError(String, File, Throwable) - Method in class org.machanism.machai.genai.provider.ToolLogger
-
Logs errors that occurred during tool method execution.
- logError(String, File, Throwable) - Method in class org.machanism.machai.process.provider.ToolLogger
-
Logs errors that occurred during tool method execution.
- logger - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Logger instance for this provider.
- logger - Static variable in class org.machanism.machai.genai.provider.AnthropicProvider
-
Logger used for provider diagnostics and request lifecycle messages.
- logger - Static variable in class org.machanism.machai.genai.provider.CodeMieProvider
-
Logger used for authentication and provider-delegation diagnostics.
- logger - Static variable in class org.machanism.machai.genai.provider.OpenAIProvider
-
Logger instance for this provider.
- logger - Static variable in class org.machanism.machai.genai.provider.ToolLogger
-
Logger used to write tool execution messages.
- logger - Static variable in class org.machanism.machai.process.manager.UsageStatistics
-
Logger used for reporting aggregated token usage.
- logger - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Logger instance for this provider.
- logger - Static variable in class org.machanism.machai.process.provider.NoneProvider
-
Logger used when diagnostic logging is enabled with the
logmodel. - logger - Static variable in class org.machanism.machai.process.provider.ToolLogger
-
Logger used to write tool execution messages.
- logger - Static variable in class org.machanism.machai.process.provider.ToolsProvider
-
Logger instance for this provider.
- logger - Static variable in class org.machanism.machai.process.tools.FunctionToolsLoader
-
Logger for debug output during tool discovery and application.
- loggingOn - Variable in class org.machanism.machai.process.provider.NoneProvider
-
Whether provider calls should be logged at INFO level.
- logInput(String, JsonNode, File) - Method in class org.machanism.machai.genai.provider.ToolLogger
-
Logs tool invocation input details.
- logInput(String, JsonNode, File) - Method in class org.machanism.machai.process.provider.ToolLogger
-
Logs tool invocation input details.
- logResult(String, File, Object) - Method in class org.machanism.machai.genai.provider.ToolLogger
-
Logs tool invocation execution results.
- logResult(String, File, Object) - Method in class org.machanism.machai.process.provider.ToolLogger
-
Logs tool invocation execution results.
- logUsage() - Static method in class org.machanism.machai.process.manager.UsageStatistics
-
Logs usage summaries for every model currently present in the registry.
- logUsageForModel(String) - Static method in class org.machanism.machai.process.manager.UsageStatistics
-
Logs a summary of the aggregated
Usagerecords for a specific model.
M
- MAPPER - Static variable in class org.machanism.machai.genai.provider.TypeConverter
- MAPPER - Static variable in class org.machanism.machai.process.provider.TypeConverter
- MAX_OUTPUT_TOKENS - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Default maximum number of tokens the model may generate.
- MAX_OUTPUT_TOKENS - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Default maximum number of tokens the model may generate.
- maxOutputTokens - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Maximum number of output tokens for responses.
- maxOutputTokens - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Maximum number of output tokens for responses.
- maxToolCalls - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Maximum number of tool calls permitted per response.
- maxToolCalls - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Maximum number of tool calls permitted per response.
- MCP_PROP_NAME_PREFIX - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Prefix for MCP property names.
- MCP_PROP_NAME_PREFIX - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Prefix for MCP property names.
- mcpServers - Variable in class org.machanism.machai.genai.provider.AnthropicProvider
-
MCP server definitions forwarded to Anthropic with each request.
- message(Object, Exception) - Static method in exception class org.machanism.machai.process.tools.ErrorResultException
-
Constructs a detailed error message by combining the provided message object and exception details.
- mimeType() - Element in annotation type org.machanism.machai.process.tools.Resource
-
The MIME type of the resource content.
- model - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Active model identifier used in
ProcessProvider.perform(). - modelUsages - Static variable in class org.machanism.machai.process.manager.UsageStatistics
-
In-memory registry of usage entries grouped by model identifier.
N
- name - Variable in class org.machanism.machai.process.tools.ParamDescriptor
-
The parameter's name.
- name() - Element in annotation type org.machanism.machai.process.tools.Param
-
Optional parameter name.
- name() - Element in annotation type org.machanism.machai.process.tools.Prompt
-
Optional prompt name.
- name() - Element in annotation type org.machanism.machai.process.tools.Tool
-
Optional tool name.
- NoneProvider - Class in org.machanism.machai.process.provider
-
No-op implementation of
ProcessProviderthat performs no AI processing. - NoneProvider() - Constructor for class org.machanism.machai.process.provider.NoneProvider
- normalize(String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Normalizes a string for case-insensitive comparisons.
- normalize(String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Normalizes a string for case-insensitive comparisons.
- NOT_DEFINED - Static variable in annotation type org.machanism.machai.process.tools.Param
-
Placeholder value indicating that the parameter name or default value is not defined.
- NOT_DEFINED - Static variable in annotation type org.machanism.machai.process.tools.Prompt
-
Placeholder value indicating that the prompt name is not defined.
- NOT_DEFINED - Static variable in annotation type org.machanism.machai.process.tools.Resource
-
Placeholder value indicating that a property is not defined.
- NOT_DEFINED - Static variable in annotation type org.machanism.machai.process.tools.Tool
-
Placeholder value indicating that the tool name is not defined.
- NULL - Static variable in annotation type org.machanism.machai.process.tools.Param
-
Placeholder value indicating a null parameter value.
O
- OBJECT_TYPE - Static variable in class org.machanism.machai.genai.provider.TypeConverter
- OBJECT_TYPE - Static variable in class org.machanism.machai.process.provider.TypeConverter
- OPENAI_API_KEY - Static variable in class org.machanism.machai.genai.provider.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.genai.provider.OpenAIProvider
-
Configuration/environment key used to override the OpenAI-compatible base URL.
- OPENAI_COMPATIBLE_MODELS_PREFIXES - Static variable in class org.machanism.machai.genai.provider.CodeMieProvider
-
Model prefixes delegated to the OpenAI-compatible provider.
- OpenAIProvider - Class in org.machanism.machai.genai.provider
-
OpenAI-backed
ProcessProviderimplementation. - OpenAIProvider() - Constructor for class org.machanism.machai.genai.provider.OpenAIProvider
-
Creates an OpenAI provider instance.
- OpenAIProviderExtension(String, String, String) - Constructor for class org.machanism.machai.genai.provider.CodeMieProvider.OpenAIProviderExtension
-
Creates an OpenAI extension with the credentials used for token refresh.
- org.machanism.machai.genai.provider - package org.machanism.machai.genai.provider
-
Concrete generative-AI provider implementations and supporting utilities used by Machai.
- org.machanism.machai.process.manager - package org.machanism.machai.process.manager
-
Provides provider factories and process-local token-usage reporting for generative-AI integrations.
- org.machanism.machai.process.provider - package org.machanism.machai.process.provider
-
Provider contracts, reusable lifecycle infrastructure, and local dispatch implementations for Machai process integrations.
- org.machanism.machai.process.tools - package org.machanism.machai.process.tools
-
Declares the provider-neutral metadata and execution contracts used to expose application methods as tools, prompts, and resources.
- outputTokens - Variable in class org.machanism.machai.process.manager.Usage
-
Number of output or completion tokens produced by the request.
P
- Packages - Search tag in Overview
- Section
- PARAGRAPH_SEPARATOR - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Paragraph separator used when composing prompts.
- PARAGRAPH_SEPARATOR - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Paragraph separator used when composing prompts.
- Param - Annotation Type in org.machanism.machai.process.tools
- ParamDescriptor - Class in org.machanism.machai.process.tools
-
Descriptor for a parameter used in tool or prompt definitions within the AI provider framework.
- ParamDescriptor(String, String, boolean, String, Object) - Constructor for class org.machanism.machai.process.tools.ParamDescriptor
-
Constructs a new
ParamDescriptorwith the specified properties. - parseResponse(BetaMessage) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Converts an Anthropic response into text, executing local tool calls and recursively submitting their results until no tool call remains.
- parseResponse(Response) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Parses the given response and handles function tool calls.
- password - Variable in class org.machanism.machai.genai.provider.CodeMieProvider.ClaudeProviderExtension
-
Password or client secret supplied to the token endpoint.
- password - Variable in class org.machanism.machai.genai.provider.CodeMieProvider.OpenAIProviderExtension
-
Password or client secret supplied to the token endpoint.
- PASSWORD_PROP_NAME - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Environment variable name for authenticating with the GenAI provider.
- PASSWORD_PROP_NAME - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Environment variable name for authenticating with the GenAI provider.
- perform() - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Sends the accumulated conversation and returns the final text response.
- perform() - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Executes a request using the currently configured model, inputs, and tools.
- perform() - Method in class org.machanism.machai.process.provider.NoneProvider
-
Performs no AI processing.
- perform() - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Executes the provider to produce a response based on the accumulated prompts, instructions, files, and registered capabilities.
- perform() - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Executes the provider to produce a response based on the accumulated prompts, instructions, files, and registered capabilities.
- perform() - Method in class org.machanism.machai.process.provider.ToolsProvider
-
Executes the provider's perform logic.
- primitiveTypeMapping(Class<?>) - Static method in class org.machanism.machai.genai.provider.TypeConverter
- primitiveTypeMapping(Class<?>) - Static method in class org.machanism.machai.process.provider.TypeConverter
- PROCESS_PROVIDER_CLASS_NAME_PATTERNS - Static variable in class org.machanism.machai.process.manager.ProcessProviderManager
-
Format used to derive the conventional fully qualified provider class name from a provider identifier.
- ProcessProvider - Interface in org.machanism.machai.process.provider
-
Contract for a generative-AI provider integration.
- ProcessProviderAdapter - Class in org.machanism.machai.process.provider
-
Delegating
ProcessProviderimplementation. - ProcessProviderAdapter() - Constructor for class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Creates an adapter without a delegate.
- ProcessProviderManager - Class in org.machanism.machai.process.manager
-
Utility class for dynamically loading and initializing generative AI providers and embedding providers.
- ProcessProviderManager() - Constructor for class org.machanism.machai.process.manager.ProcessProviderManager
-
Private constructor to prevent instantiation of this utility class.
- PROJECT_DIR_PARAM_NAME - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Name of the project directory parameter.
- PROJECT_DIR_PARAM_NAME - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Name of the project directory parameter.
- projectDir - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Working directory passed to tool handlers as contextual information.
- projectDir - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Working directory passed to tool handlers as contextual information.
- prompt(String) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Sets the prompt text for the provider.
- prompt(String) - Method in class org.machanism.machai.genai.provider.AnthropicProvider
-
Adds a non-blank user prompt.
- prompt(String) - Method in class org.machanism.machai.genai.provider.OpenAIProvider
-
Adds a text prompt to the current request input.
- prompt(String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Sets the prompt text for the provider.
- prompt(String) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; the given prompt text is discarded.
- prompt(String) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Adds a user prompt to the current session.
- prompt(String) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Adds a user prompt to the current session.
- prompt(String) - Method in class org.machanism.machai.process.provider.ToolsProvider
-
Adds a prompt text to the provider's prompt list.
- Prompt - Annotation Type in org.machanism.machai.process.tools
-
Annotation to mark a method as a prompt within the AI provider framework.
- PROMPT - Enum constant in enum org.machanism.machai.genai.provider.ToolLogger.Type
-
Indicates the logged operation is related to prompt template processing or construction.
- PROMPT - Enum constant in enum org.machanism.machai.process.provider.ToolLogger.Type
-
Indicates the logged operation is related to prompt template processing or construction.
- prompts - Variable in class org.machanism.machai.process.provider.ToolsProvider
-
List of collected prompt texts.
- provider - Variable in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Delegate provider.
- Provider contracts and decorators - Search tag in package org.machanism.machai.process.provider
- Section
- Provider creation - Search tag in package org.machanism.machai.process.manager
- Section
- Provider delegation - Search tag in class org.machanism.machai.genai.provider.CodeMieProvider
- Section
- Provider Naming Convention - Search tag in class org.machanism.machai.process.manager.ProcessProviderManager
- Section
R
- required - Variable in class org.machanism.machai.process.tools.ParamDescriptor
-
Indicates whether the parameter is required.
- resolveClass(String) - Static method in class org.machanism.machai.process.manager.ProcessProviderManager
-
Resolves the provider class name based on the provider name and a conventional naming pattern.
- resolveClassName(String) - Static method in class org.machanism.machai.process.manager.ProcessProviderManager
-
Resolves the textual class name for a provider.
- resolvedAuthUrl - Variable in class org.machanism.machai.genai.provider.CodeMieProvider.ClaudeProviderExtension
-
Token endpoint used to obtain the access token.
- resolvedAuthUrl - Variable in class org.machanism.machai.genai.provider.CodeMieProvider.OpenAIProviderExtension
-
Token endpoint used to obtain the access token.
- Resource - Annotation Type in org.machanism.machai.process.tools
-
Annotation used to declare a method as an executable resource provider within the generative-AI tools system.
- RESOURCE - Enum constant in enum org.machanism.machai.genai.provider.ToolLogger.Type
-
Indicates the logged operation involves accessing or processing an external resource.
- RESOURCE - Enum constant in enum org.machanism.machai.process.provider.ToolLogger.Type
-
Indicates the logged operation involves accessing or processing an external resource.
- RETURNS_MSG - Static variable in class org.machanism.machai.genai.provider.ToolLogger
-
Format used when a tool returns a result.
- RETURNS_MSG - Static variable in class org.machanism.machai.process.provider.ToolLogger
-
Format used when a tool returns a result.
- role() - Element in annotation type org.machanism.machai.process.tools.Prompt
-
The participant role associated with the prompt.
- Role - Enum in org.machanism.machai.process.tools
-
Enumeration representing participant roles in an AI interaction context.
- Role() - Constructor for enum org.machanism.machai.process.tools.Role
S
- safelyInvokeTool(String, ToolFunction, JsonNode, File) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Safely invokes a tool function and converts
IOExceptions into a textual error payload suitable for the model conversation. - safelyInvokeTool(String, ToolFunction, JsonNode, File) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Safely invokes a tool function and converts
IOExceptions into a textual error payload suitable for the model conversation. - serialVersionUID - Static variable in exception class org.machanism.machai.process.tools.ErrorResultException
-
Serialization version for compatibility with previously serialized exception instances.
- serialVersionUID - Static variable in exception class org.machanism.machai.process.tools.SpecialException
-
Serialization version for compatibility with previously serialized exception instances.
- serialVersionUID - Static variable in exception class org.machanism.machai.process.tools.ToolExecutionException
-
Serialization version for compatibility with previously serialized exception instances.
- SESSION_ID_PARAM_NAME - Static variable in interface org.machanism.machai.process.tools.ToolFunction
-
Standard parameter name for session identification in tool requests.
- setDefaultValue(Object) - Method in class org.machanism.machai.process.tools.ParamDescriptor
-
Sets the value used when the corresponding parameter is omitted.
- setErrorHandling(boolean) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Configures how runtime tool errors are handled by the invocation logic.
- setErrorHandling(boolean) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Configures how runtime tool errors are handled by the invocation logic.
- setErrorHandling(boolean) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; the given error-handling flag is discarded.
- setErrorHandling(boolean) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Configures whether tool invocation errors should be returned to the model for conversational recovery or propagated as exceptions.
- setErrorHandling(boolean) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Configures whether tool invocation errors should be returned to the model for conversational recovery or propagated as exceptions.
- setInstructions(String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- setMaxOutputTokens(Long) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- setMaxToolCalls(Long) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- setModel(String) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
- setProjectDir(File) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Sets the project directory.
- setProjectDir(File) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Sets the project directory.
- setProjectDir(File) - Method in class org.machanism.machai.process.provider.NoneProvider
-
Does nothing; the given project directory is discarded.
- setProjectDir(File) - Method in interface org.machanism.machai.process.provider.ProcessProvider
-
Sets the working directory for the provider, which may be supplied to tool, prompt, and resource handlers.
- setProjectDir(File) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Sets the working directory for the provider, which may be supplied to tool, prompt, and resource handlers.
- setProvider(ProcessProvider) - Method in class org.machanism.machai.process.provider.ProcessProviderAdapter
-
Sets the delegate provider.
- setTimeout(long) - Method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Sets the timeout value used by provider client creation.
- setTimeout(long) - Method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Sets the timeout value used by provider client creation.
- SpecialException - Exception Class in org.machanism.machai.process.tools
-
Exception used to signal the end of a task without terminating the application.
- SpecialException() - Constructor for exception class org.machanism.machai.process.tools.SpecialException
-
Constructs a
SpecialExceptionwithout a detail message or cause. - SpecialException(Exception) - Constructor for exception class org.machanism.machai.process.tools.SpecialException
-
Constructs a new
SpecialExceptionthat wraps another exception. - SpecialException(String) - Constructor for exception class org.machanism.machai.process.tools.SpecialException
-
Constructs a new
SpecialExceptionwith the specified detail message. - SpecialException(String, Throwable) - Constructor for exception class org.machanism.machai.process.tools.SpecialException
-
Constructs a
SpecialExceptionwith a detail message and its underlying cause. - SupportedFor - Annotation Type in org.machanism.machai.process.tools
-
Indicates which application classes a
FunctionToolsimplementation supports. - Supporting utilities - Search tag in package org.machanism.machai.genai.provider
- Section
- Supporting utilities - Search tag in package org.machanism.machai.process.provider
- Section
T
- timeoutSec - Variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Request timeout in seconds;
0means SDK defaults are used. - timeoutSec - Variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Request timeout in seconds;
0means SDK defaults are used. - Tool - Annotation Type in org.machanism.machai.process.tools
-
Annotation to mark a method as a tool function within the AI provider framework.
- TOOL - Enum constant in enum org.machanism.machai.genai.provider.ToolLogger.Type
-
Indicates the logged operation represents the execution of an AI function tool.
- TOOL - Enum constant in enum org.machanism.machai.process.provider.ToolLogger.Type
-
Indicates the logged operation represents the execution of an AI function tool.
- ToolExecutionException - Exception Class in org.machanism.machai.process.tools
-
Indicates that a tool callback could not complete its requested operation.
- ToolExecutionException(String) - Constructor for exception class org.machanism.machai.process.tools.ToolExecutionException
-
Creates an exception with a descriptive message.
- ToolExecutionException(Throwable) - Constructor for exception class org.machanism.machai.process.tools.ToolExecutionException
-
Creates an exception that preserves the underlying failure.
- ToolFunction - Interface in org.machanism.machai.process.tools
-
Functional interface representing a tool callable by a provider during a run.
- ToolLogger - Class in org.machanism.machai.genai.provider
-
Internal logging utility for tool inputs, results, and execution errors.
- ToolLogger - Class in org.machanism.machai.process.provider
-
Internal logging utility for tool inputs, results, and execution errors.
- ToolLogger(ToolLogger.Type, FunctionTools) - Constructor for class org.machanism.machai.genai.provider.ToolLogger
-
Creates an instance of ToolLogger.
- ToolLogger(ToolLogger.Type, FunctionTools) - Constructor for class org.machanism.machai.process.provider.ToolLogger
-
Creates an instance of ToolLogger.
- ToolLogger.Type - Enum in org.machanism.machai.genai.provider
-
Defines the types of operations whose activity can be logged.
- ToolLogger.Type - Enum in org.machanism.machai.process.provider
-
Defines the types of operations whose activity can be logged.
- toolMap - Variable in class org.machanism.machai.genai.provider.AnthropicProvider
-
Mapping between Anthropic tool definitions and local functions.
- toolMap - Variable in class org.machanism.machai.genai.provider.OpenAIProvider
-
Maps tools to handler functions.
- toolMap - Variable in class org.machanism.machai.process.provider.ToolsProvider
-
Map of registered tool functions by tool name.
- ToolsProvider - Class in org.machanism.machai.process.provider
-
AI provider implementation for managing and invoking host-defined function tools.
- ToolsProvider() - Constructor for class org.machanism.machai.process.provider.ToolsProvider
-
Constructs a new
ToolsProviderwith a default configuration. - toSnakeCase(String) - Static method in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Converts a given string into snake_case format.
- toSnakeCase(String) - Static method in class org.machanism.machai.process.provider.AbstractAIProvider
-
Converts a given string into snake_case format.
- type - Variable in class org.machanism.machai.genai.provider.ToolLogger
-
Category assigned to messages emitted by this logger.
- type - Variable in class org.machanism.machai.process.provider.ToolLogger
-
Category assigned to messages emitted by this logger.
- type - Variable in class org.machanism.machai.process.tools.ParamDescriptor
-
The parameter's data type.
- Type() - Constructor for enum org.machanism.machai.genai.provider.ToolLogger.Type
- Type() - Constructor for enum org.machanism.machai.process.provider.ToolLogger.Type
- TYPE_MAP - Static variable in class org.machanism.machai.genai.provider.TypeConverter
- TYPE_MAP - Static variable in class org.machanism.machai.process.provider.TypeConverter
- TypeConverter - Class in org.machanism.machai.genai.provider
-
Utility class for converting between Java types and their string representations, as well as mapping Java types to simplified type names (e.g., "string", "integer", "array").
- TypeConverter - Class in org.machanism.machai.process.provider
-
Utility class for converting between Java types and their string representations, as well as mapping Java types to simplified type names (e.g., "string", "integer", "array").
- TypeConverter() - Constructor for class org.machanism.machai.genai.provider.TypeConverter
- TypeConverter() - Constructor for class org.machanism.machai.process.provider.TypeConverter
- Typical usage - Search tag in interface org.machanism.machai.process.provider.ProcessProvider
- Section
- Typical usage - Search tag in package org.machanism.machai.process.provider
- Section
U
- uri() - Element in annotation type org.machanism.machai.process.tools.Resource
-
One or more unique URIs associated with this resource.
- urlEncode(String) - Static method in class org.machanism.machai.genai.provider.CodeMieProvider
-
URL-encodes a value for
application/x-www-form-urlencodedrequest bodies. - Usage - Class in org.machanism.machai.process.manager
-
Immutable token-usage metrics for a single generative AI interaction.
- Usage(long, long, long) - Constructor for class org.machanism.machai.process.manager.Usage
-
Creates a usage record.
- Usage Example - Search tag in annotation type org.machanism.machai.process.tools.Resource
- Section
- Usage Example - Search tag in annotation type org.machanism.machai.process.tools.SupportedFor
- Section
- Usage Example - Search tag in class org.machanism.machai.process.manager.ProcessProviderManager
- Section
- Usage Example - Search tag in class org.machanism.machai.process.provider.ToolsProvider
- Section
- Usage Example - Search tag in class org.machanism.machai.process.tools.FunctionToolsLoader
- Section
- Usage Example - Search tag in interface org.machanism.machai.process.tools.ToolFunction
- Section
- Usage reporting - Search tag in package org.machanism.machai.process.manager
- Section
- UsageStatistics - Class in org.machanism.machai.process.manager
-
Central registry for aggregated GenAI token-usage statistics.
- UsageStatistics() - Constructor for class org.machanism.machai.process.manager.UsageStatistics
-
Private constructor to prevent instantiation of this usage statistics utility class.
- USER - Enum constant in enum org.machanism.machai.process.tools.Role
-
Represents the end user or client.
- username - Variable in class org.machanism.machai.genai.provider.CodeMieProvider.ClaudeProviderExtension
-
User name supplied to the CodeMie token endpoint.
- username - Variable in class org.machanism.machai.genai.provider.CodeMieProvider.OpenAIProviderExtension
-
User name supplied to the CodeMie token endpoint.
- USERNAME_PROP_NAME - Static variable in class org.machanism.machai.genai.provider.AbstractAIProvider
-
Environment variable name for authenticating with the GenAI provider.
- USERNAME_PROP_NAME - Static variable in class org.machanism.machai.process.provider.AbstractAIProvider
-
Environment variable name for authenticating with the GenAI provider.
- Using the API - Search tag in Overview
- Section
V
- value() - Element in annotation type org.machanism.machai.process.tools.SupportedFor
-
The set of application classes for which the annotated
FunctionToolsimplementation is compatible. - valueOf(String) - Static method in enum org.machanism.machai.genai.provider.ToolLogger.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.machanism.machai.process.provider.ToolLogger.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.machanism.machai.process.tools.Role
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.machanism.machai.genai.provider.ToolLogger.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.machanism.machai.process.provider.ToolLogger.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.machanism.machai.process.tools.Role
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- webSearchTool - Variable in class org.machanism.machai.genai.provider.AnthropicProvider
-
Anthropic web search tool instance registered for outgoing requests, or
null. - writeValueAsString(Object) - Method in class org.machanism.machai.genai.provider.ToolLogger
-
Utility method that safely serializes any payload object into a JSON string format.
- writeValueAsString(Object) - Method in class org.machanism.machai.process.provider.ToolLogger
-
Utility method that safely serializes any payload object into a JSON string format.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form