BetaOptional BetaconditionalBetadocumentThe source document the transformation will use as input.
Optional BetaforceBy default, agent actions will never write to a published document.
Instead, they will force the use of a draft ID ("drafts.some-id") instead of the published ID ("some-id"), even when a published ID is provided.
Actions will use state from an existing draft if it exists, or use the published document to create a draft, if no draft exists.
Successful responses contains the _id that was mutated by the action.
When forcePublishedWrite: true an agent action will write to the exact id provided. The action will also not fallback to published state for draft ids.
When an ID on the form "versions.forcePublishedWrite: true.
That is, only the exact document state of the id provided is considered and mutated.
Optional BetafromWhile optional, it is recommended
Optional BetalanguageWhen specified, the toLanguage.id will be stored in the specified path in the target document.
The file can be hidden: true (unlike other fields in the target, which will be ignored)
Optional BetalocaleWhen localeSettings is provided on the request, instruct can write to date and datetime fields. Otherwise, such fields will be ignored.
A valid Unicode BCP 47 locale identifier used to interpret and format natural language inputs and date output. Examples include "en-US", "fr-FR", or "ja-JP".
This affects how phrases like "next Friday" or "in two weeks" are parsed, and how resulting dates are presented (e.g., 12-hour vs 24-hour format).
A valid IANA time zone identifier used to resolve relative and absolute date expressions to a specific point in time. Examples include "America/New_York", "Europe/Paris", or "Asia/Tokyo".
This ensures phrases like "tomorrow at 9am" are interpreted correctly based on the user's local time.
Optional BetaprotectedWhen the input string contains any phrase from protectedPhrases, the LLM will be instructed not
to translate them.
It is recommended to use protectedPhrases instead of styleGuide for deny-list words and phrases,
since it keeps token cost low, resulting in faster responses, and limits how much information the LLM
has to process, since only phrases that are actually in the input string will be included in the final prompt.
BetaschemaschemaId as reported by sanity deploy / sanity schema store
Optional BetastylestyleGuide can be used to tailor how the translation should be preformed.
String template using $variable from styleGuideParams.
Capped to 2000 characters, after variables has been injected.
Optional Betastyleparam values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable"
Optional BetatargetTarget defines which parts of the document will be affected by the instruction. It can be an array, so multiple parts of the document can be separately configured in detail.
Omitting target implies that the document itself is the root.
Notes:
maxPathDepthOptional BetatargetThe target document will first get content copied over from the source, then it is translated according to the instruction.
When omitted, the source document (documentId) is also the target document.
Optional BetatemperatureControls how much variance the instructions will run with.
Value must be in the range [0, 1] (inclusive).
Defaults:
Betato
When a type or field in the schema has a function set for
hiddenorreadOnly, it is conditional.By default, Generate will not output to conditional
readOnlyandhiddenfields, ie, they are considered to resolve toreadOnly: true/hidden: true.conditionalPathsparam allows setting the default conditional value forhiddenandreadOnlyto false, or individually sethiddenandreadOnlystate for individual document paths.Note: fields and types with explicit readOnly: true or hidden: true in the schema, are not available to Generate, and cannot be changed via conditionalPaths
conditionalPaths state only apply to fields and types that have conditional
hiddenorreadOnlyin their schema definition.Consider using
hidden: () => truein schema config, if a field should be writeable only by Generate and never visible in the studio – then make the field visible to the Generate usingconditionalPaths.