Connecting to OCLC FAST - samvera/questioning_authority GitHub Wiki

Overview

QA provides a wrapper around OCLC's FAST autocomplete service. The following subauthorities are available: Subauthorities:

  • for search:
    • all
    • personal
    • corporate
    • event
    • uniform
    • topical
    • geographic
    • form_genre
  • for term: TBD

Configuration

Configuration for non-linked-data OCLC fast is in file https://github.com/samvera/questioning_authority/blob/main/config/authorities/assign_fast/oclc_assign_fast.json .

Note that you should be able to override any of the settings it contains with an identically-named file in YOUR app's config directory. Place the file in config/authorities/assign_fast and the configuration code should detect the file and override QA's defaults with the ones you specify.

Prerequisites

No additional setup required.

Accessing via QA

Authority assign_fast

NOTE: The linked data module for QA also provides access to this authority. It returns additional data including the URI for terms. See Using-the-Linked-Data-module-to-access-authorities for more information.


Example search queries

Example search across all subauthorities:

/qa/search/assign_fast/all?q=periodic+table

The result includes both 'label' and 'value' to help users select the correct heading, e.g.:

[
    {
        "id":"fst01789629",
        "label":"Periodic table",
        "value":"Periodic table"
    },
    {
        "id":"fst01789629",
        "label":"Periodic table (Saunders, N.) USE Periodic table",
        "value":"Periodic table"
    },...
]

NOTE: The qa request is converted to the following OCLC FAST request. This is for information only. You do not need to know this to use QA.

http://fast.oclc.org/searchfast/fastsuggest?&query=periodic+table&queryIndex=suggestall&queryReturn=suggestall%2Cidroot%2Cauth%2Ctype&suggest=autoSubject&rows=20"

Example term fetch request

TBD


Example list all terms

Not supported


Documentation

Provide a link to the documentation that was used to build this connection to the authority.

OCLC documents their FAST API at... http://www.oclc.org/developer/develop/web-services/fast-api/assign-fast.en.html

⚠️ **GitHub.com Fallback** ⚠️