API Reference
Sapling HTTP API documentation
- class sapling.client.SaplingClient(api_key, timeout=120, hostname=None, pathname=None)
Sapling client class. Provides a mapping of Python functions to Sapling HTTP REST APIs.
- Parameters:
- accept_complete(complete_uuid, query, completion, session_id=None)
Use this API endpoint to have Sapling improve completions over time.
Each suggested autocomplete has a UUID. You can pass this information back to Sapling to indicate the suggestion was helpful.
- accept_edit(edit_uuid, session_id=None, user_id=None)
Use this API endpoint to have Sapling adapt its system over time.
Each suggested edit has an edit UUID. You can pass this information back to Sapling to indicate the edit suggestion was helpful. For each unique edit in each document, use the accept or reject API endpoint only once in total.
- aidetect(text, sent_scores=None)
Score a piece of text on how likely it was generated by AI.
- Parameters:
- Return type:
- Returns:
score: float between 0 and 1, probability that text is AI generated
sentence_scores: If sent_scores is set, will return a list of scores per sentence.
text: text that was processed
- chunk_html(html, max_length, step_size=None)
Break an input text into blocks of length of most max_length. When splitting the text, the API follows the following preference stack:
page break > paragraph breaks > line breaks > tabs > punctuation > all other whitespace
Note: This endpoint not only breaks up the HTML but also discards all HTML tags, resulting in plain text.
- chunk_text(text, max_length, step_size=None)
Break an input text into blocks of length of most max_length. When splitting the text, the API follows the following preference stack:
page break > paragraph breaks > line breaks > tabs > punctuation > all other whitespace
- complete(query, session_id=None)
Provides predictions of the next few characters or words
- edits(text, session_id=None, lang=None, variety=None, medical=None, auto_apply=False, advanced_edits=None, user_id=None, is_anon_user=None)
Fetches edits (including for grammar and spelling) for provided text.
- Parameters:
text (str) – Text to process for edits.
session_id (str) – Unique name or UUID of document or portion of text that is being checked
lang (str) – 2 letter ISO 639-1 language code
variety (str) – Specifies regional English variety preference. Defaults to the configuration in the user Sapling dashboard.
medical (bool) – If true, the backend will apply Sapling’s medical dictionary.
auto_apply (bool) – Whether to return a field with edits applied to the text
advanced_edits (dict) – Additional edit configurations
user_id (str) – Track IDs representing your end users
is_anon_user (bool) – If user_id represents a logged-in or anonymous user
- Return type:
- Returns:
- edits: List of Edits:
sentence: Unedited sentence
sentence_start: Offset of sentence from start of text
start: Offset of edit start relative to sentence
end: Offset of edit end relative to sentence
replacement: Suggested replacement
error_type: Error type
general_error_type: General Error type
applied_text: Transformed text if auto_apply is set.
- Supported languages:
de: German (Deutsch)
el: Greek (Ελληνικά)
en: English (US/UK/CA/AU)
es: Spanish (Español)
fr: French (Français) (fr-fr and fr-ca coming soon)
it: Italian (Italiano)
jp: Japanese (日本語)
ko: Korean (한국어)
nl: Dutch (Nederlands)
pl: Polish (Polski)
pt: Portuguese (Português) (pt-pt and pt-br coming soon)
sv: Swedish (Svenska)
tl: Tagalog
zh: Chinese (中文)
- Supported varieties:
us-variety: American English
gb-variety: British English
au-variety: Australian English
ca-variety: Canadian English
null-variety: Don’t suggest changes based on English variety
- Supported advanced_edit options:
advanced_edits
adverbs
simplifications
hard_to_read
qualifiers
voice
dei
gender
gender_pronoun
gender_noun
gender_id
sensitivity
disability
age
race
social_class
violence
- postprocess(text, session_id, operations)
- Performs a variety of operations that are useful for working with the outputs of an NLP (whether human or AI) system. These include:
Fixing or restoring punctuation
Fixing capitalization
Fixing or restoring whitespace
Example use cases include repairing transcriptions or captions.
- Parameters:
- Return type:
- Returns:
Same as the edits endpoint: - sentence: Unedited sentence - sentence_start: Offset of sentence from start of text - start: Offset of edit start relative to sentence - end: Offset of edit end relative to sentence - replacement: Suggested replacement - error_type: Error type - general_error_type: General Error type
- reject_edit(edit_uuid, session_id=None, user_id=None)
Use this API endpoint to have Sapling not recommend the same edit anymore.
Each suggested edit has an edit UUID. You can pass this information back to Sapling to indicate the edit suggestion was not helpful. For each unique edit in each document, use the accept or reject API endpoint only once in total.
- spellcheck(text, session_id=None, min_length=None, multiple_edits=None, lang=None, auto_apply=False, variety=None, user_data=None, user_id=None, is_anon_user=None)
Fetches spelling (no grammar or phrase level) edits for provided text.
- Parameters:
text (str) – Text to process for edits.
session_id (str) – Unique name or UUID of document or portion of text that is being checked
min_length (int) – Default is 3. Minimum character length of words to suggest corrections for. Setting this too low will result in much higher false positives.
multiple_edits (bool) – Default is false. If true, will return candidates field containing list of other potential corrections for each error.
lang (str) – Default is English. Specify a language to spellcheck the text against.
auto_apply (bool) – Whether to return a field with edits applied to the text. Cannot be set with multiple_edits option.
advanced_edits (dict) – additional edit checking options
variety (str) – Specifies regional English variety preference. Defaults to the configuration in the user Sapling dashboard.
user_id (str) – Track IDs representing your end users
is_anon_user (bool) – If user_id represents a logged-in or anonymous user
- Return type:
- Supported languages:
en: English
ar: عربي
bg: български
ca: català
cs: čeština
da: dansk
de: Deutsch
el: Ελληνικά
es: español
et: eesti keel
fa: فارسی
fi: suomi
fr: français (fr-fr and fr-ca coming soon)
he: עִבְרִית
hi: हिन्दी”,
hr: hrvatski,
hu: magyar nyelv
id: bahasa Indonesia
is: íslenska
it: italiano
jp/ja: 日本語
ko: 한국어
lt: lietuvių kalba
lv: latviešu valoda
nl: Nederlands
no: norsk
pl: polski
pt: português
ro: limba română
ru: русский
sk: slovenčina
sq: shqip
sr: srpski
sv: svenska
th: ภาษาไทย
tl: Tagalog / ᜆᜄᜎᜓᜄ᜔
tr: Türkçe
uk: Українська мова
vi: Tiếng Việt
zh: 中文
- Supported varieties:
us-variety: American English
gb-variety: British English
au-variety: Australian English
ca-variety: Canadian English
null-variety: Don’t suggest changes based on English variety