sideagentDokumentasi

Library

Operations dan allowlist

Operation API mana yang dapat dipanggil model, dan petunjuk x-agent yang dapat Anda tambahkan ke spec.

Di halaman ini

Setiap operation di spec Anda yang memiliki operationId dapat menjadi tool. Hanya operation yang Anda izinkan yang diperlihatkan ke model. Daftarkan ID-nya, atau gunakan tag:reports untuk mengizinkan satu tag sekaligus. Operation baru tidak pernah diizinkan secara default.

Ekstensi x-agent

Tambahkan petunjuk ke spec dengan ekstensi x-agent pada sebuah operation:

"x-agent": {
  "approval": "required",
  "description": "Better text for the model than the summary",
  "invalidates": ["invoices"],
  "responseFields": ["id", "total"]
}
  • approval: memaksa atau melewati langkah approval. Lihat Approvals.
  • description: teks yang dilihat model, menggantikan ringkasan (summary) dari spec.
  • invalidates: tag yang perlu di-refetch oleh UI setelah panggilan berhasil (hooks.onInvalidate di komponen chat).
  • responseFields: hanya field respons ini yang sampai ke model dan browser.

Batasan panggilan

Panggilan menggunakan baseUrl yang di-pin dan tidak pernah mengikuti redirect. Ukuran request dan response, jumlah langkah per turn, serta waktu per turn dibatasi.