<!--
{
  "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/SearchReply/stageToken-swift.property",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "Core Spotlight",
      "FoundationModels"
    ],
    "preciseIdentifier" : "s:31_CoreSpotlight_FoundationModels0B10SearchToolV0E5ReplyV10stageTokenAE05StageI0Vvp"
  },
  "title" : "stageToken"
}
-->

# stageToken

An opaque value you use to identify the pipeline stage that generated the reply.

```
let stageToken: SpotlightSearchTool.SearchReply.StageToken
```

## Discussion

The Spotlight search tool provides several ways to search content, and implements each technique
as an independent stage. For a given query, a model can run multiple stages to generate the
results of the query. Use this property to associate search reply structures with a specific
stage. The token itself is an opaque value you save and compare against tokens in other
search replies. You might use this value to partition the data you receive.

---

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)