HtmlForgeX

API Reference

Class

ImageEmbeddingResult

Namespace HtmlForgeX
Assembly HtmlForgeX

Result of an image embedding operation providing metadata about the generated base64 payload.

Inheritance

  • Object
  • ImageEmbeddingResult

Methods

public static ImageEmbeddingResult CreateFailure(String errorMessage) #
Returns: ImageEmbeddingResult

Creates a failed embedding result.

Parameters

errorMessage System.String requiredposition: 0
Description of the failure.

Returns

A failed ImageEmbeddingResult instance.

public static ImageEmbeddingResult CreateSuccess(String base64Data, String mimeType) #
Returns: ImageEmbeddingResult

Creates a successful embedding result.

Parameters

base64Data System.String requiredposition: 0
Encoded image data.
mimeType System.String requiredposition: 1
MIME type of the image.

Returns

A successful ImageEmbeddingResult instance.

Properties

public Boolean Success { get; set; } #

Indicates whether the embedding succeeded.

public String Base64Data { get; set; } #

Base64 encoded image data.

public String MimeType { get; set; } #

Embedded image MIME type.

public String ErrorMessage { get; set; } #

Error message if the embedding failed.