Skip to main content

​
Class RagResult

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for RagResult. Contains the result of an AI search, with relevance score, document refernce, relevant text chunk.

​
Inheritance

object ← RagResult

​
Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
RagResult()

Default constructor - defaults any enum props to 0.

​
Properties

​
Chunk

Markdown text that matched query.

​
Property Value

string

​
Id

Matched document’s unique id. Typically a URI.

​
Property Value

string

​
Metadata

Dictionary of metadata for this result. Keys depend on the source of the document. e.g. ‘Title’, ‘Filename’, ‘Url’, etc.

​
Property Value

StringObjectDictionary

​
Score

Relevancy score (0-1). How close this chunk of the document matched the query.

​
Property Value

double

​
Title

Title or filename of matched document, extracted from the Metadata

​
Property Value

string

​
Type

Content type (web/faq/ticket/…) NULL if unknown enum value.

​
Property Value

RagType?

​
See Also

RagResult.Type_String

​
Type_String

Content type (web/faq/ticket/…) Raw string enum value.

​
Property Value

string

​
See Also

RagResult.Type

​
See Also

AIAgent

Related topics

WebAPI changes in SuperOffice 12.0WebAPI changes in SuperOffice 12.1WebAPI changes in SuperOffice 12.2SuperOffice WebApiHow to use SuperOffice.WebApiHow to create a user-defined field using the web services APIHow to update a user-defined field using the web services API