OpenQCoreAI
Filloni

Burime · API i Njohurisë

Dokumentacioni i API-së së Njohurisë

Referencë gjithëpërfshirëse për importin e njohurive në hapësirën e punës, marrjen e tyre, rrjedhat e punës për pyetje dhe kufizimet e sigurta për prodhim.

Kthehu te DokumentetShko te Pikat e përfundimit

Pikat e përfundimit

GET /api/v1/console/knowledge
POST /api/v1/console/knowledge
POST /api/v1/console/knowledge/upload
GET /api/v1/console/knowledge/{item_id}
PATCH /api/v1/console/knowledge/{item_id}
DELETE /api/v1/console/knowledge/{item_id}
POST /api/v1/console/knowledge/ask

Koka të kërkuara

Authorization: Bearer [token] ose autentikim me çelës APIX-Scope-Type: workspaceX-Workspace-ID: [workspace_uuid]Content-Type: application/json (ose multipart/form-data për ngarkim)

Shembull Ngarkimi

bash
curl -X POST "/api/v1/console/knowledge/upload" \
  -H "Authorization: Bearer [token]" \
  -H "X-Scope-Type: workspace" \
  -H "X-Workspace-ID: [workspace_uuid]" \
  -F "file=@handbook.pdf" \
  -F "title=Team Handbook" \
  -F "tags=hr,policy"

Shembull Pyetje

json
{
  "question": "What is our remote-work policy?",
  "top_k": 5,
  "filters": {
    "tags": ["hr", "policy"]
  },
  "session_id": "sess_123"
}

Shembull Përgjigje

json
{
  "success": true,
  "answer": "Employees may work remotely up to 3 days per week...",
  "citations": [
    {
      "item_id": "kb_456",
      "title": "Team Handbook",
      "score": 0.91
    }
  ],
  "usage": {
    "input_tokens": 180,
    "output_tokens": 72
  },
  "metadata": {
    "retrieved_items": 5
  }
}

Kufizimet e njohurive

  • Madhësia maksimale e skedarit: 20MB për ngarkim.
  • Formatet e mbështetura: PDF, DOC, DOCX, TXT, Markdown.
  • Ingestimi kryhet në mënyrë asinkrone nga punëtorë në sfond.
  • Shtrirja e hapësirës së punës është e kërkuar për operacionet e njohurive në konsolë.

Cikli i jetës së ngarkimit

  1. në pritje: skedari i pranuar dhe në radhë.
  2. në përpunim: nxjerrja/ndarja në pjesë/ndërtimi i embedding-ut në progres.
  3. i përpunuar: elementi është indeksuar dhe gati për kërkime.
  4. dështuar: ngarkimi dështoi me metadatë diagnostikuese.

Modelet e Gabimeve

400

Përmbajtje e pavlefshme ose filtra të formatuar gabim.

401

Autentikimi mungon ose është i pavlefshëm.

403

Aksesi në hapësirën e punës i mohuar për shkak të rolit/shtrirjes.

404

Artikulli i njohurive nuk u gjet.

413

Skedari i ngarkuar e tejkalon madhësinë e lejuar.

415

Lloji i përmbajtjes së skedarit nuk mbështetet.

422

Dështim i verifikimit në skemën/kontekstin e kërkesës.

429

Kufiri i kërkesave u tejkalua.