sapling-py 1.0.0

Sapling Python Client

Sapling Python Client

Python wrapper for the Sapling.ai API.

Here's a grammar check demo.

Sapling Features:

Sapling is an AI Writing Assistant offering spelling and grammar checker capabilities. Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.

• 60% more grammar corrections: compared to other systems at similar accuracy using state-of-the-art machine learning systems for natural language processing.
• Low Latency: Achieve the same real-time performance that users of Sapling's own interface experience.
• Over 20 error types: Error categories such as preposition, noun form, and verb tense, including both high-level and fine-grained error information.
• Custom Models: Get corrections and edits tuned to the domain of your text—for example academic writing vs. subtitles.
• Enterprise Security: Ask us about our no data rention policies, self-hosted/on-premise deployment options, and other cybersecurity policies and procedures.
• Rich Text Editor Support: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Consider using Sapling's JavaScript SDK for webpages.

Installation

Install the sapling-py package with pip

python -m pip install sapling-py

Documentation

Documentation for the client is available at Read the Docs and documentation for the HTTP API is available on Sapling.ai.

Quickstart

• Register for an account at Sapling.ai.
• After registering and signing in, generate a development API key in your dashboard.
• Install the Python client by following the installation steps above.

from sapling import SaplingClient

API_KEY = '<YOUR_API_KEY>'
client = SaplingClient(api_key=API_KEY)
edits = client.edits('Lets get started!', session_id='test_session')

• The result should be an array of edits of this form:

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

• More information on request options and response structure.
• Get a production key by following this documentation.

License

Copyright 2022 Sapling Intelligence, Inc.

Licensed under the Apache License, Version 2.0.