本文へスキップ

ガイド

エージェント

Piqline のエージェントに回答させます。ターン、ステータス、会話。

エージェントは、HTTP で呼び出すダッシュボードのアシスタントです。リクエストを読み、ツールを選んで実行し、出典付きで回答します。チャットと同じエンジンを使い、キー自身が呼び出せるツールだけを使います。

エージェント一覧#

エージェント役割
piqlineワークスペースのパイプライン。コーパス、モニタリング、ボード、テーブル、ブックマーク。
requete的確な 1 つの質問に対して、Web、レジストリ、アーカイブから日付付きの事実を返します。
facebookMarketplace と公開グループをライブで読み取ります。
linkedin公開投稿をもとにした、採用、モニタリング、案件の発見。
upworkUpwork の案件を読み取り、スコアを付け、ナレッジベースをもとに回答を作成します。
onboardingワークスペースの初期設定をガイドします。ニーズ、ソース、ホームボード、アラート。オーナーと管理者のみ。

キーには agents スコープが必要です。GEThttps://piqline.com/api/v1/agents は、エージェントの一覧と、エージェントごとにキーで呼び出せるツールを返します。

1 ターンを実行する#

HTTP
POST https://piqline.com/api/v1/agents/{agent}
Content-Type: application/json
フィールド型役割
inputテキスト(最大 20,000 文字)あなたのメッセージ。
messages配列前回の呼び出しが返した、これまでの会話。
modelテキストアシスタントが提供するモデルの ID。不明な ID は既定のモデルに置き換えられます。
reasoninglow、medium、high推論の強度。対応するモデルで有効です。
streamブール値true でストリーミングのレスポンス(下記参照)。

input と 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 ?"}'

レスポンス:

フィールド意味
agent指定したエージェント
statuscompleted、requires_input、requires_approval のいずれか(下記参照)
textエージェントの回答
tool_callsこのターンで呼び出されたツール: tool、state、input、および output または error
pendingあなたの回答を待っているもの: kind(input または approval)、tool、input、承認の場合は approval_id
messages次の呼び出しで送り返す、会話の全体

会話を続ける#

前回のレスポンスの messages 配列を送り返し、新しいメッセージを 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 @-

エージェントが停止するとき#

  • completed。 エージェントが回答を終えました。text に回答が入っています。
  • requires_input。 エージェントが質問をするか、複数のソースから選ぶなどのカードを提示しています。pending に内容があります。messages を送り返しつつ、input にテキストで回答してください。
  • requires_approval。 エージェントは、ソースの購読などのアクションを提案しましたが、実行していません。実行するには、act スコープを持つキーで、pending[].tool に示されたツールを pending[].input を使って POSThttps://piqline.com/api/v1/tools/{nom} から自分で呼び出します。

ストリーミング#

"stream": true を指定すると、レスポンスは Server-Sent Events のストリームとして届きます。ダッシュボードのチャットと同じストリームです。curl では、-N を付けると届く様子を確認できます。

クレジットと所要時間#

1 ターンでワークスペースのクレジットを消費し、月間上限から差し引かれます。1 ターンの所要時間は、数秒から数十秒です。クライアント側で 5 分のタイムアウトを設定してください。

既定では、キーごとに 1 分あたり 10 ターンまで実行できます。制限を参照してください。

API についてのご質問や、このページの誤りはありませんか。 お問い合わせ.