Class ChatRequestHierarchyImpl<TRequest>

A model that contains information about a chat request that may branch off.

The hierarchy of requests is represented by a tree structure.

The root of the tree is the initial request
Within each branch, the requests are stored in a list. Those requests are the alternatives to the original request. Each of those items can have a next branch, which is the next request in the hierarchy.

Type Parameters

TRequest extends ChatRequestModel = ChatRequestModel

Implements

ChatRequestHierarchy<TRequest>

Index

Constructors

Properties

branch onDidChange onDidChangeActiveBranchEmitter

Methods

activeBranches activeRequests append dispose findBranch findInBranch findRequest iterateBranches notifyChange

Constructors

constructor

new ChatRequestHierarchyImpl<
TRequest extends ChatRequestModel = ChatRequestModel,
>(): ChatRequestHierarchyImpl<TRequest>
Type Parameters
- TRequest extends ChatRequestModel = ChatRequestModel
Returns ChatRequestHierarchyImpl<TRequest>

Properties

`Readonly`branch

branch: ChatHierarchyBranch<TRequest> = ...

`Readonly`onDidChange

onDidChange: Event<ChangeActiveBranchEvent<TRequest>> = ...

`Protected` `Readonly`onDidChangeActiveBranchEmitter

onDidChangeActiveBranchEmitter: Emitter<ChangeActiveBranchEvent<TRequest>> = ...

Methods

activeBranches

activeBranches(): ChatHierarchyBranch<TRequest>[]
Returns ChatHierarchyBranch<TRequest>[]
Implementation of ChatRequestHierarchy.activeBranches
- Defined in ai-chat/src/common/chat-model.ts:922

activeRequests

activeRequests(): TRequest[]
Returns TRequest[]
Implementation of ChatRequestHierarchy.activeRequests
- Defined in ai-chat/src/common/chat-model.ts:918

append

append(request: TRequest): ChatHierarchyBranch<TRequest>
Parameters
- request: TRequest
Returns ChatHierarchyBranch<TRequest>
Implementation of ChatRequestHierarchy.append
- Defined in ai-chat/src/common/chat-model.ts:907

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of ChatRequestHierarchy.dispose
- Defined in ai-chat/src/common/chat-model.ts:968

findBranch

findBranch(requestId: string): undefined | ChatHierarchyBranch<TRequest>
Parameters
- requestId: string
Returns undefined | ChatHierarchyBranch<TRequest>
Implementation of ChatRequestHierarchy.findBranch
- Defined in ai-chat/src/common/chat-model.ts:943

`Protected`findInBranch

findInBranch(
branch: ChatHierarchyBranch<TRequest>,
requestId: string,
): undefined | ChatHierarchyBranch<TRequest>
Parameters
- branch: ChatHierarchyBranch<TRequest>
- requestId: string
Returns undefined | ChatHierarchyBranch<TRequest>
- Defined in ai-chat/src/common/chat-model.ts:947

findRequest

findRequest(requestId: string): undefined | TRequest
Parameters
- requestId: string
Returns undefined | TRequest
Implementation of ChatRequestHierarchy.findRequest
- Defined in ai-chat/src/common/chat-model.ts:938

`Protected`iterateBranches

iterateBranches(): Generator<ChatHierarchyBranch<TRequest>>
Returns Generator<ChatHierarchyBranch<TRequest>>
- Defined in ai-chat/src/common/chat-model.ts:926

notifyChange

notifyChange(event: ChangeActiveBranchEvent<TRequest>): void
Parameters
- event: ChangeActiveBranchEvent<TRequest>
Returns void
Implementation of ChatRequestHierarchy.notifyChange
- Defined in ai-chat/src/common/chat-model.ts:964