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 visibile all'utente, scritto tra i tag.

Utilizzo di base

Ogni Prompt ha un'azione Copia. La versione più semplice non richiede props:

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

<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 dare un'etichetta all'attività. La prop description, compatibile con Mintlify, sostituisce l'anteprima visibile con un riepilogo più breve. Le azioni di copia e apertura usano comunque il contenuto completo visibile tra i tag.

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

- Rivolgiti agli sviluppatori backend.
- Parti dal beneficio 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>

Copia è sempre presente. Un'azione "copy" esplicita è accettata per compatibilità ma non è mai necessaria.

Azioni di apertura

Aggiungi claude, cursor, chatgpt, perplexity o gemini per permettere ai lettori di aprire il prompt in questi strumenti. Ogni azione mostra la relativa icona del marchio. La prima azione di apertura valida compare accanto a Copia. Le altre compaiono nel menu Altro.

Confronta i flussi di autenticazione con token di sessione e con chiave API in questo repository. Elenca i loro compromessi di sicurezza e consiglia quale flusso usare per 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 accettano un label, un url HTTPS o HTTP e un'icona opzionale. Inserisci {prompt} in un segmento di percorso, in un valore di query o in un frammento per controllare dove va il prompt codificato in URL. Se ometti il segnaposto, Jamdesk aggiunge un parametro di query prompt.

Confronta questo piano di migrazione con l'attuale contratto pubblico dell'API. Individua le modifiche che rompono la compatibilità, 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 essere URL http: o https: senza credenziali. Jamdesk rifiuta altri schemi, segnaposto nell'origine o nelle chiavi di query, e URL finali di azione più lunghi di 8.000 caratteri. Copia resta disponibile anche 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 scegliere lo stile di un nome Font Awesome senza prefisso.

Delinea un tutorial pratico che porti 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>

Vedi Icone per i nomi e gli stili disponibili.

Visualizzazioni compatte

L'anteprima mostra fino a tre righe e scorre per un prompt più lungo. Il controllo Espandi apre il prompt completo. Imposta singleLine per ridurre l'anteprima a una sola riga. Le azioni di copia e apertura usano comunque il prompt completo visibile all'utente.

Riassumi l'API pubblica in cinque punti:

- Autenticazione e durata dei token.
- Convenzioni di paginazione.
- Limiti di frequenza e indicazioni per i nuovi tentativi.
- Formato degli errori e codici comuni.
- Politica di versionamento e deprecazione.

Usa hidePrompt insieme a un titolo quando l'etichetta da sola basta a dare contesto ai lettori:

Crea una checklist di migrazione per passare dall'API v1 alla v2. Includi prerequisiti, modifiche al codice, passaggi di validazione, 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 è impostato title. Senza titolo, il prompt resta visibile.

Prop

Prossimi passi