Class KnowledgeIndexingResult
Namespace: Cephalon.Abstractions.Retrieval
Assembly: Cephalon.Abstractions.dll
Describes the result of a managed indexing attempt.
public sealed record KnowledgeIndexingResult : IEquatable<KnowledgeIndexingResult>Inheritance
Section titled “Inheritance”object ← KnowledgeIndexingResult
Implements
Section titled “Implements”IEquatable<KnowledgeIndexingResult>
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”KnowledgeIndexingResult(string, string, string, DateTimeOffset, DateTimeOffset?, DateTimeOffset?, int, string?, IReadOnlyDictionary<string, string>)
Section titled “ KnowledgeIndexingResult(string, string, string, DateTimeOffset, DateTimeOffset?, DateTimeOffset?, int, string?, IReadOnlyDictionary<string, string>)”Describes the result of a managed indexing attempt.
public KnowledgeIndexingResult(string CollectionId, string RunId, string Outcome, DateTimeOffset ObservedAtUtc, DateTimeOffset? IndexedAtUtc, DateTimeOffset? SourceFreshnessUtc, int DocumentCount, string? Error, IReadOnlyDictionary<string, string> Metadata)Parameters
Section titled “Parameters”CollectionId string
The collection identifier that was indexed.
RunId string
The stable indexing run identifier.
Outcome string
The stable indexing outcome identifier.
ObservedAtUtc DateTimeOffset
The UTC timestamp when the outcome was observed.
IndexedAtUtc DateTimeOffset?
The UTC timestamp when the replacement index was published.
SourceFreshnessUtc DateTimeOffset?
The newest source-document timestamp observed during indexing.
DocumentCount int
The number of documents stored in the replacement index.
Error string?
The operator-facing error summary when indexing failed.
Metadata IReadOnlyDictionary<string, string>
Optional operator-facing metadata captured with the result.
Properties
Section titled “Properties”CollectionId
Section titled “ CollectionId”The collection identifier that was indexed.
public string CollectionId { get; init; }Property Value
Section titled “Property Value”DocumentCount
Section titled “ DocumentCount”The number of documents stored in the replacement index.
public int DocumentCount { get; init; }Property Value
Section titled “Property Value”The operator-facing error summary when indexing failed.
public string? Error { get; init; }Property Value
Section titled “Property Value”IndexedAtUtc
Section titled “ IndexedAtUtc”The UTC timestamp when the replacement index was published.
public DateTimeOffset? IndexedAtUtc { get; init; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Optional operator-facing metadata captured with the result.
public IReadOnlyDictionary<string, string> Metadata { get; init; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
ObservedAtUtc
Section titled “ ObservedAtUtc”The UTC timestamp when the outcome was observed.
public DateTimeOffset ObservedAtUtc { get; init; }Property Value
Section titled “Property Value”Outcome
Section titled “ Outcome”The stable indexing outcome identifier.
public string Outcome { get; init; }Property Value
Section titled “Property Value”The stable indexing run identifier.
public string RunId { get; init; }Property Value
Section titled “Property Value”SourceFreshnessUtc
Section titled “ SourceFreshnessUtc”The newest source-document timestamp observed during indexing.
public DateTimeOffset? SourceFreshnessUtc { get; init; }