AI Schema.org JSON-LD

About this module

The AI Schema.org JSON-LD module provides a straightforward way to send a prompt that includes a webpage's content and data, along with instructions and requirements, to an AI provider and to receive a valid Schema.org JSON-LD response for saving and embedding in a webpage.

This AI Schema.org JSON-LD module is a "glue module" that combines AI Automators, Field Widget Actions, and JSON Field to create an AI-powered 'Schema.org JSON-LD' field for content entities.

Watch a 2-minute demo

What does this module do?

This module adds a 'Schema.org JSON-LD' field, a native JSON data type, to content entities, including nodes, media, and taxonomy terms. The 'Schema.org JSON-LD' field is populated by an AI automator using a Field Widget Action, which sends the entity's content and data in a prompt to an AI provider. The AI provider returns the Schema.org JSON-LD for the content, which the content author reviews, saves, and embeds in the content's webpage. Additionally, a sub-module can be enabled to log prompts and responses so that they can be reviewed and improved by humans and AIs.

What are the benefits of this module?

The AI Schema.org JSON-LD module

• Provides a straightforward way to generate Schema.org JSON-LD for content using AI.
• Demonstrates a reusable, replicable pattern for configuring AI automators with field widget actions.
• Focuses on a prompt-and-response workflow with logging for generating Schema.org JSON-LD.
• Stores Schema.org JSON-LD as native JSON data, creating a fully queryable knowledge graph for a website.
• Allows both old and new sites with complex nested structures, such as paragraphs and components, to have AI parse and generate structured data.

How to set up this module?

• Install the module as you would any other Drupal module.
• Configure a default AI provider. (/admin/config/ai/providers).
• Decide which entity types and bundles should include Schema.org JSON-LD via the UI, Drush, or a Drupal recipe (/admin/config/ai/schemadotorg-jsonld).
• Experiment with and customize the prompts to get the best Schema.org JSON-LD response from the AI provider.

How should one implement this module?

For each content type, have the AI recommend the appropriate Schema.org JSON-LD for your existing content or for similar content on the web. When working with the AI, cite types and properties directly from Schema.org. Also include articles, recommendations, and examples from Google Structured Data.

Once you have the ideal Schema.org JSON-LD, have the AI adjust your prompt. Test your prompt across different models. Download the logged prompts and responses for an SEO/AEO export review, or ask an AI to further optimize your prompts.

What is the philosophy and concept behind this module?

Use AI to build a tool that helps AI understand your website while always keeping a human in the loop.

Similar and related modules

The most distinguishing aspect of this module is that it relies heavily on the Drupal AI ecosystem, which includes AI Automators and Field Widget Actions which, in turn, enable sending simple prompts to an AI provider and receiving Schema.org JSON-LD.

Here are similar modules that generate Schema.org JSON-LD with AI.

AI JSON-LD Schema Generator
Helps site builders and content editors add schema.org JSON-LD structured data to a Drupal site without writing JSON by hand.

Schema Markup Generator using AI
Automatically creates Schema.org JSON-LD structured data for Drupal content using OpenAI.

Schema.org Metatag AI
Bring AI automation to your Drupal metatags.

Here are more traditional modules for creating Schema.org JSON-LD without AI

Schema.org Blueprints
Provides a set of tools to create perfect data structures (Schema.org), pristine APIs (JSON:API), and great SEO (JSON-LD) within the best content authoring and administration user experience.

Schema.org Metatag
Extends Drupal's Metatag module to display structured data as JSON-LD in the head of web pages.

How should you contribute?

Contributing to the code

This module was built using coding agents such as Claude and Codex. Therefore, we encourage the use of these tools to build and maintain this module. That said, all contributed code must include test coverage and be reviewed by humans.

Join the Drupal AI Learner Club to master how best to use AI coding agents with Drupal.

Contributing to the prompts

As a community, we need to determine the best default prompts with guidelines/requirements for generating pristine Schema.org JSON-LD. As LLMs improve, AI-generated Schema.org JSON-LD will continue to improve.

One of the biggest contributions someone could make is experimenting with crafting the ideal prompt and sharing the experience.