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#
| Agent | Rolle |
|---|---|
piqline | Pipeline des Workspace: Korpus, Beobachtung, Boards, Tabellen und Lesezeichen. |
requete | Eine präzise Frage, datierte Fakten aus Web, Registern und Archiven. |
facebook | Marketplace und öffentliche Gruppen, live. |
linkedin | Einstellung, Beobachtung und Gelegenheiten aus öffentlichen Beiträgen. |
upwork | Upwork-Jobs lesen, bewerten und anhand Ihrer Wissensbasis beantworten. |
onboarding | Gefü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#
POST https://piqline.com/api/v1/agents/{agent}
Content-Type: application/json| Feld | Typ | Rolle |
|---|---|---|
input | Text, höchstens 20.000 Zeichen | Ihre Nachricht. |
messages | Array | Die bisherige Unterhaltung, so wie der vorherige Aufruf sie geliefert hat. |
model | Text | ID eines vom Assistenten angebotenen Modells. Eine unbekannte ID wird durch das Standardmodell ersetzt. |
reasoning | low, medium oder high | Denkaufwand, für Modelle, die ihn unterstützen. |
stream | Boolean | true: 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 ?"}'const response = await fetch("https://piqline.com/api/v1/agents/piqline", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({ input: "Quelles sources sont en erreur, et depuis quand ?" }),
});
const data = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/agents/piqline",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={"input": "Quelles sources sont en erreur, et depuis quand ?"},
)
data = response.json()Die Antwort:
| Feld | Bedeutung |
|---|---|
agent | der Agent, den Sie angefragt haben |
status | completed, requires_input oder requires_approval (siehe unten) |
text | die Antwort des Agenten |
tool_calls | die im Turn aufgerufenen Tools: tool, state, input und output oder error |
pending | was auf Ihre Antwort wartet: kind (input oder approval), tool, input und, bei einer Freigabe, approval_id |
messages | die 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:
# 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.textenthält seine Antwort.requires_input. Der Agent stellt eine Frage oder bietet eine Karte an, zum Beispiel die Wahl zwischen mehreren Quellen.pendingbeschreibt sie. Antworten Sie als Text ininputund senden Siemessageszurü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 inpending[].toolgenannte Tool selbst auf, mitpending[].input, überPOSThttps://piqline.com/api/v1/tools/{nom}und mit einem Schlüssel, der den Scopeacthat.
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.