Prompt

Il componente <Prompt> trasforma un insieme riutilizzabile di istruzioni in una scheda che i lettori possono copiare o aprire in uno strumento AI supportato. Le azioni di copia e apertura usano esattamente il contenuto scritto e visibile all'utente tra i tag.

Utilizzo di base

Ogni Prompt include un'azione Copia, quindi la versione più semplice non richiede prop:

Spiega come funziona la rotazione delle chiavi API per uno sviluppatore che usa per la prima volta la nostra API REST.

<Prompt>

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

</Prompt>

Titolo e descrizione

Usa title per identificare l'attività. La prop description, compatibile con Mintlify, sostituisce l'anteprima visibile con un riepilogo più breve, mentre il contenuto scritto e visibile all'utente tra i tag rimane il prompt completo usato dalle azioni Copia e di apertura.

Scrivi una nota di rilascio per il nuovo endpoint di rotazione delle chiavi API.

- Rivolgiti agli sviluppatori backend.
- Inizia dal vantaggio per l'utente.
- Includi un esempio di richiesta.

<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'azione "copy" esplicita è accettata per compatibilità, ma Copia è sempre presente e non deve mai essere elencata.

Azioni di apertura

Aggiungi claude, cursor, chatgpt, perplexity o gemini per consentire ai lettori di aprire il prompt in questi strumenti, ciascuno con la propria icona. La prima azione di apertura valida viene visualizzata accanto a Copia; le azioni aggiuntive appaiono nel menu Altro.

Confronta i flussi di autenticazione tramite token di sessione e chiave API in questo repository. Elenca i compromessi in termini di sicurezza e indica quale flusso dovrebbe usare ciascun tipo di 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>

Azioni URL personalizzate

Le azioni personalizzate richiedono un label, un url HTTPS o HTTP e un'icona facoltativa. Inserisci {prompt} in un segmento del percorso, in un valore di query o in un frammento per controllare la destinazione del prompt codificato nell'URL. Se ometti il segnaposto, Jamdesk aggiunge un parametro di query prompt.

Confronta questo piano di migrazione con il contratto API pubblico attuale. Identifica le modifiche incompatibili, i passaggi di rollback mancanti e i test necessari prima del rilascio.

<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>

Gli URL delle azioni personalizzate devono usare URL http: o https: privi di credenziali. Jamdesk rifiuta altri schemi, segnaposto nelle origini o nelle chiavi di query e URL finali delle azioni più lunghi di 8.000 caratteri. Copia rimane disponibile quando un'azione di apertura viene rifiutata.

Icona personalizzata

Imposta icon su un nome Font Awesome, un URL o percorso di immagine oppure un SVG inline. Usa iconType per selezionare lo stile di un nome Font Awesome senza prefisso.

Delimita un tutorial pratico che accompagni un nuovo utente dall'installazione a una richiesta API riuscita in meno di dieci minuti.

<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>

Consulta Icone per i nomi e gli stili disponibili.

Visualizzazioni compatte

L'anteprima mostra fino a tre righe e scorre quando il prompt è più lungo; il controllo Espandi apre il prompt completo. Imposta singleLine per troncare invece l'anteprima a una sola riga. In entrambi i casi, il prompt completo e visibile all'utente viene comunque copiato o inviato da un'azione di apertura.

Riepiloga l'API pubblica in cinque punti:

- Autenticazione e durata dei token.
- Convenzioni per la paginazione.
- Limiti di frequenza e indicazioni sui nuovi tentativi.
- Formato degli errori e codici comuni.
- Criteri di versioning e deprecazione.

Usa hidePrompt con un titolo quando la sola etichetta fornisce ai lettori un contesto sufficiente:

Crea una checklist di migrazione per il passaggio da API v1 a v2. Includi prerequisiti, modifiche al codice, passaggi di convalida, criteri di rollback e approvazione del responsabile.

<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 nasconde l'anteprima solo quando è presente title. Senza un titolo, Jamdesk mantiene visibile il prompt per garantire che la scheda rimanga comprensibile.

Prop

Prossimi passi