Edit

IAIProperties interface

Package:
@microsoft/sp-module-interfaces

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Defines the AI properties for the web part, including their structure and the mapping to the web part's property bag. When provided, AI scenarios such as an LLM agent in SharePoint Pages can interact with the web part, e.g., creating it, modifying it, or understanding its data structure.

Properties

mapping

The mapping of AI properties to existing property bag.
structure

The structure of AI properties for the web part.

Property Details

mapping

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The mapping of AI properties to existing property bag.

mapping: {
        [key: string]: unknown;
    };

Property Value

{ [key: string]: unknown; }

structure

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The structure of AI properties for the web part.

structure: {
        [key: string]: unknown;
    };

Property Value

{ [key: string]: unknown; }