langsmith 0.7.8 → 0.7.10

package/dist/_openapi_client/resources/datasets/versions.js

@@ -0,0 +1,19 @@
+// @ts-nocheck
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from '../../core/resource.js';
+import { OffsetPaginationTopLevelArray, } from '../../core/pagination.js';
+import { path } from '../../internal/utils/path.js';
+export class Versions extends APIResource {
+    /**
+     * Get dataset versions.
+     */
+    list(datasetID, query = {}, options) {
+        return this._client.getAPIList(path `/api/v1/datasets/${datasetID}/versions`, (OffsetPaginationTopLevelArray), { query, ...options });
+    }
+    /**
+     * Get diff between two dataset versions.
+     */
+    retrieveDiff(datasetID, query, options) {
+        return this._client.get(path `/api/v1/datasets/${datasetID}/versions/diff`, { query, ...options });
+    }
+}

package/dist/_openapi_client/resources/evaluators.cjs

@@ -0,0 +1,15 @@
+"use strict";
+// @ts-nocheck
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Evaluators = void 0;
+const resource_js_1 = require("../core/resource.cjs");
+class Evaluators extends resource_js_1.APIResource {
+    /**
+     * List all run rules.
+     */
+    list(query = {}, options) {
+        return this._client.get('/api/v1/runs/rules', { query, ...options });
+    }
+}
+exports.Evaluators = Evaluators;

package/dist/_openapi_client/resources/evaluators.d.ts

@@ -0,0 +1,125 @@
+import { APIResource } from '../core/resource.js';
+import { APIPromise } from '../core/api-promise.js';
+import { RequestOptions } from '../internal/request-options.js';
+export declare class Evaluators extends APIResource {
+    /**
+     * List all run rules.
+     */
+    list(query?: EvaluatorListParams | null | undefined, options?: RequestOptions): APIPromise<EvaluatorListResponse>;
+}
+export interface CodeEvaluatorTopLevel {
+    code: string;
+    language?: 'python' | 'javascript' | null;
+}
+/**
+ * Run rules schema.
+ */
+export interface Evaluator {
+    id: string;
+    created_at: string;
+    display_name: string;
+    evaluator_version: number;
+    sampling_rate: number;
+    tenant_id: string;
+    updated_at: string;
+    webhooks: Array<EvaluatorWebhook> | null;
+    add_to_annotation_queue_id?: string | null;
+    add_to_annotation_queue_name?: string | null;
+    add_to_dataset_id?: string | null;
+    add_to_dataset_name?: string | null;
+    add_to_dataset_prefer_correction?: boolean;
+    alerts?: Array<EvaluatorPagerdutyAlert> | null;
+    alignment_annotation_queue_id?: string | null;
+    backfill_completed_at?: string | null;
+    backfill_error?: string | null;
+    backfill_from?: string | null;
+    backfill_id?: string | null;
+    backfill_progress?: number | null;
+    backfill_status?: string | null;
+    code_evaluators?: Array<CodeEvaluatorTopLevel> | null;
+    corrections_dataset_id?: string | null;
+    dataset_id?: string | null;
+    dataset_name?: string | null;
+    evaluator_id?: string | null;
+    evaluators?: Array<EvaluatorTopLevel> | null;
+    extend_evaluator_trace_retention?: boolean | null;
+    extend_only?: boolean;
+    filter?: string | null;
+    group_by?: 'thread_id' | null;
+    include_extended_stats?: boolean;
+    is_enabled?: boolean;
+    num_few_shot_examples?: number | null;
+    session_id?: string | null;
+    session_name?: string | null;
+    spend_limit?: Evaluator.SpendLimit | null;
+    spend_usd?: number | null;
+    trace_count?: number | null;
+    trace_filter?: string | null;
+    transient?: boolean;
+    tree_filter?: string | null;
+    use_corrections_dataset?: boolean;
+}
+export declare namespace Evaluator {
+    interface SpendLimit {
+        limit_usd: string;
+        window: 'weekly';
+    }
+}
+export interface EvaluatorPagerdutyAlert {
+    routing_key: string;
+    /**
+     * Enum for severity.
+     */
+    severity?: 'critical' | 'warning' | 'error' | 'info' | null;
+    summary?: string | null;
+    /**
+     * Enum for alert types.
+     */
+    type?: 'pagerduty' | null;
+}
+export interface EvaluatorTopLevel {
+    /**
+     * Evaluator structured output schema.
+     */
+    structured: EvaluatorTopLevel.Structured;
+}
+export declare namespace EvaluatorTopLevel {
+    /**
+     * Evaluator structured output schema.
+     */
+    interface Structured {
+        hub_ref?: string | null;
+        model?: {
+            [key: string]: unknown;
+        } | null;
+        playground_settings_id?: string | null;
+        prompt?: Array<Array<unknown>> | null;
+        schema?: {
+            [key: string]: unknown;
+        } | null;
+        template_format?: string | null;
+        variable_mapping?: {
+            [key: string]: string;
+        } | null;
+    }
+}
+export interface EvaluatorWebhook {
+    url: string;
+    headers?: {
+        [key: string]: string;
+    } | null;
+}
+export type EvaluatorListResponse = Array<Evaluator>;
+export interface EvaluatorListParams {
+    id?: Array<string> | null;
+    dataset_id?: string | null;
+    evaluator_id?: string | null;
+    include_backfill_progress?: boolean;
+    name_contains?: string | null;
+    session_id?: string | null;
+    tag_value_id?: Array<string> | null;
+    type?: 'session' | 'dataset' | null;
+}
+export declare namespace Evaluators {
+    export { type CodeEvaluatorTopLevel as CodeEvaluatorTopLevel, type Evaluator as Evaluator, type EvaluatorPagerdutyAlert as EvaluatorPagerdutyAlert, type EvaluatorTopLevel as EvaluatorTopLevel, type EvaluatorWebhook as EvaluatorWebhook, type EvaluatorListResponse as EvaluatorListResponse, type EvaluatorListParams as EvaluatorListParams, };
+}

package/dist/_openapi_client/resources/evaluators.js

@@ -0,0 +1,11 @@
+// @ts-nocheck
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from '../core/resource.js';
+export class Evaluators extends APIResource {
+    /**
+     * List all run rules.
+     */
+    list(query = {}, options) {
+        return this._client.get('/api/v1/runs/rules', { query, ...options });
+    }
+}

package/dist/_openapi_client/resources/examples/bulk.cjs

@@ -0,0 +1,24 @@
+"use strict";
+// @ts-nocheck
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bulk = void 0;
+const resource_js_1 = require("../../core/resource.cjs");
+class Bulk extends resource_js_1.APIResource {
+    /**
+     * Create bulk examples.
+     */
+    create(params, options) {
+        const { body } = params;
+        return this._client.post('/api/v1/examples/bulk', { body: body, ...options });
+    }
+    /**
+     * Legacy update examples in bulk. For update involving attachments, use PATCH
+     * /v1/platform/datasets/{dataset_id}/examples instead.
+     */
+    patchAll(params, options) {
+        const { body } = params;
+        return this._client.patch('/api/v1/examples/bulk', { body: body, ...options });
+    }
+}
+exports.Bulk = Bulk;

package/dist/_openapi_client/resources/examples/bulk.d.ts

@@ -0,0 +1,78 @@
+import { APIResource } from '../../core/resource.js';
+import * as ExamplesAPI from './examples.js';
+import { APIPromise } from '../../core/api-promise.js';
+import { RequestOptions } from '../../internal/request-options.js';
+export declare class Bulk extends APIResource {
+    /**
+     * Create bulk examples.
+     */
+    create(params: BulkCreateParams, options?: RequestOptions): APIPromise<BulkCreateResponse>;
+    /**
+     * Legacy update examples in bulk. For update involving attachments, use PATCH
+     * /v1/platform/datasets/{dataset_id}/examples instead.
+     */
+    patchAll(params: BulkPatchAllParams, options?: RequestOptions): APIPromise<unknown>;
+}
+export type BulkCreateResponse = Array<ExamplesAPI.Example>;
+export type BulkPatchAllResponse = unknown;
+export interface BulkCreateParams {
+    /**
+     * Schema for a batch of examples to be created.
+     */
+    body: Array<BulkCreateParams.Body>;
+}
+export declare namespace BulkCreateParams {
+    /**
+     * Example with optional created_at to prevent duplicate versions in bulk
+     * operations.
+     */
+    interface Body {
+        dataset_id: string;
+        id?: string | null;
+        created_at?: string | null;
+        inputs?: {
+            [key: string]: unknown;
+        } | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        outputs?: {
+            [key: string]: unknown;
+        } | null;
+        source_run_id?: string | null;
+        split?: Array<string> | string | null;
+        /**
+         * Use Legacy Message Format for LLM runs
+         */
+        use_legacy_message_format?: boolean;
+        use_source_run_attachments?: Array<string>;
+        use_source_run_io?: boolean;
+    }
+}
+export interface BulkPatchAllParams {
+    body: Array<BulkPatchAllParams.Body>;
+}
+export declare namespace BulkPatchAllParams {
+    /**
+     * Bulk update class for Example (includes example id).
+     */
+    interface Body {
+        id: string;
+        attachments_operations?: ExamplesAPI.AttachmentsOperations | null;
+        dataset_id?: string | null;
+        inputs?: {
+            [key: string]: unknown;
+        } | null;
+        metadata?: {
+            [key: string]: unknown;
+        } | null;
+        outputs?: {
+            [key: string]: unknown;
+        } | null;
+        overwrite?: boolean;
+        split?: Array<string> | string | null;
+    }
+}
+export declare namespace Bulk {
+    export { type BulkCreateResponse as BulkCreateResponse, type BulkPatchAllResponse as BulkPatchAllResponse, type BulkCreateParams as BulkCreateParams, type BulkPatchAllParams as BulkPatchAllParams, };
+}

package/dist/_openapi_client/resources/examples/bulk.js

@@ -0,0 +1,20 @@
+// @ts-nocheck
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from '../../core/resource.js';
+export class Bulk extends APIResource {
+    /**
+     * Create bulk examples.
+     */
+    create(params, options) {
+        const { body } = params;
+        return this._client.post('/api/v1/examples/bulk', { body: body, ...options });
+    }
+    /**
+     * Legacy update examples in bulk. For update involving attachments, use PATCH
+     * /v1/platform/datasets/{dataset_id}/examples instead.
+     */
+    patchAll(params, options) {
+        const { body } = params;
+        return this._client.patch('/api/v1/examples/bulk', { body: body, ...options });
+    }
+}

package/dist/_openapi_client/resources/examples/examples.cjs

@@ -0,0 +1,124 @@
+"use strict";
+// @ts-nocheck
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Examples = void 0;
+const resource_js_1 = require("../../core/resource.cjs");
+const BulkAPI = __importStar(require("./bulk.cjs"));
+const bulk_js_1 = require("./bulk.cjs");
+const ValidateAPI = __importStar(require("./validate.cjs"));
+const validate_js_1 = require("./validate.cjs");
+const pagination_js_1 = require("../../core/pagination.cjs");
+const uploads_js_1 = require("../../internal/uploads.cjs");
+const path_js_1 = require("../../internal/utils/path.cjs");
+class Examples extends resource_js_1.APIResource {
+    constructor() {
+        super(...arguments);
+        Object.defineProperty(this, "bulk", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new BulkAPI.Bulk(this._client)
+        });
+        Object.defineProperty(this, "validate", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new ValidateAPI.Validate(this._client)
+        });
+    }
+    /**
+     * Create a new example.
+     */
+    create(body, options) {
+        return this._client.post('/api/v1/examples', { body, ...options });
+    }
+    /**
+     * Get a specific example.
+     */
+    retrieve(exampleID, query = {}, options) {
+        return this._client.get((0, path_js_1.path) `/api/v1/examples/${exampleID}`, { query, ...options });
+    }
+    /**
+     * Update a specific example.
+     */
+    update(exampleID, body, options) {
+        return this._client.patch((0, path_js_1.path) `/api/v1/examples/${exampleID}`, { body, ...options });
+    }
+    /**
+     * Get all examples by query params
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/api/v1/examples', (pagination_js_1.OffsetPaginationTopLevelArray), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Soft delete an example. Only deletes the example in the 'latest' version of the
+     * dataset.
+     */
+    delete(exampleID, options) {
+        return this._client.delete((0, path_js_1.path) `/api/v1/examples/${exampleID}`, options);
+    }
+    /**
+     * Soft delete examples. Only deletes the examples in the 'latest' version of the
+     * dataset.
+     */
+    deleteAll(params, options) {
+        const { example_ids } = params;
+        return this._client.delete('/api/v1/examples', { query: { example_ids }, ...options });
+    }
+    /**
+     * Count all examples by query params
+     */
+    retrieveCount(query = {}, options) {
+        return this._client.get('/api/v1/examples/count', { query, ...options });
+    }
+    /**
+     * Upload examples from a CSV file.
+     *
+     * Note: For non-csv upload, please use the POST
+     * /v1/platform/datasets/{dataset_id}/examples endpoint which provides more
+     * efficient upload.
+     */
+    uploadFromCsv(datasetID, body, options) {
+        return this._client.post((0, path_js_1.path) `/api/v1/examples/upload/${datasetID}`, (0, uploads_js_1.multipartFormRequestOptions)({ body, ...options }, this._client));
+    }
+}
+exports.Examples = Examples;
+Examples.Bulk = bulk_js_1.Bulk;
+Examples.Validate = validate_js_1.Validate;

package/dist/_openapi_client/resources/examples/examples.d.ts

@@ -0,0 +1,182 @@
+import { APIResource } from '../../core/resource.js';
+import * as BulkAPI from './bulk.js';
+import { Bulk, BulkCreateParams, BulkCreateResponse, BulkPatchAllParams, BulkPatchAllResponse } from './bulk.js';
+import * as ValidateAPI from './validate.js';
+import { ExampleValidationResult, Validate, ValidateBulkResponse } from './validate.js';
+import { APIPromise } from '../../core/api-promise.js';
+import { OffsetPaginationTopLevelArray, type OffsetPaginationTopLevelArrayParams, PagePromise } from '../../core/pagination.js';
+import { type Uploadable } from '../../core/uploads.js';
+import { RequestOptions } from '../../internal/request-options.js';
+export declare class Examples extends APIResource {
+    bulk: BulkAPI.Bulk;
+    validate: ValidateAPI.Validate;
+    /**
+     * Create a new example.
+     */
+    create(body: ExampleCreateParams, options?: RequestOptions): APIPromise<Example>;
+    /**
+     * Get a specific example.
+     */
+    retrieve(exampleID: string, query?: ExampleRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Example>;
+    /**
+     * Update a specific example.
+     */
+    update(exampleID: string, body: ExampleUpdateParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * Get all examples by query params
+     */
+    list(query?: ExampleListParams | null | undefined, options?: RequestOptions): PagePromise<ExamplesOffsetPaginationTopLevelArray, Example>;
+    /**
+     * Soft delete an example. Only deletes the example in the 'latest' version of the
+     * dataset.
+     */
+    delete(exampleID: string, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * Soft delete examples. Only deletes the examples in the 'latest' version of the
+     * dataset.
+     */
+    deleteAll(params: ExampleDeleteAllParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * Count all examples by query params
+     */
+    retrieveCount(query?: ExampleRetrieveCountParams | null | undefined, options?: RequestOptions): APIPromise<ExampleRetrieveCountResponse>;
+    /**
+     * Upload examples from a CSV file.
+     *
+     * Note: For non-csv upload, please use the POST
+     * /v1/platform/datasets/{dataset_id}/examples endpoint which provides more
+     * efficient upload.
+     */
+    uploadFromCsv(datasetID: string, body: ExampleUploadFromCsvParams, options?: RequestOptions): APIPromise<ExampleUploadFromCsvResponse>;
+}
+export type ExamplesOffsetPaginationTopLevelArray = OffsetPaginationTopLevelArray<Example>;
+export interface AttachmentsOperations {
+    /**
+     * Mapping of old attachment names to new names
+     */
+    rename?: {
+        [key: string]: string;
+    };
+    /**
+     * List of attachment names to keep
+     */
+    retain?: Array<string>;
+}
+/**
+ * Example schema.
+ */
+export interface Example {
+    id: string;
+    dataset_id: string;
+    inputs: {
+        [key: string]: unknown;
+    };
+    name: string;
+    attachment_urls?: {
+        [key: string]: unknown;
+    } | null;
+    created_at?: string;
+    metadata?: {
+        [key: string]: unknown;
+    } | null;
+    modified_at?: string | null;
+    outputs?: {
+        [key: string]: unknown;
+    } | null;
+    source_run_id?: string | null;
+}
+export type ExampleSelect = 'id' | 'created_at' | 'modified_at' | 'name' | 'dataset_id' | 'source_run_id' | 'metadata' | 'inputs' | 'outputs' | 'attachment_urls';
+export type ExampleUpdateResponse = unknown;
+export type ExampleDeleteResponse = unknown;
+export type ExampleDeleteAllResponse = unknown;
+export type ExampleRetrieveCountResponse = number;
+export type ExampleUploadFromCsvResponse = Array<Example>;
+export interface ExampleCreateParams {
+    dataset_id: string;
+    id?: string | null;
+    created_at?: string;
+    inputs?: {
+        [key: string]: unknown;
+    } | null;
+    metadata?: {
+        [key: string]: unknown;
+    } | null;
+    outputs?: {
+        [key: string]: unknown;
+    } | null;
+    source_run_id?: string | null;
+    split?: Array<string> | string | null;
+    /**
+     * Use Legacy Message Format for LLM runs
+     */
+    use_legacy_message_format?: boolean;
+    use_source_run_attachments?: Array<string>;
+    use_source_run_io?: boolean;
+}
+export interface ExampleRetrieveParams {
+    /**
+     * Only modifications made on or before this time are included. If None, the latest
+     * version of the dataset is used.
+     */
+    as_of?: (string & {}) | string;
+    dataset?: string | null;
+}
+export interface ExampleUpdateParams {
+    attachments_operations?: AttachmentsOperations | null;
+    dataset_id?: string | null;
+    inputs?: {
+        [key: string]: unknown;
+    } | null;
+    metadata?: {
+        [key: string]: unknown;
+    } | null;
+    outputs?: {
+        [key: string]: unknown;
+    } | null;
+    overwrite?: boolean;
+    split?: Array<string> | string | null;
+}
+export interface ExampleListParams extends OffsetPaginationTopLevelArrayParams {
+    id?: Array<string> | null;
+    /**
+     * Only modifications made on or before this time are included. If None, the latest
+     * version of the dataset is used.
+     */
+    as_of?: (string & {}) | string;
+    dataset?: string | null;
+    descending?: boolean | null;
+    filter?: string | null;
+    full_text_contains?: Array<string> | null;
+    metadata?: string | null;
+    order?: 'recent' | 'random' | 'recently_created' | 'id';
+    random_seed?: number | null;
+    select?: Array<ExampleSelect>;
+    splits?: Array<string> | null;
+}
+export interface ExampleDeleteAllParams {
+    example_ids: Array<string>;
+}
+export interface ExampleRetrieveCountParams {
+    id?: Array<string> | null;
+    /**
+     * Only modifications made on or before this time are included. If None, the latest
+     * version of the dataset is used.
+     */
+    as_of?: (string & {}) | string;
+    dataset?: string | null;
+    filter?: string | null;
+    full_text_contains?: Array<string> | null;
+    metadata?: string | null;
+    splits?: Array<string> | null;
+}
+export interface ExampleUploadFromCsvParams {
+    file: Uploadable;
+    input_keys: Array<string>;
+    metadata_keys?: Array<string>;
+    output_keys?: Array<string>;
+}
+export declare namespace Examples {
+    export { type AttachmentsOperations as AttachmentsOperations, type Example as Example, type ExampleSelect as ExampleSelect, type ExampleUpdateResponse as ExampleUpdateResponse, type ExampleDeleteResponse as ExampleDeleteResponse, type ExampleDeleteAllResponse as ExampleDeleteAllResponse, type ExampleRetrieveCountResponse as ExampleRetrieveCountResponse, type ExampleUploadFromCsvResponse as ExampleUploadFromCsvResponse, type ExamplesOffsetPaginationTopLevelArray as ExamplesOffsetPaginationTopLevelArray, type ExampleCreateParams as ExampleCreateParams, type ExampleRetrieveParams as ExampleRetrieveParams, type ExampleUpdateParams as ExampleUpdateParams, type ExampleListParams as ExampleListParams, type ExampleDeleteAllParams as ExampleDeleteAllParams, type ExampleRetrieveCountParams as ExampleRetrieveCountParams, type ExampleUploadFromCsvParams as ExampleUploadFromCsvParams, };
+    export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkPatchAllResponse as BulkPatchAllResponse, type BulkCreateParams as BulkCreateParams, type BulkPatchAllParams as BulkPatchAllParams, };
+    export { Validate as Validate, type ExampleValidationResult as ExampleValidationResult, type ValidateBulkResponse as ValidateBulkResponse, };
+}