notdiamond 2.0.0-rc1 → 2.0.0-rc4

package/resources/routing.d.mts

@@ -1,391 +0,0 @@
-import { APIResource } from "../core/resource.mjs";
-import { APIPromise } from "../core/api-promise.mjs";
-import { type Uploadable } from "../core/uploads.mjs";
-import { RequestOptions } from "../internal/request-options.mjs";
-export declare class Routing extends APIResource {
-    /**
-     * Survey Response
-     *
-     * @example
-     * ```ts
-     * const response = await client.routing.createSurveyResponse({
-     *   constraint_priorities: 'constraint_priorities',
-     *   email: 'email',
-     *   llm_providers: 'llm_providers',
-     *   use_case_desc: 'use_case_desc',
-     *   user_id: 'user_id',
-     *   'x-token': 'x-token',
-     * });
-     * ```
-     */
-    createSurveyResponse(params: RoutingCreateSurveyResponseParams, options?: RequestOptions): APIPromise<unknown>;
-    /**
-     * Select the optimal LLM to handle your query based on Not Diamond's routing
-     * algorithm.
-     *
-     * This endpoint analyzes your messages and returns the best-suited model from your
-     * specified providers. The router considers factors like query complexity, model
-     * capabilities, cost, and latency based on your preferences.
-     *
-     * **Key Features:**
-     *
-     * - Intelligent routing across multiple LLM providers
-     * - Support for custom routers trained on your evaluation data
-     * - Optional cost/latency optimization
-     * - Function calling support for compatible models
-     * - Privacy-preserving content hashing
-     *
-     * **Usage:**
-     *
-     * 1. Pass your messages in OpenAI format (array of objects with 'role' and
-     *    'content')
-     * 2. Specify which LLM providers you want to route between
-     * 3. Optionally provide a preference_id for personalized routing
-     * 4. Receive a recommended model and session_id
-     * 5. Use the session_id to submit feedback and improve routing
-     *
-     * **Related Endpoints:**
-     *
-     * - `POST /v2/preferences/userPreferenceCreate` - Create a preference ID for
-     *   personalized routing
-     * - `POST /v2/report/metrics/feedback` - Submit feedback on routing decisions
-     * - `POST /v2/pzn/trainCustomRouter` - Train a custom router on your evaluation
-     *   data
-     *
-     * @example
-     * ```ts
-     * const response = await client.routing.selectModel({
-     *   llm_providers: [
-     *     { provider: 'openai', model: 'gpt-4o' },
-     *     {
-     *       provider: 'anthropic',
-     *       model: 'claude-3-5-sonnet-20241022',
-     *     },
-     *     { provider: 'google', model: 'gemini-1.5-pro' },
-     *   ],
-     *   messages: [
-     *     {
-     *       role: 'system',
-     *       content: 'You are a helpful assistant.',
-     *     },
-     *     {
-     *       role: 'user',
-     *       content: 'Explain quantum computing in simple terms',
-     *     },
-     *   ],
-     * });
-     * ```
-     */
-    selectModel(params: RoutingSelectModelParams, options?: RequestOptions): APIPromise<RoutingSelectModelResponse>;
-    /**
-     * Train a custom router on your evaluation data to optimize routing for your
-     * specific use case.
-     *
-     * This endpoint allows you to train a domain-specific router that learns which
-     * models perform best for different types of queries in your application. The
-     * router analyzes your evaluation dataset, clusters similar queries, and learns
-     * model performance patterns.
-     *
-     * **Training Process:**
-     *
-     * 1. Upload a CSV file with your evaluation data
-     * 2. Specify which models to route between
-     * 3. Define the evaluation metric (score column)
-     * 4. The system trains asynchronously and returns a preference_id
-     * 5. Use the preference_id in model_select() calls once training completes
-     *
-     * **Dataset Requirements:**
-     *
-     * - Format: CSV file
-     * - Minimum samples: 25 (more is better for accuracy)
-     * - Required columns:
-     *   - Prompt column (specified in prompt_column parameter)
-     *   - For each model: `{provider}/{model}/score` and `{provider}/{model}/response`
-     *
-     * **Example CSV structure:**
-     *
-     * ```
-     * prompt,openai/gpt-4o/score,openai/gpt-4o/response,anthropic/claude-3-5-sonnet-20241022/score,anthropic/claude-3-5-sonnet-20241022/response
-     * "Explain quantum computing",0.95,"Quantum computing uses...",0.87,"Quantum computers leverage..."
-     * "Write a Python function",0.82,"def my_function()...",0.91,"Here's a Python function..."
-     * ```
-     *
-     * **Model Selection:**
-     *
-     * - Specify standard models: `{"provider": "openai", "model": "gpt-4o"}`
-     * - Or custom models with pricing:
-     *   `{"provider": "custom", "model": "my-model", "is_custom": true, "input_price": 10.0, "output_price": 30.0, "context_length": 8192, "latency": 1.5}`
-     *
-     * **Training Time:**
-     *
-     * - Training is asynchronous and typically takes 5-15 minutes
-     * - Larger datasets or more models take longer
-     * - You'll receive a preference_id immediately
-     * - Check training status by attempting to use the preference_id in model_select()
-     *
-     * **Best Practices:**
-     *
-     * 1. Use diverse, representative examples from your production workload
-     * 2. Include at least 50-100 samples for best results
-     * 3. Ensure consistent evaluation metrics across all models
-     * 4. Use the same models you plan to route between in production
-     *
-     * **Related Documentation:** See
-     * https://docs.notdiamond.ai/docs/adapting-prompts-to-new-models for detailed
-     * guide.
-     *
-     * @example
-     * ```ts
-     * const response = await client.routing.trainCustomRouter({
-     *   dataset_file: fs.createReadStream('path/to/file'),
-     *   language: 'english',
-     *   llm_providers:
-     *     '[{"provider": "openai", "model": "gpt-4o"}, {"provider": "anthropic", "model": "claude-3-5-sonnet-20241022"}]',
-     *   maximize: true,
-     *   prompt_column: 'prompt',
-     * });
-     * ```
-     */
-    trainCustomRouter(body: RoutingTrainCustomRouterParams, options?: RequestOptions): APIPromise<RoutingTrainCustomRouterResponse>;
-}
-export type RoutingCreateSurveyResponseResponse = unknown;
-/**
- * Response from model selection endpoint.
- */
-export interface RoutingSelectModelResponse {
-    /**
-     * List containing the selected provider
-     */
-    providers: Array<RoutingSelectModelResponse.Provider>;
-    /**
-     * Unique session ID for this routing decision
-     */
-    session_id: string;
-}
-export declare namespace RoutingSelectModelResponse {
-    /**
-     * Selected LLM provider information.
-     */
-    interface Provider {
-        /**
-         * Model name
-         */
-        model: string;
-        /**
-         * Provider name
-         */
-        provider: string;
-    }
-}
-/**
- * Response from custom router training endpoint.
- */
-export interface RoutingTrainCustomRouterResponse {
-    /**
-     * The preference ID for the custom router. Training happens asynchronously - use
-     * this ID to check status and make routing calls once training is complete
-     */
-    preference_id: string;
-}
-export interface RoutingCreateSurveyResponseParams {
-    /**
-     * Body param:
-     */
-    constraint_priorities: string;
-    /**
-     * Body param:
-     */
-    email: string;
-    /**
-     * Body param:
-     */
-    llm_providers: string;
-    /**
-     * Body param:
-     */
-    use_case_desc: string;
-    /**
-     * Body param:
-     */
-    user_id: string;
-    /**
-     * Header param:
-     */
-    'x-token': string;
-    /**
-     * Body param:
-     */
-    additional_preferences?: string | null;
-    /**
-     * Body param:
-     */
-    dataset_file?: Uploadable | null;
-    /**
-     * Body param:
-     */
-    name?: string | null;
-    /**
-     * Body param:
-     */
-    prompt_file?: Uploadable | null;
-    /**
-     * Body param:
-     */
-    prompts?: string | null;
-}
-export interface RoutingSelectModelParams {
-    /**
-     * Body param: List of LLM providers to route between. Specify at least one
-     * provider in format {provider, model}
-     */
-    llm_providers: Array<RoutingSelectModelParams.RequestProvider | RoutingSelectModelParams.OpenRouterProvider>;
-    /**
-     * Body param: Array of message objects in OpenAI format (with 'role' and 'content'
-     * keys)
-     */
-    messages: Array<{
-        [key: string]: string | Array<unknown>;
-    }> | string;
-    /**
-     * Query param: Optional format type. Use 'openrouter' to accept and return
-     * OpenRouter-format model identifiers
-     */
-    type?: string | null;
-    /**
-     * Body param: Whether to hash message content for privacy
-     */
-    hash_content?: boolean;
-    /**
-     * Body param: Maximum number of models to consider for routing. If not specified,
-     * considers all provided models
-     */
-    max_model_depth?: number | null;
-    /**
-     * Body param: Optimization metric for model selection
-     */
-    metric?: string;
-    /**
-     * Body param: Preference ID for personalized routing. Create one via POST
-     * /v2/preferences/userPreferenceCreate
-     */
-    preference_id?: string | null;
-    /**
-     * Body param: Previous session ID to link related requests
-     */
-    previous_session?: string | null;
-    /**
-     * Body param: OpenAI-format function calling tools
-     */
-    tools?: Array<{
-        [key: string]: unknown;
-    }> | null;
-    /**
-     * Body param: Optimization tradeoff strategy. Use 'cost' to prioritize cost
-     * savings or 'latency' to prioritize speed
-     */
-    tradeoff?: string | null;
-}
-export declare namespace RoutingSelectModelParams {
-    /**
-     * Model for specifying an LLM provider in API requests.
-     */
-    interface RequestProvider {
-        /**
-         * Model name (e.g., 'gpt-4o', 'claude-3-5-sonnet-20241022')
-         */
-        model: string;
-        /**
-         * Provider name (e.g., 'openai', 'anthropic', 'google')
-         */
-        provider: string;
-        /**
-         * Maximum context length for the model (required for custom models)
-         */
-        context_length?: number | null;
-        /**
-         * Input token price per million tokens in USD (required for custom models)
-         */
-        input_price?: number | null;
-        /**
-         * Whether this is a custom model not in Not Diamond's supported model list
-         */
-        is_custom?: boolean;
-        /**
-         * Average latency in seconds (required for custom models)
-         */
-        latency?: number | null;
-        /**
-         * Output token price per million tokens in USD (required for custom models)
-         */
-        output_price?: number | null;
-    }
-    /**
-     * Model for specifying an LLM provider using OpenRouter format.
-     */
-    interface OpenRouterProvider {
-        /**
-         * OpenRouter model identifier in format 'provider/model'
-         */
-        model: string;
-        /**
-         * Maximum context length for the model (required for custom models)
-         */
-        context_length?: number | null;
-        /**
-         * Input token price per million tokens in USD (required for custom models)
-         */
-        input_price?: number | null;
-        /**
-         * Whether this is a custom model not in Not Diamond's supported model list
-         */
-        is_custom?: boolean;
-        /**
-         * Average latency in seconds (required for custom models)
-         */
-        latency?: number | null;
-        /**
-         * Output token price per million tokens in USD (required for custom models)
-         */
-        output_price?: number | null;
-    }
-}
-export interface RoutingTrainCustomRouterParams {
-    /**
-     * CSV file containing evaluation data with prompt column and score/response
-     * columns for each model
-     */
-    dataset_file: Uploadable;
-    /**
-     * Language of the evaluation data. Use 'english' for English-only data or
-     * 'multilingual' for multi-language support
-     */
-    language: string;
-    /**
-     * JSON string array of LLM providers to train the router on. Format:
-     * '[{"provider": "openai", "model": "gpt-4o"}, {"provider": "anthropic", "model":
-     * "claude-3-5-sonnet-20241022"}]'
-     */
-    llm_providers: string;
-    /**
-     * Whether higher scores are better. Set to true if higher scores indicate better
-     * performance, false otherwise
-     */
-    maximize: boolean;
-    /**
-     * Name of the column in the CSV file that contains the prompts
-     */
-    prompt_column: string;
-    /**
-     * Whether to override an existing custom router for this preference_id
-     */
-    override?: boolean | null;
-    /**
-     * Optional preference ID to update an existing router. If not provided, a new
-     * preference will be created
-     */
-    preference_id?: string | null;
-}
-export declare namespace Routing {
-    export { type RoutingCreateSurveyResponseResponse as RoutingCreateSurveyResponseResponse, type RoutingSelectModelResponse as RoutingSelectModelResponse, type RoutingTrainCustomRouterResponse as RoutingTrainCustomRouterResponse, type RoutingCreateSurveyResponseParams as RoutingCreateSurveyResponseParams, type RoutingSelectModelParams as RoutingSelectModelParams, type RoutingTrainCustomRouterParams as RoutingTrainCustomRouterParams, };
-}
-//# sourceMappingURL=routing.d.mts.map

package/resources/routing.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"routing.d.mts","sourceRoot":"","sources":["../src/resources/routing.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAClB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAWtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,WAAW,CACT,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAKzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACH,iBAAiB,CACf,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAMhD;AAED,MAAM,MAAM,mCAAmC,GAAG,OAAO,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAEtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,aAAa,EAAE,KAAK,CAClB,wBAAwB,CAAC,eAAe,GAAG,wBAAwB,CAAC,kBAAkB,CACvF,CAAC;IAEF;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC,GAAG,MAAM,CAAC;IAErE;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;IAED;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,YAAY,EAAE,UAAU,CAAC;IAEzB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}