Code Monkey home page Code Monkey logo

prowritingaid.csharp's Introduction

ProWritingAid.SDK

Build status

C# library for the ProWritingAid.API

Frameworks supported

  • .NET standard 2.0

Dependencies

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

Installation

Install SDK using Nuget package.

Getting Started

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ProWritingAid.SDK.Api;
using ProWritingAid.SDK.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
                
            var api = new TextAsyncApi()
                .SetLicenseCode("00000000-0000-0000-0000-2212FC205139");
            var request = new TextAnalysisRequest(
                "I couldnt wait any any longer, I new what I hadd to do",
                new List<string> {"grammar"},
                TextAnalysisRequest.StyleEnum.General,
                TextAnalysisRequest.LanguageEnum.En); 
    
            try
            {
                var response = api.Post(request);
                Debug.WriteLine(response);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextApi.TextPost: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.prowritingaid.com

Class Method HTTP request Description
ContextualThesaurusApi Get GET /api/async/contextualthesaurus/result/{taskId} Tries to get the result of a request using the task id of the request
ContextualThesaurusApi Post POST /api/async/contextualthesaurus Analyses text and returns contextual thesaurus entries
HtmlApi Get GET /api/async/html/result/{taskId} Tries to get the result of a request using the task id of the request
HtmlApi Post POST /api/async/html Analyses HTML and adds suggestion tags to it
SummaryApi Get GET /api/async/summary/result/{taskId} Tries to get the result of a request using the task id of the request
SummaryApi Post POST /api/async/summary Gets the summary analysis of a document
TextApi Get GET /api/async/text/result/{taskId} Tries to get the result of a request using the task id of the request
TextApi Post POST /api/async/text Analyses text and returns tags for it
ThesaurusApi Post POST /api/thesaurus Returns the thesaurus entries for a specific word
WordCloudApi Get GET /api/async/wordcloud/result/{taskId} Tries to get the result of a request using the task id of the request
WordCloudApi Post POST /api/async/wordcloud Analyses text and returns a word cloud (as an image)

Documentation for Models

Documentation for Authorization

licenseCode

  • Type: API key
  • API key parameter name: licenseCode
  • Location: HTTP header

prowritingaid.csharp's People

Contributors

dmit25 avatar pedroroquette avatar prowriting avatar vladimirmelekh avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

prowritingaid.csharp's Issues

Need a Nuget package for .NET Core / .NET 5

Imperative: .NET Framework 4.5 is the end of the road for that line. Beginning .NET 5, everything is built off the .NET Core code base. So at the very least, a new NuGet package built for .NET 5 is needed.

Making the package compatible with .NET Core 3.1 should cover both .NET Core 3 and .NET 5.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.