Theia API Documentation v1.65.0
    Preparing search index...

    Class AbstractChatAgentAbstract

    A chat agent is a specialized agent with a common interface for its invocation.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    additionalToolRequests agentSpecificVariables chatToolRequestService contentMatcherProviders contentMatchers defaultContentFactory defaultLanguageModelPurpose description functions iconClass id languageModelRegistry languageModelRequirements languageModelService locations logger name prompts promptService systemPromptId tags variables

    Methods

    addContentsToResponse deduplicateTools getLanguageModel getLanguageModelSelector getLlmSettings getMessages getSystemMessageDescription handleError init initializeContentMatchers invoke onResponseComplete parseContents selectLanguageModel sendLlmRequest

    Constructors

    Properties

    additionalToolRequests: ToolRequest[] = []
    agentSpecificVariables: AgentSpecificVariables[] = []

    The list of local variable identifiers that can be made available to this agent during execution, these variables are context specific and do not exist for other agents.

    This array is primarily used for documentation purposes in the AI Configuration View to show which variables can be made available to the agent. Referenced variables are NOT automatically handed over by the framework, this must be explicitly done in the agent implementation or in prompts.

    chatToolRequestService: ChatToolRequestService
    contentMatcherProviders: ContributionProvider<ResponseContentMatcherProvider>
    contentMatchers: ResponseContentMatcher[] = []
    defaultContentFactory: DefaultResponseContentFactory
    defaultLanguageModelPurpose: string
    description: string = ''

    A markdown description of its functionality and its privacy-relevant requirements, including function call handlers that access some data autonomously.

    functions: string[] = []

    The list of global function identifiers that are always available to this agent during execution, regardless of whether they are referenced in prompts.

    This array is primarily used for documentation purposes in the AI Configuration View to show which functions are guaranteed to be available to the agent. Referenced functions are NOT automatically handed over by the framework, this must be explicitly done in the agent implementation.

    iconClass: string = 'codicon codicon-copilot'
    id: string

    Used to identify an agent, e.g. when it is requesting language models, etc.

    This parameter might be removed in favor of name. Therefore, it is recommended to set id to the same value as name for now.

    languageModelRegistry: LanguageModelRegistry
    languageModelRequirements: LanguageModelRequirement[]

    Required language models. This includes the purpose and optional language model selector arguments. See #47.

    languageModelService: LanguageModelService
    locations: ChatAgentLocation[] = ChatAgentLocation.ALL
    logger: ILogger
    name: string

    Human-readable name shown to users to identify the agent. Must be unique. Use short names without "Agent" or "Chat" (see tags for adding further properties).

    prompts: PromptVariantSet[] = []

    The prompts introduced and used by this agent.

    promptService: PromptService
    systemPromptId: undefined | string = undefined
    tags: string[] = ...

    A list of tags to filter agents and to display capabilities in the UI

    variables: string[] = []

    The list of global variable identifiers that are always available to this agent during execution, regardless of whether they are referenced in prompts.

    This array is primarily used for documentation purposes in the AI Configuration View to show which variables are guaranteed to be available to the agent. Referenced variables are NOT automatically handed over by the framework, this must be explicitly done in the agent implementation.

    Methods

    • Returns undefined | { [key: string]: unknown }

      the settings, such as temperature, to be used in all language model requests. Returns undefined by default.

    • Invoked after the response by the LLM completed successfully.

      The default implementation sets the state of the response to complete. Subclasses may override this method to perform additional actions or keep the response open for processing further requests.

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods