ExecuteSemanticEditingOptions Interface
Options for executeSemanticEditing(model, tree, prompt, options).
To use, import via @fluidframework/tree-agent/alpha.
For more information about our API support guarantees, see here.
Signature
export interface ExecuteSemanticEditingOptions<TSchema extends ImplicitFieldSchema>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TSchema | ImplicitFieldSchema |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| domainHints | Alpha | optional | string | Additional information about the application domain that will be included in the generated system prompt. |
| editor | Alpha | optional | SynchronousEditor<TSchema> | AsynchronousEditor<TSchema> | Executes any generated JavaScript created by the model's editing tool. |
| logger | Alpha | optional | Logger | If supplied, generates human-readable markdown text describing the actions taken during execution. |
| maximumSequentialEdits | Alpha | optional | number | The maximum number of sequential edits the LLM can make before we assume it's stuck in a loop. |
Property Details
domainHints
Additional information about the application domain that will be included in the generated system prompt.
For more information about our API support guarantees, see here.
Signature
domainHints?: string;
Type: string
editor
Executes any generated JavaScript created by the model's editing tool.
For more information about our API support guarantees, see here.
Signature
editor?: SynchronousEditor<TSchema> | AsynchronousEditor<TSchema>;
Type: SynchronousEditor<TSchema> | AsynchronousEditor<TSchema>
Remarks
If not provided, the generated code will be executed using a simple JavaScript eval.
logger
If supplied, generates human-readable markdown text describing the actions taken during execution.
For more information about our API support guarantees, see here.
Signature
logger?: Logger;
Type: Logger
maximumSequentialEdits
The maximum number of sequential edits the LLM can make before we assume it's stuck in a loop.
For more information about our API support guarantees, see here.
Signature
maximumSequentialEdits?: number;
Type: number