<!--
{
  "availability" : [
    "iOS: 27.0.0 -",
    "iPadOS: 27.0.0 -",
    "macCatalyst: 27.0.0 -",
    "macOS: 27.0.0 -",
    "visionOS: 27.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "CoreSpotlight",
  "identifier" : "/documentation/CoreSpotlight/SpotlightSearchTool/Guide",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Core Spotlight",
      "FoundationModels",
      "_CoreSpotlight_FoundationModels"
    ],
    "preciseIdentifier" : "s:31_CoreSpotlight_FoundationModels0B10SearchToolV5GuideV"
  },
  "title" : "SpotlightSearchTool.Guide"
}
-->

# SpotlightSearchTool.Guide

A type you use to offer guidance about what search capabillities to employ during a session.

```
struct Guide
```

## Overview

Use this type to specify additional guidance about how you want the model to search your content. At
configuration time, configure an instance of this structure and assign it to the
[`guide`](/documentation/CoreSpotlight/SpotlightSearchTool/Configuration-swift.struct/guide) property of your configuration object. You use guidance
options primarily to limit the types of searches the model performs or to scope searches to specific
types of content. Adding guidance can help improve the efficiency of searches, especially if you
eliminate search techniques that don’t apply to your content.

## Topics

### Creating the search tool

[`init(level: SpotlightSearchTool.GuidanceLevel, format: SpotlightSearchTool.FormatLevel)`](/documentation/CoreSpotlight/SpotlightSearchTool/Guide/init(level:format:))

### Getting the guidance

[`let level: SpotlightSearchTool.GuidanceLevel`](/documentation/CoreSpotlight/SpotlightSearchTool/Guide/level)

The guidance for the model to use during a session.

[`let format: SpotlightSearchTool.FormatLevel`](/documentation/CoreSpotlight/SpotlightSearchTool/Guide/format)

The representation format for tool responses returned to the model.

### Setting the guidance levels

[`static var complete: SpotlightSearchTool.Guide`](/documentation/CoreSpotlight/SpotlightSearchTool/Guide/complete)

A guide that uses all available search techniques.

[`static func dynamic(SpotlightSearchTool.GuidanceProfile) -> SpotlightSearchTool.Guide`](/documentation/CoreSpotlight/SpotlightSearchTool/Guide/dynamic(_:))

A guide that includes only the search techniques specified by the given profile.

[`static func focused(SpotlightSearchTool.ContentDomain) -> SpotlightSearchTool.Guide`](/documentation/CoreSpotlight/SpotlightSearchTool/Guide/focused(_:))

A guide that searches only the specified content domain using a compact, on-device-friendly schema.

## Relationships

### Conforms To

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`Sendable`](/documentation/Swift/Sendable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)