@coval/sdk 0.4.6 → 0.6.0

package/src/generated/models/CovalUploadedConversationsAPISubmitUploadedConversationRequest.ts

@@ -0,0 +1,230 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+import type { CovalUploadedConversationsAPITranscriptMessage } from './CovalUploadedConversationsAPITranscriptMessage.js';
+import {
+    CovalUploadedConversationsAPITranscriptMessageFromJSON,
+    CovalUploadedConversationsAPITranscriptMessageFromJSONTyped,
+    CovalUploadedConversationsAPITranscriptMessageToJSON,
+    CovalUploadedConversationsAPITranscriptMessageToJSONTyped,
+} from './CovalUploadedConversationsAPITranscriptMessage.js';
+
+/**
+ * Request to submit an uploaded conversation for evaluation.
+ * 
+ * **Requirements:**
+ * - At least one of: `transcript`, `audio_url`, or `upload_id` must be provided
+ * - `audio_url` and `upload_id` are mutually exclusive
+ * 
+ * **Payload Size Limit:** The combined queued payload is subject to a 256 KB limit (including large `metadata` values); oversized payloads return 413 `PAYLOAD_TOO_LARGE`.
+ * 
+ * **Best Practices:**
+ * - Provide both transcript and audio_url (or upload_id) when available (enables audio metrics)
+ * - **Include `start_time` and `end_time` in transcript messages when submitting audio_url** to avoid automatic retranscription
+ * - Include `external_conversation_id` for correlation with external systems
+ * - Add metadata for conditional metrics and analytics
+ * 
+ * **Audio + Transcript Behavior:**
+ * - If you submit both `transcript` and `audio_url`:
+ *   - **WITH timing** (`start_time`/`end_time` on each message): Transcript is used as-is, audio metrics computed from timing
+ *   - **WITHOUT timing**: Audio is automatically transcribed and diarized, provided transcript is ignored for metrics
+ * 
+ * @export
+ * @interface CovalUploadedConversationsAPISubmitUploadedConversationRequest
+ */
+export interface CovalUploadedConversationsAPISubmitUploadedConversationRequest {
+    /**
+     * Conversation transcript as array of messages
+     * @type {Array<CovalUploadedConversationsAPITranscriptMessage>}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    transcript?: Array<CovalUploadedConversationsAPITranscriptMessage>;
+    /**
+     * Public or presigned HTTP/HTTPS URL to audio from any cloud provider.
+     * Every resolved address must be publicly routable. Redirects are rejected.
+     * 
+     * Raw `s3://bucket/key` URLs are limited to Coval-issued uploads in the
+     * shared or organization-specific audio bucket under
+     * `audio/<authenticated_organization_id>/`. For other storage locations,
+     * supply a presigned HTTPS URL or use `upload_id` from `POST /v1/audio:upload`.
+     * 
+     * **Audio Validation Requirements:**
+     * - **Formats**: WAV or MP3 ONLY (detected via magic bytes, not file extension)
+     * - **Channels**: Stereo (recommended) or mono. Stereo assigns speaker roles deterministically from channel position (channel 0 = agent, channel 1 = user); mono infers roles by classifying transcript content, which is typically accurate but less reliable than channel-based mapping.
+     * - **Duration**: 5 seconds minimum, 1 hour (3600 seconds) maximum
+     * - **File Size**: 200 MB maximum
+     * - **Validation**: Audio is validated BEFORE processing begins
+     * - **Rejected Formats**: MP4, M4A, FLAC, OGG, AAC, etc.
+     * 
+     * **Supported URL Formats:**
+     * - AWS S3: https://bucket.s3.amazonaws.com/...
+     * - GCP Cloud Storage: https://storage.googleapis.com/...
+     * - Azure Blob Storage: https://account.blob.core.windows.net/...
+     * - Any Public or Presigned HTTPS URL
+     * 
+     * **Validation Errors** (400 INVALID_ARGUMENT):
+     * - "Audio file is empty."
+     * - "Unsupported audio format: {format}. Only WAV and MP3 files are supported."
+     * - "Audio too short: {X} seconds. Minimum duration is 5 seconds."
+     * - "Audio too long: {X} minutes. Maximum duration is 60 minutes."
+     * - "Audio file too large: {X} MB. Maximum size is 200 MB."
+     * - "Invalid or corrupt audio file. Unable to detect audio format. Supported formats: WAV and MP3."
+     * - "Invalid or corrupt audio file. Unable to read audio metadata."
+     * - "Audio URL not found (404)" or "Failed to retrieve audio from URL"
+     * 
+     * @type {string}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    audio_url?: string;
+    /**
+     * Reference to a previously issued direct upload from `POST /v1/audio:upload`.
+     * 
+     * Use this when you've uploaded audio bytes directly via a Coval-issued
+     * presigned PUT URL. The Coval backend resolves the staged upload, validates
+     * it, and promotes it into managed recordings storage.
+     * 
+     * **Mutually exclusive** with `audio` and `audio_url` — provide exactly one
+     * audio source.
+     * 
+     * **Validation Errors:**
+     * - 404 NOT_FOUND: `upload_id` does not exist, has expired, has already been consumed,
+     *   or belongs to a different organization (404 is returned in all four cases to
+     *   avoid leaking ID existence across organizations).
+     * - 400 INVALID_ARGUMENT: Mutually exclusive audio sources provided.
+     * 
+     * @type {string}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    upload_id?: string;
+    /**
+     * List of metric IDs to evaluate (22–26 character IDs).
+     * 
+     * If not provided, uses your default metrics configured in the Coval dashboard.
+     * 
+     * @type {Array<string>}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    metrics?: Array<string>;
+    /**
+     * Custom metadata for conditional metrics and tracking.
+     * 
+     * Used for:
+     * - Triggering conditional metrics
+     * - Filtering conversations
+     * - Custom analytics and reporting
+     * 
+     * Reserved key `coval_simulation_id`: set it to the value of the
+     * `X-Coval-Simulation-Id` SIP header delivered with every inbound
+     * simulation call. Organizations that opt in to the simulation
+     * filter have submits carrying a matching platform-simulation id
+     * dropped without creating a conversation (see the 200 response).
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    metadata?: { [key: string]: any; };
+    /**
+     * Optional tags to apply to this conversation for filtering and organization.
+     * 
+     * Tags are normalized case-insensitively and stored on the uploaded
+     * conversation's backing run. Use them to group uploaded conversations
+     * by product, workflow, customer segment, or other operational slices.
+     * 
+     * @type {Array<string>}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    tags?: Array<string>;
+    /**
+     * External conversation ID from your system.
+     * 
+     * Stored as `conversation_id` in `customer_metadata` JSONField.
+     * Can be used to correlate with external systems (Twilio, Vonage, etc).
+     * 
+     * @type {string}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    external_conversation_id?: string;
+    /**
+     * When the conversation actually occurred (ISO 8601)
+     * @type {Date}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    occurred_at?: Date;
+    /**
+     * Agent resource ID (22-character ShortUUID) to associate with this conversation.
+     * 
+     * Must reference an existing agent within your organization. The agent is
+     * validated at submission time:
+     * - **400 INVALID_ARGUMENT**: Malformed ID (wrong length or characters).
+     * - **404 NOT_FOUND**: Agent does not exist or belongs to a different organization.
+     * 
+     * @type {string}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationRequest
+     */
+    agent_id?: string | null;
+}
+
+/**
+ * Check if a given object implements the CovalUploadedConversationsAPISubmitUploadedConversationRequest interface.
+ */
+export function instanceOfCovalUploadedConversationsAPISubmitUploadedConversationRequest(value: object): value is CovalUploadedConversationsAPISubmitUploadedConversationRequest {
+    return true;
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationRequestFromJSON(json: any): CovalUploadedConversationsAPISubmitUploadedConversationRequest {
+    return CovalUploadedConversationsAPISubmitUploadedConversationRequestFromJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalUploadedConversationsAPISubmitUploadedConversationRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'transcript': json['transcript'] == null ? undefined : ((json['transcript'] as Array<any>).map(CovalUploadedConversationsAPITranscriptMessageFromJSON)),
+        'audio_url': json['audio_url'] == null ? undefined : json['audio_url'],
+        'upload_id': json['upload_id'] == null ? undefined : json['upload_id'],
+        'metrics': json['metrics'] == null ? undefined : json['metrics'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'external_conversation_id': json['external_conversation_id'] == null ? undefined : json['external_conversation_id'],
+        'occurred_at': json['occurred_at'] == null ? undefined : (new Date(json['occurred_at'])),
+        'agent_id': json['agent_id'] == null ? undefined : json['agent_id'],
+    };
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationRequestToJSON(json: any): CovalUploadedConversationsAPISubmitUploadedConversationRequest {
+    return CovalUploadedConversationsAPISubmitUploadedConversationRequestToJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationRequestToJSONTyped(value?: CovalUploadedConversationsAPISubmitUploadedConversationRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'transcript': value['transcript'] == null ? undefined : ((value['transcript'] as Array<any>).map(CovalUploadedConversationsAPITranscriptMessageToJSON)),
+        'audio_url': value['audio_url'],
+        'upload_id': value['upload_id'],
+        'metrics': value['metrics'],
+        'metadata': value['metadata'],
+        'tags': value['tags'],
+        'external_conversation_id': value['external_conversation_id'],
+        'occurred_at': value['occurred_at'] == null ? value['occurred_at'] : value['occurred_at'].toISOString(),
+        'agent_id': value['agent_id'],
+    };
+}
+

package/src/generated/models/CovalUploadedConversationsAPISubmitUploadedConversationResponse.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+import type { CovalUploadedConversationsAPIUploadedConversationResource } from './CovalUploadedConversationsAPIUploadedConversationResource.js';
+import {
+    CovalUploadedConversationsAPIUploadedConversationResourceFromJSON,
+    CovalUploadedConversationsAPIUploadedConversationResourceFromJSONTyped,
+    CovalUploadedConversationsAPIUploadedConversationResourceToJSON,
+    CovalUploadedConversationsAPIUploadedConversationResourceToJSONTyped,
+} from './CovalUploadedConversationsAPIUploadedConversationResource.js';
+
+/**
+ * 
+ * @export
+ * @interface CovalUploadedConversationsAPISubmitUploadedConversationResponse
+ */
+export interface CovalUploadedConversationsAPISubmitUploadedConversationResponse {
+    /**
+     * 
+     * @type {CovalUploadedConversationsAPIUploadedConversationResource}
+     * @memberof CovalUploadedConversationsAPISubmitUploadedConversationResponse
+     */
+    uploaded_conversation: CovalUploadedConversationsAPIUploadedConversationResource;
+}
+
+/**
+ * Check if a given object implements the CovalUploadedConversationsAPISubmitUploadedConversationResponse interface.
+ */
+export function instanceOfCovalUploadedConversationsAPISubmitUploadedConversationResponse(value: object): value is CovalUploadedConversationsAPISubmitUploadedConversationResponse {
+    if (!('uploaded_conversation' in value) || value['uploaded_conversation'] === undefined) return false;
+    return true;
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationResponseFromJSON(json: any): CovalUploadedConversationsAPISubmitUploadedConversationResponse {
+    return CovalUploadedConversationsAPISubmitUploadedConversationResponseFromJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalUploadedConversationsAPISubmitUploadedConversationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'uploaded_conversation': CovalUploadedConversationsAPIUploadedConversationResourceFromJSON(json['uploaded_conversation']),
+    };
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationResponseToJSON(json: any): CovalUploadedConversationsAPISubmitUploadedConversationResponse {
+    return CovalUploadedConversationsAPISubmitUploadedConversationResponseToJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPISubmitUploadedConversationResponseToJSONTyped(value?: CovalUploadedConversationsAPISubmitUploadedConversationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'uploaded_conversation': CovalUploadedConversationsAPIUploadedConversationResourceToJSON(value['uploaded_conversation']),
+    };
+}
+

package/src/generated/models/CovalUploadedConversationsAPIToolCall.ts

@@ -0,0 +1,108 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+import type { CovalUploadedConversationsAPIToolCallFunction } from './CovalUploadedConversationsAPIToolCallFunction.js';
+import {
+    CovalUploadedConversationsAPIToolCallFunctionFromJSON,
+    CovalUploadedConversationsAPIToolCallFunctionFromJSONTyped,
+    CovalUploadedConversationsAPIToolCallFunctionToJSON,
+    CovalUploadedConversationsAPIToolCallFunctionToJSONTyped,
+} from './CovalUploadedConversationsAPIToolCallFunction.js';
+
+/**
+ * A tool call made by the assistant during a conversation.
+ * 
+ * Follows the OpenAI tool call format for compatibility with ChatGPT, GPT-4, and other LLM APIs.
+ * 
+ * @export
+ * @interface CovalUploadedConversationsAPIToolCall
+ */
+export interface CovalUploadedConversationsAPIToolCall {
+    /**
+     * Unique identifier for this tool call.
+     * 
+     * This ID is used to match tool responses back to their corresponding calls.
+     * 
+     * @type {string}
+     * @memberof CovalUploadedConversationsAPIToolCall
+     */
+    id: string;
+    /**
+     * Type of tool call (currently only 'function' is supported)
+     * @type {CovalUploadedConversationsAPIToolCallTypeEnum}
+     * @memberof CovalUploadedConversationsAPIToolCall
+     */
+    type: CovalUploadedConversationsAPIToolCallTypeEnum;
+    /**
+     * 
+     * @type {CovalUploadedConversationsAPIToolCallFunction}
+     * @memberof CovalUploadedConversationsAPIToolCall
+     */
+    _function: CovalUploadedConversationsAPIToolCallFunction;
+}
+
+
+/**
+ * @export
+ */
+export const CovalUploadedConversationsAPIToolCallTypeEnum = {
+    Function: 'function'
+} as const;
+export type CovalUploadedConversationsAPIToolCallTypeEnum = typeof CovalUploadedConversationsAPIToolCallTypeEnum[keyof typeof CovalUploadedConversationsAPIToolCallTypeEnum];
+
+
+/**
+ * Check if a given object implements the CovalUploadedConversationsAPIToolCall interface.
+ */
+export function instanceOfCovalUploadedConversationsAPIToolCall(value: object): value is CovalUploadedConversationsAPIToolCall {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('_function' in value) || value['_function'] === undefined) return false;
+    return true;
+}
+
+export function CovalUploadedConversationsAPIToolCallFromJSON(json: any): CovalUploadedConversationsAPIToolCall {
+    return CovalUploadedConversationsAPIToolCallFromJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPIToolCallFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalUploadedConversationsAPIToolCall {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': json['type'],
+        '_function': CovalUploadedConversationsAPIToolCallFunctionFromJSON(json['function']),
+    };
+}
+
+export function CovalUploadedConversationsAPIToolCallToJSON(json: any): CovalUploadedConversationsAPIToolCall {
+    return CovalUploadedConversationsAPIToolCallToJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPIToolCallToJSONTyped(value?: CovalUploadedConversationsAPIToolCall | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': value['type'],
+        'function': CovalUploadedConversationsAPIToolCallFunctionToJSON(value['_function']),
+    };
+}
+

package/src/generated/models/CovalUploadedConversationsAPIToolCallFunction.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * Function details for a tool call.
+ * 
+ * The `arguments` field contains a JSON-encoded string of the function parameters.
+ * 
+ * @export
+ * @interface CovalUploadedConversationsAPIToolCallFunction
+ */
+export interface CovalUploadedConversationsAPIToolCallFunction {
+    /**
+     * The name of the function to call
+     * @type {string}
+     * @memberof CovalUploadedConversationsAPIToolCallFunction
+     */
+    name: string;
+    /**
+     * JSON string containing the function arguments.
+     * 
+     * **Note:** This is a JSON-encoded string, not a raw object.
+     * 
+     * @type {string}
+     * @memberof CovalUploadedConversationsAPIToolCallFunction
+     */
+    arguments: string;
+}
+
+/**
+ * Check if a given object implements the CovalUploadedConversationsAPIToolCallFunction interface.
+ */
+export function instanceOfCovalUploadedConversationsAPIToolCallFunction(value: object): value is CovalUploadedConversationsAPIToolCallFunction {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('arguments' in value) || value['arguments'] === undefined) return false;
+    return true;
+}
+
+export function CovalUploadedConversationsAPIToolCallFunctionFromJSON(json: any): CovalUploadedConversationsAPIToolCallFunction {
+    return CovalUploadedConversationsAPIToolCallFunctionFromJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPIToolCallFunctionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalUploadedConversationsAPIToolCallFunction {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'arguments': json['arguments'],
+    };
+}
+
+export function CovalUploadedConversationsAPIToolCallFunctionToJSON(json: any): CovalUploadedConversationsAPIToolCallFunction {
+    return CovalUploadedConversationsAPIToolCallFunctionToJSONTyped(json, false);
+}
+
+export function CovalUploadedConversationsAPIToolCallFunctionToJSONTyped(value?: CovalUploadedConversationsAPIToolCallFunction | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'arguments': value['arguments'],
+    };
+}
+