UnforgedFolio DevelopersSafetySecurityPricing
Get started
Get started
Contents

FolioSearchResult

Fields

  • scope required Type: "names" "content"

    What was searched.

  • records required Type: object[]

    Record listings. In a content search each also has pages (matching pages, best first), snippets (null without folio:documents:read; otherwise [{page, parts: [{text, hit}]}]) and low_confidence.

  • matched_records optional Type: integer

    Content scope only.

  • matched_pages optional Type: integer

    Content scope only.

  • not_searchable optional Type: integer

    Content scope only. Records in scope whose text is not extracted yet, or failed.

  • low_confidence optional Type: integer

    Content scope only. Records in scope whose text was read with low confidence.

  • snippets optional Type: boolean

    Content scope only. Whether snippets were shown.

Where you'll see it