GetWiki Query Wiki - Tablestore: Central de Documentação do Alibaba Cloud

Pré-requisitos

Uma AgentStorage instance foi criada e está no estado normal, e você obteve o endpoint e o nome da instância.
Uma API key foi criada.
As operações do Wiki utilizam o Agent Scope completo de três segmentos (appId/tenantId/agentId). Cada segmento não pode estar vazio, não pode ser *, deve ter no máximo 128 bytes de comprimento e não pode conter /. Não inclua o runId.
A compilação é um processo assíncrono. Consulte o status da compilação usando o campo latestBuild.status retornado por esta operação e monitore periodicamente até que o status se torne ready ou a compilação falhe.

Parâmetros da requisição

Campo	Tipo	Obrigatório	Descrição
`memoryStoreName`	string	Sim	O nome do repositório de memória.
`scope`	object	Sim	O Agent Scope completo de três segmentos.
`scope.appId`	string	Sim	O identificador do aplicativo.
`scope.tenantId`	string	Sim	O identificador do tenant ou usuário.
`scope.agentId`	string	Sim	O identificador do Agent.

Nenhum dos campos do Scope pode estar vazio ou usar *. Cada segmento pode ter no máximo 128 bytes de comprimento e não pode conter /. Não inclua o runId.

Exemplo de requisição

Ao se autenticar com uma chave de API, passe o nome da instância e a chave de API nos cabeçalhos de requisição x-ots-instancename e 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"
  }
}'

Resposta

Campo	Descrição
`name`	O nome do Wiki. O valor padrão é `Wiki`.
`summary`	O resumo do Wiki. Este parâmetro é omitido quando não está defina.
`status`	O status do Wiki: `draft` ou `ready`.
`pageCount`	O número de páginas atualmente publicadas.
`hasPendingChanges`	Indica se o source possui alterações que ainda não foram compiladas e publicadas.
`latestBuild`	A compilação mais recente. Este parâmetro é omitido quando nenhuma compilação foi iniciada.
`createdAt`, `updatedAt`	A hora em que o Wiki foi criado e a hora da última atualização.

O latestBuild contém os seguintes campos.

Campo	Descrição
`status`	O status da compilação.
`step`	A etapa atual de processamento. Este parâmetro é omitido quando nenhum valor está disponível.
`progress`	O progresso atual. Este parâmetro é omitido quando nenhum valor está disponível.
`changes.added`, `modified`, `deleted`	O número de alterações no source em relação à última versão publicada.
`changes.affectedPages`	O número de páginas afetadas pelas alterações no source.
`pageCount`, `totalBytes`	O número de páginas geradas pela compilação e o número total de bytes dos dados da página.
`quality`	As métricas de qualidade da compilação. Este parâmetro é retornado após a conclusão da verificação de qualidade. O `quality` contém `sourceCoverage`, `groundedPageRate`, `brokenLinkCount`, `orphanPageCount`, `uncitedPageCount` e `duplicateTitleCount`.
`errorMessage`	O motivo da falha na compilação. Este parâmetro é omitido quando não há erros.
`createdAt`, `updatedAt`, `finishedAt`	As informações de tempo da compilação.

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