<!--
{
  "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/GuidanceProfile/similarityMatch",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "Core Spotlight",
      "FoundationModels"
    ],
    "preciseIdentifier" : "s:31_CoreSpotlight_FoundationModels0B10SearchToolV15GuidanceProfileV15similarityMatchSbSgvp"
  },
  "title" : "similarityMatch"
}
-->

# similarityMatch

A Boolean value that indicates whether to perform semantic similarity matching on your content.

```
var similarityMatch: Bool?
```

## Discussion

Set the value of this property true `true` to give the model the option to perform semantic searches of
content. This approach allows the search to return results that match the intent of the provided string
and not just the actual search term. For example, if model performs a semantic match against the word
“star”, the tool can match items that contain the text “star”, “sun”, or “Betelgeuse”. If you don’t specify
a value for this property, the default value is `false`.

---

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)