Skip to main content
Version: v2

IExposedProperties Interface

An interface that 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/type-factory/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​

MethodAlertsModifiersReturn TypeDescription
[exposePropertiesSymbol](properties)AlphaoptionalvoidStatic method that exposes properties of this class to an agent.

Method Details​

[exposePropertiesSymbol]​

Static method that exposes properties of this 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​

ParameterTypeDescription
propertiesExposedProperties