generated: '2026-08-30'
method: derived
source:
- openapi/_original/hbku-fanar-api-openapi.json
- openapi/hbku-farasa-api-openapi.yml
vocabulary:
  name: Hamad Bin Khalifa University Programmable Surface Vocabulary
  description: >-
    Controlled vocabulary for the machine-readable footprint Hamad Bin Khalifa University actually
    operates: the Fanar Arabic generative-AI platform and the Farasa Arabic NLP toolkit, both built
    by the Qatar Computing Research Institute, an HBKU research institute. Terms are drawn from the
    contracts themselves. This file replaces a Figshare vocabulary that described a vendor's
    repository object model rather than anything HBKU engineers.
  version: "2.0.0"
  terms:
  - term: Fanar
    definition: >-
      Qatar's Arabic generative-AI platform, developed by QCRI at HBKU with support from Qatar's
      Ministry of Communications and Information Technology. Also the default model identifier.
    tags: [fanar, platform, ai]
  - term: Model
    definition: >-
      A named generation endpoint in the Fanar family, listed by GET /v1/models as an AvailableModel
      with id, object, created and owned_by. The family spans chat (Fanar-C, Fanar-S), religious
      question answering (Fanar-Sadiq), speech (Fanar-Aura), vision (Fanar-Oryx), translation
      (Fanar-Shaheen-MT), poetry (Fanar-Diwan) and safety (Fanar-Guard).
    tags: [fanar, object, ai]
  - term: Chat Completion
    definition: >-
      The primary Fanar operation, POST /v1/chat/completions. OpenAI-client compatible — the
      provider's own sample points the openai SDK at base_url https://api.fanar.qa/v1 — and supports
      streaming over text/event-stream.
    tags: [fanar, operation, ai]
  - term: Error
    definition: >-
      Fanar's uniform failure envelope, {"error": {code, message, status, param, type}}, with a
      closed fourteen-value ErrorCode enum. See errors/hbku-fanar-errors.yml.
    tags: [fanar, object, errors]
  - term: Moderation
    definition: >-
      POST /v1/moderations, Fanar's content-safety classification endpoint, backed by the
      Fanar-Guard model family.
    tags: [fanar, operation, safety]
  - term: Farasa
    definition: >-
      "Insight" in Arabic. QCRI's Arabic text-processing toolkit, distributed both as downloadable
      JARs and as a keyed web API at farasa.qcri.org/webapi/.
    tags: [farasa, platform, nlp]
  - term: Segmentation
    definition: Splitting Arabic orthographic words into clitics and stems. POST /webapi/segmentation/.
    tags: [farasa, operation, nlp]
  - term: Diacritization
    definition: Restoring the short-vowel marks Arabic text usually omits. POST /webapi/diacritize/.
    tags: [farasa, operation, nlp]
  - term: api_key
    definition: >-
      Farasa's credential, carried as a request-BODY field rather than a header — the one place
      Farasa departs from common practice. Issued on registration at farasa.qcri.org.
    tags: [farasa, authentication]
  - term: QCRI
    definition: >-
      Qatar Computing Research Institute, a research institute of Hamad Bin Khalifa University.
      qcri.org redirects to hbku.edu.qa/en/qcri, which is what makes both APIs above
      institution-operated rather than tenant or vendor surfaces.
    tags: [institution, provenance]
  - term: Manara
    definition: >-
      Manara — Qatar Research Repository, the Figshare platform operated by Qatar National Library
      where HBKU research output is deposited. HBKU's relationship to it is a tenant one: the
      deposits are HBKU's, the contract is Figshare's.
    tags: [repository, tenant, provenance]