Table of Contents

1. JSON Schemas
2. Defining a JSON Schema
3. Examples
   1. Task JSON Schema
   2. Tool Arguments Schema

JSON Schemas

Raif includes a DSL for defining JSON schemas. You can use this to define the attributes that should be included in JSON objects produced by the LLM.

The DSL is utilized to define:

• JSON responses in tasks via the json_response_schema method
• Tool arguments of model tool invocations via the tool_arguments_schema method

Defining a JSON Schema

When defining a JSON schema, you can use the following methods:

• string(name, options = {}): Defines a string property
• integer(name, options = {}): Defines an integer property
• number(name, options = {}): Defines a number property
• boolean(name, options = {}): Defines a boolean property
• object(name = nil, options = {}, &block): Defines an object property
• array(name, options = {}, &block): Defines an array property
• items(options = {}): Defines the items of an array property

Examples

Task JSON Schema

class MyPersonGenerationTask < Raif::Task
  json_response_schema do
    string :name, description: "The name of the person"
    integer :age, description: "The age of the person"
    boolean :is_student, description: "Whether the person is a student"

    # An array of pet objects
    array :pets do
      object do
        string :name, description: "The name of the pet"
        string :species, enum: ["dog", "cat", "bird", "fish"], description: "The species of the pet"
      end
    end

    # An array of strings
    array :favorite_colors do
      items type: "string"
    end
  end
end

This schema would expect the LLM to return a JSON object like:

{
  "name": "John Doe",
  "age": 30,
  "is_student": false,
  "pets": [
    {
      "name": "Fido",
      "species": "dog"
    },
    {
      "name": "Whiskers",
      "species": "cat"
    }
  ],
  "favorite_colors": ["red", "blue", "green"]
}

Tool Arguments Schema

class WebSearchTool < Raif::ModelTool
  tool_arguments_schema do
    string :query, description: "The query to search the web for"
    integer :max_results, description: "The maximum number of results to return"
    boolean :include_images, description: "Whether to include images in the results"
    array :exclude_domains do
      items type: "string"
    end
  end
end

This schema would expect the LLM to return a JSON object like:

{
  "query": "What is the capital of France?",
  "max_results": 5,
  "include_images": false,
  "exclude_domains": ["example.com", "example.org"]
}

---

Read next: Embedding Models