Bỏ qua để đến nội dung
AggregaAggrega
Chọn ngôn ngữ: Tiếng Việt
Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

Schema Parser Socket của Aggrega Wasm

Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.

Id của schema: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json

Các dạng dữ liệu truyền mà một socket plugin parser tiêu thụ (ParseInput) và phát ra (ParseOutput). Một parser là một bộ biến đổi không trạng thái, không có tác dụng phụ, chuyển một biểu diễn văn bản ngoại lai thành một cây JSON có cấu trúc chuẩn tắc, để bất kỳ bên tiêu thụ nào bằng bất kỳ ngôn ngữ nào cũng có thể đọc cây mà không cần mang theo parser riêng cho ngôn ngữ đó. Một parser khai báo các định dạng nó xử lý dưới dạng các capability parse: trong descriptor của nó; host trao cho nó các byte cần phân tích cùng tên định dạng, và nó trả về cây cùng với các chẩn đoán và khoảng nguồn tùy chọn. Parser không gán ý nghĩa nào cho cây ngoài cú pháp của nó — trình biên dịch chuyển cây qua một cách không diễn giải.

Một trong các dạng sau

  • ParseInput
  • ParseOutput

Định nghĩa

ParseInput

Payload mà một guest parser nhận: tên định dạng chọn cách đọc các byte, các byte nguồn cần phân tích, và một tài liệu tùy chọn không diễn giải mà bên tiêu thụ cung cấp cho hành vi riêng của parser.

Thuộc tínhLoạiBắt buộcMô tả
formatstringcóTên của định dạng nguồn cần phân tích, khớp với một trong các capability parse: mà parser công bố (ví dụ hcl, toml, yaml hoặc json). Parser đọc các byte theo định dạng này.
bytesstringcóCác byte nguồn cần phân tích. Mỗi kit mang chúng trong kiểu trường riêng của nó — dạng thô khi kiểu đó là kiểu byte, mã hóa base64 khi đó là một chuỗi mà parser giải mã để khôi phục chúng — và bộ mã hóa được sinh ra chuyển đổi giữa trường và dạng mà dữ liệu truyền dùng để mang byte. Parser đọc các byte đã khôi phục theo định dạng được nêu tên.
optionsanykhôngMột tài liệu tùy chọn không diễn giải mà bên tiêu thụ cung cấp cho hành vi riêng của parser. Host chuyển nó qua mà không diễn giải; parser đọc bất kỳ dạng nào mà nó mô tả trong tài liệu. Vắng mặt khi bên tiêu thụ không cung cấp tùy chọn nào.

Không cho phép thuộc tính bổ sung.

ParseOutput

Payload mà một guest parser trả về: cây có cấu trúc chuẩn tắc của nguồn đã phân tích, cùng với mọi chẩn đoán mà quá trình phân tích phát sinh và mọi khoảng nguồn định vị các nút của cây về các byte gốc.

Thuộc tínhLoạiBắt buộcMô tả
treeanycóGóc nhìn có cấu trúc chuẩn tắc của nguồn đã phân tích, dưới dạng một tài liệu JSON. Ở đây “tài liệu JSON” chỉ dạng của giá trị mà parser tạo ra — vốn là bản chất mục đích của việc phân tích — chứ không phải mã hóa mà giá trị được truyền đi: cây là một tài liệu JSON bất kể socket này mang nó trên kênh truyền nào. Cấp cao nhất có thể là một object, một array hoặc một giá trị vô hướng, khớp với dạng của chính tài liệu đã phân tích (ví dụ một tệp JSON có thể được phân tích thành bất kỳ dạng nào trong số này). Host chuyển cây qua một cách không diễn giải, mang nó nguyên văn mà không diễn giải nội dung.
diagnosticsDiagnostic[]khôngCác chẩn đoán mà quá trình phân tích phát sinh — ví dụ một lỗi cú pháp hoặc một cảnh báo. Vắng mặt khi quá trình phân tích không tạo ra chẩn đoán nào.
spansNodeSpan[]khôngCác khoảng nguồn định vị các nút của cây về vị trí của chúng trong các byte gốc, để bên tiêu thụ có thể ánh xạ một phát hiện trên một nút cây tới một vị trí trong nguồn. Vắng mặt khi parser không báo cáo khoảng nào.
errorstringkhôngMột thông điệp lỗi được đặt khi guest đã chạy nhưng không thể hoàn tất thao tác; vắng mặt khi thành công. Nó khác với mọi chẩn đoán mà đầu ra mang theo: chẩn đoán báo cáo các vấn đề phát hiện trong một lần chạy vẫn tạo ra kết quả, còn error báo cáo rằng bản thân thao tác đã không hoàn tất. Host hiển thị một error có mặt như một lần gọi plugin thất bại.

Không cho phép thuộc tính bổ sung.

NodeSpan

Một khoảng nguồn cho một nút cây: một JSON Pointer theo RFC 6901 trỏ tới nút trong cây, đi cùng khoảng định vị nút đó trong các byte gốc.

Thuộc tínhLoạiBắt buộcMô tả
pointerstringcóMột JSON Pointer theo RFC 6901 vào cây, trỏ tới nút mà khoảng này định vị.
spanSourceSpancóKhoảng định vị nút được trỏ tới trong các byte gốc.

Không cho phép thuộc tính bổ sung.

SourceSpan

Một khoảng của các byte nguồn gốc: các offset byte là vị trí chính, chính xác, còn số dòng và số cột đi kèm để chẩn đoán dễ đọc với con người.

Thuộc tínhLoạiBắt buộcMô tả
start_offsetintegercóOffset byte của byte đầu tiên của khoảng trong nguồn gốc, đánh số từ 0.
end_offsetintegercóOffset byte ngay sau byte cuối cùng của khoảng trong nguồn gốc, nên end_offset trừ start_offset là độ dài của khoảng tính bằng byte.
start_lineintegercóSố dòng nơi khoảng bắt đầu, đánh số từ 1, để chẩn đoán dễ đọc với con người.
start_columnintegercóSố cột nơi khoảng bắt đầu, đánh số từ 1, để chẩn đoán dễ đọc với con người.
end_lineintegercóSố dòng nơi khoảng kết thúc, đánh số từ 1, để chẩn đoán dễ đọc với con người.
end_columnintegercóSố cột nơi khoảng kết thúc, đánh số từ 1, để chẩn đoán dễ đọc với con người.

Không cho phép thuộc tính bổ sung.

ParseSourceResponse

Phản hồi của host function parse-source: khi thành công là cây có cấu trúc chuẩn tắc mà parser được phân giải đã tạo ra, khi thất bại là một thông điệp lỗi. Đúng một trong hai trường được điền. Thất bại được trả về trong luồng thay vì bằng trap, để guest tiêu thụ đưa một lỗi không có parser hoặc lỗi phân tích vào chẩn đoán của chính nó như một thất bại tất định. Đây là phong bì mà một socket tiêu thụ nhận được khi nó yêu cầu host chạy một producer thông qua host; payload của yêu cầu là một ParseInput.

Thuộc tínhLoạiBắt buộcMô tả
treeanykhôngCây có cấu trúc chuẩn tắc mà parser được phân giải tạo ra khi thành công, dưới dạng một tài liệu JSON được mang nguyên văn; vắng mặt khi thất bại. Giống như với cây của chính đầu ra phân tích, “tài liệu JSON” chỉ dạng của giá trị chứ không phải mã hóa mà nó được truyền đi.
errorstringkhôngThông điệp lỗi khi thất bại, nêu tên định dạng và lý do; vắng mặt khi thành công.
hostfunc_error_codestring (enum)khôngDanh tính lỗi mà máy có thể so khớp khi thất bại, lấy từ danh mục mã lỗi đóng của host function, được đặt bên cạnh thông điệp lỗi cho con người; vắng mặt khi thành công. Danh mục đó là một bộ từ vựng cố định nêu tên các cách một host function có thể thất bại, và nó là một bộ từ vựng khác với các điều kiện dừng mà trình biên dịch đăng ký, vốn có các định danh mà guest báo cáo trên đầu ra socket dưới dạng condition_code và condition_short_code — tên khóa cho biết một giá trị thuộc về bộ nào trong hai bộ, nên hai bộ không bao giờ bị đọc như một tập. Guest rẽ nhánh dựa trên mã này mà không cần phân tích thông điệp, chấp nhận một mã vắng mặt (host cũ hơn) hoặc một mã không nhận ra (host mới hơn) bằng cách quay về dùng thông điệp. Các giá trị cho phép: "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"

Không cho phép thuộc tính bổ sung.