> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.RagResult

# <a id="SuperOffice_WebApi_Data_RagResult" /> Class RagResult

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for RagResult.
Contains the result of an AI search, with relevance score, document refernce, relevant text chunk.

```csharp theme={null}
public class RagResult
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[RagResult](SuperOffice.WebApi.Data.RagResult.md)

#### Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_RagResult__ctor" /> RagResult()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public RagResult()
```

## Properties

### <a id="SuperOffice_WebApi_Data_RagResult_Chunk" /> Chunk

Markdown text that matched query.

```csharp theme={null}
public virtual string Chunk { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_RagResult_Id" /> Id

Matched document's unique id. Typically a URI.

```csharp theme={null}
public virtual string Id { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_RagResult_Metadata" /> Metadata

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

```csharp theme={null}
public virtual StringObjectDictionary Metadata { get; set; }
```

#### Property Value

[StringObjectDictionary](SuperOffice.WebApi.Data.StringObjectDictionary.md)

### <a id="SuperOffice_WebApi_Data_RagResult_Score" /> Score

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

```csharp theme={null}
public virtual double Score { get; set; }
```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)

### <a id="SuperOffice_WebApi_Data_RagResult_Title" /> Title

Title or filename of matched document, extracted from the Metadata

```csharp theme={null}
public virtual string Title { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_RagResult_Type" /> Type

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

```csharp theme={null}
[JsonIgnore]
public RagType? Type { get; set; }
```

#### Property Value

[RagType](SuperOffice.WebApi.Data.RagType.md)?

#### See Also

[RagResult](SuperOffice.WebApi.Data.RagResult.md).[Type\_String](SuperOffice.WebApi.Data.RagResult.md#SuperOffice_WebApi_Data_RagResult_Type_String)

### <a id="SuperOffice_WebApi_Data_RagResult_Type_String" /> Type\_String

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

```csharp theme={null}
[JsonProperty("Type")]
public string Type_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[RagResult](SuperOffice.WebApi.Data.RagResult.md).[Type](SuperOffice.WebApi.Data.RagResult.md#SuperOffice_WebApi_Data_RagResult_Type)

## See Also

[AIAgent](SuperOffice.WebApi.Agents.AIAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.RagAnswer](/en/api/reference/webapi/SuperOffice.WebApi.Data.RagAnswer.md)
- [SuperOffice.WebApi.Agents.AIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AIAgent.md)
- [SuperOffice.WebApi.Agents.IAIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAIAgent.md)
- [SuperOffice.WebApi.Data.RagStatus](/en/api/reference/webapi/SuperOffice.WebApi.Data.RagStatus.md)
- [SuperOffice.WebApi.Data.RagType](/en/api/reference/webapi/SuperOffice.WebApi.Data.RagType.md)
- [SuperOffice.WebApi.Data.RagStatusChunks](/en/api/reference/webapi/SuperOffice.WebApi.Data.RagStatusChunks.md)