Grammar Checking in Ruby

Ruby is a programming language that shares design philosophies of Python and Perl around scripting, usability, and programming productivity but with a more object-oriented approach. Its popularity and adoption increased with Ruby on Rails, an MVC web framework written in Ruby.

Sapling: AI Writing Assistant

With Sapling, you can add grammar or spell checking functionality to an existing Ruby application.

This page demonstrates a quick way to integrate grammar and spell checking functionality into a Ruby application using Sapling's API. If you are not looking for a Ruby guide, click here for guides for other programming languages.

Sapling does not currently maintain a Ruby-specific SDK, but you can access the Sapling Grammar Checking HTTP API using any programming language that supports HTTP POST requests. An example is shown below.

Setup Steps

[Register] for an account.
Visit the [dashboard] to generate an API key.
Run the code below, filling in your API key.

Ruby Grammar Check Quickstart

require 'net/http'
require 'json'

uri = URI('https://api.sapling.ai/api/v1/edits')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
req = Net::HTTP::Post.new(uri.path, 'Content-Type' => 'application/json')
req.body = {key: 'API_KEY', text: 'Lets get started!',
session_id: 'Test Document UUID'}.to_json
res = http.request(req)
puts "response #{res.body}"

Returned result:

{
    "edits":[
      {
          "end":4,
          "error_type":"R:OTHER",
          "general_error_type":"Other",
          "id":"aa5ee291-a073-5146-8ebc-c9c899d01278",
          "replacement":"Let's",
          "sentence":"Lets get started!",
          "sentence_start":0,
          "start":0
      }
    ]
}

Documentation

Addtional parameters and Sapling's full API documentation can be accessed here: https://sapling.ai/docs