@plastic-ant/lightcast-api
Version:
An unofficial helper package for accessing the Lightcast API endpoints
76 lines (75 loc) • 3.48 kB
TypeScript
import { LightcastAPIClient } from "../..";
import type { Response } from "../common-types";
/**
* @see API docs {@link https://docs.lightcast.dev/apis/classification#overview}
*/
declare const _default: (client: LightcastAPIClient) => {
/**
* Returns a list of available classifier releases with meta data listing the supported taxonomies and outputs.
* @param params
* @returns
* @set API docs {@link https://docs.lightcast.dev/apis/classification#get-list-classifier-releases}
*/
classifierReleases: <R = Response>() => Promise<import("axios").AxiosResponse<R, any>>;
release: (release: string) => {
/**
* Returns a list of available classifier data source types (e.g., postings).
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#classifications-release}
*/
availableDataSourceTypes: <R_1 = Response>() => Promise<import("axios").AxiosResponse<R_1, any>>;
/**
* Returns a list of available operations for the given release and source.
* @param source
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#classifications-release-source}
*/
operationsAvailableForSource: <R_2 = Response>(source: string) => Promise<import("axios").AxiosResponse<R_2, any>>;
/**
* Classifies title and description to specialized occupation.
* @param body
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#classifications-release-lot-classify}
*/
lotClassify: <R_3 = Response, B = {
title: string;
limit?: number | undefined;
fields?: string[] | undefined;
description?: string | undefined;
}>(body: B) => Promise<import("axios").AxiosResponse<R_3, any>>;
/**
* Performs the requested classification operation on postings related data, including company name, title, and job description. A range of classifications may be performed on the input based on the requested outputs.
* @param body
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#classifications-release-postings-classify}
*/
postingClassify: <R_4 = Response, B_1 = {
context: {
company: string;
title: string;
body: string;
};
outputs: string[];
}>(body: B_1) => Promise<import("axios").AxiosResponse<R_4, any>>;
/**
* Get metadata for requested version of skills extractor.
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#get-extract-skills-metadata}
*/
extractSkillsMeta: <R_5 = Response>() => Promise<import("axios").AxiosResponse<R_5, any>>;
/**
* Extract an array of Lightcast Skills from the provided text.
* @param body
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/classification#post-extract-skills}
*/
extractSkills: <R_6 = Response, B_2 = {
text: string;
confidenceThreshold: number;
trace: boolean;
inputLocale: string;
outputLocale: string;
}>(body: B_2) => Promise<import("axios").AxiosResponse<R_6, any>>;
};
};
export default _default;