Recursos do Editor de Esquema

O Editor de Esquemas fornece funcionalidade para incorporar informações de metadados semânticos no Esquema OpenAPI/JSON da API. Duas funções-chave são a possibilidade de configurar o endpoint SPARQL, que é útil para consultar recursos do tipo RDF, e a ativação da conclusão automática para termos e classes.

Configurar o endpoint SPARQL

O Editor de Esquemas consulta recursos externos usando SPARQL, uma linguagem projetada para consultar conjuntos de dados RDF.
Por padrão, o editor usa o endpoint SPARQL do Catálogo. No entanto, pode alterá-lo para ligar a um servidor SPARQL diferente, útil, por exemplo, ao trabalhar com conjuntos de dados personalizados ou infraestruturas RDF distribuídas. Para fazer isso, clique no ícone de hambúrguer (≡) localizado no canto superior esquerdo da interface.

Para alterar o endpoint do SPARQL:

  • Clique no ícone do hambúrguer (≡) no canto superior esquerdo da interface.
  • Selecione o item Configuração no menu lateral.
  • Introduza o URL do novo endpoint SPARQL no campo dedicado.

Uma vez que a configuração é salva, o editor usará o novo endpoint para todas as consultas.

Imagem descritiva que finaliza a configuração do ponto final do SparQL.

Utilizar o preenchimento automático

O editor de esquemas é capaz de sugerir automaticamente termos e classes ao digitar, com base em um conjunto selecionado de vocabulários disponíveis no catálogo schema.gov.it. Para utilizar a auto-realização:

  • Pressionar a combinação CTRL + ESPAÇO Abrir-se-á a menu pendente com uma lista de sugestões compatíveis;
  • Ao digitar o texto, a lista será filtrada dinamicamente;
  • Prensagem ENVIAR por sugestão, o editor completará automaticamente o campo com oURI correcto para a classe ou propriedade seleccionada.

Esta funcionalidade simplifica muito a inserção de referências corretas e reduz o risco de erros de sintaxe ou URI inválidos.

Imagem descritiva da operação de auto-conclusão.

A seção Modelos de Dados do Editor de Esquemas fornece uma visão estruturada de todas as classes RDF definidas no esquema. Destina-se a facilitar a análise das propriedades associadas a cada classe e suas ligações semânticas.

Principais funcionalidades

  1. Exibição automática de classes RDF O editor recupera automaticamente todas as classes RDF no esquema. Para cada classe, são enumerados os seguintes elementos:
    As propriedades associadas;
    Ligações semânticas resultantes de mapeamentos com classes de referência.
  2. Detalhes para cada propriedade Cada propriedade exibida é enriquecida com informações úteis para a compreensão do modelo:
    Tipo sintático (por exemplo, cadeia de caracteres, número, objeto);
    Tipo semântico (URI RDF associado);
    Descrição textual;
    Exemplo de utilização, gerado de acordo com as definições do esquema.
  3. O Editor de Esquemas calcula um indicador chamado OntoScore, que mede o nível de mapeamento semântico do esquema. É definida como a razão entre o número total de propriedades presentes no esquema JSON e o número de propriedades mapeadas corretamente com um rdf:Property. Este escore ajuda a avaliar o quanto o esquema está semanticamente alinhado com os vocabulários RDF.
  4. Quando uma classe está ligada a um vocabulário controlado, o botão "Mostrar valores" aparece. Ao clicar nele, vai directamente para a secção correspondente em schema.gov.it, onde estão listados todos os valores permitidos para essa propriedade.

 

Imagem descritiva da secção Modelos de Dados com as suas características.

 

Navegação de ferramentas de análise

Esta secção do Editor de Esquemas recolhe um conjunto de ferramentas concebidas para análise semântica, visualização RDF e validação de compatibilidade JSON-LD. Através de diferentes painéis interativos, é possível explorar a estrutura do esquema, compreender seu significado semântico e verificar seu comportamento em contextos reais de RDF.

Usar JSON-LD Playground

O Editor de Esquemas permite-lhe gerar automaticamente um exemplo e abri-lo na ferramenta externa JSON-LD Playground. Esta função permite-lhe:

  • Exibir a entrada JSON produzida pelo esquema;
  • Examinar o contexto JSON-LD e o seu @type;
  • Obtenha uma serialização RDF nos formatos Turtle, RDF/XML e N-Quads.

Esta ferramenta é útil para testar a correção da representação semântica dos dados.

Imagem descritiva da análise semântica com JSON-LD Playground.

 

Utilizar trigémeos RDF

A secção RDF mostra as informações do esquema em trigémeos RDF (na forma sujeito – predicado – objeto), proporcionando uma representação clara da estrutura semântica. Esta vista permite-lhe:

  • Explorar visualmente as relações semânticas entre entidades e propriedades;
  • Verificar a coerência do modelo com o gráfico RDF;
  • Compreender como as instâncias de esquema serão interpretadas em sistemas semânticos

Imagem descritiva de trigémeos RDF.

Usar o contexto JSON-LD

O conteúdo da seção Contexto JSON-LD é gerado automaticamente a partir dos metadados (tipo x-jsonld e contexto x-jsonld) no esquema. Entre as principais características:

  • Respeita a hierarquia do regime, mantendo um contexto coerente;
  • Aplicar a herança automática de contexto aos níveis de filhos, salvo indicação em contrário;
  • Gera saídas de acordo com as especificações JSON-LD, prontas para serem integradas em sistemas baseados em ontologias RDF.

Este painel é fundamental para assegurar uma integração semântica eficaz e a publicação interoperável de dados.

Imagem descritiva da secção Contexto JSON-LD.

 

Usar o Menu de Ação

O Menu de Acção do Editor de Esquemas fornece acesso rápido a várias funcionalidades úteis para gerir, exportar e partilhar esquemas semânticos.
Pode ser acedido através de um botão dedicado localizado na interface principal do editor.

Principais funcionalidades

  1. Criar um novo modelo É possível gerar um modelo básico, que contém uma única classe de exemplo: Pessoa, com as propriedades givenName e familyName. Este modelo básico pode ser utilizado para:
    Explorar a estrutura e a lógica do regime;
    Adicionar facilmente novas classes e propriedades;
    Começar a definir um esquema personalizado, por exemplo, um modelo semântico de «Pessoa» com classes ontológicas conexas.
  2. O esquema atualmente utilizado pode ser descarregado em vários formatos:
    • Formato nativo (“tal como está”), útil para reutilização direta no Editor de Esquemas;
    • Formato JSON, adequado para integração em sistemas externos ou processamento posterior. 
  3. Partilha do regime
    Está disponível uma opção para copiar o esquema como um URL, permitindo uma partilha rápida e fácil com outros utilizadores ou ferramentas. Este link mostra uma representação persistente do esquema, pronto para ser aberto no mesmo editor ou em ambientes compatíveis.
  4. Abrir o esquema numa instância remota
    O mesmo esquema pode ser aberto numa instância remota previamente configurada do Editor de Esquemas (por exemplo, numa aplicação de terceiros ou num ambiente personalizado). Esta função é particularmente útil em contextos onde o editor está integrado num sistema de gestão, num portal de documentos ou num ambiente de desenvolvimento semântico dedicado.

Imagem descritiva do menu Action.

 

Consulte o Auxiliar RDF

O RDF Ontological Class Helper é uma ferramenta integrada no Editor de Esquemas concebida para apoiar os utilizadores no desenho semântico avançado de esquemas.
Este recurso ajuda a explorar as propriedades RDF associadas a uma classe semântica específica, facilitando o mapeamento adequado das propriedades e melhorando a qualidade semântica geral do esquema.

  1. A ferramenta executa automaticamente uma consulta SPARQL na classe semântica indicada no campo do tipo x-jsonld do esquema.
  2. Todas as propriedades associadas à classe são recuperadas, com detalhes úteis para cada propriedade, incluindo:
    • rdfs:intervalo: indica o tipo de valor esperado (p. ex. Literal, URI, etc.);
    • rdfs:comentário: Fornecer uma descrição textual da propriedade;
    • Exemplo de utilização: ajuda a compreender como integrar corretamente a propriedade no esquema.

As propriedades identificadas são inseridas num painel interativo, a partir do qual o utilizador pode analisá-las e decidir se as integra ou não no seu modelo.
Esta ferramenta é particularmente útil para alargar a cobertura semântica do esquema, assegurar o alinhamento adequado com os vocabulários RDF normalizados, reutilizar as propriedades existentes, reduzir a redundância e promover a interoperabilidade semântica.

Imagem descritiva da utilização do RDF Helper

Perguntas frequentes

Para guardar o esquema de dados criado, tem de ir para a secção Modelos de Dados, clicar no Menu de Ação e escolher se pretende guardar a ligação por Copiar como URL e guardar a ligação num documento de texto; ou guardar o esquema de dados em formato .yaml.

Há duas possibilidades:

  • Abra o ficheiro em formato .yaml, copie o texto e cole-o no Editor de Esquemas.
  • Recuperar o URL salvo anteriormente e copiá-lo para o navegador;

Para associar o valor da propriedade JSON Schema com o vocabulário controlado, preceder o valor de @base, como indicado no código de exemplo que pode ser consultado na janela que se abre ao clicar em (?) a partir do RDF Helper.

Se depois de fazer uma pesquisa minuciosa em todas as propriedades da classe e das suas superclasses não conseguir encontrar uma propriedade, é possível que esta não esteja presente no Catálogo. Faça uma pesquisa mais aprofundada diretamente no Catálogo acedendo à máscara de pesquisa schema.gov.it. Se não encontrar o recurso semântico correspondente à variável de esquema, pode escrevê-lo sem aprimorá-lo com o URI, mas recomenda-se descrevê-lo detalhadamente com a propriedade de descrição. Isto irá reduzir o OntoScore.