import {z} from 'zod' export type GetApiV1UsageArgs = {workspace_uuid?: (string | null) | undefined, date_from?: (string | null) | undefined, date_to?: (string | null) | undefined, billing_cycle_uuid?: (string | null) | undefined}; export type GetApiV1UsageOptions = {baseUrl?: string | undefined, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const usageEventSchema = z.object({date: z.string(), name: z.string(), operation: z.string(), quantity: z.number().int(), eval_type: z.string().nullable().optional(), is_jailbreak: z.boolean(), modality: z.string(), has_ground_truth: z.boolean(), cost: z.union([z.number(), z.string()]), notes: z.string().nullable().optional(), eval_uuid: z.string().nullable().optional(), eval_run_uuid: z.string().nullable().optional(), workspace_uuid: z.string().nullable().optional(), unit_price: z.union([z.number(), z.string()]).optional(), price_rule_uuid: z.string().nullable().optional(), workspace_name: z.string().nullable().optional(), created_by: z.string().nullable().optional(), rule_metric: z.string().nullable().optional()}); export const pricingRuleUsageSchema = z.object({rule_name: z.string(), rule_uuid: z.string(), priority: z.number().int(), metric: z.string().nullable(), operation: z.string().nullable(), modality: z.string().nullable(), is_jailbreak: z.boolean().nullable(), has_ground_truth: z.boolean().nullable(), quantity: z.number().int(), unit_price: z.union([z.number(), z.string()]), total_cost: z.union([z.number(), z.string()])}); export const usageBreakdownSchema = z.object({tests_created: z.number().int(), total_prompts_generated: z.number().int(), score_runs_completed: z.number().int(), total_prompts_scored: z.number().int(), usage_events: z.array(usageEventSchema), pricing_rule_usage: z.array(pricingRuleUsageSchema), costs: z.record(z.string(), z.union([z.number(), z.string()])), pricing_model: z.string()}); export const workspaceGroupUsageSchema = z.object({group_name: z.string(), workspaces: z.array(z.string()), total_cost: z.union([z.number(), z.string()]), use_credits: z.boolean(), credits_used: z.union([z.number(), z.string()]).nullable().optional(), balance_remaining: z.union([z.number(), z.string()]).nullable().optional()}); export const billingCycleUsageSchema = z.object({billing_cycle_uuid: z.string(), billing_cycle_start_date: z.string(), billing_cycle_end_date: z.string(), paid_amount_usd: z.union([z.number(), z.string()]), pricing_model: z.string(), usage_breakdown: usageBreakdownSchema.nullable().optional(), pricing_rules_count: z.number().int().nullable().optional(), total_usage: z.union([z.number(), z.string()]).nullable().optional(), credits_available: z.union([z.number(), z.string()]).nullable().optional(), credits_used: z.union([z.number(), z.string()]).nullable().optional(), balance_remaining: z.union([z.number(), z.string()]).nullable().optional(), workspace_groups: z.array(workspaceGroupUsageSchema).nullable().optional()}); export const scoreRunStatus = z.enum(["record_created", "image_uploading", "scoring", "finished", "failed"]); export const testStatus = z.enum(["record_created", "generating_questions", "finished", "failed"]); export const contentType = z.enum(["text", "image", "video"]); export const exampleType = z.enum(["good", "bad"]); export const exampleOutSchema = z.object({example_uuid: z.string(), example_text: z.string(), explanation: z.string().nullable().optional(), example_type: exampleType}); export const testOutSchema = z.object({test_uuid: z.string(), test_name: z.string(), test_status: testStatus, test_type: z.string(), organization_name: z.string().nullable().optional(), num_test_questions: z.number().int().nullable().optional(), created_at: z.string(), updated_at: z.string(), test_system_prompt: z.string().nullable().optional(), test_policy: z.string().nullable().optional(), knowledge_base: z.string().nullable().optional(), additional_instructions: z.string().nullable().optional(), is_jailbreak: z.boolean().optional(), modality: contentType.optional(), test_examples: z.array(exampleOutSchema).nullable().optional()}); export const organizationOutSchema = z.object({org_uuid: z.string(), name: z.string()}); export const workspaceOutSchema = z.object({workspace_uuid: z.string().nullable().optional(), name: z.string().nullable().optional(), organization_name: z.string().nullable().optional(), organization_uuid: z.string().nullable().optional()}); export const featureFlags = z.object({enable_dashboard: z.boolean()}); export const userOutSchema = z.object({email: z.string(), organization: organizationOutSchema.nullable().optional(), workspace: workspaceOutSchema.nullable().optional(), org_admin_emails: z.array(z.string()).nullable().optional(), is_admin: z.boolean(), is_impersonating: z.boolean(), feature_flags: featureFlags}); export const scoringExampleOutSchema = z.object({example_uuid: z.string(), question_text: z.string(), answer_text: z.string(), explanation: z.string(), example_type: z.enum(["pass", "fail"])}); export const scoreRunOutSchema = z.object({score_run_uuid: z.string(), score_run_status: scoreRunStatus, test: testOutSchema, created_at: z.string(), updated_at: z.string(), remaining_score_runs: z.number().int().nullable().optional(), price: z.number(), price_adjustment_note: z.string().nullable().optional(), created_by: userOutSchema.nullable().optional(), score_run_examples: z.array(scoringExampleOutSchema).nullable().optional(), pass_rate: z.number().nullable().optional(), workspace_uuid: z.string().nullable().optional(), workspace_name: z.string().nullable().optional()}); export const usageResponseSchema = z.object({billing_cycles: z.array(billingCycleUsageSchema).nullable().optional(), free_score_runs: z.array(scoreRunOutSchema).nullable().optional(), test_type_displays: z.record(z.string(), z.string())}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get Usage * * GET /v1/usage/ * * Also accepts auth: AuthBearer */ export const getApiV1Usage = async (args: GetApiV1UsageArgs, options?: GetApiV1UsageOptions) => { const {baseUrl = "https://api.aymara.ai", fetch: fetchFn = fetch, ApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.workspace_uuid != null) query.append("workspace_uuid", String(args.workspace_uuid)) if (args.date_from != null) query.append("date_from", String(args.date_from)) if (args.date_to != null) query.append("date_to", String(args.date_to)) if (args.billing_cycle_uuid != null) query.append("billing_cycle_uuid", String(args.billing_cycle_uuid)) if (ApiKey !== undefined) headers.set("x-api-key", ApiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/usage/${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(usageResponseSchema, await res.json()) };