@deepgram/sdk
Version:
Isomorphic Javascript client for Deepgram
26 lines • 1.52 kB
TypeScript
import { AbstractClient } from "./AbstractClient";
import { ListenLiveClient } from "./ListenLiveClient";
import { ListenRestClient } from "./ListenRestClient";
import { LiveSchema } from "../lib/types";
/**
* The `ListenClient` class extends the `AbstractClient` class and provides access to the "listen" namespace.
* It exposes two methods:
*
* 1. `prerecorded()`: Returns a `ListenRestClient` instance for interacting with the prerecorded listen API.
* 2. `live(transcriptionOptions: LiveSchema = {}, endpoint = ":version/listen")`: Returns a `ListenLiveClient` instance for interacting with the live listen API, with the provided transcription options and endpoint.
*/
export declare class ListenClient extends AbstractClient {
namespace: string;
/**
* Returns a `ListenRestClient` instance for interacting with the prerecorded listen API.
*/
get prerecorded(): ListenRestClient;
/**
* Returns a `ListenLiveClient` instance for interacting with the live listen API, with the provided transcription options and endpoint.
* @param {LiveSchema} [transcriptionOptions={}] - The transcription options to use for the live listen API.
* @param {string} [endpoint=":version/listen"] - The endpoint to use for the live listen API.
* @returns {ListenLiveClient} - A `ListenLiveClient` instance for interacting with the live listen API.
*/
live(transcriptionOptions?: LiveSchema, endpoint?: string): ListenLiveClient;
}
//# sourceMappingURL=ListenClient.d.ts.map