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

    Chat agent for OpenAI Codex integration.

    Implements

    Index

    Constructors

    Properties

    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.

    codexService: CodexFrontendService
    description: string = ...

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

    fileChangeFactory: ChangeSetFileElementFactory
    fileService: FileService
    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-robot'
    id: string = CODEX_CHAT_AGENT_ID

    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.

    languageModelRequirements: [] = []

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

    locations: ChatAgentLocation[] = ChatAgentLocation.ALL
    modes: { id: string; name: string }[] = ...
    name: string = 'Codex'

    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: [] = []

    The prompts introduced and used by this agent.

    tags: string[] = ...

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

    tokenUsageService: TokenUsageService
    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.

    workspaceService: WorkspaceService

    Methods

    • Parameters

      • OptionalmodeId: string

      Returns "workspace-write" | "read-only" | "danger-full-access"

    • Type guard using discriminated union narrowing from SDK types.

      Parameters

      • item: ThreadItem

      Returns item is ToolInvocationItem

    • protected async readFileContentSafe(fileUri: URI): Promise<string | undefined> { try { if (!await this.fileService.exists(fileUri)) { console.warn('CodexChatAgent: Skipping file change entry because file is missing', fileUri.toString()); return undefined; } const fileContent = await this.fileService.read(fileUri); return fileContent.value.toString(); } catch (error) { console.error('CodexChatAgent: Failed to read updated file content for', fileUri.toString(), error); return undefined; } } protected mapChangeKind(kind: FileChangeItem['changes'][number]['kind']): 'add' | 'delete' | 'modify' { switch (kind) { case 'add': return 'add'; case 'delete': return 'delete'; default: return 'modify'; } }

      Parameters

      • rootUri: URI
      • relativePath: string

      Returns undefined | URI