Docs / Démarrer

Démarrage rapide

Aperçu développeur

Trois étapes : récupérer un jeton, lancer une recherche, poser une question. Les points d'accès marqués « Disponible » fonctionnent dès aujourd'hui ; ceux marqués « Prévu » arriveront avec le noyau ouvert.

1
Récupérer un jeton
Le jeton se trouve dans le fichier token du répertoire de données. Il est généré automatiquement au premier démarrage et n'est lisible que par l'utilisateur actuel.
Terminal
cat <répertoire-de-données>/token
# Chaque point d'accès /api/v1 en a besoin ; écoute uniquement sur 127.0.0.1:8090 par défaut
2
Recherche
Recherchez vos documents en langage naturel. Les résultats incluent le fichier, l'emplacement et le passage, sans dépendre des noms de fichier.
Terminal
curl http://127.0.0.1:8090/api/v1/search \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"query": "conditions de paiement du contrat fournisseur", "top_k": 5}'
3
Questions
Réponse en flux. Avec la recherche activée, il ne répond que d'après vos fichiers et cite ses sources.
Terminal
curl -N http://127.0.0.1:8090/api/v1/chat/stream \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"messages": [{"role": "user", "content": "Qu'est-ce qui a été décidé à la réunion de la semaine dernière ?"}],
       "search": true}'

État de l'API

APICe qu'elle faitÉtat
MCP · ownward-mcp
Permet aux agents compatibles MCP d'utiliser directement la recherche, les questions-réponses et la bibliothèque ; les outils à effet de bord ne sont pas exposés.
Disponible
POST /api/v1/search
Une seule recherche dans documents, images, audio et vidéo.
Disponible
POST /api/v1/search-image
Recherchez des images à partir d'une image.
Disponible
POST /api/v1/search/video-clips
Repérez le segment exact dans une vidéo.
Disponible
POST /api/v1/chat/stream
Questions-réponses en flux via SSE, avec sources.
Disponible
POST /api/v1/generate
Génération d'images et de vidéos. Une durée que la machine ne peut pas mener à bout est refusée sur-le-champ, et le maximum pris en charge est renvoyé.
Disponible
GET /hub/index.json
Catalogue de scénarios ; vérifié par sha256 avant l'enregistrement.
Disponible
SDK · Python / JS / C++
Empaquette les points d'accès ci-dessus en bibliothèques clientes pour chaque langage.
Prévu
API compatible OpenAI
Les outils existants se connectent en changeant l'adresse du point d'accès.
Prévu
Connecteurs MCP
Connectez des outils et des sources de données tiers via MCP.
Prévu

Modèles

Chaque type de tâche a un choix par défaut que vous pouvez remplacer dans les réglages. Les modèles cloud sont facultatifs et désactivés par défaut.

Recherche
Texte et multimodal
Embeddings · reclassement · parcimonieux · vision des pages de documents
Images
Compréhension des images
Sémantique image-texte · visages · OCR · légendes
Audio
Compréhension de l'audio
Transcription · alignement mot à mot · locuteurs · événements
Vidéo
Analyse vidéo
Détection de plans · détection et suivi
Conversation
Questions-réponses et planification
Modèles de conversation locaux
Génération
Images et vidéo
Images · vidéo · synthèse vocale
Docs
Compréhension de la mise en page
Structure de page · compréhension élément par élément
Remplaçable
Sans enfermement
Changement par catégorie dans les réglages
Inscription à l'aperçu développeur bientôt disponible
L'inscription est en préparation et sera annoncée ici dès son ouverture.