Skip to content

Commit

Permalink
Add audio events
Browse files Browse the repository at this point in the history
  • Loading branch information
mnemitz committed Mar 19, 2024
1 parent 5905b83 commit 99a25bc
Show file tree
Hide file tree
Showing 8 changed files with 185 additions and 0 deletions.
51 changes: 51 additions & 0 deletions src/types/models/audio-event-item.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/* tslint:disable */
/* eslint-disable */
/**
* OpenAPI Template
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

/**
*
* @export
* @interface AudioEventItem
*/
export interface AudioEventItem {
/**
* Input channel this event occurred on
* @type {string}
* @memberof AudioEventItem
*/
channel?: string;
/**
* Prediction confidence associated with this event
* @type {number}
* @memberof AudioEventItem
*/
confidence?: number;
/**
* Time (in seconds) at which the audio event ends
* @type {number}
* @memberof AudioEventItem
*/
end_time?: number;
/**
* Time (in seconds) at which the audio event starts
* @type {number}
* @memberof AudioEventItem
*/
start_time?: number;
/**
* Kind of audio event. E.g. music
* @type {string}
* @memberof AudioEventItem
*/
type?: string;
}
33 changes: 33 additions & 0 deletions src/types/models/audio-event-summary-item.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/* tslint:disable */
/* eslint-disable */
/**
* OpenAPI Template
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

/**
* Summary statistics for this audio event type
* @export
* @interface AudioEventSummaryItem
*/
export interface AudioEventSummaryItem {
/**
* Number of events of this type
* @type {number}
* @memberof AudioEventSummaryItem
*/
count?: number;
/**
* Total duration (in seconds) of all audio events of this type
* @type {number}
* @memberof AudioEventSummaryItem
*/
total_duration?: number;
}
27 changes: 27 additions & 0 deletions src/types/models/audio-events-config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/* tslint:disable */
/* eslint-disable */
/**
* OpenAPI Template
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

/**
*
* @export
* @interface AudioEventsConfig
*/
export interface AudioEventsConfig {
/**
*
* @type {Array<string>}
* @memberof AudioEventsConfig
*/
types?: Array<string>;
}
6 changes: 6 additions & 0 deletions src/types/models/batch-recognition-result.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ export interface BatchRecognitionResult {
* @memberof BatchRecognitionResult
*/
type: BatchRecognitionResultTypeEnum;
/**
* An indication of the volume of audio across the time period the word was spoken.
* @type {number}
* @memberof BatchRecognitionResult
*/
volume?: number;
/**
*
* @type {WrittenFormRecognitionResult}
Expand Down
4 changes: 4 additions & 0 deletions src/types/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ export * from './add-transcript';
export * from './add-translation';
export * from './alignment-config';
export * from './audio-added';
export * from './audio-event-item';
export * from './audio-event-summary-item';
export * from './audio-events-config';
export * from './audio-format';
export * from './audio-format-file';
export * from './audio-format-raw';
Expand Down Expand Up @@ -56,6 +59,7 @@ export * from './recognition-started';
export * from './retrieve-job-response';
export * from './retrieve-jobs-response';
export * from './retrieve-transcript-response';
export * from './retrieve-transcript-response-audio-event-summary';
export * from './sentiment-analysis-error';
export * from './sentiment-analysis-result';
export * from './sentiment-analysis-result-sentiment-analysis';
Expand Down
9 changes: 9 additions & 0 deletions src/types/models/job-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
import { AlignmentConfig } from './alignment-config';
// May contain unused imports in some cases
// @ts-ignore
import { AudioEventsConfig } from './audio-events-config';
// May contain unused imports in some cases
// @ts-ignore
import { BatchTranscriptionConfig } from './batch-transcription-config';
// May contain unused imports in some cases
// @ts-ignore
Expand Down Expand Up @@ -58,6 +61,12 @@ export interface JobConfig {
* @memberof JobConfig
*/
alignment_config?: AlignmentConfig;
/**
*
* @type {AudioEventsConfig}
* @memberof JobConfig
*/
audio_events_config?: AudioEventsConfig;
/**
*
* @type {object}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/* tslint:disable */
/* eslint-disable */
/**
* OpenAPI Template
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

// May contain unused imports in some cases
// @ts-ignore
import { AudioEventSummaryItem } from './audio-event-summary-item';

/**
* Summary statistics per event type, keyed by `type`, e.g. music
* @export
* @interface RetrieveTranscriptResponseAudioEventSummary
*/
export interface RetrieveTranscriptResponseAudioEventSummary {
/**
* Summary keyed by channel, only set if channel diarization is enabled
* @type {{ [key: string]: { [key: string]: AudioEventSummaryItem; }; }}
* @memberof RetrieveTranscriptResponseAudioEventSummary
*/
channels?: { [key: string]: { [key: string]: AudioEventSummaryItem } };
/**
*
* @type {{ [key: string]: AudioEventSummaryItem; }}
* @memberof RetrieveTranscriptResponseAudioEventSummary
*/
overall?: { [key: string]: AudioEventSummaryItem };
}
18 changes: 18 additions & 0 deletions src/types/models/retrieve-transcript-response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
* Do not edit the class manually.
*/

// May contain unused imports in some cases
// @ts-ignore
import { AudioEventItem } from './audio-event-item';
// May contain unused imports in some cases
// @ts-ignore
import { BatchRecognitionMetadata } from './batch-recognition-metadata';
Expand All @@ -26,6 +29,9 @@ import { Chapter } from './chapter';
import { JobInfo } from './job-info';
// May contain unused imports in some cases
// @ts-ignore
import { RetrieveTranscriptResponseAudioEventSummary } from './retrieve-transcript-response-audio-event-summary';
// May contain unused imports in some cases
// @ts-ignore
import { SentimentAnalysisResult } from './sentiment-analysis-result';
// May contain unused imports in some cases
// @ts-ignore
Expand All @@ -43,6 +49,18 @@ import { TranslationSentence } from './translation-sentence';
* @interface RetrieveTranscriptResponse
*/
export interface RetrieveTranscriptResponse {
/**
*
* @type {RetrieveTranscriptResponseAudioEventSummary}
* @memberof RetrieveTranscriptResponse
*/
audio_event_summary?: RetrieveTranscriptResponseAudioEventSummary;
/**
* Timestamped audio events, only set if `audio_events_config` is in the config
* @type {Array<AudioEventItem>}
* @memberof RetrieveTranscriptResponse
*/
audio_events?: Array<AudioEventItem>;
/**
* An array of objects that represent summarized chapters of the transcript
* @type {Array<Chapter>}
Expand Down

0 comments on commit 99a25bc

Please sign in to comment.