Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

Use this file to discover all available pages before exploring further.

Use Arquivos para enviar documentos uma única vez. Use Lojas Vetoriais para indexar esses arquivos para busca semântica e recuperação. Esse é o padrão recomendado para assistentes baseados em documentos, fluxos de trabalho de recuperação e respostas fundamentadas.

​
Enviar um arquivo

Envie o arquivo usando multipart/form-data. A especificação OpenAPI exige file e purpose. 
mka1 llm files upload \
  --file ./support-manual.pdf \
  --purpose assistants \
  -H 'X-On-Behalf-Of: <end-user-id>'
A resposta retorna um objeto file com um ID como file-abc123.

​
Criar uma loja vetorial

Crie uma loja vetorial e anexe um ou mais IDs de arquivos enviados. 
mka1 llm vector-stores create --body '{
  "name": "Base de conhecimento de suporte",
  "description": "Manuais de suporte e documentos da central de ajuda indexados",
  "file_ids": ["file-abc123"],
  "expires_after": { "anchor": "last_active_at", "days": 30 }
}'
Esta resposta retorna um ID de loja vetorial como vs_abc123.

​
Adicionar mais arquivos depois

Você pode adicionar mais arquivos a uma loja vetorial existente sem precisar recriá-la. 
mka1 llm vector-stores create-file \
  --vector-store-id vs_abc123 \
  --file-id file-def456 \
  --attributes '{"category":"manual","version":"2.0"}'
O arquivo da loja vetorial pode retornar status: "in_progress" enquanto a indexação está em andamento. Consulte os endpoints de Arquivos e Lojas Vetoriais na Referência da API caso precise consultar o status.

​
Buscar na loja vetorial

Use busca semântica para recuperar os fragmentos mais relevantes para uma pergunta do usuário. 
mka1 llm vector-stores search \
  --vector-store-id vs_abc123 \
  --body '{
    "query": "Como faço para redefinir minha senha?",
    "max_num_results": 5
  }'
A resposta retorna correspondências ranqueadas com file_id, filename, dados de pontuação e conteúdo do fragmento.

​
Fluxo de trabalho típico

Use esta sequência para a maioria das configurações de recuperação:
  1. Envie o arquivo fonte.
  2. Crie uma loja vetorial com file_ids ou anexe o arquivo depois.
  3. Aguarde o processamento do arquivo ser concluído.
  4. Busque na loja vetorial quando precisar de contexto relevante.
Você pode então alimentar o texto retornado na lógica da sua aplicação ou em uma requisição de Respostas.