@elevenlabs/elevenlabs-js 2.10.0 → 2.12.0

package/dist/api/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/dist/api/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/dist/api/client/requests/CreateUnitTestRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ElevenLabs from "../../index";
+/**
+ * @example
+ *     {
+ *         chatHistory: [{
+ *                 role: "user",
+ *                 timeInCallSecs: 1
+ *             }],
+ *         successCondition: "success_condition",
+ *         successExamples: [{
+ *                 response: "response",
+ *                 type: "success"
+ *             }],
+ *         failureExamples: [{
+ *                 response: "response",
+ *                 type: "failure"
+ *             }],
+ *         name: "name"
+ *     }
+ */
+export interface CreateUnitTestRequest {
+    chatHistory: ElevenLabs.ConversationHistoryTranscriptCommonModelInput[];
+    /** A prompt that evaluates whether the agent's response is successful. Should return True or False. */
+    successCondition: string;
+    /** Non-empty list of example responses that should be considered successful */
+    successExamples: ElevenLabs.AgentSuccessfulResponseExample[];
+    /** Non-empty list of example responses that should be considered failures */
+    failureExamples: ElevenLabs.AgentFailureResponseExample[];
+    /** How to evaluate the agent's tool call (if any). If empty, the tool call is not evaluated. */
+    toolCallParameters?: ElevenLabs.UnitTestToolCallEvaluationModelInput;
+    /** Dynamic variables to replace in the agent config during testing */
+    dynamicVariables?: Record<string, ElevenLabs.CreateUnitTestRequestDynamicVariablesValue | undefined>;
+    name: string;
+}

package/dist/api/client/requests/CreateUnitTestRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/client/requests/ListChatResponseTestsRouteRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ListChatResponseTestsRouteRequest {
+    /**
+     * Used for fetching next page. Cursor is returned in the response.
+     */
+    cursor?: string;
+    /**
+     * How many Tests to return at maximum. Can not exceed 100, defaults to 30.
+     */
+    pageSize?: number;
+    /**
+     * Search query to filter tests by name.
+     */
+    search?: string;
+}

package/dist/api/client/requests/ListChatResponseTestsRouteRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/client/requests/ListTestsByIdsRequestModel.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         testIds: ["test_id_1", "test_id_2"]
+ *     }
+ */
+export interface ListTestsByIdsRequestModel {
+    /** List of test IDs to fetch. No duplicates allowed. */
+    testIds: string[];
+}

package/dist/api/client/requests/ListTestsByIdsRequestModel.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/client/requests/ResubmitTestsRequestModel.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ElevenLabs from "../../index";
+/**
+ * @example
+ *     {
+ *         testRunIds: ["test_run_ids"],
+ *         agentId: "agent_id"
+ *     }
+ */
+export interface ResubmitTestsRequestModel {
+    /** List of test run IDs to resubmit */
+    testRunIds: string[];
+    /** Configuration overrides to use for testing. If not provided, the agent's default configuration will be used. */
+    agentConfigOverride?: ElevenLabs.AdhocAgentConfigOverrideForTestRequestModel;
+    /** Agent ID to resubmit tests for */
+    agentId: string;
+}

package/dist/api/client/requests/ResubmitTestsRequestModel.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/client/requests/RunAgentTestsRequestModel.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ElevenLabs from "../../index";
+/**
+ * @example
+ *     {
+ *         tests: [{
+ *                 testId: "test_id"
+ *             }]
+ *     }
+ */
+export interface RunAgentTestsRequestModel {
+    /** List of tests to run on the agent */
+    tests: ElevenLabs.SingleTestRunRequestModel[];
+    /** Configuration overrides to use for testing. If not provided, the agent's default configuration will be used. */
+    agentConfigOverride?: ElevenLabs.AdhocAgentConfigOverrideForTestRequestModel;
+}

package/dist/api/client/requests/RunAgentTestsRequestModel.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/client/requests/UpdateUnitTestRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ElevenLabs from "../../index";
+/**
+ * @example
+ *     {
+ *         chatHistory: [{
+ *                 role: "user",
+ *                 timeInCallSecs: 1
+ *             }],
+ *         successCondition: "success_condition",
+ *         successExamples: [{
+ *                 response: "response",
+ *                 type: "success"
+ *             }],
+ *         failureExamples: [{
+ *                 response: "response",
+ *                 type: "failure"
+ *             }],
+ *         name: "name"
+ *     }
+ */
+export interface UpdateUnitTestRequest {
+    chatHistory: ElevenLabs.ConversationHistoryTranscriptCommonModelInput[];
+    /** A prompt that evaluates whether the agent's response is successful. Should return True or False. */
+    successCondition: string;
+    /** Non-empty list of example responses that should be considered successful */
+    successExamples: ElevenLabs.AgentSuccessfulResponseExample[];
+    /** Non-empty list of example responses that should be considered failures */
+    failureExamples: ElevenLabs.AgentFailureResponseExample[];
+    /** How to evaluate the agent's tool call (if any). If empty, the tool call is not evaluated. */
+    toolCallParameters?: ElevenLabs.UnitTestToolCallEvaluationModelInput;
+    /** Dynamic variables to replace in the agent config during testing */
+    dynamicVariables?: Record<string, ElevenLabs.UpdateUnitTestRequestDynamicVariablesValue | undefined>;
+    name: string;
+}

package/dist/api/client/requests/UpdateUnitTestRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/client/requests/index.d.ts

@@ -0,0 +1,6 @@
+export { type CreateUnitTestRequest } from "./CreateUnitTestRequest";
+export { type UpdateUnitTestRequest } from "./UpdateUnitTestRequest";
+export { type ListTestsByIdsRequestModel } from "./ListTestsByIdsRequestModel";
+export { type ListChatResponseTestsRouteRequest } from "./ListChatResponseTestsRouteRequest";
+export { type RunAgentTestsRequestModel } from "./RunAgentTestsRequestModel";
+export { type ResubmitTestsRequestModel } from "./ResubmitTestsRequestModel";

package/dist/api/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./resources";
 export * from "./types";
 export * from "./errors";
+export * from "./client";

package/dist/api/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./resources"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./client"), exports);

package/dist/api/resources/conversationalAi/resources/tools/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class Tools {
     protected readonly _options: Tools.Options;
     constructor(_options?: Tools.Options);
     /**
-     * Get all available tools available in the workspace.
+     * Get all available tools in the workspace.
      *
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/api/resources/conversationalAi/resources/tools/client/Client.js

@@ -57,7 +57,7 @@ class Tools {
         this._options = _options;
     }
     /**
-     * Get all available tools available in the workspace.
+     * Get all available tools in the workspace.
      *
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/api/resources/music/client/Client.d.ts

@@ -39,6 +39,12 @@ export declare class Music {
      */
     compose(request?: ElevenLabs.BodyComposeMusicV1MusicPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
     private __compose;
+    /**
+     * Compose a song from a prompt or a composition plan.
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     */
+    composeDetailed(request?: ElevenLabs.BodyComposeMusicWithADetailedResponseV1MusicDetailedPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __composeDetailed;
     /**
      * Stream a composed song from a prompt or a composition plan.
      * @throws {@link ElevenLabs.UnprocessableEntityError}

package/dist/api/resources/music/client/Client.js

@@ -139,6 +139,73 @@ class Music {
             }
         });
     }
+    /**
+     * Compose a song from a prompt or a composition plan.
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     */
+    composeDetailed(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__composeDetailed(request, requestOptions));
+    }
+    __composeDetailed() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c;
+            const { outputFormat } = request, _body = __rest(request, ["outputFormat"]);
+            const _queryParams = {};
+            if (outputFormat != null) {
+                _queryParams["output_format"] = serializers.MusicComposeDetailedRequestOutputFormat.jsonOrThrow(outputFormat, { unrecognizedObjectKeys: "strip" });
+            }
+            const _response = yield core.fetcher({
+                url: core.url.join((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ElevenLabsEnvironment.Production, "v1/music/detailed"),
+                method: "POST",
+                headers: (0, headers_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "xi-api-key": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                queryParameters: _queryParams,
+                requestType: "json",
+                body: serializers.BodyComposeMusicWithADetailedResponseV1MusicDetailedPost.jsonOrThrow(_body, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                responseType: "streaming",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 240000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new ElevenLabs.UnprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.ElevenLabsError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ElevenLabsError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ElevenLabsTimeoutError("Timeout exceeded when calling POST /v1/music/detailed.");
+                case "unknown":
+                    throw new errors.ElevenLabsError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Stream a composed song from a prompt or a composition plan.
      * @throws {@link ElevenLabs.UnprocessableEntityError}

package/dist/api/{types → resources/music/client/requests}/BodyComposeMusicWithADetailedResponseV1MusicDetailedPost.d.ts

@@ -1,8 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as ElevenLabs from "../index";
+import * as ElevenLabs from "../../../../index";
 export interface BodyComposeMusicWithADetailedResponseV1MusicDetailedPost {
+    /**
+     * Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
+     */
+    outputFormat?: ElevenLabs.MusicComposeDetailedRequestOutputFormat;
     /** A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`. */
     prompt?: string;
     /** A music prompt. Deprecated. Use `composition_plan` instead. */

package/dist/api/resources/music/client/requests/BodyComposeMusicWithADetailedResponseV1MusicDetailedPost.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/music/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export { type BodyComposeMusicV1MusicPost } from "./BodyComposeMusicV1MusicPost";
+export { type BodyComposeMusicWithADetailedResponseV1MusicDetailedPost } from "./BodyComposeMusicWithADetailedResponseV1MusicDetailedPost";
 export { type BodyStreamComposedMusicV1MusicStreamPost } from "./BodyStreamComposedMusicV1MusicStreamPost";

package/dist/api/resources/music/types/MusicComposeDetailedRequestOutputFormat.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
+ */
+export type MusicComposeDetailedRequestOutputFormat = "mp3_22050_32" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192";
+export declare const MusicComposeDetailedRequestOutputFormat: {
+    readonly Mp32205032: "mp3_22050_32";
+    readonly Mp34410032: "mp3_44100_32";
+    readonly Mp34410064: "mp3_44100_64";
+    readonly Mp34410096: "mp3_44100_96";
+    readonly Mp344100128: "mp3_44100_128";
+    readonly Mp344100192: "mp3_44100_192";
+    readonly Pcm8000: "pcm_8000";
+    readonly Pcm16000: "pcm_16000";
+    readonly Pcm22050: "pcm_22050";
+    readonly Pcm24000: "pcm_24000";
+    readonly Pcm44100: "pcm_44100";
+    readonly Pcm48000: "pcm_48000";
+    readonly Ulaw8000: "ulaw_8000";
+    readonly Alaw8000: "alaw_8000";
+    readonly Opus4800032: "opus_48000_32";
+    readonly Opus4800064: "opus_48000_64";
+    readonly Opus4800096: "opus_48000_96";
+    readonly Opus48000128: "opus_48000_128";
+    readonly Opus48000192: "opus_48000_192";
+};

package/dist/api/resources/music/types/MusicComposeDetailedRequestOutputFormat.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MusicComposeDetailedRequestOutputFormat = void 0;
+exports.MusicComposeDetailedRequestOutputFormat = {
+    Mp32205032: "mp3_22050_32",
+    Mp34410032: "mp3_44100_32",
+    Mp34410064: "mp3_44100_64",
+    Mp34410096: "mp3_44100_96",
+    Mp344100128: "mp3_44100_128",
+    Mp344100192: "mp3_44100_192",
+    Pcm8000: "pcm_8000",
+    Pcm16000: "pcm_16000",
+    Pcm22050: "pcm_22050",
+    Pcm24000: "pcm_24000",
+    Pcm44100: "pcm_44100",
+    Pcm48000: "pcm_48000",
+    Ulaw8000: "ulaw_8000",
+    Alaw8000: "alaw_8000",
+    Opus4800032: "opus_48000_32",
+    Opus4800064: "opus_48000_64",
+    Opus4800096: "opus_48000_96",
+    Opus48000128: "opus_48000_128",
+    Opus48000192: "opus_48000_192",
+};

package/dist/api/resources/music/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./MusicComposeRequestOutputFormat";
+export * from "./MusicComposeDetailedRequestOutputFormat";
 export * from "./MusicStreamRequestOutputFormat";

package/dist/api/resources/music/types/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./MusicComposeRequestOutputFormat"), exports);
+__exportStar(require("./MusicComposeDetailedRequestOutputFormat"), exports);
 __exportStar(require("./MusicStreamRequestOutputFormat"), exports);

package/dist/api/resources/pronunciationDictionaries/client/Client.d.ts

@@ -68,12 +68,6 @@ export declare class PronunciationDictionaries {
      */
     createFromRules(request: ElevenLabs.BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPost, requestOptions?: PronunciationDictionaries.RequestOptions): core.HttpResponsePromise<ElevenLabs.AddPronunciationDictionaryResponseModel>;
     private __createFromRules;
-    /**
-     * Get a PLS file with a pronunciation dictionary version rules
-     * @throws {@link ElevenLabs.UnprocessableEntityError}
-     */
-    download(dictionaryId: string, versionId: string, requestOptions?: PronunciationDictionaries.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
-    private __download;
     /**
      * Get metadata for a pronunciation dictionary
      *
@@ -87,6 +81,26 @@ export declare class PronunciationDictionaries {
      */
     get(pronunciationDictionaryId: string, requestOptions?: PronunciationDictionaries.RequestOptions): core.HttpResponsePromise<ElevenLabs.GetPronunciationDictionaryMetadataResponse>;
     private __get;
+    /**
+     * Partially update the pronunciation dictionary without changing the version
+     *
+     * @param {string} pronunciationDictionaryId - The id of the pronunciation dictionary
+     * @param {ElevenLabs.BodyUpdatePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdPatch} request
+     * @param {PronunciationDictionaries.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.pronunciationDictionaries.update("21m00Tcm4TlvDq8ikWAM")
+     */
+    update(pronunciationDictionaryId: string, request?: ElevenLabs.BodyUpdatePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdPatch, requestOptions?: PronunciationDictionaries.RequestOptions): core.HttpResponsePromise<ElevenLabs.GetPronunciationDictionaryMetadataResponse>;
+    private __update;
+    /**
+     * Get a PLS file with a pronunciation dictionary version rules
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     */
+    download(dictionaryId: string, versionId: string, requestOptions?: PronunciationDictionaries.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __download;
     /**
      * Get a list of the pronunciation dictionaries you have access to and their metadata
      *