Prompt

Le composant <Prompt> transforme un ensemble d'instructions réutilisable en une carte que les lecteurs peuvent copier ou ouvrir dans un outil d'IA pris en charge. Les actions Copy et d'ouverture utilisent exactement le contenu rédigé et visible par l'humain entre les balises.

Utilisation de base

Chaque Prompt inclut une action Copy, la version la plus simple ne nécessite donc aucune prop :

Expliquez comment fonctionne la rotation des clés API pour un développeur qui utilise notre API REST pour la première fois.

<Prompt>

Explain how API key rotation works for a developer using our REST API for the first time.

</Prompt>

Titre et description

Utilisez title pour nommer la tâche. La prop description, compatible avec Mintlify, remplace l'aperçu visible par un résumé plus court, tandis que le contenu rédigé et visible par l'humain entre les balises reste le prompt complet utilisé par les actions Copy et d'ouverture.

Rédigez une note de version pour le nouvel endpoint de rotation des clés API.

- Adressez-vous aux développeurs backend.
- Commencez par le bénéfice pour l'utilisateur.
- Incluez un exemple de requête.

<Prompt
  title="Draft a release note"
  description="Write a concise release note for a developer audience."
  actions={["copy", "claude"]}
>
Write a release note for the new API key rotation endpoint.

- Address backend developers.
- Lead with the user benefit.
- Include one request example.

</Prompt>

L'action "copy" explicite est acceptée pour des raisons de compatibilité, mais Copy est toujours présente et n'a jamais besoin d'être listée.

Actions d'ouverture

Ajoutez claude, cursor, chatgpt, perplexity ou gemini pour permettre aux lecteurs d'ouvrir le prompt dans ces outils, chacun avec son icône de marque. La première action d'ouverture valide apparaît à côté de Copy ; les actions supplémentaires apparaissent dans le menu More.

Comparez les flux d'authentification par jeton de session et par clé API dans ce dépôt. Listez leurs compromis de sécurité et recommandez le flux à utiliser pour chaque type de client.

<Prompt
  title="Compare authentication flows"
  actions={["claude", "cursor", "chatgpt", "perplexity", "gemini"]}
>
Compare the session-token and API-key authentication flows in this repository.
List their security tradeoffs and recommend which flow each client type should use.

</Prompt>

Actions d'URL personnalisées

Les actions personnalisées prennent un label, une url en HTTPS ou HTTP, et une icône optionnelle. Placez {prompt} dans un segment de chemin, une valeur de requête ou un fragment pour contrôler où va le prompt encodé en URL. Si vous omettez le placeholder, Jamdesk ajoute un paramètre de requête prompt.

Comparez ce plan de migration avec le contrat d'API publique actuel. Identifiez les changements cassants, les étapes de retour en arrière manquantes et les tests nécessaires avant la mise en production.

<Prompt
  title="Research this migration"
  actions={[
    {
      label: "Search the web",
      url: "https://www.google.com/search?q={prompt}",
      icon: "magnifying-glass",
    },
    "claude",
  ]}
>
Compare this migration plan with the current public API contract. Identify
breaking changes, missing rollback steps, and tests needed before release.

</Prompt>

Les URL d'actions personnalisées doivent être des URL http: ou https: sans identifiants. Jamdesk rejette les autres schémas, les placeholders dans les origines ou les clés de requête, ainsi que les URL d'action finales de plus de 8 000 caractères. Copy reste disponible lorsqu'une action d'ouverture est rejetée.

Icône personnalisée

Définissez icon avec un nom Font Awesome, une URL ou un chemin d'image, ou un SVG inline. Utilisez iconType pour sélectionner le style d'un nom Font Awesome non préfixé.

Esquissez un tutoriel pratique qui mène un nouvel utilisateur de l'installation à une requête API réussie en moins de dix minutes.

<Prompt title="Plan a tutorial" icon="pen-nib" iconType="duotone">

  Outline a hands-on tutorial that gets a new user from installation to a
  successful API request in under ten minutes.

</Prompt>

Consultez Icônes pour connaître les noms et styles disponibles.

Affichages compacts

L'aperçu affiche jusqu'à trois lignes et défile lorsque le prompt est plus long ; le contrôle Expand ouvre le prompt complet. Définissez singleLine pour limiter l'aperçu à une seule ligne à la place. Dans tous les cas, le prompt complet et visible par l'humain est toujours copié ou envoyé par une action d'ouverture.

Résumez l'API publique en cinq points :

- Authentification et durées de vie des tokens.
- Conventions de pagination.
- Limites de débit et conseils de nouvelle tentative.
- Format des erreurs et codes courants.
- Politique de versionnage et de dépréciation.

Utilisez hidePrompt avec un titre lorsque le libellé seul donne suffisamment de contexte aux lecteurs :

Créez une checklist de migration pour passer de l'API v1 à v2. Incluez les prérequis, les changements de code, les étapes de validation, les critères de retour en arrière et la validation finale du responsable.

<Prompt title="Summarize the API">

  Summarize the public API in five bullets:

  - Authentication and token lifetimes.
  - Pagination conventions.
  - Rate limits and retry guidance.
  - Error format and common codes.
  - Versioning and deprecation policy.

</Prompt>

<Prompt title="Generate a migration checklist" hidePrompt actions={["claude"]}>

  Create a migration checklist for moving from API v1 to v2. Include
  prerequisites, code changes, validation steps, and rollback criteria.

</Prompt>

hidePrompt ne masque l'aperçu que lorsque title est présent. Sans titre, Jamdesk garde le prompt visible afin que la carte reste compréhensible.

Props

Et ensuite ?