Table of Contents

Class TextOperationResult

Namespace
FoundationaLLM.Common.Models.Vectorization
Assembly
FoundationaLLM.Common.dll

The result of a text operation request.

public class TextOperationResult
Inheritance
TextOperationResult
Inherited Members
Extension Methods

Properties

ErrorMessage

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

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

Property Value

string

Failed

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

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

Property Value

bool

InProgress

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

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

Property Value

bool

OperationId

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

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

Property Value

string

TextChunks

The list of TextChunk objects containing the results.

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

Property Value

IList<TextChunk>

TokenCount

The number of tokens used during the text operation.

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

Property Value

int