import { BaseApiClient } from './base-api-client'; import { GetListOfJobsOptions } from './models/GetListOfJobsOptions'; import { RevAiApiTranscript } from './models/RevAiApiTranscript'; import { TopicExtractionJob } from './models/topic-extraction/TopicExtractionJob'; import { TopicExtractionJobOptions } from './models/topic-extraction/TopicExtractionJobOptions'; import { TopicExtractionResult } from './models/topic-extraction/TopicExtractionResult'; import { TopicExtractionResultOptions } from './models/topic-extraction/TopicExtractionResultOptions'; /** * Client which handles connection to the Rev AI topic extraction API. */ export declare class TopicExtractionClient extends BaseApiClient { /** * @param accessToken Access token used to validate API requests */ constructor(accessToken: string); /** * See https://docs.rev.ai/api/topic-extraction/reference/#operation/GetTopicExtractionJobById * Get information about a specific topic extraction job * @param id Id of job whose details are to be retrieved * @returns Job details */ getJobDetails(id: string): Promise; /** * See https://docs.rev.ai/api/topic-extraction/reference/#operation/GetListOfTopicExtractionJobs * Get a list of topic extraction jobs submitted within the last 30 days in reverse chronological order * @param options Job options for getting list of jobs * @returns List of job details */ getListOfJobs(options?: GetListOfJobsOptions): Promise; /** * See https://docs.rev.ai/api/topic-extraction/reference/#operation/DeleteTopicExtractionJobById * Delete a specific topic extraction job. * All data related to the job, such as input and result, will be permanently deleted. * A job can only by deleted once it's in a terminal state. * @param id Id of job to be deleted */ deleteJob(id: string): Promise; /** * See https://docs.rev.ai/api/topic-extraction/reference/#operation/SubmitTopicExtractionJob * Submits a topic extraction job with plain text as the input. * @param options Options submitted with the job: see TopicExtractionJobOptions object * @returns Details of the submitted job */ submitJobFromText(text: string, options?: TopicExtractionJobOptions): Promise; /** * See https://docs.rev.ai/api/topic-extraction/reference/#operation/SubmitTopicExtractionJob * Submits a topic extraction job with a json transcript as the input. * @param options Options submitted with the job: see TopicExtractionJobOptions object * @returns Details of the submitted job */ submitJobFromJson(json: RevAiApiTranscript, options?: TopicExtractionJobOptions): Promise; /** * See https://docs.rev.ai/api/topic-extraction/reference/#operation/GetTopicExtractionResultById * Get the result of a topic extraction job. * @param id Id of job to get result of * @param options Options submitted with getting results * @returns Topic extraction job result */ getResult(id: string, options?: TopicExtractionResultOptions): Promise; }