Langsung ke konten utama

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Kernel giliran kanal adalah mesin status masuk bersama yang mengubah peristiwa platform yang telah dinormalisasi menjadi giliran agen. Plugin kanal menyediakan fakta platform dan callback pengiriman. Inti menangani orkestrasi: menerima, mengklasifikasikan, prapemeriksaan, menyelesaikan, mengotorisasi, menyusun, mencatat, mengirim, dan menyelesaikan. Gunakan ini ketika Plugin Anda berada di jalur panas pesan masuk. Untuk peristiwa non-pesan (perintah garis miring, modal, interaksi tombol, peristiwa siklus hidup, reaksi, status suara), pertahankan secara lokal di Plugin. Kernel hanya menangani peristiwa yang dapat menjadi giliran teks agen.
Kernel dicapai melalui runtime Plugin yang diinjeksi sebagai runtime.channel.turn.*. Tipe runtime Plugin diekspor dari openclaw/plugin-sdk/core, sehingga Plugin native pihak ketiga dapat menggunakan titik masuk ini dengan cara yang sama seperti Plugin kanal bawaan.

Mengapa kernel bersama

Plugin kanal mengulangi alur masuk yang sama: normalisasi, perutean, gating, membangun konteks, mencatat metadata sesi, mengirim giliran agen, menyelesaikan status pengiriman. Tanpa kernel bersama, perubahan pada gating mention, balasan terlihat khusus alat, metadata sesi, riwayat tertunda, atau finalisasi pengiriman harus diterapkan per kanal. Kernel sengaja memisahkan empat konsep:
  • ConversationFacts: dari mana pesan berasal
  • RouteFacts: agen dan sesi mana yang harus memprosesnya
  • ReplyPlanFacts: ke mana balasan terlihat harus dikirim
  • MessageFacts: body dan konteks tambahan apa yang harus dilihat agen
DM Slack, topik Telegram, thread Matrix, dan sesi topik Feishu semuanya membedakan ini dalam praktik. Memperlakukannya sebagai satu pengenal menyebabkan penyimpangan seiring waktu.

Siklus hidup tahap

Kernel menjalankan pipeline tetap yang sama terlepas dari kanal:
  1. ingest — adapter mengonversi peristiwa platform mentah menjadi NormalizedTurnInput
  2. classify — adapter menyatakan apakah peristiwa ini dapat memulai giliran agen
  3. preflight — adapter melakukan dedupe, self-echo, hidrasi, debounce, dekripsi, pengisian awal fakta parsial
  4. resolve — adapter mengembalikan giliran yang telah tersusun penuh (rute, rencana balasan, pesan, pengiriman)
  5. authorize — kebijakan DM, grup, mention, dan perintah diterapkan ke fakta yang telah disusun
  6. assembleFinalizedMsgContext dibangun dari fakta melalui buildContext
  7. record — metadata sesi masuk dan rute terakhir dipersistenkan
  8. dispatch — giliran agen dieksekusi melalui dispatcher blok buffer
  9. finalize — adapter onFinalize berjalan bahkan saat terjadi kesalahan pengiriman
Setiap tahap memancarkan peristiwa log terstruktur ketika callback log disediakan. Lihat Observabilitas.

Jenis admisi

Kernel tidak melempar ketika sebuah giliran digating. Kernel mengembalikan ChannelTurnAdmission:
JenisKapan
dispatchGiliran diterima. Giliran agen berjalan dan jalur balasan terlihat dijalankan.
observeOnlyGiliran berjalan dari awal hingga akhir tetapi adapter pengiriman tidak mengirim apa pun yang terlihat. Digunakan untuk agen pengamat siaran dan alur multi-agen pasif lainnya.
handledPeristiwa platform dikonsumsi secara lokal (siklus hidup, reaksi, tombol, modal). Kernel melewati pengiriman.
dropJalur lewati. Secara opsional recordHistory: true mempertahankan pesan dalam riwayat grup tertunda agar mention mendatang memiliki konteks.
Admisi dapat berasal dari classify (kelas peristiwa menyatakan tidak dapat memulai giliran), dari preflight (dedupe, self-echo, mention hilang dengan pencatatan riwayat), atau dari resolveTurn itu sendiri.

Titik masuk

Runtime mengekspos tiga titik masuk yang disarankan agar adapter dapat ikut serta pada level yang sesuai dengan kanal.
runtime.channel.turn.run(...)             // adapter-driven full pipeline
runtime.channel.turn.runAssembled(...)    // already-built context + delivery adapter
runtime.channel.turn.runPrepared(...)     // channel owns dispatch; kernel runs record + finalize
runtime.channel.turn.buildContext(...)    // pure facts to FinalizedMsgContext mapping
Dua helper runtime lama tetap tersedia untuk kompatibilitas SDK Plugin:
runtime.channel.turn.runResolved(...)      // deprecated compatibility alias; prefer run
runtime.channel.turn.dispatchAssembled(...) // deprecated compatibility alias; prefer runAssembled

run

Gunakan ketika kanal Anda dapat mengekspresikan alur masuknya sebagai ChannelTurnAdapter<TRaw>. Adapter memiliki callback untuk ingest, classify opsional, preflight opsional, resolveTurn wajib, dan onFinalize opsional.
await runtime.channel.turn.run({
  channel: "tlon",
  accountId,
  raw: platformEvent,
  adapter: {
    ingest(raw) {
      return {
        id: raw.messageId,
        timestamp: raw.timestamp,
        rawText: raw.body,
        textForAgent: raw.body,
      };
    },
    classify(input) {
      return { kind: "message", canStartAgentTurn: input.rawText.length > 0 };
    },
    async preflight(input, eventClass) {
      if (await isDuplicate(input.id)) {
        return { admission: { kind: "drop", reason: "dedupe" } };
      }
      return {};
    },
    resolveTurn(input) {
      return buildAssembledTurn(input);
    },
    onFinalize(result) {
      clearPendingGroupHistory(result);
    },
  },
});
run adalah bentuk yang tepat ketika kanal memiliki logika adapter kecil dan mendapat manfaat dari memiliki siklus hidup melalui hook.

runAssembled

Gunakan ketika kanal sudah menyelesaikan perutean, membangun FinalizedMsgContext, dan hanya memerlukan urutan catat, pipeline balasan, pengiriman, dan finalisasi bersama. Ini adalah bentuk yang disarankan untuk jalur masuk bawaan sederhana yang jika tidak akan mengulangi boilerplate createChannelMessageReplyPipeline(...) dan runPrepared(...).
await runtime.channel.turn.runAssembled({
  cfg,
  channel: "irc",
  accountId,
  agentId: route.agentId,
  routeSessionKey: route.sessionKey,
  storePath,
  ctxPayload,
  recordInboundSession: runtime.channel.session.recordInboundSession,
  dispatchReplyWithBufferedBlockDispatcher:
    runtime.channel.reply.dispatchReplyWithBufferedBlockDispatcher,
  delivery: {
    deliver: async (payload) => {
      await sendPlatformReply(payload);
    },
    onError: (err, info) => {
      runtime.error?.(`reply ${info.kind} failed: ${String(err)}`);
    },
  },
});
Pilih runAssembled dibandingkan runPrepared ketika satu-satunya perilaku pengiriman yang dimiliki kanal adalah pengiriman payload akhir plus pengetikan opsional, opsi balasan, pengiriman tahan lama, atau pencatatan kesalahan.

runPrepared

Gunakan ketika kanal memiliki dispatcher lokal kompleks dengan pratinjau, percobaan ulang, edit, atau bootstrap thread yang harus tetap dimiliki kanal. Kernel tetap mencatat sesi masuk sebelum pengiriman dan menampilkan DispatchedChannelTurnResult yang seragam.
const { dispatchResult } = await runtime.channel.turn.runPrepared({
  channel: "matrix",
  accountId,
  routeSessionKey,
  storePath,
  ctxPayload,
  recordInboundSession,
  record: {
    onRecordError,
    updateLastRoute,
  },
  onPreDispatchFailure: async (err) => {
    await stopStatusReactions();
  },
  runDispatch: async () => {
    return await runMatrixOwnedDispatcher();
  },
});
Kanal kaya (Matrix, Mattermost, Microsoft Teams, Feishu, QQ Bot) menggunakan runPrepared karena dispatcher mereka mengorkestrasi perilaku spesifik platform yang tidak boleh perlu dipelajari kernel.

buildContext

Fungsi murni yang memetakan bundel fakta menjadi FinalizedMsgContext. Gunakan ketika kanal Anda merakit sendiri sebagian pipeline tetapi menginginkan bentuk konteks yang konsisten.
const ctxPayload = runtime.channel.turn.buildContext({
  channel: "googlechat",
  accountId,
  messageId,
  timestamp,
  from,
  sender,
  conversation,
  route,
  reply,
  message,
  access,
  media,
  supplemental,
});
buildContext juga berguna di dalam callback resolveTurn ketika menyusun giliran untuk run.
Helper SDK yang tidak digunakan lagi seperti dispatchInboundReplyWithBase masih menjembatani melalui helper giliran tersusun. Kode Plugin baru sebaiknya menggunakan run atau runPrepared.

Tipe fakta

Fakta yang dikonsumsi kernel dari adapter Anda bersifat agnostik terhadap platform. Terjemahkan objek platform ke bentuk ini sebelum menyerahkannya ke kernel.

NormalizedTurnInput

BidangTujuan
idID pesan stabil yang digunakan untuk dedupe dan log
timestampepoch ms opsional
rawTextBody sebagaimana diterima dari platform
textForAgentBody bersih opsional untuk agen (penghapusan mention, pemangkasan pengetikan)
textForCommandsBody opsional yang digunakan untuk parsing /command
rawReferensi pass-through opsional untuk callback adapter yang membutuhkan aslinya

ChannelEventClass

BidangTujuan
kindmessage, command, interaction, reaction, lifecycle, unknown
canStartAgentTurnJika false, kernel mengembalikan { kind: "handled" }
requiresImmediateAckPetunjuk untuk adapter yang perlu melakukan ACK sebelum pengiriman

SenderFacts

BidangTujuan
idID pengirim platform yang stabil
nameNama tampilan
usernameHandle jika berbeda dari name
tagDiskriminator gaya Discord atau tag platform
rolesID peran, digunakan untuk pencocokan allowlist peran anggota
isBotTrue ketika pengirim adalah bot yang dikenal (kernel menggunakan ini untuk drop)
isSelfTrue ketika pengirim adalah agen yang dikonfigurasi itu sendiri
displayLabelLabel yang telah dirender untuk teks envelope

ConversationFacts

BidangTujuan
kinddirect, group, atau channel
idID percakapan yang digunakan untuk perutean
labelLabel manusia untuk envelope
spaceIdPengenal ruang luar opsional (workspace Slack, homeserver Matrix)
parentIdID percakapan luar ketika ini adalah thread
threadIdID thread ketika pesan ini berada di dalam thread
nativeChannelIdID kanal native platform ketika berbeda dari ID perutean
routePeerPeer yang digunakan untuk lookup resolveAgentRoute

RouteFacts

BidangTujuan
agentIdAgen yang harus menangani giliran ini
accountIdPengganti opsional (saluran multi-akun)
routeSessionKeyKunci sesi yang digunakan untuk perutean
dispatchSessionKeyKunci sesi yang digunakan saat dispatch jika berbeda dari kunci rute
persistedSessionKeyKunci sesi yang ditulis ke metadata sesi persisten
parentSessionKeyInduk untuk sesi bercabang/berutas
modelParentSessionKeyInduk sisi model untuk sesi bercabang
mainSessionKeyPin pemilik DM utama untuk percakapan langsung
createIfMissingIzinkan langkah pencatatan membuat baris sesi yang hilang

ReplyPlanFacts

BidangTujuan
toTarget balasan logis yang ditulis ke konteks To
originatingToTarget konteks asal (OriginatingTo)
nativeChannelIdId saluran native platform untuk pengiriman
replyTargetTujuan balasan terlihat final jika berbeda dari to
deliveryTargetPengganti pengiriman tingkat rendah
replyToIdId pesan yang dikutip/ditambatkan
replyToIdFullId kutipan bentuk lengkap saat platform memiliki keduanya
messageThreadIdId thread pada waktu pengiriman
threadParentIdId pesan induk dari thread
sourceReplyDeliveryModethread, reply, channel, direct, atau none

AccessFacts

AccessFacts membawa boolean yang dibutuhkan tahap otorisasi. Pencocokan identitas tetap berada di saluran: kernel hanya memakai hasilnya.
BidangTujuan
dmKeputusan izinkan/pasangkan/tolak DM dan daftar allowFrom
groupKebijakan grup, izin rute, izin pengirim, allowlist, persyaratan mention
commandsOtorisasi perintah di seluruh pengotorisasi yang dikonfigurasi
mentionsApakah deteksi mention memungkinkan dan apakah agen disebut

MessageFacts

BidangTujuan
bodyIsi envelope final (terformat)
rawBodyIsi inbound mentah
bodyForAgentIsi yang dilihat agen
commandBodyIsi yang digunakan untuk parsing perintah
envelopeFromLabel pengirim yang sudah dirender untuk envelope
senderLabelPengganti opsional untuk pengirim yang dirender
previewPratinjau singkat yang disunting untuk log
inboundHistoryEntri riwayat inbound terbaru saat saluran menyimpan buffer

SupplementalContextFacts

Konteks tambahan mencakup konteks kutipan, penerusan, dan bootstrap thread. Kernel menerapkan kebijakan contextVisibility yang dikonfigurasi. Adapter saluran hanya menyediakan fakta dan flag senderAllowed agar kebijakan lintas saluran tetap konsisten.

InboundMediaFacts

Media berbentuk fakta. Unduhan platform, autentikasi, kebijakan SSRF, aturan CDN, dan dekripsi tetap lokal saluran. Kernel memetakan fakta ke MediaPath, MediaUrl, MediaType, MediaPaths, MediaUrls, MediaTypes, dan MediaTranscribedIndexes.

Kontrak adapter

Untuk run penuh, bentuk adapternya adalah:
type ChannelTurnAdapter<TRaw> = {
  ingest(raw: TRaw): Promise<NormalizedTurnInput | null> | NormalizedTurnInput | null;
  classify?(input: NormalizedTurnInput): Promise<ChannelEventClass> | ChannelEventClass;
  preflight?(
    input: NormalizedTurnInput,
    eventClass: ChannelEventClass,
  ): Promise<PreflightFacts | ChannelTurnAdmission | null | undefined>;
  resolveTurn(
    input: NormalizedTurnInput,
    eventClass: ChannelEventClass,
    preflight: PreflightFacts,
  ): Promise<ChannelTurnResolved> | ChannelTurnResolved;
  onFinalize?(result: ChannelTurnResult): Promise<void> | void;
};
resolveTurn mengembalikan ChannelTurnResolved, yaitu AssembledChannelTurn dengan jenis admission opsional. Mengembalikan { admission: { kind: "observeOnly" } } menjalankan giliran tanpa menghasilkan output yang terlihat. Adapter tetap memiliki callback pengiriman; callback itu hanya menjadi no-op untuk giliran tersebut. onFinalize berjalan pada setiap hasil, termasuk error dispatch. Gunakan ini untuk membersihkan riwayat grup yang tertunda, menghapus reaksi ack, menghentikan indikator status, dan melakukan flush state lokal.

Adapter pengiriman

Kernel tidak memanggil platform secara langsung. Saluran menyerahkan ChannelTurnDeliveryAdapter ke kernel:
type ChannelTurnDeliveryAdapter = {
  deliver(payload: ReplyPayload, info: ChannelDeliveryInfo): Promise<ChannelDeliveryResult | void>;
  onError?(err: unknown, info: { kind: string }): void;
  durable?: false | DurableInboundReplyDeliveryOptions;
};

type ChannelDeliveryResult = {
  messageIds?: string[];
  receipt?: MessageReceipt;
  threadId?: string;
  replyToId?: string;
  visibleReplySent?: boolean;
};
deliver dipanggil sekali per potongan balasan yang dibuffer. Selama migrasi siklus hidup pesan, pengiriman channel-turn yang telah dirakit dimiliki saluran secara default: field durable yang dihilangkan berarti kernel harus memanggil deliver secara langsung dan tidak boleh merutekan melalui pengiriman outbound generik. Tetapkan durable hanya setelah saluran diaudit untuk membuktikan bahwa jalur kirim generik mempertahankan perilaku pengiriman lama, termasuk target balasan/thread, penanganan media, cache pesan terkirim/self-echo, pembersihan status, dan id pesan yang dikembalikan. durable: false tetap menjadi ejaan kompatibilitas untuk “gunakan callback milik saluran”, tetapi saluran yang belum dimigrasikan seharusnya tidak perlu menambahkannya. Kembalikan id pesan platform saat saluran memilikinya agar dispatcher dapat mempertahankan tambatan thread dan mengedit potongan berikutnya; jalur pengiriman yang lebih baru juga harus mengembalikan receipt agar pemulihan, finalisasi pratinjau, dan penekanan duplikat dapat berpindah dari messageIds. Untuk giliran observe-only, kembalikan { visibleReplySent: false } atau gunakan createNoopChannelTurnDeliveryAdapter(). Saluran yang menggunakan runPrepared dengan dispatcher yang sepenuhnya dimiliki saluran tidak memiliki ChannelTurnDeliveryAdapter. Dispatcher tersebut tidak durable secara default. Dispatcher harus mempertahankan jalur pengiriman langsungnya sampai secara eksplisit ikut memakai konteks kirim baru dengan target lengkap, adapter aman-replay, kontrak receipt, dan hook efek samping saluran. Helper kompatibilitas publik seperti recordInboundSessionAndDispatchReply, dispatchInboundReplyWithBase, dan helper direct-DM harus tetap mempertahankan perilaku selama migrasi. Helper tersebut tidak boleh memanggil pengiriman durable generik sebelum callback deliver atau reply milik pemanggil.

Opsi pencatatan

Tahap pencatatan membungkus recordInboundSession. Sebagian besar saluran dapat menggunakan default. Ganti melalui record:
record: {
  groupResolution,
  createIfMissing: true,
  updateLastRoute,
  onRecordError: (err) => log.warn("record failed", err),
  trackSessionMetaTask: (task) => pendingTasks.push(task),
}
Dispatcher menunggu tahap pencatatan. Jika pencatatan melempar error, kernel menjalankan onPreDispatchFailure (saat diberikan ke runPrepared) dan melempar ulang.

Observabilitas

Setiap tahap memancarkan event terstruktur saat callback log disediakan:
await runtime.channel.turn.run({
  channel: "twitch",
  accountId,
  raw,
  adapter,
  log: (event) => {
    runtime.log?.debug?.(`turn.${event.stage}:${event.event}`, {
      channel: event.channel,
      accountId: event.accountId,
      messageId: event.messageId,
      sessionKey: event.sessionKey,
      admission: event.admission,
      reason: event.reason,
    });
  },
});
Tahap yang dicatat: ingest, classify, preflight, resolve, authorize, assemble, record, dispatch, finalize. Hindari mencatat isi mentah; gunakan MessageFacts.preview untuk pratinjau singkat yang disunting.

Yang tetap lokal saluran

Kernel memiliki orkestrasi. Saluran tetap memiliki:
  • Transport platform (Gateway, REST, websocket, polling, Webhook)
  • Resolusi identitas dan pencocokan nama tampilan
  • Perintah native, slash command, autocomplete, modal, tombol, state suara
  • Rendering kartu, modal, dan adaptive-card
  • Autentikasi media, aturan CDN, media terenkripsi, transkripsi
  • API edit, reaksi, penyuntingan, dan presence
  • Backfill dan pengambilan riwayat sisi platform
  • Alur pairing yang memerlukan verifikasi spesifik platform
Jika dua saluran mulai membutuhkan helper yang sama untuk salah satu hal ini, ekstrak helper SDK bersama alih-alih mendorongnya ke kernel.

Stabilitas

runtime.channel.turn.* adalah bagian dari permukaan runtime plugin publik. Tipe fakta (SenderFacts, ConversationFacts, RouteFacts, ReplyPlanFacts, AccessFacts, MessageFacts, SupplementalContextFacts, InboundMediaFacts) dan bentuk admission (ChannelTurnAdmission, ChannelEventClass) dapat dijangkau melalui PluginRuntime dari openclaw/plugin-sdk/core. Aturan kompatibilitas mundur berlaku: field fakta baru bersifat aditif, jenis admission tidak diganti nama, dan nama entry point tetap stabil. Kebutuhan saluran baru yang memerlukan perubahan non-aditif harus melalui proses migrasi SDK plugin.

Terkait