Documentation

API Platform livre la documentation Scrydon dans son image : ces mêmes pages, en anglais et en français, en texte brut. Deux opérations la recherchent et la lisent là où votre installation s’exécute. Une installation isolée d’Internet peut ainsi répondre aux questions sur Scrydon à partir des pages de la version qu’elle exécute, sans joindre ce site.

import { createHttpPlatformTransport, createScrydonSDK } from '@scrydon/sdk/platform'

const platform = createScrydonSDK(
  createHttpPlatformTransport({
    baseUrl: 'https://scrydon.com',
    headers: () => ({ authorization: `Bearer ${accessToken}` }),
  })
)

const { available, hits } = await platform.data.docs.search({ query: 'create an automation' })
if (available && hits[0]) {
  const { found, page } = await platform.data.docs.read({ path: hits[0].path })
  if (found && page) console.log(page.title, page.truncated ? '(cut)' : '', page.text)
}

Les deux exigent tools:read. Elles sont en lecture seule et peuvent être relancées sans risque. La documentation est la même pour toutes les organisations et ne contient aucune donnée d’organisation. Rien n’est envoyé hors de la plateforme.

Dans un workflow, sélectionnez les outils Scrydon Search Scrydon docs et Read Scrydon docs page parmi les outils d’un bloc Agent. Dans un outil Scrydon, les mêmes opérations sont ctx.data.docs.search et ctx.data.docs.read. Cortex utilise ces outils dans les salons d’espace de travail pour expliquer le fonctionnement de Scrydon.

Recherche

Le résultat est { available, hits }. Chaque résultat contient :

Les titres et les intertitres pèsent plus que les mots du corps du texte. Une recherche en français qui ne trouve rien cherche en anglais à la place ; ses résultats portent alors locale: 'en'. Une requête qui ne trouve rien renvoie available: true sans résultat.

Lecture

Le résultat est { available, found, page }. Quand found vaut true, page contient path, title, description (si la page en a une), locale, text et truncated.

• Le français se replie sur l’anglais. Demander en français une page qui n’a pas de version française renvoie la page anglaise, avec locale: 'en'.
• Le texte est limité à 24 000 octets (UTF-8). Une page plus longue est coupée à la limite d’un caractère et truncated vaut true. La coupe ne tombe jamais au milieu d’un caractère.
• Le texte est brut. Les intertitres, la prose, les cellules de tableau et les blocs de code sont conservés. Le balisage, les composants et les images sont supprimés, et un lien ne garde que son texte.

Un chemin qui ne désigne aucune page renvoie available: true, found: false, sans page.

@scrydon/sdk/platform exporte les limites (DOCS_SEARCH_QUERY_MAX_CHARS, DOCS_SEARCH_LIMIT_MAX, DOCS_SEARCH_LIMIT_DEFAULT, DOCS_PAGE_PATH_MAX_CHARS, DOCS_READ_TEXT_MAX_BYTES) et les langues (DOCS_LOCALES, DOCS_DEFAULT_LOCALE). Les champs inconnus, y compris un champ d’organisation ou d’espace de travail, sont refusés.

Quand la documentation n’est pas installée

Une image construite sans la documentation répond available: false au lieu d’une erreur : une recherche ne renvoie aucun résultat, et une lecture renvoie found: false. Indiquez que la documentation n’est pas installée au lieu d’échouer.

Erreurs

INVALID_REQUEST signifie que l’entrée n’a pas passé la validation, par exemple une requête vide, un limit de 11 ou une locale inconnue. Quand un outil Scrydon appelle data.docs.search, la politique de prévention des pertes de données de votre organisation s’applique à la requête.