Przejdź do głównej treści

Documentation Index

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

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

Jądro tur kanału to wspólna maszyna stanów przychodzących, która przekształca znormalizowane zdarzenie platformy w turę agenta. Pluginy kanałów dostarczają fakty platformy i wywołanie zwrotne dostarczania. Rdzeń odpowiada za orkiestrację: przyjmowanie, klasyfikowanie, kontrole wstępne, rozwiązywanie, autoryzowanie, składanie, rejestrowanie, wysyłanie i finalizowanie. Użyj tego, gdy Twój plugin znajduje się na gorącej ścieżce wiadomości przychodzących. Zdarzenia niebędące wiadomościami (polecenia ukośnikowe, modale, interakcje przycisków, zdarzenia cyklu życia, reakcje, stan głosu) pozostaw lokalnie w pluginie. Jądro odpowiada tylko za zdarzenia, które mogą stać się tekstową turą agenta.
Do jądra dociera się przez wstrzyknięte środowisko uruchomieniowe pluginu jako runtime.channel.turn.*. Typ środowiska uruchomieniowego pluginu jest eksportowany z openclaw/plugin-sdk/core, więc natywne pluginy firm trzecich mogą używać tych punktów wejścia tak samo jak dołączone pluginy kanałów.

Dlaczego wspólne jądro

Pluginy kanałów powtarzają ten sam przepływ przychodzący: normalizacja, trasowanie, bramkowanie, budowanie kontekstu, rejestrowanie metadanych sesji, wysyłanie tury agenta, finalizowanie stanu dostarczania. Bez wspólnego jądra zmianę bramkowania wzmianek, widocznych odpowiedzi tylko narzędziowych, metadanych sesji, oczekującej historii lub finalizacji wysyłania trzeba stosować osobno dla każdego kanału. Jądro celowo rozdziela cztery pojęcia:
  • ConversationFacts: skąd pochodzi wiadomość
  • RouteFacts: który agent i która sesja powinny ją przetworzyć
  • ReplyPlanFacts: dokąd powinny trafić widoczne odpowiedzi
  • MessageFacts: jaką treść i dodatkowy kontekst powinien zobaczyć agent
W praktyce DM-y Slacka, tematy Telegram, wątki Matrix i sesje tematów Feishu rozróżniają je wszystkie. Traktowanie ich jako jednego identyfikatora z czasem powoduje rozjazdy.

Cykl życia etapów

Jądro uruchamia ten sam stały potok niezależnie od kanału:
  1. ingest — adapter przekształca surowe zdarzenie platformy w NormalizedTurnInput
  2. classify — adapter deklaruje, czy to zdarzenie może rozpocząć turę agenta
  3. preflight — adapter wykonuje deduplikację, obsługę własnego echa, hydratację, debounce, odszyfrowanie, częściowe wstępne wypełnienie faktów
  4. resolve — adapter zwraca w pełni złożoną turę (trasę, plan odpowiedzi, wiadomość, dostarczanie)
  5. authorize — do złożonych faktów stosowane są zasady DM-ów, grup, wzmianek i poleceń
  6. assembleFinalizedMsgContext budowany z faktów przez buildContext
  7. record — metadane sesji przychodzącej i ostatnia trasa utrwalane
  8. dispatch — tura agenta wykonywana przez buforowany dyspozytor bloków
  9. finalize — adapter onFinalize uruchamia się nawet przy błędzie wysyłania
Każdy etap emituje ustrukturyzowane zdarzenie dziennika, gdy podano wywołanie zwrotne log. Zobacz Obserwowalność.

Rodzaje dopuszczenia

Jądro nie zgłasza wyjątku, gdy tura zostaje zablokowana. Zwraca ChannelTurnAdmission:
RodzajKiedy
dispatchTura jest dopuszczona. Tura agenta działa, a ścieżka widocznej odpowiedzi jest używana.
observeOnlyTura działa od początku do końca, ale adapter dostarczania nie wysyła niczego widocznego. Używane dla agentów-obserwatorów rozgłoszeniowych i innych pasywnych przepływów wieloagentowych.
handledZdarzenie platformy zostało obsłużone lokalnie (cykl życia, reakcja, przycisk, modal). Jądro pomija wysyłanie.
dropŚcieżka pominięcia. Opcjonalnie recordHistory: true zachowuje wiadomość w oczekującej historii grupy, aby przyszła wzmianka miała kontekst.
Dopuszczenie może pochodzić z classify (klasa zdarzenia stwierdziła, że nie może rozpocząć tury), z preflight (deduplikacja, własne echo, brak wzmianki z zapisem historii) albo z samego resolveTurn.

Punkty wejścia

Środowisko uruchomieniowe udostępnia trzy preferowane punkty wejścia, aby adaptery mogły włączać się na poziomie pasującym do kanału.
runtime.channel.turn.run(...)             // pełny potok sterowany przez adapter
runtime.channel.turn.runPrepared(...)     // kanał odpowiada za wysyłanie; jądro wykonuje record + finalize
runtime.channel.turn.buildContext(...)    // czyste fakty do mapowania FinalizedMsgContext
Dwa starsze pomocniki środowiska uruchomieniowego pozostają dostępne dla zgodności z Plugin SDK:
runtime.channel.turn.runResolved(...)      // przestarzały alias zgodności; preferuj run
runtime.channel.turn.dispatchAssembled(...) // przestarzały alias zgodności; preferuj run lub runPrepared

run

Użyj, gdy Twój kanał może wyrazić swój przepływ przychodzący jako ChannelTurnAdapter<TRaw>. Adapter ma wywołania zwrotne dla ingest, opcjonalne classify, opcjonalne preflight, obowiązkowe resolveTurn i opcjonalne onFinalize.
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 ma właściwy kształt, gdy kanał ma niewielką logikę adaptera i korzysta na posiadaniu cyklu życia przez haki.

runPrepared

Użyj, gdy kanał ma złożony lokalny dyspozytor z podglądami, ponowieniami, edycjami lub bootstrapem wątków, który musi pozostać własnością kanału. Jądro nadal rejestruje sesję przychodzącą przed wysłaniem i udostępnia jednolity DispatchedChannelTurnResult.
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();
  },
});
Bogate kanały (Matrix, Mattermost, Microsoft Teams, Feishu, QQ Bot) używają runPrepared, ponieważ ich dyspozytor orkiestruje zachowanie specyficzne dla platformy, którego jądro nie powinno poznawać.

buildContext

Czysta funkcja, która mapuje pakiety faktów na FinalizedMsgContext. Użyj jej, gdy Twój kanał ręcznie implementuje część potoku, ale chce spójnego kształtu kontekstu.
const ctxPayload = runtime.channel.turn.buildContext({
  channel: "googlechat",
  accountId,
  messageId,
  timestamp,
  from,
  sender,
  conversation,
  route,
  reply,
  message,
  access,
  media,
  supplemental,
});
buildContext przydaje się też wewnątrz wywołań zwrotnych resolveTurn podczas składania tury dla run.
Przestarzałe pomocniki SDK, takie jak dispatchInboundReplyWithBase, nadal przechodzą przez pomocnik złożonej tury. Nowy kod pluginu powinien używać run albo runPrepared.

Typy faktów

Fakty konsumowane przez jądro z Twojego adaptera są niezależne od platformy. Przetłumacz obiekty platformy na te kształty przed przekazaniem ich do jądra.

NormalizedTurnInput

PoleCel
idStabilny identyfikator wiadomości używany do deduplikacji i dzienników
timestampOpcjonalny czas epoki w ms
rawTextTreść odebrana z platformy
textForAgentOpcjonalnie oczyszczona treść dla agenta (usunięcie wzmianki, przycięcie pisania)
textForCommandsOpcjonalna treść używana do parsowania /command
rawOpcjonalne odwołanie przekazywane dalej dla wywołań zwrotnych adaptera, które potrzebują oryginału

ChannelEventClass

PoleCel
kindmessage, command, interaction, reaction, lifecycle, unknown
canStartAgentTurnJeśli false, jądro zwraca { kind: "handled" }
requiresImmediateAckWskazówka dla adapterów, które muszą wykonać ACK przed wysłaniem

SenderFacts

PoleCel
idStabilny identyfikator nadawcy na platformie
nameNazwa wyświetlana
usernameUchwyt, jeśli różni się od name
tagDyskryminator w stylu Discorda albo tag platformy
rolesIdentyfikatory ról, używane do dopasowywania listy dozwolonych ról członków
isBotTrue, gdy nadawca jest znanym botem (jądro używa do odrzucania)
isSelfTrue, gdy nadawca jest samym skonfigurowanym agentem
displayLabelWstępnie wyrenderowana etykieta dla tekstu koperty

ConversationFacts

PoleCel
kinddirect, group albo channel
idIdentyfikator konwersacji używany do trasowania
labelCzytelna etykieta koperty
spaceIdOpcjonalny identyfikator przestrzeni zewnętrznej (obszar roboczy Slacka, homeserver Matrix)
parentIdIdentyfikator konwersacji zewnętrznej, gdy to jest wątek
threadIdIdentyfikator wątku, gdy ta wiadomość znajduje się w wątku
nativeChannelIdNatywny identyfikator kanału platformy, gdy różni się od identyfikatora trasowania
routePeerPeer używany do wyszukiwania resolveAgentRoute

RouteFacts

PoleCel
agentIdAgent, który powinien obsłużyć tę turę
accountIdOpcjonalne nadpisanie (kanały z wieloma kontami)
routeSessionKeyKlucz sesji używany do trasowania
dispatchSessionKeyKlucz sesji używany przy wysyłaniu, gdy różni się od klucza trasy
persistedSessionKeyKlucz sesji zapisany w utrwalonych metadanych sesji
parentSessionKeyRodzic dla sesji rozgałęzionych/wątkowanych
modelParentSessionKeyRodzic po stronie modelu dla sesji rozgałęzionych
mainSessionKeyPrzypięcie właściciela głównego DM dla konwersacji bezpośrednich
createIfMissingZezwól etapowi rejestrowania na utworzenie brakującego wiersza sesji

ReplyPlanFacts

PoleCel
toLogiczny cel odpowiedzi zapisywany w kontekście To
originatingToPoczątkowy cel kontekstu (OriginatingTo)
nativeChannelIdNatywny dla platformy identyfikator kanału do dostarczenia
replyTargetKońcowy widoczny cel odpowiedzi, jeśli różni się od to
deliveryTargetNiższego poziomu nadpisanie miejsca dostarczenia
replyToIdIdentyfikator cytowanej/zakotwiczonej wiadomości
replyToIdFullPełna postać cytowanego identyfikatora, gdy platforma ma obie
messageThreadIdIdentyfikator wątku w czasie dostarczenia
threadParentIdIdentyfikator wiadomości nadrzędnej wątku
sourceReplyDeliveryModethread, reply, channel, direct lub none

AccessFacts

AccessFacts przenosi wartości logiczne potrzebne etapowi autoryzacji. Dopasowywanie tożsamości pozostaje w kanale: kernel zużywa tylko wynik.
PoleCel
dmDecyzja zezwolenia/parowania/odmowy dla DM oraz lista allowFrom
groupZasady grupy, zezwolenie trasy, zezwolenie nadawcy, lista dozwolonych, wymóg wzmianki
commandsAutoryzacja poleceń w skonfigurowanych autoryzatorach
mentionsCzy wykrywanie wzmianek jest możliwe i czy agent został wspomniany

MessageFacts

PoleCel
bodyKońcowa treść koperty (sformatowana)
rawBodySurowa treść przychodząca
bodyForAgentTreść widziana przez agenta
commandBodyTreść używana do parsowania poleceń
envelopeFromWstępnie wyrenderowana etykieta nadawcy dla koperty
senderLabelOpcjonalne nadpisanie wyrenderowanego nadawcy
previewKrótki zredagowany podgląd do logów
inboundHistoryOstatnie wpisy historii przychodzącej, gdy kanał utrzymuje bufor

SupplementalContextFacts

Kontekst uzupełniający obejmuje kontekst cytatu, przekazania oraz inicjalizacji wątku. Kernel stosuje skonfigurowaną zasadę contextVisibility. Adapter kanału dostarcza tylko fakty i flagi senderAllowed, dzięki czemu zasady międzykanałowe pozostają spójne.

InboundMediaFacts

Media mają postać faktów. Pobieranie platformowe, uwierzytelnianie, zasady SSRF, reguły CDN i deszyfrowanie pozostają lokalne dla kanału. Kernel mapuje fakty na MediaPath, MediaUrl, MediaType, MediaPaths, MediaUrls, MediaTypes i MediaTranscribedIndexes.

Kontrakt adaptera

Dla pełnego run kształt adaptera jest następujący:
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 zwraca ChannelTurnResolved, czyli AssembledChannelTurn z opcjonalnym rodzajem dopuszczenia. Zwrócenie { admission: { kind: "observeOnly" } } uruchamia turę bez tworzenia widocznych danych wyjściowych. Adapter nadal jest właścicielem wywołania zwrotnego dostarczenia; dla tej tury staje się ono po prostu operacją bez efektu. onFinalize uruchamia się dla każdego wyniku, w tym błędów wysyłki. Używaj go do czyszczenia oczekującej historii grupy, usuwania reakcji potwierdzenia, zatrzymywania wskaźników statusu i opróżniania stanu lokalnego.

Adapter dostarczania

Kernel nie wywołuje platformy bezpośrednio. Kanał przekazuje kernelowi ChannelTurnDeliveryAdapter:
type ChannelTurnDeliveryAdapter = {
  deliver(payload: ReplyPayload, info: ChannelDeliveryInfo): Promise<ChannelDeliveryResult | void>;
  onError?(err: unknown, info: { kind: string }): void;
};

type ChannelDeliveryResult = {
  messageIds?: string[];
  threadId?: string;
  replyToId?: string;
  visibleReplySent?: boolean;
};
deliver jest wywoływane raz dla każdego buforowanego fragmentu odpowiedzi. Zwracaj identyfikatory wiadomości platformy, gdy kanał je ma, aby dyspozytor mógł zachować zakotwiczenia wątku i później edytować kolejne fragmenty. Dla tur tylko obserwacyjnych zwróć { visibleReplySent: false } albo użyj createNoopChannelTurnDeliveryAdapter().

Opcje rekordu

Etap rekordu opakowuje recordInboundSession. Większość kanałów może używać wartości domyślnych. Nadpisz przez record:
record: {
  groupResolution,
  createIfMissing: true,
  updateLastRoute,
  onRecordError: (err) => log.warn("record failed", err),
  trackSessionMetaTask: (task) => pendingTasks.push(task),
}
Dyspozytor czeka na etap rekordu. Jeśli rekord zgłosi wyjątek, kernel uruchamia onPreDispatchFailure (gdy podano je do runPrepared) i ponownie zgłasza wyjątek.

Obserwowalność

Każdy etap emituje zdarzenie strukturalne, gdy podano wywołanie zwrotne log:
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,
    });
  },
});
Logowane etapy: ingest, classify, preflight, resolve, authorize, assemble, record, dispatch, finalize. Unikaj logowania surowych treści; używaj MessageFacts.preview do krótkich zredagowanych podglądów.

Co pozostaje lokalne dla kanału

Kernel jest właścicielem orkiestracji. Kanał nadal jest właścicielem:
  • Transportów platformy (Gateway, REST, websocket, polling, webhooki)
  • Rozwiązywania tożsamości i dopasowywania nazw wyświetlanych
  • Poleceń natywnych, poleceń slash, autouzupełniania, modali, przycisków, stanu głosu
  • Renderowania kart, modali i kart adaptacyjnych
  • Uwierzytelniania mediów, reguł CDN, mediów szyfrowanych, transkrypcji
  • API edycji, reakcji, redakcji i obecności
  • Backfillu i pobierania historii po stronie platformy
  • Przepływów parowania wymagających weryfikacji specyficznej dla platformy
Jeśli dwa kanały zaczynają potrzebować tego samego pomocnika dla jednej z tych rzeczy, wyodrębnij współdzielony pomocnik SDK zamiast przenosić go do kernela.

Stabilność

runtime.channel.turn.* jest częścią publicznej powierzchni środowiska uruchomieniowego pluginów. Typy faktów (SenderFacts, ConversationFacts, RouteFacts, ReplyPlanFacts, AccessFacts, MessageFacts, SupplementalContextFacts, InboundMediaFacts) i kształty dopuszczenia (ChannelTurnAdmission, ChannelEventClass) są dostępne przez PluginRuntime z openclaw/plugin-sdk/core. Obowiązują zasady zgodności wstecznej: nowe pola faktów są addytywne, rodzaje dopuszczenia nie są przemianowywane, a nazwy punktów wejścia pozostają stabilne. Nowe potrzeby kanału wymagające zmiany nieaddytywnej muszą przejść przez proces migracji SDK pluginów.

Powiązane