@plastic-ant/lightcast-api
Version:
An unofficial helper package for accessing the Lightcast API endpoints
80 lines (79 loc) • 3.95 kB
TypeScript
import { LightcastAPIClient } from "../..";
import type { Status, Response } from "../common-types";
declare const _default: (client: LightcastAPIClient) => {
/**
*
* @returns
* @See API docs {@link https://docs.lightcast.dev/apis/skills#get-get-service-status}
*/
status: () => Promise<import("typed-rest-client").IRestResponse<Response<Status>>>;
taxonomies: {
listAll: <R = Response>(params?: {
tags?: string | undefined;
} | undefined) => Promise<import("typed-rest-client").IRestResponse<R>>;
meta: <R_1 = Response>(facet: string) => Promise<import("typed-rest-client").IRestResponse<R_1>>;
versions: <R_2 = Response<string[]>>(facet: string) => Promise<import("typed-rest-client").IRestResponse<R_2>>;
version: (version: string) => {
meta: <R_3 = Response>(facet: string) => Promise<import("typed-rest-client").IRestResponse<R_3>>;
concepts: <R_4 = Response>(facet: string, params?: {
q?: string | undefined;
fields?: string | undefined;
filter?: string | undefined;
limit?: number | undefined;
after?: number | undefined;
locale?: string | undefined;
} | undefined) => Promise<import("typed-rest-client").IRestResponse<R_4>>;
conceptsById: <R_5 = Response>(facet: string, id: string, params?: {
q?: string | undefined;
fields?: string | undefined;
filter?: string | undefined;
limit?: number | undefined;
after?: number | undefined;
locale?: string | undefined;
} | undefined) => Promise<import("typed-rest-client").IRestResponse<R_5>>;
relations: <R_6 = Response>(facet: string, body: {
relationType: "child" | "sibling" | "any";
ids: string[];
filter?: import("type-fest").JsonObject | undefined;
}) => Promise<import("typed-rest-client").IRestResponse<R_6>>;
};
};
mappings: {
meta: <R_7 = Response>(params?: {
filter?: string | undefined;
} | undefined) => Promise<import("typed-rest-client").IRestResponse<R_7>>;
concepts: <R_8 = Response>(name: string, body: {
ids: string[];
}) => Promise<import("typed-rest-client").IRestResponse<R_8>>;
};
classifications: {
classifierReleases: <R_9 = Response>() => Promise<import("typed-rest-client").IRestResponse<R_9>>;
release: (release: string) => {
availableDataSourceTypes: <R_10 = Response>() => Promise<import("typed-rest-client").IRestResponse<R_10>>;
operationsAvailableForSource: <R_11 = Response>(source: string) => Promise<import("typed-rest-client").IRestResponse<R_11>>;
lotClassify: <R_12 = Response>(body: {
title: string;
limit?: number | undefined;
fields?: string[] | undefined;
description?: string | undefined;
}) => Promise<import("typed-rest-client").IRestResponse<R_12>>;
postingClassify: <R_13 = Response>(body: {
context: {
company: string;
title: string;
body: string;
};
outputs: string[];
}) => Promise<import("typed-rest-client").IRestResponse<R_13>>;
extractSkillsMeta: <R_14 = Response>() => Promise<import("typed-rest-client").IRestResponse<R_14>>;
extractSkills: <R_15 = Response>(body: {
text: string;
confidenceThreshold: number;
trace: boolean;
inputLocale: string;
outputLocale: string;
}) => Promise<import("typed-rest-client").IRestResponse<R_15>>;
};
};
};
export default _default;