Aggrega Wasm ayrıştırıcı soketi şeması
Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.
Şema kimliği: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json
Bir ayrıştırıcı eklenti soketinin tükettiği (ParseInput) ve yaydığı (ParseOutput) aktarım biçimleri. Ayrıştırıcı, yabancı bir metin gösterimini kanonik, yapılandırılmış bir JSON ağacına dönüştüren durumsuz ve yan etkisiz bir dönüştürücüdür; böylece herhangi bir dildeki herhangi bir tüketici, kendi dil ayrıştırıcısını taşımadan ağacı okuyabilir. Ayrıştırıcı, işlediği biçimleri tanımlayıcısında parse:
Aşağıdaki biçimlerden biri
ParseInputParseOutput
Tanımlar
ParseInput
Bir ayrıştırıcı konuğun aldığı yük: baytların nasıl okunacağını seçen biçim adı, ayrıştırılacak kaynak baytları ve tüketicinin ayrıştırıcıya özgü davranış için sağladığı isteğe bağlı, opak bir seçenekler belgesi.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
format | string | evet | Ayrıştırılacak kaynak biçiminin adı; ayrıştırıcının duyurduğu parse: |
bytes | string | evet | Ayrıştırılacak kaynak baytları. Her kit bunları kendi alan türünde taşır: bu tür bir bayt türüyse ham olarak, ayrıştırıcının baytları geri elde etmek için çözdüğü bir string ise base64 ile kodlanmış olarak. Üretilen kodlayıcı, alan ile aktarımın baytları taşıdığı biçim arasında dönüştürme yapar. Ayrıştırıcı, geri elde edilen baytları adı verilen biçimde okur. |
options | herhangi | hayır | Tüketicinin ayrıştırıcıya özgü davranış için sağladığı opak bir seçenekler belgesi. Ana makine onu yorumlamadan iletir; ayrıştırıcı, belgelediği biçim neyse onu okur. Tüketici seçenek sağlamadığında bulunmaz. |
Ek özelliklere izin verilmez.
ParseOutput
Bir ayrıştırıcı konuğun döndürdüğü yük: ayrıştırılan kaynağın kanonik, yapılandırılmış ağacı, ayrıca ayrıştırmanın ürettiği tanılamalar ve ağaç düğümlerini özgün baytlardaki yerlerine bağlayan kaynak aralıkları.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
tree | herhangi | evet | Ayrıştırılan kaynağın JSON belgesi olarak kanonik, yapılandırılmış görünümü. Burada “JSON belgesi”, değerin taşındığı kodlamayı değil, bir ayrıştırıcının ürettiği değerin biçimini adlandırır; bu da ayrıştırmanın asıl amacıdır: bu soket ağacı hangi aktarım üzerinden taşırsa taşısın, ağaç bir JSON belgesidir. Üst düzey, ayrıştırılan belgenin kendi biçimine uygun olarak bir nesne, bir dizi veya bir skaler olabilir (örneğin bir JSON dosyası bunlardan herhangi birine ayrıştırılabilir). Ana makine ağacı opak olarak iletir; içeriğini yorumlamadan olduğu gibi taşır. |
diagnostics | Diagnostic[] | hayır | Ayrıştırmanın ürettiği tanılamalar; örneğin bir sözdizimi hatası veya bir uyarı. Ayrıştırma hiç tanılama üretmediğinde bulunmaz. |
spans | NodeSpan[] | hayır | Ağaç düğümlerini özgün baytlardaki konumlarına bağlayan kaynak aralıkları; böylece bir tüketici, bir ağaç düğümündeki bulguyu bir kaynak konumuna eşleyebilir. Ayrıştırıcı hiç aralık bildirmediğinde bulunmaz. |
error | string | hayır | Konuk çalıştığı hâlde işlemi tamamlayamadığında ayarlanan bir hata mesajı; başarı durumunda bulunmaz. Çıktının taşıdığı tanılamalardan farklıdır: tanılamalar yine de bir sonuç üreten bir çalıştırma sırasında bulunan sorunları bildirirken error, işlemin kendisinin tamamlanmadığını bildirir. Ana makine, mevcut bir error’u başarısız bir eklenti çağrısı olarak yansıtır. |
Ek özelliklere izin verilmez.
NodeSpan
Bir ağaç düğümü için kaynak aralığı: düğümü ağaç içinde adresleyen bir RFC 6901 JSON Pointer ile onu özgün baytlarda konumlandıran aralığın eşleşmesi.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
pointer | string | evet | Ağaç içine bir RFC 6901 JSON Pointer; bu aralığın konumlandırdığı düğümü adresler. |
span | SourceSpan | evet | Adreslenen düğümü özgün baytlarda konumlandıran aralık. |
Ek özelliklere izin verilmez.
SourceSpan
Özgün kaynak baytlarının bir aralığı: bayt uzaklıkları birincil ve kesin konumdur; satır ve sütun numaraları insan tarafından okunabilir tanılamalar için bunlara eşlik eder.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
start_offset | integer | evet | Aralığın ilk baytının özgün kaynaktaki sıfır tabanlı bayt uzaklığı. |
end_offset | integer | evet | Aralığın son baytının bir sonrasının özgün kaynaktaki bayt uzaklığı; böylece end_offset eksi start_offset, aralığın bayt cinsinden uzunluğudur. |
start_line | integer | evet | Aralığın başlangıcının bir tabanlı satır numarası; insan tarafından okunabilir tanılamalar içindir. |
start_column | integer | evet | Aralığın başlangıcının bir tabanlı sütun numarası; insan tarafından okunabilir tanılamalar içindir. |
end_line | integer | evet | Aralığın sonunun bir tabanlı satır numarası; insan tarafından okunabilir tanılamalar içindir. |
end_column | integer | evet | Aralığın sonunun bir tabanlı sütun numarası; insan tarafından okunabilir tanılamalar içindir. |
Ek özelliklere izin verilmez.
ParseSourceResponse
parse-source ana makine işlevinin yanıtı: başarı durumunda çözümlenen ayrıştırıcının ürettiği kanonik, yapılandırılmış ağaç, başarısızlık durumunda bir hata mesajı. İki alandan tam olarak biri doldurulur. Başarısızlık tuzaklama (trap) yerine bant içinde iletilir; böylece tüketici bir konuk, ayrıştırıcı bulunmamasını veya bir ayrıştırma başarısızlığını deterministik bir başarısızlık olarak kendi tanılamalarına taşır. Bu, bir tüketici soketin ana makineden bir üreticiyi ana makine üzerinden çalıştırmasını istediğinde aldığı zarftır; istek yükü bir ParseInput’tur.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
tree | herhangi | hayır | Çözümlenen ayrıştırıcının başarı durumunda ürettiği, olduğu gibi taşınan bir JSON belgesi olarak kanonik, yapılandırılmış ağaç; başarısızlık durumunda bulunmaz. Ayrıştırma çıktısının kendi ağacında olduğu gibi, “JSON belgesi” değerin taşındığı kodlamayı değil, değerin biçimini adlandırır. |
error | string | hayır | Başarısızlık durumunda biçimi ve nedeni belirten hata mesajı; başarı durumunda bulunmaz. |
hostfunc_error_code | string (enum) | hayır | Başarısızlık durumunda, kapalı ana makine işlevi hata kodu kataloğundan alınan ve insan tarafından okunan hata mesajının yanında ayarlanan, makinece eşleştirilebilir başarısızlık kimliği; başarı durumunda bulunmaz. Bu katalog, bir ana makine işlevinin başarısız olabileceği yolları adlandıran sabit bir sözcük dağarcığıdır ve derleyicinin kaydettiği durdurma koşullarından farklı bir dağarcıktır; bu koşulların tanımlayıcılarını bir konuk, soket çıktısında condition_code ve condition_short_code olarak bildirir. Anahtar adı, bir değerin bu ikisinden hangisine ait olduğunu söyler; böylece ikisi asla tek bir küme olarak okunmaz. Bir konuk, mesajı ayrıştırmadan bu koda göre dallanır; bulunmayan bir kodu (eski ana makine) veya tanınmayan bir kodu (yeni ana makine) mesaja geri dönerek tolere eder. İzin verilen değerler: "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" |
Ek özelliklere izin verilmez.