IExposedProperties Interface
An interface that SharedTree schema classes should implement to expose their properties to the LLM.
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.
Signature
export interface IExposedProperties
Remarks
The getExposedProperties free function will cause the method here to be called on the class passed to it.
Methods
| Method | Alerts | Modifiers | Return Type | Description |
|---|---|---|---|---|
| [exposePropertiesSymbol](properties) | Alpha | optional | void | Static method that exposes properties of this schema class to an agent. |
Method Details
[exposePropertiesSymbol]
Static method that exposes properties of this schema class to an agent.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
[exposePropertiesSymbol]?(properties: ExposedProperties): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| properties | ExposedProperties |