Lightcast Ruby

An API client for the Lightcast REST APIs in ruby.

Lightcast Classification APIs documentation can be found here:

https://docs.lightcast.dev/apis/classification

Add to your Gemfile:

gem 'lightcast-ruby'

Then bundle install.

Create your client

client = Lightcast::Client.new(
  client_id: '123ABC'
  client_secret: '456DEF'
  scope: 'classifications_api',
)

and then create an authentication token that lasts 1 hour

client.authenticate

Now you can make use of any of your available APIs for your client.

You can access the skills API via

client.skills(version: '9.0.0', release: '2024.7')

where the optional version is any valid version.

Extract skills from plain text.

skills.extract(text:'computer science is a cool thing to study')

API docs

Get a single skill.

client.skills.get(123)

API docs

List skills.

client.skills.post(
   fields: ['name'],
   filter: {
     level: ['2'],
     id: [
      "someId",
      "anotherId"
     ]
   },
   limit: 5)

API docs

Get related skills from provided skills.

client.related.get(ids: ['12345', 'abcde'], relationType: 'sibling')

API docs

Get the status of the classifications API.

client.skills.status

API docs

Any error code returned by the Lightcast API will result in one of the following expections

Copyright (C) 2023 Riipen. See LICENSE for details.