struct · iOS 27.0+ · SDK 27.1
struct GuideA type you use to offer guidance about what search capabillities to employ during a session. 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 ``SpotlightSearchTool/Configuration/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.
static init(level?: SpotlightSearchTool_GuidanceLevel, format?: SpotlightSearchTool_FormatLevel): SpotlightSearchTool_Guideinit(level: SpotlightSearchTool.GuidanceLevel = .complete, format: SpotlightSearchTool.FormatLevel = .structured)get level(): SpotlightSearchTool_GuidanceLevellet level: SpotlightSearchTool.GuidanceLevelThe guidance for the model to use during a session. Use this property to specify custom guidance for how to search your app’s content. The default value of this property is ``SpotlightSearchTool/GuidanceLevel/complete``, which uses all available search techniques and search all content types.
get format(): SpotlightSearchTool_FormatLevellet format: SpotlightSearchTool.FormatLevelThe representation format for tool responses returned to the model. Controls how search results are serialized in the model's context window. Use ``FormatLevel/compact`` to reduce token consumption when working with small-context models or long conversations.
static dynamic(profile: SpotlightSearchTool_GuidanceProfile): SpotlightSearchTool_Guidestatic func dynamic(_ profile: SpotlightSearchTool.GuidanceProfile) -> SpotlightSearchTool.GuideA guide that includes only the search techniques specified by the given profile. - Parameter profile: The set of search techniques and attributes the model may use.
static focused(domain?: SpotlightSearchTool_ContentDomain): SpotlightSearchTool_Guidestatic func focused(_ domain: SpotlightSearchTool.ContentDomain = .items) -> SpotlightSearchTool.GuideA guide that searches only the specified content domain using a compact, on-device-friendly schema. - Parameter domain: The content domain to focus on. Defaults to ``SpotlightSearchTool/ContentDomain/items``.
static get complete(): SpotlightSearchTool_Guidestatic var complete: SpotlightSearchTool.Guide { get }A guide that uses all available search techniques.
No declarations were skipped in this snapshot.