@deepgram/sdk
Version:
Isomorphic Javascript client for Deepgram
106 lines • 3.68 kB
TypeScript
import { AbstractClient, AgentLiveClient, AuthRestClient, ListenClient, ManageClient, ReadClient, OnPremClient, SelfHostedRestClient, SpeakClient, ModelsRestClient } from "./packages";
/**
* The DeepgramClient class provides access to various Deepgram API clients, including ListenClient, ManageClient, SelfHostedRestClient, ReadClient, and SpeakClient.
*
* @see https://github.com/deepgram/deepgram-js-sdk
*/
export default class DeepgramClient extends AbstractClient {
/**
* Returns a new instance of the AuthRestClient, which provides access to the Deepgram API's temporary token endpoints.
*
* @returns {AuthRestClient} A new instance of the AuthRestClient.
* @see https://developers.deepgram.com/reference/token-based-auth-api/grant-token
*/
get auth(): AuthRestClient;
/**
* Returns a new instance of the ListenClient, which provides access to the Deepgram API's listening functionality.
*
* @returns {ListenClient} A new instance of the ListenClient.
*/
get listen(): ListenClient;
/**
* Returns a new instance of the ManageClient, which provides access to the Deepgram API's management functionality.
*
* @returns {ManageClient} A new instance of the ManageClient.
*/
get manage(): ManageClient;
/**
* Returns a new instance of the ModelsRestClient, which provides access to the Deepgram API's model functionality.
*
* @returns {ModelsRestClient} A new instance of the ModelsRestClient.
*/
get models(): ModelsRestClient;
/**
* Returns a new instance of the SelfHostedRestClient, which provides access to the Deepgram API's self-hosted functionality.
*
* @returns {OnPremClient} A new instance of the SelfHostedRestClient named as OnPremClient.
* @deprecated use selfhosted() instead
*/
get onprem(): OnPremClient;
/**
* Returns a new instance of the SelfHostedRestClient, which provides access to the Deepgram API's self-hosted functionality.
*
* @returns {SelfHostedRestClient} A new instance of the SelfHostedRestClient.
*/
get selfhosted(): SelfHostedRestClient;
/**
* Returns a new instance of the ReadClient, which provides access to the Deepgram API's reading functionality.
*
* @returns {ReadClient} A new instance of the ReadClient.
*/
get read(): ReadClient;
/**
* Returns a new instance of the SpeakClient, which provides access to the Deepgram API's speaking functionality.
*
* @returns {SpeakClient} A new instance of the SpeakClient.
*/
get speak(): SpeakClient;
/**
* Returns a new instance of the AgentLiveClient, which provides access to Deepgram's Voice Agent API.
*
* @returns {AgentLiveClient} A new instance of the AgentLiveClient.
* @beta
*/
agent(endpoint?: string): AgentLiveClient;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get transcription(): any;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get projects(): any;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get keys(): any;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get members(): any;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get scopes(): any;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get invitation(): any;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get usage(): any;
/**
* @deprecated
* @see https://dpgr.am/js-v3
*/
get billing(): any;
}
//# sourceMappingURL=DeepgramClient.d.ts.map