Skip to main content

IExposedMethods Interface

An interface that SharedTree schema classes should implement to expose their methods 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 IExposedMethods

Remarks

The getExposedMethods free function will cause the method here to be called on the class passed to it.

Methods

MethodAlertsReturn TypeDescription
[exposeMethodsSymbol](methods)AlphavoidStatic method that exposes methods of this schema class to an agent.

Method Details

[exposeMethodsSymbol]

Static method that exposes methods 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

[exposeMethodsSymbol](methods: ExposedMethods): void;

Parameters

ParameterTypeDescription
methodsExposedMethods