@saplingai/sapling-js 1.0.0 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -11
- package/package.json +3 -3
- package/sapling/sapling-sdk-v1.0.1.min.js +2 -40305
package/README.md
CHANGED
|
@@ -2,25 +2,32 @@
|
|
|
2
2
|
|
|
3
3
|
Node.js client for the [Sapling.ai API](https://sapling.ai/api).
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Try out a [grammar check demo](https://sapling.ai/grammar-check).
|
|
6
|
+
Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
|
|
7
|
+
|
|
8
|
+
Functionality
|
|
6
9
|
--------
|
|
7
10
|
|
|
8
|
-
Sapling is an AI
|
|
11
|
+
Sapling is an AI messaging assistant.
|
|
12
|
+
The API currently offers spelling and grammar checking endpoints.
|
|
9
13
|
|
|
14
|
+
Benefits include:
|
|
10
15
|
- **60% more grammar corrections**: compared to [other systems](https://sapling.ai/comparison/api) at similar accuracy using state-of-the-art machine learning systems for natural language processing.
|
|
11
16
|
- **Low Latency**: Achieve the same real-time performance that users of Sapling's own interface experience.
|
|
12
17
|
- **Over 20 error types**: Error categories such as preposition, noun form, and verb tense, including both high-level and fine-grained error information.
|
|
13
18
|
- **Custom Models**: Get corrections and edits tuned to the domain of your text—for example academic writing vs. subtitles.
|
|
14
|
-
- **Enterprise Security**:
|
|
15
|
-
- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others.
|
|
19
|
+
- **Enterprise Security**: Contact us for our no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and other [cybersecurity policies and procedures](https://sapling.ai/security).
|
|
20
|
+
- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Consider using [Sapling's JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for displaying the API's outputs on webpage editors.
|
|
21
|
+
|
|
22
|
+
|
|
16
23
|
|
|
17
24
|
Installation
|
|
18
25
|
--------
|
|
19
26
|
|
|
20
27
|
`npm install @saplingai/sapling-js`
|
|
21
28
|
|
|
22
|
-
- Register for an account at [Sapling.ai](https://sapling.ai).
|
|
23
|
-
- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings)
|
|
29
|
+
- Register for an account at [Sapling.ai](https://sapling.ai/user/register).
|
|
30
|
+
- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
|
|
24
31
|
|
|
25
32
|
|
|
26
33
|
Quickstart - Backend
|
|
@@ -45,7 +52,7 @@ Quickstart - Frontend
|
|
|
45
52
|
|
|
46
53
|
The SDK provides a way to automatically apply edit suggestions to any HTML contenteditable and textarea elements.
|
|
47
54
|
|
|
48
|
-
Do not serve a page like this publicly, as it exposes the API key. See documentation [Deploying to Production](https://sapling.ai/docs/sdk/quickstart#deploying-to-production) for an example of setting up the API key
|
|
55
|
+
Do **not** serve a page like this publicly, as it exposes the API key. See documentation [Deploying to Production](https://sapling.ai/docs/sdk/quickstart#deploying-to-production) for an example of setting up the API key with a separate backend environment.
|
|
49
56
|
|
|
50
57
|
```javscript
|
|
51
58
|
import { useEffect } from 'react';
|
|
@@ -75,10 +82,10 @@ function App() {
|
|
|
75
82
|
```
|
|
76
83
|
|
|
77
84
|
|
|
78
|
-
|
|
85
|
+
Documentation
|
|
79
86
|
-------------
|
|
80
87
|
|
|
81
|
-
-
|
|
82
|
-
- Complete Sapling SDK and HTTP API [documentation](https://sapling.ai/docs).
|
|
83
|
-
- More information on [request options and response structure](https://sapling.ai/docs/api/edits-overview)
|
|
88
|
+
- Complete Sapling HTTP API and SDK [documentation](https://sapling.ai/docs).
|
|
84
89
|
- Get a production key by following [these instructions](https://sapling.ai/docs/api/api-access).
|
|
90
|
+
- JavaScript, HTML, and Python [starter code](https://github.com/saplingai/sapling-samples).
|
|
91
|
+
- More information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@saplingai/sapling-js",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.0.3",
|
|
4
|
+
"description": "JavaScript library for using the Sapling.ai API.",
|
|
5
5
|
"type":"module",
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"axios": "^0.26.1",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"homepage": "https://sapling.ai/docs/",
|
|
15
15
|
"repository": {
|
|
16
16
|
"type": "git",
|
|
17
|
-
"url": "https://github.com/
|
|
17
|
+
"url": "https://github.com/saplingai/sapling-samples.git"
|
|
18
18
|
},
|
|
19
19
|
"bugs": {
|
|
20
20
|
"url" : "https://github.com/saplingai/sapling-samples/issues",
|