Use a operação IngestWiki para congelar as sources atuais e compilar assincronamente um novo conjunto de páginas da Wiki. As páginas já publicadas continuam disponíveis para leitura até a publicação da nova compilação.
Pré-requisitos
É necessário ter um AgentStorage instance criado e no estado
normal, além de possuir o endpoint e o nome da instância.É necessário ter um api key criado.
As operações da Wiki utilizam o Agent Scope completo de três segmentos (
appId/tenantId/agentId). Cada segmento deve ser não vazio, não pode ser*, pode ter até 128 bytes de tamanho e não pode conter o caractere/. Não inclua orunId.As sources ficam armazenadas no diretório
/.wiki/raw/, sob omemoryStoreNamee o Agent Scope de três segmentos especificados. Tanto os uploads quanto as compilações utilizam o mesmoappId,tenantIdeagentId, omitindo orunIdem ambos os casos.
A operação AddItem grava os arquivos source da Wiki no diretório /.wiki/raw/ descrito acima, utilizando o mesmo Agent Scope de três segmentos da compilação e omitindo o runId. Isso representa uma exceção à regra de Scope para operações de arquivo, pois as demais operações exigem o Scope completo de quatro segmentos, incluindo o runId. Para mais detalhes, consulte Crie um arquivo. Exemplo de upload:
{
"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"
}
Parâmetros da requisição
|
Campo |
Tipo |
Obrigatório |
Descrição |
|
|
string |
Sim |
O nome do repositório de memória. |
|
|
object |
Sim |
defina o Agent Scope completo de três segmentos, seguindo as mesmas regras do |
|
|
string |
Não |
O token de idempotência, com até 256 bytes de tamanho. Requisições com as mesmas sources e o mesmo token podem ser repetidas com segurança. |
|
|
array |
Não |
As referências aos artefatos do Dream a serem incluídos nesta compilação. Há suporte para no máximo 100 referências. |
|
|
string |
Sim |
O ID do Dream concluído, com até 128 bytes de tamanho. |
|
|
string |
Sim |
O ID da ação de artefato aplicada, com até 128 bytes de tamanho. |
O parâmetro dreamActionRefs surte efeito apenas na compilação atual. As referências precisam pertencer ao mesmo repositório de memória e ao mesmo Agente, correspondendo a artefatos de Skill ou Profile aplicados que ainda estejam válidos. O sistema rejeita referências duplicadas.
Exemplo de requisição
Ao utilizar a autenticação por chave de api, informe 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>/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"
}'
Resposta
|
Campo |
Descrição |
|
|
O status inicial da nova compilação, geralmente |
|
|
Indica se o sistema reutiliza uma compilação existente com base no mesmo |
|
|
Indica se a compilação foi ignorada por não haver alterações nas sources. |
{
"status": "pending",
"reused": false,
"skipped": false
}
A compilação ocorre de forma assíncrona. Após iniciar o processo, consulte periodicamente o GetWiki e verifique o valor retornado em latestBuild.status até que ele mude para ready ou até que a compilação falhe. Caso não haja nenhuma source disponível, o sistema retorna o erro 400 VALIDATION_ERROR.