OpenQCoreAI
Commencer

Ressources · Docs

Documentation de la plateforme.

Prêt pour la production par conception.

Documentation OpenQCore pour les équipes qui créent des produits d'IA fiables pour le chat, la voix, la génération multimodale et les workflows de connaissance, avec un contrôle du runtime limité par périmètre.

Commencez à construireSurface de l'API
Runtime orienté APIPérimètres pour espaces de travail et personnelsStreaming + Non-streamingLimitation de débit + Déduplication + VerrouillagePipeline vocal (STT/LLM/TTS)API de connaissances de la console

Démarrage rapide

Du premier appel à la mise en production en quelques minutes.

1) S'authentifier

Utilisez l'authentification par session JWT ou par clé API avec un contrôle d'accès tenant compte du scope.

2) Choisir le périmètre d'exécution

Définissez le contexte personnel ou l'espace de travail en utilisant les en-têtes d'exécution si nécessaire.

3) Appeler les complétions de chat

Utilisez /api/v1/chat/completions pour l'exécution principale de l'assistant.

4) Ajouter la voix et le multimodal

Utilisez les endpoints /api/v1/voice et Iris pour les flux STT/TTS, image, vidéo et OCR.

5) Intégrer les connaissances

Utilisez /api/v1/console/knowledge pour le téléversement, l'ingestion et les requêtes basées sur la récupération.

URL de base

Base de l'API publique

/api/v1

Tous les endpoints publics de la plateforme sont montés sous /api/v1.

Authentification & périmètre

Accès contextuel pour l'exécution personnelle et en espace de travail.

Méthodes d'authentification

JWT/session or API key

En-tête de scope

X-Scope-Type: personal | workspace

En-tête d'espace de travail

X-Workspace-ID: [uuid] (required in workspace scope)

En-tête d'agent

X-Agent-ID: [uuid] (optional)

Règles de validation

  • Si scope est personal, workspace_id n'est pas autorisé.
  • Si scope est workspace, workspace_id est requis.
  • Les en-têtes de scope invalides renvoient 422.

Limites de débit

Limitation basée sur la politique selon le contexte d'authentification.

Clé API

60 requêtes / minute

La clé du bucket utilise l'identité hachée de la clé API.

JWT/session

120 requêtes / minute

La clé du bucket utilise l'ID du workspace si présent, sinon l'ID de l'utilisateur.

En-têtes de réponse pour la limitation

Retry-AfterX-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset

Runtime de chat

/chat/completions avec des couches de contrôle en production.

GET /api/v1/chat/health
POST /api/v1/chat/completions

Comportements d'exécution

  • Suivi du backpressure et rejet en cas de surcharge du système (503).
  • Verrou distribué pour empêcher le traitement en double en cours (409).
  • Cache de déduplication pour les réponses non-stream.
  • Persistance des sessions/messages pour les tours utilisateur et assistant.
  • Validation à l'exécution des requêtes, pièces jointes et accès aux sessions.

Runtime vocal

Pipeline STT → LLM → TTS avec streaming et interruption.

POST /api/v1/voice/chat/meta
POST /api/v1/voice/chat
POST /api/v1/voice/interrupt/{session_id}
WS /api/v1/voice/ws

Fonctionnalités vocales

  • Routage vers un fournisseur de secours (OpenAI + Azure).
  • Disjoncteurs pour les phases STT, LLM et TTS.
  • Pipeline de conversion audio pour les entrées non WAV.
  • Réponses audio en streaming avec en-têtes de métadonnées.
  • Contexte d'annulation pour interruption au niveau de la session.
  • Réduction de charge et dégradation de la qualité en cas de forte charge.

Iris multimodal

Flux de travail d'images, vidéos, OCR et vérification routés par modèle.

Catalogue de modèles

iris-orbit

Mode de routage automatique

iris-genesis

Génération d'images

iris-edit

Édition d'images (non implémentée)

iris-lens

Analyse d'images (non implémentée)

iris-video

Génération de vidéos

iris-ocr

OCR de documents

iris-verify

Vérification d'identité

iris-guard

Détection de fraude (non implémentée)

iris-face

Vérification faciale (non implémentée)

Connaissances de la console

APIs de connaissances de la console de l'espace de travail pour l'ingestion et l'interrogation.

/api/v1/console/knowledge
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

Contraintes de connaissances

  • Taille maximale du fichier : 20 Mo
  • Types autorisés : PDF, DOC, DOCX, TXT, Markdown
  • L'ingestion s'exécute de manière asynchrone en arrière-plan
  • Statuts : pending → processing → processed | failed

Sémantique des erreurs

Classes de réponse courantes de la plateforme.

400

Requête invalide, données manquantes ou saisie malformée

401

Authentification manquante ou invalide

403

Portée non autorisée / restriction liée au rôle dans l'espace de travail

404

Ressource introuvable

409

Requête déjà en cours de traitement (conflit de verrou)

413

Charge utile trop volumineuse (p. ex. limites audio/fichier)

415

Type de contenu non pris en charge

422

Échec de validation (portée/contexte/schéma)

429

Limite de requêtes dépassée

503

Surcharge du système / fournisseur indisponible

Observabilité

Exécution traçable sur l'ensemble des cycles de vie du chat et de la voix.

  • Identifiants de trace pour la corrélation des requêtes.
  • Pipeline de middleware pour la journalisation de l'utilisation.
  • Initialisation d'OpenTelemetry avec export OTLP.
  • Les en-têtes de réponse exposent des signaux de temporisation dans les flux vocaux.
X-Trace-IDX-Session-IDX-STT-Time-MSX-LLM-Time-MSX-TTS-Time-MS

Navigation de la documentation

Explorer les sections de la documentation

Accédez directement aux guides d'implémentation et aux références de production pour chaque surface d'exécution.

Authentification

Authentification par JWT/clé API, en-têtes de portée et modèle de validation.

API de chat

Complétions, comportement du streaming et contrôles d'exécution.

API Vocale

Pipeline vocal en temps réel, flux d'interruption et en-têtes de métadonnées.

API Iris

Points de terminaison et routage pour image/vidéo/OCR/vérification.

API de connaissances

Téléversement, cycle de vie de l'indexation, récupération et workflows de requête.

Fournisseurs

Matrice des capacités, politique de routage et stratégie de basculement.

Contrats de sortie

Enveloppe de réponse unifiée pour les fournisseurs et les modalités.

Architecture

Couches d'exécution, abstraction des fournisseurs et garanties du système.

Construisez en toute confiance sur l'environnement d'exécution OpenQCore.

Utilisez la documentation comme votre guide de production pour le chat, la voix, la génération multimodale et l'exécution basée sur la connaissance.

Explorateur Open APIAccéder à l'infrastructure