NeboAI
NeboAI
Começar

Referência do agent.json

O agent.json guarda tudo o que, num funcionário, não é texto: as capacidades de que precisa, as perguntas que faz ao proprietário, como a sua memória é mantida, que operações precisam sempre de aprovação e os fluxos de trabalho que executa. Todos os campos são opcionais.

Exemplo

{
  "requires": {
    "interfaces": ["ledger", "mail"],
    "plugins": [],
    "tools": []
  },
  "skills": ["@example/skills/receipt-capture"],
  "inputs": [
    {
      "key": "invoice_mailbox",
      "label": "Mailbox that receives vendor invoices",
      "type": "text",
      "id": "finance.ap.invoice_mailbox",
      "scope": "company",
      "required": true,
      "missing": "Ask the owner which mailbox to watch before processing invoices."
    }
  ],
  "memory": {
    "mode": "separate",
    "topics": [
      { "slug": "vendor", "description": "A supplier: terms, usual amounts, contacts, open disputes" }
    ]
  },
  "subscribes": ["finance.ap.*"],
  "ceiling": { "ledger.bill.create": "approval" },
  "workflows": {
    "invoice-intake": {
      "trigger": { "type": "watch", "plugin": "mail", "event": "email.new" },
      "activities": [
        { "id": "record", "intent": "If the message in _watch_payload is a vendor invoice, record it as a bill." }
      ]
    }
  }
}

Campos

CampoTipoSignificado
requires.interfaceslista de cadeiasCapacidades de que a função precisa, como mail ou ledger. Concedidas na contratação; cada operação sujeita a aprovação continua a ser um pedido de aprovação. Ver Capacidades e aprovações.
requires.pluginslista de cadeiasPlugins instalados com o funcionário. Use apenas quando a função depende mesmo de um plugin; prefira uma capacidade.
requires.toolslista de cadeiasFerramentas carregadas na sessão do funcionário desde a primeira interação. Isto nunca contorna a aprovação.
skillslista de cadeiasSkills da loja a instalar e usar: @org/skills/name, opcionalmente @version, ou um código SKIL-. As skills na própria pasta skills/ do pacote não precisam de entrada.
inputslistPerguntas a que o proprietário responde na contratação. Ver Entradas.
memoryobjectComo as conversas e a memória são mantidas. Ver Persona e memória.
subscribeslista de cadeiasÁreas de factos da empresa que o funcionário volta a ler quando mudam, como finance.ar.*.
ceilingmapOperação para "approval". Essa operação pede sempre autorização ao proprietário para este funcionário. Não é aceite nenhum outro valor.
workflowsmapNome do fluxo de trabalho para o fluxo de trabalho. Ver Fluxos de trabalho.
toolslistFerramentas HTTP servidas pelo sidecar de uma app. Ver Ferramentas de sidecar.
scopesmapGrupos com nome de tools, skills e plugins. Os plugins de um âmbito são descritos ao funcionário quando esse âmbito está ativo.

Entradas

Um input é uma pergunta a que o proprietário responde ao contratar. As respostas aparecem ao funcionário em "Configured Inputs" e preenchem os marcadores {{key}} nos acionadores de vigilância e de pasta.

{
  "key": "close_day",
  "label": "Business day to finish the close",
  "type": "select",
  "options": [
    { "value": "3", "label": "Third business day" },
    { "value": "5", "label": "Fifth business day" }
  ],
  "default": "5",
  "scope": "company",
  "id": "finance.close.day"
}
CampoPredefiniçãoSignificado
keyobrigatórioNome usado nos marcadores de posição. name é aceite como alternativa.
labela partir de keyA pergunta apresentada ao proprietário.
typetexttext, textarea, number, select, checkbox ou radio.
requiredfalseMarca a pergunta como uma a que o proprietário tem de responder.
defaultnenhumResposta pré-preenchida. Não é permitida numa pergunta sobre dinheiro.
placeholder, descriptionnenhumTexto de ajuda.
optionsnenhumPara select e radio: objetos {value, label} ou cadeias simples.
idnenhumUm nome estável, com pontos, para o facto, como finance.ap.invoice_mailbox, para que outros funcionários o possam partilhar.
scopecompanycompany: um facto partilhado da empresa. seat: só esta contratação.
missingnenhumO que o funcionário faz enquanto a pergunta não tem resposta.
moneyfalseMarca um montante em dinheiro. Uma pergunta sobre dinheiro não pode ter valor predefinido.

Ferramentas de sidecar

Uma app com sidecar expõe endpoints HTTP ao seu funcionário como ferramentas. O Nebo regista cada entrada como app__<app>__<name> e envia as chamadas para o sidecar em method e path. Ver Sidecar de apps.

"tools": [
  {
    "name": "list_entries",
    "description": "List journal entries for a date range.",
    "method": "GET",
    "path": "/entries",
    "input_schema": { "type": "object", "properties": { "from": { "type": "string" } } }
  }
]

Fluxos de trabalho

Cada chave em workflows dá nome a um fluxo de trabalho; o nome é o seu identificador. O formato completo está em Fluxos de trabalho, Gatilhos e Atividades.