Utilisez l'interface IngestWiki pour figer les sources actuelles et générer de manière asynchrone un nouvel ensemble de pages Wiki. Les pages publiées restent accessibles jusqu'à la publication réussie de la nouvelle version.
Prérequis
Vous avez créé une instance AgentStorage dont l'état est
normal, et vous disposez du nom de l'instance ainsi que de son endpoint.Vous avez créé une clé API.
Les opérations Wiki utilisent le périmètre Agent Scope complet à trois segments (
appId/tenantId/agentId). Chaque segment doit être non vide, différent de*, ne pas contenir/et avoir une longueur maximale de 128 octets. Ne transmettez pasrunId.Les sources sont stockées dans le répertoire
/.wiki/raw/associé à unmemoryStoreNamespécifique et à un périmètre Agent Scope à trois segments. Les téléchargements et les générations utilisent les mêmes valeurs pourappId,tenantIdetagentId, et omettentrunId.
Les fichiers source du Wiki sont écrits dans le répertoire /.wiki/raw/ décrit ci-dessus via l'opération AddItem en utilisant le même périmètre Agent Scope à trois segments que pour la génération et en omettant runId. Il s'agit d'une exception à la règle de périmètre pour les opérations sur les fichiers ; les autres opérations sur les fichiers nécessitent le périmètre complet à quatre segments (incluant runId). Pour plus d'informations, consultez la section Créer un fichier. Exemple de téléchargement :
{
"type": "memoryfile",
"memoryStoreName": "agent_memory",
"scope": {
"appId": "app-001",
"tenantId": "user-001",
"agentId": "assistant"
},
"path": "/.wiki/raw/payment-spec.md",
"content": "# Payment rules\nA refund requires the order number.\n"
}
Paramètres de requête
|
Champ |
Type |
Obligatoire |
Description |
|
|
string |
Oui |
Nom du magasin de mémoire. |
|
|
object |
Oui |
Périmètre Agent Scope complet à trois segments. Les règles sont identiques à celles de |
|
|
string |
Non |
Jeton d'idempotence (jusqu'à 256 octets). L'utilisation de la même source et du même jeton permet des nouvelles tentatives sécurisées. |
|
|
array |
Non |
Références aux artefacts Dream à inclure dans cette génération (jusqu'à 100 entrées). |
|
|
string |
Oui |
ID du Dream terminé (jusqu'à 128 octets). |
|
|
string |
Oui |
ID de l'action d'artefact appliquée (jusqu'à 128 octets). |
Le paramètre dreamActionRefs prend effet uniquement pour cette génération. Les références doivent appartenir au même magasin de mémoire et au même Agent, et correspondre à des artefacts Skill ou Profile appliqués et toujours valides ; les références en double sont rejetées.
Exemple de requête
Lors de l'utilisation de l'authentification par clé API, transmettez le nom de l'instance et la clé API via les en-têtes de requête x-ots-instancename et x-ots-apikey.
curl -X POST https://<endpoint>/IngestWiki \
-H "x-ots-instancename: <instance-name>" \
-H "x-ots-apikey: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"memoryStoreName": "agent_memory",
"scope": {
"appId": "app-001",
"tenantId": "user-001",
"agentId": "assistant"
},
"clientToken": "payment-wiki-20260904"
}'
Réponse
|
Champ |
Description |
|
|
Statut initial de la nouvelle génération, généralement |
|
|
Indique si une génération existante a été réutilisée sur la base du même |
|
|
Indique si la génération a été ignorée car les sources n'avaient pas changé. |
{
"status": "pending",
"reused": false,
"skipped": false
}
La génération est un processus asynchrone. Une fois lancée, interrogez régulièrement le champ latestBuild.status renvoyé par GetWiki jusqu'à ce qu'il passe à ready ou échoue. Si aucune source n'est disponible, une erreur 400 VALIDATION_ERROR est renvoyée.