GetWiki Query Wiki - Tablestore - Centre de documentation Alibaba Cloud

Prérequis

Vous avez créé une instance AgentStorage dont l'état est normal, et vous disposez du endpoint et du nom de l'instance.
Vous avez créé une clé API.
Les opérations sur le Wiki utilisent l'Agent Scope complet à trois segments (appId/tenantId/agentId). Chaque segment doit être non vide, différent de *, ne pas dépasser 128 octets et ne pas contenir /. Ne transmettez pas runId.
La construction est un processus asynchrone. Vérifiez l'état de la construction via le champ latestBuild.status renvoyé par cette interface, et effectuez un sondage jusqu'à ce que l'état passe à ready ou que la construction échoue.

Paramètres de requête

Champ

Type

Obligatoire

Description

memoryStoreName

string

Oui

Nom du magasin de mémoire.

scope

object

Oui

Agent Scope complet à trois segments.

scope.appId

string

Oui

Identifiant de l'application.

scope.tenantId

string

Oui

Identifiant du locataire ou de l'utilisateur.

scope.agentId

string

Oui

Identifiant de l'Agent.

Les champs du scope ne doivent pas être vides ni utiliser *. Chaque segment ne doit pas dépasser 128 octets et ne doit pas contenir /. Ne transmettez pas runId.

Exemple de requête

Pour 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>/GetWiki \
  -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"
  }
}'

Réponse

Champ

Description

name

Nom du Wiki. La valeur par défaut est Wiki.

summary

Résumé du Wiki. Absent si non défini.

status

État du Wiki : draft ou ready.

pageCount

Nombre de pages actuellement publiées.

hasPendingChanges

Indique si la source contient des modifications non encore construites et publiées.

latestBuild

Dernière construction. Absente si aucune construction n'a été lancée.

createdAt, updatedAt

Dates de création et de mise à jour.

latestBuild contient les champs suivants.

Champ

Description

status

État de la construction.

step

Étape de traitement actuelle. Absente si aucune valeur n'est disponible.

progress

Progression actuelle. Absente si aucune valeur n'est disponible.

changes.added, modified, deleted

Nombre de modifications de la source par rapport à la dernière version publiée.

changes.affectedPages

Nombre de pages affectées par les modifications de la source.

pageCount, totalBytes

Nombre de pages générées par la construction et taille totale des données de page en octets.

quality

Métriques de qualité de la construction. Renvoyées une fois le contrôle de qualité terminé. quality contient sourceCoverage, groundedPageRate, brokenLinkCount, orphanPageCount, uncitedPageCount et duplicateTitleCount.

errorMessage

Raison de l'échec de la construction. Absente en l'absence d'erreur.

createdAt, updatedAt, finishedAt

Informations temporelles relatives à la construction.

{
    "name": "Wiki",
    "status": "draft",
    "pageCount": 0,
    "hasPendingChanges": false,
    "createdAt": "2026-09-16T12:21:46.826185003Z",
    "updatedAt": "2026-09-16T12:21:46.826185003Z"
}