Sanity Library Reference Docs
    Preparing search index...

    Type Alias ImageDescriptionOperationBeta

    ImageDescriptionOperation: {
        sourcePath?: AgentActionPath;
        type: "image-description";
    } & (
        | { imageUrl?: never; sourcePath?: AgentActionPath }
        | { imageUrl?: `https://${string}`; sourcePath?: never }
    )

    Type declaration

    • OptionalsourcePath?: AgentActionPath

      When omitted, parent image value will be inferred from the arget path.

      When specified, the sourcePath should be a path to an image (or image asset) field:

      • ['image']
      • ['wrapper', 'mainImage']
      • ['heroImage', 'asset'] // the asset segment is optional, but supported
    • type: "image-description"
    • { imageUrl?: never; sourcePath?: AgentActionPath }
      • OptionalimageUrl?: never
      • OptionalsourcePath?: AgentActionPath

        When omitted, parent image value will be inferred from the target path.

        When specified, the sourcePath should be a path to an image (or image asset) field:

        • ['image']
        • ['wrapper', 'mainImage']
        • ['heroImage', 'asset'] // the asset segment is optional, but supported

        Incompatible with imageUrl

    • { imageUrl?: `https://${string}`; sourcePath?: never }
      • OptionalimageUrl?: `https://${string}`

        When specified, the image source to be described will be fetched from the URL.

        Incompatible with sourcePath

      • OptionalsourcePath?: never

    #TransformOperation