Aggrega Wasm パーサーソケットのスキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json
パーサープラグインのソケットが受け取る (ParseInput) および出力する (ParseOutput) ワイヤ形式です。パーサーはステートレスで副作用のない変換器であり、外部のテキスト表現を正規の構造化 JSON ツリーに変換します。これにより、どの言語のコンシューマーも独自の言語パーサーを持たずにツリーを読み取れます。パーサーは扱うフォーマットを記述子の中で parse:
次のいずれかの形
ParseInputParseOutput
定義
ParseInput
パーサーゲストが受け取るペイロードです。バイト列の読み方を選択するフォーマット名、パースするソースバイト列、およびパーサー固有の動作のためにコンシューマーが指定する任意の不透明なオプションドキュメントで構成されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
format | string | はい | パースするソースフォーマットの名前で、パーサーが公開している parse: |
bytes | string | はい | パースするソースバイト列です。各キットはこれを独自のフィールド型で保持します。その型がバイト型であれば生のまま、文字列であれば base64 エンコードされた形で保持し、パーサーがデコードして復元します。生成されたエンコーダーが、フィールドとワイヤ上でバイト列を運ぶ形式との間で変換を行います。パーサーは復元したバイト列を指定されたフォーマットとして読み取ります。 |
options | any | いいえ | パーサー固有の動作のためにコンシューマーが指定する不透明なオプションドキュメントです。ホストはこれを解釈せずにそのまま受け渡し、パーサーは自身が文書化している形式で読み取ります。コンシューマーがオプションを指定しない場合は存在しません。 |
追加のプロパティは許可されません。
ParseOutput
パーサーゲストが返すペイロードです。パースされたソースの正規の構造化ツリーに加え、パース中に発生した診断と、ツリーノードを元のバイト列上の位置に対応付けるソーススパンを含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
tree | any | はい | パースされたソースの正規の構造化ビューで、JSON ドキュメントとして表されます。ここでの「JSON ドキュメント」はパーサーが生成する値の形式 (これがパースの目的の本質です) を指し、値が運ばれるエンコーディングを指すものではありません。このソケットがどのワイヤでツリーを運んでも、ツリーは JSON ドキュメントです。最上位はオブジェクト、配列、スカラーのいずれでもよく、パースされたドキュメント自体の形に一致します (たとえば JSON ファイルはこれらのいずれにもパースされ得ます)。ホストはツリーを不透明なまま受け渡し、内容を解釈せずにそのまま運びます。 |
diagnostics | Diagnostic[] | いいえ | パース中に発生した診断です (例: 構文エラーや警告)。パースで診断が生じなかった場合は存在しません。 |
spans | NodeSpan[] | いいえ | ツリーノードを元のバイト列上の位置に対応付けるソーススパンです。これにより、コンシューマーはツリーノードに対する検出結果をソース上の位置に対応付けられます。パーサーがスパンを報告しない場合は存在しません。 |
error | string | いいえ | ゲストは実行されたものの操作を完了できなかった場合に設定される失敗メッセージです。成功時には存在しません。出力に含まれる診断とは別のものです。診断は結果を生成した実行中に見つかった問題を報告し、error は操作自体が完了しなかったことを報告します。ホストは error が存在する場合、プラグイン呼び出しの失敗として扱います。 |
追加のプロパティは許可されません。
NodeSpan
1 つのツリーノードのソーススパンです。ツリー内のノードを指す RFC 6901 JSON Pointer と、元のバイト列上でそのノードの位置を示すスパンの組です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
pointer | string | はい | ツリーへの RFC 6901 JSON Pointer で、このスパンが位置を示すノードを指します。 |
span | SourceSpan | はい | 指されたノードの元のバイト列上の位置を示すスパンです。 |
追加のプロパティは許可されません。
SourceSpan
元のソースバイトのスパンです。バイトオフセットが主要かつ正確な位置であり、行番号と列番号は人間が読める診断のためにそれに付随します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
start_offset | integer | はい | 元のソースにおけるスパンの最初のバイトのバイトオフセットで、0 始まりです。 |
end_offset | integer | はい | 元のソースにおけるスパンの最後のバイトの 1 つ後のバイトオフセットです。したがって、end_offset から start_offset を引いた値がスパンのバイト長になります。 |
start_line | integer | はい | スパンの開始位置の行番号で、1 始まりです。人間が読める診断に使われます。 |
start_column | integer | はい | スパンの開始位置の列番号で、1 始まりです。人間が読める診断に使われます。 |
end_line | integer | はい | スパンの終了位置の行番号で、1 始まりです。人間が読める診断に使われます。 |
end_column | integer | はい | スパンの終了位置の列番号で、1 始まりです。人間が読める診断に使われます。 |
追加のプロパティは許可されません。
ParseSourceResponse
parse-source ホスト関数の応答です。成功時には解決されたパーサーが生成した正規の構造化ツリー、失敗時にはエラーメッセージを含みます。2 つのフィールドのうち厳密に 1 つだけが設定されます。失敗はトラップではなくインバンドで伝えられるため、コンシューマーゲストはパーサー不在やパース失敗を決定的な失敗として自身の診断に取り込めます。これは、コンシューマーソケットがホストを介してプロデューサーを実行するようホストに依頼したときに受け取るエンベロープです。リクエストのペイロードは ParseInput です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
tree | any | いいえ | 成功時に解決されたパーサーが生成した正規の構造化ツリーで、JSON ドキュメントとしてそのまま運ばれます。失敗時には存在しません。パース出力自体のツリーと同様に、「JSON ドキュメント」は値が運ばれるエンコーディングではなく値の形式を指します。 |
error | string | いいえ | 失敗時の失敗メッセージで、フォーマットと理由を示します。成功時には存在しません。 |
hostfunc_error_code | string (enum) | いいえ | 失敗時の機械照合可能な失敗識別子で、閉じたホスト関数エラーコードカタログから取られ、人間向けのエラーメッセージと並べて設定されます。成功時には存在しません。このカタログはホスト関数が失敗し得る方法を名付けた固定の語彙であり、コンパイラが登録する停止条件とは別の語彙です。停止条件の識別子は、ゲストがソケット出力で condition_code および condition_short_code として報告します。キー名によって値がどちらに属するかがわかるため、2 つが 1 つの集合として読まれることはありません。ゲストはメッセージをパースせずにこのコードで分岐し、コードが存在しない場合 (古いホスト) や認識できない場合 (新しいホスト) はメッセージにフォールバックして対処します。許可される値: "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" |
追加のプロパティは許可されません。