netra-sdk 1.0.3 → 1.0.5

package/dist/index.d.cts

@@ -110,7 +110,9 @@ declare enum Measure {
     REQUEST_COUNT = "Request Count",
     TOTAL_COST = "Total Cost",
     VIOLATIONS = "Violations",
-    TOTAL_TOKENS = "Total Tokens"
+    TOTAL_TOKENS = "Total Tokens",
+    AUDIO_DURATION = "Audio Duration",
+    CHARACTER_COUNT = "Character Count"
 }
 declare enum Aggregation {
     AVERAGE = "Average",
@@ -814,6 +816,105 @@ declare enum ConversationType {
     OUTPUT = "output"
 }
 
+/**
+ * Represents a single item in a simulation run.
+ */
+interface SimulationItem {
+    runItemId: string;
+    message: string;
+    turnId: string;
+}
+/**
+ * Response from the conversation trigger API.
+ */
+interface ConversationResponse {
+    decision: string;
+    reason?: string;
+    nextTurnId?: string;
+    nextUserMessage?: string;
+    nextRunItemId?: string;
+}
+/**
+ * Result returned from the user's task function.
+ */
+interface TaskResult {
+    message: string;
+    sessionId: string;
+}
+/**
+ * Result of a single conversation execution.
+ */
+interface ConversationResult {
+    runItemId: string;
+    success: boolean;
+    error?: string;
+    finalTurnId?: string;
+    turnId?: string;
+}
+/**
+ * Overall simulation run result.
+ */
+interface SimulationResult {
+    success: boolean;
+    completed: ConversationResult[];
+    failed: ConversationResult[];
+    totalItems: number;
+}
+
+declare abstract class BaseTask {
+    /**
+     * @param message - The input message from the simulation.
+     * @param sessionId - The Session identifier.
+     * @returns The task result containing:
+     *            - message (string): The response message from the task.
+     *            - sessionId (string): The session identifier.
+     */
+    abstract run(message: string, sessionId?: string | null): Promise<TaskResult> | TaskResult;
+}
+
+/**
+ * Public API for running multi-turn conversation simulations.
+ */
+
+interface SimulationOptions {
+    name: string;
+    datasetId: string;
+    task: BaseTask;
+    context?: Record<string, any>;
+    maxConcurrency?: number;
+}
+/**
+ * Public API for running multi-turn conversation simulations.
+ */
+declare class Simulation {
+    private _config;
+    private _client;
+    constructor(config: Config);
+    /**
+     * Run a multi-turn conversation simulation.
+     *
+     * @param options - Simulation configuration options
+     * @returns Dictionary with simulation results, or null on failure
+     */
+    runSimulation(options: SimulationOptions): Promise<SimulationResult | null>;
+    /**
+     * Async implementation of run_simulation with concurrency control.
+     */
+    private _runSimulationAsync;
+    /**
+     * Execute a multi-turn conversation for a single simulation item.
+     */
+    private _executeConversation;
+}
+
+/**
+ * Result from creating a simulation run.
+ */
+interface CreateRunResult {
+    runId: string;
+    simulationItems: SimulationItem[];
+}
+
 /**
  * Type definitions for Netra SDK
  */
@@ -1134,6 +1235,11 @@ declare class Netra {
      * Available after calling Netra.init()
      */
     static dashboard: Dashboard;
+    static simulation: Simulation;
+    /**
+     * Get the current Netra configuration
+     */
+    static getConfig(): Config;
     /**
      * Check if Netra has been initialized
      */
@@ -1237,4 +1343,4 @@ declare class Netra {
     static withBlockedSpansLocal: typeof withBlockedSpansLocal;
 }
 
-export { type ActionModel, Aggregation, type CategoricalDataPoint, ChartType, Config, ConversationType, type CreateDatasetParams, Dashboard, type DashboardData, type Dataset, type DatasetEntry, type DatasetItem, type Dimension, DimensionField, type DimensionValue, EntryStatus, Evaluation, type EvaluationScore, type EvaluatorFunction, type Filter, type FilterConfig, FilterField, FilterType, FilteringSpanExporter, GroupBy, InstrumentationSpanProcessor, type ListSpansParams, type ListTracesParams, Measure, type Metrics, Netra, NetraInstruments, type NumberResponse, Operator, type QueryDataParams, type QueryResponse, type Run, RunEntryContext, RunStatus, Scope, ScrubbingSpanProcessor, SessionSpanProcessor, type SessionUsageData, SpanType, type SpansPage, type TaskFunction, type TenantUsageData, type TestSuiteResult, type TimeRange, type TimeSeriesDataPoint, type TimeSeriesResponse, type TimeSeriesWithDimension, type TraceSpan, type TraceSummary, type TracesPage, TrialAwareOTLPExporter, Usage, type UsageModel, agent, Netra as default, metadataField, mistralAIInstrumentor, span, task, workflow };
+export { type ActionModel, Aggregation, BaseTask, type CategoricalDataPoint, ChartType, Config, type ConversationResponse, type ConversationResult, ConversationType, type CreateDatasetParams, type CreateRunResult, Dashboard, type DashboardData, type Dataset, type DatasetEntry, type DatasetItem, type Dimension, DimensionField, type DimensionValue, EntryStatus, Evaluation, type EvaluationScore, type EvaluatorFunction, type Filter, type FilterConfig, FilterField, FilterType, FilteringSpanExporter, GroupBy, InstrumentationSpanProcessor, type ListSpansParams, type ListTracesParams, Measure, type Metrics, Netra, NetraInstruments, type NumberResponse, Operator, type QueryDataParams, type QueryResponse, type Run, RunEntryContext, RunStatus, Scope, ScrubbingSpanProcessor, SessionSpanProcessor, type SessionUsageData, Simulation, type SimulationItem, type SimulationOptions, type SimulationResult, SpanType, type SpansPage, type TaskFunction, type TaskResult, type TenantUsageData, type TestSuiteResult, type TimeRange, type TimeSeriesDataPoint, type TimeSeriesResponse, type TimeSeriesWithDimension, type TraceSpan, type TraceSummary, type TracesPage, TrialAwareOTLPExporter, Usage, type UsageModel, agent, Netra as default, metadataField, mistralAIInstrumentor, span, task, workflow };

package/dist/index.d.ts

@@ -110,7 +110,9 @@ declare enum Measure {
     REQUEST_COUNT = "Request Count",
     TOTAL_COST = "Total Cost",
     VIOLATIONS = "Violations",
-    TOTAL_TOKENS = "Total Tokens"
+    TOTAL_TOKENS = "Total Tokens",
+    AUDIO_DURATION = "Audio Duration",
+    CHARACTER_COUNT = "Character Count"
 }
 declare enum Aggregation {
     AVERAGE = "Average",
@@ -814,6 +816,105 @@ declare enum ConversationType {
     OUTPUT = "output"
 }
 
+/**
+ * Represents a single item in a simulation run.
+ */
+interface SimulationItem {
+    runItemId: string;
+    message: string;
+    turnId: string;
+}
+/**
+ * Response from the conversation trigger API.
+ */
+interface ConversationResponse {
+    decision: string;
+    reason?: string;
+    nextTurnId?: string;
+    nextUserMessage?: string;
+    nextRunItemId?: string;
+}
+/**
+ * Result returned from the user's task function.
+ */
+interface TaskResult {
+    message: string;
+    sessionId: string;
+}
+/**
+ * Result of a single conversation execution.
+ */
+interface ConversationResult {
+    runItemId: string;
+    success: boolean;
+    error?: string;
+    finalTurnId?: string;
+    turnId?: string;
+}
+/**
+ * Overall simulation run result.
+ */
+interface SimulationResult {
+    success: boolean;
+    completed: ConversationResult[];
+    failed: ConversationResult[];
+    totalItems: number;
+}
+
+declare abstract class BaseTask {
+    /**
+     * @param message - The input message from the simulation.
+     * @param sessionId - The Session identifier.
+     * @returns The task result containing:
+     *            - message (string): The response message from the task.
+     *            - sessionId (string): The session identifier.
+     */
+    abstract run(message: string, sessionId?: string | null): Promise<TaskResult> | TaskResult;
+}
+
+/**
+ * Public API for running multi-turn conversation simulations.
+ */
+
+interface SimulationOptions {
+    name: string;
+    datasetId: string;
+    task: BaseTask;
+    context?: Record<string, any>;
+    maxConcurrency?: number;
+}
+/**
+ * Public API for running multi-turn conversation simulations.
+ */
+declare class Simulation {
+    private _config;
+    private _client;
+    constructor(config: Config);
+    /**
+     * Run a multi-turn conversation simulation.
+     *
+     * @param options - Simulation configuration options
+     * @returns Dictionary with simulation results, or null on failure
+     */
+    runSimulation(options: SimulationOptions): Promise<SimulationResult | null>;
+    /**
+     * Async implementation of run_simulation with concurrency control.
+     */
+    private _runSimulationAsync;
+    /**
+     * Execute a multi-turn conversation for a single simulation item.
+     */
+    private _executeConversation;
+}
+
+/**
+ * Result from creating a simulation run.
+ */
+interface CreateRunResult {
+    runId: string;
+    simulationItems: SimulationItem[];
+}
+
 /**
  * Type definitions for Netra SDK
  */
@@ -1134,6 +1235,11 @@ declare class Netra {
      * Available after calling Netra.init()
      */
     static dashboard: Dashboard;
+    static simulation: Simulation;
+    /**
+     * Get the current Netra configuration
+     */
+    static getConfig(): Config;
     /**
      * Check if Netra has been initialized
      */
@@ -1237,4 +1343,4 @@ declare class Netra {
     static withBlockedSpansLocal: typeof withBlockedSpansLocal;
 }
 
-export { type ActionModel, Aggregation, type CategoricalDataPoint, ChartType, Config, ConversationType, type CreateDatasetParams, Dashboard, type DashboardData, type Dataset, type DatasetEntry, type DatasetItem, type Dimension, DimensionField, type DimensionValue, EntryStatus, Evaluation, type EvaluationScore, type EvaluatorFunction, type Filter, type FilterConfig, FilterField, FilterType, FilteringSpanExporter, GroupBy, InstrumentationSpanProcessor, type ListSpansParams, type ListTracesParams, Measure, type Metrics, Netra, NetraInstruments, type NumberResponse, Operator, type QueryDataParams, type QueryResponse, type Run, RunEntryContext, RunStatus, Scope, ScrubbingSpanProcessor, SessionSpanProcessor, type SessionUsageData, SpanType, type SpansPage, type TaskFunction, type TenantUsageData, type TestSuiteResult, type TimeRange, type TimeSeriesDataPoint, type TimeSeriesResponse, type TimeSeriesWithDimension, type TraceSpan, type TraceSummary, type TracesPage, TrialAwareOTLPExporter, Usage, type UsageModel, agent, Netra as default, metadataField, mistralAIInstrumentor, span, task, workflow };
+export { type ActionModel, Aggregation, BaseTask, type CategoricalDataPoint, ChartType, Config, type ConversationResponse, type ConversationResult, ConversationType, type CreateDatasetParams, type CreateRunResult, Dashboard, type DashboardData, type Dataset, type DatasetEntry, type DatasetItem, type Dimension, DimensionField, type DimensionValue, EntryStatus, Evaluation, type EvaluationScore, type EvaluatorFunction, type Filter, type FilterConfig, FilterField, FilterType, FilteringSpanExporter, GroupBy, InstrumentationSpanProcessor, type ListSpansParams, type ListTracesParams, Measure, type Metrics, Netra, NetraInstruments, type NumberResponse, Operator, type QueryDataParams, type QueryResponse, type Run, RunEntryContext, RunStatus, Scope, ScrubbingSpanProcessor, SessionSpanProcessor, type SessionUsageData, Simulation, type SimulationItem, type SimulationOptions, type SimulationResult, SpanType, type SpansPage, type TaskFunction, type TaskResult, type TenantUsageData, type TestSuiteResult, type TimeRange, type TimeSeriesDataPoint, type TimeSeriesResponse, type TimeSeriesWithDimension, type TraceSpan, type TraceSummary, type TracesPage, TrialAwareOTLPExporter, Usage, type UsageModel, agent, Netra as default, metadataField, mistralAIInstrumentor, span, task, workflow };