A documentação da API e a IA: o ficheiro llms.txt e dar a documentação inteira a um assistente

IA e Agentes·· 31 visualizações· 3 min de leitura

A resposta curta: na raiz da documentação há um ficheiro llms.txt: um índice em texto simples de todas as páginas, nas duas línguas, cada uma com a ligação para a sua versão em Markdown e uma frase sobre o que tem. No fim, a ligação para a especificação OpenAPI. É a forma mais rápida de pôr um assistente de IA a trabalhar com a nossa documentação, e não com o que ele julga saber.

O que tem o ficheiro

Parte O que diz
Cabeçalho O nome da MozOut, o endereço base da API e o aviso de que cada página tem versão Markdown.
Documentação em português Todas as páginas em português, com a ligação .md e a descrição.
Documentation in English O mesmo, em inglês.
Specification A ligação para a especificação OpenAPI.

Como o usar com um assistente

1 Assistente que abre ligações: dê-lhe a ligação do llms.txt e peça-lhe que leia só as páginas de que precisa, por exemplo Regras da API e SMS.
2 Assistente sem acesso à internet: abra a página que interessa, carregue em Copiar página e cole o texto na conversa.
3 Assistente de programação no editor: muitos aceitam ficheiros ou ligações como contexto. Junte as páginas Markdown que vai usar, ou a especificação OpenAPI.

Um pedido bem feito

Quanto mais preciso for o pedido, menos o assistente inventa. Um exemplo:

Lê o llms.txt desta documentação e as páginas Regras da API e SMS.
Escreve uma função em Python que envia um SMS pela API.
A chave vem da variável de ambiente RLX_API_KEY.
Envia sempre Idempotency-Key e espera o Retry-After depois de um 429.
Usa só operações que estejam na documentação.

Nunca cole a chave da API numa conversa com um assistente. Ele não precisa dela para escrever o código; a chave entra só no ambiente onde o programa corre. E confirme o resultado: se o assistente usar uma operação que não está na lista «O que a API já faz», essa operação não existe.
O que é o llms.txt em geral, e se vale a pena no seu próprio site, está em llms.txt: o que é.

Abra o índice e veja como está montado.

Abrir o llms.txt

VEJA TAMBÉM

A documentação da API em Markdown: Ver em Markdown, Copiar página e para que servem

Resumir com IA e Partilhar na documentação da API: o que fazem e quando confiar na resposta

A especificação OpenAPI da nossa API: o que é, onde a descarregar e o que contém

llms.txt: o que é e se faz alguma coisa pelo seu site

Exemplos de código na documentação da API: curl, PHP, Python e JavaScript, prontos a adaptar

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 396,00 MT/mês (plano de 3 anos, com cupão)

Ver planos
Esta resposta foi útil? A sua resposta ajuda-nos a melhorar este artigo.