Class KnowledgeQueryMatch
Namespace: Cephalon.Abstractions.Retrieval
Assembly: Cephalon.Abstractions.dll
Describes one ranked document match returned by the managed query engine.
public sealed record KnowledgeQueryMatch : IEquatable<KnowledgeQueryMatch>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<KnowledgeQueryMatch>
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”KnowledgeQueryMatch(string, string, string, string, int, Uri?, IReadOnlyList<string>, DateTimeOffset?, IReadOnlyDictionary<string, string>)
Section titled “ KnowledgeQueryMatch(string, string, string, string, int, Uri?, IReadOnlyList<string>, DateTimeOffset?, IReadOnlyDictionary<string, string>)”Describes one ranked document match returned by the managed query engine.
public KnowledgeQueryMatch(string CollectionId, string DocumentId, string Title, string ContentSnippet, int Score, Uri? Uri, IReadOnlyList<string> Tags, DateTimeOffset? LastModifiedAtUtc, IReadOnlyDictionary<string, string> Metadata)Parameters
Section titled “Parameters”CollectionId string
The collection identifier that produced the match.
DocumentId string
The matched document identifier.
Title string
The matched document title.
ContentSnippet string
A short content snippet around the matched text.
Score int
The lexical relevance score assigned by the managed query engine.
Uri Uri?
The optional source document URI.
Tags IReadOnlyList<string>
The normalized tags attached to the matched document.
LastModifiedAtUtc DateTimeOffset?
The UTC timestamp when the matched source document was last modified.
Metadata IReadOnlyDictionary<string, string>
The operator-facing metadata attached to the matched document.
Properties
Section titled “Properties”CollectionId
Section titled “ CollectionId”The collection identifier that produced the match.
public string CollectionId { get; init; }Property Value
Section titled “Property Value”ContentSnippet
Section titled “ ContentSnippet”A short content snippet around the matched text.
public string ContentSnippet { get; init; }Property Value
Section titled “Property Value”DocumentId
Section titled “ DocumentId”The matched document identifier.
public string DocumentId { get; init; }Property Value
Section titled “Property Value”LastModifiedAtUtc
Section titled “ LastModifiedAtUtc”The UTC timestamp when the matched source document was last modified.
public DateTimeOffset? LastModifiedAtUtc { get; init; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”The operator-facing metadata attached to the matched document.
public IReadOnlyDictionary<string, string> Metadata { get; init; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
The lexical relevance score assigned by the managed query engine.
public int Score { get; init; }Property Value
Section titled “Property Value”The normalized tags attached to the matched document.
public IReadOnlyList<string> Tags { get; init; }Property Value
Section titled “Property Value”The matched document title.
public string Title { get; init; }Property Value
Section titled “Property Value”The optional source document URI.
public Uri? Uri { get; init; }Property Value
Section titled “Property Value”Uri?