Sanity Library Reference Docs
    Preparing search index...

    Interface TranslateRequestBaseBeta

    interface TranslateRequestBase {
        forcePublishedWrite?: boolean;
        conditionalPaths?: {
            defaultReadOnly?: boolean;
            defaultHidden?: boolean;
            paths?: { path: AgentActionPath; readOnly: boolean; hidden: boolean }[];
        };
        localeSettings?: { locale: string; timeZone: string };
        temperature?: number;
        schemaId: string;
        documentId: string;
        targetDocument?: TransformTargetDocument;
        fromLanguage?: TranslateLanguage;
        toLanguage: TranslateLanguage;
        styleGuide?: string;
        styleGuideParams?: AgentActionParams;
        protectedPhrases?: string[];
        languageFieldPath?: AgentActionPathSegment | AgentActionPath;
        target?: TranslateTarget | TranslateTarget[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    forcePublishedWrite? conditionalPaths? localeSettings? temperature? schemaId documentId targetDocument? fromLanguage? toLanguage styleGuide? styleGuideParams? protectedPhrases? languageFieldPath? target?

    Properties

    forcePublishedWrite?: boolean

    By 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..some-id" is provided, agent actions will always behave as if forcePublishedWrite: true. That is, only the exact document state of the id provided is considered and mutated.

    conditionalPaths?: {
        defaultReadOnly?: boolean;
        defaultHidden?: boolean;
        paths?: { path: AgentActionPath; readOnly: boolean; hidden: boolean }[];
    }

    When a type or field in the schema has a function set for hidden or readOnly, it is conditional.

    By default, Generate will not output to conditional readOnly and hidden fields, ie, they are considered to resolve to readOnly: true / hidden: true.

    conditionalPaths param allows setting the default conditional value for hidden and readOnly to false, or individually set hidden and readOnly state 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 hidden or readOnly in their schema definition.

    Consider using hidden: () => true in 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 using conditionalPaths.

    GenerateRequestBase#target

    localeSettings?: { locale: string; timeZone: string }

    When localeSettings is provided on the request, instruct can write to date and datetime fields. Otherwise, such fields will be ignored.

    Type declaration

    temperature?: number

    Controls how much variance the instructions will run with.

    Value must be in the range [0, 1] (inclusive).

    Defaults:

    • generate: 0.3
    • translate: 0
    • transform: 0
    schemaId: string

    schemaId as reported by sanity deploy / sanity schema store

    documentId: string

    The source document the transformation will use as input.

    #AgentActionSchema.forcePublishedWrite

    targetDocument?: TransformTargetDocument

    The 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.

    #AgentActionSchema.forcePublishedWrite

    fromLanguage?: TranslateLanguage

    While optional, it is recommended

    toLanguage: TranslateLanguage
    styleGuide?: string

    styleGuide 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.

    #protectedPhrases

    styleGuideParams?: AgentActionParams

    param values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable"

    protectedPhrases?: string[]

    When 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.

    languageFieldPath?: AgentActionPathSegment | AgentActionPath

    When 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)

    target?: TranslateTarget | TranslateTarget[]

    Target 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:

    • instruction can only affect fields up to maxPathDepth
    • when multiple targets are provided, they will be coalesced into a single target sharing a common target root. It is therefor an error to provide conflicting include/exclude across targets (ie, include title in one, and exclude it in another)

    AgentActionRequestBase#conditionalPaths

    Settings

    Member Visibility

    On This Page

    Properties