Skip to main content

Como armazenar prompts em repositórios do GitHub

Armazene prompts diretamente em seus repositórios do GitHub para aproveitar o resumo de texto automatizado e outras funcionalidades controladas por IA.

Os prompts podem ser armazenados como arquivos diretamente nos repositórios do GitHub. Isso possibilita exibir seus prompts em uma interface do usuário organizada, compartilhá-los com stakeholders não técnicos e executar iterações e comparações perfeitas em ajustes em modelos e prompts.

Benefícios

  • Fácil integração com o novo pacote de ferramentas de desenvolvimento de IA diretamente no GitHub.
  • Simples e escalonável de casos de uso simples a complexos.
  • Usa um formato amplamente compatível com ferramentas existentes.

Formato de arquivo com suporte

Armazene prompts em arquivos YAML.

O arquivo pode estar em qualquer lugar do repositório, mas deve ter a extensão .prompt.yml ou .prompt.yaml.

Exemplo:

YAML
name: Text Summarizer
description: Summarizes input text concisely
model: openai/gpt-4o-mini
modelParameters:
  temperature: 0.5
messages:
  - role: system
    content: You are a text summarizer. Your only job is to summarize text given to you.
  - role: user
    content: |
      Summarize the given text, beginning with "Summary -":
      <text>
      {{input}}
      </text>
testData:
  - input: |
      The quick brown fox jumped over the lazy dog.
      The dog was too tired to react.
    expected: Summary - A fox jumped over a lazy, unresponsive dog.
evaluators:
  - name: Output should start with 'Summary -'
    string:
      startsWith: 'Summary -'

Estrutura de prompt

Os prompts têm duas partes principais:

  • Informações de runtime (obrigatório)
    • Modelos de prompt (sistema, usuário etc.) usando espaços reservados {{variable}} simples
  • Informações de desenvolvimento (opcional)
    • Nome e descrição legíveis por humanos
    • Identificador e parâmetros de modelo
    • Dados de exemplo para testes e avaliações
    • Dados que descrevem os próprios avaliadores

Limitações

Você não pode armazenar prompts para:

  • Linguagens de modelagem complexas
  • Formatos de arquivo proprietários ou complexos (como .ghprompt, ou .prompty)