Jamdesk Documentation logo

Prompt

Use Prompt para apresentar instruções reutilizáveis de IA com cópia, ações de abertura integradas, destinos personalizados, ícones e opções de exibição compactas.

O componente <Prompt> transforma um conjunto reutilizável de instruções em um cartão que o leitor pode copiar ou abrir em uma ferramenta de IA compatível. As ações de copiar e de abrir usam exatamente o conteúdo autoral visível ao usuário, entre as tags.

Uso básico

Todo Prompt tem uma ação de Copiar. A versão mais simples não precisa de props:

Explique como funciona a rotação de chaves de API para um desenvolvedor que está usando nossa API REST pela primeira vez.

Prompt

Explique como funciona a rotação de chaves de API para um desenvolvedor que está usando nossa API REST pela primeira vez.
<Prompt>

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

</Prompt>

Título e descrição

Use title para identificar a tarefa. A prop description, compatível com o Mintlify, substitui a prévia visível por um resumo mais curto. As ações de copiar e de abrir continuam usando o conteúdo completo visível entre as tags.

Redigir uma nota de versão

Escreva uma nota de versão concisa para um público de desenvolvedores.

Redigir uma nota de versão

Escreva uma nota de versão para o novo endpoint de rotação de chaves de API.

- Dirija-se a desenvolvedores de backend.
- Comece pelo benefício para o usuário.
- Inclua um exemplo de requisição.
<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>

A ação de copiar está sempre presente. Uma ação "copy" explícita é aceita por compatibilidade, mas nunca é necessária.

O Prompt copia exatamente o conteúdo autoral visível ao usuário. Em um prompt que contém Visibility, o Jamdesk remove do texto copiado as tags de invólucro exclusivas para humanos e mantém o seu conteúdo. Subárvores exclusivas para agentes são excluídas. O Jamdesk também exclui Visibility com uma prop for com valor de expressão, ou com um público ocultado por um atributo spread posterior, porque esse público não pode ser determinado estaticamente. Visibility sem prop for, com for abreviado ou com um público literal inválido continua visível. Um Prompt oculto dentro de um Visibility exclusivo para agentes, ou ofuscado por expressão/spread, não tem fonte copiável.

Ações de abertura

Adicione claude, cursor, chatgpt, perplexity ou gemini para permitir que o leitor abra o prompt nessas ferramentas. Cada ação exibe o ícone da marca. A primeira ação de abertura válida aparece ao lado de Copiar. As demais aparecem no menu Mais.

Comparar fluxos de autenticação

Compare os fluxos de autenticação por token de sessão e por chave de API neste repositório. Liste seus trade-offs de segurança e recomende qual fluxo cada tipo de cliente deve usar.

Comparar fluxos de autenticação

Compare os fluxos de autenticação por token de sessão e por chave de API neste repositório. Liste seus trade-offs de segurança e recomende qual fluxo cada tipo de cliente deve usar.
<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>

Clicar em uma ação de abertura envia o prompt copiável completo ao terceiro selecionado. Não inclua segredos, dados pessoais ou conteúdo proprietário, a menos que pretenda compartilhá-los sob a política de privacidade desse provedor. Copiar não abre nenhum serviço de terceiros.

Ações com URL personalizada

Ações personalizadas recebem um label, uma url HTTPS ou HTTP e um ícone opcional. Coloque {prompt} em um segmento de caminho, em um valor de query ou em um fragmento para controlar onde o prompt codificado para URL será inserido. Se você omitir o marcador, o Jamdesk adiciona um parâmetro de query prompt.

Pesquisar esta migração

Compare este plano de migração com o contrato público atual da API. Identifique mudanças incompatíveis, etapas de rollback ausentes e os testes necessários antes da publicação.

Pesquisar esta migração

Compare este plano de migração com o contrato público atual da API. Identifique mudanças incompatíveis, etapas de rollback ausentes e os testes necessários antes da publicação.
<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>

As URLs de ações personalizadas devem ser http: ou https: sem credenciais. O Jamdesk rejeita outros esquemas, marcadores em origens ou chaves de query, e URLs finais de ação com mais de 8.000 caracteres. A ação de copiar continua disponível quando uma ação de abertura é rejeitada.

Ícone personalizado

Defina icon como um nome do Font Awesome, um URL ou caminho de imagem, ou SVG inline. Use iconType para escolher o estilo de um nome do Font Awesome sem prefixo.

Planejar um tutorial

Esboce um tutorial prático que leve um novo usuário da instalação até uma requisição bem-sucedida à API em menos de dez minutos.

Planejar um tutorial

Esboce um tutorial prático que leve um novo usuário da instalação até uma requisição bem-sucedida à API em menos de dez minutos.
<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>

Veja Ícones para os nomes e estilos disponíveis.

Exibições compactas

A prévia mostra até três linhas e rola para prompts mais longos. O controle Expandir abre o prompt completo. Defina singleLine para limitar a prévia a uma linha. As ações de copiar e de abrir continuam usando o prompt completo visível ao usuário.

Resumir a API

Resuma a API pública em cinco tópicos: - Autenticação e tempo de vida dos tokens. - Convenções de paginação. - Limites de taxa e orientações de nova tentativa. - Formato de erro e códigos comuns. - Política de versionamento e descontinuação.

Resumir a API

Resuma a API pública em cinco tópicos:

- Autenticação e tempo de vida dos tokens.
- Convenções de paginação.
- Limites de taxa e orientações de nova tentativa.
- Formato de erro e códigos comuns.
- Política de versionamento e descontinuação.

Use hidePrompt com um título quando o rótulo sozinho já oferecer contexto suficiente ao leitor:

Gerar uma lista de verificação de migração

Gerar uma lista de verificação de migração

Crie uma lista de verificação para migrar da API v1 para a v2. Inclua pré-requisitos, mudanças de código, etapas de validação, critérios de rollback e aprovação do responsável.
<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 oculta a prévia somente quando title está definido. Sem título, o prompt permanece visível.

Propriedades

ReactNode

O conteúdo do prompt entre as tags de abertura e fechamento. O Jamdesk preserva o Markdown autoral exato, visível ao usuário, para as ações de copiar e de abrir. Ele também renderiza esse conteúdo como prévia, a menos que description substitua a prévia ou hidePrompt a oculte. A filtragem de Visibility segue as regras acima.

string

Rótulo exibido no cabeçalho do cartão. Nenhum título é mostrado por padrão.

string

Prévia compacta com Markdown inline, aceita por compatibilidade com o Mintlify. Altera apenas a prévia visível. As ações de copiar e de abrir continuam usando o conteúdo visível ao usuário entre as tags.

string | ReactElementdefault: sparkles

Ícone do cabeçalho. Aceita um nome do Font Awesome, um URL ou caminho de imagem, ou um elemento SVG inline.

regular | solid | light | thin | sharp-solid | duotone | brands

Estilo do Font Awesome aplicado a um ícone em string sem prefixo. Não altera URLs ou caminhos de imagem, nomes já prefixados nem elementos SVG inline.

('copy' | 'cursor' | 'claude' | 'chatgpt' | 'perplexity' | 'gemini' | CustomAction)[]default: []

Ações de abertura na ordem de exibição. CustomAction é { label: string; url: string; icon?: string }. Copiar é sempre exibido. Uma entrada copy explícita é aceita e removida das duplicatas. Ações de abertura inválidas, duplicadas ou muito longas são omitidas.

boolean | stringdefault: false

Limita a prévia visível a uma linha quando definido como booleano true ou como a string "true". A string "false" mantém o comportamento padrão. Todas as ações continuam usando o prompt completo.

boolean | stringdefault: false

Oculta a prévia visível quando há um título e o valor é booleano true ou a string "true". Sem título, a prévia permanece visível. A string "false" mantém o comportamento padrão.

string

Classes CSS adicionais aplicadas ao elemento raiz do cartão Prompt.

O que vem a seguir?

Escrever com IA

Transforme os requisitos de uma página em prompts objetivos

Visão geral dos componentes

Explore o restante da biblioteca de componentes MDX