SearchHit

AgentsAI AssistantArtificial IntelligenceChatbotCopilotExtensibilityGenerative AIMicrosoft 365Productivity

Properties

Name	Type	Description
webUrl	string	The URL of the matching document.
preview	string	A preview snippet of the matching content.
resourceType	string	The type of resource (e.g., driveItem).
resourceMetadata	object	Metadata fields for the resource, if requested.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchHit",
  "title": "SearchHit",
  "type": "object",
  "properties": {
    "webUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the matching document.",
      "example": "https://www.example.com"
    },
    "preview": {
      "type": "string",
      "description": "A preview snippet of the matching content.",
      "example": "example_value"
    },
    "resourceType": {
      "type": "string",
      "description": "The type of resource (e.g., driveItem).",
      "example": "example_value"
    },
    "resourceMetadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Metadata fields for the resource, if requested.",
      "example": "example_value"
    }
  }
}