Sources

Match the captures that name no feature to the features they show.

A recording counts toward a feature only when it names that feature. A recording that names none is matched from its own name, the page it was recorded on and the tour it ran against each feature's name, pages and tours: a strong match is tagged by itself (marked featureSource: "matched" until the writer confirms it), and any other likely match is offered as suggestedFeature for the writer to confirm or correct. Every capture that names no feature and ran no stored tour is matched, newest first: its match (feature, confidence and the reason in plain words) and whether it is strong. A dry run unless { apply: true }, which tags the strong matches (featureSource: "matched") and leaves the rest for the writer; a capture already named is never changed. A tagged capture is never matched again, so no Idempotency-Key. Free.

post/story-projects/{projectId}/captures/match-features

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/captures/match-features
  • Auth: HTTP bearer

Request body

applyboolean

True tags the strong matches; left out or false is a dry run.

Response

Each untagged capture with its match, and how many were (or would be) tagged.

projectIdstring required
appliedboolean required

Whether this call tagged the strong matches or only reported them.

taggedCountinteger required

How many captures were (or would be) tagged: the strong matches.

leftCountinteger required

How many are left for the writer: a likely or weak match to confirm, or none.

Changes

No recorded changes to this operation across all 1 revision of this API.