Ir para o conteúdo

Guias

Agentes

Faça um agente Piqline responder: um turno, um status, uma conversa.

Um agente é o assistente do painel, chamado via HTTP: ele lê o seu pedido, escolhe suas ferramentas, as executa e responde com as fontes. Usa o mesmo motor do chat. Só tem as ferramentas que a sua chave poderia chamar.

Os agentes#

AgenteFunção
piqlinePipeline do workspace: corpus, monitoramento, boards, tabelas e favoritos.
requeteUma pergunta precisa, fatos datados extraídos da web, de registros e de arquivos.
facebookMarketplace e grupos públicos, ao vivo.
linkedinContratação, monitoramento e oportunidades a partir de posts públicos.
upworkVagas do Upwork lidas, pontuadas e respondidas a partir da sua base de conhecimento.
onboardingConfiguração guiada do workspace: necessidade, fontes, board inicial, alertas. Somente owners e admins.

A chave precisa do scope agents. GEThttps://piqline.com/api/v1/agents lista os agentes e, para cada um, as ferramentas que a sua chave pode chamar.

Executar um turno#

HTTP
POST https://piqline.com/api/v1/agents/{agent}
Content-Type: application/json
CampoTipoFunção
inputtexto, no máximo 20.000 caracteresSua mensagem.
messagesarrayA conversa anterior, como a chamada anterior a devolveu.
modeltextoID de um modelo oferecido pelo assistente. Um ID desconhecido é substituído pelo modelo padrão.
reasoninglow, medium ou highEsforço de raciocínio, para os modelos que o aceitam.
streambooleanotrue: resposta em streaming (veja abaixo).

Envie pelo menos input ou messages.

curl -s https://piqline.com/api/v1/agents/piqline \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":"Quelles sources sont en erreur, et depuis quand ?"}'

A resposta:

CampoSignificado
agento agente que você consultou
statuscompleted, requires_input ou requires_approval (veja abaixo)
texta resposta do agente
tool_callsas ferramentas chamadas durante o turno: tool, state, input e output ou error
pendingo que aguarda a sua resposta: kind (input ou approval), tool, input e, para uma aprovação, approval_id
messagesa conversa completa, para reenviar na próxima chamada

Continuar uma conversa#

Reenvie o array messages da resposta anterior e coloque a nova mensagem em input:

Shell
# Premier tour : on garde la réponse.
curl -s https://piqline.com/api/v1/agents/piqline \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":"Quelles sources sont en erreur ?"}' > tour1.json

# Deuxième tour : on renvoie la conversation.
jq '{messages: .messages, input: "Et depuis quand ?"}' tour1.json \
  | curl -s https://piqline.com/api/v1/agents/piqline \
      -H "Authorization: Bearer $PIQLINE_API_KEY" \
      -H "Content-Type: application/json" \
      -d @-

Quando o agente para#

  • completed. O agente respondeu. text contém a resposta.
  • requires_input. O agente faz uma pergunta ou propõe um cartão, por exemplo uma escolha entre várias fontes. pending o descreve. Responda em texto em input, reenviando messages.
  • requires_approval. O agente propõe uma ação, por exemplo assinar uma fonte, sem executá-la. Para executá-la, chame você mesmo a ferramenta indicada em pending[].tool com pending[].input, por meio de POSThttps://piqline.com/api/v1/tools/{nom}, com uma chave que tenha o scope act.

Streaming#

Com "stream": true, a resposta chega como um fluxo de Server-Sent Events: o mesmo fluxo do chat do painel. Com curl, adicione -N para vê-la chegar.

Créditos e duração#

Um turno consome créditos do workspace, debitados do seu limite mensal. Um turno dura de alguns segundos a várias dezenas de segundos. Defina um timeout de 5 minutos no cliente.

Cada chave pode executar 10 turnos por minuto por padrão: veja Limites.

Uma dúvida sobre a API, ou um erro nesta página? Escreva para nós.