ITakeawayInstructions
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Instructions an AI takeaway is written with, each at most 2000 characters.
export interface ITakeawayInstructions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (BETA) (Optional) What the whole document is for. | ||
string | (BETA) (Optional) The preferred shape of the text. Yields to | ||
string | (BETA) (Optional) What this takeaway must say. Wins over |
Property details
ITakeawayInstructions.documentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
What the whole document is for.
document?: string;
ITakeawayInstructions.formatHintpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The preferred shape of the text. Yields to document and slot.
formatHint?: string;
ITakeawayInstructions.slotpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
What this takeaway must say. Wins over document and formatHint where they disagree.
slot?: string;