Class KnowledgeQueryResult
Namespace: Cephalon.Abstractions.Retrieval
Assembly: Cephalon.Abstractions.dll
Describes the result of a managed retrieval query.
public sealed record KnowledgeQueryResult : IEquatable<KnowledgeQueryResult>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<KnowledgeQueryResult>
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”KnowledgeQueryResult(string, string, DateTimeOffset, IReadOnlyList<KnowledgeQueryMatch>, int, IReadOnlyDictionary<string, string>)
Section titled “ KnowledgeQueryResult(string, string, DateTimeOffset, IReadOnlyList<KnowledgeQueryMatch>, int, IReadOnlyDictionary<string, string>)”Describes the result of a managed retrieval query.
public KnowledgeQueryResult(string CollectionId, string QueryText, DateTimeOffset QueriedAtUtc, IReadOnlyList<KnowledgeQueryMatch> Matches, int TotalIndexedDocuments, IReadOnlyDictionary<string, string> Metadata)Parameters
Section titled “Parameters”CollectionId string
The collection identifier that was queried.
QueryText string
The query text supplied by the caller.
QueriedAtUtc DateTimeOffset
The UTC timestamp when the query executed.
Matches IReadOnlyList<KnowledgeQueryMatch>
The ranked matches returned by the managed query engine.
TotalIndexedDocuments int
The number of indexed documents available at query time.
Metadata IReadOnlyDictionary<string, string>
Optional operator-facing metadata captured with the query result.
Properties
Section titled “Properties”CollectionId
Section titled “ CollectionId”The collection identifier that was queried.
public string CollectionId { get; init; }Property Value
Section titled “Property Value”HasMatches
Section titled “ HasMatches”Gets a value indicating whether the query returned at least one match.
public bool HasMatches { get; }Property Value
Section titled “Property Value”Matches
Section titled “ Matches”The ranked matches returned by the managed query engine.
public IReadOnlyList<KnowledgeQueryMatch> Matches { get; init; }Property Value
Section titled “Property Value”IReadOnlyList<KnowledgeQueryMatch>
Metadata
Section titled “ Metadata”Optional operator-facing metadata captured with the query result.
public IReadOnlyDictionary<string, string> Metadata { get; init; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
QueriedAtUtc
Section titled “ QueriedAtUtc”The UTC timestamp when the query executed.
public DateTimeOffset QueriedAtUtc { get; init; }Property Value
Section titled “Property Value”QueryText
Section titled “ QueryText”The query text supplied by the caller.
public string QueryText { get; init; }Property Value
Section titled “Property Value”TotalIndexedDocuments
Section titled “ TotalIndexedDocuments”The number of indexed documents available at query time.
public int TotalIndexedDocuments { get; init; }