Class KnowledgeIndexState
Namespace: Cephalon.Abstractions.Retrieval
Assembly: Cephalon.Abstractions.dll
Describes the latest managed index and query execution state for one knowledge collection.
public sealed record KnowledgeIndexState : IEquatable<KnowledgeIndexState>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<KnowledgeIndexState>
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”KnowledgeIndexState(string, string?, string?, DateTimeOffset?, DateTimeOffset?, DateTimeOffset?, int, string, int, int, int, int, int, DateTimeOffset?, string?, int, int, string?, string?, string?, IReadOnlyDictionary<string, string>)
Section titled “ KnowledgeIndexState(string, string?, string?, DateTimeOffset?, DateTimeOffset?, DateTimeOffset?, int, string, int, int, int, int, int, DateTimeOffset?, string?, int, int, string?, string?, string?, IReadOnlyDictionary<string, string>)”Describes the latest managed index and query execution state for one knowledge collection.
public KnowledgeIndexState(string CollectionId, string? LastRunId, string? LastOutcome, DateTimeOffset? LastObservedAtUtc, DateTimeOffset? LastIndexedAtUtc, DateTimeOffset? SourceFreshnessUtc, int DocumentCount, string FreshnessState, int StartedCount, int SucceededCount, int FailedCount, int SkippedCount, int QueryCount, DateTimeOffset? LastQueriedAtUtc, string? LastQueryFingerprint, int LastQueryLength, int LastQueryMatchedCount, string? LastActorId, string? LastCorrelationId, string? LastError, IReadOnlyDictionary<string, string> Metadata)Parameters
Section titled “Parameters”CollectionId string
The collection identifier represented by this state.
LastRunId string?
The latest indexing run identifier when one has been observed.
LastOutcome string?
The latest indexing outcome when one has been observed.
LastObservedAtUtc DateTimeOffset?
The UTC timestamp when the latest indexing observation was recorded.
LastIndexedAtUtc DateTimeOffset?
The UTC timestamp when the latest replacement index was published.
SourceFreshnessUtc DateTimeOffset?
The newest source-document timestamp observed during the latest successful indexing run.
DocumentCount int
The number of documents currently stored in the managed index.
FreshnessState string
The operator-facing freshness state captured for the latest indexing observation.
StartedCount int
The number of indexing runs that have started.
SucceededCount int
The number of indexing runs that have completed successfully.
FailedCount int
The number of indexing runs that have failed.
SkippedCount int
The number of indexing runs that have been skipped.
QueryCount int
The number of managed queries executed against this collection.
LastQueriedAtUtc DateTimeOffset?
The UTC timestamp when the latest query was executed.
LastQueryFingerprint string?
A non-reversible SHA-256 fingerprint of the latest query text.
LastQueryLength int
The character length of the latest query text.
LastQueryMatchedCount int
The number of matches returned by the latest query.
LastActorId string?
The latest actor identifier when one was supplied by an indexing request.
LastCorrelationId string?
The latest correlation identifier when one was supplied by an indexing request.
LastError string?
The latest operator-facing error summary when indexing failed.
Metadata IReadOnlyDictionary<string, string>
Optional operator-facing metadata captured with the latest indexing observation.
Properties
Section titled “Properties”CollectionId
Section titled “ CollectionId”The collection identifier represented by this state.
public string CollectionId { get; init; }Property Value
Section titled “Property Value”DocumentCount
Section titled “ DocumentCount”The number of documents currently stored in the managed index.
public int DocumentCount { get; init; }Property Value
Section titled “Property Value”FailedCount
Section titled “ FailedCount”The number of indexing runs that have failed.
public int FailedCount { get; init; }Property Value
Section titled “Property Value”FreshnessState
Section titled “ FreshnessState”The operator-facing freshness state captured for the latest indexing observation.
public string FreshnessState { get; init; }Property Value
Section titled “Property Value”LastActorId
Section titled “ LastActorId”The latest actor identifier when one was supplied by an indexing request.
public string? LastActorId { get; init; }Property Value
Section titled “Property Value”LastCorrelationId
Section titled “ LastCorrelationId”The latest correlation identifier when one was supplied by an indexing request.
public string? LastCorrelationId { get; init; }Property Value
Section titled “Property Value”LastError
Section titled “ LastError”The latest operator-facing error summary when indexing failed.
public string? LastError { get; init; }Property Value
Section titled “Property Value”LastIndexedAtUtc
Section titled “ LastIndexedAtUtc”The UTC timestamp when the latest replacement index was published.
public DateTimeOffset? LastIndexedAtUtc { get; init; }Property Value
Section titled “Property Value”LastObservedAtUtc
Section titled “ LastObservedAtUtc”The UTC timestamp when the latest indexing observation was recorded.
public DateTimeOffset? LastObservedAtUtc { get; init; }Property Value
Section titled “Property Value”LastOutcome
Section titled “ LastOutcome”The latest indexing outcome when one has been observed.
public string? LastOutcome { get; init; }Property Value
Section titled “Property Value”LastQueriedAtUtc
Section titled “ LastQueriedAtUtc”The UTC timestamp when the latest query was executed.
public DateTimeOffset? LastQueriedAtUtc { get; init; }Property Value
Section titled “Property Value”LastQueryFingerprint
Section titled “ LastQueryFingerprint”A non-reversible SHA-256 fingerprint of the latest query text.
public string? LastQueryFingerprint { get; init; }Property Value
Section titled “Property Value”LastQueryLength
Section titled “ LastQueryLength”The character length of the latest query text.
public int LastQueryLength { get; init; }Property Value
Section titled “Property Value”LastQueryMatchedCount
Section titled “ LastQueryMatchedCount”The number of matches returned by the latest query.
public int LastQueryMatchedCount { get; init; }Property Value
Section titled “Property Value”LastRunId
Section titled “ LastRunId”The latest indexing run identifier when one has been observed.
public string? LastRunId { get; init; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Optional operator-facing metadata captured with the latest indexing observation.
public IReadOnlyDictionary<string, string> Metadata { get; init; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
QueryCount
Section titled “ QueryCount”The number of managed queries executed against this collection.
public int QueryCount { get; init; }Property Value
Section titled “Property Value”SkippedCount
Section titled “ SkippedCount”The number of indexing runs that have been skipped.
public int SkippedCount { get; init; }Property Value
Section titled “Property Value”SourceFreshnessUtc
Section titled “ SourceFreshnessUtc”The newest source-document timestamp observed during the latest successful indexing run.
public DateTimeOffset? SourceFreshnessUtc { get; init; }Property Value
Section titled “Property Value”StartedCount
Section titled “ StartedCount”The number of indexing runs that have started.
public int StartedCount { get; init; }Property Value
Section titled “Property Value”SucceededCount
Section titled “ SucceededCount”The number of indexing runs that have completed successfully.
public int SucceededCount { get; init; }Property Value
Section titled “Property Value”TotalIndexRuns
Section titled “ TotalIndexRuns”Gets the total number of indexing observations recorded for this collection.
public int TotalIndexRuns { get; }