Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Esquema del socket Wasm de analizador de Aggrega

Referencia generada. No la edites a mano — regenérala a partir del JSON Schema publicado.

ID del esquema: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json

Las formas de transmisión que consume (ParseInput) y emite (ParseOutput) un socket de plugin de analizador. Un analizador es un transformador sin estado y sin efectos secundarios que convierte una representación textual externa en un árbol JSON estructurado canónico, de modo que cualquier consumidor en cualquier lenguaje puede leer el árbol sin incluir su propio analizador del lenguaje. Un analizador declara los formatos que maneja como capacidades parse: en su descriptor; el host le entrega los bytes que debe analizar y el nombre del formato, y el analizador devuelve el árbol junto con diagnósticos e intervalos de la fuente opcionales. El analizador no atribuye al árbol ningún significado más allá de su sintaxis — el compilador transmite el árbol de forma opaca.

Una de las siguientes formas

  • ParseInput
  • ParseOutput

Definiciones

ParseInput

El payload que recibe un guest analizador: el nombre del formato que selecciona cómo leer los bytes, los bytes de la fuente que se deben analizar y un documento de opciones opaco opcional que el consumidor proporciona para un comportamiento específico del analizador.

PropiedadTipoObligatoriaDescripción
formatstringsíEl nombre del formato de origen que se debe analizar, que coincide con una de las capacidades parse: anunciadas por el analizador (por ejemplo hcl, toml, yaml o json). El analizador lee los bytes en este formato.
bytesstringsíLos bytes de la fuente que se deben analizar. Cada kit los lleva en su propio tipo de campo — en bruto donde ese tipo es un tipo de bytes, codificados en base64 donde es una cadena que el analizador decodifica para recuperarlos — y el codificador generado convierte entre el campo y la forma en que el formato de transmisión lleva los bytes. El analizador lee los bytes recuperados en el formato nombrado.
optionsanynoUn documento de opciones opaco que el consumidor proporciona para un comportamiento específico del analizador. El host lo hace pasar sin interpretarlo; el analizador lee la forma que documente. Ausente cuando el consumidor no proporciona opciones.

No se permiten propiedades adicionales.

ParseOutput

El payload que devuelve un guest analizador: el árbol estructurado canónico de la fuente analizada, más los diagnósticos que haya planteado el análisis y los intervalos de la fuente que vinculan los nodos del árbol con los bytes originales.

PropiedadTipoObligatoriaDescripción
treeanysíLa vista estructurada canónica de la fuente analizada, como documento JSON. Aquí «documento JSON» nombra la forma del valor que produce un analizador — que es la sustancia de aquello para lo que sirve el análisis — y no la codificación en la que viaja el valor: el árbol es un documento JSON sea cual sea el formato de transmisión en el que este socket lo lleve. El nivel superior puede ser un objeto, un array o un escalar, según la forma propia del documento analizado (un archivo JSON, por ejemplo, puede analizarse como cualquiera de ellos). El host hace pasar el árbol de forma opaca, llevándolo literalmente sin interpretar su contenido.
diagnosticsDiagnostic[]noDiagnósticos que planteó el análisis — por ejemplo, un error de sintaxis o un aviso. Ausente cuando el análisis no produjo ninguno.
spansNodeSpan[]noIntervalos de la fuente que vinculan los nodos del árbol con su posición en los bytes originales, de modo que un consumidor puede asociar un hallazgo sobre un nodo del árbol con una ubicación en la fuente. Ausente cuando el analizador no informa de ningún intervalo.
errorstringnoUn mensaje de error que se establece cuando el guest se ejecutó pero no pudo completar la operación; ausente en caso de éxito. Es distinto de cualquier diagnóstico que lleve la salida: los diagnósticos informan de problemas encontrados durante una ejecución que aun así produjo un resultado, mientras que error informa de que la propia operación no se completó. El host presenta un error presente como una invocación de plugin fallida.

No se permiten propiedades adicionales.

NodeSpan

Un intervalo de la fuente para un nodo del árbol: un JSON Pointer RFC 6901 que direcciona el nodo dentro del árbol, emparejado con el intervalo que lo localiza en los bytes originales.

PropiedadTipoObligatoriaDescripción
pointerstringsíUn JSON Pointer RFC 6901 dentro del árbol, que direcciona el nodo que localiza este intervalo.
spanSourceSpansíEl intervalo que localiza el nodo direccionado en los bytes originales.

No se permiten propiedades adicionales.

SourceSpan

Un intervalo de los bytes de la fuente original: los desplazamientos en bytes son la ubicación principal y exacta, y los números de línea y columna los acompañan para diagnósticos legibles por una persona.

PropiedadTipoObligatoriaDescripción
start_offsetintegersíEl desplazamiento en bytes del primer byte del intervalo en la fuente original, contado desde cero.
end_offsetintegersíEl desplazamiento en bytes situado uno después del último byte del intervalo en la fuente original, de modo que end_offset menos start_offset es la longitud del intervalo en bytes.
start_lineintegersíEl número de línea del inicio del intervalo, contado desde uno, para diagnósticos legibles por una persona.
start_columnintegersíEl número de columna del inicio del intervalo, contado desde uno, para diagnósticos legibles por una persona.
end_lineintegersíEl número de línea del final del intervalo, contado desde uno, para diagnósticos legibles por una persona.
end_columnintegersíEl número de columna del final del intervalo, contado desde uno, para diagnósticos legibles por una persona.

No se permiten propiedades adicionales.

ParseSourceResponse

La respuesta de la función host parse-source: en caso de éxito, el árbol estructurado canónico que produjo el analizador resuelto; en caso de fallo, un mensaje de error. Exactamente uno de los dos campos está rellenado. El fallo se entrega dentro de banda en lugar de mediante un trap, de modo que un guest consumidor lleva la ausencia de analizador o un fallo de análisis a sus propios diagnósticos como un fallo determinista. Este es el sobre que recibe un socket consumidor cuando pide al host que ejecute un productor a través del host; el payload de la solicitud es un ParseInput.

PropiedadTipoObligatoriaDescripción
treeanynoEl árbol estructurado canónico que produjo el analizador resuelto en caso de éxito, como documento JSON llevado literalmente; ausente en caso de fallo. Como en el árbol propio de la salida del análisis, «documento JSON» nombra la forma del valor y no la codificación en la que viaja.
errorstringnoEl mensaje de fallo en caso de fallo, que nombra el formato y el motivo; ausente en caso de éxito.
hostfunc_error_codestring (enum)noLa identidad del fallo identificable por máquina en caso de fallo, tomada del catálogo cerrado de códigos de error de las funciones host, establecida junto al mensaje de error legible por personas; ausente en caso de éxito. Ese catálogo es un vocabulario fijo que nombra las formas en que puede fallar una función host, y es un vocabulario distinto de las condiciones de detención que registra el compilador, cuyos identificadores informa un guest en una salida de socket como condition_code y condition_short_code — el nombre de la clave dice a cuál de los dos pertenece un valor, de modo que los dos nunca se leen como un único conjunto. Un guest se ramifica según este código sin analizar el mensaje, tolerando un código ausente (host más antiguo) o uno no reconocido (host más reciente) mediante el recurso al mensaje. Valores permitidos: "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"

No se permiten propiedades adicionales.