3.5 Yardım ve belge uçları POST /ClientREST/Help* / Doc*

<< İçindekileri Görüntülemek İçin Tıklayın >>

Yer:  Teknik Kılavuzlar > Netsim System Agent İstemci Protokolü Referansı > 3. Diğer HTTP uçları (/ClientREST/...) >

3.5 Yardım ve belge uçları POST /ClientREST/Help* / Doc*

Uygulama içi yardım ve müşteri belgeleri (NetsimApp) için §3.3'teki araçların HTTP karşılığı; aynı havuzlar, aynı kod. Uç adı büyük/küçük harf duyarsız, gövde JSON nesnesi.

  • Help* yardım havuzunu okur: anonim, yetki denetimi yok.
  • Doc* oturumun veritabanının (OpenSession DatabaseName) belge havuzunu okur; oturumda veritabanı yoksa (WebAdmin oturumu) gövdedeki database, varsa gövde onu ezemez. Açık oturum (401). Oturum her istekte SYSAgentSessionID çerezinden bulunur, bağlantıdan değil: istemci WebSocket'e yükseltilmiş ana bağlantısını kullanmaz, her çağrıyı ayrı bir HTTP bağlantısından çerezle gönderir. Süzme kümesi {oturumun kullanıcısı, o kullanıcının oturum veritabanındaki (OpenSessionDatabaseName) rolleri - GRANT zinciri dahil, MASTER rolleri, *}; veritabanı ya da kullanıcı bulunamazsa kullanıcı adı + MASTER rolleri. Masaüstü oturumunun kullanıcısı parolayla doğrulanmaz (§2).
  • Hatalar: 202 {"result": false, "message"} — havuz dosyası yoksa help pool not found (...) / document pool not imported (...), eksik / geçersiz argüman, bulunamayan konu / varlık. Gövdesiz ya da ayrıştırılamayan istek 400.
  • Arama: limit öndeğer 5, en çok 20; mode öndeğer hybrid (fts | vector | hybrid). vector / hybrid model ister; model ya da ONNX Runtime yoksa hata vermeden tam metinle arar ve üstteki method fts olur. score: fts'te bm25 (küçük = iyi), vector'de benzerlik, hybrid'de RRF toplamı (büyük = iyi); öğenin method'u fts | vector | fts+vector. module konunun o modül varlığına bağlı olmasını ister.
  • help_url: konunun form_class'ı için doc$entity_kind.url_template (<key>; <v3> = koleksiyonun help_url_v3'ü, yoksa ajan sürümünün üçüncü alanı). form_class yoksa null.
  • maxChars > 0 ise body_md ilk o kadar karakterle (Unicode kod noktası) kesilir ve truncated: true.
Uç Gövde Başarı (200)
HelpSearch query, module?, limit?, mode? {result: true, method, items: [{slug, title, breadcrumb, snippet, score, method, module, form_class, help_url}]}
HelpTopic slug | form_class | islem_kodu, maxChars? {result: true, slug, title, breadcrumb, body_md, module, form_class, islem_kodu, related: [{slug, title}], help_url, truncated} — çözüm help_get_topic'teki gibi
HelpFormInfo form_class {result: true, form, islem_kodlari, topics, help_url[, legacy_alias]} — help_form_info'nun nesnesi
DocCollections — {result: true, items: [{id, title, kind, erisim, topics, generated}]} — izinli koleksiyonlar
DocSearch query, collection?, module?, limit?, mode? {result: true, method, items: [{collection, slug, title, breadcrumb, snippet, score, method, module, form_class, help_url}]}
DocTopic collection? + slug | kind + key, maxChars? {result: true, collection, slug, title, breadcrumb, category, description, source_uri, mime, mtime, body_md, links, related, module, form_class, islem_kodu, help_url, truncated} — varlıkla bulunursa istenen varlık kendi alanında kalır
DocEntity kind, key {result: true, …} — doc_entity'nin nesnesi