Passages et formats de contenu

Recherche web et Recherche d’actualités renvoient du contenu web récupéré dans le champ content de chaque résultat. Browse renvoie le contenu pour une URL que vous spécifiez.

Utilisez contentFormat pour sélectionner des passages ou un format de document complet, et maxLength pour limiter le nombre de caractères retournés. Définissez explicitement les deux paramètres pour éviter de compter sur les valeurs par défaut. Pour la mise à la terre, utilisez contentFormat: "passage".

Passages

Définissez contentFormat sur passage pour obtenir, pour chaque résultat, les parties du document les plus pertinentes pour votre requête, jusqu’à maxLength caractères. Web IQ traite l’ensemble du document de son côté et retourne un extrait ciblé par la requête, de sorte que votre modèle n’a pas besoin de lire des paragraphes sans rapport pour trouver la phrase appropriée.

  • Économies de jetons : votre modèle reçoit une fraction du document au lieu de l’intégralité du document.
  • Meilleure exactitude factuelle : avec moins de contenu hors sujet dans le contexte, le modèle est moins susceptible de s’ancrer sur un paragraphe tangentiel.

Les Passages fonctionnent pour chaque application. Pour recherche web et recherche d’actualités, un bon point de départ est maxResults = 10,passagecontentFormat = et maxLength = 3000. Parcourir n’accepte maxResultspas ; il retourne le contenu d’une URL par requête. À partir de là, ajustez selon votre cas d’usage ; voir Comment dois-je régler maxResults et maxLength?

Document complet : text, html, markdown

Web IQ ne retourne pas la page web d’origine. Pendant l’indexation, il génère un document structuré à partir du contenu pertinent de chaque page, et les passages sont sélectionnés à partir de ce document. Les applications disposant d’un accès complet aux documents peuvent demander l’intégralité du document au lieu des passages :

contentFormat Returns
passage Les parties du document les plus pertinentes pour la requête, jusqu’à maxLength caractères.
text Document complet sous forme de texte brut, jusqu’à maxLength caractères.
html Document complet au format HTML, jusqu’à maxLength caractères.
markdown Document complet en tant que Markdown, jusqu’à maxLength caractères.

Les documents de plus de maxLength sont coupés. Pour obtenir un document complet, définissez maxLength suffisamment haut.

Si votre application n’a pas d’accès complet au document, une requête qui définit text, htmlou markdown retourne HTTP 403 avec le code AuthContentFormatForbiddend’erreur . Les passages restent le format recommandé pour l’ancrage.

Obtenir le document complet dans différents formats

Pour demander un accès complet au document, ouvrez une demande de support Web IQ. Applications qui utilisent html déjà ou text continuent de fonctionner comme aujourd’hui.

Valeurs par défaut et limites

Les formats disponibles et les valeurs par défaut varient selon que votre application dispose d’un accès complet aux documents. Définissez contentFormat et maxLength sur chaque requête pour contrôler explicitement le format de réponse et la longueur maximale.

Setting Sans accès complet aux documents Accès complet aux documents
Formats disponibles passage passage, text, html, markdown
contentFormat si vous l’omettez passage html (Recherche web), text (Recherche d’actualités)
maxLength si vous l’omettez 3000 10000
Longueur maximale du contenu retournée 3 000 caractères, même si vous définissez une limite plus élevée maxLength Jusqu’à 500 000 caractères, contrôlé par maxLength

Parcourir

Parcourir renvoie le contenu d’une URL que vous choisissez et prend en charge les mêmes formats. Définissez passage à contentFormat et envoyez un query pour obtenir les parties de la page les plus pertinentes pour cette requête, jusqu’à maxLength caractères. Une demande de passage nécessite un query.

Sans accès complet au document, passage est le format par défaut et le seul que vous pouvez demander, par conséquent, incluez query dans chaque requête Parcourir. Avec l’accès complet au document, vous pouvez également demander text, html ou markdown pour obtenir le document complet, jusqu’à maxLength caractères.

Si vous omettez contentFormat, Browse utilise par défaut passage sans accès complet au document ou html avec accès complet au document. Si vous omettez maxLength, la valeur par défaut est 3000 sans accès complet au document ou 10000 avec accès complet au document. Avec l’accès complet aux documents, vous pouvez définir maxLength jusqu’à 500 000 caractères ; sans cela, le contenu est limité à 3 000 caractères.