SearchWikiPages Search Wiki pages - Tablestore - Centre de documentation Alibaba Cloud

Utilisez l'interface SearchWikiPages pour rechercher les pages Wiki publiées à partir d'un texte de requête. Cette interface sert à découvrir des pages ; pour récupérer le contenu complet, appelez GetWikiPage.

Prérequis

Vous avez créé une instance AgentStorage dont le statut est normal, et vous avez obtenu son adresse d'accès (endpoint) ainsi que son nom.
Vous avez créé une clé API.
Les opérations Wiki utilisent le scope Agent complet en trois segments (appId/tenantId/agentId). Chaque segment doit être non vide, ne pas contenir * ni /, et sa taille ne doit pas dépasser 128 octets. Ne transmettez pas le paramètre runId.

Paramètres de la requête

Champ

Type

Obligatoire

Description

memoryStoreName

string

Oui

Nom du magasin de mémoire.

scope

object

Oui

Scope Agent complet en trois segments. Les règles sont identiques à celles de GetWiki.

query

string

Oui

Texte de requête non vide.

limit

int

Non

Nombre de résultats à renvoyer. Valeur par défaut : 10. Maximum : 100.

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>/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
}'

Réponse

Champ

Description

pages

Liste de pages triées par pertinence. Pour plus de détails sur les champs, consultez l'objet page Wiki.

pages[].score

Score de pertinence entre la page et la requête.

Les résultats de recherche ne renvoient pas le champ content. Sélectionnez un petit nombre de pages correspondantes dans votre application, puis appelez GetWikiPage avec le paramètre path pour récupérer le contenu complet.

{
  "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
    }
  ]
}