package textrazor

  1. Overview
  2. Docs
An OCaml wrapper for the TextRazor API

Install

Dune Dependency

Authors

Maintainers

Sources

textrazor-0.1.1.tbz
sha256=00c8c230c1327aa15005259e6b48b9a7e56401780cedfd1b8f8c432bd8fb8fda
sha512=46fe60e8dbb5cafe38b2e2adc8053e849a4feb3b9057388062bed04cfea61f42fd373abaeb503559fb2b5c924c10a91da3b22304f5b96d4808d5e1e776fd9483

Description

An OCaml wrapper for the TextRazor API

Published: 08 Jun 2022

README

OCaml TextRazor  

An OCaml wrapper for the TextRazor API.

Installation

opam install textrazor

Usage

Configuration

open Textrazor

let client = Client.create "api_key"

(* Optional configuration *)
let client = Client.create ~use_eu_endpoint:false ~secure:true "api_key"

Analysis

Send either a text or a publicly available URL to the analysis endpoint.

open Textrazor

(* Analyze a text *)
let analysis = Analysis.post (`Text "Text to analyze") client

(* Analyze a text by public URL *)
let analysis =
  Analysis.post (`Uri (Uri.of_string "https://www.example.com/sample.txt")) c

Use Analysis.Options to customize the analysis.

open Textrazor

let analysis =
  let options = Analysis.Options.{default with field = value} in
  Analysis.post (`Text "Text to analyze") ~options client

Account

Get information about your Textrazor account.

open Textrazor

let account = Account.get client

Contributing

  • Fork the project;

  • Create your feature branch (git checkout -b my-new-feature);

  • Commit your changes (git commit -am 'Add some feature');

  • Push to the branch (git push origin my-new-feature);

  • Create a new pull request.

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test

Used by

None

Conflicts

None