Recherche d'artefacts

Modifier en ligne

L'outil Artifacts Searcher permet de rechercher et d'extraire des informations détaillées sur l'API, les objets source de l'application et les artefacts de la table en fonction des requêtes de l'utilisateur.

L'outil Artifacts Searcher prend en charge le filtrage par type de source et fournit des résultats structurés au format markdown avec les colonnes suivantes :

  • Nom
  • Type
  • Emplacement
  • ID source
Cet outil permet de localiser et d'extraire rapidement des détails techniques pertinents dans divers domaines, notamment :
API
Trouver la documentation de l'API et les directives d'utilisation stockées dans les tables de la base de données. Cela aide les développeurs à comprendre comment intégrer et utiliser efficacement les API.
Objets d'application
Les objets d'application désignent les entités et les composants des plates-formes logicielles. Les exemples incluent Salesforce et ServiceNow. L'outil permet d'obtenir des métadonnées sur ces objets, telles que leurs propriétés et leurs méthodes.
Tables de base de données
Les tables de base de données sont des unités de stockage structurées qui organisent et récupèrent les données de manière efficace. Vous pouvez utiliser cet outil pour :
  • Accéder à la documentation de l'API stockée dans des tableaux pour une référence rapide.
  • Récupérer les détails de l'objet de l'application, y compris les attributs et les comportements.
  • Explorer les structures des tableaux, telles que les noms des colonnes et les types de données, pour comprendre l'organisation des données.
Faits marquants
  • Recherche dans les points d'extrémité de l'API, les objets source de l'application et les tables de la base de données.
  • Affiche des métadonnées détaillées, y compris l'emplacement et les spécifications de la source.
  • Prise en charge du filtrage par OpenAPI versions et types d'API.
  • Fournit des tableaux markdown formatés pour faciliter la lecture.
Les opérations suivantes sont prises en charge par l'outil Artifacts Searcher :
Remarque : lorsque vous saisissez une invite pour rechercher une API ou une table de base de données et que les résultats de la recherche ne sont pas appropriés. Effectuez une actualisation manuelle pour résoudre ce problème.

Recherche d'artefacts de l'API

Lorsque vous entrez une invite pour rechercher des artefacts de source d'application, l'outil recherche les API correspondant aux critères spécifiés et affiche des informations détaillées sur leurs spécifications et leurs emplacements.

Cette opération permet d'afficher un tableau au format markdown contenant les métadonnées de l'API.
Tableau 1. Paramètres
Paramètre Obligatoire Descriptif
text Oui Recherche de noms ou de descriptions d'API.
source_type Oui Régler sur "API" pour cette opération.
Exemples d'invites
  • List all APIs that support the OpenAPI 3 specification
  • Show me all APIs that have paths containing the word 'order'
  • What are all the APIs supporting user authentication operations?

Recherche d'artefacts de table

Lorsque vous entrez une invite pour rechercher des artefacts de table, l'outil recherche les tables de base de données correspondant aux critères spécifiés et affiche leur schéma et leurs informations de métadonnées.
Remarque : Lorsque vous recherchez un artefact, l'outil n'affiche par défaut que les cinq premiers résultats, même s'il existe d'autres entrées dans la base de données pour votre requête.
Cette opération permet d'afficher un tableau au format markdown contenant les métadonnées du tableau.
Tableau 2. Paramètres
Paramètre Obligatoire Descriptif
text Oui Requête de recherche de noms ou de descriptions de tables.
source_type Oui Régler sur "endpoint_schema" pour cette opération.
Exemples d'invites
  • search for available tables with name procurement_order
  • What are all the tables supporting order-related operations?
  • List all tables in the sales schema