@plastic-ant/lightcast-api
Version:
An unofficial helper package for accessing the Lightcast API endpoints
54 lines (53 loc) • 2.08 kB
TypeScript
import { LightcastAPIClient } from "../..";
import type { Status } from "../common-types";
import { JsonValue } from "type-fest";
declare const _default: (client: LightcastAPIClient) => {
/**
* Get the health of the service. Be sure to check the healthy attribute of the response.
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/similarity#get-get-service-status}
*/
status: () => Promise<import("axios").AxiosResponse<{
data: Status;
}, any>>;
/**
* Get service meta data, including attribution text. Caching is encouraged, but the meta data does change periodically..
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/similarity#get-get-service-meta-data}
*/
meta: <R = JsonValue>() => Promise<import("axios").AxiosResponse<R, any>>;
/**
* Get available models.
* @param params
* @returns
* @set API docs {@link https://docs.lightcast.dev/apis/similarity#get-get-available-models}
*/
listAllModels: (params?: {
tags?: string;
}) => Promise<import("axios").AxiosResponse<{
data: string[];
}, any>>;
/**
*
* @param dimension - The occupation dimension used for modeling Salary Boosting Skills.
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/ddn-api#dimensions}
*/
models: (model: string) => {
/**
* Get similarity mappings based on selected model and input taxonomy item.
* @param body - { id: Occupation code of the dimension }
* @returns
* @see API docs {@link https://docs.lightcast.dev/apis/similarity#post-get-similarity-data-on-a-selected-item}
*/
similarity: <R_1 = Response, B = {
input: string | string[];
filter?: {
ids?: string[] | undefined;
minScore?: number | undefined;
} | undefined;
limit: number;
}>(body: B) => Promise<import("axios").AxiosResponse<R_1, any>>;
};
};
export default _default;