Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Skema Aggrega Wasm Parser Socket

Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.

Id skema: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json

Bentuk wire yang dikonsumsi (ParseInput) dan dikeluarkan (ParseOutput) oleh socket plugin parser. Parser adalah transformer tanpa status dan tanpa efek samping yang mengubah representasi teks asing menjadi pohon JSON terstruktur kanonis, sehingga konsumen apa pun dalam bahasa apa pun dapat membaca pohon tersebut tanpa membawa parser bahasanya sendiri. Parser mendeklarasikan format yang ditanganinya sebagai kapabilitas parse: dalam deskriptornya; host menyerahkan byte yang akan di-parse beserta nama formatnya, dan parser mengembalikan pohon beserta diagnostik dan rentang sumber opsional. Parser tidak memberikan makna apa pun pada pohon di luar sintaksisnya — compiler meneruskan pohon tersebut secara buram.

Salah satu dari bentuk berikut

  • ParseInput
  • ParseOutput

Definisi

ParseInput

Payload yang diterima guest parser: nama format yang menentukan cara membaca byte, byte sumber yang akan di-parse, dan dokumen opsi buram opsional yang disediakan konsumen untuk perilaku khusus parser.

PropertiJenisWajibDeskripsi
formatstringyaNama format sumber yang akan di-parse, yang cocok dengan salah satu kapabilitas parse: yang diiklankan parser (misalnya hcl, toml, yaml, atau json). Parser membaca byte sebagai format ini.
bytesstringyaByte sumber yang akan di-parse. Setiap kit membawanya dalam jenis field-nya sendiri — mentah jika jenis tersebut adalah jenis byte, dienkode base64 jika berupa string yang didekode parser untuk memulihkannya — dan encoder yang dihasilkan mengonversi antara field tersebut dan bentuk yang digunakan wire untuk membawa byte. Parser membaca byte yang dipulihkan sebagai format yang disebutkan.
optionsanytidakDokumen opsi buram yang disediakan konsumen untuk perilaku khusus parser. Host meneruskannya tanpa menafsirkannya; parser membaca bentuk apa pun yang didokumentasikannya. Tidak ada jika konsumen tidak menyediakan opsi.

Properti tambahan tidak diizinkan.

ParseOutput

Payload yang dikembalikan guest parser: pohon terstruktur kanonis dari sumber yang di-parse, beserta diagnostik apa pun yang muncul saat parsing dan rentang sumber apa pun yang menunjukkan lokasi node pohon di byte asli.

PropertiJenisWajibDeskripsi
treeanyyaTampilan terstruktur kanonis dari sumber yang di-parse, sebagai dokumen JSON. Di sini “dokumen JSON” menyebut bentuk nilai yang dihasilkan parser — yang merupakan inti tujuan parsing — dan bukan encoding yang digunakan untuk mengirim nilai tersebut: pohon adalah dokumen JSON apa pun wire yang digunakan socket ini untuk membawanya. Tingkat teratas dapat berupa objek, array, atau skalar, sesuai dengan bentuk dokumen yang di-parse itu sendiri (file JSON, misalnya, dapat di-parse menjadi salah satu dari bentuk tersebut). Host meneruskan pohon secara buram, membawanya apa adanya tanpa menafsirkan isinya.
diagnosticsDiagnostic[]tidakDiagnostik yang muncul saat parsing — misalnya kesalahan sintaksis atau peringatan. Tidak ada jika parsing tidak menghasilkan diagnostik.
spansNodeSpan[]tidakRentang sumber yang menunjukkan posisi node pohon di byte asli, sehingga konsumen dapat memetakan temuan pada node pohon ke lokasi sumber. Tidak ada jika parser tidak melaporkan rentang.
errorstringtidakPesan kegagalan yang diisi ketika guest berjalan tetapi tidak dapat menyelesaikan operasi; tidak ada jika berhasil. Ini berbeda dari diagnostik apa pun yang dibawa output: diagnostik melaporkan masalah yang ditemukan selama run yang tetap menghasilkan hasil, sedangkan error melaporkan bahwa operasi itu sendiri tidak selesai. Host menampilkan error yang ada sebagai pemanggilan plugin yang gagal.

Properti tambahan tidak diizinkan.

NodeSpan

Rentang sumber untuk satu node pohon: JSON Pointer RFC 6901 yang mengalamatkan node di dalam pohon, dipasangkan dengan rentang yang menunjukkan lokasinya di byte asli.

PropertiJenisWajibDeskripsi
pointerstringyaJSON Pointer RFC 6901 ke dalam pohon, yang mengalamatkan node yang lokasinya ditunjukkan oleh rentang ini.
spanSourceSpanyaRentang yang menunjukkan lokasi node yang dialamatkan di byte asli.

Properti tambahan tidak diizinkan.

SourceSpan

Rentang byte sumber asli: offset byte adalah lokasi utama yang tepat, dan nomor baris serta kolom menyertainya untuk diagnostik yang dapat dibaca manusia.

PropertiJenisWajibDeskripsi
start_offsetintegeryaOffset byte dari byte pertama rentang dalam sumber asli, berbasis nol.
end_offsetintegeryaOffset byte satu setelah byte terakhir rentang dalam sumber asli, sehingga end_offset dikurangi start_offset adalah panjang rentang dalam byte.
start_lineintegeryaNomor baris awal rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia.
start_columnintegeryaNomor kolom awal rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia.
end_lineintegeryaNomor baris akhir rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia.
end_columnintegeryaNomor kolom akhir rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia.

Properti tambahan tidak diizinkan.

ParseSourceResponse

Balasan fungsi host parse-source: jika berhasil, pohon terstruktur kanonis yang dihasilkan parser yang di-resolve; jika gagal, pesan kesalahan. Tepat satu dari kedua field tersebut diisi. Kegagalan disampaikan secara in-band, bukan dengan trap, sehingga guest konsumen membawa ketiadaan parser atau kegagalan parsing ke dalam diagnostiknya sendiri sebagai kegagalan deterministik. Ini adalah amplop yang diterima socket konsumen saat meminta host menjalankan produser melalui host; payload permintaannya adalah ParseInput.

PropertiJenisWajibDeskripsi
treeanytidakPohon terstruktur kanonis yang dihasilkan parser yang di-resolve jika berhasil, sebagai dokumen JSON yang dibawa apa adanya; tidak ada jika gagal. Sama seperti pada pohon output parse itu sendiri, “dokumen JSON” menyebut bentuk nilai, bukan encoding yang digunakan untuk mengirimnya.
errorstringtidakPesan kegagalan jika gagal, yang menyebutkan format dan alasannya; tidak ada jika berhasil.
hostfunc_error_codestring (enum)tidakIdentitas kegagalan yang dapat dicocokkan mesin jika gagal, diambil dari katalog kode kesalahan fungsi host yang tertutup, ditetapkan di samping pesan kesalahan untuk manusia; tidak ada jika berhasil. Katalog tersebut adalah kosakata tetap yang menyebutkan cara-cara fungsi host dapat gagal, dan merupakan kosakata yang berbeda dari kondisi penghentian yang didaftarkan compiler, yang pengidentifikasinya dilaporkan guest pada output socket sebagai condition_code dan condition_short_code — nama kunci menunjukkan kosakata mana dari keduanya yang memiliki suatu nilai, sehingga keduanya tidak pernah dibaca sebagai satu himpunan. Guest bercabang berdasarkan kode ini tanpa mem-parse pesan, dengan menoleransi kode yang tidak ada (host lama) atau kode yang tidak dikenali (host baru) dengan kembali ke pesan. Nilai yang diizinkan: "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"

Properti tambahan tidak diizinkan.