DiffBase Interface
A base interface to enforce consistency between all Diff objects.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface DiffBase
Remarks
This object is not intended to be used directly. The union type Diff provides a better typescript experience
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| aiExplanation | Alpha |
readonly |
string | An explanation from the ai as to why the edit is being made. |
| type | Alpha |
readonly |
string | The operation type performed by an ai agent on a SharedTree |
Property Details
aiExplanation
An explanation from the ai as to why the edit is being made.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly aiExplanation: string;
Type: string
type
The operation type performed by an ai agent on a SharedTree
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly type: string;
Type: string
Remarks
This is intended to be used to correlate the diff with the operation that generated it.