SharedTreeSemanticAgent Class
An agent that uses a SharedTreeChatModel to interact with a SharedTree.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/tree-agent/alpha.
For more information about our API support guarantees, see here.
Sealed
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export declare class SharedTreeSemanticAgent<TSchema extends ImplicitFieldSchema>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TSchema | ImplicitFieldSchema |
Remarks
This class forwards user queries to the chat model, and handles the application of any edits to the tree that the model requests.
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(client, tree, options) | Alpha | Constructs a new instance of the SharedTreeSemanticAgent class |
Constructor Details
(constructor)
Constructs a new instance of the SharedTreeSemanticAgent class
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
constructor(client: SharedTreeChatModel, tree: ViewOrTree<TSchema>, options?: Readonly<SemanticAgentOptions<TSchema>> | undefined);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| client | SharedTreeChatModel | ||
| tree | ViewOrTree<TSchema> | ||
| options | optional | Readonly<SemanticAgentOptions<TSchema>> | undefined |