assemblyai 2.0.0-beta → 2.0.1-beta

package/src/services/transcripts/subtitles.ts

@@ -1,26 +0,0 @@
-import BaseService from "@/services/base";
-import { Retrieveable } from "@/types";
-
-type Subtitle = string;
-type SubtitleFormat = "vtt" | "srt";
-
-type TranscriptionSubtitleParams = {
-  transcript_id: string;
-  format: SubtitleFormat;
-};
-
-export default class TranscriptSubtitleService
-  extends BaseService
-  implements Retrieveable<Subtitle, TranscriptionSubtitleParams>
-{
-  async retrieve({
-    transcript_id,
-    format,
-  }: TranscriptionSubtitleParams): Promise<Subtitle> {
-    const { data } = await this.client.get<Subtitle>(
-      `/v2/transcript/${transcript_id}/${format}`
-    );
-
-    return data;
-  }
-}

package/src/types/core/index.ts

@@ -1,2 +0,0 @@
-export type * from "./transcript";
-export type * from "./segments";

package/src/types/core/params.ts

@@ -1,3 +0,0 @@
-type WordBoostWeight = "low" | "default" | "high";
-
-export type { WordBoostWeight };

package/src/types/core/segments.ts

@@ -1,29 +0,0 @@
-type SegmentType = "paragraphs" | "sentences";
-
-type Segment<T> = T & {
-  id: string;
-  confidence: number;
-  audio_duration: number;
-};
-
-type ParagraphsBody = Segment<{ paragraphs: Utterance[] }>;
-type SentencesBody = Segment<{ sentences: Utterance[] }>;
-
-type Word = {
-  text: string;
-  start: number;
-  end: number;
-  confidence: number;
-  speaker?: string | null;
-};
-
-type Utterance = {
-  start: number;
-  end: number;
-  confidence: number;
-  speaker?: string;
-  text: string;
-  words: Word[];
-};
-
-export type { Word, Utterance, ParagraphsBody, SentencesBody, SegmentType };

package/src/types/core/transcript.ts

@@ -1,159 +0,0 @@
-import {
-  AutoChapter,
-  AutoHighlights,
-  ContentSafetyLabels,
-  Entity,
-  PIIAudioQuality,
-  PIIRedactionPolicies,
-  SentimentAnalysis,
-  SummaryModel,
-  SummaryType,
-  TopicDetection,
-} from "@/types/models";
-import { PageDetails } from "@/types/shared";
-import { Utterance, Word } from "./segments";
-import { WordBoostWeight } from "./params";
-
-type TranscriptStatus = "queued" | "processing" | "completed" | "error";
-
-type TranscriptBase = {
-  status?: TranscriptStatus | null;
-
-  // Core Transcription
-  audio_url: string;
-  audio_start_from?: number | null;
-  audio_end_at?: number | null;
-  filter_profanity?: boolean;
-  custom_spelling?: null;
-  disfluencies?: boolean;
-  dual_channel?: boolean | null;
-  punctuate?: boolean;
-  speaker_labels?: boolean;
-  format_text?: boolean;
-
-  // Audio Intelligence
-  auto_chapters?: boolean;
-  content_safety?: boolean;
-  entity_detection?: boolean;
-  language_code?: string;
-  language_detection?: boolean;
-  iab_categories?: boolean;
-  auto_highlights?: boolean;
-  summarization?: boolean;
-  summary_type?: SummaryType;
-  summary_model?: SummaryModel;
-  redact_pii?: boolean;
-  redact_pii_sub?: string;
-  redact_pii_audio_quality?: PIIAudioQuality;
-  redact_pii_audio?: boolean;
-  redact_pii_policies?: PIIRedactionPolicies[];
-  sentiment_analysis?: boolean;
-  webhook_auth_header_name?: null;
-  webhook_auth?: boolean;
-  webhook_status_code?: null | number;
-  webhook_url?: null | string;
-
-  word_boost?: string[];
-  boost_param?: WordBoostWeight;
-};
-
-type TranscriptParams = Omit<TranscriptBase, "status">;
-
-type TranscriptQueued = TranscriptBase & {
-  id: string;
-  status: "queued";
-};
-
-type TranscriptProcessing = TranscriptBase & {
-  id: string;
-  status: "processing";
-};
-
-type TranscriptCompleted = TranscriptBase & {
-  status: "completed";
-  id: string;
-  audio_duration?: number;
-  words?: Word[];
-  utterances?: Utterance[];
-  text?: string;
-  confidence?: number;
-  chapters?: AutoChapter[] | null;
-  content_safety_labels?: ContentSafetyLabels;
-  entities?: Entity[];
-  iab_categories_result?: TopicDetection;
-  auto_highlights_result?: AutoHighlights;
-  summary?: string;
-  sentiment_analysis_results?: SentimentAnalysis[];
-
-  /**
-   * @deprecated Acoustic Model is deprecated and will be removed in a future release
-   */
-  acoustic_model?: unknown;
-
-  /**
-   * @deprecated Speed Boost is deprecated and will be removed in a future release
-   */
-  speed_boost?: boolean;
-
-  /**
-   * @deprecated Language Model is deprecated and will be removed in a future release
-   */
-  language_model?: unknown;
-};
-
-type TranscriptFailed = TranscriptBase & {
-  status: "error";
-  id: string;
-  error?: string;
-};
-
-type Transcript =
-  | Readonly<TranscriptQueued>
-  | Readonly<TranscriptProcessing>
-  | Readonly<TranscriptCompleted>
-  | Readonly<TranscriptFailed>;
-
-type TranscriptPollingSettings = {
-  pollingInterval: number;
-  pollingTimeout: number;
-  resolver?: (transcript: Transcript) => boolean;
-};
-
-type TranscriptListInternal = {
-  page_details: PageDetails;
-  transcripts: TranscriptListItemInternal[];
-};
-
-type TranscriptListItemInternal = {
-  id: string;
-  resource_url: string;
-  status: TranscriptStatus;
-  created: string;
-  completed: string;
-  audio_url: string;
-};
-
-type TranscriptList = {
-  page_details: PageDetails;
-  transcripts: TranscriptListItem[];
-};
-
-type TranscriptListItem = {
-  id: string;
-  resource_url: string;
-  status: TranscriptStatus;
-  created: Date;
-  completed: Date;
-  audio_url: string;
-};
-
-export type {
-  Transcript,
-  TranscriptStatus,
-  TranscriptParams,
-  TranscriptList,
-  TranscriptListItem,
-  TranscriptListInternal,
-  TranscriptListItemInternal,
-  TranscriptPollingSettings,
-};

package/src/types/lemur/index.ts

@@ -1,97 +0,0 @@
-type LeMURModel = "default" | "basic";
-type LeMURContext = string | object | LeMURContext[];
-
-type LeMURBaseServiceParams = {
-  /**
-   * A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.
-   */
-  transcript_ids: string[];
-  /**
-   * The model that is used for the final prompt after compression is performed (options: "basic" and "default").
-   */
-  final_model?: LeMURModel;
-  /**
-   * Max output size in tokens. Up to 4000 allowed.
-   */
-  max_output_size?: number;
-};
-
-type SummaryParams = LeMURBaseServiceParams & {
-  /**
-   * How you want the summary to be returned. This can be any text. Examples: "TLDR", "bullet points"
-   */
-  answer_format?: string;
-  /**
-   * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
-   */
-  context?: LeMURContext;
-};
-
-type Question = {
-  /**
-   * The question you wish to ask. For more complex questions use default model.
-   */
-  question: string;
-  /**
-   * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
-   */
-  context?: LeMURContext;
-  /**
-   * How you want the answer to be returned. This can be any text. Cannot be used with answer_options. Examples: "short sentence", "bullet points"
-   */
-  answer_format?: string;
-  /**
-   * What discrete options to return. Useful for precise responses. Cannot be used with answer_format. Example: ["Yes", "No"]
-   */
-  answer_options?: string[];
-};
-
-type QuestionAnswerParams = LeMURBaseServiceParams & {
-  /**
-   * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
-   */
-  context?: LeMURContext;
-  /**
-   * 	A list of questions to ask. Question format listed below.
-   */
-  questions: Question[];
-};
-
-type ActionItemsParams = LeMURBaseServiceParams & {
-  /**
-   * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
-   */
-  context?: LeMURContext;
-};
-
-type TaskParams = LeMURBaseServiceParams & {
-  /**
-   * Your text to prompt the model to produce a desired output, including any context you want to pass into the model.
-   */
-  prompt: string;
-};
-
-type LeMURResponse = {
-  response: string;
-  request_id: string;
-};
-
-type QuestionAnswer = {
-  question: string;
-  answer: string;
-};
-
-type LeMURQuestionAnswerResponse = {
-  response: QuestionAnswer[];
-  request_id: string;
-};
-
-export type {
-  SummaryParams,
-  QuestionAnswerParams,
-  ActionItemsParams,
-  TaskParams,
-  LeMURResponse,
-  LeMURQuestionAnswerResponse,
-  LeMURBaseServiceParams,
-};

package/src/types/models/auto_chapter.ts

@@ -1,9 +0,0 @@
-type AutoChapter = {
-  summary: string;
-  headline: string;
-  gist: string;
-  start: number;
-  end: number;
-};
-
-export type { AutoChapter };

package/src/types/models/auto_highlights.ts

@@ -1,14 +0,0 @@
-import { ModelResultStatus } from "./shared";
-
-type AutoHighlightsResult = {
-  text: string;
-  count: number;
-  rank: number;
-};
-
-type AutoHighlights = {
-  status: ModelResultStatus;
-  results: AutoHighlightsResult[];
-};
-
-export type { AutoHighlights };

package/src/types/models/content_safety.ts

@@ -1,34 +0,0 @@
-import { ModelResultStatus, ModelSummary } from "./shared";
-import { Timestamp } from "@/types/shared";
-
-type ContentSafetyLabel = {
-  label: string;
-  confidence: number;
-  severity: number | null;
-};
-
-type ContentSafetyResult = {
-  text: string;
-  labels: ContentSafetyLabel[];
-  timestamp: Timestamp;
-};
-
-type ContentSafetySeverityScore = {
-  low: number;
-  medium: number;
-  high: number;
-};
-
-type ContentSafetySeverityScoreSummary = Record<
-  string,
-  ContentSafetySeverityScore
->;
-
-type ContentSafetyLabels = {
-  status: ModelResultStatus;
-  results: ContentSafetyResult[];
-  summary: ModelSummary;
-  severity_score_summary: ContentSafetySeverityScoreSummary;
-};
-
-export type { ContentSafetyLabels };

package/src/types/models/entity_detection.ts

@@ -1,8 +0,0 @@
-type Entity = {
-  entity_type: string;
-  text: string;
-  start: number;
-  end: number;
-};
-
-export type { Entity };

package/src/types/models/index.ts

@@ -1,8 +0,0 @@
-export type * from "./auto_chapter";
-export type * from "./auto_highlights";
-export type * from "./content_safety";
-export type * from "./entity_detection";
-export type * from "./pii";
-export type * from "./sentiment_analysis";
-export type * from "./summarization";
-export type * from "./topic_detection";

package/src/types/models/pii.ts

@@ -1,32 +0,0 @@
-type PIIRedactionPolicies =
-  | "medical_process"
-  | "medical_condition"
-  | "blood_type"
-  | "drug"
-  | "injury"
-  | "number_sequence"
-  | "email_address"
-  | "date_of_birth"
-  | "phone_number"
-  | "us_social_security_number"
-  | "credit_card_number"
-  | "credit_card_expiration"
-  | "credit_card_cvv"
-  | "date"
-  | "nationality"
-  | "event"
-  | "language"
-  | "location"
-  | "money_amount"
-  | "person_name"
-  | "person_age"
-  | "organization"
-  | "political_affiliation"
-  | "occupation"
-  | "religion"
-  | "drivers_license"
-  | "banking_information";
-
-type PIIAudioQuality = "mp3" | "wav";
-
-export type { PIIRedactionPolicies, PIIAudioQuality };

package/src/types/models/sentiment_analysis.ts

@@ -1,11 +0,0 @@
-type Sentiment = "NEUTRAL" | "POSITIVE" | "NEGATIVE";
-
-type SentimentAnalysis = {
-  text: string;
-  start: number;
-  end: number;
-  sentiment: Sentiment;
-  confidence: number;
-};
-
-export type { SentimentAnalysis };

package/src/types/models/shared.ts

@@ -1,4 +0,0 @@
-type ModelResultStatus = "success" | "error";
-type ModelSummary = Record<string, number>;
-
-export type { ModelResultStatus, ModelSummary };

package/src/types/models/summarization.ts

@@ -1,10 +0,0 @@
-type SummaryType =
-  | "bullets"
-  | "bullets_verbose"
-  | "gist"
-  | "headline"
-  | "paragraph";
-
-type SummaryModel = "informative" | "conversational" | "catchy";
-
-export type { SummaryType, SummaryModel };

package/src/types/models/topic_detection.ts

@@ -1,21 +0,0 @@
-import { ModelResultStatus, ModelSummary } from "./shared";
-import { Timestamp } from "@/types/shared";
-
-type TopicDetectionLabel = {
-  relevance: number;
-  label: string;
-};
-
-type TopicDetectionResults = {
-  text: string;
-  labels: TopicDetectionLabel[];
-  timestamp: Timestamp;
-};
-
-type TopicDetection = {
-  status: ModelResultStatus;
-  results: TopicDetectionResults[];
-  summary: ModelSummary;
-};
-
-export type { TopicDetection };

package/src/types/shared/index.ts

@@ -1,2 +0,0 @@
-export type * from "./pagination";
-export type * from "./timestamp";

package/src/types/shared/pagination.ts

@@ -1,8 +0,0 @@
-type PageDetails = {
-  limit: number;
-  result_count: number;
-  next_url: string | null;
-  previous_url: string | null;
-};
-
-export type { PageDetails };

package/src/types/shared/timestamp.ts

@@ -1,6 +0,0 @@
-type Timestamp = {
-  start: number;
-  end: number;
-};
-
-export type { Timestamp };