Schemat gniazda parsera Aggrega Wasm
Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.
Identyfikator schematu: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json
Kształty komunikatów, które gniazdo pluginu parsera przyjmuje (ParseInput) i emituje (ParseOutput). Parser to bezstanowy transformator bez efektów ubocznych, który zamienia obcą reprezentację tekstową w kanoniczne, ustrukturyzowane drzewo JSON, dzięki czemu każdy konsument w dowolnym języku może odczytać drzewo bez własnego parsera danego języka. Parser deklaruje obsługiwane formaty jako możliwości parse:
Jeden z następujących kształtów
ParseInputParseOutput
Definicje
ParseInput
Ładunek, który otrzymuje gość parsera: nazwa formatu określająca sposób odczytu bajtów, bajty źródła do sparsowania oraz opcjonalny, nieprzejrzysty dokument opcji, który konsument dostarcza na potrzeby zachowania specyficznego dla parsera.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
format | string | tak | Nazwa formatu źródłowego do sparsowania, odpowiadająca jednej z ogłaszanych przez parser możliwości parse: |
bytes | string | tak | Bajty źródła do sparsowania. Każdy zestaw przenosi je we własnym typie pola — w postaci surowej, gdy ten typ jest typem bajtowym, lub zakodowane w base64, gdy jest to ciąg znaków, który parser dekoduje, aby je odzyskać — a wygenerowany koder dokonuje konwersji między polem a postacią, w jakiej bajty są przesyłane. Parser odczytuje odzyskane bajty jako wskazany format. |
options | any | nie | Nieprzejrzysty dokument opcji, który konsument dostarcza na potrzeby zachowania specyficznego dla parsera. Host przekazuje go dalej bez interpretowania; parser odczytuje go w kształcie, który sam dokumentuje. Nieobecny, gdy konsument nie dostarcza opcji. |
Dodatkowe właściwości są niedozwolone.
ParseOutput
Ładunek, który zwraca gość parsera: kanoniczne, ustrukturyzowane drzewo sparsowanego źródła wraz z diagnostyką zgłoszoną podczas parsowania oraz zakresami źródła wskazującymi położenie węzłów drzewa w oryginalnych bajtach.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
tree | any | tak | Kanoniczny, ustrukturyzowany widok sparsowanego źródła w postaci dokumentu JSON. „Dokument JSON” oznacza tu postać wartości wytwarzanej przez parser — co stanowi istotę parsowania — a nie kodowanie, w jakim wartość jest przesyłana: drzewo jest dokumentem JSON niezależnie od tego, jakim kanałem przenosi je to gniazdo. Najwyższy poziom może być obiektem, tablicą lub wartością skalarną, zgodnie z kształtem sparsowanego dokumentu (na przykład plik JSON może zostać sparsowany do dowolnej z tych postaci). Host przekazuje drzewo dalej bez wglądu w nie, przenosząc je dosłownie, bez interpretowania jego treści. |
diagnostics | Diagnostic[] | nie | Diagnostyka zgłoszona podczas parsowania — na przykład błąd składni lub ostrzeżenie. Nieobecna, gdy parsowanie nie dało żadnej. |
spans | NodeSpan[] | nie | Zakresy źródła wskazujące położenie węzłów drzewa w oryginalnych bajtach, dzięki czemu konsument może odwzorować ustalenie dotyczące węzła drzewa na lokalizację w źródle. Nieobecne, gdy parser nie zgłasza zakresów. |
error | string | nie | Komunikat o niepowodzeniu ustawiany, gdy gość został uruchomiony, ale nie mógł ukończyć operacji; nieobecny w razie powodzenia. Różni się od diagnostyki przenoszonej przez wynik: diagnostyka zgłasza problemy wykryte podczas przebiegu, który mimo to dał wynik, natomiast błąd zgłasza, że sama operacja nie została ukończona. Host traktuje obecny błąd jako nieudane wywołanie pluginu. |
Dodatkowe właściwości są niedozwolone.
NodeSpan
Zakres źródła dla jednego węzła drzewa: JSON Pointer zgodny z RFC 6901 wskazujący węzeł w drzewie, w parze z zakresem określającym jego położenie w oryginalnych bajtach.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
pointer | string | tak | JSON Pointer zgodny z RFC 6901 wskazujący w drzewie węzeł, którego położenie określa ten zakres. |
span | SourceSpan | tak | Zakres określający położenie wskazanego węzła w oryginalnych bajtach. |
Dodatkowe właściwości są niedozwolone.
SourceSpan
Zakres oryginalnych bajtów źródła: przesunięcia bajtowe są podstawową, dokładną lokalizacją, a numery wiersza i kolumny towarzyszą im na potrzeby diagnostyki czytelnej dla człowieka.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
start_offset | integer | tak | Przesunięcie bajtowe pierwszego bajtu zakresu w oryginalnym źródle, liczone od zera. |
end_offset | integer | tak | Przesunięcie bajtowe o jeden za ostatnim bajtem zakresu w oryginalnym źródle, tak że end_offset minus start_offset to długość zakresu w bajtach. |
start_line | integer | tak | Numer wiersza początku zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka. |
start_column | integer | tak | Numer kolumny początku zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka. |
end_line | integer | tak | Numer wiersza końca zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka. |
end_column | integer | tak | Numer kolumny końca zakresu, liczony od jedynki, na potrzeby diagnostyki czytelnej dla człowieka. |
Dodatkowe właściwości są niedozwolone.
ParseSourceResponse
Odpowiedź funkcji hosta parse-source: w razie powodzenia kanoniczne, ustrukturyzowane drzewo wytworzone przez wybrany parser, w razie niepowodzenia komunikat o błędzie. Wypełnione jest dokładnie jedno z dwóch pól. Niepowodzenie jest przekazywane w treści odpowiedzi, a nie przez pułapkę, dzięki czemu gość konsumenta przenosi brak parsera lub niepowodzenie parsowania do własnej diagnostyki jako deterministyczne niepowodzenie. Jest to koperta, którą otrzymuje gniazdo konsumenta, gdy prosi hosta o uruchomienie producenta za pośrednictwem hosta; ładunkiem żądania jest ParseInput.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
tree | any | nie | Kanoniczne, ustrukturyzowane drzewo wytworzone przez wybrany parser w razie powodzenia, jako dokument JSON przenoszony dosłownie; nieobecne w razie niepowodzenia. Podobnie jak w przypadku drzewa w wyniku parsowania, „dokument JSON” oznacza postać wartości, a nie kodowanie, w jakim jest przesyłana. |
error | string | nie | Komunikat o niepowodzeniu w razie niepowodzenia, podający format i przyczynę; nieobecny w razie powodzenia. |
hostfunc_error_code | string (enum) | nie | Identyfikator niepowodzenia przeznaczony do dopasowywania maszynowego, ustawiany w razie niepowodzenia obok komunikatu o błędzie dla człowieka i pochodzący z zamkniętego katalogu kodów błędów funkcji hosta; nieobecny w razie powodzenia. Ten katalog to stały słownik nazw sposobów, w jakie funkcja hosta może zakończyć się niepowodzeniem, i jest to słownik odrębny od warunków zatrzymania rejestrowanych przez kompilator, których identyfikatory gość zgłasza w wyniku gniazda jako condition_code i condition_short_code — nazwa klucza wskazuje, do którego z nich należy wartość, więc oba nigdy nie są odczytywane jako jeden zbiór. Gość rozgałęzia działanie na podstawie tego kodu bez parsowania komunikatu, tolerując brak kodu (starszy host) lub kod nierozpoznany (nowszy host) przez powrót do komunikatu. Dozwolone wartości: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Dodatkowe właściwości są niedozwolone.