Documentation / Version 0.17

Артық күрделіліксіз қосу

Қысқаша ашық нұсқаулық клиент келісімін және операциялық реттілікті көрсетеді. Толық admin runbook on-premise пакетпен жеткізіледі.

API quickstartPilot docs

Негізгі ұғымдар

Клиент физикалық provider-ді тікелей таңдамайды. Ол белсенді tenant policy арқылы шешілетін model alias жібереді.

  • 01
    Provider

    OpenAI-compatible upstream endpoint, public/private class және шифрланған credential.

  • 02
    Model alias

    Upstream model ID-мен байланысқан тұрақты клиент идентификаторы.

  • 03
    Policy version

    Модель allowlist-і, лимиттер, DLP, Guard және sensitive route.

  • 04
    Security event

    Prompt/response content сақтамайтын шешім метадеректері.

Қолданбадан сұрау

Control Center-де қажетті scope бар service account және gateway API key жасаңыз. Құпия тек жасалған кезде көрсетіледі.

curl / OpenAI-compatible requestHTTPS
curl https://gateway.cyberpass.kz/v1/chat/completions \
  -H "Authorization: Bearer cpsk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "public-general",
    "messages": [
      {"role": "user", "content": "Reply with pilot-ready"}
    ]
  }'
Тек synthetic test text пайдаланыңыз. Алғашқы тексеруге production secret қоймаңыз.

Жұмыс орнынан сұрау

Enrollment аяқталғаннан кейін Windows Connector жергілікті OpenAI-compatible proxy іске қосады. Қолданба loopback base URL және кез келген бос емес placeholder key көрсетеді.

local client base URLWindows beta
Base URL: http://127.0.0.1:8765/v1
API key:  local-placeholder
Model:    public-general

Browser extension

Extension тек Connector-мен байланысады. Ол қолдау көрсетілетін сайттардағы text prompt-тарды тексереді, бірақ кез келген TLS трафигін ұстамайды және файлдарды талдамайды.

Firewall арқылы MCP

Әкімші Control Center-де Streamable HTTP server және tool pattern ережелерін тіркейді. IDE немесе агент Connector-дың жергілікті URL-ын қолданады; device token клиентке қолжетімсіз қалады.

IDE MCP URLtools/list · tools/call
http://127.0.0.1:8765/mcp/internal-tools

Action мәні бар шақыру require_approval approval ID қайтарады. Аналитик шешім қабылдағаннан кейін клиент сол шақыруды мына мәнмен қайталайды: params._meta["io.cyberpass/approvalId"]. Approval server, tool және аргументтердің SHA-256 мәніне байланысқан және бір рет қолданылады.

On-premise deployment

Production-like пилот Linux host, Docker Compose, тапсырыс беруші ingress-і және customer PKI пайдаланады.

pilot lifecycleoperator
./deploy/pilot/init-env.sh
./deploy/pilot/preflight.sh
./deploy/pilot/install.sh

# later, pinned upgrade
./deploy/pilot/upgrade.sh origin/main <40-char-sha>

Жаңарту backup жасап, acceptance тексерулерін іске қосады. Alembic revision өзгерсе, database downgrade автоматты түрде орындалмайды.

Events және SIEM

Gateway request ID, decision, policy/model route, detector ID, risk score және timing сақтайды. Event schema ішінде prompt және response content жоқ.

SIEM destination Syslog UDP/TCP арқылы CEF қолдайды. Асинхронды кезек bounded retry және DLQ қолданады; тапсырыс беруші желісі жеткізуге рұқсат етуі керек.

Қазіргі шектеулер

LLM protocolsOpenAI-compatibleБасқа хаттамалар reusable adapter roadmap құрамында.
ContentTextФайлдар, OCR және multimodal контент бөлек.
Human identityBaselineLocal auth, OIDC және LDAP/AD; нақты claims/schema және MFA policy тапсырыс берушімен тексеріледі.
AvailabilityPilot topologySingle-node PostgreSQL/Redis in Compose.

Толық pilot runbook керек пе?

Ол сіздің PKI, DNS, model endpoint және acceptance checklist талаптарыңызға бейімделеді.

Пилотты сұрау →