AIAgentFunctionalContextBase
Represents the execution context for an AI agent operating in a loop. It provides access to critical parts such as the environment, configuration, large language model (LLM) context, state management, and storage. Additionally, it enables the agent to store, retrieve, and manage context-specific data during its execution lifecycle.
Inheritors
Properties
A unique identifier for the agent, differentiating it from other agents in the system.
A unique identifier representing the current agent instance within the context.
The input data passed to the agent, which can be of any type, depending on the agent's context.
Represents the input provided to the agent's execution.
Represents the input provided to the agent's execution.
The configuration settings for the agent, including its prompt and model details, as well as operational constraints like iteration limits.
Represents the configuration for an AI agent.
Represents the configuration for an AI agent.
The environment interface allowing the agent to interact with the external world, including executing tools and reporting problems.
Represents the environment in which the agent operates.
Represents the environment in which the agent operates.
Represents the observability data associated with the AI Agent context.
Represents the observability data associated with the AI Agent context.
Represents the observability data associated with the AI Agent context.
The context for interacting with the large language model used by the agent, enabling message history retrieval and processing.
Represents the AI agent's LLM context, providing mechanisms for managing tools, prompts, and interaction with the execution environment. It ensures thread safety during concurrent read and write operations through the use of sessions.
Represents the AI agent's LLM context, providing mechanisms for managing tools, prompts, and interaction with the execution environment. It ensures thread safety during concurrent read and write operations through the use of sessions.
Represents the parent context of the AI Agent.
Represents the parent context of the AI Agent.
Represents the parent context of the AI Agent.
A unique identifier for the current run or instance of the agent's operation.
A unique identifier for the current session associated with the AI agent context. Used to track and differentiate sessions within the execution of the agent pipeline.
The state management component responsible for tracking and updating the agent's state during its execution.
Manages and tracks the state of aт AI agent within the context of its execution.
Manages and tracks the state of aт AI agent within the context of its execution.
A storage interface providing persistent storage capabilities for the agent's data.
Concurrent-safe key-value storage for an agent, used to manage and persist data within the context of the AI agent stage execution. The storage property provides a thread-safe mechanism for sharing and storing data specific to the agent's operation.
Concurrent-safe key-value storage for an agent, used to manage and persist data within the context of the AI agent stage execution. The storage property provides a thread-safe mechanism for sharing and storing data specific to the agent's operation.
The name of the agent's strategic approach or operational method, determining its behavior during execution.
Represents the name of the strategy being used in the current AI agent context.
Represents the name of the strategy being used in the current AI agent context.
Functions
Retrieves the current agent input.
Utility function to get AIAgentContext.agentInput and try to cast it to some expected type.
Casts the current instance of a Message.Response to a Message.Assistant. This function should only be used when it is guaranteed that the instance is of type Message.Assistant, as it will throw an exception if the type does not match.
Casts the current instance of a Message.Response to a Message.Assistant. This function should only be used when it is guaranteed that the instance is of type Message.Assistant, as it will throw an exception if the type does not match.
Casts the current instance of a Message.Response to a Message.Assistant. This function should only be used when it is guaranteed that the instance is of type Message.Assistant, as it will throw an exception if the type does not match.
Attempts to cast a Message.Response instance to a Message.Assistant type.
Attempts to cast a Message.Response instance to a Message.Assistant type.
Attempts to cast a Message.Response instance to a Message.Assistant type.
Compresses the current LLM prompt (message history) into a summary, replacing messages with a TLDR.
Compresses the historical data of a tool's operations using the specified compression strategy. This method is designed for optimizing memory usage by reducing the size of stored historical data.
Compresses the current LLM prompt (message history) into a summary, replacing messages with a TLDR.
Compresses the current LLM prompt (message history) into a summary, replacing messages with a TLDR.
Provides the configuration for an AI agent.
Checks if the list of Message.Response contains any instances of Message.Tool.Call.
Checks if the list of Message.Response contains any instances of Message.Tool.Call.
Checks if the list of Message.Response contains any instances of Message.Tool.Call.
Extension function to access the Debugger feature from an agent context.
Retrieves the current AI agent environment.
Executes multiple tool calls and returns their results. These calls can optionally be executed in parallel.
Executes multiple tool calls either sequentially or in parallel based on the provided configurations.
Executes multiple tool calls and returns their results. These calls can optionally be executed in parallel.
Executes multiple tool calls and returns their results. These calls can optionally be executed in parallel.
Calls a specific tool directly using the provided arguments.
Executes a single tool with the specified arguments.
Calls a specific tool directly using the provided arguments.
Calls a specific tool directly using the provided arguments.
Executes a tool call and returns the result.
Executes the specified tool call using an optional executor service.
Executes a tool call and returns the result.
Executes a tool call and returns the result.
Retrieves the execution information of the agent.
Extracts a list of tool call messages from a given list of response messages.
Extracts a list of tool call messages from a given list of response messages.
Extracts a list of tool call messages from a given list of response messages.
Retrieves a feature from the AIAgentContext.pipeline associated with this context using the specified key.
Retrieves a feature from the AIAgentContext.pipeline associated with this context using the specified key or throws an exception if it is not available.
Retrieves data from the agent's storage using the specified key.
Retrieves data from the agent's storage using the specified key.
Retrieves data from the agent's storage using the specified key.
Retrieves the agent-specific context data associated with the current instance.
Retrieves the history of messages exchanged during the agent's execution.
Retrieves the history of messages exchanged during the agent's execution.
Retrieves the history of messages exchanged during the agent's execution.
Retrieves the latest token usage from the prompt within the LLM session.
Retrieves the most recent token usage count synchronously.
Retrieves the latest token usage from the prompt within the LLM session.
Retrieves the latest token usage from the prompt within the LLM session.
Returns the current instance of AIAgentLLMContext.
Executes the provided action if the given response is of type Message.Assistant.
Executes the provided action if the given response is of type Message.Assistant.
Executes the provided action if the given response is of type Message.Assistant.
Filters the provided list of response messages to include only assistant messages and, if the filtered list is not empty, performs the specified action with the filtered list.
Filters the provided list of response messages to include only assistant messages and, if the filtered list is not empty, performs the specified action with the filtered list.
Filters the provided list of response messages to include only assistant messages and, if the filtered list is not empty, performs the specified action with the filtered list.
Invokes the provided action when multiple tool call messages are found within a given list of response messages. Filters the list of responses to include only instances of Message.Tool.Call and executes the action on the filtered list if it is not empty.
Invokes the provided action when multiple tool call messages are found within a given list of response messages. Filters the list of responses to include only instances of Message.Tool.Call and executes the action on the filtered list if it is not empty.
Invokes the provided action when multiple tool call messages are found within a given list of response messages. Filters the list of responses to include only instances of Message.Tool.Call and executes the action on the filtered list if it is not empty.
Removes a feature or data associated with the specified key from the agent's storage.
Removes a feature or data associated with the specified key from the agent's storage.
Removes a feature or data associated with the specified key from the agent's storage.
Removes the agent-specific context data associated with the current context.
Sends a message to a Large Language Model (LLM) and optionally allows the use of tools during the LLM interaction. The message becomes part of the current prompt, and the LLM's response is processed accordingly, either with or without tool integrations based on the provided parameters.
Sends a message to a Large Language Model (LLM) and optionally allows the use of tools during the LLM interaction. The message becomes part of the current prompt, and the LLM's response is processed accordingly, either with or without tool integrations based on the provided parameters.
Sends a request to the Large Language Model (LLM) and retrieves its response.
Sends a message to a Large Language Model (LLM) and optionally allows the use of tools during the LLM interaction. The message becomes part of the current prompt, and the LLM's response is processed accordingly, either with or without tool integrations based on the provided parameters.
Sends a message to a Large Language Model (LLM) and forces it to use a specific tool. The message becomes part of the current prompt, and the LLM is instructed to use only the specified tool.
Sends a request to the LLM (Large Language Model) system using a specified tool, ensuring the use of exactly one tool in the response generation process.
Sends a request to the LLM (Large Language Model) forcing the use of a specified tool and returns the response.
Sends a message to a Large Language Model (LLM) and forces it to use a specific tool. The message becomes part of the current prompt, and the LLM is instructed to use only the specified tool.
Sends a message to a Large Language Model (LLM) and forces it to use a specific tool. The message becomes part of the current prompt, and the LLM is instructed to use only the specified tool.
Sends a message to a Large Language Model (LLM) and gets multiple LLM responses with tool calls enabled. The message becomes part of the current prompt, and multiple responses from the LLM are collected.
Sends a request to the Large Language Model (LLM) and retrieves multiple responses.
Sends a message to a Large Language Model (LLM) and gets multiple LLM responses with tool calls enabled. The message becomes part of the current prompt, and multiple responses from the LLM are collected.
Sends a message to a Large Language Model (LLM) and gets multiple LLM responses with tool calls enabled. The message becomes part of the current prompt, and multiple responses from the LLM are collected.
Sends a message to a Large Language Model (LLM) that will only call tools without generating text responses. The message becomes part of the current prompt, and the LLM is instructed to only use tools.
Executes a request to the LLM, restricting the process to only calling external tools as needed.
Sends a message to a Large Language Model (LLM) that will only call tools without generating text responses. The message becomes part of the current prompt, and the LLM is instructed to only use tools.
Sends a message to a Large Language Model (LLM) that will only call tools without generating text responses. The message becomes part of the current prompt, and the LLM is instructed to only use tools.
Sends a message to a Large Language Model (LLM) and streams the LLM response. The message becomes part of the current prompt, and the LLM's response is streamed as it's generated.
Sends a request to the Language Learning Model (LLM) for streaming data.
Sends a message to a Large Language Model (LLM) and streams the LLM response. The message becomes part of the current prompt, and the LLM's response is streamed as it's generated.
Sends a message to a Large Language Model (LLM) and streams the LLM response. The message becomes part of the current prompt, and the LLM's response is streamed as it's generated.
Sends a structured request to the Large Language Model (LLM) and processes the response.
Provides the root context of the current agent. If the root context is not defined, this function defaults to returning the current instance.
Adds multiple tool results to the prompt and gets multiple LLM responses.
Sends multiple tool results for processing and returns the corresponding responses.
Adds multiple tool results to the prompt and gets multiple LLM responses.
Adds multiple tool results to the prompt and gets multiple LLM responses.
Adds a tool result to the prompt and requests an LLM response.
Sends the provided tool result for processing.
Adds a tool result to the prompt and requests an LLM response.
Adds a tool result to the prompt and requests an LLM response.
Provides an instance of AIAgentStateManager responsible for managing the state of an AI Agent. This function allows access to the state management operations for coordinating AI agent behavior.
Provides access to the AIAgentStorage instance.
Stores a feature in the agent's storage using the specified key.
Stores a feature in the agent's storage using the specified key.
Stores a feature in the agent's storage using the specified key.
Stores the given agent context data within the current AI agent context.
Retrieves the name of the strategy.
Executes a subtask within the AI agent's functional context. This method enables the use of tools to achieve a specific task based on the input provided. It defines the task using an inline function, employs tools iteratively, and attempts to complete the subtask with a designated finishing tool.
Executes a subtask within the larger context of an AI agent's functional operation. This method allows you to define a specific task to be performed, using the given input, tools, and optional configuration parameters.
Executes a subtask within the AI agent's functional context. This method enables the use of tools to achieve a specific task based on the input provided. It defines the task using an inline function, employs tools iteratively, and attempts to complete the subtask with a designated finishing tool.
Executes a subtask within the larger context of an AI agent's functional operation. This method allows you to define a specific task to be performed, using the given input, tools, and optional configuration parameters.
Executes a subtask within the AI agent's functional context. This method enables the use of tools to achieve a specific task based on the input provided. It defines the task using an inline function, employs tools iteratively, and attempts to complete the subtask with a designated finishing tool.
Executes a subtask within the larger context of an AI agent's functional operation. This method allows you to define a specific task to be performed, using the given input, tools, and optional configuration parameters.
Executes a subtask with validation and verification of the results. The method defines a subtask for the AI agent using the provided input and additional parameters and ensures that the output is evaluated based on its correctness and feedback.
Executes a subtask with validation and verification of the results. The method defines a subtask for the AI agent using the provided input and additional parameters and ensures that the output is evaluated based on its correctness and feedback.
Executes a subtask with validation and verification of the results. The method defines a subtask for the AI agent using the provided input and additional parameters and ensures that the output is evaluated based on its correctness and feedback.
Executes a block of code with a modified execution context.
Executes a block of code with a modified execution context, creating a parent-child relationship between execution contexts for tracing purposes.