Class CommandChatAgent

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

Hierarchy (view full)

AbstractTextToModelParsingChatAgent<ParsedCommand>
- CommandChatAgent

Implements

ChatAgent

Constructors

constructor

new CommandChatAgent(): CommandChatAgent
Returns CommandChatAgent
Overrides AbstractTextToModelParsingChatAgent.constructor
- Defined in packages/ai-chat/src/common/command-chat-agents.ts:265

Properties

`Readonly` agentSpecificVariables

agentSpecificVariables: AgentSpecificVariables[]

`Protected` commandRegistry

commandRegistry: CommandRegistry

`Protected` contentMatcherProviders

contentMatcherProviders: ContributionProvider<ResponseContentMatcherProvider>

`Protected` contentMatchers

contentMatchers: ResponseContentMatcher[] = []

`Protected` defaultContentFactory

defaultContentFactory: DefaultResponseContentFactory

`Protected` defaultLanguageModelPurpose

defaultLanguageModelPurpose: string

defaultLogging

defaultLogging: boolean = true

`Readonly` description

description: string

`Readonly` functions

functions: string[]

iconClass

iconClass: string = 'codicon codicon-copilot'

id

id: string

`Protected` languageModelRegistry

languageModelRegistry: LanguageModelRegistry

languageModelRequirements

languageModelRequirements: LanguageModelRequirement[]

locations

locations: ChatAgentLocation[] = ChatAgentLocation.ALL

`Protected` logger

logger: ILogger

`Protected` messageService

messageService: MessageService

`Readonly` name

name: string

`Protected` promptService

promptService: PromptService

`Readonly` promptTemplates

promptTemplates: PromptTemplate[]

`Protected` recordingService

recordingService: CommunicationRecordingService

`Readonly` variables

variables: string[]

Methods

`Protected` addContentsToResponse

addContentsToResponse(languageModelResponse, request): Promise<void>
Parameters
- languageModelResponse: LanguageModelResponse
- request: ChatRequestModelImpl
Returns Promise<void>
Inherited from AbstractTextToModelParsingChatAgent.addContentsToResponse
- Defined in packages/ai-chat/src/common/chat-agents.ts:315

`Protected` callLlm

callLlm(languageModel, messages, tools, token): Promise<LanguageModelResponse>
Parameters
- languageModel: LanguageModel
- messages: ChatMessage[]
- tools: undefined | ToolRequest[]
- token: CancellationToken
Returns Promise<LanguageModelResponse>
Inherited from AbstractTextToModelParsingChatAgent.callLlm
- Defined in packages/ai-chat/src/common/chat-agents.ts:277

`Protected` commandCallback

commandCallback(...commandArgs): Promise<void>
Parameters
- Rest ...commandArgs: unknown[]
Returns Promise<void>
- Defined in packages/ai-chat/src/common/command-chat-agents.ts:350

`Protected` createResponseContent

createResponseContent(parsedCommand, request): ChatResponseContent
Parameters
- parsedCommand: ParsedCommand
- request: ChatRequestModelImpl
Returns ChatResponseContent
Overrides AbstractTextToModelParsingChatAgent.createResponseContent
- Defined in packages/ai-chat/src/common/command-chat-agents.ts:313

`Protected` getLanguageModel

getLanguageModel(languageModelPurpose): Promise<LanguageModel>
Parameters
- languageModelPurpose: string
Returns Promise<LanguageModel>
Inherited from AbstractTextToModelParsingChatAgent.getLanguageModel
- Defined in packages/ai-chat/src/common/chat-agents.ts:230

`Protected` getLanguageModelSelector

getLanguageModelSelector(languageModelPurpose): LanguageModelRequirement
Parameters
- languageModelPurpose: string
Returns LanguageModelRequirement
Inherited from AbstractTextToModelParsingChatAgent.getLanguageModelSelector
- Defined in packages/ai-chat/src/common/chat-agents.ts:226

`Protected` getLlmSettings

getLlmSettings(): undefined | {
[key: string]: unknown;
}
Returns undefined | {
[key: string]: unknown;
}
the settings, such as temperature, to be used in all language model requests. Returns undefined by default.
Inherited from AbstractTextToModelParsingChatAgent.getLlmSettings
- Defined in packages/ai-chat/src/common/chat-agents.ts:295

`Protected` getMessages

getMessages(model, includeResponseInProgress?): Promise<ChatMessage[]>
Parameters
- model: ChatModel
- includeResponseInProgress: boolean = false
Returns Promise<ChatMessage[]>
Inherited from AbstractTextToModelParsingChatAgent.getMessages
- Defined in packages/ai-chat/src/common/chat-agents.ts:244

`Protected` getSystemMessageDescription

getSystemMessageDescription(): Promise<undefined | SystemMessageDescription>
Returns Promise<undefined | SystemMessageDescription>
Overrides AbstractTextToModelParsingChatAgent.getSystemMessageDescription
- Defined in packages/ai-chat/src/common/command-chat-agents.ts:284

`Protected` getTools

getTools(request): undefined | ToolRequest[]
Parameters
- request: ChatRequestModel
Returns undefined | ToolRequest[]
the list of tools used by this agent, or undefined if none is needed.
Inherited from AbstractTextToModelParsingChatAgent.getTools
- Defined in packages/ai-chat/src/common/chat-agents.ts:271

`Protected` onResponseComplete

onResponseComplete(request): Promise<void>
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
- request: ChatRequestModelImpl
Returns Promise<void>
Inherited from AbstractTextToModelParsingChatAgent.onResponseComplete
- Defined in packages/ai-chat/src/common/chat-agents.ts:305

`Protected` parseContents

parseContents(text, request): ChatResponseContent[]
Parameters
- text: string
- request: ChatRequestModelImpl
Returns ChatResponseContent[]
Inherited from AbstractTextToModelParsingChatAgent.parseContents
- Defined in packages/ai-chat/src/common/chat-agents.ts:212

`Protected` parseTextResponse

parseTextResponse(text): Promise<ParsedCommand>
Parameters
- text: string
  the text received from the language model
Returns Promise<ParsedCommand>
the parsed command if the text contained a valid command. If there was no json in the text, return a no-command response.
Overrides AbstractTextToModelParsingChatAgent.parseTextResponse
- Defined in packages/ai-chat/src/common/command-chat-agents.ts:303

`Protected` selectLanguageModel

selectLanguageModel(selector): Promise<LanguageModel>
Parameters
- selector: LanguageModelRequirement
Returns Promise<LanguageModel>
Inherited from AbstractTextToModelParsingChatAgent.selectLanguageModel
- Defined in packages/ai-chat/src/common/chat-agents.ts:234

Class CommandChatAgent

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CommandChatAgent

Properties

Readonly agentSpecificVariables

Protected commandRegistry

Protected contentMatcherProviders

Protected contentMatchers

Protected defaultContentFactory

Protected defaultLanguageModelPurpose

defaultLogging

Readonly description

Readonly functions

iconClass

id

Protected languageModelRegistry

languageModelRequirements

locations

Protected logger

Protected messageService

Readonly name

Protected promptService

Readonly promptTemplates

Protected recordingService

tags

Readonly variables

Methods

Protected addContentsToResponse

Parameters

Returns Promise<void>

Protected callLlm

Parameters

Returns Promise<LanguageModelResponse>

Protected commandCallback

Parameters

Returns Promise<void>

Protected createResponseContent

Parameters

Returns ChatResponseContent

Protected getLanguageModel

Parameters

Returns Promise<LanguageModel>

Protected getLanguageModelSelector

Parameters

Returns LanguageModelRequirement

Protected getLlmSettings

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

Protected getMessages

Parameters

Returns Promise<ChatMessage[]>

Protected getSystemMessageDescription

Returns Promise<undefined | SystemMessageDescription>

Protected getTools

Parameters

Returns undefined | ToolRequest[]

Protected handleError

Parameters

Returns void

init

Returns void

Protected initializeContentMatchers

Returns void

invoke

Parameters

Returns Promise<void>

Protected onResponseComplete

Parameters

Returns Promise<void>

Protected parseContents

Parameters

Returns ChatResponseContent[]

Protected parseTextResponse

Parameters

`Readonly` agentSpecificVariables

`Protected` commandRegistry

`Protected` contentMatcherProviders

`Protected` contentMatchers

`Protected` defaultContentFactory

`Protected` defaultLanguageModelPurpose

`Readonly` description

`Readonly` functions

`Protected` languageModelRegistry

`Protected` logger

`Protected` messageService

`Readonly` name

`Protected` promptService

`Readonly` promptTemplates

`Protected` recordingService

`Readonly` variables

`Protected` addContentsToResponse

`Protected` callLlm

`Protected` commandCallback

`Protected` createResponseContent

`Protected` getLanguageModel

`Protected` getLanguageModelSelector

`Protected` getLlmSettings

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

`Protected` getMessages

`Protected` getSystemMessageDescription

`Protected` getTools

`Protected` handleError

`Protected` initializeContentMatchers

`Protected` onResponseComplete

`Protected` parseContents

`Protected` parseTextResponse

`Protected` selectLanguageModel