Class KnowledgeDocument
Namespace: Cephalon.Retrieval.Services
Assembly: Cephalon.Retrieval.dll
Describes one source document that can be indexed by the managed retrieval runtime.
public sealed class KnowledgeDocumentInheritance
Section titled “Inheritance”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”KnowledgeDocument(string, string, string, Uri?, IReadOnlyList<string>?, DateTimeOffset?, IReadOnlyDictionary<string, string>?)
Section titled “ KnowledgeDocument(string, string, string, Uri?, IReadOnlyList<string>?, DateTimeOffset?, IReadOnlyDictionary<string, string>?)”Creates a knowledge document for managed indexing.
public KnowledgeDocument(string id, string title, string content, Uri? uri = null, IReadOnlyList<string>? tags = null, DateTimeOffset? lastModifiedAtUtc = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable document identifier within its collection.
title string
The human-readable document title.
content string
The searchable document content.
uri Uri?
An optional document URI for operator drill-down.
tags IReadOnlyList<string>?
Optional tags that classify the document.
lastModifiedAtUtc DateTimeOffset?
The UTC timestamp when the source document was last modified.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata attached to the document.
Properties
Section titled “Properties”Content
Section titled “ Content”Gets the searchable document content.
public string Content { get; }Property Value
Section titled “Property Value”Gets the stable document identifier within its collection.
public string Id { get; }Property Value
Section titled “Property Value”LastModifiedAtUtc
Section titled “ LastModifiedAtUtc”Gets the UTC timestamp when the source document was last modified.
public DateTimeOffset? LastModifiedAtUtc { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets optional operator-facing metadata attached to the document.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Gets the normalized tags that classify the document.
public IReadOnlyList<string> Tags { get; }Property Value
Section titled “Property Value”Gets the human-readable document title.
public string Title { get; }Property Value
Section titled “Property Value”Gets an optional document URI for operator drill-down.
public Uri? Uri { get; }Property Value
Section titled “Property Value”Uri?