Class KnowledgeQueryRequest
Namespace: Cephalon.Abstractions.Retrieval
Assembly: Cephalon.Abstractions.dll
Describes a managed retrieval query request for one knowledge collection.
public sealed class KnowledgeQueryRequestInheritance
Section titled “Inheritance”object ← KnowledgeQueryRequest
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”KnowledgeQueryRequest(string, string, int?, string?, string?, IReadOnlyDictionary<string, string>?)
Section titled “ KnowledgeQueryRequest(string, string, int?, string?, string?, IReadOnlyDictionary<string, string>?)”Creates a managed retrieval query request.
public KnowledgeQueryRequest(string collectionId, string queryText, int? maxResults = null, string? actorId = null, string? correlationId = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”collectionId string
The collection identifier to query.
queryText string
The text to search for.
maxResults int?
The optional maximum number of matches to return. When omitted, the runtime default is used.
actorId string?
The optional actor that requested the query.
correlationId string?
The optional correlation identifier for the query.
metadata IReadOnlyDictionary<string, string>?
Optional request metadata used by provider-specific query engines.
Properties
Section titled “Properties”ActorId
Section titled “ ActorId”Gets the optional actor that requested the query.
public string? ActorId { get; }Property Value
Section titled “Property Value”CollectionId
Section titled “ CollectionId”Gets the collection identifier to query.
public string CollectionId { get; }Property Value
Section titled “Property Value”CorrelationId
Section titled “ CorrelationId”Gets the optional correlation identifier for the query.
public string? CorrelationId { get; }Property Value
Section titled “Property Value”MaxResults
Section titled “ MaxResults”Gets the optional maximum number of matches to return.
public int? MaxResults { get; }Property Value
Section titled “Property Value”int?
Metadata
Section titled “ Metadata”Gets optional request metadata used by provider-specific query engines.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
QueryText
Section titled “ QueryText”Gets the text to search for.
public string QueryText { get; }