Class RagResult
Contains the result of an AI search, with relevance score, document refernce, relevant text chunk.
Carrier object for RagResult. Services for the RagResult Carrier is available from the AI Agent.Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.10.0.0")]
public class RagResultConstructors
RagResult()
Default constructor
Declaration
public RagResult()See Also
Properties
Chunk
Markdown text that matched query.
Declaration
[DataMember]
public virtual string Chunk { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Id
Matched document's unique id. Typically a URI.
Declaration
[DataMember]
public virtual string Id { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Metadata
Dictionary of metadata for this result. Keys depend on the source of the document. e.g. 'Title', 'Filename', 'Url', etc.
Declaration
[DataMember]
public virtual StringObjectDictionary Metadata { get; set; }Property Value
| Type | Description |
|---|---|
| StringObjectDictionary |
See Also
Score
Relevancy score (0-1). How close this chunk of the document matched the query.
Declaration
[DataMember]
public virtual double Score { get; set; }Property Value
| Type | Description |
|---|---|
| double |
See Also
Title
Title or filename of matched document, extracted from the Metadata
Declaration
[DataMember]
public virtual string Title { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Type
Content type (web/faq/ticket/...)
Declaration
[DataMember]
public virtual RagType Type { get; set; }Property Value
| Type | Description |
|---|---|
| RagType |
See Also
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | The carrier contents. |
Overrides
See Also
ToString(string)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |