Edit

Share via

retrievalHit resource type

Important

APIs under the /beta version are subject to change. Use of these APIs in production applications is not supported.

Represents a single result within the list of retrieval results.

Properties

Property Type Description
extracts retrievalExtract collection An array of text extracts extracted from the document for Retrieval-Augmented Generation. Currently, only one text snippet is extracted.
resourceMetadata searchResourceMetadataDictionary The requested SharePoint and Microsoft 365 Copilot connectors metadata from the request payload (empty if not applicable).
resourceType retrievalEntityType The resource type of the item.
sensitivityLabel searchSensitivityLabelInfo A JSON object with information about the document's sensitivity label.
webUrl String The URL of the item in which the extract was retrieved.

retrievalEntityType enumeration

An evolvable enumeration with the following possible values.

Value
site
list
listItem
externalItem
drive
driveItem
unknownFutureValue

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.retrievalHit",
  "webUrl": "String",
  "sensitivityLabel": {
    "@odata.type": "microsoft.graph.searchSensitivityLabelInfo"
  },
  "extracts": [
    {
      "@odata.type": "microsoft.graph.retrievalExtract"
    }
  ],
  "resourceType": "String",
  "resourceMetadata": {
    "@odata.type": "microsoft.graph.searchResourceMetadataDictionary"
  }
}