Class ContentSafetyDocumentAnalysisResult

Namespace

FoundationaLLM.Common.Models.ContentSafety

Assembly

FoundationaLLM.Common.dll

Represents the result of a content safety analysis for multiple documents.

public class ContentSafetyDocumentAnalysisResult

Inheritance

object

ContentSafetyDocumentAnalysisResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

Details

Gets or sets the details associated with the analysis, such as error messages if the analysis was not successful.

public string? Details { get; set; }

Property Value

string

DocumentResults

Gets or sets the analysis results for each processed document, indexed by document identifier.

public Dictionary<int, ContentSafetyAnalysisResult> DocumentResults { get; set; }

Property Value

Dictionary<int, ContentSafetyAnalysisResult>

Remarks

Each entry in the dictionary maps a unique document identifier to its corresponding content safety analysis result. The dictionary will be empty if no documents have been analyzed.

Success

Gets or sets a flag representing if the analysis was executed successfully.

public bool Success { get; set; }

Property Value

bool

Remarks

In this context, success means that there was at least one attempt to evaluate each document. The DocumentResults property might still contain documents for which the attempt was not successfully carried out.