@humeai/audio-decisions 0.1.0 → 0.2.0

package/dist/esm/api/resources/decisions/client/Client.mjs

@@ -79,7 +79,7 @@ export class DecisionsClient {
      *                     criteria: ["Not at all", "2", "3", "4", "Extremely"]
      *                 },
      *                 "agent_glitches": {
-     *                     type: "moment",
+     *                     type: "span",
      *                     instructions: "Where does the agent glitch, slur or sound robotic?"
      *                 }
      *             }
@@ -156,7 +156,7 @@ export class DecisionsClient {
      *             context: "A clip from a licensed corpus of scripted speech by consenting voice actors, being labeled to train an expressive text-to-speech model.",
      *             questions: {
      *                 "vocal_bursts": {
-     *                     type: "moment",
+     *                     type: "span",
      *                     instructions: "Where does the speaker laugh, sigh, gasp or make another vocal burst?"
      *                 }
      *             }
@@ -331,7 +331,7 @@ export class DecisionsClient {
      *                 criteria: ["Not at all", "2", "3", "4", "Extremely"]
      *             },
      *             "agent_glitches": {
-     *                 type: "moment",
+     *                 type: "span",
      *                 instructions: "Where does the agent glitch, slur or sound robotic?"
      *             }
      *         }
@@ -446,7 +446,7 @@ export class DecisionsClient {
     /**
      * Cuts a recording longer than `create` accepts into chunks and sends each chunk to the model in its own `create` request. The recording is never sent as one file. The model processes each chunk independently, hearing only that chunk, so every answer describes its chunk alone and nothing combines the answers across chunks. Each request has its own `runId` and its own billing. Each chunk's result is yielded as soon as its request is done, so it can be saved or reported before the next chunk is sent.
      *
-     * The chunks are cut by `iterAudioChunks` in `@humeai/audio-decisions/audio-helpers`, which describes where cuts fall in MP3 and WAV files and how each option works, and are sent one at a time, in order. Each request asks the same questions with the same context. A moment's times are measured from the start of its chunk, so add the chunk's `startMs` to place it in the recording.
+     * The chunks are cut by `iterAudioChunks` in `@humeai/audio-decisions/audio-helpers`, which describes where cuts fall in MP3 and WAV files and how each option works, and are sent one at a time, in order. Each request asks the same questions with the same context. A span's times are measured from the start of its chunk, so add the chunk's `startMs` to place it in the recording.
      *
      * The whole recording is read into memory before the first request, so that a file that cannot be split is rejected before anything is sent and billed. A WAV file is mixed down before it is cut, as `downmixStrategy` asks. Each chunk is copied only while its request is sent, so memory use stays near the size of the recording and its mixed-down copy. An hour of 16-bit stereo WAV at 48 kHz is about 690 MB, and about 230 MB once mixed down.
      *
@@ -467,7 +467,7 @@ export class DecisionsClient {
      *         request: {
      *             questions: {
      *                 "agent_glitches": {
-     *                     type: "moment",
+     *                     type: "span",
      *                     instructions: "Where does the agent glitch, slur or sound robotic?"
      *                 }
      *             }
@@ -504,7 +504,7 @@ export class DecisionsClient {
      *         request: {
      *             questions: {
      *                 "agent_glitches": {
-     *                     type: "moment",
+     *                     type: "span",
      *                     instructions: "Where does the agent glitch, slur or sound robotic?"
      *                 }
      *             }

package/dist/esm/api/resources/decisions/client/requests/DecisionsUpload.d.mts

@@ -31,7 +31,7 @@ import type * as Decisions from "../../../../index.mjs";
  *                     criteria: ["Not at all", "2", "3", "4", "Extremely"]
  *                 },
  *                 "agent_glitches": {
- *                     type: "moment",
+ *                     type: "span",
  *                     instructions: "Where does the agent glitch, slur or sound robotic?"
  *                 }
  *             }
@@ -104,7 +104,7 @@ import type * as Decisions from "../../../../index.mjs";
  *             context: "A clip from a licensed corpus of scripted speech by consenting voice actors, being labeled to train an expressive text-to-speech model.",
  *             questions: {
  *                 "vocal_bursts": {
- *                     type: "moment",
+ *                     type: "span",
  *                     instructions: "Where does the speaker laugh, sigh, gasp or make another vocal burst?"
  *                 }
  *             }

package/dist/esm/api/resources/decisions/client/requests/InputTokensRequest.d.mts

@@ -29,7 +29,7 @@ import type * as Decisions from "../../../../index.mjs";
  *                 criteria: ["Not at all", "2", "3", "4", "Extremely"]
  *             },
  *             "agent_glitches": {
- *                 type: "moment",
+ *                 type: "span",
  *                 instructions: "Where does the agent glitch, slur or sound robotic?"
  *             }
  *         }

package/dist/esm/api/types/Answer.d.mts

@@ -2,7 +2,7 @@ import type * as Decisions from "../index.mjs";
 /**
  * The answer to one question. `type` names the question's primitive and determines the answer's fields. Treat an unrecognized `type` as unknown rather than as an error.
  */
-export type Answer = Decisions.Answer.Noul | Decisions.Answer.Choice | Decisions.Answer.Score | Decisions.Answer.Moment;
+export type Answer = Decisions.Answer.Noul | Decisions.Answer.Choice | Decisions.Answer.Score | Decisions.Answer.Span;
 export declare namespace Answer {
     interface Noul extends Decisions.NoulAnswer {
         type: "noul";
@@ -13,7 +13,7 @@ export declare namespace Answer {
     interface Score extends Decisions.ScoreAnswer {
         type: "score";
     }
-    interface Moment extends Decisions.MomentAnswer {
-        type: "moment";
+    interface Span extends Decisions.SpanAnswer {
+        type: "span";
     }
 }

package/dist/esm/api/types/Question.d.mts

@@ -2,7 +2,7 @@ import type * as Decisions from "../index.mjs";
 /**
  * A question. `type` names its primitive, which determines the question's options and the structure of its answer.
  */
-export type Question = Decisions.Question.Noul | Decisions.Question.Choice | Decisions.Question.Score | Decisions.Question.Moment;
+export type Question = Decisions.Question.Noul | Decisions.Question.Choice | Decisions.Question.Score | Decisions.Question.Span;
 export declare namespace Question {
     interface Noul extends Decisions.NoulQuestion {
         type: "noul";
@@ -13,7 +13,7 @@ export declare namespace Question {
     interface Score extends Decisions.ScoreQuestion {
         type: "score";
     }
-    interface Moment extends Decisions.MomentQuestion {
-        type: "moment";
+    interface Span extends Decisions.SpanQuestion {
+        type: "span";
     }
 }

package/dist/esm/api/types/Questions.d.mts

@@ -1,6 +1,6 @@
 import type * as Decisions from "../index.mjs";
 /**
- * The questions to answer: at most 20 `noul`, `choice` and `score` questions together, and at most 5 `moment` questions. Each key is a question ID you choose, such as `agent_tone`, and can be any non-empty string of up to 256 characters. The response returns each answer under the same ID.
+ * The questions to answer: at most 20 `noul`, `choice` and `score` questions together, and at most 5 `span` questions. Each key is a question ID you choose, such as `agent_tone`, and can be any non-empty string of up to 256 characters. The response returns each answer under the same ID.
  */
 export type Questions = {
     [key: string]: Decisions.Question;

package/dist/esm/api/types/Span.d.mts

@@ -0,0 +1,11 @@
+/**
+ * A span where the described event may occur.
+ */
+export interface Span {
+    /** Where the span begins, in milliseconds from the start of the audio file. */
+    audioStartMs: number;
+    /** Where the span ends, in milliseconds from the start of the audio file. */
+    audioEndMs: number;
+    /** The probability that the event occurs in the span. */
+    probability: number;
+}

package/dist/esm/api/types/SpanAnswer.d.mts

@@ -0,0 +1,8 @@
+import type * as Decisions from "../index.mjs";
+/**
+ * The answer to a `span` question.
+ */
+export interface SpanAnswer {
+    /** The spans where the described event may occur, in order of `audio_start_ms`. Overlapping candidates are merged. An empty array means the event was not found. */
+    spans: Decisions.Span[];
+}

package/dist/esm/api/types/{MomentQuestion.d.mts → SpanQuestion.d.mts}

@@ -1,7 +1,7 @@
 /**
  * Asks when an event occurs in the audio.
  */
-export interface MomentQuestion {
+export interface SpanQuestion {
     /** The question, written in natural language. */
     instructions: string;
 }

package/dist/esm/api/types/index.d.mts

@@ -10,9 +10,6 @@ export * from "./ErrorCode.mjs";
 export * from "./ErrorType.mjs";
 export * from "./GatewayError.mjs";
 export * from "./InputTokensResponse.mjs";
-export * from "./Moment.mjs";
-export * from "./MomentAnswer.mjs";
-export * from "./MomentQuestion.mjs";
 export * from "./NoulAnswer.mjs";
 export * from "./NoulCriteria.mjs";
 export * from "./NoulQuestion.mjs";
@@ -26,3 +23,6 @@ export * from "./RunSummary.mjs";
 export * from "./RunsPage.mjs";
 export * from "./ScoreAnswer.mjs";
 export * from "./ScoreQuestion.mjs";
+export * from "./Span.mjs";
+export * from "./SpanAnswer.mjs";
+export * from "./SpanQuestion.mjs";

package/dist/esm/api/types/index.mjs

@@ -10,9 +10,6 @@ export * from "./ErrorCode.mjs";
 export * from "./ErrorType.mjs";
 export * from "./GatewayError.mjs";
 export * from "./InputTokensResponse.mjs";
-export * from "./Moment.mjs";
-export * from "./MomentAnswer.mjs";
-export * from "./MomentQuestion.mjs";
 export * from "./NoulAnswer.mjs";
 export * from "./NoulCriteria.mjs";
 export * from "./NoulQuestion.mjs";
@@ -26,3 +23,6 @@ export * from "./RunSummary.mjs";
 export * from "./RunsPage.mjs";
 export * from "./ScoreAnswer.mjs";
 export * from "./ScoreQuestion.mjs";
+export * from "./Span.mjs";
+export * from "./SpanAnswer.mjs";
+export * from "./SpanQuestion.mjs";

package/dist/esm/audio-helpers/results.d.mts

@@ -7,8 +7,8 @@ interface ChunkPosition {
     /** Position of the chunk in the recording, starting at 0. */
     readonly index: number;
     /**
-     * Where the chunk starts in the recording, in milliseconds. A moment's `audioStartMs` and
-     * `audioEndMs` are measured from the start of the chunk, so add this to place the moment in the
+     * Where the chunk starts in the recording, in milliseconds. A span's `audioStartMs` and
+     * `audioEndMs` are measured from the start of the chunk, so add this to place the span in the
      * recording. The first chunk of an MP3 file can start a few tens of milliseconds before 0.
      */
     readonly startMs: number;

package/dist/esm/serialization/types/Answer.d.mts

@@ -2,12 +2,12 @@ import type * as Decisions from "../../api/index.mjs";
 import * as core from "../../core/index.mjs";
 import type * as serializers from "../index.mjs";
 import { ChoiceAnswer } from "./ChoiceAnswer.mjs";
-import { MomentAnswer } from "./MomentAnswer.mjs";
 import { NoulAnswer } from "./NoulAnswer.mjs";
 import { ScoreAnswer } from "./ScoreAnswer.mjs";
+import { SpanAnswer } from "./SpanAnswer.mjs";
 export declare const Answer: core.serialization.Schema<serializers.Answer.Raw, Decisions.Answer>;
 export declare namespace Answer {
-    type Raw = Answer.Noul | Answer.Choice | Answer.Score | Answer.Moment;
+    type Raw = Answer.Noul | Answer.Choice | Answer.Score | Answer.Span;
     interface Noul extends NoulAnswer.Raw {
         type: "noul";
     }
@@ -17,7 +17,7 @@ export declare namespace Answer {
     interface Score extends ScoreAnswer.Raw {
         type: "score";
     }
-    interface Moment extends MomentAnswer.Raw {
-        type: "moment";
+    interface Span extends SpanAnswer.Raw {
+        type: "span";
     }
 }

package/dist/esm/serialization/types/Answer.mjs

@@ -1,15 +1,15 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../core/index.mjs";
 import { ChoiceAnswer } from "./ChoiceAnswer.mjs";
-import { MomentAnswer } from "./MomentAnswer.mjs";
 import { NoulAnswer } from "./NoulAnswer.mjs";
 import { ScoreAnswer } from "./ScoreAnswer.mjs";
+import { SpanAnswer } from "./SpanAnswer.mjs";
 export const Answer = core.serialization
     .union("type", {
     noul: NoulAnswer,
     choice: ChoiceAnswer,
     score: ScoreAnswer,
-    moment: MomentAnswer,
+    span: SpanAnswer,
 })
     .transform({
     transform: (value) => value,

package/dist/esm/serialization/types/Question.d.mts

@@ -2,12 +2,12 @@ import type * as Decisions from "../../api/index.mjs";
 import * as core from "../../core/index.mjs";
 import type * as serializers from "../index.mjs";
 import { ChoiceQuestion } from "./ChoiceQuestion.mjs";
-import { MomentQuestion } from "./MomentQuestion.mjs";
 import { NoulQuestion } from "./NoulQuestion.mjs";
 import { ScoreQuestion } from "./ScoreQuestion.mjs";
+import { SpanQuestion } from "./SpanQuestion.mjs";
 export declare const Question: core.serialization.Schema<serializers.Question.Raw, Decisions.Question>;
 export declare namespace Question {
-    type Raw = Question.Noul | Question.Choice | Question.Score | Question.Moment;
+    type Raw = Question.Noul | Question.Choice | Question.Score | Question.Span;
     interface Noul extends NoulQuestion.Raw {
         type: "noul";
     }
@@ -17,7 +17,7 @@ export declare namespace Question {
     interface Score extends ScoreQuestion.Raw {
         type: "score";
     }
-    interface Moment extends MomentQuestion.Raw {
-        type: "moment";
+    interface Span extends SpanQuestion.Raw {
+        type: "span";
     }
 }

package/dist/esm/serialization/types/Question.mjs

@@ -1,15 +1,15 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../core/index.mjs";
 import { ChoiceQuestion } from "./ChoiceQuestion.mjs";
-import { MomentQuestion } from "./MomentQuestion.mjs";
 import { NoulQuestion } from "./NoulQuestion.mjs";
 import { ScoreQuestion } from "./ScoreQuestion.mjs";
+import { SpanQuestion } from "./SpanQuestion.mjs";
 export const Question = core.serialization
     .union("type", {
     noul: NoulQuestion,
     choice: ChoiceQuestion,
     score: ScoreQuestion,
-    moment: MomentQuestion,
+    span: SpanQuestion,
 })
     .transform({
     transform: (value) => value,

package/dist/esm/serialization/types/{Moment.d.mts → Span.d.mts}

@@ -1,8 +1,8 @@
 import type * as Decisions from "../../api/index.mjs";
 import * as core from "../../core/index.mjs";
 import type * as serializers from "../index.mjs";
-export declare const Moment: core.serialization.ObjectSchema<serializers.Moment.Raw, Decisions.Moment>;
-export declare namespace Moment {
+export declare const Span: core.serialization.ObjectSchema<serializers.Span.Raw, Decisions.Span>;
+export declare namespace Span {
     interface Raw {
         audio_start_ms: number;
         audio_end_ms: number;

package/dist/esm/serialization/types/{Moment.mjs → Span.mjs}

@@ -1,6 +1,6 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../core/index.mjs";
-export const Moment = core.serialization.object({
+export const Span = core.serialization.object({
     audioStartMs: core.serialization.property("audio_start_ms", core.serialization.number()),
     audioEndMs: core.serialization.property("audio_end_ms", core.serialization.number()),
     probability: core.serialization.number(),

package/dist/esm/serialization/types/SpanAnswer.d.mts

@@ -0,0 +1,10 @@
+import type * as Decisions from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { Span } from "./Span.mjs";
+export declare const SpanAnswer: core.serialization.ObjectSchema<serializers.SpanAnswer.Raw, Decisions.SpanAnswer>;
+export declare namespace SpanAnswer {
+    interface Raw {
+        spans: Span.Raw[];
+    }
+}

package/dist/esm/serialization/types/SpanAnswer.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { Span } from "./Span.mjs";
+export const SpanAnswer = core.serialization.object({
+    spans: core.serialization.list(Span),
+});

package/dist/esm/serialization/types/{MomentQuestion.d.mts → SpanQuestion.d.mts}

@@ -1,8 +1,8 @@
 import type * as Decisions from "../../api/index.mjs";
 import * as core from "../../core/index.mjs";
 import type * as serializers from "../index.mjs";
-export declare const MomentQuestion: core.serialization.ObjectSchema<serializers.MomentQuestion.Raw, Decisions.MomentQuestion>;
-export declare namespace MomentQuestion {
+export declare const SpanQuestion: core.serialization.ObjectSchema<serializers.SpanQuestion.Raw, Decisions.SpanQuestion>;
+export declare namespace SpanQuestion {
     interface Raw {
         instructions: string;
     }

package/dist/esm/serialization/types/{MomentQuestion.mjs → SpanQuestion.mjs}

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../core/index.mjs";
-export const MomentQuestion = core.serialization.object({
+export const SpanQuestion = core.serialization.object({
     instructions: core.serialization.string(),
 });

package/dist/esm/serialization/types/index.d.mts

@@ -10,9 +10,6 @@ export * from "./ErrorCode.mjs";
 export * from "./ErrorType.mjs";
 export * from "./GatewayError.mjs";
 export * from "./InputTokensResponse.mjs";
-export * from "./Moment.mjs";
-export * from "./MomentAnswer.mjs";
-export * from "./MomentQuestion.mjs";
 export * from "./NoulAnswer.mjs";
 export * from "./NoulCriteria.mjs";
 export * from "./NoulQuestion.mjs";
@@ -26,3 +23,6 @@ export * from "./RunSummary.mjs";
 export * from "./RunsPage.mjs";
 export * from "./ScoreAnswer.mjs";
 export * from "./ScoreQuestion.mjs";
+export * from "./Span.mjs";
+export * from "./SpanAnswer.mjs";
+export * from "./SpanQuestion.mjs";

package/dist/esm/serialization/types/index.mjs

@@ -10,9 +10,6 @@ export * from "./ErrorCode.mjs";
 export * from "./ErrorType.mjs";
 export * from "./GatewayError.mjs";
 export * from "./InputTokensResponse.mjs";
-export * from "./Moment.mjs";
-export * from "./MomentAnswer.mjs";
-export * from "./MomentQuestion.mjs";
 export * from "./NoulAnswer.mjs";
 export * from "./NoulCriteria.mjs";
 export * from "./NoulQuestion.mjs";
@@ -26,3 +23,6 @@ export * from "./RunSummary.mjs";
 export * from "./RunsPage.mjs";
 export * from "./ScoreAnswer.mjs";
 export * from "./ScoreQuestion.mjs";
+export * from "./Span.mjs";
+export * from "./SpanAnswer.mjs";
+export * from "./SpanQuestion.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.0";
+export declare const SDK_VERSION = "0.2.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.1.0";
+export const SDK_VERSION = "0.2.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@humeai/audio-decisions",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -58,7 +58,7 @@ await client.decisions.create({
                 criteria: ["Not at all", "2", "3", "4", "Extremely"]
             },
             "agent_glitches": {
-                type: "moment",
+                type: "span",
                 instructions: "Where does the agent glitch, slur or sound robotic?"
             }
         }
@@ -154,7 +154,7 @@ await client.decisions.inputTokens({
             criteria: ["Not at all", "2", "3", "4", "Extremely"]
         },
         "agent_glitches": {
-            type: "moment",
+            type: "span",
             instructions: "Where does the agent glitch, slur or sound robotic?"
         }
     }

package/dist/cjs/api/types/Moment.d.ts

@@ -1,11 +0,0 @@
-/**
- * A moment where the described event may occur.
- */
-export interface Moment {
-    /** Where the moment begins, in milliseconds from the start of the audio file. */
-    audioStartMs: number;
-    /** Where the moment ends, in milliseconds from the start of the audio file. */
-    audioEndMs: number;
-    /** The probability that the event occurs in the moment. */
-    probability: number;
-}

package/dist/cjs/api/types/MomentAnswer.d.ts

@@ -1,8 +0,0 @@
-import type * as Decisions from "../index.js";
-/**
- * The answer to a `moment` question.
- */
-export interface MomentAnswer {
-    /** The moments where the described event may occur, in order of `audio_start_ms`. Overlapping candidates are merged. An empty array means the event was not found. */
-    moments: Decisions.Moment[];
-}

package/dist/cjs/serialization/types/MomentAnswer.d.ts

@@ -1,10 +0,0 @@
-import type * as Decisions from "../../api/index.js";
-import * as core from "../../core/index.js";
-import type * as serializers from "../index.js";
-import { Moment } from "./Moment.js";
-export declare const MomentAnswer: core.serialization.ObjectSchema<serializers.MomentAnswer.Raw, Decisions.MomentAnswer>;
-export declare namespace MomentAnswer {
-    interface Raw {
-        moments: Moment.Raw[];
-    }
-}

package/dist/esm/api/types/Moment.d.mts

@@ -1,11 +0,0 @@
-/**
- * A moment where the described event may occur.
- */
-export interface Moment {
-    /** Where the moment begins, in milliseconds from the start of the audio file. */
-    audioStartMs: number;
-    /** Where the moment ends, in milliseconds from the start of the audio file. */
-    audioEndMs: number;
-    /** The probability that the event occurs in the moment. */
-    probability: number;
-}

package/dist/esm/api/types/MomentAnswer.d.mts

@@ -1,8 +0,0 @@
-import type * as Decisions from "../index.mjs";
-/**
- * The answer to a `moment` question.
- */
-export interface MomentAnswer {
-    /** The moments where the described event may occur, in order of `audio_start_ms`. Overlapping candidates are merged. An empty array means the event was not found. */
-    moments: Decisions.Moment[];
-}

package/dist/esm/serialization/types/MomentAnswer.d.mts

@@ -1,10 +0,0 @@
-import type * as Decisions from "../../api/index.mjs";
-import * as core from "../../core/index.mjs";
-import type * as serializers from "../index.mjs";
-import { Moment } from "./Moment.mjs";
-export declare const MomentAnswer: core.serialization.ObjectSchema<serializers.MomentAnswer.Raw, Decisions.MomentAnswer>;
-export declare namespace MomentAnswer {
-    interface Raw {
-        moments: Moment.Raw[];
-    }
-}

package/dist/esm/serialization/types/MomentAnswer.mjs

@@ -1,6 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-import * as core from "../../core/index.mjs";
-import { Moment } from "./Moment.mjs";
-export const MomentAnswer = core.serialization.object({
-    moments: core.serialization.list(Moment),
-});