Class RetrievalHit

Represents a single result within the list of retrieval results.

public class RetrievalHit

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

An array of text extracts extracted from the document for Retrieval-Augmented Generation. Currently, only one text snippet is extracted.

[JsonPropertyName("extracts")]
public List<RetrievalExtract> Extracts { get; set; }

The requested SharePoint and Microsoft 365 Copilot connectors metadata from the request payload (empty if not applicable).

[JsonPropertyName("resourceMetadata")]
public Dictionary<string, object>? ResourceMetadata { get; set; }

The resource type of the item. Possible values: site, list, listItem, externalItem, drive, driveItem ,unknownFutureValue

[JsonPropertyName("resourceType")]
public string ResourceType { get; set; }

A JSON object with information about the document's sensitivity label.

[JsonPropertyName("sensitivityLabelInfo")]
public SensitivityLabelInfo? SensitivityLabelInfo { get; set; }

The URL of the item in which the extract was retrieved.

[JsonPropertyName("webUrl")]
public string WebUrl { get; set; }