@cartesia/cartesia-js 2.2.9 → 3.0.0-b4

package/src/resources/agents/metrics/results.ts

@@ -0,0 +1,196 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as CallsAPI from '../calls';
+import { APIPromise } from '../../../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { type Uploadable } from '../../../core/uploads';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Results extends APIResource {
+  /**
+   * Paginated list of metric results. Filter results using the query parameters,
+   */
+  list(
+    query: ResultListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ResultListResponsesCursorIDPage, ResultListResponse> {
+    return this._client.getAPIList('/agents/metrics/results', CursorIDPage<ResultListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Export metric results to a CSV file. This endpoint streams at most 100k results
+   * as the CSV file directly to the client. Use the optional filters to narrow down
+   * the results to export.
+   */
+  export(query: ResultExportParams | null | undefined = {}, options?: RequestOptions): APIPromise<string> {
+    return this._client.get('/agents/metrics/results/export', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'text/csv' }, options?.headers]),
+    });
+  }
+}
+
+export type ResultListResponsesCursorIDPage = CursorIDPage<ResultListResponse>;
+
+export interface ResultListResponse {
+  /**
+   * The unique identifier for the metric result.
+   */
+  id: string;
+
+  /**
+   * The identifier of the agent associated with the metric result.
+   */
+  agentId: string;
+
+  /**
+   * The identifier of the call associated with the metric result.
+   */
+  callId: string;
+
+  /**
+   * The UTC timestamp when the metric result was created.
+   */
+  createdAt: string;
+
+  /**
+   * The identifier of the deployment associated with the metric result.
+   */
+  deploymentId: string;
+
+  /**
+   * The identifier of the metric being measured.
+   */
+  metricId: string;
+
+  /**
+   * The name of the metric being measured.
+   */
+  metricName: string;
+
+  /**
+   * The raw result of the metric in a string format.
+   */
+  result: string;
+
+  /**
+   * The status of the metric result.
+   */
+  status: 'completed' | 'failed';
+
+  /**
+   * A summary of the transcript of the call.
+   */
+  summary: string;
+
+  /**
+   * The structured JSON result of the metric.
+   */
+  jsonResult?: { [key: string]: unknown } | null;
+
+  /**
+   * The identifier of the run associated with the metric result, if applicable.
+   */
+  runId?: string | null;
+
+  /**
+   * The transcript of the call.
+   */
+  transcript?: Array<CallsAPI.AgentTranscript> | null;
+
+  /**
+   * The value of the metric result.
+   */
+  value?: unknown;
+}
+
+export type ResultExportResponse = Uploadable;
+
+export interface ResultListParams extends CursorIDPageParams {
+  /**
+   * The ID of the agent.
+   */
+  agent_id?: string | null;
+
+  /**
+   * The ID of the call.
+   */
+  call_id?: string | null;
+
+  /**
+   * The ID of the deployment.
+   */
+  deployment_id?: string | null;
+
+  /**
+   * Filter metric results created before or at this ISO 8601 date/time (e.g.
+   * 2024-04-30T23:59:59Z).
+   */
+  end_date?: string | null;
+
+  /**
+   * The number of metric results to return per page, ranging between 1 and 100.
+   */
+  limit?: number | null;
+
+  /**
+   * The ID of the metric.
+   */
+  metric_id?: string | null;
+
+  /**
+   * Filter metric results created at or after this ISO 8601 date/time (e.g.
+   * 2024-04-01T00:00:00Z).
+   */
+  start_date?: string | null;
+}
+
+export interface ResultExportParams {
+  /**
+   * The ID of the agent.
+   */
+  agent_id?: string | null;
+
+  /**
+   * The ID of the call.
+   */
+  call_id?: string | null;
+
+  /**
+   * The ID of the deployment.
+   */
+  deployment_id?: string | null;
+
+  /**
+   * Filter metric results created before or at this ISO 8601 date/time (e.g.
+   * 2024-04-30T23:59:59Z).
+   */
+  end_date?: string | null;
+
+  /**
+   * The ID of the metric.
+   */
+  metric_id?: string | null;
+
+  /**
+   * Filter metric results created at or after this ISO 8601 date/time (e.g.
+   * 2024-04-01T00:00:00Z).
+   */
+  start_date?: string | null;
+}
+
+export declare namespace Results {
+  export {
+    type ResultListResponse as ResultListResponse,
+    type ResultExportResponse as ResultExportResponse,
+    type ResultListResponsesCursorIDPage as ResultListResponsesCursorIDPage,
+    type ResultListParams as ResultListParams,
+    type ResultExportParams as ResultExportParams,
+  };
+}

package/src/resources/agents/metrics.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './metrics/index';

package/src/resources/agents.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './agents/index';

package/src/resources/datasets/datasets.ts

@@ -0,0 +1,145 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as FilesAPI from './files';
+import {
+  FileDeleteParams,
+  FileListParams,
+  FileListResponse,
+  FileListResponsesCursorIDPage,
+  FileUploadParams,
+  Files,
+} from './files';
+import { APIPromise } from '../../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Datasets extends APIResource {
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+
+  /**
+   * Create a new dataset
+   */
+  create(body: DatasetCreateParams, options?: RequestOptions): APIPromise<Dataset> {
+    return this._client.post('/datasets/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific dataset by ID
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Dataset> {
+    return this._client.get(path`/datasets/${id}`, options);
+  }
+
+  /**
+   * Update an existing dataset
+   */
+  update(id: string, body: DatasetUpdateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.patch(path`/datasets/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Paginated list of datasets
+   */
+  list(
+    query: DatasetListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DatasetsCursorIDPage, Dataset> {
+    return this._client.getAPIList('/datasets/', CursorIDPage<Dataset>, { query, ...options });
+  }
+
+  /**
+   * Delete a dataset
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/datasets/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type DatasetsCursorIDPage = CursorIDPage<Dataset>;
+
+/**
+ * A collection of files used for fine-tuning models
+ */
+export interface Dataset {
+  /**
+   * Unique identifier for the dataset
+   */
+  id: string;
+
+  /**
+   * Timestamp when the dataset was created
+   */
+  created_at: string;
+
+  /**
+   * Optional description of the dataset
+   */
+  description: string;
+
+  /**
+   * Name of the dataset
+   */
+  name: string;
+}
+
+export interface DatasetCreateParams {
+  /**
+   * Optional description for the dataset
+   */
+  description: string;
+
+  /**
+   * Name for the new dataset
+   */
+  name: string;
+}
+
+export interface DatasetUpdateParams {
+  /**
+   * New description for the dataset
+   */
+  description: string;
+
+  /**
+   * New name for the dataset
+   */
+  name: string;
+}
+
+export interface DatasetListParams extends CursorIDPageParams {
+  /**
+   * The number of Datasets to return per page, ranging between 1 and 100.
+   */
+  limit?: number | null;
+}
+
+Datasets.Files = Files;
+
+export declare namespace Datasets {
+  export {
+    type Dataset as Dataset,
+    type DatasetsCursorIDPage as DatasetsCursorIDPage,
+    type DatasetCreateParams as DatasetCreateParams,
+    type DatasetUpdateParams as DatasetUpdateParams,
+    type DatasetListParams as DatasetListParams,
+  };
+
+  export {
+    Files as Files,
+    type FileListResponse as FileListResponse,
+    type FileListResponsesCursorIDPage as FileListResponsesCursorIDPage,
+    type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
+    type FileUploadParams as FileUploadParams,
+  };
+}

package/src/resources/datasets/files.ts

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../core/pagination';
+import { type Uploadable } from '../../core/uploads';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+
+export class Files extends APIResource {
+  /**
+   * Paginated list of files in a dataset
+   */
+  list(
+    id: string,
+    query: FileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FileListResponsesCursorIDPage, FileListResponse> {
+    return this._client.getAPIList(path`/datasets/${id}/files`, CursorIDPage<FileListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Remove a file from a dataset
+   */
+  delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id } = params;
+    return this._client.delete(path`/datasets/${id}/files/${fileID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Upload a new file to a dataset
+   */
+  upload(id: string, body: FileUploadParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(
+      path`/datasets/${id}/files`,
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
+  }
+}
+
+export type FileListResponsesCursorIDPage = CursorIDPage<FileListResponse>;
+
+/**
+ * File stored in a dataset
+ */
+export interface FileListResponse {
+  /**
+   * Unique identifier for the file
+   */
+  id: string;
+
+  /**
+   * Timestamp when the file was created
+   */
+  created_at: string;
+
+  /**
+   * Original filename
+   */
+  filename: string;
+
+  /**
+   * Size of the file in bytes
+   */
+  size: number;
+}
+
+export interface FileListParams extends CursorIDPageParams {
+  /**
+   * The number of files to return per page, ranging between 1 and 100.
+   */
+  limit?: number | null;
+}
+
+export interface FileDeleteParams {
+  /**
+   * ID of the dataset containing the file
+   */
+  id: string;
+}
+
+export interface FileUploadParams {
+  file?: Uploadable;
+
+  /**
+   * Purpose of the file (e.g., fine_tune)
+   */
+  purpose?: string;
+}
+
+export declare namespace Files {
+  export {
+    type FileListResponse as FileListResponse,
+    type FileListResponsesCursorIDPage as FileListResponsesCursorIDPage,
+    type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
+    type FileUploadParams as FileUploadParams,
+  };
+}

package/src/resources/datasets/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Datasets,
+  type Dataset,
+  type DatasetCreateParams,
+  type DatasetUpdateParams,
+  type DatasetListParams,
+  type DatasetsCursorIDPage,
+} from './datasets';
+export {
+  Files,
+  type FileListResponse,
+  type FileListParams,
+  type FileDeleteParams,
+  type FileUploadParams,
+  type FileListResponsesCursorIDPage,
+} from './files';

package/src/resources/datasets.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './datasets/index';

package/src/resources/fine-tunes.ts

@@ -0,0 +1,155 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as VoicesAPI from './voices';
+import { VoicesCursorIDPage } from './voices';
+import { APIPromise } from '../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class FineTunes extends APIResource {
+  /**
+   * Create a new fine-tune
+   */
+  create(body: FineTuneCreateParams, options?: RequestOptions): APIPromise<FineTune> {
+    return this._client.post('/fine-tunes/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific fine-tune by ID
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<FineTune> {
+    return this._client.get(path`/fine-tunes/${id}`, options);
+  }
+
+  /**
+   * Paginated list of all fine-tunes for the authenticated user
+   */
+  list(
+    query: FineTuneListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FineTunesCursorIDPage, FineTune> {
+    return this._client.getAPIList('/fine-tunes/', CursorIDPage<FineTune>, { query, ...options });
+  }
+
+  /**
+   * Delete a fine-tune
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/fine-tunes/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * List all voices created from a fine-tune
+   */
+  listVoices(
+    id: string,
+    query: FineTuneListVoicesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VoicesCursorIDPage, VoicesAPI.Voice> {
+    return this._client.getAPIList(path`/fine-tunes/${id}/voices`, CursorIDPage<VoicesAPI.Voice>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type FineTunesCursorIDPage = CursorIDPage<FineTune>;
+
+/**
+ * Information about a fine-tune
+ */
+export interface FineTune {
+  /**
+   * Unique identifier for the fine-tune
+   */
+  id: string;
+
+  /**
+   * ID of the dataset used for fine-tuning
+   */
+  dataset: string;
+
+  /**
+   * Description of the fine-tune
+   */
+  description: string;
+
+  /**
+   * Language code of the fine-tune
+   */
+  language: string;
+
+  /**
+   * Base model identifier to fine-tune from
+   */
+  model_id: string;
+
+  /**
+   * Name of the fine-tune
+   */
+  name: string;
+
+  /**
+   * Current status of the fine-tune
+   */
+  status: 'created' | 'training' | 'completed' | 'failed';
+}
+
+export interface FineTuneCreateParams {
+  /**
+   * Dataset ID containing training files
+   */
+  dataset: string;
+
+  /**
+   * Description for the fine-tune
+   */
+  description: string;
+
+  /**
+   * Language code for the fine-tune
+   */
+  language: string;
+
+  /**
+   * Base model ID to fine-tune from
+   */
+  model_id: string;
+
+  /**
+   * Name for the new fine-tune
+   */
+  name: string;
+}
+
+export interface FineTuneListParams extends CursorIDPageParams {
+  /**
+   * The number of fine-tunes to return per page, ranging between 1 and 100.
+   */
+  limit?: number | null;
+}
+
+export interface FineTuneListVoicesParams extends CursorIDPageParams {
+  /**
+   * The number of voices to return per page, ranging between 1 and 100.
+   */
+  limit?: number | null;
+}
+
+export declare namespace FineTunes {
+  export {
+    type FineTune as FineTune,
+    type FineTunesCursorIDPage as FineTunesCursorIDPage,
+    type FineTuneCreateParams as FineTuneCreateParams,
+    type FineTuneListParams as FineTuneListParams,
+    type FineTuneListVoicesParams as FineTuneListVoicesParams,
+  };
+}
+
+export { type VoicesCursorIDPage };

package/src/resources/index.ts

@@ -0,0 +1,69 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { AccessToken, type AccessTokenCreateResponse, type AccessTokenCreateParams } from './access-token';
+export {
+  Agents,
+  type AgentSummary,
+  type AgentListResponse,
+  type AgentListPhoneNumbersResponse,
+  type AgentListTemplatesResponse,
+  type AgentUpdateParams,
+} from './agents/agents';
+export {
+  Datasets,
+  type Dataset,
+  type DatasetCreateParams,
+  type DatasetUpdateParams,
+  type DatasetListParams,
+  type DatasetsCursorIDPage,
+} from './datasets/datasets';
+export {
+  FineTunes,
+  type FineTune,
+  type FineTuneCreateParams,
+  type FineTuneListParams,
+  type FineTuneListVoicesParams,
+  type FineTunesCursorIDPage,
+} from './fine-tunes';
+export { Infill, type OutputFormatContainer, type RawEncoding, type InfillCreateParams } from './infill';
+export {
+  PronunciationDicts,
+  type PronunciationDict,
+  type PronunciationDictItem,
+  type PronunciationDictCreateParams,
+  type PronunciationDictUpdateParams,
+  type PronunciationDictListParams,
+  type PronunciationDictsCursorIDPage,
+} from './pronunciation-dicts';
+export { Stt, type SttTranscribeResponse, type SttTranscribeParams } from './stt';
+export {
+  TTS,
+  type GenerationConfig,
+  type GenerationRequest,
+  type ModelSpeed,
+  type RawOutputFormat,
+  type VoiceSpecifier,
+  type WebsocketClientEvent,
+  type WebsocketResponse,
+  type TTSGenerateParams,
+  type TTSGenerateSseParams,
+} from './tts';
+export {
+  VoiceChanger,
+  type VoiceChangerChangeVoiceBytesParams,
+  type VoiceChangerChangeVoiceSseParams,
+} from './voice-changer';
+export {
+  Voices,
+  type GenderPresentation,
+  type SupportedLanguage,
+  type Voice,
+  type VoiceMetadata,
+  type VoiceUpdateParams,
+  type VoiceListParams,
+  type VoiceCloneParams,
+  type VoiceGetParams,
+  type VoiceLocalizeParams,
+  type VoicesCursorIDPage,
+} from './voices';
+export { type GetStatusResponse } from './top-level';