Zum Inhalt springen

Leitfäden

Agenten

Einen Piqline-Agenten antworten lassen: ein Turn, ein Status, eine Unterhaltung.

Ein Agent ist der Assistent des Dashboards, aufgerufen über HTTP: Er liest Ihre Anfrage, wählt seine Tools, führt sie aus und antwortet mit seinen Quellen. Er nutzt dieselbe Engine wie der Chat. Er hat nur die Tools, die Ihr Schlüssel auch selbst aufrufen könnte.

Die Agenten#

AgentRolle
piqlinePipeline des Workspace: Korpus, Beobachtung, Boards, Tabellen und Lesezeichen.
requeteEine präzise Frage, datierte Fakten aus Web, Registern und Archiven.
facebookMarketplace und öffentliche Gruppen, live.
linkedinEinstellung, Beobachtung und Gelegenheiten aus öffentlichen Beiträgen.
upworkUpwork-Jobs lesen, bewerten und anhand Ihrer Wissensbasis beantworten.
onboardingGeführte Einrichtung des Workspace: Bedarf, Quellen, Start-Board, Alarme. Nur Owner und Admins.

Der Schlüssel braucht den Scope agents. GEThttps://piqline.com/api/v1/agents listet die Agenten auf und für jeden die Tools, die Ihr Schlüssel aufrufen kann.

Einen Turn ausführen#

HTTP
POST https://piqline.com/api/v1/agents/{agent}
Content-Type: application/json
FeldTypRolle
inputText, höchstens 20.000 ZeichenIhre Nachricht.
messagesArrayDie bisherige Unterhaltung, so wie der vorherige Aufruf sie geliefert hat.
modelTextID eines vom Assistenten angebotenen Modells. Eine unbekannte ID wird durch das Standardmodell ersetzt.
reasoninglow, medium oder highDenkaufwand, für Modelle, die ihn unterstützen.
streamBooleantrue: gestreamte Antwort (siehe unten).

Senden Sie mindestens input oder 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 ?"}'

Die Antwort:

FeldBedeutung
agentder Agent, den Sie angefragt haben
statuscompleted, requires_input oder requires_approval (siehe unten)
textdie Antwort des Agenten
tool_callsdie im Turn aufgerufenen Tools: tool, state, input und output oder error
pendingwas auf Ihre Antwort wartet: kind (input oder approval), tool, input und, bei einer Freigabe, approval_id
messagesdie vollständige Unterhaltung, die Sie beim nächsten Aufruf zurücksenden

Eine Unterhaltung fortsetzen#

Senden Sie das Array messages der vorherigen Antwort zurück und tragen Sie Ihre neue Nachricht in input ein:

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 @-

Wann der Agent anhält#

  • completed. Der Agent hat geantwortet. text enthält seine Antwort.
  • requires_input. Der Agent stellt eine Frage oder bietet eine Karte an, zum Beispiel die Wahl zwischen mehreren Quellen. pending beschreibt sie. Antworten Sie als Text in input und senden Sie messages zurück.
  • requires_approval. Der Agent schlägt eine Aktion vor, zum Beispiel das Abonnieren einer Quelle, ohne sie auszuführen. Um sie auszuführen, rufen Sie das in pending[].tool genannte Tool selbst auf, mit pending[].input, über POSThttps://piqline.com/api/v1/tools/{nom} und mit einem Schlüssel, der den Scope act hat.

Streaming#

Mit "stream": true kommt die Antwort als Strom von Server-Sent Events: derselbe Strom wie im Chat des Dashboards. Mit curl sehen Sie ihn durch -N live eintreffen.

Credits und Dauer#

Ein Turn verbraucht Credits des Workspace, belastet sein Monatslimit. Ein Turn dauert wenige Sekunden bis mehrere zehn Sekunden. Setzen Sie clientseitig ein Timeout von 5 Minuten.

Jeder Schlüssel kann standardmäßig 10 Turns pro Minute ausführen: siehe Grenzwerte.

Eine Frage zur API oder ein Fehler auf dieser Seite? Schreiben Sie uns.