@humeai/audio-decisions 0.0.1 → 0.1.0

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

@@ -0,0 +1,16 @@
+import type * as Decisions from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { RunReceived } from "./RunReceived.mjs";
+import { RunStatus } from "./RunStatus.mjs";
+export declare const RunSummary: core.serialization.ObjectSchema<serializers.RunSummary.Raw, Decisions.RunSummary>;
+export declare namespace RunSummary {
+    interface Raw {
+        run_id: string;
+        user_id: string;
+        status: RunStatus.Raw;
+        started_at: string;
+        ended_at: string;
+        received: RunReceived.Raw;
+    }
+}

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

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { RunReceived } from "./RunReceived.mjs";
+import { RunStatus } from "./RunStatus.mjs";
+export const RunSummary = core.serialization.object({
+    runId: core.serialization.property("run_id", core.serialization.string()),
+    userId: core.serialization.property("user_id", core.serialization.string()),
+    status: RunStatus,
+    startedAt: core.serialization.property("started_at", core.serialization.date()),
+    endedAt: core.serialization.property("ended_at", core.serialization.date()),
+    received: RunReceived,
+});

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

@@ -0,0 +1,11 @@
+import type * as Decisions from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { RunSummary } from "./RunSummary.mjs";
+export declare const RunsPage: core.serialization.ObjectSchema<serializers.RunsPage.Raw, Decisions.RunsPage>;
+export declare namespace RunsPage {
+    interface Raw {
+        runs: RunSummary.Raw[];
+        next_cursor?: string | null;
+    }
+}

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

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { RunSummary } from "./RunSummary.mjs";
+export const RunsPage = core.serialization.object({
+    runs: core.serialization.list(RunSummary),
+    nextCursor: core.serialization.property("next_cursor", core.serialization.string().optional()),
+});

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

@@ -0,0 +1,12 @@
+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 ScoreAnswer: core.serialization.ObjectSchema<serializers.ScoreAnswer.Raw, Decisions.ScoreAnswer>;
+export declare namespace ScoreAnswer {
+    interface Raw {
+        score: number;
+        confidence: number;
+        probabilities: Record<string, number>;
+        legend: Record<string, string>;
+    }
+}

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

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+export const ScoreAnswer = core.serialization.object({
+    score: core.serialization.number(),
+    confidence: core.serialization.number(),
+    probabilities: core.serialization.record(core.serialization.string(), core.serialization.number()),
+    legend: core.serialization.record(core.serialization.string(), core.serialization.string()),
+});

package/dist/esm/serialization/types/ScoreQuestion.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";
+export declare const ScoreQuestion: core.serialization.ObjectSchema<serializers.ScoreQuestion.Raw, Decisions.ScoreQuestion>;
+export declare namespace ScoreQuestion {
+    interface Raw {
+        instructions: string;
+        criteria: string[];
+    }
+}

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

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

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

@@ -0,0 +1,28 @@
+export * from "./Answer.mjs";
+export * from "./Answers.mjs";
+export * from "./ChoiceAnswer.mjs";
+export * from "./ChoiceQuestion.mjs";
+export * from "./Criterion.mjs";
+export * from "./DecisionsRequest.mjs";
+export * from "./DecisionsResponse.mjs";
+export * from "./Error_.mjs";
+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";
+export * from "./Question.mjs";
+export * from "./Questions.mjs";
+export * from "./Received.mjs";
+export * from "./Run.mjs";
+export * from "./RunReceived.mjs";
+export * from "./RunStatus.mjs";
+export * from "./RunSummary.mjs";
+export * from "./RunsPage.mjs";
+export * from "./ScoreAnswer.mjs";
+export * from "./ScoreQuestion.mjs";

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

@@ -0,0 +1,28 @@
+export * from "./Answer.mjs";
+export * from "./Answers.mjs";
+export * from "./ChoiceAnswer.mjs";
+export * from "./ChoiceQuestion.mjs";
+export * from "./Criterion.mjs";
+export * from "./DecisionsRequest.mjs";
+export * from "./DecisionsResponse.mjs";
+export * from "./Error_.mjs";
+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";
+export * from "./Question.mjs";
+export * from "./Questions.mjs";
+export * from "./Received.mjs";
+export * from "./Run.mjs";
+export * from "./RunReceived.mjs";
+export * from "./RunStatus.mjs";
+export * from "./RunSummary.mjs";
+export * from "./RunsPage.mjs";
+export * from "./ScoreAnswer.mjs";
+export * from "./ScoreQuestion.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

@@ -0,0 +1 @@
+export const SDK_VERSION = "0.1.0";

package/package.json

@@ -1,10 +1,116 @@
 {
-  "name": "@humeai/audio-decisions",
-  "version": "0.0.1",
-  "description": "Placeholder that reserves the package name. Install 0.1.0 or later.",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/HumeAI/hume-audio-decisions-typescript-sdk.git"
-  }
+    "name": "@humeai/audio-decisions",
+    "version": "0.1.0",
+    "private": false,
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/HumeAI/hume-audio-decisions-typescript-sdk.git"
+    },
+    "license": "MIT",
+    "type": "commonjs",
+    "main": "./dist/cjs/index.js",
+    "module": "./dist/esm/index.mjs",
+    "types": "./dist/cjs/index.d.ts",
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/esm/index.d.mts",
+                "default": "./dist/esm/index.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/index.d.ts",
+                "default": "./dist/cjs/index.js"
+            },
+            "default": "./dist/cjs/index.js"
+        },
+        "./serialization": {
+            "import": {
+                "types": "./dist/esm/serialization/index.d.mts",
+                "default": "./dist/esm/serialization/index.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/serialization/index.d.ts",
+                "default": "./dist/cjs/serialization/index.js"
+            },
+            "default": "./dist/cjs/serialization/index.js"
+        },
+        "./decisions": {
+            "import": {
+                "types": "./dist/esm/api/resources/decisions/exports.d.mts",
+                "default": "./dist/esm/api/resources/decisions/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/decisions/exports.d.ts",
+                "default": "./dist/cjs/api/resources/decisions/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/decisions/exports.js"
+        },
+        "./runs": {
+            "import": {
+                "types": "./dist/esm/api/resources/runs/exports.d.mts",
+                "default": "./dist/esm/api/resources/runs/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/runs/exports.d.ts",
+                "default": "./dist/cjs/api/resources/runs/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/runs/exports.js"
+        },
+        "./audio-helpers": {
+            "import": {
+                "types": "./dist/esm/audio-helpers/index.d.mts",
+                "default": "./dist/esm/audio-helpers/index.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/audio-helpers/index.d.ts",
+                "default": "./dist/cjs/audio-helpers/index.js"
+            },
+            "default": "./dist/cjs/audio-helpers/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist",
+        "reference.md",
+        "README.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "format:check": "biome format --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "lint": "biome lint --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+        "build": "pnpm build:cjs && pnpm build:esm",
+        "build:cjs": "tsc --project ./tsconfig.cjs.json",
+        "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
+        "test": "vitest",
+        "test:unit": "vitest --project unit",
+        "test:wire": "vitest --project wire"
+    },
+    "dependencies": {},
+    "devDependencies": {
+        "webpack": "^5.105.4",
+        "ts-loader": "^9.5.4",
+        "vitest": "^4.1.1",
+        "msw": "2.11.2",
+        "@types/node": "^20.0.0",
+        "typescript": "~5.9.3",
+        "@biomejs/biome": "2.4.10"
+    },
+    "browser": {
+        "fs": false,
+        "os": false,
+        "path": false,
+        "stream": false,
+        "crypto": false
+    },
+    "packageManager": "pnpm@10.33.0",
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "sideEffects": false,
+    "description": "A TypeScript SDK for the Audio Decisions API",
+    "homepage": "https://dev.hume.ai/audio-decisions/docs/overview"
 }

package/reference.md

@@ -0,0 +1,327 @@
+# Reference
+## decisions
+<details><summary><code>client.decisions.<a href="/src/api/resources/decisions/client/Client.ts">create</a>({ ...params }) -> Decisions.DecisionsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Asks questions about one audio file and returns an answer to each, with the `run_id` of the model run that produced them. Each answer estimates how human raters would respond, so you choose the thresholds for acting on it.
+
+All the questions in a request are answered in one model inference, so an answer can change when other questions are added, removed or reordered. To compare answers across recordings, send the same questions in the same order. To evaluate several files, send one request per file.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.decisions.create({
+    file: fs.createReadStream("/path/to/your/file"),
+    request: {
+        context: "A simulated test call in which a voice AI agent helps a caller reschedule an appointment. Both voices are synthetic, and the agent speaks first.",
+        questions: {
+            "talks_over_caller": {
+                type: "noul",
+                instructions: "Does the agent talk over the caller?"
+            },
+            "agent_tone": {
+                type: "choice",
+                instructions: "Which best describes the tone of the agent?",
+                criteria: [{
+                        name: "warm",
+                        description: "Warm and friendly toward the caller"
+                    }, {
+                        name: "neutral",
+                        description: "Polite but impersonal"
+                    }, {
+                        name: "curt",
+                        description: "Short or dismissive with the caller"
+                    }]
+            },
+            "agent_naturalness": {
+                type: "score",
+                instructions: "How natural does the agent sound?",
+                criteria: ["Not at all", "2", "3", "4", "Extremely"]
+            },
+            "agent_glitches": {
+                type: "moment",
+                instructions: "Where does the agent glitch, slur or sound robotic?"
+            }
+        }
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Decisions.DecisionsUpload` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DecisionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.decisions.<a href="/src/api/resources/decisions/client/Client.ts">inputTokens</a>({ ...params }) -> Decisions.InputTokensResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Estimates the input tokens of a decisions request from its questions and the duration of its audio. The body takes the same `context` and `questions` as the `request` part of a `POST /v0/decisions/file` request, plus `audio_duration_ms`, the duration of the audio file in milliseconds.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.decisions.inputTokens({
+    audioDurationMs: 135000,
+    context: "A simulated test call in which a voice AI agent helps a caller reschedule an appointment. Both voices are synthetic, and the agent speaks first.",
+    questions: {
+        "talks_over_caller": {
+            type: "noul",
+            instructions: "Does the agent talk over the caller?"
+        },
+        "agent_tone": {
+            type: "choice",
+            instructions: "Which best describes the tone of the agent?",
+            criteria: [{
+                    name: "warm",
+                    description: "Warm and friendly toward the caller"
+                }, {
+                    name: "neutral",
+                    description: "Polite but impersonal"
+                }, {
+                    name: "curt",
+                    description: "Short or dismissive with the caller"
+                }]
+        },
+        "agent_naturalness": {
+            type: "score",
+            instructions: "How natural does the agent sound?",
+            criteria: ["Not at all", "2", "3", "4", "Extremely"]
+        },
+        "agent_glitches": {
+            type: "moment",
+            instructions: "Where does the agent glitch, slur or sound robotic?"
+        }
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Decisions.InputTokensRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DecisionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## runs
+<details><summary><code>client.runs.<a href="/src/api/resources/runs/client/Client.ts">list</a>({ ...params }) -> Decisions.RunsPage</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Your organization's runs, newest first, one page at a time. The filters combine.
+
+A run is one model inference. A successful decisions request is recorded as a run, which can take a moment to appear in this list, and under heavy load may not be recorded. A decisions request that fails before its input reaches the model, including every request rejected with a `4xx` status, has none.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.runs.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Decisions.ListRunsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RunsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.runs.<a href="/src/api/resources/runs/client/Client.ts">get</a>({ ...params }) -> Decisions.Run</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The run's status, when it started and ended, the audio it received, and the request it evaluated. The run does not include the answers.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.runs.get({
+    runId: "019a1f3c-7d2e-7b41-9c58-2e6f4a1d8b03"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Decisions.GetRunsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RunsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+