O SearchWikiPages pesquisa páginas da Wiki publicadas atualmente pelo texto da consulta. Use esta operação para descobrir páginas; para recuperar o conteúdo completo, chame GetWikiPage.
Pré-requisitos
Crie uma instância AgentStorage com o status
normale obtenha o endereço de acesso da instância (endpoint) e o nome da instância.Crie uma API Key.
Para operações da Wiki, use o Agent Scope completo de três segmentos (
appId/tenantId/agentId). Cada segmento não pode estar vazio, não pode ser*, não pode exceder 128 bytes e não pode conter/; não inclua orunId.
Parâmetros da requisição
|
Campo |
Tipo |
Obrigatório |
Descrição |
|
|
string |
Sim |
O nome do repositório de memória. |
|
|
object |
Sim |
O Agent Scope completo de três segmentos. As regras são as mesmas do |
|
|
string |
Sim |
O texto da consulta, que não pode estar vazio. |
|
|
int |
Não |
O número de resultados a serem retornados. Valor padrão: 10. Valor máximo: 100. |
Exemplo de requisição
Ao usar a autenticação por API Key, passe o nome da instância e a API Key nos cabeçalhos de requisição x-ots-instancename e x-ots-apikey.
curl -X POST https://<endpoint>/SearchWikiPages \
-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"
},
"query": "How does the payment callback ensure idempotency",
"limit": 5
}'
Resposta
|
Campo |
Descrição |
|
|
Uma lista de páginas ordenadas por relevância. Para descrições dos campos, consulte objeto de página da Wiki. |
|
|
A pontuação de relevância entre a página e a consulta. |
Os resultados da pesquisa não retornam content. Selecione um número pequeno de páginas correspondentes e, em seguida, use cada path para chamar GetWikiPage e recuperar o conteúdo.
{
"pages": [
{
"path": "/wiki/payment-callback.md",
"title": "Payment callback",
"type": "guide",
"description": "Idempotency and signature verification requirements for payment callbacks",
"sources": [
"raw/product/payment.md"
],
"score": 0.87
}
]
}