hanzoai 0.0.1-alpha.1

package/src/resources/global/global.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SpendAPI from './spend';
+import {
+  Spend,
+  SpendListTagsParams,
+  SpendListTagsResponse,
+  SpendResetResponse,
+  SpendRetrieveReportParams,
+  SpendRetrieveReportResponse,
+} from './spend';
+
+export class Global extends APIResource {
+  spend: SpendAPI.Spend = new SpendAPI.Spend(this._client);
+}
+
+Global.Spend = Spend;
+
+export declare namespace Global {
+  export {
+    Spend as Spend,
+    type SpendListTagsResponse as SpendListTagsResponse,
+    type SpendResetResponse as SpendResetResponse,
+    type SpendRetrieveReportResponse as SpendRetrieveReportResponse,
+    type SpendListTagsParams as SpendListTagsParams,
+    type SpendRetrieveReportParams as SpendRetrieveReportParams,
+  };
+}

package/src/resources/global/index.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Global } from './global';
+export {
+  Spend,
+  type SpendListTagsResponse,
+  type SpendResetResponse,
+  type SpendRetrieveReportResponse,
+  type SpendListTagsParams,
+  type SpendRetrieveReportParams,
+} from './spend';

package/src/resources/global/spend.ts

@@ -0,0 +1,213 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+
+export class Spend extends APIResource {
+  /**
+   * LLM Enterprise - View Spend Per Request Tag. Used by LLM UI
+   *
+   * Example Request:
+   *
+   * ```
+   * curl -X GET "http://0.0.0.0:4000/spend/tags" -H "Authorization: Bearer sk-1234"
+   * ```
+   *
+   * Spend with Start Date and End Date
+   *
+   * ```
+   * curl -X GET "http://0.0.0.0:4000/spend/tags?start_date=2022-01-01&end_date=2022-02-01" -H "Authorization: Bearer sk-1234"
+   * ```
+   */
+  listTags(
+    query: SpendListTagsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SpendListTagsResponse> {
+    return this._client.get('/global/spend/tags', { query, ...options });
+  }
+
+  /**
+   * ADMIN ONLY / MASTER KEY Only Endpoint
+   *
+   * Globally reset spend for All API Keys and Teams, maintain LLM_SpendLogs
+   *
+   * 1. LLM_SpendLogs will maintain the logs on spend, no data gets deleted from
+   *    there
+   * 2. LLM_VerificationTokens spend will be set = 0
+   * 3. LLM_TeamTable spend will be set = 0
+   */
+  reset(options?: RequestOptions): APIPromise<unknown> {
+    return this._client.post('/global/spend/reset', options);
+  }
+
+  /**
+   * Get Daily Spend per Team, based on specific startTime and endTime. Per team,
+   * view usage by each key, model [ { "group-by-day": "2024-05-10", "teams": [ {
+   * "team_name": "team-1" "spend": 10, "keys": [ "key": "1213", "usage": {
+   * "model-1": { "cost": 12.50, "input_tokens": 1000, "output_tokens": 5000,
+   * "requests": 100 }, "audio-modelname1": { "cost": 25.50, "seconds": 25,
+   * "requests": 50 }, } } ] ] }
+   */
+  retrieveReport(
+    query: SpendRetrieveReportParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SpendRetrieveReportResponse> {
+    return this._client.get('/global/spend/report', { query, ...options });
+  }
+}
+
+export type SpendListTagsResponse = Array<SpendListTagsResponse.SpendListTagsResponseItem>;
+
+export namespace SpendListTagsResponse {
+  export interface SpendListTagsResponseItem {
+    api_key: string;
+
+    call_type: string;
+
+    endTime: string | (string & {}) | null;
+
+    messages: string | Array<unknown> | unknown | null;
+
+    request_id: string;
+
+    response: string | Array<unknown> | unknown | null;
+
+    startTime: string | (string & {}) | null;
+
+    api_base?: string | null;
+
+    cache_hit?: string | null;
+
+    cache_key?: string | null;
+
+    completion_tokens?: number | null;
+
+    metadata?: unknown;
+
+    model?: string | null;
+
+    prompt_tokens?: number | null;
+
+    request_tags?: unknown;
+
+    requester_ip_address?: string | null;
+
+    spend?: number | null;
+
+    total_tokens?: number | null;
+
+    user?: string | null;
+  }
+}
+
+export type SpendResetResponse = unknown;
+
+export type SpendRetrieveReportResponse = Array<SpendRetrieveReportResponse.SpendRetrieveReportResponseItem>;
+
+export namespace SpendRetrieveReportResponse {
+  export interface SpendRetrieveReportResponseItem {
+    api_key: string;
+
+    call_type: string;
+
+    endTime: string | (string & {}) | null;
+
+    messages: string | Array<unknown> | unknown | null;
+
+    request_id: string;
+
+    response: string | Array<unknown> | unknown | null;
+
+    startTime: string | (string & {}) | null;
+
+    api_base?: string | null;
+
+    cache_hit?: string | null;
+
+    cache_key?: string | null;
+
+    completion_tokens?: number | null;
+
+    metadata?: unknown;
+
+    model?: string | null;
+
+    prompt_tokens?: number | null;
+
+    request_tags?: unknown;
+
+    requester_ip_address?: string | null;
+
+    spend?: number | null;
+
+    total_tokens?: number | null;
+
+    user?: string | null;
+  }
+}
+
+export interface SpendListTagsParams {
+  /**
+   * Time till which to view key spend
+   */
+  end_date?: string | null;
+
+  /**
+   * Time from which to start viewing key spend
+   */
+  start_date?: string | null;
+
+  /**
+   * comman separated tags to filter on
+   */
+  tags?: string | null;
+}
+
+export interface SpendRetrieveReportParams {
+  /**
+   * View spend for a specific api_key. Example api_key='sk-1234
+   */
+  api_key?: string | null;
+
+  /**
+   * View spend for a specific customer_id. Example customer_id='1234. Can be used in
+   * conjunction with team_id as well.
+   */
+  customer_id?: string | null;
+
+  /**
+   * Time till which to view spend
+   */
+  end_date?: string | null;
+
+  /**
+   * Group spend by internal team or customer or api_key
+   */
+  group_by?: 'team' | 'customer' | 'api_key' | null;
+
+  /**
+   * View spend for a specific internal_user_id. Example internal_user_id='1234
+   */
+  internal_user_id?: string | null;
+
+  /**
+   * Time from which to start viewing spend
+   */
+  start_date?: string | null;
+
+  /**
+   * View spend for a specific team_id. Example team_id='1234
+   */
+  team_id?: string | null;
+}
+
+export declare namespace Spend {
+  export {
+    type SpendListTagsResponse as SpendListTagsResponse,
+    type SpendResetResponse as SpendResetResponse,
+    type SpendRetrieveReportResponse as SpendRetrieveReportResponse,
+    type SpendListTagsParams as SpendListTagsParams,
+    type SpendRetrieveReportParams as SpendRetrieveReportParams,
+  };
+}

package/src/resources/global.ts

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

package/src/resources/guardrails.ts

@@ -0,0 +1,81 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+export class Guardrails extends APIResource {
+  /**
+   * List the guardrails that are available on the proxy server
+   *
+   * 👉 [Guardrail docs](https://docs.llm.ai/docs/proxy/guardrails/quick_start)
+   *
+   * Example Request:
+   *
+   * ```bash
+   * curl -X GET "http://localhost:4000/guardrails/list" -H "Authorization: Bearer <your_api_key>"
+   * ```
+   *
+   * Example Response:
+   *
+   * ```json
+   * {
+   *   "guardrails": [
+   *     {
+   *       "guardrail_name": "bedrock-pre-guard",
+   *       "guardrail_info": {
+   *         "params": [
+   *           {
+   *             "name": "toxicity_score",
+   *             "type": "float",
+   *             "description": "Score between 0-1 indicating content toxicity level"
+   *           },
+   *           {
+   *             "name": "pii_detection",
+   *             "type": "boolean"
+   *           }
+   *         ]
+   *       }
+   *     }
+   *   ]
+   * }
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<GuardrailListResponse> {
+    return this._client.get('/guardrails/list', options);
+  }
+}
+
+export interface GuardrailListResponse {
+  guardrails: Array<GuardrailListResponse.Guardrail>;
+}
+
+export namespace GuardrailListResponse {
+  export interface Guardrail {
+    guardrail_info: unknown | null;
+
+    guardrail_name: string;
+
+    /**
+     * The returned LLM Params object for /guardrails/list
+     */
+    llm_params: Guardrail.LlmParams;
+  }
+
+  export namespace Guardrail {
+    /**
+     * The returned LLM Params object for /guardrails/list
+     */
+    export interface LlmParams {
+      guardrail: string;
+
+      mode: string | Array<string>;
+
+      default_on?: boolean;
+    }
+  }
+}
+
+export declare namespace Guardrails {
+  export { type GuardrailListResponse as GuardrailListResponse };
+}

package/src/resources/health.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 { RequestOptions } from '../internal/request-options';
+
+export class Health extends APIResource {
+  /**
+   * 🚨 USE `/health/liveliness` to health check the proxy 🚨
+   *
+   * See more 👉 https://docs.llm.ai/docs/proxy/health
+   *
+   * Check the health of all the endpoints in config.yaml
+   *
+   * To run health checks in the background, add this to config.yaml:
+   *
+   * ```
+   * general_settings:
+   *     # ... other settings
+   *     background_health_checks: True
+   * ```
+   *
+   * else, the health checks will be run on models when /health is called.
+   */
+  checkAll(
+    query: HealthCheckAllParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    return this._client.get('/health', { query, ...options });
+  }
+
+  /**
+   * Unprotected endpoint for checking if worker is alive
+   */
+  checkLiveliness(options?: RequestOptions): APIPromise<unknown> {
+    return this._client.get('/health/liveliness', options);
+  }
+
+  /**
+   * Unprotected endpoint for checking if worker is alive
+   */
+  checkLiveness(options?: RequestOptions): APIPromise<unknown> {
+    return this._client.get('/health/liveness', options);
+  }
+
+  /**
+   * Unprotected endpoint for checking if worker can receive requests
+   */
+  checkReadiness(options?: RequestOptions): APIPromise<unknown> {
+    return this._client.get('/health/readiness', options);
+  }
+
+  /**
+   * Use this admin-only endpoint to check if the service is healthy.
+   *
+   * Example:
+   *
+   * ```
+   * curl -L -X GET 'http://0.0.0.0:4000/health/services?service=datadog'     -H 'Authorization: Bearer sk-1234'
+   * ```
+   */
+  checkServices(query: HealthCheckServicesParams, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.get('/health/services', { query, ...options });
+  }
+}
+
+export type HealthCheckAllResponse = unknown;
+
+export type HealthCheckLivelinessResponse = unknown;
+
+export type HealthCheckLivenessResponse = unknown;
+
+export type HealthCheckReadinessResponse = unknown;
+
+export type HealthCheckServicesResponse = unknown;
+
+export interface HealthCheckAllParams {
+  /**
+   * Specify the model name (optional)
+   */
+  model?: string | null;
+}
+
+export interface HealthCheckServicesParams {
+  /**
+   * Specify the service being hit.
+   */
+  service:
+    | 'slack_budget_alerts'
+    | 'langfuse'
+    | 'slack'
+    | 'openmeter'
+    | 'webhook'
+    | 'email'
+    | 'braintrust'
+    | 'datadog'
+    | (string & {});
+}
+
+export declare namespace Health {
+  export {
+    type HealthCheckAllResponse as HealthCheckAllResponse,
+    type HealthCheckLivelinessResponse as HealthCheckLivelinessResponse,
+    type HealthCheckLivenessResponse as HealthCheckLivenessResponse,
+    type HealthCheckReadinessResponse as HealthCheckReadinessResponse,
+    type HealthCheckServicesResponse as HealthCheckServicesResponse,
+    type HealthCheckAllParams as HealthCheckAllParams,
+    type HealthCheckServicesParams as HealthCheckServicesParams,
+  };
+}

package/src/resources/images/generations.ts

@@ -0,0 +1,20 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+
+export class Generations extends APIResource {
+  /**
+   * Image Generation
+   */
+  create(options?: RequestOptions): APIPromise<unknown> {
+    return this._client.post('/v1/images/generations', options);
+  }
+}
+
+export type GenerationCreateResponse = unknown;
+
+export declare namespace Generations {
+  export { type GenerationCreateResponse as GenerationCreateResponse };
+}

package/src/resources/images/images.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as GenerationsAPI from './generations';
+import { GenerationCreateResponse, Generations } from './generations';
+
+export class Images extends APIResource {
+  generations: GenerationsAPI.Generations = new GenerationsAPI.Generations(this._client);
+}
+
+Images.Generations = Generations;
+
+export declare namespace Images {
+  export { Generations as Generations, type GenerationCreateResponse as GenerationCreateResponse };
+}

package/src/resources/images/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Generations, type GenerationCreateResponse } from './generations';
+export { Images } from './images';

package/src/resources/images.ts

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