feat: sits for JS sdk (#233)

* feat: add audio sits features to JS sdk

* fix: fix typos in sync+callback error

* feat: sits analyze types and schema

Author: lukeocodes

src/lib/helpers.ts

@@ -1,5 +1,12 @@
 import { Headers as CrossFetchHeaders } from "cross-fetch";
-import { DeepgramClientOptions, FileSource, PrerecordedSource, UrlSource } from "./types";
+import {
+  DeepgramClientOptions,
+  FileSource,
+  PrerecordedSource,
+  UrlSource,
+  TextSource,
+  AnalyzeSource,
+} from "./types";
 import { Readable } from "stream";
 import merge from "deepmerge";
 
@@ -41,12 +48,22 @@ export const resolveHeadersConstructor = () => {
   return Headers;
 };
 
-export const isUrlSource = (providedSource: PrerecordedSource): providedSource is UrlSource => {
+export const isUrlSource = (
+  providedSource: PrerecordedSource | AnalyzeSource
+): providedSource is UrlSource => {
   if ((providedSource as UrlSource).url) return true;
 
   return false;
 };
 
+export const isTextSource = (
+  providedSource: PrerecordedSource | AnalyzeSource
+): providedSource is TextSource => {
+  if ((providedSource as TextSource).text) return true;
+
+  return false;
+};
+
 export const isFileSource = (providedSource: PrerecordedSource): providedSource is FileSource => {
   if (isReadStreamSource(providedSource) || isBufferSource(providedSource)) return true;
 

src/lib/types/AnalyzeSchema.ts

@@ -0,0 +1,28 @@
+/**
+ * Options for read analysis
+ */
+interface AnalyzeSchema extends Record<string, unknown> {
+  callback?: string;
+
+  callback_method?: string;
+
+  custom_intent?: string | string[];
+
+  custom_intent_mode?: "strict" | "extended";
+
+  custom_topic?: string | string[];
+
+  custom_topic_mode?: "strict" | "extended";
+
+  intents?: boolean;
+
+  language?: string;
+
+  summarize?: boolean;
+
+  sentiment?: boolean;
+
+  topics?: boolean;
+}
+
+export type { AnalyzeSchema };

src/lib/types/AsyncAnalyzeResponse.ts

@@ -0,0 +1,3 @@
+export interface AsyncAnalyzeResponse {
+  request_id: string;
+}

src/lib/types/PrerecordedSource.ts src/lib/types/DeepgramSource.tssrc/lib/types/PrerecordedSource.ts renamed to src/lib/types/DeepgramSource.ts

@@ -7,3 +7,9 @@ export type FileSource = Buffer | Readable;
 export interface UrlSource {
   url: string;
 }
+
+export interface TextSource {
+  text: string;
+}
+
+export type AnalyzeSource = UrlSource | TextSource;

src/lib/types/SyncAnalyzeResponse.ts

@@ -0,0 +1,88 @@
+export interface SyncAnalyzeResponse {
+  model_uuid: string;
+  metadata: Metadata;
+  results: Results;
+}
+
+interface IntentsInfo {
+  model_uuid: string;
+  input_tokens: number;
+  output_tokens: number;
+}
+
+interface SentimentInfo {
+  model_uuid: string;
+  input_tokens: number;
+  output_tokens: number;
+}
+
+interface SummaryInfo {
+  model_uuid: string;
+  input_tokens: number;
+  output_tokens: number;
+}
+
+interface TopicsInfo {
+  model_uuid: string;
+  input_tokens: number;
+  output_tokens: number;
+}
+
+interface Metadata {
+  request_id: string;
+  created: string;
+  language: string;
+  intents_info: IntentsInfo;
+  sentiment_info: SentimentInfo;
+  summary_info: SummaryInfo;
+  topics_info: TopicsInfo;
+}
+
+interface Average {
+  sentiment: string;
+  sentiment_score: number;
+}
+
+interface Summary {
+  text: string;
+}
+
+interface Topic {
+  topic: string;
+  confidence_score: number;
+}
+
+interface Intent {
+  intent: string;
+  confidence_score: number;
+}
+
+interface Segment {
+  text: string;
+  start_word: number;
+  end_word: number;
+  sentiment: "positive" | "neutral" | "negative";
+  sentiment_score?: number;
+  topics?: Topic[];
+  intents?: Intent[];
+}
+
+interface Sentiments {
+  segments: Segment[];
+  average: Average;
+}
+
+interface Topics {
+  segments: Segment[];
+}
+
+interface Intents {
+  segments: Segment[];
+}
+
+interface Results {
+  sentiments?: Sentiments;
+  summary?: Summary;
+  topics?: Topics;
+  intents?: Intents;
+}

src/lib/types/SyncPrerecordedResponse.ts

@@ -44,8 +44,12 @@ interface Metadata {
   duration: number;
   channels: number;
   models: string[];
-  model_info: Record<string, ModelInfo>;
   warnings?: Warning[];
+  model_info: Record<string, ModelInfo>;
+  summary_info?: SummaryInfo;
+  intents_info?: IntentsInfo;
+  sentiment_info?: SentimentInfo;
+  topics_info?: TopicsInfo;
 }
 
 interface ModelInfo {
@@ -54,6 +58,30 @@ interface ModelInfo {
   arch: string;
 }
 
+interface SummaryInfo {
+  input_tokens: number;
+  output_tokens: number;
+  model_uuid: string;
+}
+
+interface IntentsInfo {
+  model_uuid: string;
+  input_tokens: number;
+  output_tokens: number;
+}
+
+interface SentimentInfo {
+  model_uuid: string;
+  input_tokens: number;
+  output_tokens: number;
+}
+
+interface TopicsInfo {
+  model_uuid: string;
+  input_tokens: number;
+  output_tokens: number;
+}
+
 interface Paragraph {
   sentences: Sentence[];
   start: number;
@@ -70,6 +98,47 @@ interface Result {
   channels: Channel[];
   utterances?: Utterance[];
   summary?: TranscriptionSummary;
+  sentiments?: Sentiments;
+  topics?: Topics;
+  intents?: Intents;
+}
+
+interface Sentiments {
+  segments: Segment[];
+  average: Average;
+}
+
+interface Topics {
+  segments: Segment[];
+}
+
+interface Intents {
+  segments: Segment[];
+}
+
+interface Intent {
+  intent: string;
+  confidence_score: number;
+}
+
+interface Average {
+  sentiment: string;
+  sentiment_score: number;
+}
+
+interface Topic {
+  topic: string;
+  confidence_score: number;
+}
+
+interface Segment {
+  text: string;
+  start_word: number;
+  end_word: number;
+  sentiment?: string;
+  sentiment_score?: number;
+  topics?: Topic[];
+  intents?: Intent[];
 }
 
 interface Search {

src/lib/types/TranscriptionSchema.ts

@@ -83,6 +83,41 @@ interface TranscriptionSchema extends Record<string, unknown> {
    */
   tag?: string[];
 
+  /**
+   * As yet unreleased.
+   */
+  sentiment?: boolean;
+
+  /**
+   * As yet unreleased.
+   */
+  intents?: boolean;
+
+  /**
+   * As yet unreleased.
+   */
+  custom_intent?: string[] | string;
+
+  /**
+   * As yet unreleased.
+   */
+  custom_intent_mode?: "strict" | "extended";
+
+  /**
+   * As yet unreleased.
+   */
+  topics?: boolean;
+
+  /**
+   * As yet unreleased.
+   */
+  custom_topic?: string[] | string;
+
+  /**
+   * As yet unreleased.
+   */
+  custom_topic_mode?: "strict" | "extended";
+
   [key: string]: unknown;
 }
 

src/lib/types/index.ts

@@ -1,4 +1,6 @@
+export type { AnalyzeSchema } from "./AnalyzeSchema";
 export type { AsyncPrerecordedResponse } from "./AsyncPrerecordedResponse";
+export type { AsyncAnalyzeResponse } from "./AsyncAnalyzeResponse";
 export type { CreateOnPremCredentialsSchema } from "./CreateOnPremCredentialsSchema";
 export type { CreateProjectKeySchema } from "./CreateProjectKeySchema";
 export type { CreateProjectKeyResponse } from "./CreateProjectKeyResponse";
@@ -32,9 +34,16 @@ export type { LiveConfigOptions } from "./LiveConfigOptions";
 export type { LiveMetadataEvent } from "./LiveMetadataEvent";
 export type { LiveTranscriptionEvent } from "./LiveTranscriptionEvent";
 export type { MessageResponse } from "./MessageResponse";
-export type { FileSource, PrerecordedSource, UrlSource } from "./PrerecordedSource";
+export type {
+  FileSource,
+  PrerecordedSource,
+  UrlSource,
+  TextSource,
+  AnalyzeSource,
+} from "./DeepgramSource";
 export type { SendProjectInviteSchema } from "./SendProjectInviteSchema";
 export type { SyncPrerecordedResponse } from "./SyncPrerecordedResponse";
+export type { SyncAnalyzeResponse } from "./SyncAnalyzeResponse";
 export type { TranscriptionSchema, PrerecordedSchema, LiveSchema } from "./TranscriptionSchema";
 export type { UpdateProjectMemberScopeSchema } from "./UpdateProjectMemberScopeSchema";
 export type { UpdateProjectSchema } from "./UpdateProjectSchema";

src/packages/PrerecordedClient.ts

@@ -28,7 +28,7 @@ export class PrerecordedClient extends AbstractRestfulClient {
 
       if (options !== undefined && "callback" in options) {
         throw new DeepgramError(
-          "Callback cannot be provided as an option to a synchronous transcription. Use `asyncPrerecordedUrl` or `asyncPrerecordedFile` instead."
+          "Callback cannot be provided as an option to a synchronous transcription. Use `transcribeUrlCallback` or `transcribeFileCallback` instead."
         );
       }
 
@@ -65,7 +65,7 @@ export class PrerecordedClient extends AbstractRestfulClient {
 
       if (options !== undefined && "callback" in options) {
         throw new DeepgramError(
-          "Callback cannot be provided as an option to a synchronous transcription. Use `asyncPrerecordedUrl` or `asyncPrerecordedFile` instead."
+          "Callback cannot be provided as an option to a synchronous transcription. Use `transcribeUrlCallback` or `transcribeFileCallback` instead."
         );
       }