Class TextEmbeddingResult

The result of a text embedding request.

public class TextEmbeddingResult

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

The message describing the error that lead to the cancellation of the operation.

[JsonPropertyName("error_message")]
public string? ErrorMessage { get; set; }

Indicates whether the text embedding operation failed due to an error. When true, the ErrorMessage property contains a message describing the error.

[JsonPropertyName("cancelled")]
public bool Failed { get; set; }

Indicates whether the text embedding operation is still in progress. When true, the OperationId property contains an operation identifier.

[JsonPropertyName("in_progress")]
public bool InProgress { get; set; }

Optional operation identifier that can be used to retrieve the final result.

[JsonPropertyName("operation_id")]
public string? OperationId { get; set; }

The list of TextChunk objects containing the embeddings.

[JsonPropertyName("text_chunks")]
public IList<TextChunk> TextChunks { get; set; }

The number of tokens used during the embedding operation.

[JsonPropertyName("token_count")]
public int TokenCount { get; set; }